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, INITIAL_ADDRESSES, CONTINUE, IGNORE_HEAP, UNIGNORE_HEAP, IGNORE_MEMORY,
27 STACK_REGION, REGISTER_SYMBOL, DEADLOCK_CHECK, DEADLOCK_CHECK_REPLY, WAITING, SIMCALL_EXECUTE,
28 SIMCALL_EXECUTE_ANSWER, ASSERTION_FAILED, ACTORS_STATUS, ACTORS_STATUS_REPLY, FINALIZE,
30 } // namespace simgrid::mc
32 constexpr unsigned MC_MESSAGE_LENGTH = 512;
33 constexpr unsigned SIMCALL_SERIALIZATION_BUFFER_SIZE = 2048;
35 /** Basic structure for a MC message
37 * The current version of the client/server protocol sends C structures over `AF_LOCAL`
38 * `SOCK_SEQPACKET` sockets. This means that the protocol is ABI/architecture specific:
39 * we currently can't model-check a x86 process from a x86_64 process.
41 * Moreover the protocol is not stable. The same version of the library should be used
42 * for the client and the server.
45 /* Basic structure: all message start with a message type */
46 struct s_mc_message_t {
47 simgrid::mc::MessageType type;
50 struct s_mc_message_int_t {
51 simgrid::mc::MessageType type;
56 struct s_mc_message_initial_addresses_t {
57 simgrid::mc::MessageType type;
58 xbt_mheap_t mmalloc_default_mdp;
59 unsigned long* maxpid;
62 struct s_mc_message_ignore_heap_t {
63 simgrid::mc::MessageType type;
70 struct s_mc_message_ignore_memory_t {
71 simgrid::mc::MessageType type;
76 struct s_mc_message_stack_region_t {
77 simgrid::mc::MessageType type;
78 s_stack_region_t stack_region;
81 struct s_mc_message_register_symbol_t {
82 simgrid::mc::MessageType type;
83 std::array<char, 128> name;
84 int (*callback)(void*);
88 /* Server -> client */
89 struct s_mc_message_simcall_execute_t {
90 simgrid::mc::MessageType type;
92 int times_considered_;
94 struct s_mc_message_simcall_execute_answer_t {
95 simgrid::mc::MessageType type;
96 std::array<char, SIMCALL_SERIALIZATION_BUFFER_SIZE> buffer;
99 struct s_mc_message_restore_t {
100 simgrid::mc::MessageType type;
104 struct s_mc_message_actors_status_answer_t {
105 simgrid::mc::MessageType type;
107 int transition_count; // The total number of transitions sent as a payload to the checker
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`
115 // The total number of transitions that are serialized and associated with this actor.
116 // Enforced to be either `0` or the same as `max_considered`
120 // Answer from an actor to the question "what are you about to run?"
121 struct s_mc_message_simcall_probe_one_t { // an array of `s_mc_message_simcall_probe_one_t[n_transitions]
122 // is sent right after a `s_mc_message_actors_status_one_t`
123 std::array<char, SIMCALL_SERIALIZATION_BUFFER_SIZE> buffer;
126 #endif // __cplusplus