1 /* Copyright (c) 2007-2019. The SimGrid Team. All rights reserved. */
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. */
6 #ifndef SG_POPPING_PRIVATE_HPP
7 #define SG_POPPING_PRIVATE_HPP
9 #include "simgrid/forward.h"
10 #include "src/kernel/activity/ActivityImpl.hpp"
12 #include <boost/intrusive_ptr.hpp>
14 /********************************* Simcalls *********************************/
15 #include "popping_enum.h" /* Definition of e_smx_simcall_t, with one value per simcall */
17 XBT_PUBLIC_DATA const char* simcall_names[]; /* Name of each simcall */
19 typedef bool (*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
24 /* Pack all possible scalar types in an union */
36 unsigned long long ull;
43 * @brief Represents a simcall to the kernel.
45 struct s_smx_simcall {
46 e_smx_simcall_t call_ = SIMCALL_NONE;
47 smx_actor_t issuer_ = nullptr;
48 smx_timer_t timeout_cb_ = nullptr; // Callback to timeouts
49 simgrid::mc::SimcallInspector* inspector_ = nullptr; // makes that simcall observable by the MC
51 u_smx_scalar args_[11] = {{0}, {0}, {0}, {0}, {0}, {0}, {0}, {0}, {0}, {0}, {0}};
52 u_smx_scalar result_ = {0};
55 #define SIMCALL_SET_MC_VALUE(simcall, value) ((simcall).mc_value_ = (value))
56 #define SIMCALL_GET_MC_VALUE(simcall) ((simcall).mc_value_)
58 /******************************** General *************************************/
60 XBT_PRIVATE const char* SIMIX_simcall_name(e_smx_simcall_t kind);
61 XBT_PRIVATE void SIMIX_run_kernel(std::function<void()> const* code);
62 XBT_PRIVATE void SIMIX_run_blocking(std::function<void()> const* code);
64 /* Defines the marshal/unmarshal functions for each type of parameters.
66 * They will be used in popping_accessors.hpp to define the functions allowing
67 * to retrieve/set each parameter of each simcall.
69 * There is a unmarshal_raw() function, which is exactly similar to unmarshal()
70 * for all types but boost::intrusive_ptr(T). For that type, the unmarshal()
71 * function builds a new intrusive_ptr wrapping the pointer (that is stored raw
72 * within the simcall) while the unmarshal_raw retrieves the raw pointer.
74 * This is used in <simcall>_getraw_<param> functions, that allow the
75 * model-checker, to read the data in the remote memory of the MCed.
81 template <class T> class type {
82 constexpr bool operator==(type) const { return true; }
83 template <class U> constexpr bool operator==(type<U>) const { return false; }
84 constexpr bool operator!=(type) const { return false; }
85 template <class U> constexpr bool operator!=(type<U>) const { return true; }
88 template <typename T> struct marshal_t {
90 #define SIMIX_MARSHAL(T, field) \
91 inline void marshal(type<T>, u_smx_scalar& simcall, T value) { simcall.field = value; } \
92 inline T unmarshal(type<T>, u_smx_scalar const& simcall) { return simcall.field; } \
93 inline T unmarshal_raw(type<T>, u_smx_scalar const& simcall) \
94 { /* Exactly same as unmarshal. It differs only for intrusive_ptr */ return simcall.field; }
96 SIMIX_MARSHAL(bool, b)
97 SIMIX_MARSHAL(char, c)
98 SIMIX_MARSHAL(short, s)
100 SIMIX_MARSHAL(long, l)
101 SIMIX_MARSHAL(unsigned char, uc)
102 SIMIX_MARSHAL(unsigned short, us)
103 SIMIX_MARSHAL(unsigned int, ui)
104 SIMIX_MARSHAL(unsigned long, ul)
105 SIMIX_MARSHAL(unsigned long long, ull)
106 SIMIX_MARSHAL(long long, ll)
107 SIMIX_MARSHAL(float, d)
108 SIMIX_MARSHAL(double, d)
109 SIMIX_MARSHAL(FPtr, fp)
111 inline void unmarshal(type<void>, u_smx_scalar const& simcall)
113 /* Nothing to do for void data */
115 inline void unmarshal_raw(type<void>, u_smx_scalar const& simcall)
117 /* Nothing to do for void data */
120 template <class T> inline void marshal(type<T*>, u_smx_scalar& simcall, T* value)
122 simcall.dp = (void*)value;
124 template <class T> inline T* unmarshal(type<T*>, u_smx_scalar const& simcall)
126 return static_cast<T*>(simcall.dp);
128 template <class T> inline T* unmarshal_raw(type<T*>, u_smx_scalar const& simcall)
130 return static_cast<T*>(simcall.dp);
134 inline void marshal(type<boost::intrusive_ptr<T>>, u_smx_scalar& simcall, boost::intrusive_ptr<T> value)
136 if (value.get() == nullptr) { // Sometimes we return nullptr in an intrusive_ptr...
137 simcall.dp = nullptr;
139 intrusive_ptr_add_ref(value.get());
140 simcall.dp = static_cast<void*>(value.get());
143 template <class T> inline boost::intrusive_ptr<T> unmarshal(type<boost::intrusive_ptr<T>>, u_smx_scalar const& simcall)
145 // refcount was already increased during the marshaling, thus the "false" as last argument
146 boost::intrusive_ptr<T> res = boost::intrusive_ptr<T>(static_cast<T*>(simcall.dp), false);
149 template <class T> inline T* unmarshal_raw(type<boost::intrusive_ptr<T>>, u_smx_scalar const& simcall)
151 return static_cast<T*>(simcall.dp);
154 template <class R, class... T> inline void marshal(type<R (*)(T...)>, u_smx_scalar& simcall, R (*value)(T...))
156 simcall.fp = (FPtr)value;
158 template <class R, class... T> inline auto unmarshal(type<R (*)(T...)>, u_smx_scalar simcall) -> R (*)(T...)
160 return (R(*)(T...))simcall.fp;
162 template <class R, class... T> inline auto unmarshal_raw(type<R (*)(T...)>, u_smx_scalar simcall) -> R (*)(T...)
164 return (R(*)(T...))simcall.fp;
167 template <class T> inline void marshal(u_smx_scalar& simcall, T const& value)
169 return marshal(type<T>(), simcall, value);
171 template <class T> inline typename std::remove_reference<T>::type unmarshal(u_smx_scalar& simcall)
173 return unmarshal(type<T>(), simcall);
175 template <class T> inline typename std::remove_reference<T>::type unmarshal_raw(u_smx_scalar& simcall)
177 return unmarshal(type<T>(), simcall);
180 template <std::size_t I> inline void marshal_args(smx_simcall_t simcall)
182 /* Nothing to do when no args */
185 template <std::size_t I, class A> inline void marshal_args(smx_simcall_t simcall, A const& a)
187 marshal(simcall->args_[I], a);
190 template <std::size_t I, class A, class... B> inline void marshal_args(smx_simcall_t simcall, A const& a, B const&... b)
192 marshal(simcall->args_[I], a);
193 marshal_args<I + 1>(simcall, b...);
196 /** Initialize the simcall */
197 template <class... A> inline void marshal(smx_simcall_t simcall, e_smx_simcall_t call, A const&... a)
199 simcall->call_ = call;
200 memset(&simcall->result_, 0, sizeof(simcall->result_));
201 memset(simcall->args_, 0, sizeof(simcall->args_));
202 marshal_args<0>(simcall, a...);
207 #include "popping_accessors.hpp"