src/mc/remote/mc_protocol.h

   1 /* Copyright (c) 2015-2022. 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 /** Environment variable name used to pass the communication socket.
  12  *
  13  * It is set by `simgrid-mc` to enable MC support in the children processes
  14  */
  15 #define MC_ENV_SOCKET_FD "SIMGRID_MC_SOCKET_FD"
  16
  17 #ifdef __cplusplus
  18
  19 #include "src/kernel/actor/SimcallObserver.hpp"
  20
  21 #include "mc/datatypes.h"
  22 #include "simgrid/forward.h" // aid_t
  23 #include <array>
  24 #include <cstdint>
  25 #include <xbt/dynar.h>
  26 #include <xbt/mmalloc.h>
  27 #include <xbt/utility.hpp>
  28
  29 // ***** Messages
  30 namespace simgrid {
  31 namespace mc {
  32
  33 XBT_DECLARE_ENUM_CLASS(MessageType, NONE, INITIAL_ADDRESSES, CONTINUE, IGNORE_HEAP, UNIGNORE_HEAP, IGNORE_MEMORY,
  34                        STACK_REGION, REGISTER_SYMBOL, DEADLOCK_CHECK, DEADLOCK_CHECK_REPLY, WAITING, SIMCALL_EXECUTE,
  35                        SIMCALL_EXECUTE_ANSWER, SIMCALL_IS_VISIBLE, SIMCALL_IS_VISIBLE_ANSWER, ASSERTION_FAILED,
  36                        ACTOR_ENABLED, ACTOR_ENABLED_REPLY, FINALIZE);
  37
  38 } // namespace mc
  39 } // namespace simgrid
  40
  41 constexpr unsigned MC_MESSAGE_LENGTH = 512;
  42 constexpr unsigned SIMCALL_SERIALIZATION_BUFFER_SIZE = 2048;
  43
  44 /** Basic structure for a MC message
  45  *
  46  *  The current version of the client/server protocol sends C structures over `AF_LOCAL`
  47  *  `SOCK_SEQPACKET` sockets. This means that the protocol is ABI/architecture specific:
  48  *  we currently can't model-check a x86 process from a x86_64 process.
  49  *
  50  *  Moreover the protocol is not stable. The same version of the library should be used
  51  *  for the client and the server.
  52  */
  53
  54 /* Basic structure: all message start with a message type */
  55 struct s_mc_message_t {
  56   simgrid::mc::MessageType type;
  57 };
  58
  59 struct s_mc_message_int_t {
  60   simgrid::mc::MessageType type;
  61   uint64_t value;
  62 };
  63
  64 /* Client->Server */
  65 struct s_mc_message_initial_addresses_t {
  66   simgrid::mc::MessageType type;
  67   xbt_mheap_t mmalloc_default_mdp;
  68   unsigned long* maxpid;
  69   xbt_dynar_t actors;
  70   xbt_dynar_t dead_actors;
  71 };
  72
  73 struct s_mc_message_ignore_heap_t {
  74   simgrid::mc::MessageType type;
  75   int block;
  76   int fragment;
  77   void* address;
  78   size_t size;
  79 };
  80
  81 struct s_mc_message_ignore_memory_t {
  82   simgrid::mc::MessageType type;
  83   uint64_t addr;
  84   size_t size;
  85 };
  86
  87 struct s_mc_message_stack_region_t {
  88   simgrid::mc::MessageType type;
  89   s_stack_region_t stack_region;
  90 };
  91
  92 struct s_mc_message_register_symbol_t {
  93   simgrid::mc::MessageType type;
  94   std::array<char, 128> name;
  95   int (*callback)(void*);
  96   void* data;
  97 };
  98
  99 /* Server -> client */
 100 struct s_mc_message_simcall_execute_t {
 101   simgrid::mc::MessageType type;
 102   aid_t aid_;
 103   int times_considered_;
 104 };
 105 struct s_mc_message_simcall_execute_answer_t {
 106   simgrid::mc::MessageType type;
 107   std::array<char, SIMCALL_SERIALIZATION_BUFFER_SIZE> buffer;
 108 };
 109
 110 struct s_mc_message_restore_t {
 111   simgrid::mc::MessageType type;
 112   int index;
 113 };
 114
 115 struct s_mc_message_actor_enabled_t {
 116   simgrid::mc::MessageType type;
 117   aid_t aid; // actor ID
 118 };
 119
 120 /* RPC */
 121 struct s_mc_message_simcall_is_visible_t { // MessageType::SIMCALL_IS_VISIBLE
 122   simgrid::mc::MessageType type;
 123   aid_t aid;
 124 };
 125 struct s_mc_message_simcall_is_visible_answer_t { // MessageType::SIMCALL_IS_VISIBLE_ANSWER
 126   simgrid::mc::MessageType type;
 127   bool value;
 128 };
 129
 130 #endif // __cplusplus
 131 #endif