1 /* Copyright (c) 2015. The SimGrid Team.
2 * All rights reserved. */
4 /* This program is free software; you can redistribute it and/or modify it
5 * under the terms of the license (GNU LGPL) which comes with this package. */
7 #ifndef SIMGRID_MC_PROTOCOL_H
8 #define SIMGRID_MC_PROTOCOL_H
12 #include "mc/datatypes.h"
16 // ***** Environment variables for passing context to the model-checked process
18 /** Environment variable name set by `simgrid-mc` to enable MC support in the
19 * children MC processes
21 #define MC_ENV_VARIABLE "SIMGRIC_MC"
23 /** Environment variable name used to pass the communication socket */
24 #define MC_ENV_SOCKET_FD "SIMGRID_MC_SOCKET_FD"
34 extern e_mc_mode_t mc_mode;
41 MC_MESSAGE_IGNORE_HEAP,
42 MC_MESSAGE_UNIGNORE_HEAP,
43 MC_MESSAGE_IGNORE_MEMORY,
44 MC_MESSAGE_STACK_REGION,
45 MC_MESSAGE_REGISTER_SYMBOL,
46 MC_MESSAGE_DEADLOCK_CHECK,
47 MC_MESSAGE_DEADLOCK_CHECK_REPLY,
49 MC_MESSAGE_SIMCALL_HANDLE,
50 MC_MESSAGE_ASSERTION_FAILED,
51 // MCer request to finish the restoration:
55 #define MC_MESSAGE_LENGTH 512
57 /** Basic structure for a MC message
59 * The current version of the client/server protocol sends C structures over `AF_LOCAL`
60 * `SOCK_DGRAM` sockets. This means that the protocol is ABI/architecture specific:
61 * we currently can't model-check a x86 process from a x86_64 process.
63 * Moreover the protocol is not stable. The same version of the library should be used
64 * for the client and the server.
66 * This is the basic structure shared by all messages: all message start with a message
69 typedef struct s_mc_message {
70 e_mc_message_type type;
71 } s_mc_message_t, *mc_message_t;
73 typedef struct s_mc_int_message {
74 e_mc_message_type type;
76 } s_mc_int_message_t, *mc_int_message_t;
78 typedef struct s_mc_ignore_heap_message {
79 e_mc_message_type type;
84 } s_mc_ignore_heap_message_t, *mc_ignore_heap_message_t;
86 typedef struct s_mc_ignore_memory_message {
87 e_mc_message_type type;
90 } s_mc_ignore_memory_message_t, *mc_ignore_memory_message_t;
92 typedef struct s_mc_stack_region_message {
93 e_mc_message_type type;
94 s_stack_region_t stack_region;
95 } s_mc_stack_region_message_t, *mc_stack_region_message_t;
97 typedef struct s_mc_simcall_handle_message {
98 e_mc_message_type type;
101 } s_mc_simcall_handle_message_t, *mc_simcall_handle_message;
103 typedef struct s_mc_register_symbol_message {
104 e_mc_message_type type;
106 int (*callback)(void*);
108 } s_mc_register_symbol_message_t, * mc_register_symbol_message_t;
110 typedef struct s_mc_restore_message {
111 e_mc_message_type type;
113 } s_mc_restore_message_t, *mc_restore_message_t;
115 XBT_PRIVATE int MC_protocol_send(int socket, const void* message, size_t size);
116 XBT_PRIVATE int MC_protocol_send_simple_message(int socket, e_mc_message_type type);
117 XBT_PRIVATE ssize_t MC_receive_message(int socket, void* message, size_t size, int options);
119 XBT_PRIVATE const char* MC_message_type_name(e_mc_message_type type);
120 XBT_PRIVATE const char* MC_mode_name(e_mc_mode_t mode);