Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Various doc improvements
[simgrid.git] / include / simgrid / modelchecker.h
index 30d97c3efee8153706e171b4f9c21b113a2aa199..09566a3b824872cd286f33e201d554759677a7a5 100644 (file)
@@ -1,36 +1,28 @@
 /* simgrid/modelchecker.h - Formal Verification made possible in SimGrid    */
 
-/* Copyright (c) 2008-2012. 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 <simgrid_config.h> /* HAVE_MC ? */
-#include <xbt.h>
-#include "xbt/automaton.h"
-
 #ifndef SIMGRID_MODELCHECKER_H
 #define SIMGRID_MODELCHECKER_H
 
-#ifdef HAVE_MC
-
-extern int _surf_do_model_check;
-#define MC_IS_ENABLED _surf_do_model_check
-
-XBT_PUBLIC(void) MC_assert(int);
-XBT_PUBLIC(void) MC_assert_stateful(int);
-XBT_PUBLIC(int) MC_random(int min, int max);
-XBT_PUBLIC(void) MC_diff(void);
-XBT_PUBLIC(xbt_automaton_t) MC_create_automaton(const char *file);
+#include <stddef.h> /* size_t */
+#include <xbt/base.h>
 
-#else
+SG_BEGIN_DECL
 
-#define MC_IS_ENABLED 0
-#define MC_assert(a) xbt_assert(a)
-#define MC_assert_stateful(a) xbt_assert(a)
+/** Explore every branches where that function returns a value between min and max (inclusive) */
+XBT_PUBLIC int MC_random(int min, int max);
 
-#endif
+/** Assertion for the model-checker: Defines a safety property to verify */
+XBT_PUBLIC void MC_assert(int);
 
+/** 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();
 
+SG_END_DECL
 
 #endif /* SIMGRID_MODELCHECKER_H */