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>
18 #include "src/internal_config.h"
20 #include "src/mc/mc_protocol.h"
21 #include "src/mc/Client.hpp"
22 #include "src/mc/mc_request.h"
24 // We won't need those once the separation MCer/MCed is complete:
25 #include "src/mc/mc_ignore.h"
26 #include "src/mc/mc_smx.h"
28 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_client, mc, "MC client logic");
33 std::unique_ptr<Client> Client::client_;
35 Client* Client::initialize()
37 // We are not in MC mode:
38 // TODO, handle this more gracefully.
39 if (!getenv(MC_ENV_SOCKET_FD))
42 // Do not break if we are called multiple times:
46 // Check and set the mode:
47 if (mc_mode != MC_MODE_NONE)
49 mc_mode = MC_MODE_CLIENT;
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:
70 if (ptrace(PTRACE_TRACEME, 0, nullptr, NULL) == -1 || raise(SIGSTOP) != 0)
71 xbt_die("Could not wait for the model-checker");
73 client_->handleMessages();
77 void Client::handleMessages()
80 XBT_DEBUG("Waiting messages from model-checker");
82 char message_buffer[MC_MESSAGE_LENGTH];
85 if ((s = channel_.receive(&message_buffer, sizeof(message_buffer))) < 0)
86 xbt_die("Could not receive commands from the model-checker");
88 s_mc_message_t message;
89 if ((size_t) s < sizeof(message))
90 xbt_die("Received message is too small");
91 memcpy(&message, message_buffer, sizeof(message));
92 switch (message.type) {
94 case MC_MESSAGE_DEADLOCK_CHECK:
97 bool deadlock = false;
98 smx_process_t process;
99 if (xbt_swag_size(simix_global->process_list)) {
101 xbt_swag_foreach(process, simix_global->process_list)
102 if (simgrid::mc::process_is_enabled(process)) {
109 s_mc_int_message_t answer;
110 answer.type = MC_MESSAGE_DEADLOCK_CHECK_REPLY;
111 answer.value = deadlock;
112 if (channel_.send(answer))
113 xbt_die("Could not send response");
117 case MC_MESSAGE_CONTINUE:
120 case MC_MESSAGE_SIMCALL_HANDLE:
122 s_mc_simcall_handle_message_t message;
123 if (s != sizeof(message))
124 xbt_die("Unexpected size for SIMCALL_HANDLE");
125 memcpy(&message, message_buffer, sizeof(message));
126 smx_process_t process = SIMIX_process_from_PID(message.pid);
128 xbt_die("Invalid pid %lu", (unsigned long) message.pid);
129 SIMIX_simcall_handle(&process->simcall, message.value);
130 if (channel_.send(MC_MESSAGE_WAITING))
131 xbt_die("Could not send MESSAGE_WAITING to model-checker");
135 case MC_MESSAGE_RESTORE:
137 s_mc_restore_message_t message;
138 if (s != sizeof(message))
139 xbt_die("Unexpected size for SIMCALL_HANDLE");
140 memcpy(&message, message_buffer, sizeof(message));
141 smpi_really_switch_data_segment(message.index);
146 xbt_die("%s received unexpected message %s (%i)",
147 MC_mode_name(mc_mode),
148 MC_message_type_name(message.type),
155 void Client::mainLoop(void)
158 if (channel_.send(MC_MESSAGE_WAITING))
159 xbt_die("Could not send WAITING mesage to model-checker");
160 this->handleMessages();
161 simgrid::mc::wait_for_requests();
165 void Client::reportAssertionFailure(const char* description)
167 if (channel_.send(MC_MESSAGE_ASSERTION_FAILED))
168 xbt_die("Could not send assertion to model-checker");
169 this->handleMessages();
172 void Client::ignoreMemory(void* addr, std::size_t size)
174 s_mc_ignore_memory_message_t message;
175 message.type = MC_MESSAGE_IGNORE_MEMORY;
176 message.addr = (std::uintptr_t) addr;
178 if (channel_.send(message))
179 xbt_die("Could not send IGNORE_MEMORY mesage to model-checker");
182 void Client::ignoreHeap(void* address, std::size_t size)
184 xbt_mheap_t heap = mmalloc_get_current_heap();
186 s_mc_ignore_heap_message_t message;
187 message.type = MC_MESSAGE_IGNORE_HEAP;
188 message.address = address;
192 (char *) heap->heapbase) / BLOCKSIZE + 1;
193 if (heap->heapinfo[message.block].type == 0) {
194 message.fragment = -1;
195 heap->heapinfo[message.block].busy_block.ignore++;
198 ((uintptr_t) (ADDR2UINT(address) % (BLOCKSIZE))) >>
199 heap->heapinfo[message.block].type;
200 heap->heapinfo[message.block].busy_frag.ignore[message.fragment]++;
203 if (channel_.send(message))
204 xbt_die("Could not send ignored region to MCer");
207 void Client::unignoreHeap(void* address, std::size_t size)
209 s_mc_ignore_memory_message_t message;
210 message.type = MC_MESSAGE_UNIGNORE_HEAP;
211 message.addr = (std::uintptr_t) address;
213 if (channel_.send(message))
214 xbt_die("Could not send IGNORE_HEAP mesasge to model-checker");
217 void Client::declareSymbol(const char *name, int* value)
219 s_mc_register_symbol_message_t message;
220 message.type = MC_MESSAGE_REGISTER_SYMBOL;
221 if (strlen(name) + 1 > sizeof(message.name))
222 xbt_die("Symbol is too long");
223 strncpy(message.name, name, sizeof(message.name));
224 message.callback = nullptr;
225 message.data = value;
226 if (channel_.send(message))
227 xbt_die("Could send REGISTER_SYMBOL message to model-checker");
230 void Client::declareStack(void *stack, size_t size, smx_process_t process, ucontext_t* context)
232 xbt_mheap_t heap = mmalloc_get_current_heap();
234 s_stack_region_t region;
235 memset(®ion, 0, sizeof(region));
236 region.address = stack;
237 region.context = context;
241 (char *) heap->heapbase) / BLOCKSIZE + 1;
243 if (smpi_privatize_global_variables && process)
244 region.process_index = smpi_process_index_of_smx_process(process);
247 region.process_index = -1;
249 s_mc_stack_region_message_t message;
250 message.type = MC_MESSAGE_STACK_REGION;
251 message.stack_region = region;
252 if (channel_.send(message))
253 xbt_die("Coule not send STACK_REGION to model-checker");