Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
sanitize the OOP of kernel::profile
[simgrid.git] / src / mc / Type.hpp
index 5a6a2ad..7bc1464 100644 (file)
@@ -1,5 +1,4 @@
-/* Copyright (c) 2007-2015. The SimGrid Team.
- * All rights reserved.                                                     */
+/* Copyright (c) 2007-2019. The SimGrid Team. All rights reserved.          */
 
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
@@ -7,12 +6,15 @@
 #ifndef SIMGRID_MC_TYPE_HPP
 #define SIMGRID_MC_TYPE_HPP
 
+#include <cstddef>
+
 #include <vector>
 #include <string>
 
-#include <xbt/base.h>
+#include "xbt/asserts.h"
+#include "xbt/base.h"
 
-#include "src/mc/mc_forward.h"
+#include "src/mc/mc_forward.hpp"
 #include "src/mc/LocationList.hpp"
 
 namespace simgrid {
@@ -24,45 +26,74 @@ namespace mc {
  */
 class Member {
 public:
-  Member() {}
+  typedef int flags_type;
+  static constexpr flags_type INHERITANCE_FLAG = 1;
+  static constexpr flags_type VIRTUAL_POINTER_FLAG = 2;
+
+  Member() = default;
+
+  /** Whether this member represent some inherited part of the object */
+  flags_type flags = 0;
 
-  bool inheritance = false;
+  /** Name of the member (if any) */
   std::string name;
+
+  /** DWARF location expression for locating the location of the member */
   simgrid::dwarf::DwarfExpression location_expression;
+
   std::size_t byte_size = 0; // Do we really need this?
+
   unsigned type_id = 0;
   simgrid::mc::Type* type = nullptr;
 
+  bool isInheritance() const
+  {
+    return this->flags & INHERITANCE_FLAG;
+  }
+  bool isVirtualPointer() const
+  {
+    return this->flags & VIRTUAL_POINTER_FLAG;
+  }
+
+  /** Whether the member is at a fixed offset from the base address */
   bool has_offset_location() const
   {
+    // Recognize the expression `DW_OP_plus_uconst(offset)`:
     return location_expression.size() == 1 &&
       location_expression[0].atom == DW_OP_plus_uconst;
   }
 
-  // TODO, check if this shortcut is really necessary
+  /** Get the offset of the member
+  *
+  *  This is only valid is the member is at a fixed offset from the base.
+  *  This is often the case (for C types, C++ type without virtual
+  *  inheritance).
+  *
+  *  If the location is more complex, the location expression has
+  *  to be evaluated (which might need accessing the memory).
+  */
   int offset() const
   {
     xbt_assert(this->has_offset_location());
     return this->location_expression[0].number;
   }
 
+  /** Set the location of the member as a fixed offset */
   void offset(int new_offset)
   {
+    // Set the expression to be `DW_OP_plus_uconst(offset)`:
     Dwarf_Op op;
     op.atom = DW_OP_plus_uconst;
     op.number = new_offset;
     this->location_expression = { op };
   }
+
 };
 
 /** A type in the model-checked program */
 class Type {
 public:
-  Type() {}
-  Type(Type const& type) = default;
-  Type& operator=(Type const&) = default;
-  Type(Type&& type) = default;
-  Type& operator=(Type&&) = default;
+  Type() = default;
 
   /** The DWARF TAG of the type (e.g. DW_TAG_array_type) */
   int type = 0;
@@ -72,7 +103,6 @@ public:
   int element_count = 0; /* Number of elements for array type */
   unsigned type_id = 0; /* DW_AT_type id */
   std::vector<Member> members; /* if DW_TAG_structure_type, DW_TAG_class_type, DW_TAG_union_type*/
-  int is_pointer_type = 0;
 
   simgrid::mc::Type* subtype = nullptr; // DW_AT_type
   simgrid::mc::Type* full_type = nullptr; // The same (but more complete) type