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> class type {
  90   constexpr bool operator==(type) const { return true; }
  91   template <class U> constexpr bool operator==(type<U>) const { return false; }
  92   constexpr bool operator!=(type) const { return false; }
  93   template <class U> constexpr bool operator!=(type<U>) const { return true; }
  94 };
  95
  96 template <typename T> struct marshal_t {
  97 };
  98 #define SIMIX_MARSHAL(T, field)                                                                                        \
  99   inline void marshal(type<T>, u_smx_scalar& simcall, T value) { simcall.field = value; }                              \
 100   inline T unmarshal(type<T>, u_smx_scalar const& simcall) { return simcall.field; }                                   \
 101   inline T unmarshal_raw(type<T>, u_smx_scalar const& simcall)                                                         \
 102   { /* Exactly same as unmarshal. It differs only for intrusive_ptr */ return simcall.field; }
 103
 104 SIMIX_MARSHAL(char, c);
 105 SIMIX_MARSHAL(short, s);
 106 SIMIX_MARSHAL(int, i);
 107 SIMIX_MARSHAL(long, l);
 108 SIMIX_MARSHAL(unsigned char, uc);
 109 SIMIX_MARSHAL(unsigned short, us);
 110 SIMIX_MARSHAL(unsigned int, ui);
 111 SIMIX_MARSHAL(unsigned long, ul);
 112 SIMIX_MARSHAL(unsigned long long, ull);
 113 SIMIX_MARSHAL(long long, ll);
 114 SIMIX_MARSHAL(float, d);
 115 SIMIX_MARSHAL(double, d);
 116 SIMIX_MARSHAL(FPtr, fp);
 117
 118 inline void unmarshal(type<void>, u_smx_scalar const& simcall)
 119 {
 120   /* Nothing to do for void data */
 121 }
 122 inline void unmarshal_raw(type<void>, u_smx_scalar const& simcall)
 123 {
 124   /* Nothing to do for void data */
 125 }
 126
 127 template <class T> inline void marshal(type<T*>, u_smx_scalar& simcall, T* value)
 128 {
 129   simcall.dp = (void*)value;
 130 }
 131 template <class T> inline T* unmarshal(type<T*>, u_smx_scalar const& simcall)
 132 {
 133   return static_cast<T*>(simcall.dp);
 134 }
 135 template <class T> inline T* unmarshal_raw(type<T*>, u_smx_scalar const& simcall)
 136 {
 137   return static_cast<T*>(simcall.dp);
 138 }
 139
 140 template <class T>
 141 inline void marshal(type<boost::intrusive_ptr<T>>, u_smx_scalar& simcall, boost::intrusive_ptr<T> value)
 142 {
 143   if (value.get() == nullptr) { // Sometimes we return nullptr in an intrusive_ptr...
 144     simcall.dp = nullptr;
 145   } else {
 146     intrusive_ptr_add_ref(&*value);
 147     simcall.dp = static_cast<void*>(&*value);
 148   }
 149 }
 150 template <class T> inline boost::intrusive_ptr<T> unmarshal(type<boost::intrusive_ptr<T>>, u_smx_scalar const& simcall)
 151 {
 152   // refcount was already increased during the marshaling, thus the "false" as last argument
 153   boost::intrusive_ptr<T> res = boost::intrusive_ptr<T>(static_cast<T*>(simcall.dp), false);
 154   return res;
 155 }
 156 template <class T> inline T* unmarshal_raw(type<boost::intrusive_ptr<T>>, u_smx_scalar const& simcall)
 157 {
 158   return static_cast<T*>(simcall.dp);
 159 }
 160
 161 template <class R, class... T> inline void marshal(type<R (*)(T...)>, u_smx_scalar& simcall, R (*value)(T...))
 162 {
 163   simcall.fp = (FPtr)value;
 164 }
 165 template <class R, class... T> inline auto unmarshal(type<R (*)(T...)>, u_smx_scalar simcall) -> R (*)(T...)
 166 {
 167   return (R(*)(T...))simcall.fp;
 168 }
 169 template <class R, class... T> inline auto unmarshal_raw(type<R (*)(T...)>, u_smx_scalar simcall) -> R (*)(T...)
 170 {
 171   return (R(*)(T...))simcall.fp;
 172 }
 173
 174 template <class T> inline void marshal(u_smx_scalar& simcall, T const& value)
 175 {
 176   return marshal(type<T>(), simcall, value);
 177 }
 178 template <class T> inline typename std::remove_reference<T>::type unmarshal(u_smx_scalar& simcall)
 179 {
 180   return unmarshal(type<T>(), simcall);
 181 }
 182 template <class T> inline typename std::remove_reference<T>::type unmarshal_raw(u_smx_scalar& simcall)
 183 {
 184   return unmarshal(type<T>(), simcall);
 185 }
 186
 187 template <std::size_t I> inline void marshalArgs(smx_simcall_t simcall)
 188 {
 189 }
 190
 191 template <std::size_t I, class A> inline void marshalArgs(smx_simcall_t simcall, A const& a)
 192 {
 193   marshal(simcall->args[I], a);
 194 }
 195
 196 template <std::size_t I, class A, class... B> inline void marshalArgs(smx_simcall_t simcall, A const& a, B const&... b)
 197 {
 198   marshal(simcall->args[I], a);
 199   marshalArgs<I + 1>(simcall, b...);
 200 }
 201
 202 /** Initialize the simcall */
 203 template <class... A> inline void marshal(smx_simcall_t simcall, e_smx_simcall_t call, A const&... a)
 204 {
 205   simcall->call = call;
 206   memset(&simcall->result, 0, sizeof(simcall->result));
 207   memset(simcall->args, 0, sizeof(simcall->args));
 208   marshalArgs<0>(simcall, a...);
 209 }
 210 }
 211 }
 212
 213 #include "popping_accessors.hpp"
 214
 215 #endif