src/mc/inspect/Type.hpp

   1 /* Copyright (c) 2007-2019. The SimGrid Team. All rights reserved.          */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4  * under the terms of the license (GNU LGPL) which comes with this package. */
   5
   6 #ifndef SIMGRID_MC_TYPE_HPP
   7 #define SIMGRID_MC_TYPE_HPP
   8
   9 #include <cstddef>
  10
  11 #include <string>
  12 #include <vector>
  13
  14 #include "xbt/asserts.h"
  15 #include "xbt/base.h"
  16
  17 #include "src/mc/inspect/LocationList.hpp"
  18 #include "src/mc/mc_forward.hpp"
  19
  20 namespace simgrid {
  21 namespace mc {
  22
  23 /** A member of a structure, union
  24  *
  25  *  Inheritance is seen as a special member as well.
  26  */
  27 class Member {
  28 public:
  29   typedef int flags_type;
  30   static constexpr flags_type INHERITANCE_FLAG     = 1;
  31   static constexpr flags_type VIRTUAL_POINTER_FLAG = 2;
  32
  33   Member() = default;
  34
  35   /** Whether this member represent some inherited part of the object */
  36   flags_type flags = 0;
  37
  38   /** Name of the member (if any) */
  39   std::string name;
  40
  41   /** DWARF location expression for locating the location of the member */
  42   simgrid::dwarf::DwarfExpression location_expression;
  43
  44   std::size_t byte_size = 0; // Do we really need this?
  45
  46   unsigned type_id        = 0;
  47   simgrid::mc::Type* type = nullptr;
  48
  49   bool isInheritance() const { return this->flags & INHERITANCE_FLAG; }
  50   bool isVirtualPointer() const { return this->flags & VIRTUAL_POINTER_FLAG; }
  51
  52   /** Whether the member is at a fixed offset from the base address */
  53   bool has_offset_location() const
  54   {
  55     // Recognize the expression `DW_OP_plus_uconst(offset)`:
  56     return location_expression.size() == 1 && location_expression[0].atom == DW_OP_plus_uconst;
  57   }
  58
  59   /** Get the offset of the member
  60    *
  61    *  This is only valid is the member is at a fixed offset from the base.
  62    *  This is often the case (for C types, C++ type without virtual
  63    *  inheritance).
  64    *
  65    *  If the location is more complex, the location expression has
  66    *  to be evaluated (which might need accessing the memory).
  67    */
  68   int offset() const
  69   {
  70     xbt_assert(this->has_offset_location());
  71     return this->location_expression[0].number;
  72   }
  73
  74   /** Set the location of the member as a fixed offset */
  75   void offset(int new_offset)
  76   {
  77     // Set the expression to be `DW_OP_plus_uconst(offset)`:
  78     Dwarf_Op op;
  79     op.atom                   = DW_OP_plus_uconst;
  80     op.number                 = new_offset;
  81     this->location_expression = {op};
  82   }
  83 };
  84
  85 /** A type in the model-checked program */
  86 class Type {
  87 public:
  88   Type() = default;
  89
  90   /** The DWARF TAG of the type (e.g. DW_TAG_array_type) */
  91   int type    = 0;
  92   unsigned id = 0;             /* Offset in the section (in hexadecimal form) */
  93   std::string name;            /* Name of the type */
  94   int byte_size     = 0;       /* Size in bytes */
  95   int element_count = 0;       /* Number of elements for array type */
  96   unsigned type_id  = 0;       /* DW_AT_type id */
  97   std::vector<Member> members; /* if DW_TAG_structure_type, DW_TAG_class_type, DW_TAG_union_type*/
  98
  99   simgrid::mc::Type* subtype   = nullptr; // DW_AT_type
 100   simgrid::mc::Type* full_type = nullptr; // The same (but more complete) type
 101 };
 102
 103 } // namespace mc
 104 } // namespace simgrid
 105
 106 #endif