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. */
10 #include <sys/types.h>
11 #include <sys/ptrace.h>
12 #include <sys/socket.h>
15 #include <xbt/sysdep.h>
16 #include <xbt/mmalloc.h>
19 #include <simgrid/modelchecker.h>
21 #include "src/internal_config.h"
23 #include "src/mc/mc_protocol.h"
24 #include "src/mc/Client.hpp"
25 #include "src/mc/mc_request.h"
27 // We won't need those once the separation MCer/MCed is complete:
28 #include "src/mc/mc_ignore.h"
29 #include "src/mc/mc_smx.h"
31 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_client, mc, "MC client logic");
36 std::unique_ptr<Client> Client::client_;
38 Client* Client::initialize()
40 // We are not in MC mode:
41 // TODO, handle this more gracefully.
42 if (!getenv(MC_ENV_SOCKET_FD))
45 // Do not break if we are called multiple times:
49 _sg_do_model_check = 1;
51 // Fetch socket from MC_ENV_SOCKET_FD:
52 char* fd_env = std::getenv(MC_ENV_SOCKET_FD);
54 xbt_die("No MC socket passed in the environment");
55 int fd = xbt_str_parse_int(fd_env, bprintf("Variable %s should contain a number but contains '%%s'", MC_ENV_SOCKET_FD));
56 XBT_DEBUG("Model-checked application found socket FD %i", fd);
58 // Check the socket type/validity:
60 socklen_t socklen = sizeof(type);
61 if (getsockopt(fd, SOL_SOCKET, SO_TYPE, &type, &socklen) != 0)
62 xbt_die("Could not check socket type");
63 if (type != SOCK_DGRAM)
64 xbt_die("Unexpected socket type %i", type);
65 XBT_DEBUG("Model-checked application found expected socket type");
67 client_ = std::unique_ptr<Client>(new simgrid::mc::Client(fd));
69 // Wait for the model-checker:
72 ptrace(PTRACE_TRACEME, 0, nullptr, nullptr);
74 ptrace(PT_TRACE_ME, 0, nullptr, 0);
76 # error "ptrace not declared on this platform"
78 if(errno != 0 || raise(SIGSTOP) != 0)
79 xbt_die("Could not wait for the model-checker");
81 client_->handleMessages();
85 void Client::handleMessages()
88 XBT_DEBUG("Waiting messages from model-checker");
90 char message_buffer[MC_MESSAGE_LENGTH];
93 if ((s = channel_.receive(&message_buffer, sizeof(message_buffer))) < 0)
94 xbt_die("Could not receive commands from the model-checker");
96 s_mc_message_t message;
97 if ((size_t) s < sizeof(message))
98 xbt_die("Received message is too small");
99 memcpy(&message, message_buffer, sizeof(message));
100 switch (message.type) {
102 case MC_MESSAGE_DEADLOCK_CHECK:
105 bool deadlock = false;
107 if (xbt_swag_size(simix_global->process_list)) {
109 xbt_swag_foreach(process, simix_global->process_list)
110 if (simgrid::mc::process_is_enabled(process)) {
117 s_mc_int_message_t answer;
118 answer.type = MC_MESSAGE_DEADLOCK_CHECK_REPLY;
119 answer.value = deadlock;
120 if (channel_.send(answer))
121 xbt_die("Could not send response");
125 case MC_MESSAGE_CONTINUE:
128 case MC_MESSAGE_SIMCALL_HANDLE:
130 s_mc_simcall_handle_message_t message;
131 if (s != sizeof(message))
132 xbt_die("Unexpected size for SIMCALL_HANDLE");
133 memcpy(&message, message_buffer, sizeof(message));
134 smx_actor_t process = SIMIX_process_from_PID(message.pid);
136 xbt_die("Invalid pid %lu", (unsigned long) message.pid);
137 SIMIX_simcall_handle(&process->simcall, message.value);
138 if (channel_.send(MC_MESSAGE_WAITING))
139 xbt_die("Could not send MESSAGE_WAITING to model-checker");
143 case MC_MESSAGE_RESTORE:
145 s_mc_restore_message_t message;
146 if (s != sizeof(message))
147 xbt_die("Unexpected size for SIMCALL_HANDLE");
148 memcpy(&message, message_buffer, sizeof(message));
150 smpi_really_switch_data_segment(message.index);
156 xbt_die("Received unexpected message %s (%i)",
157 MC_message_type_name(message.type),
164 void Client::mainLoop(void)
167 simgrid::mc::wait_for_requests();
168 if (channel_.send(MC_MESSAGE_WAITING))
169 xbt_die("Could not send WAITING mesage to model-checker");
170 this->handleMessages();
174 void Client::reportAssertionFailure(const char* description)
176 if (channel_.send(MC_MESSAGE_ASSERTION_FAILED))
177 xbt_die("Could not send assertion to model-checker");
178 this->handleMessages();
181 void Client::ignoreMemory(void* addr, std::size_t size)
183 s_mc_ignore_memory_message_t message;
184 message.type = MC_MESSAGE_IGNORE_MEMORY;
185 message.addr = (std::uintptr_t) addr;
187 if (channel_.send(message))
188 xbt_die("Could not send IGNORE_MEMORY mesage to model-checker");
191 void Client::ignoreHeap(void* address, std::size_t size)
193 xbt_mheap_t heap = mmalloc_get_current_heap();
195 s_mc_ignore_heap_message_t message;
196 message.type = MC_MESSAGE_IGNORE_HEAP;
197 message.address = address;
201 (char *) heap->heapbase) / BLOCKSIZE + 1;
202 if (heap->heapinfo[message.block].type == 0) {
203 message.fragment = -1;
204 heap->heapinfo[message.block].busy_block.ignore++;
207 ((uintptr_t) (ADDR2UINT(address) % (BLOCKSIZE))) >>
208 heap->heapinfo[message.block].type;
209 heap->heapinfo[message.block].busy_frag.ignore[message.fragment]++;
212 if (channel_.send(message))
213 xbt_die("Could not send ignored region to MCer");
216 void Client::unignoreHeap(void* address, std::size_t size)
218 s_mc_ignore_memory_message_t message;
219 message.type = MC_MESSAGE_UNIGNORE_HEAP;
220 message.addr = (std::uintptr_t) address;
222 if (channel_.send(message))
223 xbt_die("Could not send IGNORE_HEAP mesasge to model-checker");
226 void Client::declareSymbol(const char *name, int* value)
228 s_mc_register_symbol_message_t message;
229 message.type = MC_MESSAGE_REGISTER_SYMBOL;
230 if (strlen(name) + 1 > sizeof(message.name))
231 xbt_die("Symbol is too long");
232 strncpy(message.name, name, sizeof(message.name));
233 message.callback = nullptr;
234 message.data = value;
235 if (channel_.send(message))
236 xbt_die("Could send REGISTER_SYMBOL message to model-checker");
239 void Client::declareStack(void *stack, size_t size, smx_actor_t process, ucontext_t* context)
241 xbt_mheap_t heap = mmalloc_get_current_heap();
243 s_stack_region_t region;
244 memset(®ion, 0, sizeof(region));
245 region.address = stack;
246 region.context = context;
250 (char *) heap->heapbase) / BLOCKSIZE + 1;
252 if (smpi_privatize_global_variables && process)
253 region.process_index = smpi_process_index_of_smx_process(process);
256 region.process_index = -1;
258 s_mc_stack_region_message_t message;
259 message.type = MC_MESSAGE_STACK_REGION;
260 message.stack_region = region;
261 if (channel_.send(message))
262 xbt_die("Coule not send STACK_REGION to model-checker");