1 /* Copyright (c) 2015-2023. 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
13 #include "src/kernel/actor/SimcallObserver.hpp"
15 #include "simgrid/forward.h" // aid_t
16 #include "src/mc/datatypes.h"
17 #include "src/xbt/mmalloc/mmalloc.h"
18 #include <xbt/utility.hpp>
24 namespace simgrid::mc {
26 XBT_DECLARE_ENUM_CLASS(MessageType, NONE, NEED_MEMINFO, NEED_MEMINFO_REPLY, FORK, FORK_REPLY, WAIT_CHILD,
27 WAIT_CHILD_REPLY, CONTINUE, IGNORE_HEAP, UNIGNORE_HEAP, IGNORE_MEMORY, STACK_REGION,
28 REGISTER_SYMBOL, DEADLOCK_CHECK, DEADLOCK_CHECK_REPLY, WAITING, SIMCALL_EXECUTE,
29 SIMCALL_EXECUTE_REPLY, ASSERTION_FAILED, ACTORS_STATUS, ACTORS_STATUS_REPLY_COUNT,
30 ACTORS_STATUS_REPLY_SIMCALL, ACTORS_STATUS_REPLY_TRANSITION, ACTORS_MAXPID, ACTORS_MAXPID_REPLY,
31 FINALIZE, FINALIZE_REPLY);
32 } // namespace simgrid::mc
34 constexpr unsigned MC_MESSAGE_LENGTH = 512;
35 constexpr unsigned SIMCALL_SERIALIZATION_BUFFER_SIZE = 2048;
37 /** Basic structure for a MC message
39 * The current version of the client/server protocol sends C structures over `AF_LOCAL`
40 * `SOCK_SEQPACKET` sockets. This means that the protocol is ABI/architecture specific:
41 * we currently can't model-check a x86 process from a x86_64 process.
43 * Moreover the protocol is not stable. The same version of the library should be used
44 * for the client and the server.
47 /* Basic structure: all message start with a message type */
48 struct s_mc_message_t {
49 simgrid::mc::MessageType type;
52 struct s_mc_message_int_t {
53 simgrid::mc::MessageType type;
58 struct s_mc_message_ignore_heap_t {
59 simgrid::mc::MessageType type;
66 struct s_mc_message_ignore_memory_t {
67 simgrid::mc::MessageType type;
72 struct s_mc_message_stack_region_t {
73 simgrid::mc::MessageType type;
74 s_stack_region_t stack_region;
77 struct s_mc_message_register_symbol_t {
78 simgrid::mc::MessageType type;
79 std::array<char, 128> name;
80 int (*callback)(void*);
84 /* Server -> client */
85 struct s_mc_message_need_meminfo_reply_t {
86 simgrid::mc::MessageType type;
87 xbt_mheap_t mmalloc_default_mdp;
90 struct s_mc_message_simcall_execute_t {
91 simgrid::mc::MessageType type;
93 int times_considered_;
95 struct s_mc_message_simcall_execute_answer_t {
96 simgrid::mc::MessageType type;
97 std::array<char, SIMCALL_SERIALIZATION_BUFFER_SIZE> buffer;
100 struct s_mc_message_restore_t {
101 simgrid::mc::MessageType type;
105 struct s_mc_message_actors_status_answer_t {
106 simgrid::mc::MessageType type;
109 struct s_mc_message_actors_status_one_t { // an array of `s_mc_message_actors_status_one_t[count]` is sent right after
110 // after a `s_mc_message_actors_status_answer_t`
111 simgrid::mc::MessageType type;
117 // Answer from an actor to the question "what are you about to run?"
118 struct s_mc_message_simcall_probe_one_t { // a series of `s_mc_message_simcall_probe_one_t`
119 // is sent right after `s_mc_message_actors_status_one_t[]`
120 simgrid::mc::MessageType type;
121 std::array<char, SIMCALL_SERIALIZATION_BUFFER_SIZE> buffer;
124 #endif // __cplusplus