src/mc/remote/mc_protocol.h

   1 /* Copyright (c) 2015-2021. 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 "mc/datatypes.h"
  20 #include "simgrid/forward.h" // aid_t
  21 #include <array>
  22 #include <cstdint>
  23 #include <xbt/utility.hpp>
  24
  25 // ***** Messages
  26 namespace simgrid {
  27 namespace mc {
  28
  29 XBT_DECLARE_ENUM_CLASS(MessageType, NONE, CONTINUE, IGNORE_HEAP, UNIGNORE_HEAP, IGNORE_MEMORY, STACK_REGION,
  30                        REGISTER_SYMBOL, DEADLOCK_CHECK, DEADLOCK_CHECK_REPLY, WAITING, SIMCALL_HANDLE, ASSERTION_FAILED,
  31                        ACTOR_ENABLED, ACTOR_ENABLED_REPLY);
  32
  33 } // namespace mc
  34 } // namespace simgrid
  35
  36 constexpr unsigned MC_MESSAGE_LENGTH = 512;
  37
  38 /** Basic structure for a MC message
  39  *
  40  *  The current version of the client/server protocol sends C structures over `AF_LOCAL`
  41  *  `SOCK_SEQPACKET` sockets. This means that the protocol is ABI/architecture specific:
  42  *  we currently can't model-check a x86 process from a x86_64 process.
  43  *
  44  *  Moreover the protocol is not stable. The same version of the library should be used
  45  *  for the client and the server.
  46  */
  47
  48 /* Basic structure: all message start with a message type */
  49 struct s_mc_message_t {
  50   simgrid::mc::MessageType type;
  51 };
  52
  53 struct s_mc_message_int_t {
  54   simgrid::mc::MessageType type;
  55   uint64_t value;
  56 };
  57
  58 /* Client->Server */
  59 struct s_mc_message_ignore_heap_t {
  60   simgrid::mc::MessageType type;
  61   int block;
  62   int fragment;
  63   void* address;
  64   size_t size;
  65 };
  66
  67 struct s_mc_message_ignore_memory_t {
  68   simgrid::mc::MessageType type;
  69   uint64_t addr;
  70   size_t size;
  71 };
  72
  73 struct s_mc_message_stack_region_t {
  74   simgrid::mc::MessageType type;
  75   s_stack_region_t stack_region;
  76 };
  77
  78 struct s_mc_message_register_symbol_t {
  79   simgrid::mc::MessageType type;
  80   std::array<char, 128> name;
  81   int (*callback)(void*);
  82   void* data;
  83 };
  84
  85 /* Server -> client */
  86 struct s_mc_message_simcall_handle_t {
  87   simgrid::mc::MessageType type;
  88   unsigned long pid;
  89   int value;
  90 };
  91
  92 struct s_mc_message_restore_t {
  93   simgrid::mc::MessageType type;
  94   int index;
  95 };
  96
  97 struct s_mc_message_actor_enabled_t {
  98   simgrid::mc::MessageType type;
  99   aid_t aid; // actor ID
 100 };
 101
 102 #endif // __cplusplus
 103 #endif