ROSE 0.11.145.147
SgAsmCilMethodData.h
1
2#ifndef ROSE_SgAsmCilMethodData_H
3#define ROSE_SgAsmCilMethodData_H
4#include <RoseFirst.h>
5#include <Cxx_GrammarDeclarations.h>
6#include <SgAsmCilNode.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 SgAsmCilMethodData
23
24/* #line 25 "../../../src/frontend/SageIII//SgAsmCilMethodData.h" */
25/* #line 34405 "/workspace/src/ROSETTA/src/binaryInstruction.C" */
26
27#include <vector>
28
29
30/* #line 13 "/workspace/src/ROSETTA/Grammar/grammarClassDeclarationMacros.macro after subst for $PREDECLARATIONS" */
31
32/* #line 14 "/workspace/src/ROSETTA/Grammar/grammarClassDeclarationMacros.macro" */
33
34#if !defined(DOCUMENTATION)
35// Class Definition for SgAsmCilMethodData
36class ROSE_DLL_API SgAsmCilMethodData : public SgAsmCilNode
37 {
38 public:
39
40
41/* #line 42 "../../../src/frontend/SageIII//SgAsmCilMethodData.h" */
42
43 virtual SgNode* copy ( SgCopyHelp& help) const override;
44// Start of memberFunctionString
45/* #line 34436 "/workspace/src/ROSETTA/src/binaryInstruction.C" */
46
47
48 //----------------------- Boost serialization for SgAsmCilMethodData -----------------------
49#ifdef ROSE_HAVE_BOOST_SERIALIZATION_LIB
50private:
51 friend class boost::serialization::access;
52
53 template<class S>
54 void serialize(S &s, const unsigned /*version*/) {
55 debugSerializationBegin("SgAsmCilMethodData");
56 s & BOOST_SERIALIZATION_BASE_OBJECT_NVP(SgAsmCilNode);
57 s & BOOST_SERIALIZATION_NVP(p_kind);
58 s & BOOST_SERIALIZATION_NVP(p_dataSize);
59 s & BOOST_SERIALIZATION_NVP(p_clauses);
60 debugSerializationEnd("SgAsmCilMethodData");
61 }
62#endif // ROSE_HAVE_BOOST_SERIALIZATION_LIB
63public:
64 enum
65 {
66 CorILMethod_Sect_EHTable = 0x01,
67 CorILMethod_Sect_OptILTable = 0x02,
68 CorILMethod_Sect_FatFormat = 0x40,
69 CorILMethod_Sect_MoreSects = 0x40,
70 };
71
72private:
73public:
74 uint64_t const& get_kind() const;
75 void set_kind(uint64_t const&);
76
77public:
78 std::uint32_t const& get_dataSize() const;
79 void set_dataSize(std::uint32_t const&);
80
81public:
82 std::vector<SgAsmCilExceptionData*> const& get_Clauses() const;
83 std::vector<SgAsmCilExceptionData*>& get_Clauses();
84public:
85 bool isExceptionSection() const
86 {
87 return (p_kind & CorILMethod_Sect_EHTable) == CorILMethod_Sect_EHTable;
88 }
89
90 bool isOptILTable() const
91 {
92 const bool res = (p_kind & CorILMethod_Sect_OptILTable) == CorILMethod_Sect_OptILTable;
93
94 ASSERT_require(!res);
95 return res;
96 }
97
98 bool usesFatFormat() const
99 {
100 return (p_kind & CorILMethod_Sect_FatFormat) == CorILMethod_Sect_FatFormat;
101 }
102
103 bool hasMoreSections() const
104 {
105 return (p_kind & CorILMethod_Sect_MoreSects) == CorILMethod_Sect_MoreSects;
106 }
107public:
109 virtual ~SgAsmCilMethodData();
110
111public:
114
115protected:
123
124
125// End of memberFunctionString
126// Start of memberFunctionString
127/* #line 1 "/workspace/src/ROSETTA/Grammar/Common.code" */
128
129// *** COMMON CODE SECTION BEGINS HERE ***
130
131 public:
132
133 // DQ (3/25/3006): I put this back in because it had the logic for where the copy function required
134 // and not required which is required to match the other aspects of the copy mechanism code generation.
135 // Specifically it is a problem to declare the copy function everywhere because it is not implemented
136 // for the SgSymbol IR nodes. I'm not clear why it is not implemented for these IR nodes.
137 /* \brief Copies AST (whole subtree, depending on the SgCopyHelp class */
138 // virtual SgNode* copy ( const SgCopyHelp & help) const;
139
141 virtual std::string class_name() const override;
142
144 virtual VariantT variantT() const override; // MS: new variant used in tree traversal
145
147 // King84 (2010.08.16): Moved this to an enum to save space, since it's only used at compiler-time anyway.
148 // static const VariantT static_variant = V_SgAsmCilMethodData;
149 enum { static_variant = V_SgAsmCilMethodData };
150
151 /* the generated cast function */
153 ROSE_DLL_API friend SgAsmCilMethodData* isSgAsmCilMethodData( SgNode * s );
154
156 ROSE_DLL_API friend const SgAsmCilMethodData* isSgAsmCilMethodData( const SgNode * s );
157
158 // ******************************************
159 // * Memory Pool / New / Delete
160 // ******************************************
161
162 public:
164 static const unsigned pool_size; //
166 static std::vector<unsigned char *> pools; //
168 static SgAsmCilMethodData * next_node; //
169
171 static unsigned long initializeStorageClassArray(SgAsmCilMethodDataStorageClass *); //
172
174 static void clearMemoryPool(); //
175 static void deleteMemoryPool(); //
176
178 static void extendMemoryPoolForFileIO(); //
179
181 static SgAsmCilMethodData * getPointerFromGlobalIndex(unsigned long); //
183 static SgAsmCilMethodData * getPointerFromGlobalIndex(AstSpecificDataManagingClass *, unsigned long); //
184
186 static unsigned long getNumberOfValidNodesAndSetGlobalIndexInFreepointer(unsigned long); //
188 static void resetValidFreepointers(); //
190 static unsigned long getNumberOfLastValidPointer(); //
191
192
193#if defined(INLINE_FUNCTIONS)
195 inline void *operator new (size_t size);
196#else
198 void *operator new (size_t size);
199#endif
201 void operator delete (void* pointer, size_t size);
202
203 // DQ (4/5/2007): This is not the correct operator that we want, but appears to be required to compile ROSE with ROSE.
204 void operator delete (void* pointer)
205 {
206 // This is the generated delete operator...
207 SgAsmCilMethodData::operator delete (pointer,sizeof(SgAsmCilMethodData));
208 }
209
211 static size_t numberOfNodes();
212
214 static size_t memoryUsage();
215
216 // End of scope which started in IR nodes specific code
217 /* */
218
219 /* name Internal Functions
220 \brief Internal functions ... incomplete-documentation
221
222 These functions have been made public as part of the design, but they are suggested for internal use
223 or by particularly knowledgeable users for specialized tools or applications.
224
225 \internal We could not make these private because they are required by user for special purposes. And
226 it would be unwieldy to have many of the internal classes in ROSE be explicitly defined as friends.
227
228 */
229
230 // MS: 02/12/02 container of pointers to AST successor nodes used in the traversal
231 // overridden in every class by *generated* implementation
233 virtual std::vector<SgNode*> get_traversalSuccessorContainer() override;
234 // MS: 06/28/02 container of names of variables or container indices
235 // used used in the traversal to access AST successor nodes
236 // overridden in every class by *generated* implementation
239 virtual std::vector<std::string> get_traversalSuccessorNamesContainer() override;
240
241 // GB (09/25/2007): Functions for index-based access to traversal successors; these are hopefully a lot faster
242 // than all the vector copies. The implementation for these functions is generated for each class.
244 virtual size_t get_numberOfTraversalSuccessors() override;
246 virtual SgNode *get_traversalSuccessorByIndex(size_t idx) override;
248 virtual size_t get_childIndex(SgNode *child) override;
249
250#ifndef ROSE_USE_INTERNAL_FRONTEND_DEVELOPMENT
251 // MS: 08/16/2002 method for generating RTI information
253 virtual RTIReturnType roseRTI() override;
254#endif
255 /* */
256
257
258
259 /* name Deprecated Functions
260 \brief Deprecated functions ... incomplete-documentation
261
262 These functions have been deprecated from use.
263 */
264 /* */
265
267 virtual const char* sage_class_name() const override ROSE_DEPRECATED_FUNCTION;
268
269 // JJW (10/16/2008): Changed to a single function in Node.code, and put
270 // getVariant() in #if 0 block to prevent confusing Doxygen
271#if 0
273 virtual int variant() const ROSE_DEPRECATED_FUNCTION;
275 // virtual int getVariant() const ROSE_DEPRECATED_FUNCTION;
276#endif
277 /* */
278
279
280
281
282 public:
283 /* name Traversal Support Functions
284 \brief Traversal support functions ... incomplete-documentation
285
286 These functions have been made public as part of the design, but they are suggested for internal use
287 or by particularly knowledgable users for specialized tools or applications.
288 */
289 /* */
290
291 // DQ (11/26/2005): Support for visitor pattern mechanims
292 // (inferior to ROSE traversal mechanism, experimental).
296
297 /* DXN (08/09/2010): support for the classic visitor pattern done in GoF */
299 virtual void accept (ROSE_VisitorPattern & visitor) override;
300
301 // DQ (12/26/2005): Support for traversal based on the memory pool
304 static void traverseMemoryPoolNodes(ROSE_VisitTraversal & visit);
305
309
310 // DQ (2/9/2006): Added to support traversal over single representative of each IR node
311 // This traversal helps support internal tools that call static member functions.
312 // note: this function operates on the memory pools.
315 static void visitRepresentativeNode (ROSE_VisitTraversal & visit);
316 /* */
317
318 public:
319 /* NodeId support functions */
321 static SgNode* getNodeByNodeId(VariantT variantT, size_t poolIdx, size_t itemIdx);
324 static SgAsmCilMethodData* getNodeByNodeIdInternal(size_t poolIdx, size_t itemIdx);
327 static std::string getNodeIdString(SgAsmCilMethodData* sgnode);
328 static std::string getNodeIdStringInternal(SgAsmCilMethodData* sgnode);
329
330 public:
331 /* name Memory Allocation Functions
332 \brief Memory allocations functions ... incomplete-documentation
333
334 These functions have been made public as part of the design, but they are suggested for internal use
335 or by particularly knowledgable users for specialized tools or applications.
336 */
337 /* */
338
349 virtual bool isInMemoryPool() override;
350
361 virtual void checkDataMemberPointersIfInMemoryPool() override;
362
363 // DQ (4/30/2006): Modified to be a const function.
378 virtual std::vector<std::pair<SgNode*,std::string> > returnDataMemberPointers() const override;
379
390
402 virtual long getChildIndex( SgNode* childNode ) const override;
403
404 // DQ (9/2/2015): Since this function is generated by ROSETTA, we can't define the
405 // comment here (changed to be a C style comment and not be a doxygen comment).
406 /* \brief Constructor for use by AST File I/O Mechanism
407
408 This constructor permits the IR node to be rebuilt from the contiguously arranged data in memory
409 which obtained via fast binary file I/O from disk.
410 */
411 // SgAsmCilMethodData( SgAsmCilMethodDataStorageClass& source );
412
413
414
415
416
417 // JH (10/24/2005): methods added to support the ast file IO
418 private:
419
420 /* name AST Memory Allocation Support Functions
421 \brief Memory allocations support....
422
423 These functions handle the low leve support of the memory allocation scheme which permits IR nodes to be allocated
424 in large contiguous blocks to reduce memory fragmentation, improve performance, support specialized access (AST traversals),
425 and support the AST File I/O Mechanism.
426 */
427 /* */
428
429 /* JH (10/24/2005): Two typedefs. The TestType notes the type every pointer is cast to before
430 we compare them. Since I had several problems with this, I decided to make a typdef to ensure
431 that I use the same type everywhere, if any changes are made. THe second one declares the type
432 (actually unsigned long) where teh pointer address gets converted to. On 64 bit platforms this
433 might got changed, but unfortunatly, the return types are still unsigned longs. There exists
434 a correspinding one in the AST_FILE_IO class!
435 */
436 // DQ (9/2/2015): This typedef is no longer used, we can't define the
437 // comment here (changed to be a C style comment and not be a doxygen comment).
438 /* \brief Typedef used for low level memory access.
439 */
440 // typedef unsigned char* TestType;
441
442 // DQ (9/2/2015): This typedef is no longer used, we can't define the
443 // comment here (changed to be a C style comment and not be a doxygen comment).
444 /* \brief Typedef used to hold memory addresses as values.
445 */
446 // typedef unsigned long AddressType;
447
448
449
450 // necessary, to have direct access to the p_freepointer and the private methods !
452 friend class AST_FILE_IO;
453
455 friend class SgAsmCilMethodDataStorageClass;
456
458 friend class AstSpecificDataManagingClass;
459
461 friend class AstSpecificDataManagingClassStorageClass;
462 public:
464 SgAsmCilMethodData( const SgAsmCilMethodDataStorageClass& source );
465
466 // private: // JJW hack
467 /*
468 name AST Memory Allocation Support Variables
469 Memory allocations support variables
470
471 These variables handle the low level support of the memory allocation scheme which permits IR nodes to be allocated
472 in large contiguous blocks to reduce memory fragmentation, improve performance, support specialized access (AST traversals),
473 and support the AST File I/O Mechanism.
474 */
475 /* */
476
477 public:
478
479 // DQ (11/21/2009): Added function to add new Regular Expression attributes and return pointer
480 // to current node (so that it will work cleanly with build functions to specify patterns).
481 // virtual SgNode* addRegExpAttribute();
488
489#ifndef _MSC_VER
490// Rasmussen (04/17/2019): Support for ATerms has been deprecated as it is no longer needed
491// and likely never fully implemented nor tested. Files remain in the src tree but are no
492// longer built.
493#define BUILD_ATERM_SUPPORT 0
494 #if BUILD_ATERM_SUPPORT
495 #ifdef ROSE_USE_ROSE_ATERM_SUPPORT
496 // DQ (10/4/2014): Adding ATerm support to ROSE.
506 // Rasmussen (1/7/2019): Added override to kill warning messages of overridden virtual function
507 virtual ATerm generate_ATerm() override;
508
510 virtual void generate_ATerm_Annotation(ATerm & term) override;
511 #endif
512 #endif // BUILD_ATERM_SUPPORT
513#endif
514 // These can't be virtual functions since we don't yet know what IR node to build (until we have read the aterm).
515 // virtual generate_AST(ATerm & term);
516 // virtual void read_ATerm_Annotation(ATerm & term);
517
518// *** COMMON CODE SECTION ENDS HERE ***
519
520
521// End of memberFunctionString
522// Start of memberFunctionString
523/* #line 706 "/workspace/src/ROSETTA/Grammar/Node.code" */
524
525 // the generated cast function
526 // friend ROSE_DLL_API SgAsmCilMethodData* isSgAsmCilMethodData ( SgNode* s );
527
528 typedef SgAsmCilNode base_node_type;
529
530
531// End of memberFunctionString
532
533
534
535
536 protected:
537// Start of memberFunctionString
538uint64_t p_kind;
539
540// End of memberFunctionString
541// Start of memberFunctionString
542std::uint32_t p_dataSize;
543
544// End of memberFunctionString
545// Start of memberFunctionString
546std::vector<SgAsmCilExceptionData*> p_clauses;
547
548// End of memberFunctionString
549
551 friend struct Rose::Traits::generated::describe_field_t<SgAsmCilMethodData, uint64_t,&SgAsmCilMethodData::p_kind>;
552 friend struct Rose::Traits::generated::describe_field_t<SgAsmCilMethodData, std::uint32_t,&SgAsmCilMethodData::p_dataSize>;
553 friend struct Rose::Traits::generated::describe_field_t<SgAsmCilMethodData, std::vector<SgAsmCilExceptionData*>,&SgAsmCilMethodData::p_clauses>;
554
555/* #line 21 "/workspace/src/ROSETTA/Grammar/grammarClassDeclarationMacros.macro" */
556
557
558 };
559#endif
560
561// postdeclarations for SgAsmCilMethodData
562
563/* #line 564 "../../../src/frontend/SageIII//SgAsmCilMethodData.h" */
564
565/* #line 27 "/workspace/src/ROSETTA/Grammar/grammarClassDeclarationMacros.macro after subst for $POSTDECLARATIONS" */
566
567/* #line 28 "/workspace/src/ROSETTA/Grammar/grammarClassDeclarationMacros.macro" */
568
569
570/* #line 571 "../../../src/frontend/SageIII//SgAsmCilMethodData.h" */
571
572#endif // ROSE_SgAsmCilMethodData_H
573
Class holding static data and functions supporting File I/O.
Definition AST_FILE_IO.h:19
Attribute containing a regex expression as a string.
Property class representing CIL Extra Sections (II.25.4.5).
Base class for CIL branch of binary analysis IR nodes.
void initializeProperties()
Initialize all properties that have explicit initial values.
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 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.