src/mc/remote/mc_protocol.h

   1 /* Copyright (c) 2015-2023. 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 #ifdef __cplusplus
  12
  13 #include "src/kernel/actor/SimcallObserver.hpp"
  14
  15 #include "simgrid/forward.h" // aid_t
  16 #include "src/mc/datatypes.h"
  17 #include "src/xbt/mmalloc/mmalloc.h"
  18 #include <xbt/utility.hpp>
  19
  20 #include <array>
  21 #include <cstdint>
  22
  23 // ***** Messages
  24 namespace simgrid::mc {
  25
  26 XBT_DECLARE_ENUM_CLASS(MessageType, NONE, INITIAL_ADDRESSES, INITIAL_ADDRESSES_REPLY, CONTINUE, IGNORE_HEAP,
  27                        UNIGNORE_HEAP, IGNORE_MEMORY, STACK_REGION, REGISTER_SYMBOL, DEADLOCK_CHECK,
  28                        DEADLOCK_CHECK_REPLY, WAITING, SIMCALL_EXECUTE, SIMCALL_EXECUTE_ANSWER, ASSERTION_FAILED,
  29                        ACTORS_STATUS, ACTORS_STATUS_REPLY, ACTORS_MAXPID, ACTORS_MAXPID_REPLY, FINALIZE,
  30                        FINALIZE_REPLY);
  31 } // namespace simgrid::mc
  32
  33 constexpr unsigned MC_MESSAGE_LENGTH                 = 512;
  34 constexpr unsigned SIMCALL_SERIALIZATION_BUFFER_SIZE = 2048;
  35
  36 /** Basic structure for a MC message
  37  *
  38  *  The current version of the client/server protocol sends C structures over `AF_LOCAL`
  39  *  `SOCK_SEQPACKET` sockets. This means that the protocol is ABI/architecture specific:
  40  *  we currently can't model-check a x86 process from a x86_64 process.
  41  *
  42  *  Moreover the protocol is not stable. The same version of the library should be used
  43  *  for the client and the server.
  44  */
  45
  46 /* Basic structure: all message start with a message type */
  47 struct s_mc_message_t {
  48   simgrid::mc::MessageType type;
  49 };
  50
  51 struct s_mc_message_int_t {
  52   simgrid::mc::MessageType type;
  53   uint64_t value;
  54 };
  55
  56 /* Client->Server */
  57 struct s_mc_message_ignore_heap_t {
  58   simgrid::mc::MessageType type;
  59   int block;
  60   int fragment;
  61   void* address;
  62   size_t size;
  63 };
  64
  65 struct s_mc_message_ignore_memory_t {
  66   simgrid::mc::MessageType type;
  67   uint64_t addr;
  68   size_t size;
  69 };
  70
  71 struct s_mc_message_stack_region_t {
  72   simgrid::mc::MessageType type;
  73   s_stack_region_t stack_region;
  74 };
  75
  76 struct s_mc_message_register_symbol_t {
  77   simgrid::mc::MessageType type;
  78   std::array<char, 128> name;
  79   int (*callback)(void*);
  80   void* data;
  81 };
  82
  83 /* Server -> client */
  84 struct s_mc_message_initial_addresses_reply_t {
  85   simgrid::mc::MessageType type;
  86   xbt_mheap_t mmalloc_default_mdp;
  87 };
  88
  89 struct s_mc_message_simcall_execute_t {
  90   simgrid::mc::MessageType type;
  91   aid_t aid_;
  92   int times_considered_;
  93 };
  94 struct s_mc_message_simcall_execute_answer_t {
  95   simgrid::mc::MessageType type;
  96   std::array<char, SIMCALL_SERIALIZATION_BUFFER_SIZE> buffer;
  97 };
  98
  99 struct s_mc_message_restore_t {
 100   simgrid::mc::MessageType type;
 101   int index;
 102 };
 103
 104 struct s_mc_message_actors_status_answer_t {
 105   simgrid::mc::MessageType type;
 106   int count;
 107 };
 108 struct s_mc_message_actors_status_one_t { // an array of `s_mc_message_actors_status_one_t[count]` is sent right after
 109                                           // after a `s_mc_message_actors_status_answer_t`
 110   aid_t aid;
 111   bool enabled;
 112   int max_considered;
 113
 114   // The total number of transitions that are serialized and associated with this actor.
 115   // Enforced to be either `0` or the same as `max_considered`
 116   int n_transitions;
 117 };
 118
 119 // Answer from an actor to the question "what are you about to run?"
 120 struct s_mc_message_simcall_probe_one_t { // a series of `s_mc_message_simcall_probe_one_t`
 121                                           // is sent right after `s_mc_message_actors_status_one_t[]`
 122   std::array<char, SIMCALL_SERIALIZATION_BUFFER_SIZE> buffer;
 123 };
 124
 125 #endif // __cplusplus
 126 #endif