ROSE 0.11.145.147
SgAsmElfEHFrameEntryFDList.h
1
2#ifndef ROSE_SgAsmElfEHFrameEntryFDList_H
3#define ROSE_SgAsmElfEHFrameEntryFDList_H
4#include <RoseFirst.h>
5#include <Cxx_GrammarDeclarations.h>
6#include <SgAsmExecutableFileFormat.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 SgAsmElfEHFrameEntryFDList
23
24/* #line 25 "../../../src/frontend/SageIII//SgAsmElfEHFrameEntryFDList.h" */
25/* #line 21968 "/workspace/src/ROSETTA/src/binaryInstruction.C" */
26
27#include <sageContainer.h>
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 SgAsmElfEHFrameEntryFDList
37 {
38 public:
39
40
41/* #line 42 "../../../src/frontend/SageIII//SgAsmElfEHFrameEntryFDList.h" */
42
43 virtual SgNode* copy ( SgCopyHelp& help) const override;
44// Start of memberFunctionString
45/* #line 21987 "/workspace/src/ROSETTA/src/binaryInstruction.C" */
46
47
48 //----------------------- Boost serialization for SgAsmElfEHFrameEntryFDList -----------------------
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("SgAsmElfEHFrameEntryFDList");
56 s & BOOST_SERIALIZATION_BASE_OBJECT_NVP(SgAsmExecutableFileFormat);
57 s & BOOST_SERIALIZATION_NVP(p_entries);
58 debugSerializationEnd("SgAsmElfEHFrameEntryFDList");
59 }
60#endif // ROSE_HAVE_BOOST_SERIALIZATION_LIB
61public:
62public:
66 SgAsmElfEHFrameEntryFDPtrList const& get_entries() const;
67 SgAsmElfEHFrameEntryFDPtrList& get_entries();
68 void set_entries(SgAsmElfEHFrameEntryFDPtrList const&);
71public:
74
75public:
78
79protected:
87
88
89// End of memberFunctionString
90// Start of memberFunctionString
91/* #line 1 "/workspace/src/ROSETTA/Grammar/Common.code" */
92
93// *** COMMON CODE SECTION BEGINS HERE ***
94
95 public:
96
97 // DQ (3/25/3006): I put this back in because it had the logic for where the copy function required
98 // and not required which is required to match the other aspects of the copy mechanism code generation.
99 // Specifically it is a problem to declare the copy function everywhere because it is not implemented
100 // for the SgSymbol IR nodes. I'm not clear why it is not implemented for these IR nodes.
101 /* \brief Copies AST (whole subtree, depending on the SgCopyHelp class */
102 // virtual SgNode* copy ( const SgCopyHelp & help) const;
103
105 virtual std::string class_name() const override;
106
108 virtual VariantT variantT() const override; // MS: new variant used in tree traversal
109
111 // King84 (2010.08.16): Moved this to an enum to save space, since it's only used at compiler-time anyway.
112 // static const VariantT static_variant = V_SgAsmElfEHFrameEntryFDList;
113 enum { static_variant = V_SgAsmElfEHFrameEntryFDList };
114
115 /* the generated cast function */
117 ROSE_DLL_API friend SgAsmElfEHFrameEntryFDList* isSgAsmElfEHFrameEntryFDList( SgNode * s );
118
120 ROSE_DLL_API friend const SgAsmElfEHFrameEntryFDList* isSgAsmElfEHFrameEntryFDList( const SgNode * s );
121
122 // ******************************************
123 // * Memory Pool / New / Delete
124 // ******************************************
125
126 public:
128 static const unsigned pool_size; //
130 static std::vector<unsigned char *> pools; //
132 static SgAsmElfEHFrameEntryFDList * next_node; //
133
135 static unsigned long initializeStorageClassArray(SgAsmElfEHFrameEntryFDListStorageClass *); //
136
138 static void clearMemoryPool(); //
139 static void deleteMemoryPool(); //
140
142 static void extendMemoryPoolForFileIO(); //
143
145 static SgAsmElfEHFrameEntryFDList * getPointerFromGlobalIndex(unsigned long); //
147 static SgAsmElfEHFrameEntryFDList * getPointerFromGlobalIndex(AstSpecificDataManagingClass *, unsigned long); //
148
150 static unsigned long getNumberOfValidNodesAndSetGlobalIndexInFreepointer(unsigned long); //
152 static void resetValidFreepointers(); //
154 static unsigned long getNumberOfLastValidPointer(); //
155
156
157#if defined(INLINE_FUNCTIONS)
159 inline void *operator new (size_t size);
160#else
162 void *operator new (size_t size);
163#endif
165 void operator delete (void* pointer, size_t size);
166
167 // DQ (4/5/2007): This is not the correct operator that we want, but appears to be required to compile ROSE with ROSE.
168 void operator delete (void* pointer)
169 {
170 // This is the generated delete operator...
171 SgAsmElfEHFrameEntryFDList::operator delete (pointer,sizeof(SgAsmElfEHFrameEntryFDList));
172 }
173
175 static size_t numberOfNodes();
176
178 static size_t memoryUsage();
179
180 // End of scope which started in IR nodes specific code
181 /* */
182
183 /* name Internal Functions
184 \brief Internal functions ... incomplete-documentation
185
186 These functions have been made public as part of the design, but they are suggested for internal use
187 or by particularly knowledgeable users for specialized tools or applications.
188
189 \internal We could not make these private because they are required by user for special purposes. And
190 it would be unwieldy to have many of the internal classes in ROSE be explicitly defined as friends.
191
192 */
193
194 // MS: 02/12/02 container of pointers to AST successor nodes used in the traversal
195 // overridden in every class by *generated* implementation
197 virtual std::vector<SgNode*> get_traversalSuccessorContainer() override;
198 // MS: 06/28/02 container of names of variables or container indices
199 // used used in the traversal to access AST successor nodes
200 // overridden in every class by *generated* implementation
203 virtual std::vector<std::string> get_traversalSuccessorNamesContainer() override;
204
205 // GB (09/25/2007): Functions for index-based access to traversal successors; these are hopefully a lot faster
206 // than all the vector copies. The implementation for these functions is generated for each class.
208 virtual size_t get_numberOfTraversalSuccessors() override;
210 virtual SgNode *get_traversalSuccessorByIndex(size_t idx) override;
212 virtual size_t get_childIndex(SgNode *child) override;
213
214#ifndef ROSE_USE_INTERNAL_FRONTEND_DEVELOPMENT
215 // MS: 08/16/2002 method for generating RTI information
217 virtual RTIReturnType roseRTI() override;
218#endif
219 /* */
220
221
222
223 /* name Deprecated Functions
224 \brief Deprecated functions ... incomplete-documentation
225
226 These functions have been deprecated from use.
227 */
228 /* */
229
231 virtual const char* sage_class_name() const override ROSE_DEPRECATED_FUNCTION;
232
233 // JJW (10/16/2008): Changed to a single function in Node.code, and put
234 // getVariant() in #if 0 block to prevent confusing Doxygen
235#if 0
237 virtual int variant() const ROSE_DEPRECATED_FUNCTION;
239 // virtual int getVariant() const ROSE_DEPRECATED_FUNCTION;
240#endif
241 /* */
242
243
244
245
246 public:
247 /* name Traversal Support Functions
248 \brief Traversal support functions ... incomplete-documentation
249
250 These functions have been made public as part of the design, but they are suggested for internal use
251 or by particularly knowledgable users for specialized tools or applications.
252 */
253 /* */
254
255 // DQ (11/26/2005): Support for visitor pattern mechanims
256 // (inferior to ROSE traversal mechanism, experimental).
260
261 /* DXN (08/09/2010): support for the classic visitor pattern done in GoF */
263 virtual void accept (ROSE_VisitorPattern & visitor) override;
264
265 // DQ (12/26/2005): Support for traversal based on the memory pool
268 static void traverseMemoryPoolNodes(ROSE_VisitTraversal & visit);
269
273
274 // DQ (2/9/2006): Added to support traversal over single representative of each IR node
275 // This traversal helps support internal tools that call static member functions.
276 // note: this function operates on the memory pools.
279 static void visitRepresentativeNode (ROSE_VisitTraversal & visit);
280 /* */
281
282 public:
283 /* NodeId support functions */
285 static SgNode* getNodeByNodeId(VariantT variantT, size_t poolIdx, size_t itemIdx);
288 static SgAsmElfEHFrameEntryFDList* getNodeByNodeIdInternal(size_t poolIdx, size_t itemIdx);
291 static std::string getNodeIdString(SgAsmElfEHFrameEntryFDList* sgnode);
292 static std::string getNodeIdStringInternal(SgAsmElfEHFrameEntryFDList* sgnode);
293
294 public:
295 /* name Memory Allocation Functions
296 \brief Memory allocations functions ... incomplete-documentation
297
298 These functions have been made public as part of the design, but they are suggested for internal use
299 or by particularly knowledgable users for specialized tools or applications.
300 */
301 /* */
302
313 virtual bool isInMemoryPool() override;
314
325 virtual void checkDataMemberPointersIfInMemoryPool() override;
326
327 // DQ (4/30/2006): Modified to be a const function.
342 virtual std::vector<std::pair<SgNode*,std::string> > returnDataMemberPointers() const override;
343
354
366 virtual long getChildIndex( SgNode* childNode ) const override;
367
368 // DQ (9/2/2015): Since this function is generated by ROSETTA, we can't define the
369 // comment here (changed to be a C style comment and not be a doxygen comment).
370 /* \brief Constructor for use by AST File I/O Mechanism
371
372 This constructor permits the IR node to be rebuilt from the contiguously arranged data in memory
373 which obtained via fast binary file I/O from disk.
374 */
375 // SgAsmElfEHFrameEntryFDList( SgAsmElfEHFrameEntryFDListStorageClass& source );
376
377
378
379
380
381 // JH (10/24/2005): methods added to support the ast file IO
382 private:
383
384 /* name AST Memory Allocation Support Functions
385 \brief Memory allocations support....
386
387 These functions handle the low leve support of the memory allocation scheme which permits IR nodes to be allocated
388 in large contiguous blocks to reduce memory fragmentation, improve performance, support specialized access (AST traversals),
389 and support the AST File I/O Mechanism.
390 */
391 /* */
392
393 /* JH (10/24/2005): Two typedefs. The TestType notes the type every pointer is cast to before
394 we compare them. Since I had several problems with this, I decided to make a typdef to ensure
395 that I use the same type everywhere, if any changes are made. THe second one declares the type
396 (actually unsigned long) where teh pointer address gets converted to. On 64 bit platforms this
397 might got changed, but unfortunatly, the return types are still unsigned longs. There exists
398 a correspinding one in the AST_FILE_IO class!
399 */
400 // DQ (9/2/2015): This typedef is no longer used, we can't define the
401 // comment here (changed to be a C style comment and not be a doxygen comment).
402 /* \brief Typedef used for low level memory access.
403 */
404 // typedef unsigned char* TestType;
405
406 // DQ (9/2/2015): This typedef is no longer used, we can't define the
407 // comment here (changed to be a C style comment and not be a doxygen comment).
408 /* \brief Typedef used to hold memory addresses as values.
409 */
410 // typedef unsigned long AddressType;
411
412
413
414 // necessary, to have direct access to the p_freepointer and the private methods !
416 friend class AST_FILE_IO;
417
419 friend class SgAsmElfEHFrameEntryFDListStorageClass;
420
422 friend class AstSpecificDataManagingClass;
423
425 friend class AstSpecificDataManagingClassStorageClass;
426 public:
428 SgAsmElfEHFrameEntryFDList( const SgAsmElfEHFrameEntryFDListStorageClass& source );
429
430 // private: // JJW hack
431 /*
432 name AST Memory Allocation Support Variables
433 Memory allocations support variables
434
435 These variables handle the low level support of the memory allocation scheme which permits IR nodes to be allocated
436 in large contiguous blocks to reduce memory fragmentation, improve performance, support specialized access (AST traversals),
437 and support the AST File I/O Mechanism.
438 */
439 /* */
440
441 public:
442
443 // DQ (11/21/2009): Added function to add new Regular Expression attributes and return pointer
444 // to current node (so that it will work cleanly with build functions to specify patterns).
445 // virtual SgNode* addRegExpAttribute();
452
453#ifndef _MSC_VER
454// Rasmussen (04/17/2019): Support for ATerms has been deprecated as it is no longer needed
455// and likely never fully implemented nor tested. Files remain in the src tree but are no
456// longer built.
457#define BUILD_ATERM_SUPPORT 0
458 #if BUILD_ATERM_SUPPORT
459 #ifdef ROSE_USE_ROSE_ATERM_SUPPORT
460 // DQ (10/4/2014): Adding ATerm support to ROSE.
470 // Rasmussen (1/7/2019): Added override to kill warning messages of overridden virtual function
471 virtual ATerm generate_ATerm() override;
472
474 virtual void generate_ATerm_Annotation(ATerm & term) override;
475 #endif
476 #endif // BUILD_ATERM_SUPPORT
477#endif
478 // These can't be virtual functions since we don't yet know what IR node to build (until we have read the aterm).
479 // virtual generate_AST(ATerm & term);
480 // virtual void read_ATerm_Annotation(ATerm & term);
481
482// *** COMMON CODE SECTION ENDS HERE ***
483
484
485// End of memberFunctionString
486// Start of memberFunctionString
487/* #line 706 "/workspace/src/ROSETTA/Grammar/Node.code" */
488
489 // the generated cast function
490 // friend ROSE_DLL_API SgAsmElfEHFrameEntryFDList* isSgAsmElfEHFrameEntryFDList ( SgNode* s );
491
492 typedef SgAsmExecutableFileFormat base_node_type;
493
494
495// End of memberFunctionString
496
497
498 protected:
499// Start of memberFunctionString
500SgAsmElfEHFrameEntryFDPtrList p_entries;
501
502// End of memberFunctionString
503
505 friend struct Rose::Traits::generated::describe_field_t<SgAsmElfEHFrameEntryFDList, SgAsmElfEHFrameEntryFDPtrList,&SgAsmElfEHFrameEntryFDList::p_entries>;
506
507/* #line 21 "/workspace/src/ROSETTA/Grammar/grammarClassDeclarationMacros.macro" */
508
509
510 };
511#endif
512
513// postdeclarations for SgAsmElfEHFrameEntryFDList
514
515/* #line 516 "../../../src/frontend/SageIII//SgAsmElfEHFrameEntryFDList.h" */
516
517/* #line 27 "/workspace/src/ROSETTA/Grammar/grammarClassDeclarationMacros.macro after subst for $POSTDECLARATIONS" */
518
519/* #line 28 "/workspace/src/ROSETTA/Grammar/grammarClassDeclarationMacros.macro" */
520
521
522/* #line 523 "../../../src/frontend/SageIII//SgAsmElfEHFrameEntryFDList.h" */
523
524#endif // ROSE_SgAsmElfEHFrameEntryFDList_H
525
Class holding static data and functions supporting File I/O.
Definition AST_FILE_IO.h:19
Attribute containing a regex expression as a string.
List of ELF error handling frame descriptor entries.
Base class for many binary analysis 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.