1 /* Copyright (c) 2007-2022. 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"
13 #include <boost/intrusive_ptr.hpp>
15 /********************************* Simcalls *********************************/
16 #include "popping_enum.hpp" /* Definition of Simcall, with one value per simcall */
18 XBT_PUBLIC_DATA const std::array<const char*, simgrid::simix::NUM_SIMCALLS> simcall_names; /* Name of each simcall */
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
25 /* Pack all possible scalar types in an union */
37 unsigned long long ull;
44 * @brief Represents a simcall to the kernel.
46 struct s_smx_simcall {
47 simgrid::simix::Simcall call_ = simgrid::simix::Simcall::NONE;
48 smx_actor_t issuer_ = nullptr;
49 simgrid::kernel::timer::Timer* timeout_cb_ = nullptr; // Callback to timeouts
50 simgrid::kernel::actor::SimcallObserver* observer_ = nullptr; // makes that simcall observable by the MC
51 unsigned int mc_max_consider_ =
52 0; // How many times this simcall should be used. If >1, this will be a fork in the state space.
53 std::array<u_smx_scalar, 11> args_ = {};
54 u_smx_scalar result_ = {};
57 /******************************** General *************************************/
59 XBT_PRIVATE const char* SIMIX_simcall_name(const s_smx_simcall& simcall);
60 XBT_PRIVATE void SIMIX_run_kernel(std::function<void()> const* code);
61 XBT_PRIVATE void SIMIX_run_blocking(std::function<void()> const* code);
63 /* Defines the marshal/unmarshal functions for each type of parameters.
65 * There is a unmarshal_raw() function, which is exactly similar to unmarshal()
66 * for all types but boost::intrusive_ptr(T). For that type, the unmarshal()
67 * function builds a new intrusive_ptr wrapping the pointer (that is stored raw
68 * within the simcall) while the unmarshal_raw retrieves the raw pointer.
70 * This is used in <simcall>_getraw_<param> functions, that allow the
71 * model-checker, to read the data in the remote memory of the MCed.
77 template <class T> class type {
78 constexpr bool operator==(type) const { return true; }
79 template <class U> constexpr bool operator==(type<U>) const { return false; }
80 constexpr bool operator!=(type) const { return false; }
81 template <class U> constexpr bool operator!=(type<U>) const { return true; }
84 template <typename T> struct marshal_t {
86 #define SIMIX_MARSHAL(T, field) \
87 inline void marshal(type<T>, u_smx_scalar& simcall, T value) { simcall.field = value; } \
88 inline T unmarshal(type<T>, u_smx_scalar const& simcall) { return simcall.field; } \
89 inline T unmarshal_raw(type<T>, u_smx_scalar const& simcall) \
90 { /* Exactly same as unmarshal. It differs only for intrusive_ptr */ return simcall.field; }
92 SIMIX_MARSHAL(bool, b)
93 SIMIX_MARSHAL(char, c)
94 SIMIX_MARSHAL(short, s)
96 SIMIX_MARSHAL(long, l)
97 SIMIX_MARSHAL(unsigned char, uc)
98 SIMIX_MARSHAL(unsigned short, us)
99 SIMIX_MARSHAL(unsigned int, ui)
100 SIMIX_MARSHAL(unsigned long, ul)
101 SIMIX_MARSHAL(unsigned long long, ull)
102 SIMIX_MARSHAL(long long, ll)
103 SIMIX_MARSHAL(float, d)
104 SIMIX_MARSHAL(double, d)
105 SIMIX_MARSHAL(FPtr, fp)
107 inline void unmarshal(type<void>, u_smx_scalar const& /*simcall*/)
109 /* Nothing to do for void data */
111 inline void unmarshal_raw(type<void>, u_smx_scalar const& /*simcall*/)
113 /* Nothing to do for void data */
116 template <class T> inline void marshal(type<T*>, u_smx_scalar& simcall, T* value)
118 simcall.dp = (void*)value;
120 template <class T> inline T* unmarshal(type<T*>, u_smx_scalar const& simcall)
122 return static_cast<T*>(simcall.dp);
124 template <class T> inline T* unmarshal_raw(type<T*>, u_smx_scalar const& simcall)
126 return static_cast<T*>(simcall.dp);
130 inline void marshal(type<boost::intrusive_ptr<T>>, u_smx_scalar& simcall, boost::intrusive_ptr<T> value)
132 if (value.get() == nullptr) { // Sometimes we return nullptr in an intrusive_ptr...
133 simcall.dp = nullptr;
135 intrusive_ptr_add_ref(value.get());
136 simcall.dp = static_cast<void*>(value.get());
139 template <class T> inline boost::intrusive_ptr<T> unmarshal(type<boost::intrusive_ptr<T>>, u_smx_scalar const& simcall)
141 // refcount was already increased during the marshaling, thus the "false" as last argument
142 boost::intrusive_ptr<T> res = boost::intrusive_ptr<T>(static_cast<T*>(simcall.dp), false);
145 template <class T> inline T* unmarshal_raw(type<boost::intrusive_ptr<T>>, u_smx_scalar const& simcall)
147 return static_cast<T*>(simcall.dp);
150 template <class R, class... T> inline void marshal(type<R (*)(T...)>, u_smx_scalar& simcall, R (*value)(T...))
152 simcall.fp = (FPtr)value;
154 template <class R, class... T> inline auto unmarshal(type<R (*)(T...)>, u_smx_scalar simcall) -> R (*)(T...)
156 return (R(*)(T...))simcall.fp;
158 template <class R, class... T> inline auto unmarshal_raw(type<R (*)(T...)>, u_smx_scalar simcall) -> R (*)(T...)
160 return (R(*)(T...))simcall.fp;
163 template <class T> inline void marshal(u_smx_scalar& simcall, T const& value)
165 return marshal(type<T>(), simcall, value);
167 template <class T> inline typename std::remove_reference_t<T> unmarshal(u_smx_scalar& simcall)
169 return unmarshal(type<T>(), simcall);
171 template <class T> inline typename std::remove_reference_t<T> unmarshal_raw(u_smx_scalar& simcall)
173 return unmarshal(type<T>(), simcall);
176 template <std::size_t I> inline void marshal_args(const s_smx_simcall* /*simcall*/)
178 /* Nothing to do when no args */
181 template <std::size_t I, class A> inline void marshal_args(smx_simcall_t simcall, A const& a)
183 marshal(simcall->args_[I], a);
186 template <std::size_t I, class A, class... B> inline void marshal_args(smx_simcall_t simcall, A const& a, B const&... b)
188 marshal(simcall->args_[I], a);
189 marshal_args<I + 1>(simcall, b...);
192 /** Initialize the simcall */
193 template <class... A> inline void marshal(smx_simcall_t simcall, Simcall call, A const&... a)
195 simcall->call_ = call;
196 memset(&simcall->result_, 0, sizeof simcall->result_);
197 memset(simcall->args_.data(), 0, simcall->args_.size() * sizeof simcall->args_[0]);
198 marshal_args<0>(simcall, a...);