1 /* Copyright (c) 2015-2022. 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 "src/kernel/actor/SimcallObserver.hpp"
21 #include "mc/datatypes.h"
22 #include "simgrid/forward.h" // aid_t
25 #include <xbt/dynar.h>
26 #include <xbt/mmalloc.h>
27 #include <xbt/utility.hpp>
33 XBT_DECLARE_ENUM_CLASS(MessageType, NONE, INITIAL_ADDRESSES, CONTINUE, IGNORE_HEAP, UNIGNORE_HEAP, IGNORE_MEMORY,
34 STACK_REGION, REGISTER_SYMBOL, DEADLOCK_CHECK, DEADLOCK_CHECK_REPLY, WAITING, SIMCALL_EXECUTE,
35 SIMCALL_EXECUTE_ANSWER, SIMCALL_IS_VISIBLE, SIMCALL_IS_VISIBLE_ANSWER, SIMCALL_DOT_LABEL,
36 SIMCALL_DOT_LABEL_ANSWER, ASSERTION_FAILED, ACTOR_ENABLED, ACTOR_ENABLED_REPLY, FINALIZE);
39 } // namespace simgrid
41 constexpr unsigned MC_MESSAGE_LENGTH = 512;
43 /** Basic structure for a MC message
45 * The current version of the client/server protocol sends C structures over `AF_LOCAL`
46 * `SOCK_SEQPACKET` sockets. This means that the protocol is ABI/architecture specific:
47 * we currently can't model-check a x86 process from a x86_64 process.
49 * Moreover the protocol is not stable. The same version of the library should be used
50 * for the client and the server.
53 /* Basic structure: all message start with a message type */
54 struct s_mc_message_t {
55 simgrid::mc::MessageType type;
58 struct s_mc_message_int_t {
59 simgrid::mc::MessageType type;
64 struct s_mc_message_initial_addresses_t {
65 simgrid::mc::MessageType type;
66 xbt_mheap_t mmalloc_default_mdp;
67 unsigned long* maxpid;
69 xbt_dynar_t dead_actors;
72 struct s_mc_message_ignore_heap_t {
73 simgrid::mc::MessageType type;
80 struct s_mc_message_ignore_memory_t {
81 simgrid::mc::MessageType type;
86 struct s_mc_message_stack_region_t {
87 simgrid::mc::MessageType type;
88 s_stack_region_t stack_region;
91 struct s_mc_message_register_symbol_t {
92 simgrid::mc::MessageType type;
93 std::array<char, 128> name;
94 int (*callback)(void*);
98 /* Server -> client */
99 struct s_mc_message_simcall_execute_t {
100 simgrid::mc::MessageType type;
102 int times_considered_;
104 struct s_mc_message_simcall_execute_answer_t {
105 simgrid::mc::MessageType type;
106 simgrid::kernel::actor::SimcallObserver::Simcall simcall;
110 struct s_mc_message_restore_t {
111 simgrid::mc::MessageType type;
115 struct s_mc_message_actor_enabled_t {
116 simgrid::mc::MessageType type;
117 aid_t aid; // actor ID
121 struct s_mc_message_simcall_is_visible_t { // MessageType::SIMCALL_IS_VISIBLE
122 simgrid::mc::MessageType type;
125 struct s_mc_message_simcall_is_visible_answer_t { // MessageType::SIMCALL_IS_VISIBLE_ANSWER
126 simgrid::mc::MessageType type;
130 struct s_mc_message_simcall_to_string_t { // MessageType::SIMCALL_DOT_LABEL
131 simgrid::mc::MessageType type;
135 struct s_mc_message_simcall_to_string_answer_t { // MessageType::SIMCALL_DOT_LABEL_ANSWER
136 simgrid::mc::MessageType type;
140 #endif // __cplusplus