[mc] Support for mmap-able snapthots

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

diff --git a/src/mc/mc_base.h b/src/mc/mc_base.h
index c46241459fc4fddde93d9d1641dfa08b0f37eaef..7b668d56eb998c2137204a48185ce3fdf107085d 100644 (file)
--- a/src/mc/mc_base.h
+++ b/src/mc/mc_base.h
@@ -1,12 +1,13 @@
-/* Copyright (c) 2008-2014. The SimGrid Team.
+/* Copyright (c) 2008-2015. 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. */
 
-#ifndef MC_BASE_H
-#define MC_BASE_H
+#ifndef SIMGRID_MC_BASE_H
+#define SIMGRID_MC_BASE_H
 
+#include <xbt/misc.h>
 #include <simgrid/simix.h>
 #include "simgrid_config.h"
 #include "internal_config.h"
@@ -14,11 +15,27 @@
 
 SG_BEGIN_DECL()
 
-int MC_request_is_enabled(smx_simcall_t req);
-int MC_request_is_visible(smx_simcall_t req);
-void MC_wait_for_requests(void);
-
-extern double *mc_time;
+/** Check if the given simcall can be resolved
+ *
+ *  \return `TRUE` or `FALSE`
+ */
+XBT_PRIVATE int MC_request_is_enabled(smx_simcall_t req);
+
+/** Check if the given simcall is visible
+ *
+ *  \return `TRUE` or `FALSE`
+ */
+XBT_PRIVATE int MC_request_is_visible(smx_simcall_t req);
+
+/** Execute everything which is invisible
+ *
+ *  Execute all the processes that are ready to run and all invisible simcalls
+ *  iteratively until there doesn't remain any. At this point, the function
+ *  returns to the caller which can handle the visible (and ready) simcalls.
+ */
+XBT_PRIVATE void MC_wait_for_requests(void);
+
+XBT_PRIVATE extern double *mc_time;
 
 SG_END_DECL()