include/simgrid/modelchecker.h

   1 /* simgrid/modelchecker.h - Formal Verification made possible in SimGrid    */
   2
   3 /* Copyright (c) 2008-2017. 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 <stdbool.h>
  18 #include <stddef.h> /* size_t */
  19
  20 #include <simgrid_config.h> /* SIMGRID_HAVE_MC ? */
  21
  22 #include <xbt/base.h>
  23
  24 SG_BEGIN_DECL()
  25
  26 XBT_PUBLIC(int) MC_random(int min, int max);
  27
  28 #if SIMGRID_HAVE_MC
  29
  30 /* Internal variable used to check if we're running under the MC
  31  *
  32  * Please don't use directly: you should use MC_is_active. */
  33 extern XBT_PUBLIC(int) _sg_do_model_check;
  34 extern XBT_PUBLIC(int) _sg_mc_max_visited_states;
  35
  36 #define MC_is_active()                  _sg_do_model_check
  37 #define MC_visited_reduction() _sg_mc_max_visited_states
  38
  39 /** Assertion for the model-checker
  40  *
  41  *  This function is used to define safety properties to verify.
  42  */
  43 XBT_PUBLIC(void) MC_assert(int);
  44
  45 XBT_PUBLIC(void) MC_automaton_new_propositional_symbol(const char* id, int(*fct)(void));
  46 XBT_PUBLIC(void) MC_automaton_new_propositional_symbol_pointer(const char *id, int* value);
  47
  48 XBT_PUBLIC(void) MC_cut(void);
  49 XBT_PUBLIC(void) MC_ignore(void *addr, size_t size);
  50
  51 XBT_PUBLIC(void) MC_ignore_heap(void* address, size_t size);
  52 XBT_PUBLIC(void) MC_remove_ignore_heap(void* address, size_t size);
  53 XBT_PUBLIC(void) MC_ignore_local_variable(const char* var_name, const char* frame);
  54 XBT_PUBLIC(void) MC_ignore_global_variable(const char* var_name);
  55
  56 #else
  57
  58 #define MC_is_active()                  0
  59 #define MC_visited_reduction()          0
  60
  61 #define MC_assert(a)                    xbt_assert(a)
  62 #define MC_automaton_new_propositional_symbol(a, b) ((void)0)
  63 #define MC_automaton_new_propositional_symbol_pointer(a, b) ((void)0)
  64 #define MC_cut()                        ((void)0)
  65 #define MC_ignore(a, b)                 ((void)0)
  66
  67 #define MC_ignore_heap(a,s)             ((void)0)
  68 #define MC_remove_ignore_heap(a,s)      ((void)0)
  69 #define MC_ignore_local_variable(n,f)   ((void)0)
  70 #define MC_ignore_global_variable(v)    ((void)0)
  71
  72 #endif
  73
  74 SG_END_DECL()
  75
  76 #endif /* SIMGRID_MODELCHECKER_H */