-/* 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/sysdep.h>
-#include <xbt/automaton.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/Client.hpp"
-#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)
+int MC_random(int min, int max)
{
- if (MC_is_active() && !prop)
- simgrid::mc::Client::get()->reportAssertionFailure();
-}
+ xbt_assert(get_model_checking_mode() != ModelCheckingMode::CHECKER_SIDE,
+ "This should be called from the client side");
-void MC_cut(void)
-{
- // FIXME, We want to do this in the model-checker:
- xbt_die("MC_cut() not implemented");
+ 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_ignore(void* addr, size_t size)
-{
- xbt_assert(mc_mode != MC_MODE_SERVER);
- if (mc_mode != MC_MODE_CLIENT)
- return;
- simgrid::mc::Client::get()->ignoreMemory(addr, size);
-}
-
-void MC_automaton_new_propositional_symbol(const char *id, int(*fct)(void))
-{
- 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."
- );
-}
-
-void MC_automaton_new_propositional_symbol_pointer(const char *name, int* value)
-{
- xbt_assert(mc_mode != MC_MODE_SERVER);
- if (mc_mode != MC_MODE_CLIENT)
- return;
- simgrid::mc::Client::get()->declareSymbol(name, value);
-}
-
-/** @brief Register a stack in the model checker
- *
- * The stacks are allocated in the heap. The MC handle them especially
- * when we analyse/compare the content of the heap so it must be told where
- * they are with this function.
- *
- * @param stack
- * @param process Process owning the stack
- * @param context
- * @param size Size of the stack
- */
-void MC_register_stack_area(void *stack, smx_process_t process, ucontext_t* context, size_t size)
-{
- if (mc_mode != MC_MODE_CLIENT)
- return;
- simgrid::mc::Client::get()->declareStack(stack, size, process, context);
-}
-
-void MC_ignore_global_variable(const char *name)
-{
- // TODO, send a message to the model_checker
- xbt_die("Unimplemented");
-}
-
-void MC_ignore_heap(void *address, size_t size)
-{
- if (mc_mode != MC_MODE_CLIENT)
- return;
- simgrid::mc::Client::get()->ignoreHeap(address, size);
-}
-
-void MC_remove_ignore_heap(void *address, size_t size)
+void MC_assert(int prop)
{
- if (mc_mode != MC_MODE_CLIENT)
- return;
- simgrid::mc::Client::get()->unignoreHeap(address, size);
+ // 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
+}
+
+int MC_is_active()
+{
+ return get_model_checking_mode() == ModelCheckingMode::APP_SIDE ||
+ get_model_checking_mode() == ModelCheckingMode::CHECKER_SIDE;
}
