src/mc/inspect/Type.hpp

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