ROSE 0.11.145.147
SgAsmCilStandAloneSig.h
1
2#ifndef ROSE_SgAsmCilStandAloneSig_H
3#define ROSE_SgAsmCilStandAloneSig_H
4#include <RoseFirst.h>
5#include <Cxx_GrammarDeclarations.h>
6#include <SgAsmCilMetadata.h>
7
8
9
10/* #line 1 "/workspace/src/ROSETTA/Grammar/grammarClassDeclarationMacros.macro" */
11
12// WARNING -- GENERATED CODE -- DO NOT MODIFY THIS CODE -- WARNING!
13// This code is automatically generated for each
14// terminal and non-terminal within the defined
15// grammar. There is a simple way to change the
16// code to fix bugs etc. See the ROSE README file
17// for directions.
18
19// tps: (02/22/2010): Adding DLL export requirements
20#include "rosedll.h"
21
22// predeclarations for SgAsmCilStandAloneSig
23
24/* #line 25 "../../../src/frontend/SageIII//SgAsmCilStandAloneSig.h" */
25
26/* #line 13 "/workspace/src/ROSETTA/Grammar/grammarClassDeclarationMacros.macro after subst for $PREDECLARATIONS" */
27
28/* #line 14 "/workspace/src/ROSETTA/Grammar/grammarClassDeclarationMacros.macro" */
29
30#if !defined(DOCUMENTATION)
31// Class Definition for SgAsmCilStandAloneSig
32class ROSE_DLL_API SgAsmCilStandAloneSig : public SgAsmCilMetadata
33 {
34 public:
35
36
37/* #line 38 "../../../src/frontend/SageIII//SgAsmCilStandAloneSig.h" */
38
39 virtual SgNode* copy ( SgCopyHelp& help) const override;
40// Start of memberFunctionString
41/* #line 32464 "/workspace/src/ROSETTA/src/binaryInstruction.C" */
42
43
44 //----------------------- Boost serialization for SgAsmCilStandAloneSig -----------------------
45#ifdef ROSE_HAVE_BOOST_SERIALIZATION_LIB
46private:
47 friend class boost::serialization::access;
48
49 template<class S>
50 void serialize(S &s, const unsigned /*version*/) {
51 debugSerializationBegin("SgAsmCilStandAloneSig");
52 s & BOOST_SERIALIZATION_BASE_OBJECT_NVP(SgAsmCilMetadata);
53 s & BOOST_SERIALIZATION_NVP(p_Signature);
54 debugSerializationEnd("SgAsmCilStandAloneSig");
55 }
56#endif // ROSE_HAVE_BOOST_SERIALIZATION_LIB
57
58public:
64 uint32_t const& get_Signature() const;
65 void set_Signature(uint32_t const&);
67public:
68 void parse(const std::vector<uint8_t>& buf, size_t& index, uint64_t uses4byteIndexing);
69 void unparse(std::vector<uint8_t>& buf, size_t& index, uint64_t uses4byteIndexing) const;
70 void dump(std::ostream&) const;
71
72 const std::uint8_t* get_Signature_blob() const;
73public:
75 virtual ~SgAsmCilStandAloneSig();
76
77public:
80
81protected:
89
90
91// End of memberFunctionString
92// Start of memberFunctionString
93/* #line 1 "/workspace/src/ROSETTA/Grammar/Common.code" */
94
95// *** COMMON CODE SECTION BEGINS HERE ***
96
97 public:
98
99 // DQ (3/25/3006): I put this back in because it had the logic for where the copy function required
100 // and not required which is required to match the other aspects of the copy mechanism code generation.
101 // Specifically it is a problem to declare the copy function everywhere because it is not implemented
102 // for the SgSymbol IR nodes. I'm not clear why it is not implemented for these IR nodes.
103 /* \brief Copies AST (whole subtree, depending on the SgCopyHelp class */
104 // virtual SgNode* copy ( const SgCopyHelp & help) const;
105
107 virtual std::string class_name() const override;
108
110 virtual VariantT variantT() const override; // MS: new variant used in tree traversal
111
113 // King84 (2010.08.16): Moved this to an enum to save space, since it's only used at compiler-time anyway.
114 // static const VariantT static_variant = V_SgAsmCilStandAloneSig;
115 enum { static_variant = V_SgAsmCilStandAloneSig };
116
117 /* the generated cast function */
119 ROSE_DLL_API friend SgAsmCilStandAloneSig* isSgAsmCilStandAloneSig( SgNode * s );
120
122 ROSE_DLL_API friend const SgAsmCilStandAloneSig* isSgAsmCilStandAloneSig( const SgNode * s );
123
124 // ******************************************
125 // * Memory Pool / New / Delete
126 // ******************************************
127
128 public:
130 static const unsigned pool_size; //
132 static std::vector<unsigned char *> pools; //
134 static SgAsmCilStandAloneSig * next_node; //
135
137 static unsigned long initializeStorageClassArray(SgAsmCilStandAloneSigStorageClass *); //
138
140 static void clearMemoryPool(); //
141 static void deleteMemoryPool(); //
142
144 static void extendMemoryPoolForFileIO(); //
145
147 static SgAsmCilStandAloneSig * getPointerFromGlobalIndex(unsigned long); //
149 static SgAsmCilStandAloneSig * getPointerFromGlobalIndex(AstSpecificDataManagingClass *, unsigned long); //
150
152 static unsigned long getNumberOfValidNodesAndSetGlobalIndexInFreepointer(unsigned long); //
154 static void resetValidFreepointers(); //
156 static unsigned long getNumberOfLastValidPointer(); //
157
158
159#if defined(INLINE_FUNCTIONS)
161 inline void *operator new (size_t size);
162#else
164 void *operator new (size_t size);
165#endif
167 void operator delete (void* pointer, size_t size);
168
169 // DQ (4/5/2007): This is not the correct operator that we want, but appears to be required to compile ROSE with ROSE.
170 void operator delete (void* pointer)
171 {
172 // This is the generated delete operator...
173 SgAsmCilStandAloneSig::operator delete (pointer,sizeof(SgAsmCilStandAloneSig));
174 }
175
177 static size_t numberOfNodes();
178
180 static size_t memoryUsage();
181
182 // End of scope which started in IR nodes specific code
183 /* */
184
185 /* name Internal Functions
186 \brief Internal functions ... incomplete-documentation
187
188 These functions have been made public as part of the design, but they are suggested for internal use
189 or by particularly knowledgeable users for specialized tools or applications.
190
191 \internal We could not make these private because they are required by user for special purposes. And
192 it would be unwieldy to have many of the internal classes in ROSE be explicitly defined as friends.
193
194 */
195
196 // MS: 02/12/02 container of pointers to AST successor nodes used in the traversal
197 // overridden in every class by *generated* implementation
199 virtual std::vector<SgNode*> get_traversalSuccessorContainer() override;
200 // MS: 06/28/02 container of names of variables or container indices
201 // used used in the traversal to access AST successor nodes
202 // overridden in every class by *generated* implementation
205 virtual std::vector<std::string> get_traversalSuccessorNamesContainer() override;
206
207 // GB (09/25/2007): Functions for index-based access to traversal successors; these are hopefully a lot faster
208 // than all the vector copies. The implementation for these functions is generated for each class.
210 virtual size_t get_numberOfTraversalSuccessors() override;
212 virtual SgNode *get_traversalSuccessorByIndex(size_t idx) override;
214 virtual size_t get_childIndex(SgNode *child) override;
215
216#ifndef ROSE_USE_INTERNAL_FRONTEND_DEVELOPMENT
217 // MS: 08/16/2002 method for generating RTI information
219 virtual RTIReturnType roseRTI() override;
220#endif
221 /* */
222
223
224
225 /* name Deprecated Functions
226 \brief Deprecated functions ... incomplete-documentation
227
228 These functions have been deprecated from use.
229 */
230 /* */
231
233 virtual const char* sage_class_name() const override ROSE_DEPRECATED_FUNCTION;
234
235 // JJW (10/16/2008): Changed to a single function in Node.code, and put
236 // getVariant() in #if 0 block to prevent confusing Doxygen
237#if 0
239 virtual int variant() const ROSE_DEPRECATED_FUNCTION;
241 // virtual int getVariant() const ROSE_DEPRECATED_FUNCTION;
242#endif
243 /* */
244
245
246
247
248 public:
249 /* name Traversal Support Functions
250 \brief Traversal support functions ... incomplete-documentation
251
252 These functions have been made public as part of the design, but they are suggested for internal use
253 or by particularly knowledgable users for specialized tools or applications.
254 */
255 /* */
256
257 // DQ (11/26/2005): Support for visitor pattern mechanims
258 // (inferior to ROSE traversal mechanism, experimental).
262
263 /* DXN (08/09/2010): support for the classic visitor pattern done in GoF */
265 virtual void accept (ROSE_VisitorPattern & visitor) override;
266
267 // DQ (12/26/2005): Support for traversal based on the memory pool
270 static void traverseMemoryPoolNodes(ROSE_VisitTraversal & visit);
271
275
276 // DQ (2/9/2006): Added to support traversal over single representative of each IR node
277 // This traversal helps support internal tools that call static member functions.
278 // note: this function operates on the memory pools.
281 static void visitRepresentativeNode (ROSE_VisitTraversal & visit);
282 /* */
283
284 public:
285 /* NodeId support functions */
287 static SgNode* getNodeByNodeId(VariantT variantT, size_t poolIdx, size_t itemIdx);
290 static SgAsmCilStandAloneSig* getNodeByNodeIdInternal(size_t poolIdx, size_t itemIdx);
293 static std::string getNodeIdString(SgAsmCilStandAloneSig* sgnode);
294 static std::string getNodeIdStringInternal(SgAsmCilStandAloneSig* sgnode);
295
296 public:
297 /* name Memory Allocation Functions
298 \brief Memory allocations functions ... incomplete-documentation
299
300 These functions have been made public as part of the design, but they are suggested for internal use
301 or by particularly knowledgable users for specialized tools or applications.
302 */
303 /* */
304
315 virtual bool isInMemoryPool() override;
316
327 virtual void checkDataMemberPointersIfInMemoryPool() override;
328
329 // DQ (4/30/2006): Modified to be a const function.
344 virtual std::vector<std::pair<SgNode*,std::string> > returnDataMemberPointers() const override;
345
356
368 virtual long getChildIndex( SgNode* childNode ) const override;
369
370 // DQ (9/2/2015): Since this function is generated by ROSETTA, we can't define the
371 // comment here (changed to be a C style comment and not be a doxygen comment).
372 /* \brief Constructor for use by AST File I/O Mechanism
373
374 This constructor permits the IR node to be rebuilt from the contiguously arranged data in memory
375 which obtained via fast binary file I/O from disk.
376 */
377 // SgAsmCilStandAloneSig( SgAsmCilStandAloneSigStorageClass& source );
378
379
380
381
382
383 // JH (10/24/2005): methods added to support the ast file IO
384 private:
385
386 /* name AST Memory Allocation Support Functions
387 \brief Memory allocations support....
388
389 These functions handle the low leve support of the memory allocation scheme which permits IR nodes to be allocated
390 in large contiguous blocks to reduce memory fragmentation, improve performance, support specialized access (AST traversals),
391 and support the AST File I/O Mechanism.
392 */
393 /* */
394
395 /* JH (10/24/2005): Two typedefs. The TestType notes the type every pointer is cast to before
396 we compare them. Since I had several problems with this, I decided to make a typdef to ensure
397 that I use the same type everywhere, if any changes are made. THe second one declares the type
398 (actually unsigned long) where teh pointer address gets converted to. On 64 bit platforms this
399 might got changed, but unfortunatly, the return types are still unsigned longs. There exists
400 a correspinding one in the AST_FILE_IO class!
401 */
402 // DQ (9/2/2015): This typedef is no longer used, we can't define the
403 // comment here (changed to be a C style comment and not be a doxygen comment).
404 /* \brief Typedef used for low level memory access.
405 */
406 // typedef unsigned char* TestType;
407
408 // DQ (9/2/2015): This typedef is no longer used, we can't define the
409 // comment here (changed to be a C style comment and not be a doxygen comment).
410 /* \brief Typedef used to hold memory addresses as values.
411 */
412 // typedef unsigned long AddressType;
413
414
415
416 // necessary, to have direct access to the p_freepointer and the private methods !
418 friend class AST_FILE_IO;
419
421 friend class SgAsmCilStandAloneSigStorageClass;
422
424 friend class AstSpecificDataManagingClass;
425
427 friend class AstSpecificDataManagingClassStorageClass;
428 public:
430 SgAsmCilStandAloneSig( const SgAsmCilStandAloneSigStorageClass& source );
431
432 // private: // JJW hack
433 /*
434 name AST Memory Allocation Support Variables
435 Memory allocations support variables
436
437 These variables handle the low level support of the memory allocation scheme which permits IR nodes to be allocated
438 in large contiguous blocks to reduce memory fragmentation, improve performance, support specialized access (AST traversals),
439 and support the AST File I/O Mechanism.
440 */
441 /* */
442
443 public:
444
445 // DQ (11/21/2009): Added function to add new Regular Expression attributes and return pointer
446 // to current node (so that it will work cleanly with build functions to specify patterns).
447 // virtual SgNode* addRegExpAttribute();
454
455#ifndef _MSC_VER
456// Rasmussen (04/17/2019): Support for ATerms has been deprecated as it is no longer needed
457// and likely never fully implemented nor tested. Files remain in the src tree but are no
458// longer built.
459#define BUILD_ATERM_SUPPORT 0
460 #if BUILD_ATERM_SUPPORT
461 #ifdef ROSE_USE_ROSE_ATERM_SUPPORT
462 // DQ (10/4/2014): Adding ATerm support to ROSE.
472 // Rasmussen (1/7/2019): Added override to kill warning messages of overridden virtual function
473 virtual ATerm generate_ATerm() override;
474
476 virtual void generate_ATerm_Annotation(ATerm & term) override;
477 #endif
478 #endif // BUILD_ATERM_SUPPORT
479#endif
480 // These can't be virtual functions since we don't yet know what IR node to build (until we have read the aterm).
481 // virtual generate_AST(ATerm & term);
482 // virtual void read_ATerm_Annotation(ATerm & term);
483
484// *** COMMON CODE SECTION ENDS HERE ***
485
486
487// End of memberFunctionString
488// Start of memberFunctionString
489/* #line 706 "/workspace/src/ROSETTA/Grammar/Node.code" */
490
491 // the generated cast function
492 // friend ROSE_DLL_API SgAsmCilStandAloneSig* isSgAsmCilStandAloneSig ( SgNode* s );
493
494 typedef SgAsmCilMetadata base_node_type;
495
496
497// End of memberFunctionString
498
499
500 protected:
501// Start of memberFunctionString
502uint32_t p_Signature;
503
504// End of memberFunctionString
505
507 friend struct Rose::Traits::generated::describe_field_t<SgAsmCilStandAloneSig, uint32_t,&SgAsmCilStandAloneSig::p_Signature>;
508
509/* #line 21 "/workspace/src/ROSETTA/Grammar/grammarClassDeclarationMacros.macro" */
510
511
512 };
513#endif
514
515// postdeclarations for SgAsmCilStandAloneSig
516
517/* #line 518 "../../../src/frontend/SageIII//SgAsmCilStandAloneSig.h" */
518
519/* #line 27 "/workspace/src/ROSETTA/Grammar/grammarClassDeclarationMacros.macro after subst for $POSTDECLARATIONS" */
520
521/* #line 28 "/workspace/src/ROSETTA/Grammar/grammarClassDeclarationMacros.macro" */
522
523
524/* #line 525 "../../../src/frontend/SageIII//SgAsmCilStandAloneSig.h" */
525
526#endif // ROSE_SgAsmCilStandAloneSig_H
527
Class holding static data and functions supporting File I/O.
Definition AST_FILE_IO.h:19
Attribute containing a regex expression as a string.
Base class for CIL branch of binary analysis IR nodes.
void initializeProperties()
Initialize all properties that have explicit initial values.
CIL StandAloneSig node (II.22.36).
Supporting class from copy mechanism within ROSE.
Definition sageCopy.h:26
This class represents the base class for all IR nodes within Sage III.
virtual size_t get_numberOfTraversalSuccessors()
return number of children in the traversal successor list
virtual RTIReturnType roseRTI()
return C++ Runtime-Time-Information
virtual std::vector< std::string > get_traversalSuccessorNamesContainer()
container of names of variables or container indices used used in the traversal to access AST success...
virtual void debugSerializationEnd(const char *className)
Called by generated serializers.
static std::string getNodeIdString(SgNode *sgnode)
compute the NodeId for a particular SgNode*.
virtual bool isInMemoryPool()
FOR INTERNAL USE This is used in internal tests to verify that all IR nodes are allocated from the he...
int variant() const
Older version function returns enum value "NODE".
virtual void processDataMemberReferenceToPointers(ReferenceToPointerHandler *)
FOR INTERNAL USE Processes pairs of references to SgNode* and strings for use in AST tools
virtual VariantT variantT() const
returns new style SageIII enum values
virtual long getChildIndex(SgNode *childNode) const
FOR INTERNAL USE Returns a unique index value for the childNode in the list of children at this IR no...
virtual size_t get_childIndex(SgNode *child)
index-based access to traversal successors by child node
virtual void debugSerializationBegin(const char *className)
Called by generated serializers.
virtual std::vector< SgNode * > get_traversalSuccessorContainer()
container of pointers to AST successor nodes used in the traversal overridden in every class by gener...
virtual std::string class_name() const
returns a string representing the class name
static void visitRepresentativeNode(ROSE_VisitTraversal &visit)
FOR INTERNAL USE Support for type-based traversal.
virtual void checkDataMemberPointersIfInMemoryPool()
FOR INTERNAL USE This is used in internal tests to verify that all IR nodes are allocated from the he...
static size_t numberOfNodes()
Returns the total number of IR nodes of this type.
virtual void accept(ROSE_VisitorPattern &visitor)
support for the classic visitor pattern done in GoF
virtual SgNode * get_traversalSuccessorByIndex(size_t idx)
index-based access to traversal successors by index number
static void traverseMemoryPoolVisitorPattern(ROSE_VisitorPattern &visitor)
FOR INTERNAL USE Support for visitor pattern.
void executeVisitorMemberFunction(ROSE_VisitorPattern &visitor)
FOR INTERNAL USE Support for visitor pattern.
static SgNode * getNodeByNodeId(VariantT variantT, size_t poolIdx, size_t itemIdx)
Find a node by its variant type, pool index, and item index.
static size_t memoryUsage()
Returns the size in bytes of the total memory allocated for all IR nodes of this type.
static void traverseMemoryPoolNodes(ROSE_VisitTraversal &visit)
FOR INTERNAL USE Support for visitor pattern over all IR nodes by type of IR node.
virtual const char * sage_class_name() const
generates string representing the class name: (e.g. for SgNode returns "SgNode").
virtual std::vector< std::pair< SgNode *, std::string > > returnDataMemberPointers() const
FOR INTERNAL USE Returns STL vector of pairs of SgNode* and strings for use in AST tools
static SgNode * getNodeByNodeIdInternal(size_t poolIdx, size_t itemIdx)
FOR INTERNAL USE Find an SgNode from its memory pool and location therin.
SgNode * addRegExpAttribute(std::string s, AstRegExAttribute *a)
Support for AST matching using regular expression.
void parse(SgAsmGenericFile *)
Main function to parse DWARF information.
void serialize(std::ostream &output, Graph &graph)
Serialize a graph into a stream of bytes.
void copy(const Word *src, const BitRange &srcRange, Word *dst, const BitRange &dstRange)
Copy some bits.