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