1 /* Copyright (c) 2015-2021. 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
23 #include <xbt/utility.hpp>
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);
34 } // namespace simgrid
36 constexpr unsigned MC_MESSAGE_LENGTH = 512;
38 /** Basic structure for a MC message
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.
44 * Moreover the protocol is not stable. The same version of the library should be used
45 * for the client and the server.
48 /* Basic structure: all message start with a message type */
49 struct s_mc_message_t {
50 simgrid::mc::MessageType type;
53 struct s_mc_message_int_t {
54 simgrid::mc::MessageType type;
59 struct s_mc_message_ignore_heap_t {
60 simgrid::mc::MessageType type;
67 struct s_mc_message_ignore_memory_t {
68 simgrid::mc::MessageType type;
73 struct s_mc_message_stack_region_t {
74 simgrid::mc::MessageType type;
75 s_stack_region_t stack_region;
78 struct s_mc_message_register_symbol_t {
79 simgrid::mc::MessageType type;
80 std::array<char, 128> name;
81 int (*callback)(void*);
85 /* Server -> client */
86 struct s_mc_message_simcall_handle_t {
87 simgrid::mc::MessageType type;
92 struct s_mc_message_restore_t {
93 simgrid::mc::MessageType type;
97 struct s_mc_message_actor_enabled_t {
98 simgrid::mc::MessageType type;
99 aid_t aid; // actor ID
102 #endif // __cplusplus