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