Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Add new entry in Release_Notes.
[simgrid.git] / src / mc / mc_client_api.cpp
index da2fece..27e471d 100644 (file)
@@ -1,81 +1,55 @@
-/* Copyright (c) 2008-2015. The SimGrid Team.
- * All rights reserved.                                                     */
+/* Copyright (c) 2008-2023. 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. */
 
-#include <xbt/log.h>
-#include <xbt/fifo.h>
-#include <xbt/sysdep.h>
-#include <simgrid/modelchecker.h>
+#include "simgrid/simix.hpp"
+#include "src/kernel/actor/ActorImpl.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"
 
-#include "src/mc/mc_record.h"
-#include "src/mc/mc_private.h"
-#include "src/mc/mc_ignore.h"
-#include "src/mc/mc_protocol.h"
-#include "src/mc/mc_client.h"
-#include "src/mc/ModelChecker.hpp"
+using namespace simgrid::mc;
 
-/** \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).
- */
+/* Implementation of the user API from the App to the Checker (see modelchecker.h)  */
 
-XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_client_api, mc,
-  "Public API for the model-checked application");
-
-// MC_random() is in mc_base.cpp
-
-void MC_assert(int prop)
-{
-  if (MC_is_active() && !prop) {
-    MC_client_send_simple_message(MC_MESSAGE_ASSERTION_FAILED);
-    MC_client_handle_messages();
-  }
-}
-
-void MC_cut(void)
+int MC_random(int min, int max)
 {
-  user_max_depth_reached = 1;
-}
+  xbt_assert(get_model_checking_mode() != ModelCheckingMode::CHECKER_SIDE,
+             "This should be called from the client side");
 
-void MC_ignore(void* addr, size_t size)
-{
-  xbt_assert(mc_mode != MC_MODE_SERVER);
-  if (mc_mode != MC_MODE_CLIENT)
-    return;
-
-  s_mc_ignore_memory_message_t message;
-  message.type = MC_MESSAGE_IGNORE_MEMORY;
-  message.addr = (std::uintptr_t) addr;
-  message.size = size;
-  MC_client_send_message(&message, sizeof(message));
+  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_automaton_new_propositional_symbol(const char *id, int(*fct)(void))
+void MC_assert(int prop)
 {
-  xbt_assert(mc_mode != MC_MODE_SERVER);
-  if (mc_mode != MC_MODE_CLIENT)
-    return;
-
-  xbt_die("Support for client-side function proposition is not implemented: "
-    "use MC_automaton_new_propositional_symbol_pointer instead."
-  );
+  // Cannot used xbt_assert here, or it would be an infinite recursion.
+  xbt_assert(get_model_checking_mode() != ModelCheckingMode::CHECKER_SIDE,
+             "This should be called from the client side");
+#if SIMGRID_HAVE_MC
+  if (not prop) {
+    if (MC_is_active())
+      AppSide::get()->report_assertion_failure();
+    if (MC_record_replay_is_active())
+      xbt_die("MC assertion failed");
+  }
+#else
+  if (not prop)
+    xbt_die("Safety property violation detected without the model-checker");
+#endif
 }
 
-void MC_automaton_new_propositional_symbol_pointer(const char *name, int* value)
+int MC_is_active()
 {
-  xbt_assert(mc_mode != MC_MODE_SERVER);
-  if (mc_mode != MC_MODE_CLIENT)
-    return;
-
-  s_mc_register_symbol_message_t message;
-  message.type = MC_MESSAGE_REGISTER_SYMBOL;
-  if (strlen(name) + 1 > sizeof(message.name))
-    xbt_die("Symbol is too long");
-  strncpy(message.name, name, sizeof(message.name));
-  message.callback = nullptr;
-  message.data = value;
-  MC_client_send_message(&message, sizeof(message));
+  return get_model_checking_mode() == ModelCheckingMode::APP_SIDE ||
+         get_model_checking_mode() == ModelCheckingMode::CHECKER_SIDE;
 }