Don't include simgrid/config.h from simgrid/modelchecker.h so that the later is cheap...

[simgrid.git] / src / mc / mc_client_api.cpp

diff --git a/src/mc/mc_client_api.cpp b/src/mc/mc_client_api.cpp
index d8044c3..d2dd997 100644 (file)
--- a/src/mc/mc_client_api.cpp
+++ b/src/mc/mc_client_api.cpp
@@ -1,27 +1,35 @@
-/* Copyright (c) 2008-2022. The SimGrid Team.
- * All rights reserved.                                                     */
+/* Copyright (c) 2008-2022. 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. */
 
+/* Implementation of the user API from the App to the Checker (see modelchecker.h)  */
+
 #include "src/mc/ModelChecker.hpp"
-#include "src/mc/mc_ignore.hpp"
+#include "src/mc/mc_config.hpp"
 #include "src/mc/mc_private.hpp"
 #include "src/mc/mc_record.hpp"
 #include "src/mc/mc_replay.hpp"
 #include "src/mc/remote/AppSide.hpp"
 #include "xbt/asserts.h"
+#include "xbt/random.hpp"
 
-/** @file mc_client_api.cpp
- *
- *  This is the implementation of the API used by the user simulated program to
- *  communicate with the MC (declared in modelchecker.h).
- */
-
-// MC_random() is in mc_base.cpp
+int MC_random(int min, int max)
+{
+#if SIMGRID_HAVE_MC
+  xbt_assert(mc_model_checker == nullptr);
+#endif
+  if (not MC_is_active() && not MC_record_replay_is_active()) { // no need to do a simcall in this case
+    static simgrid::xbt::random::XbtRandom prng;
+    return prng.uniform_int(min, max);
+  }
+  simgrid::kernel::actor::RandomSimcall observer{simgrid::kernel::actor::ActorImpl::self(), min, max};
+  return simgrid::kernel::actor::simcall_answered([&observer] { return observer.get_value(); }, &observer);
+}
 
 void MC_assert(int prop)
 {
+#if SIMGRID_HAVE_MC
   xbt_assert(mc_model_checker == nullptr);
   if (not prop) {
     if (MC_is_active())
@@ -29,73 +37,48 @@ void MC_assert(int prop)
     if (MC_record_replay_is_active())
       xbt_die("MC assertion failed");
   }
+#else
+  xbt_assert(prop, "Safety property violation detected without the model-checker");
+#endif
 }
 
-void MC_ignore(void* addr, size_t size)
+int MC_is_active()
 {
-  xbt_assert(mc_model_checker == nullptr);
-  if (not MC_is_active())
-    return;
-  simgrid::mc::AppSide::get()->ignore_memory(addr, size);
-}
-
-void MC_automaton_new_propositional_symbol(const char* /*id*/, int (*/*fct*/)())
-{
-  xbt_assert(mc_model_checker == nullptr);
-  if (not MC_is_active())
-    return;
-  xbt_die("Support for client-side function proposition is not implemented: "
-    "use MC_automaton_new_propositional_symbol_pointer instead.");
+  return simgrid::mc::cfg_do_model_check;
 }
 
 void MC_automaton_new_propositional_symbol_pointer(const char *name, int* value)
 {
+#if SIMGRID_HAVE_MC
   xbt_assert(mc_model_checker == nullptr);
   if (not MC_is_active())
     return;
   simgrid::mc::AppSide::get()->declare_symbol(name, value);
+#endif
 }
 
-/** @brief Register a stack in the model checker
- *
- *  The stacks are allocated in the heap. The MC handle them specifically
- *  when we analyze/compare the content of the heap so it must be told where
- *  they are with this function.
- *
- *  @param stack Where the stack is
- *  @param actor Actor owning the stack
- *  @param context The context associated to that stack
- *  @param size    Size of the stack
- */
-void MC_register_stack_area(void* stack, ucontext_t* context, size_t size)
-{
-  xbt_assert(mc_model_checker == nullptr);
-  if (not MC_is_active())
-    return;
-  simgrid::mc::AppSide::get()->declare_stack(stack, size, context);
-}
-
-void MC_ignore_global_variable(const char* /*name*/)
+void MC_ignore(void* addr, size_t size)
 {
+#if SIMGRID_HAVE_MC
   xbt_assert(mc_model_checker == nullptr);
   if (not MC_is_active())
     return;
-  // TODO, send a message to the model_checker
-  xbt_die("Unimplemented");
+  simgrid::mc::AppSide::get()->ignore_memory(addr, size);
+#endif
 }
 
 void MC_ignore_heap(void *address, size_t size)
 {
+#if SIMGRID_HAVE_MC
   xbt_assert(mc_model_checker == nullptr);
-  if (not MC_is_active())
-    return;
   simgrid::mc::AppSide::get()->ignore_heap(address, size);
+#endif
 }
 
 void MC_unignore_heap(void* address, size_t size)
 {
+#if SIMGRID_HAVE_MC
   xbt_assert(mc_model_checker == nullptr);
-  if (not MC_is_active())
-    return;
   simgrid::mc::AppSide::get()->unignore_heap(address, size);
+#endif
 }