cosmetic to make the code easier to read

[simgrid.git] / include / simgrid / modelchecker.h

diff --git a/include/simgrid/modelchecker.h b/include/simgrid/modelchecker.h
index 34d9124..2ddf8a9 100644 (file)
--- a/include/simgrid/modelchecker.h
+++ b/include/simgrid/modelchecker.h
@@ -1,35 +1,54 @@
 /* simgrid/modelchecker.h - Formal Verification made possible in SimGrid    */
 
-/* Copyright (c) 2008-2014. The SimGrid Team.
- * All rights reserved.                                                     */
+/* Copyright (c) 2008-2019. 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"
+/** \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 <simgrid/config.h> /* SIMGRID_HAVE_MC ? */
+#include <xbt/base.h>
+
+#include <stddef.h> /* size_t */
+
 SG_BEGIN_DECL()
 
-#ifdef HAVE_MC
+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;
 
-extern int _sg_do_model_check; /* please don't use directly: we inline MC_is_active, but that's what you should use */
-extern int _sg_mc_visited;
+#define MC_is_active()         _sg_do_model_check
+#define MC_visited_reduction() _sg_mc_max_visited_states
 
-#define MC_is_active()                  _sg_do_model_check
-#define MC_visited_reduction()          _sg_mc_visited
+/** 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_assert(int);
-XBT_PUBLIC(int) MC_random(int min, int max);
-XBT_PUBLIC(void) MC_automaton_new_propositional_symbol(const char* id, void* fct);
-XBT_PUBLIC(void *) MC_snapshot(void);
-XBT_PUBLIC(int) MC_compare_snapshots(void *s1, void *s2);
-XBT_PUBLIC(void) MC_cut(void);
-XBT_PUBLIC(void) MC_ignore(void *addr, size_t size);
+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);
+
+XBT_PUBLIC void MC_cut(void);
+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);
+XBT_PUBLIC void MC_ignore_global_variable(const char* var_name);
 
 #else
 
@@ -37,13 +56,15 @@ XBT_PUBLIC(void) MC_ignore(void *addr, size_t size);
 #define MC_visited_reduction()          0
 
 #define MC_assert(a)                    xbt_assert(a)
-#define MC_random(a, b)                 0
 #define MC_automaton_new_propositional_symbol(a, b) ((void)0)
-#define MC_snapshot()                   ((void*)0)
-#define MC_compare_snapshots(a, b)      0
+#define MC_automaton_new_propositional_symbol_pointer(a, b) ((void)0)
 #define MC_cut()                        ((void)0)
 #define MC_ignore(a, b)                 ((void)0)
 
+#define MC_ignore_heap(a,s)             ((void)0)
+#define MC_remove_ignore_heap(a,s)      ((void)0)
+#define MC_ignore_global_variable(v)    ((void)0)
+
 #endif
 
 SG_END_DECL()