1 /* Copyright (c) 2015-2019. 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 #include "mc/datatypes.h"
10 #include "simgrid/forward.h"
14 // ***** Environment variables for passing context to the model-checked process
16 /** Environment variable name set by `simgrid-mc` to enable MC support in the
17 * children MC processes
19 #define MC_ENV_VARIABLE "SIMGRID_MC"
21 /** Environment variable name used to pass the communication socket */
22 #define MC_ENV_SOCKET_FD "SIMGRID_MC_SOCKET_FD"
26 enum e_mc_message_type {
29 MC_MESSAGE_IGNORE_HEAP,
30 MC_MESSAGE_UNIGNORE_HEAP,
31 MC_MESSAGE_IGNORE_MEMORY,
32 MC_MESSAGE_STACK_REGION,
33 MC_MESSAGE_REGISTER_SYMBOL,
34 MC_MESSAGE_DEADLOCK_CHECK,
35 MC_MESSAGE_DEADLOCK_CHECK_REPLY,
37 MC_MESSAGE_SIMCALL_HANDLE,
38 MC_MESSAGE_ASSERTION_FAILED,
39 MC_MESSAGE_ACTOR_ENABLED,
40 MC_MESSAGE_ACTOR_ENABLED_REPLY
43 #define MC_MESSAGE_LENGTH 512
45 /** Basic structure for a MC message
47 * The current version of the client/server protocol sends C structures over `AF_LOCAL`
48 * `SOCK_SEQPACKET` sockets. This means that the protocol is ABI/architecture specific:
49 * we currently can't model-check a x86 process from a x86_64 process.
51 * Moreover the protocol is not stable. The same version of the library should be used
52 * for the client and the server.
55 /* Basic structure: all message start with a message type */
56 struct s_mc_message_t {
57 enum e_mc_message_type type;
60 struct s_mc_message_int_t {
61 enum e_mc_message_type type;
66 struct s_mc_message_ignore_heap_t {
67 enum e_mc_message_type type;
74 struct s_mc_message_ignore_memory_t {
75 enum e_mc_message_type type;
80 struct s_mc_message_stack_region_t {
81 enum e_mc_message_type type;
82 s_stack_region_t stack_region;
85 struct s_mc_message_register_symbol_t {
86 enum e_mc_message_type type;
88 int (*callback)(void*);
92 /* Server -> client */
93 struct s_mc_message_simcall_handle_t {
94 enum e_mc_message_type type;
99 struct s_mc_message_restore_t {
100 enum e_mc_message_type type;
104 struct s_mc_message_actor_enabled_t {
105 enum e_mc_message_type type;
106 aid_t aid; // actor ID
109 XBT_PRIVATE const char* MC_message_type_name(enum e_mc_message_type type);