src/simix/popping_private.hpp

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