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
14 #include "mc/datatypes.h"
18 // ***** Environment variables for passing context to the model-checked process
20 /** Environment variable name set by `simgrid-mc` to enable MC support in the
21 * children MC processes
23 #define MC_ENV_VARIABLE "SIMGRID_MC"
25 /** Environment variable name used to pass the communication socket */
26 #define MC_ENV_SOCKET_FD "SIMGRID_MC_SOCKET_FD"
33 MC_MESSAGE_IGNORE_HEAP,
34 MC_MESSAGE_UNIGNORE_HEAP,
35 MC_MESSAGE_IGNORE_MEMORY,
36 MC_MESSAGE_STACK_REGION,
37 MC_MESSAGE_REGISTER_SYMBOL,
38 MC_MESSAGE_DEADLOCK_CHECK,
39 MC_MESSAGE_DEADLOCK_CHECK_REPLY,
41 MC_MESSAGE_SIMCALL_HANDLE,
42 MC_MESSAGE_ASSERTION_FAILED,
43 // MCer request to finish the restoration:
47 #define MC_MESSAGE_LENGTH 512
49 /** Basic structure for a MC message
51 * The current version of the client/server protocol sends C structures over `AF_LOCAL`
52 * `SOCK_DGRAM` sockets. This means that the protocol is ABI/architecture specific:
53 * we currently can't model-check a x86 process from a x86_64 process.
55 * Moreover the protocol is not stable. The same version of the library should be used
56 * for the client and the server.
58 * This is the basic structure shared by all messages: all message start with a message
61 typedef struct s_mc_message {
62 e_mc_message_type type;
63 } s_mc_message_t, *mc_message_t;
65 typedef struct s_mc_int_message {
66 e_mc_message_type type;
68 } s_mc_int_message_t, *mc_int_message_t;
70 typedef struct s_mc_ignore_heap_message {
71 e_mc_message_type type;
76 } s_mc_ignore_heap_message_t, *mc_ignore_heap_message_t;
78 typedef struct s_mc_ignore_memory_message {
79 e_mc_message_type type;
82 } s_mc_ignore_memory_message_t, *mc_ignore_memory_message_t;
84 typedef struct s_mc_stack_region_message {
85 e_mc_message_type type;
86 s_stack_region_t stack_region;
87 } s_mc_stack_region_message_t, *mc_stack_region_message_t;
89 typedef struct s_mc_simcall_handle_message {
90 e_mc_message_type type;
93 } s_mc_simcall_handle_message_t, *mc_simcall_handle_message;
95 typedef struct s_mc_register_symbol_message {
96 e_mc_message_type type;
98 int (*callback)(void*);
100 } s_mc_register_symbol_message_t, * mc_register_symbol_message_t;
102 typedef struct s_mc_restore_message {
103 e_mc_message_type type;
105 } s_mc_restore_message_t, *mc_restore_message_t;
107 XBT_PRIVATE const char* MC_message_type_name(e_mc_message_type type);