src/mc/remote/mc_protocol.h

   1 /* Copyright (c) 2015-2022. The SimGrid Team. All rights reserved.          */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4  * under the terms of the license (GNU LGPL) which comes with this package. */
   5
   6 #ifndef SIMGRID_MC_PROTOCOL_H
   7 #define SIMGRID_MC_PROTOCOL_H
   8
   9 // ***** Environment variables for passing context to the model-checked process
  10
  11 /** Environment variable name used to pass the communication socket.
  12  *
  13  * It is set by `simgrid-mc` to enable MC support in the children processes
  14  */
  15 #define MC_ENV_SOCKET_FD "SIMGRID_MC_SOCKET_FD"
  16
  17 #ifdef __cplusplus
  18
  19 #include "src/kernel/actor/SimcallObserver.hpp"
  20
  21 #include "mc/datatypes.h"
  22 #include "simgrid/forward.h" // aid_t
  23 #include <array>
  24 #include <cstdint>
  25 #include <xbt/dynar.h>
  26 #include <xbt/mmalloc.h>
  27 #include <xbt/utility.hpp>
  28
  29 // ***** Messages
  30 namespace simgrid {
  31 namespace mc {
  32
  33 XBT_DECLARE_ENUM_CLASS(MessageType, NONE, INITIAL_ADDRESSES, CONTINUE, IGNORE_HEAP, UNIGNORE_HEAP, IGNORE_MEMORY,
  34                        STACK_REGION, REGISTER_SYMBOL, DEADLOCK_CHECK, DEADLOCK_CHECK_REPLY, WAITING, SIMCALL_EXECUTE,
  35                        SIMCALL_EXECUTE_ANSWER, SIMCALL_IS_VISIBLE, SIMCALL_IS_VISIBLE_ANSWER, ASSERTION_FAILED,
  36                        ACTOR_ENABLED, ACTOR_ENABLED_REPLY, FINALIZE);
  37
  38 #define SIMCALL_SERIALIZATION_BUFFER_SIZE 2048
  39
  40 } // namespace mc
  41 } // namespace simgrid
  42
  43 constexpr unsigned MC_MESSAGE_LENGTH = 512;
  44
  45 /** Basic structure for a MC message
  46  *
  47  *  The current version of the client/server protocol sends C structures over `AF_LOCAL`
  48  *  `SOCK_SEQPACKET` sockets. This means that the protocol is ABI/architecture specific:
  49  *  we currently can't model-check a x86 process from a x86_64 process.
  50  *
  51  *  Moreover the protocol is not stable. The same version of the library should be used
  52  *  for the client and the server.
  53  */
  54
  55 /* Basic structure: all message start with a message type */
  56 struct s_mc_message_t {
  57   simgrid::mc::MessageType type;
  58 };
  59
  60 struct s_mc_message_int_t {
  61   simgrid::mc::MessageType type;
  62   uint64_t value;
  63 };
  64
  65 /* Client->Server */
  66 struct s_mc_message_initial_addresses_t {
  67   simgrid::mc::MessageType type;
  68   xbt_mheap_t mmalloc_default_mdp;
  69   unsigned long* maxpid;
  70   xbt_dynar_t actors;
  71   xbt_dynar_t dead_actors;
  72 };
  73
  74 struct s_mc_message_ignore_heap_t {
  75   simgrid::mc::MessageType type;
  76   int block;
  77   int fragment;
  78   void* address;
  79   size_t size;
  80 };
  81
  82 struct s_mc_message_ignore_memory_t {
  83   simgrid::mc::MessageType type;
  84   uint64_t addr;
  85   size_t size;
  86 };
  87
  88 struct s_mc_message_stack_region_t {
  89   simgrid::mc::MessageType type;
  90   s_stack_region_t stack_region;
  91 };
  92
  93 struct s_mc_message_register_symbol_t {
  94   simgrid::mc::MessageType type;
  95   std::array<char, 128> name;
  96   int (*callback)(void*);
  97   void* data;
  98 };
  99
 100 /* Server -> client */
 101 struct s_mc_message_simcall_execute_t {
 102   simgrid::mc::MessageType type;
 103   aid_t aid_;
 104   int times_considered_;
 105 };
 106 struct s_mc_message_simcall_execute_answer_t {
 107   simgrid::mc::MessageType type;
 108   simgrid::mc::Transition::Type simcall;
 109   char buffer[SIMCALL_SERIALIZATION_BUFFER_SIZE];
 110 };
 111
 112 struct s_mc_message_restore_t {
 113   simgrid::mc::MessageType type;
 114   int index;
 115 };
 116
 117 struct s_mc_message_actor_enabled_t {
 118   simgrid::mc::MessageType type;
 119   aid_t aid; // actor ID
 120 };
 121
 122 /* RPC */
 123 struct s_mc_message_simcall_is_visible_t { // MessageType::SIMCALL_IS_VISIBLE
 124   simgrid::mc::MessageType type;
 125   aid_t aid;
 126 };
 127 struct s_mc_message_simcall_is_visible_answer_t { // MessageType::SIMCALL_IS_VISIBLE_ANSWER
 128   simgrid::mc::MessageType type;
 129   bool value;
 130 };
 131
 132 #endif // __cplusplus
 133 #endif