Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Rename instr_interface.h and mc_ignore.h to .hpp.
[simgrid.git] / src / mc / mc_client_api.cpp
index 179033b..68279a7 100644 (file)
-/* Copyright (c) 2008-2015. The SimGrid Team.
+/* Copyright (c) 2008-2018. 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 <xbt/log.h>
-#include <xbt/fifo.h>
-#include <xbt/sysdep.h>
+#include "xbt/log.h"
+#include "xbt/sysdep.h"
 #include <simgrid/modelchecker.h>
 
-#include "mc_record.h"
-#include "mc_private.h"
-#include "mc_mmalloc.h"
-#include "mc_ignore.h"
-#include "mc_protocol.h"
-#include "mc_client.h"
-#include "ModelChecker.hpp"
+#include "src/mc/ModelChecker.hpp"
+#include "src/mc/mc_ignore.hpp"
+#include "src/mc/mc_private.hpp"
+#include "src/mc/mc_record.hpp"
+#include "src/mc/remote/Client.hpp"
+#include "src/mc/remote/mc_protocol.h"
 
-extern "C" {
+/** @file mc_client_api.cpp
+ *
+ *  This is the implementation of the API used by the user simulated program to
+ *  communicate with the MC (declared in modelchecker.h).
+ */
 
 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_client_api, mc,
   "Public API for the model-checked application");
 
+// MC_random() is in mc_base.cpp
+
 void MC_assert(int prop)
 {
-  if (MC_is_active() && !prop) {
-    MC_client_send_simple_message(MC_MESSAGE_ASSERTION_FAILED);
-    MC_client_handle_messages();
-  }
+  xbt_assert(mc_model_checker == nullptr);
+  if (MC_is_active() && not prop)
+    simgrid::mc::Client::get()->reportAssertionFailure();
 }
 
-// TODO, MC_automaton_new_propositional_symbol
+void MC_cut()
+{
+  xbt_assert(mc_model_checker == nullptr);
+  if (not MC_is_active())
+    return;
+  // FIXME, We want to do this in the model-checker:
+  xbt_die("MC_cut() not implemented");
+}
 
-void *MC_snapshot(void)
+void MC_ignore(void* addr, size_t size)
 {
-  return simcall_mc_snapshot();
+  xbt_assert(mc_model_checker == nullptr);
+  if (not MC_is_active())
+    return;
+  simgrid::mc::Client::get()->ignoreMemory(addr, size);
 }
 
-int simcall_HANDLER_mc_compare_snapshots(smx_simcall_t simcall,
-                                   mc_snapshot_t s1, mc_snapshot_t s2)
+void MC_automaton_new_propositional_symbol(const char* id, int (*fct)())
 {
-  return snapshot_compare(s1, s2);
+  xbt_assert(mc_model_checker == nullptr);
+  if (not MC_is_active())
+    return;
+  xbt_die("Support for client-side function proposition is not implemented: "
+    "use MC_automaton_new_propositional_symbol_pointer instead.");
 }
 
-int MC_compare_snapshots(void *s1, void *s2)
+void MC_automaton_new_propositional_symbol_pointer(const char *name, int* value)
 {
-  return simcall_mc_compare_snapshots(s1, s2);
+  xbt_assert(mc_model_checker == nullptr);
+  if (not MC_is_active())
+    return;
+  simgrid::mc::Client::get()->declareSymbol(name, value);
 }
 
-void MC_cut(void)
+/** @brief Register a stack in the model checker
+ *
+ *  The stacks are allocated in the heap. The MC handle them specifically
+ *  when we analyze/compare the content of the heap so it must be told where
+ *  they are with this function.
+ *
+ *  @param stack Where the stack is
+ *  @param actor Actor owning the stack
+ *  @param context The context associated to that stack
+ *  @param size    Size of the stack
+ */
+void MC_register_stack_area(void* stack, smx_actor_t actor, ucontext_t* context, size_t size)
 {
-  user_max_depth_reached = 1;
+  xbt_assert(mc_model_checker == nullptr);
+  if (not MC_is_active())
+    return;
+  simgrid::mc::Client::get()->declareStack(stack, size, actor, context);
 }
 
-void MC_ignore(void* addr, size_t size)
+void MC_ignore_global_variable(const char *name)
 {
-  if (mc_mode == MC_MODE_CLIENT) {
-    s_mc_ignore_memory_message_t message;
-    message.type = MC_MESSAGE_IGNORE_MEMORY;
-    message.addr = addr;
-    message.size = size;
-    MC_client_send_message(&message, sizeof(message));
-  }
+  xbt_assert(mc_model_checker == nullptr);
+  if (not MC_is_active())
+    return;
+  // TODO, send a message to the model_checker
+  xbt_die("Unimplemented");
+}
 
-  // TODO, remove this once the migration has been completed
-  xbt_mheap_t heap = mmalloc_set_current_heap(mc_heap);
-  MC_process_ignore_memory(&mc_model_checker->process(), addr, size);
-  mmalloc_set_current_heap(heap);
+void MC_ignore_heap(void *address, size_t size)
+{
+  xbt_assert(mc_model_checker == nullptr);
+  if (not MC_is_active())
+    return;
+  simgrid::mc::Client::get()->ignoreHeap(address, size);
 }
 
+void MC_unignore_heap(void* address, size_t size)
+{
+  xbt_assert(mc_model_checker == nullptr);
+  if (not MC_is_active())
+    return;
+  simgrid::mc::Client::get()->unignoreHeap(address, size);
 }