include/simgrid/modelchecker.h

   1 /* simgrid/modelchecker.h - Formal Verification made possible in SimGrid    */
   2
   3 /* Copyright (c) 2008-2019. The SimGrid Team. All rights reserved.          */
   4
   5 /* This program is free software; you can redistribute it and/or modify it
   6  * under the terms of the license (GNU LGPL) which comes with this package. */
   7
   8 /** \file modelchecker.h
   9  *
  10  *  This is the API used by the user simulated program to communicate
  11  *  with the MC.
  12  */
  13
  14 #ifndef SIMGRID_MODELCHECKER_H
  15 #define SIMGRID_MODELCHECKER_H
  16
  17 #include <simgrid/config.h> /* SIMGRID_HAVE_MC ? */
  18 #include <xbt/base.h>
  19
  20 #include <stddef.h> /* size_t */
  21
  22 SG_BEGIN_DECL()
  23
  24 XBT_PUBLIC int MC_random(int min, int max);
  25
  26 #if SIMGRID_HAVE_MC
  27
  28 /* Internal variable used to check if we're running under the MC
  29  *
  30  * Please don't use directly: you should use MC_is_active. */
  31 extern XBT_PUBLIC int _sg_do_model_check;
  32 extern XBT_PUBLIC int _sg_mc_max_visited_states;
  33
  34 #define MC_is_active()                  _sg_do_model_check
  35 #define MC_visited_reduction() _sg_mc_max_visited_states
  36
  37 /** Assertion for the model-checker
  38  *
  39  *  This function is used to define safety properties to verify.
  40  */
  41 XBT_PUBLIC void MC_assert(int);
  42
  43 XBT_PUBLIC void MC_automaton_new_propositional_symbol(const char* id, int (*fct)(void));
  44 XBT_PUBLIC void MC_automaton_new_propositional_symbol_pointer(const char* id, int* value);
  45
  46 XBT_PUBLIC void MC_cut(void);
  47 XBT_PUBLIC void MC_ignore(void* addr, size_t size);
  48
  49 XBT_PUBLIC void MC_ignore_heap(void* address, size_t size);
  50 XBT_PUBLIC void MC_unignore_heap(void* address, size_t size);
  51 XBT_PUBLIC void MC_ignore_global_variable(const char* var_name);
  52
  53 #else
  54
  55 #define MC_is_active()                  0
  56 #define MC_visited_reduction()          0
  57
  58 #define MC_assert(a)                    xbt_assert(a)
  59 #define MC_automaton_new_propositional_symbol(a, b) ((void)0)
  60 #define MC_automaton_new_propositional_symbol_pointer(a, b) ((void)0)
  61 #define MC_cut()                        ((void)0)
  62 #define MC_ignore(a, b)                 ((void)0)
  63
  64 #define MC_ignore_heap(a,s)             ((void)0)
  65 #define MC_remove_ignore_heap(a,s)      ((void)0)
  66 #define MC_ignore_global_variable(v)    ((void)0)
  67
  68 #endif
  69
  70 SG_END_DECL()
  71
  72 #endif /* SIMGRID_MODELCHECKER_H */