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"
15 // ***** Environment variables for passing context to the model-checked process
17 /** Environment variable name set by `simgrid-mc` to enable MC support in the
18 * children MC processes
20 #define MC_ENV_VARIABLE "SIMGRID_MC"
22 /** Environment variable name used to pass the communication socket */
23 #define MC_ENV_SOCKET_FD "SIMGRID_MC_SOCKET_FD"
27 enum e_mc_message_type {
30 MC_MESSAGE_IGNORE_HEAP,
31 MC_MESSAGE_UNIGNORE_HEAP,
32 MC_MESSAGE_IGNORE_MEMORY,
33 MC_MESSAGE_STACK_REGION,
34 MC_MESSAGE_REGISTER_SYMBOL,
35 MC_MESSAGE_DEADLOCK_CHECK,
36 MC_MESSAGE_DEADLOCK_CHECK_REPLY,
38 MC_MESSAGE_SIMCALL_HANDLE,
39 MC_MESSAGE_ASSERTION_FAILED,
40 MC_MESSAGE_ACTOR_ENABLED,
41 MC_MESSAGE_ACTOR_ENABLED_REPLY
44 #define MC_MESSAGE_LENGTH 512
46 /** Basic structure for a MC message
48 * The current version of the client/server protocol sends C structures over `AF_LOCAL`
49 * `SOCK_SEQPACKET` sockets. This means that the protocol is ABI/architecture specific:
50 * we currently can't model-check a x86 process from a x86_64 process.
52 * Moreover the protocol is not stable. The same version of the library should be used
53 * for the client and the server.
56 /* Basic structure: all message start with a message type */
57 struct s_mc_message_t {
58 enum e_mc_message_type type;
61 struct s_mc_message_int_t {
62 enum e_mc_message_type type;
67 struct s_mc_message_ignore_heap_t {
68 enum e_mc_message_type type;
75 struct s_mc_message_ignore_memory_t {
76 enum e_mc_message_type type;
81 struct s_mc_message_stack_region_t {
82 enum e_mc_message_type type;
83 s_stack_region_t stack_region;
86 struct s_mc_message_register_symbol_t {
87 enum e_mc_message_type type;
89 int (*callback)(void*);
93 /* Server -> client */
94 struct s_mc_message_simcall_handle_t {
95 enum e_mc_message_type type;
100 struct s_mc_message_restore_t {
101 enum e_mc_message_type type;
105 struct s_mc_message_actor_enabled_t {
106 enum e_mc_message_type type;
107 aid_t aid; // actor ID
110 XBT_PRIVATE const char* MC_message_type_name(enum e_mc_message_type type);