[mc] Add comments

[simgrid.git] / src / include / mc / mc.h

diff --git a/src/include/mc/mc.h b/src/include/mc/mc.h
index c87f017..0cf9f2d 100644 (file)
--- a/src/include/mc/mc.h
+++ b/src/include/mc/mc.h
@@ -1,7 +1,5 @@
-/*     $Id: simix.h 5497 2008-05-26 12:19:15Z cristianrosa $    */
-
-/* Copyright (c) 2008 Martin Quinson, Cristian Rosa.
-   All rights reserved.                                          */
+/* Copyright (c) 2008-2013. 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. */
@@ -14,30 +12,58 @@
 #include "xbt/dict.h"
 #include "xbt/function_types.h"
 #include "mc/datatypes.h"
-#include "simix/datatypes.h"
+#include "simgrid/simix.h"
+#include "simgrid/modelchecker.h" /* our public interface (and definition of HAVE_MC) */
+#include "xbt/automaton.h"
+#include "xbt/dynar.h"
+
+#define STD_HEAP_SIZE   20480000        /* Maximum size of the system's heap */
 
 SG_BEGIN_DECL()
 
+/********************************** Configuration of MC **************************************/        
+extern int _sg_do_model_check;
+extern int _sg_mc_checkpoint;
+extern char* _sg_mc_property_file;
+extern int _sg_mc_timeout;
+extern int _sg_mc_max_depth;
+extern int _sg_mc_visited;
+extern char* _sg_mc_dot_output_file;
+
+extern xbt_dynar_t mc_heap_comparison_ignore;
+extern xbt_dynar_t stacks_areas;
+extern void *maestro_stack_start;
+extern void *maestro_stack_end;
+
 /********************************* Global *************************************/
-XBT_PUBLIC(void) MC_init(int);
-XBT_PUBLIC(void) MC_exit(int);
-XBT_PUBLIC(void) MC_assert(int);
-XBT_PUBLIC(void) MC_modelcheck(int);
-XBT_PUBLIC(int) MC_random(int,int);
+void _mc_cfg_cb_reduce(const char *name, int pos);
+void _mc_cfg_cb_checkpoint(const char *name, int pos);
+void _mc_cfg_cb_property(const char *name, int pos);
+void _mc_cfg_cb_timeout(const char *name, int pos);
+void _mc_cfg_cb_max_depth(const char *name, int pos);
+void _mc_cfg_cb_visited(const char *name, int pos);
+void _mc_cfg_cb_dot_output(const char *name, int pos);
 
-/******************************* Transitions **********************************/
-XBT_PUBLIC(mc_transition_t) MC_create_transition(mc_trans_type_t, smx_process_t, smx_rdv_t, smx_comm_t);
-XBT_PUBLIC(void) MC_transition_set_comm(mc_transition_t, smx_comm_t);
+XBT_PUBLIC(void) MC_do_the_modelcheck_for_real(void);
 
-/********************************* Memory *************************************/
-XBT_PUBLIC(void) MC_memory_init(void);   /* Initialize the memory subsystem */
-XBT_PUBLIC(void) MC_memory_exit(void);
+XBT_PUBLIC(void) MC_init(void);
+XBT_PUBLIC(void) MC_exit(void);
+XBT_PUBLIC(void) MC_modelcheck_safety(void);
+XBT_PUBLIC(void) MC_modelcheck_liveness(void);
+XBT_PUBLIC(void) MC_process_clock_add(smx_process_t, double);
+XBT_PUBLIC(double) MC_process_clock_get(smx_process_t);
+void MC_automaton_load(const char *file);
 
-/*
- * Boolean indicating whether we want to activate the model-checker
- */
-extern int _surf_do_model_check;
+/****************************** MC ignore **********************************/
+XBT_PUBLIC(void) MC_ignore_heap(void *address, size_t size);
+XBT_PUBLIC(void) MC_remove_ignore_heap(void *address, size_t size);
+XBT_PUBLIC(void) MC_ignore_local_variable(const char *var_name, const char *frame);
+XBT_PUBLIC(void) MC_ignore_global_variable(const char *var_name);
+void MC_new_stack_area(void *stack, char *name, void *context, size_t size);
 
+/********************************* Memory *************************************/
+XBT_PUBLIC(void) MC_memory_init(void);  /* Initialize the memory subsystem */
+XBT_PUBLIC(void) MC_memory_exit(void);
 
 SG_END_DECL()