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