src/mc/remote/mc_protocol.h

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