src/mc/remote/mc_protocol.h

   1 /* Copyright (c) 2015-2020. 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
  24 // ***** Messages
  25 namespace simgrid {
  26 namespace mc {
  27
  28 enum class MessageType {
  29   NONE,
  30   CONTINUE,
  31   IGNORE_HEAP,
  32   UNIGNORE_HEAP,
  33   IGNORE_MEMORY,
  34   STACK_REGION,
  35   REGISTER_SYMBOL,
  36   DEADLOCK_CHECK,
  37   DEADLOCK_CHECK_REPLY,
  38   WAITING,
  39   SIMCALL_HANDLE,
  40   ASSERTION_FAILED,
  41   ACTOR_ENABLED,
  42   ACTOR_ENABLED_REPLY
  43 };
  44
  45 } // namespace mc
  46 } // namespace simgrid
  47
  48 constexpr unsigned MC_MESSAGE_LENGTH = 512;
  49
  50 /** Basic structure for a MC message
  51  *
  52  *  The current version of the client/server protocol sends C structures over `AF_LOCAL`
  53  *  `SOCK_SEQPACKET` sockets. This means that the protocol is ABI/architecture specific:
  54  *  we currently can't model-check a x86 process from a x86_64 process.
  55  *
  56  *  Moreover the protocol is not stable. The same version of the library should be used
  57  *  for the client and the server.
  58  */
  59
  60 /* Basic structure: all message start with a message type */
  61 struct s_mc_message_t {
  62   simgrid::mc::MessageType type;
  63 };
  64
  65 struct s_mc_message_int_t {
  66   simgrid::mc::MessageType type;
  67   uint64_t value;
  68 };
  69
  70 /* Client->Server */
  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_handle_t {
  99   simgrid::mc::MessageType type;
 100   unsigned long pid;
 101   int value;
 102 };
 103
 104 struct s_mc_message_restore_t {
 105   simgrid::mc::MessageType type;
 106   int index;
 107 };
 108
 109 struct s_mc_message_actor_enabled_t {
 110   simgrid::mc::MessageType type;
 111   aid_t aid; // actor ID
 112 };
 113
 114 XBT_PRIVATE const char* MC_message_type_name(simgrid::mc::MessageType type);
 115
 116 #endif // __cplusplus
 117 #endif