ROSE 0.11.145.147
SgAsmCilAssemblyRefOS.h
1
2#ifndef ROSE_SgAsmCilAssemblyRefOS_H
3#define ROSE_SgAsmCilAssemblyRefOS_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 SgAsmCilAssemblyRefOS
23
24/* #line 25 "../../../src/frontend/SageIII//SgAsmCilAssemblyRefOS.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 SgAsmCilAssemblyRefOS
32class ROSE_DLL_API SgAsmCilAssemblyRefOS : public SgAsmCilMetadata
33 {
34 public:
35
36
37/* #line 38 "../../../src/frontend/SageIII//SgAsmCilAssemblyRefOS.h" */
38
39 virtual SgNode* copy ( SgCopyHelp& help) const override;
40// Start of memberFunctionString
41/* #line 39659 "/workspace/src/ROSETTA/src/binaryInstruction.C" */
42
43
44 //----------------------- Boost serialization for SgAsmCilAssemblyRefOS -----------------------
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("SgAsmCilAssemblyRefOS");
52 s & BOOST_SERIALIZATION_BASE_OBJECT_NVP(SgAsmCilMetadata);
53 s & BOOST_SERIALIZATION_NVP(p_OSPlatformID);
54 s & BOOST_SERIALIZATION_NVP(p_OSMajorVersion);
55 s & BOOST_SERIALIZATION_NVP(p_OSMinorVersion);
56 s & BOOST_SERIALIZATION_NVP(p_AssemblyRefOS);
57 debugSerializationEnd("SgAsmCilAssemblyRefOS");
58 }
59#endif // ROSE_HAVE_BOOST_SERIALIZATION_LIB
60
61public:
67 uint32_t const& get_OSPlatformID() const;
68 void set_OSPlatformID(uint32_t const&);
71public:
77 uint32_t const& get_OSMajorVersion() const;
78 void set_OSMajorVersion(uint32_t const&);
81public:
87 uint32_t const& get_OSMinorVersion() const;
88 void set_OSMinorVersion(uint32_t const&);
91public:
97 uint32_t const& get_AssemblyRefOS() const;
98 void set_AssemblyRefOS(uint32_t const&);
100public:
101 void parse(const std::vector<uint8_t>& buf, size_t& index, uint64_t uses4byteIndexing);
102 void unparse(std::vector<uint8_t>& buf, size_t& index, uint64_t uses4byteIndexing) const;
103 void dump(std::ostream&) const;
104
105 const SgAsmCilMetadata* get_AssemblyRefOS_object() const;
106public:
108 virtual ~SgAsmCilAssemblyRefOS();
109
110public:
113
114protected:
122
123
124// End of memberFunctionString
125// Start of memberFunctionString
126/* #line 1 "/workspace/src/ROSETTA/Grammar/Common.code" */
127
128// *** COMMON CODE SECTION BEGINS HERE ***
129
130 public:
131
132 // DQ (3/25/3006): I put this back in because it had the logic for where the copy function required
133 // and not required which is required to match the other aspects of the copy mechanism code generation.
134 // Specifically it is a problem to declare the copy function everywhere because it is not implemented
135 // for the SgSymbol IR nodes. I'm not clear why it is not implemented for these IR nodes.
136 /* \brief Copies AST (whole subtree, depending on the SgCopyHelp class */
137 // virtual SgNode* copy ( const SgCopyHelp & help) const;
138
140 virtual std::string class_name() const override;
141
143 virtual VariantT variantT() const override; // MS: new variant used in tree traversal
144
146 // King84 (2010.08.16): Moved this to an enum to save space, since it's only used at compiler-time anyway.
147 // static const VariantT static_variant = V_SgAsmCilAssemblyRefOS;
148 enum { static_variant = V_SgAsmCilAssemblyRefOS };
149
150 /* the generated cast function */
152 ROSE_DLL_API friend SgAsmCilAssemblyRefOS* isSgAsmCilAssemblyRefOS( SgNode * s );
153
155 ROSE_DLL_API friend const SgAsmCilAssemblyRefOS* isSgAsmCilAssemblyRefOS( const SgNode * s );
156
157 // ******************************************
158 // * Memory Pool / New / Delete
159 // ******************************************
160
161 public:
163 static const unsigned pool_size; //
165 static std::vector<unsigned char *> pools; //
167 static SgAsmCilAssemblyRefOS * next_node; //
168
170 static unsigned long initializeStorageClassArray(SgAsmCilAssemblyRefOSStorageClass *); //
171
173 static void clearMemoryPool(); //
174 static void deleteMemoryPool(); //
175
177 static void extendMemoryPoolForFileIO(); //
178
180 static SgAsmCilAssemblyRefOS * getPointerFromGlobalIndex(unsigned long); //
182 static SgAsmCilAssemblyRefOS * getPointerFromGlobalIndex(AstSpecificDataManagingClass *, unsigned long); //
183
185 static unsigned long getNumberOfValidNodesAndSetGlobalIndexInFreepointer(unsigned long); //
187 static void resetValidFreepointers(); //
189 static unsigned long getNumberOfLastValidPointer(); //
190
191
192#if defined(INLINE_FUNCTIONS)
194 inline void *operator new (size_t size);
195#else
197 void *operator new (size_t size);
198#endif
200 void operator delete (void* pointer, size_t size);
201
202 // DQ (4/5/2007): This is not the correct operator that we want, but appears to be required to compile ROSE with ROSE.
203 void operator delete (void* pointer)
204 {
205 // This is the generated delete operator...
206 SgAsmCilAssemblyRefOS::operator delete (pointer,sizeof(SgAsmCilAssemblyRefOS));
207 }
208
210 static size_t numberOfNodes();
211
213 static size_t memoryUsage();
214
215 // End of scope which started in IR nodes specific code
216 /* */
217
218 /* name Internal Functions
219 \brief Internal functions ... incomplete-documentation
220
221 These functions have been made public as part of the design, but they are suggested for internal use
222 or by particularly knowledgeable users for specialized tools or applications.
223
224 \internal We could not make these private because they are required by user for special purposes. And
225 it would be unwieldy to have many of the internal classes in ROSE be explicitly defined as friends.
226
227 */
228
229 // MS: 02/12/02 container of pointers to AST successor nodes used in the traversal
230 // overridden in every class by *generated* implementation
232 virtual std::vector<SgNode*> get_traversalSuccessorContainer() override;
233 // MS: 06/28/02 container of names of variables or container indices
234 // used used in the traversal to access AST successor nodes
235 // overridden in every class by *generated* implementation
238 virtual std::vector<std::string> get_traversalSuccessorNamesContainer() override;
239
240 // GB (09/25/2007): Functions for index-based access to traversal successors; these are hopefully a lot faster
241 // than all the vector copies. The implementation for these functions is generated for each class.
243 virtual size_t get_numberOfTraversalSuccessors() override;
245 virtual SgNode *get_traversalSuccessorByIndex(size_t idx) override;
247 virtual size_t get_childIndex(SgNode *child) override;
248
249#ifndef ROSE_USE_INTERNAL_FRONTEND_DEVELOPMENT
250 // MS: 08/16/2002 method for generating RTI information
252 virtual RTIReturnType roseRTI() override;
253#endif
254 /* */
255
256
257
258 /* name Deprecated Functions
259 \brief Deprecated functions ... incomplete-documentation
260
261 These functions have been deprecated from use.
262 */
263 /* */
264
266 virtual const char* sage_class_name() const override ROSE_DEPRECATED_FUNCTION;
267
268 // JJW (10/16/2008): Changed to a single function in Node.code, and put
269 // getVariant() in #if 0 block to prevent confusing Doxygen
270#if 0
272 virtual int variant() const ROSE_DEPRECATED_FUNCTION;
274 // virtual int getVariant() const ROSE_DEPRECATED_FUNCTION;
275#endif
276 /* */
277
278
279
280
281 public:
282 /* name Traversal Support Functions
283 \brief Traversal support functions ... incomplete-documentation
284
285 These functions have been made public as part of the design, but they are suggested for internal use
286 or by particularly knowledgable users for specialized tools or applications.
287 */
288 /* */
289
290 // DQ (11/26/2005): Support for visitor pattern mechanims
291 // (inferior to ROSE traversal mechanism, experimental).
295
296 /* DXN (08/09/2010): support for the classic visitor pattern done in GoF */
298 virtual void accept (ROSE_VisitorPattern & visitor) override;
299
300 // DQ (12/26/2005): Support for traversal based on the memory pool
303 static void traverseMemoryPoolNodes(ROSE_VisitTraversal & visit);
304
308
309 // DQ (2/9/2006): Added to support traversal over single representative of each IR node
310 // This traversal helps support internal tools that call static member functions.
311 // note: this function operates on the memory pools.
314 static void visitRepresentativeNode (ROSE_VisitTraversal & visit);
315 /* */
316
317 public:
318 /* NodeId support functions */
320 static SgNode* getNodeByNodeId(VariantT variantT, size_t poolIdx, size_t itemIdx);
323 static SgAsmCilAssemblyRefOS* getNodeByNodeIdInternal(size_t poolIdx, size_t itemIdx);
326 static std::string getNodeIdString(SgAsmCilAssemblyRefOS* sgnode);
327 static std::string getNodeIdStringInternal(SgAsmCilAssemblyRefOS* sgnode);
328
329 public:
330 /* name Memory Allocation Functions
331 \brief Memory allocations functions ... incomplete-documentation
332
333 These functions have been made public as part of the design, but they are suggested for internal use
334 or by particularly knowledgable users for specialized tools or applications.
335 */
336 /* */
337
348 virtual bool isInMemoryPool() override;
349
360 virtual void checkDataMemberPointersIfInMemoryPool() override;
361
362 // DQ (4/30/2006): Modified to be a const function.
377 virtual std::vector<std::pair<SgNode*,std::string> > returnDataMemberPointers() const override;
378
389
401 virtual long getChildIndex( SgNode* childNode ) const override;
402
403 // DQ (9/2/2015): Since this function is generated by ROSETTA, we can't define the
404 // comment here (changed to be a C style comment and not be a doxygen comment).
405 /* \brief Constructor for use by AST File I/O Mechanism
406
407 This constructor permits the IR node to be rebuilt from the contiguously arranged data in memory
408 which obtained via fast binary file I/O from disk.
409 */
410 // SgAsmCilAssemblyRefOS( SgAsmCilAssemblyRefOSStorageClass& source );
411
412
413
414
415
416 // JH (10/24/2005): methods added to support the ast file IO
417 private:
418
419 /* name AST Memory Allocation Support Functions
420 \brief Memory allocations support....
421
422 These functions handle the low leve support of the memory allocation scheme which permits IR nodes to be allocated
423 in large contiguous blocks to reduce memory fragmentation, improve performance, support specialized access (AST traversals),
424 and support the AST File I/O Mechanism.
425 */
426 /* */
427
428 /* JH (10/24/2005): Two typedefs. The TestType notes the type every pointer is cast to before
429 we compare them. Since I had several problems with this, I decided to make a typdef to ensure
430 that I use the same type everywhere, if any changes are made. THe second one declares the type
431 (actually unsigned long) where teh pointer address gets converted to. On 64 bit platforms this
432 might got changed, but unfortunatly, the return types are still unsigned longs. There exists
433 a correspinding one in the AST_FILE_IO class!
434 */
435 // DQ (9/2/2015): This typedef is no longer used, we can't define the
436 // comment here (changed to be a C style comment and not be a doxygen comment).
437 /* \brief Typedef used for low level memory access.
438 */
439 // typedef unsigned char* TestType;
440
441 // DQ (9/2/2015): This typedef is no longer used, we can't define the
442 // comment here (changed to be a C style comment and not be a doxygen comment).
443 /* \brief Typedef used to hold memory addresses as values.
444 */
445 // typedef unsigned long AddressType;
446
447
448
449 // necessary, to have direct access to the p_freepointer and the private methods !
451 friend class AST_FILE_IO;
452
454 friend class SgAsmCilAssemblyRefOSStorageClass;
455
457 friend class AstSpecificDataManagingClass;
458
460 friend class AstSpecificDataManagingClassStorageClass;
461 public:
463 SgAsmCilAssemblyRefOS( const SgAsmCilAssemblyRefOSStorageClass& source );
464
465 // private: // JJW hack
466 /*
467 name AST Memory Allocation Support Variables
468 Memory allocations support variables
469
470 These variables handle the low level support of the memory allocation scheme which permits IR nodes to be allocated
471 in large contiguous blocks to reduce memory fragmentation, improve performance, support specialized access (AST traversals),
472 and support the AST File I/O Mechanism.
473 */
474 /* */
475
476 public:
477
478 // DQ (11/21/2009): Added function to add new Regular Expression attributes and return pointer
479 // to current node (so that it will work cleanly with build functions to specify patterns).
480 // virtual SgNode* addRegExpAttribute();
487
488#ifndef _MSC_VER
489// Rasmussen (04/17/2019): Support for ATerms has been deprecated as it is no longer needed
490// and likely never fully implemented nor tested. Files remain in the src tree but are no
491// longer built.
492#define BUILD_ATERM_SUPPORT 0
493 #if BUILD_ATERM_SUPPORT
494 #ifdef ROSE_USE_ROSE_ATERM_SUPPORT
495 // DQ (10/4/2014): Adding ATerm support to ROSE.
505 // Rasmussen (1/7/2019): Added override to kill warning messages of overridden virtual function
506 virtual ATerm generate_ATerm() override;
507
509 virtual void generate_ATerm_Annotation(ATerm & term) override;
510 #endif
511 #endif // BUILD_ATERM_SUPPORT
512#endif
513 // These can't be virtual functions since we don't yet know what IR node to build (until we have read the aterm).
514 // virtual generate_AST(ATerm & term);
515 // virtual void read_ATerm_Annotation(ATerm & term);
516
517// *** COMMON CODE SECTION ENDS HERE ***
518
519
520// End of memberFunctionString
521// Start of memberFunctionString
522/* #line 706 "/workspace/src/ROSETTA/Grammar/Node.code" */
523
524 // the generated cast function
525 // friend ROSE_DLL_API SgAsmCilAssemblyRefOS* isSgAsmCilAssemblyRefOS ( SgNode* s );
526
527 typedef SgAsmCilMetadata base_node_type;
528
529
530// End of memberFunctionString
531
532
533
534
535
536 protected:
537// Start of memberFunctionString
538uint32_t p_OSPlatformID;
539
540// End of memberFunctionString
541// Start of memberFunctionString
542uint32_t p_OSMajorVersion;
543
544// End of memberFunctionString
545// Start of memberFunctionString
546uint32_t p_OSMinorVersion;
547
548// End of memberFunctionString
549// Start of memberFunctionString
550uint32_t p_AssemblyRefOS;
551
552// End of memberFunctionString
553
555 friend struct Rose::Traits::generated::describe_field_t<SgAsmCilAssemblyRefOS, uint32_t,&SgAsmCilAssemblyRefOS::p_OSPlatformID>;
556 friend struct Rose::Traits::generated::describe_field_t<SgAsmCilAssemblyRefOS, uint32_t,&SgAsmCilAssemblyRefOS::p_OSMajorVersion>;
557 friend struct Rose::Traits::generated::describe_field_t<SgAsmCilAssemblyRefOS, uint32_t,&SgAsmCilAssemblyRefOS::p_OSMinorVersion>;
558 friend struct Rose::Traits::generated::describe_field_t<SgAsmCilAssemblyRefOS, uint32_t,&SgAsmCilAssemblyRefOS::p_AssemblyRefOS>;
559
560/* #line 21 "/workspace/src/ROSETTA/Grammar/grammarClassDeclarationMacros.macro" */
561
562
563 };
564#endif
565
566// postdeclarations for SgAsmCilAssemblyRefOS
567
568/* #line 569 "../../../src/frontend/SageIII//SgAsmCilAssemblyRefOS.h" */
569
570/* #line 27 "/workspace/src/ROSETTA/Grammar/grammarClassDeclarationMacros.macro after subst for $POSTDECLARATIONS" */
571
572/* #line 28 "/workspace/src/ROSETTA/Grammar/grammarClassDeclarationMacros.macro" */
573
574
575/* #line 576 "../../../src/frontend/SageIII//SgAsmCilAssemblyRefOS.h" */
576
577#endif // ROSE_SgAsmCilAssemblyRefOS_H
578
Class holding static data and functions supporting File I/O.
Definition AST_FILE_IO.h:19
Attribute containing a regex expression as a string.
CIL AssemblyRefOS node (II.22.6).
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 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.