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 "mc/datatypes.h"
  20 #include "simgrid/forward.h" // aid_t
  21 #include <array>
  22 #include <cstdint>
  23 #include <xbt/dynar.h>
  24 #include <xbt/mmalloc.h>
  25 #include <xbt/utility.hpp>
  26
  27 // ***** Messages
  28 namespace simgrid {
  29 namespace mc {
  30
  31 XBT_DECLARE_ENUM_CLASS(MessageType, NONE, INITIAL_ADDRESSES, CONTINUE, IGNORE_HEAP, UNIGNORE_HEAP, IGNORE_MEMORY,
  32                        STACK_REGION, REGISTER_SYMBOL, DEADLOCK_CHECK, DEADLOCK_CHECK_REPLY, WAITING, SIMCALL_EXECUTE,
  33                        SIMCALL_EXECUTE_ANSWER, SIMCALL_IS_VISIBLE, SIMCALL_IS_VISIBLE_ANSWER, SIMCALL_TO_STRING,
  34                        SIMCALL_TO_STRING_ANSWER, SIMCALLS_DEPENDENT, SIMCALLS_DEPENDENT_ANSWER, SIMCALL_DOT_LABEL,
  35                        ASSERTION_FAILED, ACTOR_ENABLED, ACTOR_ENABLED_REPLY, FINALIZE);
  36
  37 } // namespace mc
  38 } // namespace simgrid
  39
  40 constexpr unsigned MC_MESSAGE_LENGTH = 512;
  41
  42 /** Basic structure for a MC message
  43  *
  44  *  The current version of the client/server protocol sends C structures over `AF_LOCAL`
  45  *  `SOCK_SEQPACKET` sockets. This means that the protocol is ABI/architecture specific:
  46  *  we currently can't model-check a x86 process from a x86_64 process.
  47  *
  48  *  Moreover the protocol is not stable. The same version of the library should be used
  49  *  for the client and the server.
  50  */
  51
  52 /* Basic structure: all message start with a message type */
  53 struct s_mc_message_t {
  54   simgrid::mc::MessageType type;
  55 };
  56
  57 struct s_mc_message_int_t {
  58   simgrid::mc::MessageType type;
  59   uint64_t value;
  60 };
  61
  62 /* Client->Server */
  63 struct s_mc_message_initial_addresses_t {
  64   simgrid::mc::MessageType type;
  65   xbt_mheap_t mmalloc_default_mdp;
  66   unsigned long* maxpid;
  67   xbt_dynar_t actors;
  68   xbt_dynar_t dead_actors;
  69 };
  70
  71 struct s_mc_message_ignore_heap_t {
  72   simgrid::mc::MessageType type;
  73   int block;
  74   int fragment;
  75   void* address;
  76   size_t size;
  77 };
  78
  79 struct s_mc_message_ignore_memory_t {
  80   simgrid::mc::MessageType type;
  81   uint64_t addr;
  82   size_t size;
  83 };
  84
  85 struct s_mc_message_stack_region_t {
  86   simgrid::mc::MessageType type;
  87   s_stack_region_t stack_region;
  88 };
  89
  90 struct s_mc_message_register_symbol_t {
  91   simgrid::mc::MessageType type;
  92   std::array<char, 128> name;
  93   int (*callback)(void*);
  94   void* data;
  95 };
  96
  97 /* Server -> client */
  98 struct s_mc_message_simcall_execute_t {
  99   simgrid::mc::MessageType type;
 100   aid_t aid_;
 101   int times_considered_;
 102 };
 103 struct s_mc_message_simcall_execute_answer_t {
 104   simgrid::mc::MessageType type;
 105   simgrid::kernel::actor::SimcallObserver* observer;
 106 };
 107
 108 struct s_mc_message_restore_t {
 109   simgrid::mc::MessageType type;
 110   int index;
 111 };
 112
 113 struct s_mc_message_actor_enabled_t {
 114   simgrid::mc::MessageType type;
 115   aid_t aid; // actor ID
 116 };
 117
 118 /* RPC */
 119 struct s_mc_message_simcall_is_visible_t { // MessageType::SIMCALL_IS_VISIBLE
 120   simgrid::mc::MessageType type;
 121   aid_t aid;
 122 };
 123 struct s_mc_message_simcall_is_visible_answer_t { // MessageType::SIMCALL_IS_VISIBLE_ANSWER
 124   simgrid::mc::MessageType type;
 125   bool value;
 126 };
 127
 128 struct s_mc_message_simcall_to_string_t { // MessageType::SIMCALL_TO_STRING or MessageType::SIMCALL_DOT_LABEL
 129   simgrid::mc::MessageType type;
 130   aid_t aid;
 131   int time_considered;
 132 };
 133 struct s_mc_message_simcall_to_string_answer_t { // MessageType::SIMCALL_TO_STRING_ANSWER
 134   simgrid::mc::MessageType type;
 135   char value[1024];
 136 };
 137
 138 struct s_mc_message_simcalls_dependent_t { // MessageType::SIMCALLS_DEPENDENT
 139   simgrid::mc::MessageType type;
 140   simgrid::kernel::actor::SimcallObserver* obs1;
 141   simgrid::kernel::actor::SimcallObserver* obs2;
 142 };
 143 struct s_mc_message_simcalls_dependent_answer_t { // MessageType::SIMCALLS_DEPENDENT_ANSWER
 144   simgrid::mc::MessageType type;
 145   bool value;
 146 };
 147
 148 #endif // __cplusplus
 149 #endif