Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
please sonar and simplify simcalls (before killing them)
[simgrid.git] / src / simix / popping_private.h
index 0d5427b..c04b0b2 100644 (file)
-/* Copyright (c) 2007-2010, 2012-2015. The SimGrid Team.
- * All rights reserved.                                                     */
+/* Copyright (c) 2007-2017. The SimGrid Team. All rights reserved.          */
 
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
 
-#ifndef _POPPING_PRIVATE_H
-#define _POPPING_PRIVATE_H
+#ifndef SG_POPPING_PRIVATE_H
+#define SG_POPPING_PRIVATE_H
 
 #include <xbt/base.h>
 #include <simgrid/simix.h>
 
+#include <src/kernel/activity/ActivityImpl.hpp>
+#include <src/kernel/activity/CommImpl.hpp>
+
+#include <boost/intrusive_ptr.hpp>
+
 SG_BEGIN_DECL()
 
 /********************************* Simcalls *********************************/
 XBT_PUBLIC_DATA(const char*) simcall_names[]; /* Name of each simcall */
 
 #include "popping_enum.h" /* Definition of e_smx_simcall_t, with one value per simcall */
-#include "src/mc/mc_forward.h" /* Definition of mc_snapshot_t, used by one simcall */
 
-typedef int (*simix_match_func_t)(void *, void *, smx_synchro_t);
-typedef void (*simix_copy_data_func_t)(smx_synchro_t, void*, size_t);
+typedef int (*simix_match_func_t)(void *, void *, smx_activity_t);
+typedef void (*simix_copy_data_func_t)(smx_activity_t, void*, size_t);
 typedef void (*simix_clean_func_t)(void *);
 typedef void (*FPtr)(void); // Hide the ugliness
 
 /* Pack all possible scalar types in an union */
 union u_smx_scalar {
   char            c;
-  const char*     cc;
   short           s;
   int             i;
   long            l;
+  long long       ll;
   unsigned char   uc;
   unsigned short  us;
   unsigned int    ui;
   unsigned long   ul;
-  float           f;
+  unsigned long long ull;
   double          d;
-  size_t          sz;
-  sg_size_t       sgsz;
-  sg_offset_t     sgoff;
   void*           dp;
   FPtr            fp;
-  const void*     cp;
 };
 
 /**
  * \brief Represents a simcall to the kernel.
  */
-typedef struct s_smx_simcall {
+struct s_smx_simcall {
   e_smx_simcall_t call;
-  smx_process_t issuer;
+  smx_actor_t issuer;
+  smx_timer_t timer;
   int mc_value;
   union u_smx_scalar args[11];
   union u_smx_scalar result;
-} s_smx_simcall_t, *smx_simcall_t;
+};
 
 #define SIMCALL_SET_MC_VALUE(simcall, value) ((simcall)->mc_value = (value))
 #define SIMCALL_GET_MC_VALUE(simcall) ((simcall)->mc_value)
 
-#include "popping_accessors.h"
-
 /******************************** General *************************************/
 
-XBT_PRIVATE void SIMIX_simcall_answer(smx_simcall_t);
-XBT_PRIVATE void SIMIX_simcall_handle(smx_simcall_t, int);
-XBT_PRIVATE void SIMIX_simcall_exit(smx_synchro_t);
+XBT_PRIVATE void SIMIX_simcall_answer(smx_simcall_t simcall);
+XBT_PRIVATE void SIMIX_simcall_handle(smx_simcall_t simcall, int value);
+XBT_PRIVATE void SIMIX_simcall_exit(smx_activity_t synchro);
 XBT_PRIVATE const char *SIMIX_simcall_name(e_smx_simcall_t kind);
-XBT_PRIVATE void SIMIX_run_kernel(void* code);
+XBT_PRIVATE void SIMIX_run_kernel(std::function<void()> const* code);
+XBT_PRIVATE void SIMIX_run_blocking(std::function<void()> const* code);
 
 SG_END_DECL()
 
 #ifdef __cplusplus
 
