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/fifo.h>
   9 #include <xbt/sysdep.h>
  10 #include <simgrid/modelchecker.h>
  11
  12 #include "mc_record.h"
  13 #include "mc_private.h"
  14 #include "mc_mmalloc.h"
  15 #include "mc_ignore.h"
  16 #include "mc_protocol.h"
  17 #include "mc_client.h"
  18 #include "ModelChecker.hpp"
  19
  20 /** \file mc_client_api.cpp
  21  *
  22  *  This is the implementation of the API used by the user simulated program to
  23  *  communicate with the MC (declared in modelchecker.h).
  24  */
  25
  26 extern "C" {
  27
  28 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_client_api, mc,
  29   "Public API for the model-checked application");
  30
  31 }
  32
  33 int MC_random(int min, int max)
  34 {
  35   xbt_assert(mc_mode != MC_MODE_SERVER);
  36   /* TODO, if the MC is disabled we do not really need to make a simcall for
  37    * this :) */
  38   /* FIXME: return mc_current_state->executed_transition->random.value; */
  39   return simcall_mc_random(min, max);
  40 }
  41
  42 void MC_assert(int prop)
  43 {
  44   if (MC_is_active() && !prop) {
  45     MC_client_send_simple_message(MC_MESSAGE_ASSERTION_FAILED);
  46     MC_client_handle_messages();
  47   }
  48 }
  49
  50 void *MC_snapshot(void)
  51 {
  52   return simcall_mc_snapshot();
  53 }
  54
  55 int simcall_HANDLER_mc_compare_snapshots(smx_simcall_t simcall,
  56                                    mc_snapshot_t s1, mc_snapshot_t s2)
  57 {
  58   return snapshot_compare(s1, s2);
  59 }
  60
  61 int MC_compare_snapshots(void *s1, void *s2)
  62 {
  63   return simcall_mc_compare_snapshots(s1, s2);
  64 }
  65
  66 void MC_cut(void)
  67 {
  68   user_max_depth_reached = 1;
  69 }
  70
  71 void MC_ignore(void* addr, size_t size)
  72 {
  73   xbt_assert(mc_mode != MC_MODE_SERVER);
  74   if (mc_mode != MC_MODE_CLIENT)
  75     return;
  76
  77   s_mc_ignore_memory_message_t message;
  78   message.type = MC_MESSAGE_IGNORE_MEMORY;
  79   message.addr = (std::uintptr_t) addr;
  80   message.size = size;
  81   MC_client_send_message(&message, sizeof(message));
  82 }
  83
  84 void MC_automaton_new_propositional_symbol(const char *id, int(*fct)(void))
  85 {
  86   xbt_assert(mc_mode != MC_MODE_SERVER);
  87   if (mc_mode != MC_MODE_CLIENT)
  88     return;
  89
  90   xbt_die("Support for client-side function proposition is not implemented: "
  91     "use MC_automaton_new_propositional_symbol_pointer instead."
  92   );
  93 }
  94
  95 void MC_automaton_new_propositional_symbol_pointer(const char *name, int* value)
  96 {
  97   xbt_assert(mc_mode != MC_MODE_SERVER);
  98   if (mc_mode != MC_MODE_CLIENT)
  99     return;
 100
 101   s_mc_register_symbol_message_t message;
 102   message.type = MC_MESSAGE_REGISTER_SYMBOL;
 103   if (strlen(name) + 1 > sizeof(message.name))
 104     xbt_die("Symbol is too long");
 105   strncpy(message.name, name, sizeof(message.name));
 106   message.callback = nullptr;
 107   message.data = value;
 108   MC_client_send_message(&message, sizeof(message));
 109 }