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 #include <sys/un.h>
  23
  24 // ***** Messages
  25 namespace simgrid::mc {
  26
  27 XBT_DECLARE_ENUM_CLASS(MessageType, NONE, NEED_MEMINFO, NEED_MEMINFO_REPLY, FORK, FORK_REPLY, WAIT_CHILD,
  28                        WAIT_CHILD_REPLY, CONTINUE, IGNORE_HEAP, UNIGNORE_HEAP, IGNORE_MEMORY, UNIGNORE_MEMORY,
  29                        STACK_REGION, REGISTER_SYMBOL, DEADLOCK_CHECK, DEADLOCK_CHECK_REPLY, WAITING, SIMCALL_EXECUTE,
  30                        SIMCALL_EXECUTE_REPLY, ASSERTION_FAILED, ACTORS_STATUS, ACTORS_STATUS_REPLY_COUNT,
  31                        ACTORS_STATUS_REPLY_SIMCALL, ACTORS_STATUS_REPLY_TRANSITION, ACTORS_MAXPID, ACTORS_MAXPID_REPLY,
  32                        FINALIZE, FINALIZE_REPLY);
  33 } // namespace simgrid::mc
  34
  35 constexpr unsigned MC_MESSAGE_LENGTH                 = 512;
  36 constexpr unsigned MC_SOCKET_NAME_LEN                = sizeof(sockaddr_un::sun_path);
  37 constexpr unsigned SIMCALL_SERIALIZATION_BUFFER_SIZE = 2048;
  38
  39 /** Basic structure for a MC message
  40  *
  41  *  The current version of the client/server protocol sends C structures over `AF_UNIX`
  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_need_meminfo_reply_t {
  88   simgrid::mc::MessageType type;
  89   xbt_mheap_t mmalloc_default_mdp;
  90 };
  91
  92 struct s_mc_message_fork_t {
  93   simgrid::mc::MessageType type;
  94   std::array<char, MC_SOCKET_NAME_LEN> socket_name;
  95 };
  96
  97 struct s_mc_message_simcall_execute_t {
  98   simgrid::mc::MessageType type;
  99   aid_t aid_;
 100   int times_considered_;
 101 };
 102 struct s_mc_message_simcall_execute_answer_t {
 103   simgrid::mc::MessageType type;
 104   std::array<char, SIMCALL_SERIALIZATION_BUFFER_SIZE> buffer;
 105 };
 106
 107 struct s_mc_message_restore_t {
 108   simgrid::mc::MessageType type;
 109   int index;
 110 };
 111
 112 struct s_mc_message_actors_status_answer_t {
 113   simgrid::mc::MessageType type;
 114   int count;
 115 };
 116 struct s_mc_message_actors_status_one_t { // an array of `s_mc_message_actors_status_one_t[count]` is sent right after
 117                                           // after a `s_mc_message_actors_status_answer_t`
 118   simgrid::mc::MessageType type;
 119   aid_t aid;
 120   bool enabled;
 121   int max_considered;
 122 };
 123
 124 // Answer from an actor to the question "what are you about to run?"
 125 struct s_mc_message_simcall_probe_one_t { // a series of `s_mc_message_simcall_probe_one_t`
 126                                           // is sent right after `s_mc_message_actors_status_one_t[]`
 127   simgrid::mc::MessageType type;
 128   std::array<char, SIMCALL_SERIALIZATION_BUFFER_SIZE> buffer;
 129 };
 130
 131 #endif // __cplusplus
 132 #endif