Core/PathSensitive/MemRegion.h

62 /// Represent a region's offset within the top level base region.
64   /// The base region.
67   /// The bit offset within the base region. Can be negative.
92 // Base region classes.
123   /// Recursively retrieve the region of the most derived class instance of
128   /// Check if the region is a subregion of the given region.
129   /// Each region is a subregion of itself.
135   /// If this is a symbolic region, returns the region. Otherwise,
136   /// goes up the base chain looking for the first symbolic base region.
149   /// Get a string representation of a region for debug use.
156   /// Returns true if this region can be printed in a user-friendly way.
159   /// Print the region for use in diagnostics.
162   /// Returns true if this region's textual representation can be used
166   /// Print the region as expression.
168   /// When this region represents a subexpression, the method is for printing
180   /// Get descriptive name for memory region. The name is obtained from
181   /// the variable/field declaration retrieved from the memory region.
187   /// \returns variable name for memory region
190   /// Retrieve source range from memory region. The range retrieval
191   /// is based on the decl obtained from the memory region.
192   /// For a VarRegion the range of the base region is returned.
197   /// \returns source range for declaration retrieved from memory region
201 /// MemSpaceRegion - A memory region that represents a "memory space";
255 /// The region of the static variables within the current CodeTextRegion
283 /// The region for all the non-static global variables.
288 /// globals, we invalidate the whole parent region).
306 /// The region containing globals which are defined in system/external
322 /// The region containing globals which are considered not to be modified
325 /// this region. This region also includes most system globals since they have
341 /// The region containing globals which can be modified by calls to
439 /// SubRegion - A region that subsets another larger region.  Most regions
471 /// AllocaRegion - A region that represents an untyped blob of bytes created
578 /// FunctionCodeRegion - A region that represents code texts of function.
620 /// BlockCodeRegion - A region that represents code texts of blocks (closures).
667 /// BlockDataRegion - A region that represents a block instance.
748   /// Return the original region for a captured region, if
770 /// SymbolicRegion - A special, "non-concrete" region. Unlike other region
771 ///  classes, SymbolicRegion represents a region that serves as an alias for
772 ///  either a real region, a NULL pointer, etc.  It essentially is used to
857 /// The region associated with an ObjCStringLiteral.
892 /// CompoundLiteralRegion - A memory region representing a compound literal.
1019 /// ParamVarRegion - Represents a region for paremters. Only parameters of the
1066 /// CXXThisRegion - Represents the region for the implicit 'this' parameter
1067 ///  in a call to a C++ method.  This region doesn't represent the object
1077            "Invalid region type!");
1207            "Invalid region type!");
1305 // identified by the base class declaration and the region of its parent object.
1335   static bool classof(const MemRegion *region) {
1336     return region->getKind() == CXXBaseObjectRegionKind;
1342 // region of its parent object. It is a bit counter-intuitive (but not otherwise
1343 // unseen) that this region represents a larger segment of memory that its
1344 // super-region.
1353     // In case of a concrete region, it should always be possible to model
1357            "Should have unwrapped a base region instead!");
1377   static bool classof(const MemRegion *region) {
1378     return region->getKind() == CXXDerivedObjectRegionKind;
1429   /// \returns The static size in bytes of the region \p MR.
1430   /// \note The region \p MR must be a 'SubRegion'.
1434   /// getStackLocalsRegion - Retrieve the memory region associated with the
1439   /// getStackArgumentsRegion - Retrieve the memory region associated with
1444   /// getGlobalsRegion - Retrieve the memory region associated with
1450   /// getHeapRegion - Retrieve the memory region associated with the
1454   /// getUnknownRegion - Retrieve the memory region associated with unknown
1460   /// getAllocaRegion - Retrieve a region associated with a call to alloca().
1464   /// getCompoundLiteralRegion - Retrieve the region associated with a
1470   /// getCXXThisRegion - Retrieve the [artificial] region associated with the
1475   /// Retrieve or create a "symbolic" memory region.
1480   /// Return a unique symbolic region belonging to heap memory space.
1487   /// getVarRegion - Retrieve or create the memory region associated with
1491   /// getVarRegion - Retrieve or create the memory region associated with
1496   /// getParamVarRegion - Retrieve or create the memory region
1502   /// getElementRegion - Retrieve the memory region associated with the
1503   ///  associated element type, index, and super region.
1514   /// getFieldRegion - Retrieve or create the memory region associated with
1516   ///  memory region (which typically represents the memory representing
1526   /// getObjCIvarRegion - Retrieve or create the memory region associated with
1528   ///   to the containing region (which typically represents the Objective-C
1545   /// ValueDecl const *, LocationContext const *) in the super-region used.
1549   /// Create a CXXBaseObjectRegion with the given base class for region
1558   /// super region.
1566   /// Create a CXXDerivedObjectRegion with the given derived class for region
1579   /// getBlockDataRegion - Get the memory region associated with an instance
1605   const REG* LazyAllocate(REG*& region);
1608   const REG* LazyAllocate(REG*& region, ARG a);
1620 // Means for storing region/symbol handling traits.
1623 /// Information about invalidation for a particular region/symbol.
1638     /// Tells that a region's contents is not changed.
1641     /// Suppress pointer-escaping of a region.
1644     // Do not invalidate super region.