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 <xbt/utility.hpp>
  18
  19 #include <array>
  20 #include <cstdint>
  21 #include <sys/un.h>
  22
  23 // ***** Messages
  24 namespace simgrid::mc {
  25
  26 XBT_DECLARE_ENUM_CLASS(MessageType, NONE, FORK, FORK_REPLY, WAIT_CHILD, WAIT_CHILD_REPLY, CONTINUE, DEADLOCK_CHECK,
  27                        DEADLOCK_CHECK_REPLY, WAITING, SIMCALL_EXECUTE, SIMCALL_EXECUTE_REPLY, ASSERTION_FAILED,
  28                        ACTORS_STATUS, ACTORS_STATUS_REPLY_COUNT, ACTORS_STATUS_REPLY_SIMCALL,
  29                        ACTORS_STATUS_REPLY_TRANSITION, ACTORS_MAXPID, ACTORS_MAXPID_REPLY, FINALIZE, FINALIZE_REPLY);
  30 } // namespace simgrid::mc
  31
  32 constexpr unsigned MC_MESSAGE_LENGTH                 = 512;
  33 constexpr unsigned MC_SOCKET_NAME_LEN                = sizeof(sockaddr_un::sun_path);
  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_UNIX`
  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
  58 /* Server -> client */
  59 struct s_mc_message_fork_t {
  60   simgrid::mc::MessageType type;
  61   std::array<char, MC_SOCKET_NAME_LEN> socket_name;
  62 };
  63
  64 struct s_mc_message_simcall_execute_t {
  65   simgrid::mc::MessageType type;
  66   aid_t aid_;
  67   int times_considered_;
  68 };
  69 struct s_mc_message_simcall_execute_answer_t {
  70   simgrid::mc::MessageType type;
  71   std::array<char, SIMCALL_SERIALIZATION_BUFFER_SIZE> buffer;
  72 };
  73
  74 struct s_mc_message_restore_t {
  75   simgrid::mc::MessageType type;
  76   int index;
  77 };
  78
  79 struct s_mc_message_actors_status_answer_t {
  80   simgrid::mc::MessageType type;
  81   int count;
  82 };
  83 struct s_mc_message_actors_status_one_t { // an array of `s_mc_message_actors_status_one_t[count]` is sent right after
  84                                           // after a `s_mc_message_actors_status_answer_t`
  85   simgrid::mc::MessageType type;
  86   aid_t aid;
  87   bool enabled;
  88   int max_considered;
  89 };
  90
  91 // Answer from an actor to the question "what are you about to run?"
  92 struct s_mc_message_simcall_probe_one_t { // a series of `s_mc_message_simcall_probe_one_t`
  93                                           // is sent right after `s_mc_message_actors_status_one_t[]`
  94   simgrid::mc::MessageType type;
  95   std::array<char, SIMCALL_SERIALIZATION_BUFFER_SIZE> buffer;
  96 };
  97
  98 #endif // __cplusplus
  99 #endif