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