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