ROSE 0.11.145.147
SgAsmCilAssemblyOS.h
1
2#ifndef ROSE_SgAsmCilAssemblyOS_H
3#define ROSE_SgAsmCilAssemblyOS_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 SgAsmCilAssemblyOS
23
24/* #line 25 "../../../src/frontend/SageIII//SgAsmCilAssemblyOS.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 SgAsmCilAssemblyOS
32class ROSE_DLL_API SgAsmCilAssemblyOS : public SgAsmCilMetadata
33 {
34 public:
35
36
37/* #line 38 "../../../src/frontend/SageIII//SgAsmCilAssemblyOS.h" */
38
39 virtual SgNode* copy ( SgCopyHelp& help) const override;
40// Start of memberFunctionString
41/* #line 40201 "/workspace/src/ROSETTA/src/binaryInstruction.C" */
42
43
44 //----------------------- Boost serialization for SgAsmCilAssemblyOS -----------------------
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("SgAsmCilAssemblyOS");
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 debugSerializationEnd("SgAsmCilAssemblyOS");
57 }
58#endif // ROSE_HAVE_BOOST_SERIALIZATION_LIB
59
60public:
66 uint32_t const& get_OSPlatformID() const;
67 void set_OSPlatformID(uint32_t const&);
70public:
76 uint32_t const& get_OSMajorVersion() const;
77 void set_OSMajorVersion(uint32_t const&);
80public:
86 uint32_t const& get_OSMinorVersion() const;
87 void set_OSMinorVersion(uint32_t const&);
89public:
90 void parse(const std::vector<uint8_t>& buf, size_t& index, uint64_t uses4byteIndexing);
91 void unparse(std::vector<uint8_t>& buf, size_t& index, uint64_t uses4byteIndexing) const;
92 void dump(std::ostream&) const;
93public:
95 virtual ~SgAsmCilAssemblyOS();
96
97public:
100
101protected:
109
110
111// End of memberFunctionString
112// Start of memberFunctionString
113/* #line 1 "/workspace/src/ROSETTA/Grammar/Common.code" */
114
115// *** COMMON CODE SECTION BEGINS HERE ***
116
117 public:
118
119 // DQ (3/25/3006): I put this back in because it had the logic for where the copy function required
120 // and not required which is required to match the other aspects of the copy mechanism code generation.
121 // Specifically it is a problem to declare the copy function everywhere because it is not implemented
122 // for the SgSymbol IR nodes. I'm not clear why it is not implemented for these IR nodes.
123 /* \brief Copies AST (whole subtree, depending on the SgCopyHelp class */
124 // virtual SgNode* copy ( const SgCopyHelp & help) const;
125
127 virtual std::string class_name() const override;
128
130 virtual VariantT variantT() const override; // MS: new variant used in tree traversal
131
133 // King84 (2010.08.16): Moved this to an enum to save space, since it's only used at compiler-time anyway.
134 // static const VariantT static_variant = V_SgAsmCilAssemblyOS;
135 enum { static_variant = V_SgAsmCilAssemblyOS };
136
137 /* the generated cast function */
139 ROSE_DLL_API friend SgAsmCilAssemblyOS* isSgAsmCilAssemblyOS( SgNode * s );
140
142 ROSE_DLL_API friend const SgAsmCilAssemblyOS* isSgAsmCilAssemblyOS( const SgNode * s );
143
144 // ******************************************
145 // * Memory Pool / New / Delete
146 // ******************************************
147
148 public:
150 static const unsigned pool_size; //
152 static std::vector<unsigned char *> pools; //
154 static SgAsmCilAssemblyOS * next_node; //
155
157 static unsigned long initializeStorageClassArray(SgAsmCilAssemblyOSStorageClass *); //
158
160 static void clearMemoryPool(); //
161 static void deleteMemoryPool(); //
162
164 static void extendMemoryPoolForFileIO(); //
165
167 static SgAsmCilAssemblyOS * getPointerFromGlobalIndex(unsigned long); //
169 static SgAsmCilAssemblyOS * getPointerFromGlobalIndex(AstSpecificDataManagingClass *, unsigned long); //
170
172 static unsigned long getNumberOfValidNodesAndSetGlobalIndexInFreepointer(unsigned long); //
174 static void resetValidFreepointers(); //
176 static unsigned long getNumberOfLastValidPointer(); //
177
178
179#if defined(INLINE_FUNCTIONS)
181 inline void *operator new (size_t size);
182#else
184 void *operator new (size_t size);
185#endif
187 void operator delete (void* pointer, size_t size);
188
189 // DQ (4/5/2007): This is not the correct operator that we want, but appears to be required to compile ROSE with ROSE.
190 void operator delete (void* pointer)
191 {
192 // This is the generated delete operator...
193 SgAsmCilAssemblyOS::operator delete (pointer,sizeof(SgAsmCilAssemblyOS));
194 }
195
197 static size_t numberOfNodes();
198
200 static size_t memoryUsage();
201
202 // End of scope which started in IR nodes specific code
203 /* */
204
205 /* name Internal Functions
206 \brief Internal functions ... incomplete-documentation
207
208 These functions have been made public as part of the design, but they are suggested for internal use
209 or by particularly knowledgeable users for specialized tools or applications.
210
211 \internal We could not make these private because they are required by user for special purposes. And
212 it would be unwieldy to have many of the internal classes in ROSE be explicitly defined as friends.
213
214 */
215
216 // MS: 02/12/02 container of pointers to AST successor nodes used in the traversal
217 // overridden in every class by *generated* implementation
219 virtual std::vector<SgNode*> get_traversalSuccessorContainer() override;
220 // MS: 06/28/02 container of names of variables or container indices
221 // used used in the traversal to access AST successor nodes
222 // overridden in every class by *generated* implementation
225 virtual std::vector<std::string> get_traversalSuccessorNamesContainer() override;
226
227 // GB (09/25/2007): Functions for index-based access to traversal successors; these are hopefully a lot faster
228 // than all the vector copies. The implementation for these functions is generated for each class.
230 virtual size_t get_numberOfTraversalSuccessors() override;
232 virtual SgNode *get_traversalSuccessorByIndex(size_t idx) override;
234 virtual size_t get_childIndex(SgNode *child) override;
235
236#ifndef ROSE_USE_INTERNAL_FRONTEND_DEVELOPMENT
237 // MS: 08/16/2002 method for generating RTI information
239 virtual RTIReturnType roseRTI() override;
240#endif
241 /* */
242
243
244
245 /* name Deprecated Functions
246 \brief Deprecated functions ... incomplete-documentation
247
248 These functions have been deprecated from use.
249 */
250 /* */
251
253 virtual const char* sage_class_name() const override ROSE_DEPRECATED_FUNCTION;
254
255 // JJW (10/16/2008): Changed to a single function in Node.code, and put
256 // getVariant() in #if 0 block to prevent confusing Doxygen
257#if 0
259 virtual int variant() const ROSE_DEPRECATED_FUNCTION;
261 // virtual int getVariant() const ROSE_DEPRECATED_FUNCTION;
262#endif
263 /* */
264
265
266
267
268 public:
269 /* name Traversal Support Functions
270 \brief Traversal support functions ... incomplete-documentation
271
272 These functions have been made public as part of the design, but they are suggested for internal use
273 or by particularly knowledgable users for specialized tools or applications.
274 */
275 /* */
276
277 // DQ (11/26/2005): Support for visitor pattern mechanims
278 // (inferior to ROSE traversal mechanism, experimental).
282
283 /* DXN (08/09/2010): support for the classic visitor pattern done in GoF */
285 virtual void accept (ROSE_VisitorPattern & visitor) override;
286
287 // DQ (12/26/2005): Support for traversal based on the memory pool
290 static void traverseMemoryPoolNodes(ROSE_VisitTraversal & visit);
291
295
296 // DQ (2/9/2006): Added to support traversal over single representative of each IR node
297 // This traversal helps support internal tools that call static member functions.
298 // note: this function operates on the memory pools.
301 static void visitRepresentativeNode (ROSE_VisitTraversal & visit);
302 /* */
303
304 public:
305 /* NodeId support functions */
307 static SgNode* getNodeByNodeId(VariantT variantT, size_t poolIdx, size_t itemIdx);
310 static SgAsmCilAssemblyOS* getNodeByNodeIdInternal(size_t poolIdx, size_t itemIdx);
313 static std::string getNodeIdString(SgAsmCilAssemblyOS* sgnode);
314 static std::string getNodeIdStringInternal(SgAsmCilAssemblyOS* sgnode);
315
316 public:
317 /* name Memory Allocation Functions
318 \brief Memory allocations functions ... incomplete-documentation
319
320 These functions have been made public as part of the design, but they are suggested for internal use
321 or by particularly knowledgable users for specialized tools or applications.
322 */
323 /* */
324
335 virtual bool isInMemoryPool() override;
336
347 virtual void checkDataMemberPointersIfInMemoryPool() override;
348
349 // DQ (4/30/2006): Modified to be a const function.
364 virtual std::vector<std::pair<SgNode*,std::string> > returnDataMemberPointers() const override;
365
376
388 virtual long getChildIndex( SgNode* childNode ) const override;
389
390 // DQ (9/2/2015): Since this function is generated by ROSETTA, we can't define the
391 // comment here (changed to be a C style comment and not be a doxygen comment).
392 /* \brief Constructor for use by AST File I/O Mechanism
393
394 This constructor permits the IR node to be rebuilt from the contiguously arranged data in memory
395 which obtained via fast binary file I/O from disk.
396 */
397 // SgAsmCilAssemblyOS( SgAsmCilAssemblyOSStorageClass& source );
398
399
400
401
402
403 // JH (10/24/2005): methods added to support the ast file IO
404 private:
405
406 /* name AST Memory Allocation Support Functions
407 \brief Memory allocations support....
408
409 These functions handle the low leve support of the memory allocation scheme which permits IR nodes to be allocated
410 in large contiguous blocks to reduce memory fragmentation, improve performance, support specialized access (AST traversals),
411 and support the AST File I/O Mechanism.
412 */
413 /* */
414
415 /* JH (10/24/2005): Two typedefs. The TestType notes the type every pointer is cast to before
416 we compare them. Since I had several problems with this, I decided to make a typdef to ensure
417 that I use the same type everywhere, if any changes are made. THe second one declares the type
418 (actually unsigned long) where teh pointer address gets converted to. On 64 bit platforms this
419 might got changed, but unfortunatly, the return types are still unsigned longs. There exists
420 a correspinding one in the AST_FILE_IO class!
421 */
422 // DQ (9/2/2015): This typedef is no longer used, we can't define the
423 // comment here (changed to be a C style comment and not be a doxygen comment).
424 /* \brief Typedef used for low level memory access.
425 */
426 // typedef unsigned char* TestType;
427
428 // DQ (9/2/2015): This typedef is no longer used, we can't define the
429 // comment here (changed to be a C style comment and not be a doxygen comment).
430 /* \brief Typedef used to hold memory addresses as values.
431 */
432 // typedef unsigned long AddressType;
433
434
435
436 // necessary, to have direct access to the p_freepointer and the private methods !
438 friend class AST_FILE_IO;
439
441 friend class SgAsmCilAssemblyOSStorageClass;
442
444 friend class AstSpecificDataManagingClass;
445
447 friend class AstSpecificDataManagingClassStorageClass;
448 public:
450 SgAsmCilAssemblyOS( const SgAsmCilAssemblyOSStorageClass& source );
451
452 // private: // JJW hack
453 /*
454 name AST Memory Allocation Support Variables
455 Memory allocations support variables
456
457 These variables handle the low level support of the memory allocation scheme which permits IR nodes to be allocated
458 in large contiguous blocks to reduce memory fragmentation, improve performance, support specialized access (AST traversals),
459 and support the AST File I/O Mechanism.
460 */
461 /* */
462
463 public:
464
465 // DQ (11/21/2009): Added function to add new Regular Expression attributes and return pointer
466 // to current node (so that it will work cleanly with build functions to specify patterns).
467 // virtual SgNode* addRegExpAttribute();
474
475#ifndef _MSC_VER
476// Rasmussen (04/17/2019): Support for ATerms has been deprecated as it is no longer needed
477// and likely never fully implemented nor tested. Files remain in the src tree but are no
478// longer built.
479#define BUILD_ATERM_SUPPORT 0
480 #if BUILD_ATERM_SUPPORT
481 #ifdef ROSE_USE_ROSE_ATERM_SUPPORT
482 // DQ (10/4/2014): Adding ATerm support to ROSE.
492 // Rasmussen (1/7/2019): Added override to kill warning messages of overridden virtual function
493 virtual ATerm generate_ATerm() override;
494
496 virtual void generate_ATerm_Annotation(ATerm & term) override;
497 #endif
498 #endif // BUILD_ATERM_SUPPORT
499#endif
500 // These can't be virtual functions since we don't yet know what IR node to build (until we have read the aterm).
501 // virtual generate_AST(ATerm & term);
502 // virtual void read_ATerm_Annotation(ATerm & term);
503
504// *** COMMON CODE SECTION ENDS HERE ***
505
506
507// End of memberFunctionString
508// Start of memberFunctionString
509/* #line 706 "/workspace/src/ROSETTA/Grammar/Node.code" */
510
511 // the generated cast function
512 // friend ROSE_DLL_API SgAsmCilAssemblyOS* isSgAsmCilAssemblyOS ( SgNode* s );
513
514 typedef SgAsmCilMetadata base_node_type;
515
516
517// End of memberFunctionString
518
519
520
521
522 protected:
523// Start of memberFunctionString
524uint32_t p_OSPlatformID;
525
526// End of memberFunctionString
527// Start of memberFunctionString
528uint32_t p_OSMajorVersion;
529
530// End of memberFunctionString
531// Start of memberFunctionString
532uint32_t p_OSMinorVersion;
533
534// End of memberFunctionString
535
537 friend struct Rose::Traits::generated::describe_field_t<SgAsmCilAssemblyOS, uint32_t,&SgAsmCilAssemblyOS::p_OSPlatformID>;
538 friend struct Rose::Traits::generated::describe_field_t<SgAsmCilAssemblyOS, uint32_t,&SgAsmCilAssemblyOS::p_OSMajorVersion>;
539 friend struct Rose::Traits::generated::describe_field_t<SgAsmCilAssemblyOS, uint32_t,&SgAsmCilAssemblyOS::p_OSMinorVersion>;
540
541/* #line 21 "/workspace/src/ROSETTA/Grammar/grammarClassDeclarationMacros.macro" */
542
543
544 };
545#endif
546
547// postdeclarations for SgAsmCilAssemblyOS
548
549/* #line 550 "../../../src/frontend/SageIII//SgAsmCilAssemblyOS.h" */
550
551/* #line 27 "/workspace/src/ROSETTA/Grammar/grammarClassDeclarationMacros.macro after subst for $POSTDECLARATIONS" */
552
553/* #line 28 "/workspace/src/ROSETTA/Grammar/grammarClassDeclarationMacros.macro" */
554
555
556/* #line 557 "../../../src/frontend/SageIII//SgAsmCilAssemblyOS.h" */
557
558#endif // ROSE_SgAsmCilAssemblyOS_H
559
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 AssemblyOS node (II.22.3).
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.