+/* Defines the marshal/unmarshal functions for each type of parameters.
+ *
+ * They will be used in popping_accessors.h to define the functions allowing
+ * to retrieve/set each parameter of each simcall.
+ *
+ * There is a unmarshal_raw() function, which is exactly similar to unmarshal()
+ * for all types but boost::intrusive_ptr(T). For that type, the unmarshal()
+ * function builds a new intrusive_ptr wrapping the pointer (that is stored raw
+ * within the simcall) while the unmarshal_raw retrieves the raw pointer.
+ *
+ * This is used in <simcall>_getraw_<param> functions, that allow the
+ * model-checker, to read the data in the remote memory of the MCed.
+ */
+
 namespace simgrid {
 namespace simix {
 
+template<class T>
+class type {
+  constexpr bool operator==(type) const    { return true; }
+  template<class U>
+  constexpr bool operator==(type<U>) const { return false; }
+  constexpr bool operator!=(type) const    { return false; }
+  template<class U>
+  constexpr bool operator!=(type<U>) const { return true; }
+};
+
 template<typename T> struct marshal_t {};
-#define SIMIX_MARSHAL(T, field) \
-  template<> struct marshal_t<T> { \
-    static void marshal(u_smx_scalar& simcall, T value) \
-    { \
-      simcall.field = value; \
-    } \
-    static T unmarshal(u_smx_scalar const& simcall) \
-    { \
-      return simcall.field; \
-    } \
-  };
+#define SIMIX_MARSHAL(T, field)                                                                                        \
+  inline void marshal(type<T>, u_smx_scalar& simcall, T value) { simcall.field = value; }                              \
+  inline T unmarshal(type<T>, u_smx_scalar const& simcall) { return simcall.field; }                                   \
+  inline T unmarshal_raw(type<T>, u_smx_scalar const& simcall)                                                         \
+  { /* Exactly same as unmarshal. It differs only for intrusive_ptr */ return simcall.field; }
 
 SIMIX_MARSHAL(char, c);
 SIMIX_MARSHAL(short, s);
@@ -96,150 +113,111 @@ SIMIX_MARSHAL(unsigned char, uc);
 SIMIX_MARSHAL(unsigned short, us);
 SIMIX_MARSHAL(unsigned int, ui);
 SIMIX_MARSHAL(unsigned long, ul);
-SIMIX_MARSHAL(float, f);
+SIMIX_MARSHAL(unsigned long long, ull);
+SIMIX_MARSHAL(long long, ll);
+SIMIX_MARSHAL(float, d);
 SIMIX_MARSHAL(double, d);
 SIMIX_MARSHAL(FPtr, fp);
 
-template<typename T> struct marshal_t<T*> {
-  static void marshal(u_smx_scalar& simcall, T* value)
-  {
-    simcall.dp = value;
-  }
-  static T* unmarshal(u_smx_scalar const& simcall)
-  {
-    return simcall.dp;
-  }
-};
-
-template<> struct marshal_t<void> {
-  static void unmarshal(u_smx_scalar const& simcall) {}
-};
+inline void unmarshal(type<void>, u_smx_scalar const& simcall)
+{
+  /* Nothing to do for void data */
+}
+inline void unmarshal_raw(type<void>, u_smx_scalar const& simcall)
+{
+  /* Nothing to do for void data */
+}
 
 template<class T> inline
-void marshal(u_smx_scalar& simcall, T const& value)
+void marshal(type<T*>, u_smx_scalar& simcall, T* value)
 {
-  marshal_t<T>::marshal(simcall, value);
+  simcall.dp = (void*) value;
 }
-
 template<class T> inline
-T unmarshal(u_smx_scalar const& simcall)
+T* unmarshal(type<T*>, u_smx_scalar const& simcall)
 {
-  return marshal_t<T>::unmarshal(simcall);
+  return static_cast<T*>(simcall.dp);
 }
-
-template<class A> inline
-void marshal(smx_simcall_t simcall, e_smx_simcall_t call, A&& a)
+template <class T> inline T* unmarshal_raw(type<T*>, u_smx_scalar const& simcall)
 {
-  simcall->call = call;
-  memset(&simcall->result, 0, sizeof(simcall->result));
-  marshal(simcall->args[0], std::forward<A>(a));
+  return static_cast<T*>(simcall.dp);
 }
 
-template<class A, class B> inline
-void marshal(smx_simcall_t simcall, e_smx_simcall_t call, A&& a, B&& b)
+template <class T>
+inline void marshal(type<boost::intrusive_ptr<T>>, u_smx_scalar& simcall, boost::intrusive_ptr<T> value)
 {
-  simcall->call = call;
-  memset(&simcall->result, 0, sizeof(simcall->result));
-  marshal(simcall->args[0], std::forward<A>(a));
-  marshal(simcall->args[1], std::forward<B>(b));
+  if (value.get() == nullptr) { // Sometimes we return nullptr in an intrusive_ptr...
+    simcall.dp = nullptr;
+  } else {
+    intrusive_ptr_add_ref(&*value);
+    simcall.dp = static_cast<void*>(&*value);
+  }
 }
-
-template<class A, class B, class C> inline
-void marshal(smx_simcall_t simcall, e_smx_simcall_t call, A&& a, B&& b, C&& c)
+template <class T> inline boost::intrusive_ptr<T> unmarshal(type<boost::intrusive_ptr<T>>, u_smx_scalar const& simcall)
 {
-  simcall->call = call;
-  memset(&simcall->result, 0, sizeof(simcall->result));
-  marshal(simcall->args[0], std::forward<A>(a));
-  marshal(simcall->args[1], std::forward<B>(b));
-  marshal(simcall->args[2], std::forward<C>(c));
+  // refcount was already increased during the marshaling, thus the "false" as last argument
+  boost::intrusive_ptr<T> res = boost::intrusive_ptr<T>(static_cast<T*>(simcall.dp), false);
+  return res;
 }
-
-template<class A, class B, class C, class D> inline
-void marshal(smx_simcall_t simcall, e_smx_simcall_t call, A&& a, B&& b, C&& c, D&& d)
+template <class T> inline T* unmarshal_raw(type<boost::intrusive_ptr<T>>, u_smx_scalar const& simcall)
 {
-  simcall->call = call;
-  memset(&simcall->result, 0, sizeof(simcall->result));
-  marshal(simcall->args[0], std::forward<A>(a));
-  marshal(simcall->args[1], std::forward<B>(b));
-  marshal(simcall->args[2], std::forward<C>(c));
-  marshal(simcall->args[3], std::forward<D>(d));
+  return static_cast<T*>(simcall.dp);
 }
 
-template<class A, class B, class C, class D, class E> inline
-void marshal(smx_simcall_t simcall, e_smx_simcall_t call, A&& a, B&& b, C&& c, D&& d, E&& e)
+template<class R, class... T> inline
+void marshal(type<R(*)(T...)>, u_smx_scalar& simcall, R(*value)(T...))
 {
-  simcall->call = call;
-  memset(&simcall->result, 0, sizeof(simcall->result));
-  marshal(simcall->args[0], std::forward<A>(a));
-  marshal(simcall->args[1], std::forward<B>(b));
-  marshal(simcall->args[2], std::forward<C>(c));
-  marshal(simcall->args[3], std::forward<D>(d));
-  marshal(simcall->args[4], std::forward<E>(e));
+  simcall.fp = (FPtr) value;
+}
+template<class R, class... T> inline
+auto unmarshal(type<R(*)(T...)>, u_smx_scalar simcall) -> R(*)(T...)
+{
+  return (R(*)(T...)) simcall.fp;
+}
+template <class R, class... T> inline auto unmarshal_raw(type<R (*)(T...)>, u_smx_scalar simcall) -> R (*)(T...)
+{
+  return (R(*)(T...))simcall.fp;
 }
 
-template<class A, class B, class C, class D, class E, class F> inline
-void marshal(smx_simcall_t simcall, e_smx_simcall_t call,
-  A&& a, B&& b, C&& c, D&& d, E&& e, F&& f)
+template<class T> inline
+void marshal(u_smx_scalar& simcall, T const& value)
 {
-  simcall->call = call;
-  memset(&simcall->result, 0, sizeof(simcall->result));
-  marshal(simcall->args[0], std::forward<A>(a));
-  marshal(simcall->args[1], std::forward<B>(b));
-  marshal(simcall->args[2], std::forward<C>(c));
-  marshal(simcall->args[3], std::forward<D>(d));
-  marshal(simcall->args[4], std::forward<E>(e));
-  marshal(simcall->args[5], std::forward<F>(f));
+  return marshal(type<T>(), simcall, value);
 }
+template<class T> inline
+typename std::remove_reference<T>::type unmarshal(u_smx_scalar& simcall)
+{
+  return unmarshal(type<T>(), simcall);
+}
+template <class T> inline typename std::remove_reference<T>::type unmarshal_raw(u_smx_scalar& simcall)
+{
+  return unmarshal(type<T>(), simcall);
+}
+
+template<std::size_t I>
+inline void marshalArgs(smx_simcall_t simcall) {}
 
-template<class A, class B, class C, class D, class E, class F, class G> inline
-void marshal(smx_simcall_t simcall, e_smx_simcall_t call,
-  A&& a, B&& b, C&& c, D&& d, E&& e, F&& f, G&& g)
+template<std::size_t I, class A>
+inline void marshalArgs(smx_simcall_t simcall, A const& a)
 {
-  simcall->call = call;
-  memset(&simcall->result, 0, sizeof(simcall->result));
-  marshal(simcall->args[0], std::forward<A>(a));
-  marshal(simcall->args[1], std::forward<B>(b));
-  marshal(simcall->args[2], std::forward<C>(c));
-  marshal(simcall->args[3], std::forward<D>(d));
-  marshal(simcall->args[4], std::forward<E>(e));
-  marshal(simcall->args[5], std::forward<F>(f));
-  marshal(simcall->args[6], std::forward<G>(g));
+  marshal(simcall->args[I], a);
 }
 
-template<class A, class B, class C,
-          class D, class E, class F, class G, class H> inline
-void marshal(smx_simcall_t simcall, e_smx_simcall_t call,
-  A&& a, B&& b, C&& c, D&& d, E&& e, F&& f, G&& g, H&& h)
+template<std::size_t I, class A, class... B>
+inline void marshalArgs(smx_simcall_t simcall, A const& a, B const&... b)
 {
-  simcall->call = call;
-  memset(&simcall->result, 0, sizeof(simcall->result));
-  marshal(simcall->args[0], std::forward<A>(a));
-  marshal(simcall->args[1], std::forward<B>(b));
-  marshal(simcall->args[2], std::forward<C>(c));
-  marshal(simcall->args[3], std::forward<D>(d));
-  marshal(simcall->args[4], std::forward<E>(e));
-  marshal(simcall->args[5], std::forward<F>(f));
-  marshal(simcall->args[6], std::forward<G>(g));
-  marshal(simcall->args[7], std::forward<H>(h));
-}
-
-template<class A, class B, class C,
-          class D, class E, class F,
-          class G, class H, class I> inline
-void marshal(smx_simcall_t simcall, e_smx_simcall_t call,
-  A&& a, B&& b, C&& c, D&& d, E&& e, F&& f, G&& g, H&& h, I&& i)
+  marshal(simcall->args[I], a);
+  marshalArgs<I+1>(simcall, b...);
+}
+
+/** Initialize the simcall */
+template<class... A> inline
+void marshal(smx_simcall_t simcall, e_smx_simcall_t call, A const&... a)
 {
   simcall->call = call;
   memset(&simcall->result, 0, sizeof(simcall->result));
-  marshal(simcall->args[0], std::forward<A>(a));
-  marshal(simcall->args[1], std::forward<B>(b));
-  marshal(simcall->args[2], std::forward<C>(c));
-  marshal(simcall->args[3], std::forward<D>(d));
-  marshal(simcall->args[4], std::forward<E>(e));
-  marshal(simcall->args[5], std::forward<F>(f));
-  marshal(simcall->args[6], std::forward<G>(g));
-  marshal(simcall->args[7], std::forward<H>(h));
-  marshal(simcall->args[8], std::forward<I>(i));
+  memset(simcall->args, 0, sizeof(simcall->args));
+  marshalArgs<0>(simcall, a...);
 }
 
 }
@@ -247,4 +225,6 @@ void marshal(smx_simcall_t simcall, e_smx_simcall_t call,
 
 #endif
 
+#include "popping_accessors.h"
+
 #endif