1 /* Copyright (c) 2015-2020. The SimGrid Team. All rights reserved. */
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. */
6 #ifndef SIMGRID_MC_PROTOCOL_H
7 #define SIMGRID_MC_PROTOCOL_H
9 // ***** Environment variables for passing context to the model-checked process
11 /** Environment variable name used to pass the communication socket.
13 * It is set by `simgrid-mc` to enable MC support in the children processes
15 #define MC_ENV_SOCKET_FD "SIMGRID_MC_SOCKET_FD"
19 #include "mc/datatypes.h"
20 #include "simgrid/forward.h" // aid_t
28 enum class MessageType {
46 } // namespace simgrid
48 constexpr unsigned MC_MESSAGE_LENGTH = 512;
50 /** Basic structure for a MC message
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.
56 * Moreover the protocol is not stable. The same version of the library should be used
57 * for the client and the server.
60 /* Basic structure: all message start with a message type */
61 struct s_mc_message_t {
62 simgrid::mc::MessageType type;
65 struct s_mc_message_int_t {
66 simgrid::mc::MessageType type;
71 struct s_mc_message_ignore_heap_t {
72 simgrid::mc::MessageType type;
79 struct s_mc_message_ignore_memory_t {
80 simgrid::mc::MessageType type;
85 struct s_mc_message_stack_region_t {
86 simgrid::mc::MessageType type;
87 s_stack_region_t stack_region;
90 struct s_mc_message_register_symbol_t {
91 simgrid::mc::MessageType type;
92 std::array<char, 128> name;
93 int (*callback)(void*);
97 /* Server -> client */
98 struct s_mc_message_simcall_handle_t {
99 simgrid::mc::MessageType type;
104 struct s_mc_message_restore_t {
105 simgrid::mc::MessageType type;
109 struct s_mc_message_actor_enabled_t {
110 simgrid::mc::MessageType type;
111 aid_t aid; // actor ID
114 XBT_PRIVATE const char* MC_message_type_name(simgrid::mc::MessageType type);
116 #endif // __cplusplus