/* simgrid/modelchecker.h - Formal Verification made possible in SimGrid */
-/* 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. */
-/** \file modelchecker.h
- *
- * This is the API used by the user simulated program to communicate
- * with the MC.
- */
-
#ifndef SIMGRID_MODELCHECKER_H
#define SIMGRID_MODELCHECKER_H
-#include <stdbool.h>
#include <stddef.h> /* size_t */
-
-#include <simgrid_config.h> /* SIMGRID_HAVE_MC ? */
-
#include <xbt/base.h>
-SG_BEGIN_DECL()
-
-XBT_PUBLIC(int) MC_random(int min, int max);
-
-#if SIMGRID_HAVE_MC
-
-/* Internal variable used to check if we're running under the MC
- *
- * Please don't use directly: you should use MC_is_active. */
-extern XBT_PUBLIC(int) _sg_do_model_check;
-extern XBT_PUBLIC(int) _sg_mc_max_visited_states;
-
-#define MC_is_active() _sg_do_model_check
-#define MC_visited_reduction() _sg_mc_max_visited_states
-
-/** Assertion for the model-checker
- *
- * This function is used to define safety properties to verify.
- */
-XBT_PUBLIC(void) MC_assert(int);
-
-XBT_PUBLIC(void) MC_automaton_new_propositional_symbol(const char* id, int(*fct)(void));
-XBT_PUBLIC(void) MC_automaton_new_propositional_symbol_pointer(const char *id, int* value);
+SG_BEGIN_DECL
-XBT_PUBLIC(void) MC_cut(void);
-XBT_PUBLIC(void) MC_ignore(void *addr, size_t size);
+/** Explore every branches where that function returns a value between min and max (inclusive) */
+XBT_PUBLIC int MC_random(int min, int max);
-#else
+/** Assertion for the model-checker: Defines a safety property to verify */
+XBT_PUBLIC void MC_assert(int);
-#define MC_is_active() 0
-#define MC_visited_reduction() 0
+/** Check whether the model-checker is currently active, ie if this process was started with simgrid-mc.
+ * It is off in simulation or when replaying MC traces (see MC_record_replay_is_active()) */
+XBT_PUBLIC int MC_is_active();
-#define MC_assert(a) xbt_assert(a)
-#define MC_automaton_new_propositional_symbol(a, b) ((void)0)
-#define MC_automaton_new_propositional_symbol_pointer(a, b) ((void)0)
-#define MC_cut() ((void)0)
-#define MC_ignore(a, b) ((void)0)
+XBT_PUBLIC void MC_automaton_new_propositional_symbol_pointer(const char* id, int* value);
-#endif
+XBT_PUBLIC void MC_ignore(void* addr, size_t size);
+XBT_PUBLIC void MC_ignore_heap(void* address, size_t size);
+XBT_PUBLIC void MC_unignore_heap(void* address, size_t size);
-SG_END_DECL()
+SG_END_DECL
#endif /* SIMGRID_MODELCHECKER_H */
