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. */
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"
35 extern e_mc_mode_t mc_mode;
43 MC_MESSAGE_IGNORE_HEAP,
44 MC_MESSAGE_UNIGNORE_HEAP,
45 MC_MESSAGE_IGNORE_MEMORY,
46 MC_MESSAGE_STACK_REGION,
47 MC_MESSAGE_REGISTER_SYMBOL,
48 MC_MESSAGE_DEADLOCK_CHECK,
49 MC_MESSAGE_DEADLOCK_CHECK_REPLY,
52 #define MC_MESSAGE_LENGTH 512
54 /** Basic structure for a MC message
56 * The current version of the client/server protocol sends C structures over `AF_LOCAL`
57 * `SOCK_DGRAM` sockets. This means that the protocol is ABI/architecture specific:
58 * we currently can't model-check a x86 process from a x86_64 process.
60 * Moreover the protocol is not stable. The same version of the library should be used
61 * for the client and the server.
63 * This is the basic structure shared by all messages: all message start with a message
66 typedef struct s_mc_message {
67 e_mc_message_type type;
68 } s_mc_message_t, *mc_message_t;
70 typedef struct s_mc_int_message {
71 e_mc_message_type type;
73 } s_mc_int_message_t, *mc_int_message_t;
75 typedef struct s_mc_ignore_heap_message {
76 e_mc_message_type type;
77 s_mc_heap_ignore_region_t region;
78 } s_mc_ignore_heap_message_t, *mc_ignore_heap_message_t;
80 typedef struct s_mc_ignore_memory_message {
81 e_mc_message_type type;
84 } s_mc_ignore_memory_message_t, *mc_ignore_memory_message_t;
86 typedef struct s_mc_stack_region_message {
87 e_mc_message_type type;
88 s_stack_region_t stack_region;
89 } s_mc_stack_region_message_t, *mc_stack_region_message_t;
91 typedef struct s_mc_register_symbol_message {
92 e_mc_message_type type;
94 int (*callback)(void*);
96 } s_mc_register_symbol_message_t, * mc_register_symbol_message_t;
98 int MC_protocol_send(int socket, void* message, size_t size);
99 int MC_protocol_send_simple_message(int socket, int type);
100 int MC_protocol_hello(int socket);
101 ssize_t MC_receive_message(int socket, void* message, size_t size);