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