ROSE 0.11.145.147
SgAsmCilFieldMarshal.h
1
2#ifndef ROSE_SgAsmCilFieldMarshal_H
3#define ROSE_SgAsmCilFieldMarshal_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 SgAsmCilFieldMarshal
23
24/* #line 25 "../../../src/frontend/SageIII//SgAsmCilFieldMarshal.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 SgAsmCilFieldMarshal
32class ROSE_DLL_API SgAsmCilFieldMarshal : public SgAsmCilMetadata
33 {
34 public:
35
36
37/* #line 38 "../../../src/frontend/SageIII//SgAsmCilFieldMarshal.h" */
38
39 virtual SgNode* copy ( SgCopyHelp& help) const override;
40// Start of memberFunctionString
41/* #line 37344 "/workspace/src/ROSETTA/src/binaryInstruction.C" */
42
43
44 //----------------------- Boost serialization for SgAsmCilFieldMarshal -----------------------
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("SgAsmCilFieldMarshal");
52 s & BOOST_SERIALIZATION_BASE_OBJECT_NVP(SgAsmCilMetadata);
53 s & BOOST_SERIALIZATION_NVP(p_Parent);
54 s & BOOST_SERIALIZATION_NVP(p_NativeType);
55 debugSerializationEnd("SgAsmCilFieldMarshal");
56 }
57#endif // ROSE_HAVE_BOOST_SERIALIZATION_LIB
58
59public:
65 uint32_t const& get_Parent() const;
66 void set_Parent(uint32_t const&);
69public:
75 uint32_t const& get_NativeType() const;
76 void set_NativeType(uint32_t const&);
78public:
79 void parse(const std::vector<uint8_t>& buf, size_t& index, uint64_t uses4byteIndexing);
80 void unparse(std::vector<uint8_t>& buf, size_t& index, uint64_t uses4byteIndexing) const;
81 void dump(std::ostream&) const;
82
83 const SgAsmCilMetadata* get_Parent_object() const;
84 const std::uint8_t* get_NativeType_blob() const;
85public:
87 virtual ~SgAsmCilFieldMarshal();
88
89public:
92
93protected:
101
102
103// End of memberFunctionString
104// Start of memberFunctionString
105/* #line 1 "/workspace/src/ROSETTA/Grammar/Common.code" */
106
107// *** COMMON CODE SECTION BEGINS HERE ***
108
109 public:
110
111 // DQ (3/25/3006): I put this back in because it had the logic for where the copy function required
112 // and not required which is required to match the other aspects of the copy mechanism code generation.
113 // Specifically it is a problem to declare the copy function everywhere because it is not implemented
114 // for the SgSymbol IR nodes. I'm not clear why it is not implemented for these IR nodes.
115 /* \brief Copies AST (whole subtree, depending on the SgCopyHelp class */
116 // virtual SgNode* copy ( const SgCopyHelp & help) const;
117
119 virtual std::string class_name() const override;
120
122 virtual VariantT variantT() const override; // MS: new variant used in tree traversal
123
125 // King84 (2010.08.16): Moved this to an enum to save space, since it's only used at compiler-time anyway.
126 // static const VariantT static_variant = V_SgAsmCilFieldMarshal;
127 enum { static_variant = V_SgAsmCilFieldMarshal };
128
129 /* the generated cast function */
131 ROSE_DLL_API friend SgAsmCilFieldMarshal* isSgAsmCilFieldMarshal( SgNode * s );
132
134 ROSE_DLL_API friend const SgAsmCilFieldMarshal* isSgAsmCilFieldMarshal( const SgNode * s );
135
136 // ******************************************
137 // * Memory Pool / New / Delete
138 // ******************************************
139
140 public:
142 static const unsigned pool_size; //
144 static std::vector<unsigned char *> pools; //
146 static SgAsmCilFieldMarshal * next_node; //
147
149 static unsigned long initializeStorageClassArray(SgAsmCilFieldMarshalStorageClass *); //
150
152 static void clearMemoryPool(); //
153 static void deleteMemoryPool(); //
154
156 static void extendMemoryPoolForFileIO(); //
157
159 static SgAsmCilFieldMarshal * getPointerFromGlobalIndex(unsigned long); //
161 static SgAsmCilFieldMarshal * getPointerFromGlobalIndex(AstSpecificDataManagingClass *, unsigned long); //
162
164 static unsigned long getNumberOfValidNodesAndSetGlobalIndexInFreepointer(unsigned long); //
166 static void resetValidFreepointers(); //
168 static unsigned long getNumberOfLastValidPointer(); //
169
170
171#if defined(INLINE_FUNCTIONS)
173 inline void *operator new (size_t size);
174#else
176 void *operator new (size_t size);
177#endif
179 void operator delete (void* pointer, size_t size);
180
181 // DQ (4/5/2007): This is not the correct operator that we want, but appears to be required to compile ROSE with ROSE.
182 void operator delete (void* pointer)
183 {
184 // This is the generated delete operator...
185 SgAsmCilFieldMarshal::operator delete (pointer,sizeof(SgAsmCilFieldMarshal));
186 }
187
189 static size_t numberOfNodes();
190
192 static size_t memoryUsage();
193
194 // End of scope which started in IR nodes specific code
195 /* */
196
197 /* name Internal Functions
198 \brief Internal functions ... incomplete-documentation
199
200 These functions have been made public as part of the design, but they are suggested for internal use
201 or by particularly knowledgeable users for specialized tools or applications.
202
203 \internal We could not make these private because they are required by user for special purposes. And
204 it would be unwieldy to have many of the internal classes in ROSE be explicitly defined as friends.
205
206 */
207
208 // MS: 02/12/02 container of pointers to AST successor nodes used in the traversal
209 // overridden in every class by *generated* implementation
211 virtual std::vector<SgNode*> get_traversalSuccessorContainer() override;
212 // MS: 06/28/02 container of names of variables or container indices
213 // used used in the traversal to access AST successor nodes
214 // overridden in every class by *generated* implementation
217 virtual std::vector<std::string> get_traversalSuccessorNamesContainer() override;
218
219 // GB (09/25/2007): Functions for index-based access to traversal successors; these are hopefully a lot faster
220 // than all the vector copies. The implementation for these functions is generated for each class.
222 virtual size_t get_numberOfTraversalSuccessors() override;
224 virtual SgNode *get_traversalSuccessorByIndex(size_t idx) override;
226 virtual size_t get_childIndex(SgNode *child) override;
227
228#ifndef ROSE_USE_INTERNAL_FRONTEND_DEVELOPMENT
229 // MS: 08/16/2002 method for generating RTI information
231 virtual RTIReturnType roseRTI() override;
232#endif
233 /* */
234
235
236
237 /* name Deprecated Functions
238 \brief Deprecated functions ... incomplete-documentation
239
240 These functions have been deprecated from use.
241 */
242 /* */
243
245 virtual const char* sage_class_name() const override ROSE_DEPRECATED_FUNCTION;
246
247 // JJW (10/16/2008): Changed to a single function in Node.code, and put
248 // getVariant() in #if 0 block to prevent confusing Doxygen
249#if 0
251 virtual int variant() const ROSE_DEPRECATED_FUNCTION;
253 // virtual int getVariant() const ROSE_DEPRECATED_FUNCTION;
254#endif
255 /* */
256
257
258
259
260 public:
261 /* name Traversal Support Functions
262 \brief Traversal support functions ... incomplete-documentation
263
264 These functions have been made public as part of the design, but they are suggested for internal use
265 or by particularly knowledgable users for specialized tools or applications.
266 */
267 /* */
268
269 // DQ (11/26/2005): Support for visitor pattern mechanims
270 // (inferior to ROSE traversal mechanism, experimental).
274
275 /* DXN (08/09/2010): support for the classic visitor pattern done in GoF */
277 virtual void accept (ROSE_VisitorPattern & visitor) override;
278
279 // DQ (12/26/2005): Support for traversal based on the memory pool
282 static void traverseMemoryPoolNodes(ROSE_VisitTraversal & visit);
283
287
288 // DQ (2/9/2006): Added to support traversal over single representative of each IR node
289 // This traversal helps support internal tools that call static member functions.
290 // note: this function operates on the memory pools.
293 static void visitRepresentativeNode (ROSE_VisitTraversal & visit);
294 /* */
295
296 public:
297 /* NodeId support functions */
299 static SgNode* getNodeByNodeId(VariantT variantT, size_t poolIdx, size_t itemIdx);
302 static SgAsmCilFieldMarshal* getNodeByNodeIdInternal(size_t poolIdx, size_t itemIdx);
305 static std::string getNodeIdString(SgAsmCilFieldMarshal* sgnode);
306 static std::string getNodeIdStringInternal(SgAsmCilFieldMarshal* sgnode);
307
308 public:
309 /* name Memory Allocation Functions
310 \brief Memory allocations functions ... incomplete-documentation
311
312 These functions have been made public as part of the design, but they are suggested for internal use
313 or by particularly knowledgable users for specialized tools or applications.
314 */
315 /* */
316
327 virtual bool isInMemoryPool() override;
328
339 virtual void checkDataMemberPointersIfInMemoryPool() override;
340
341 // DQ (4/30/2006): Modified to be a const function.
356 virtual std::vector<std::pair<SgNode*,std::string> > returnDataMemberPointers() const override;
357
368
380 virtual long getChildIndex( SgNode* childNode ) const override;
381
382 // DQ (9/2/2015): Since this function is generated by ROSETTA, we can't define the
383 // comment here (changed to be a C style comment and not be a doxygen comment).
384 /* \brief Constructor for use by AST File I/O Mechanism
385
386 This constructor permits the IR node to be rebuilt from the contiguously arranged data in memory
387 which obtained via fast binary file I/O from disk.
388 */
389 // SgAsmCilFieldMarshal( SgAsmCilFieldMarshalStorageClass& source );
390
391
392
393
394
395 // JH (10/24/2005): methods added to support the ast file IO
396 private:
397
398 /* name AST Memory Allocation Support Functions
399 \brief Memory allocations support....
400
401 These functions handle the low leve support of the memory allocation scheme which permits IR nodes to be allocated
402 in large contiguous blocks to reduce memory fragmentation, improve performance, support specialized access (AST traversals),
403 and support the AST File I/O Mechanism.
404 */
405 /* */
406
407 /* JH (10/24/2005): Two typedefs. The TestType notes the type every pointer is cast to before
408 we compare them. Since I had several problems with this, I decided to make a typdef to ensure
409 that I use the same type everywhere, if any changes are made. THe second one declares the type
410 (actually unsigned long) where teh pointer address gets converted to. On 64 bit platforms this
411 might got changed, but unfortunatly, the return types are still unsigned longs. There exists
412 a correspinding one in the AST_FILE_IO class!
413 */
414 // DQ (9/2/2015): This typedef is no longer used, we can't define the
415 // comment here (changed to be a C style comment and not be a doxygen comment).
416 /* \brief Typedef used for low level memory access.
417 */
418 // typedef unsigned char* TestType;
419
420 // DQ (9/2/2015): This typedef is no longer used, we can't define the
421 // comment here (changed to be a C style comment and not be a doxygen comment).
422 /* \brief Typedef used to hold memory addresses as values.
423 */
424 // typedef unsigned long AddressType;
425
426
427
428 // necessary, to have direct access to the p_freepointer and the private methods !
430 friend class AST_FILE_IO;
431
433 friend class SgAsmCilFieldMarshalStorageClass;
434
436 friend class AstSpecificDataManagingClass;
437
439 friend class AstSpecificDataManagingClassStorageClass;
440 public:
442 SgAsmCilFieldMarshal( const SgAsmCilFieldMarshalStorageClass& source );
443
444 // private: // JJW hack
445 /*
446 name AST Memory Allocation Support Variables
447 Memory allocations support variables
448
449 These variables handle the low level support of the memory allocation scheme which permits IR nodes to be allocated
450 in large contiguous blocks to reduce memory fragmentation, improve performance, support specialized access (AST traversals),
451 and support the AST File I/O Mechanism.
452 */
453 /* */
454
455 public:
456
457 // DQ (11/21/2009): Added function to add new Regular Expression attributes and return pointer
458 // to current node (so that it will work cleanly with build functions to specify patterns).
459 // virtual SgNode* addRegExpAttribute();
466
467#ifndef _MSC_VER
468// Rasmussen (04/17/2019): Support for ATerms has been deprecated as it is no longer needed
469// and likely never fully implemented nor tested. Files remain in the src tree but are no
470// longer built.
471#define BUILD_ATERM_SUPPORT 0
472 #if BUILD_ATERM_SUPPORT
473 #ifdef ROSE_USE_ROSE_ATERM_SUPPORT
474 // DQ (10/4/2014): Adding ATerm support to ROSE.
484 // Rasmussen (1/7/2019): Added override to kill warning messages of overridden virtual function
485 virtual ATerm generate_ATerm() override;
486
488 virtual void generate_ATerm_Annotation(ATerm & term) override;
489 #endif
490 #endif // BUILD_ATERM_SUPPORT
491#endif
492 // These can't be virtual functions since we don't yet know what IR node to build (until we have read the aterm).
493 // virtual generate_AST(ATerm & term);
494 // virtual void read_ATerm_Annotation(ATerm & term);
495
496// *** COMMON CODE SECTION ENDS HERE ***
497
498
499// End of memberFunctionString
500// Start of memberFunctionString
501/* #line 706 "/workspace/src/ROSETTA/Grammar/Node.code" */
502
503 // the generated cast function
504 // friend ROSE_DLL_API SgAsmCilFieldMarshal* isSgAsmCilFieldMarshal ( SgNode* s );
505
506 typedef SgAsmCilMetadata base_node_type;
507
508
509// End of memberFunctionString
510
511
512
513 protected:
514// Start of memberFunctionString
515uint32_t p_Parent;
516
517// End of memberFunctionString
518// Start of memberFunctionString
519uint32_t p_NativeType;
520
521// End of memberFunctionString
522
524 friend struct Rose::Traits::generated::describe_field_t<SgAsmCilFieldMarshal, uint32_t,&SgAsmCilFieldMarshal::p_Parent>;
525 friend struct Rose::Traits::generated::describe_field_t<SgAsmCilFieldMarshal, uint32_t,&SgAsmCilFieldMarshal::p_NativeType>;
526
527/* #line 21 "/workspace/src/ROSETTA/Grammar/grammarClassDeclarationMacros.macro" */
528
529
530 };
531#endif
532
533// postdeclarations for SgAsmCilFieldMarshal
534
535/* #line 536 "../../../src/frontend/SageIII//SgAsmCilFieldMarshal.h" */
536
537/* #line 27 "/workspace/src/ROSETTA/Grammar/grammarClassDeclarationMacros.macro after subst for $POSTDECLARATIONS" */
538
539/* #line 28 "/workspace/src/ROSETTA/Grammar/grammarClassDeclarationMacros.macro" */
540
541
542/* #line 543 "../../../src/frontend/SageIII//SgAsmCilFieldMarshal.h" */
543
544#endif // ROSE_SgAsmCilFieldMarshal_H
545
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 FieldMarshal node (II.22.17).
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.