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"
20 #include "mc/datatypes.h"
21 #include "simgrid/forward.h" // aid_t
27 enum class MessageType {
45 } // namespace simgrid
47 #define MC_MESSAGE_LENGTH 512
49 /** Basic structure for a MC message
51 * The current version of the client/server protocol sends C structures over `AF_LOCAL`
52 * `SOCK_SEQPACKET` sockets. This means that the protocol is ABI/architecture specific:
53 * we currently can't model-check a x86 process from a x86_64 process.
55 * Moreover the protocol is not stable. The same version of the library should be used
56 * for the client and the server.
59 /* Basic structure: all message start with a message type */
60 struct s_mc_message_t {
61 simgrid::mc::MessageType type;
64 struct s_mc_message_int_t {
65 simgrid::mc::MessageType type;
70 struct s_mc_message_ignore_heap_t {
71 simgrid::mc::MessageType type;
78 struct s_mc_message_ignore_memory_t {
79 simgrid::mc::MessageType type;
84 struct s_mc_message_stack_region_t {
85 simgrid::mc::MessageType type;
86 s_stack_region_t stack_region;
89 struct s_mc_message_register_symbol_t {
90 simgrid::mc::MessageType type;
92 int (*callback)(void*);
96 /* Server -> client */
97 struct s_mc_message_simcall_handle_t {
98 simgrid::mc::MessageType type;
103 struct s_mc_message_restore_t {
104 simgrid::mc::MessageType type;
108 struct s_mc_message_actor_enabled_t {
109 simgrid::mc::MessageType type;
110 aid_t aid; // actor ID
113 XBT_PRIVATE const char* MC_message_type_name(simgrid::mc::MessageType type);
115 #endif // __cplusplus