src/mc/mc_client_api.cpp

   1 /* Copyright (c) 2008-2015. The SimGrid Team.
   2  * All rights reserved.                                                     */
   3
   4 /* This program is free software; you can redistribute it and/or modify it
   5  * under the terms of the license (GNU LGPL) which comes with this package. */
   6
   7 #include <xbt/log.h>
   8 #include <xbt/sysdep.h>
   9 #include <xbt/automaton.h>
  10 #include <simgrid/modelchecker.h>
  11
  12 #include "src/mc/mc_record.h"
  13 #include "src/mc/mc_private.h"
  14 #include "src/mc/mc_ignore.h"
  15 #include "src/mc/mc_protocol.h"
  16 #include "src/mc/Client.hpp"
  17 #include "src/mc/ModelChecker.hpp"
  18
  19 /** \file mc_client_api.cpp
  20  *
  21  *  This is the implementation of the API used by the user simulated program to
  22  *  communicate with the MC (declared in modelchecker.h).
  23  */
  24
  25 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_client_api, mc,
  26   "Public API for the model-checked application");
  27
  28 // MC_random() is in mc_base.cpp
  29
  30 void MC_assert(int prop)
  31 {
  32   if (MC_is_active() && !prop)
  33     simgrid::mc::Client::get()->reportAssertionFailure();
  34 }
  35
  36 void MC_cut(void)
  37 {
  38   // FIXME, We want to do this in the model-checker:
  39   xbt_die("MC_cut() not implemented");
  40 }
  41
  42 void MC_ignore(void* addr, size_t size)
  43 {
  44   xbt_assert(mc_mode != MC_MODE_SERVER);
  45   if (mc_mode != MC_MODE_CLIENT)
  46     return;
  47   simgrid::mc::Client::get()->ignoreMemory(addr, size);
  48 }
  49
  50 void MC_automaton_new_propositional_symbol(const char *id, int(*fct)(void))
  51 {
  52   xbt_assert(mc_mode != MC_MODE_SERVER);
  53   if (mc_mode != MC_MODE_CLIENT)
  54     return;
  55
  56   xbt_die("Support for client-side function proposition is not implemented: "
  57     "use MC_automaton_new_propositional_symbol_pointer instead."
  58   );
  59 }
  60
  61 void MC_automaton_new_propositional_symbol_pointer(const char *name, int* value)
  62 {
  63   xbt_assert(mc_mode != MC_MODE_SERVER);
  64   if (mc_mode != MC_MODE_CLIENT)
  65     return;
  66   simgrid::mc::Client::get()->declareSymbol(name, value);
  67 }
  68
  69 /** @brief Register a stack in the model checker
  70  *
  71  *  The stacks are allocated in the heap. The MC handle them especially
  72  *  when we analyse/compare the content of the heap so it must be told where
  73  *  they are with this function.
  74  *
  75  *  @param stack
  76  *  @param process Process owning the stack
  77  *  @param context
  78  *  @param size    Size of the stack
  79  */
  80 void MC_register_stack_area(void *stack, smx_process_t process, ucontext_t* context, size_t size)
  81 {
  82   if (mc_mode != MC_MODE_CLIENT)
  83     return;
  84   simgrid::mc::Client::get()->declareStack(stack, size, process, context);
  85 }
  86
  87 void MC_ignore_global_variable(const char *name)
  88 {
  89   // TODO, send a message to the model_checker
  90   xbt_die("Unimplemented");
  91 }
  92
  93 void MC_ignore_heap(void *address, size_t size)
  94 {
  95   if (mc_mode != MC_MODE_CLIENT)
  96     return;
  97   simgrid::mc::Client::get()->ignoreHeap(address, size);
  98 }
  99
 100 void MC_remove_ignore_heap(void *address, size_t size)
 101 {
 102   if (mc_mode != MC_MODE_CLIENT)
 103     return;
 104   simgrid::mc::Client::get()->unignoreHeap(address, size);
 105 }