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