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