src/simix/popping_private.hpp

   1 /* Copyright (c) 2007-2020. 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 SG_POPPING_PRIVATE_HPP
   7 #define SG_POPPING_PRIVATE_HPP
   8
   9 #include "simgrid/forward.h"
  10 #include "src/kernel/activity/ActivityImpl.hpp"
  11
  12 #include <array>
  13 #include <boost/intrusive_ptr.hpp>
  14
  15 /********************************* Simcalls *********************************/
  16 #include "popping_enum.hpp" /* Definition of e_smx_simcall_t, with one value per simcall */
  17
  18 XBT_PUBLIC_DATA const std::array<const char*, NUM_SIMCALLS> simcall_names; /* Name of each simcall */
  19
  20 using simix_match_func_t     = bool (*)(void*, void*, simgrid::kernel::activity::CommImpl*);
  21 using simix_copy_data_func_t = void (*)(simgrid::kernel::activity::CommImpl*, void*, size_t);
  22 using simix_clean_func_t     = void (*)(void*);
  23 using FPtr                   = void (*)(); // Hide the ugliness
  24
  25 /* Pack all possible scalar types in an union */
  26 union u_smx_scalar {
  27   bool b;
  28   char c;
  29   short s;
  30   int i;
  31   long l;
  32   long long ll;
  33   unsigned char uc;
  34   unsigned short us;
  35   unsigned int ui;
  36   unsigned long ul;
  37   unsigned long long ull;
  38   double d;
  39   void* dp;
  40   FPtr fp;
  41 };
  42
  43 /**
  44  * @brief Represents a simcall to the kernel.
  45  */
  46 struct s_smx_simcall {
  47   e_smx_simcall_t call_                     = SIMCALL_NONE;
  48   smx_actor_t issuer_                       = nullptr;
  49   smx_timer_t timeout_cb_                   = nullptr; // Callback to timeouts
  50   simgrid::mc::SimcallInspector* inspector_ = nullptr; // makes that simcall observable by the MC
  51   int mc_value_                             = 0;
  52   std::array<u_smx_scalar, 11> args_        = {};
  53   u_smx_scalar result_                      = {};
  54 };
  55
  56 #define SIMCALL_SET_MC_VALUE(simcall, value) ((simcall).mc_value_ = (value))
  57 #define SIMCALL_GET_MC_VALUE(simcall) ((simcall).mc_value_)
  58
  59 /******************************** General *************************************/
  60
  61 XBT_PRIVATE const char* SIMIX_simcall_name(e_smx_simcall_t kind);
  62 XBT_PRIVATE void SIMIX_run_kernel(std::function<void()> const* code);
  63 XBT_PRIVATE void SIMIX_run_blocking(std::function<void()> const* code);
  64
  65 /* Defines the marshal/unmarshal functions for each type of parameters.
  66  *
  67  * They will be used in popping_accessors.hpp to define the functions allowing
  68  * to retrieve/set each parameter of each simcall.
  69  *
  70  * There is a unmarshal_raw() function, which is exactly similar to unmarshal()
  71  * for all types but boost::intrusive_ptr(T). For that type, the unmarshal()
  72  * function builds a new intrusive_ptr wrapping the pointer (that is stored raw
  73  * within the simcall) while the unmarshal_raw retrieves the raw pointer.
  74  *
  75  * This is used in <simcall>_getraw_<param> functions, that allow the
  76  * model-checker, to read the data in the remote memory of the MCed.
  77  */
  78
  79 namespace simgrid {
  80 namespace simix {
  81
  82 template <class T> class type {
  83   constexpr bool operator==(type) const { return true; }
  84   template <class U> constexpr bool operator==(type<U>) const { return false; }
  85   constexpr bool operator!=(type) const { return false; }
  86   template <class U> constexpr bool operator!=(type<U>) const { return true; }
  87 };
  88
  89 template <typename T> struct marshal_t {
  90 };
  91 #define SIMIX_MARSHAL(T, field)                                                                                        \
  92   inline void marshal(type<T>, u_smx_scalar& simcall, T value) { simcall.field = value; }                              \
  93   inline T unmarshal(type<T>, u_smx_scalar const& simcall) { return simcall.field; }                                   \
  94   inline T unmarshal_raw(type<T>, u_smx_scalar const& simcall)                                                         \
  95   { /* Exactly same as unmarshal. It differs only for intrusive_ptr */ return simcall.field; }
  96
  97 SIMIX_MARSHAL(bool, b)
  98 SIMIX_MARSHAL(char, c)
  99 SIMIX_MARSHAL(short, s)
 100 SIMIX_MARSHAL(int, i)
 101 SIMIX_MARSHAL(long, l)
 102 SIMIX_MARSHAL(unsigned char, uc)
 103 SIMIX_MARSHAL(unsigned short, us)
 104 SIMIX_MARSHAL(unsigned int, ui)
 105 SIMIX_MARSHAL(unsigned long, ul)
 106 SIMIX_MARSHAL(unsigned long long, ull)
 107 SIMIX_MARSHAL(long long, ll)
 108 SIMIX_MARSHAL(float, d)
 109 SIMIX_MARSHAL(double, d)
 110 SIMIX_MARSHAL(FPtr, fp)
 111
 112 inline void unmarshal(type<void>, u_smx_scalar const& /*simcall*/)
 113 {
 114   /* Nothing to do for void data */
 115 }
 116 inline void unmarshal_raw(type<void>, u_smx_scalar const& /*simcall*/)
 117 {
 118   /* Nothing to do for void data */
 119 }
 120
 121 template <class T> inline void marshal(type<T*>, u_smx_scalar& simcall, T* value)
 122 {
 123   simcall.dp = (void*)value;
 124 }
 125 template <class T> inline T* unmarshal(type<T*>, u_smx_scalar const& simcall)
 126 {
 127   return static_cast<T*>(simcall.dp);
 128 }
 129 template <class T> inline T* unmarshal_raw(type<T*>, u_smx_scalar const& simcall)
 130 {
 131   return static_cast<T*>(simcall.dp);
 132 }
 133
 134 template <class T>
 135 inline void marshal(type<boost::intrusive_ptr<T>>, u_smx_scalar& simcall, boost::intrusive_ptr<T> value)
 136 {
 137   if (value.get() == nullptr) { // Sometimes we return nullptr in an intrusive_ptr...
 138     simcall.dp = nullptr;
 139   } else {
 140     intrusive_ptr_add_ref(value.get());
 141     simcall.dp = static_cast<void*>(value.get());
 142   }
 143 }
 144 template <class T> inline boost::intrusive_ptr<T> unmarshal(type<boost::intrusive_ptr<T>>, u_smx_scalar const& simcall)
 145 {
 146   // refcount was already increased during the marshaling, thus the "false" as last argument
 147   boost::intrusive_ptr<T> res = boost::intrusive_ptr<T>(static_cast<T*>(simcall.dp), false);
 148   return res;
 149 }
 150 template <class T> inline T* unmarshal_raw(type<boost::intrusive_ptr<T>>, u_smx_scalar const& simcall)
 151 {
 152   return static_cast<T*>(simcall.dp);
 153 }
 154
 155 template <class R, class... T> inline void marshal(type<R (*)(T...)>, u_smx_scalar& simcall, R (*value)(T...))
 156 {
 157   simcall.fp = (FPtr)value;
 158 }
 159 template <class R, class... T> inline auto unmarshal(type<R (*)(T...)>, u_smx_scalar simcall) -> R (*)(T...)
 160 {
 161   return (R(*)(T...))simcall.fp;
 162 }
 163 template <class R, class... T> inline auto unmarshal_raw(type<R (*)(T...)>, u_smx_scalar simcall) -> R (*)(T...)
 164 {
 165   return (R(*)(T...))simcall.fp;
 166 }
 167
 168 template <class T> inline void marshal(u_smx_scalar& simcall, T const& value)
 169 {
 170   return marshal(type<T>(), simcall, value);
 171 }
 172 template <class T> inline typename std::remove_reference<T>::type unmarshal(u_smx_scalar& simcall)
 173 {
 174   return unmarshal(type<T>(), simcall);
 175 }
 176 template <class T> inline typename std::remove_reference<T>::type unmarshal_raw(u_smx_scalar& simcall)
 177 {
 178   return unmarshal(type<T>(), simcall);
 179 }
 180
 181 template <std::size_t I> inline void marshal_args(const s_smx_simcall* /*simcall*/)
 182 {
 183   /* Nothing to do when no args */
 184 }
 185
 186 template <std::size_t I, class A> inline void marshal_args(smx_simcall_t simcall, A const& a)
 187 {
 188   marshal(simcall->args_[I], a);
 189 }
 190
 191 template <std::size_t I, class A, class... B> inline void marshal_args(smx_simcall_t simcall, A const& a, B const&... b)
 192 {
 193   marshal(simcall->args_[I], a);
 194   marshal_args<I + 1>(simcall, b...);
 195 }
 196
 197 /** Initialize the simcall */
 198 template <class... A> inline void marshal(smx_simcall_t simcall, e_smx_simcall_t call, A const&... a)
 199 {
 200   simcall->call_ = call;
 201   memset(&simcall->result_, 0, sizeof simcall->result_);
 202   memset(simcall->args_.data(), 0, simcall->args_.size() * sizeof simcall->args_[0]);
 203   marshal_args<0>(simcall, a...);
 204 }
 205 }
 206 }
 207
 208 #include "popping_accessors.hpp"
 209
 210 #endif