1 /* Copyright (c) 2015-2017. The SimGrid Team. All rights reserved. */
3 /* This program is free software; you can redistribute it and/or modify it
4 * under the terms of the license (GNU LGPL) which comes with this package. */
9 #include <sys/ptrace.h>
10 #include <sys/socket.h>
11 #include <sys/types.h>
14 #include <xbt/mmalloc.h>
16 #include <xbt/sysdep.h>
18 #include <simgrid/modelchecker.h>
20 #include "src/internal_config.h"
22 #include "src/mc/mc_request.h"
23 #include "src/mc/remote/Client.hpp"
24 #include "src/mc/remote/mc_protocol.h"
26 #include "src/smpi/private.hpp"
28 // We won't need those once the separation MCer/MCed is complete:
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::instance_;
38 Client* Client::initialize()
40 // We are not in MC mode:
41 // TODO, handle this more gracefully.
42 if (not std::getenv(MC_ENV_SOCKET_FD))
45 // Do not break if we are called multiple times:
47 return instance_.get();
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");
56 xbt_str_parse_int(fd_env, bprintf("Variable %s should contain a number but contains '%%s'", MC_ENV_SOCKET_FD));
57 XBT_DEBUG("Model-checked application found socket FD %i", fd);
59 // Check the socket type/validity:
61 socklen_t socklen = sizeof(type);
62 if (getsockopt(fd, SOL_SOCKET, SO_TYPE, &type, &socklen) != 0)
63 xbt_die("Could not check socket type");
64 if (type != SOCK_DGRAM)
65 xbt_die("Unexpected socket type %i", type);
66 XBT_DEBUG("Model-checked application found expected socket type");
68 instance_ = std::unique_ptr<Client>(new simgrid::mc::Client(fd));
70 // Wait for the model-checker:
73 ptrace(PTRACE_TRACEME, 0, nullptr, nullptr);
75 ptrace(PT_TRACE_ME, 0, nullptr, 0);
77 #error "no ptrace equivalent coded for this platform"
79 if (errno != 0 || raise(SIGSTOP) != 0)
80 xbt_die("Could not wait for the model-checker");
82 instance_->handleMessages();
83 return instance_.get();
86 void Client::handleDeadlockCheck(mc_message_t* msg)
88 bool deadlock = false;
89 if (not simix_global->process_list.empty()) {
91 for (auto kv : simix_global->process_list)
92 if (simgrid::mc::actor_is_enabled(kv.second)) {
99 mc_message_int_t answer{MC_MESSAGE_DEADLOCK_CHECK_REPLY, deadlock};
100 xbt_assert(channel_.send(answer) == 0, "Could not send response");
102 void Client::handleContinue(mc_message_t* msg)
105 void Client::handleSimcall(s_mc_message_simcall_handle_t* message)
107 smx_actor_t process = SIMIX_process_from_PID(message->pid);
109 xbt_die("Invalid pid %lu", (unsigned long)message->pid);
110 SIMIX_simcall_handle(&process->simcall, message->value);
111 if (channel_.send(MC_MESSAGE_WAITING))
112 xbt_die("Could not send MESSAGE_WAITING to model-checker");
114 void Client::handleRestore(s_mc_message_restore_t* message)
117 smpi_really_switch_data_segment(message->index);
121 void Client::handleMessages()
124 XBT_DEBUG("Waiting messages from model-checker");
126 char message_buffer[MC_MESSAGE_LENGTH];
127 ssize_t received_size = channel_.receive(&message_buffer, sizeof(message_buffer));
129 if (received_size < 0)
130 xbt_die("Could not receive commands from the model-checker");
132 mc_message_t* message = (mc_message_t*)message_buffer;
133 switch (message->type) {
135 case MC_MESSAGE_DEADLOCK_CHECK:
136 xbt_assert(received_size == sizeof(mc_message_t), "Unexpected size for DEADLOCK_CHECK (%zu != %zu)",
137 received_size, sizeof(mc_message_t));
138 handleDeadlockCheck(message);
141 case MC_MESSAGE_CONTINUE:
142 xbt_assert(received_size == sizeof(mc_message_t), "Unexpected size for MESSAGE_CONTINUE (%zu != %zu)",
143 received_size, sizeof(mc_message_t));
144 handleContinue(message);
147 case MC_MESSAGE_SIMCALL_HANDLE:
148 xbt_assert(received_size == sizeof(s_mc_message_simcall_handle_t),
149 "Unexpected size for SIMCALL_HANDLE (%zu != %zu)", received_size,
150 sizeof(s_mc_message_simcall_handle_t));
151 handleSimcall((s_mc_message_simcall_handle_t*)message_buffer);
154 case MC_MESSAGE_RESTORE:
155 xbt_assert(received_size == sizeof(mc_message_t), "Unexpected size for MESSAGE_RESTORE (%zu != %zu)",
156 received_size, sizeof(mc_message_t));
157 handleRestore((s_mc_message_restore_t*)message_buffer);
161 xbt_die("Received unexpected message %s (%i)", MC_message_type_name(message->type), message->type);
167 void Client::mainLoop()
170 simgrid::mc::wait_for_requests();
171 xbt_assert(channel_.send(MC_MESSAGE_WAITING) == 0, "Could not send WAITING message to model-checker");
172 this->handleMessages();
176 void Client::reportAssertionFailure(const char* description)
178 if (channel_.send(MC_MESSAGE_ASSERTION_FAILED))
179 xbt_die("Could not send assertion to model-checker");
180 this->handleMessages();
183 void Client::ignoreMemory(void* addr, std::size_t size)
185 s_mc_message_ignore_memory_t message;
186 message.type = MC_MESSAGE_IGNORE_MEMORY;
187 message.addr = (std::uintptr_t)addr;
189 if (channel_.send(message))
190 xbt_die("Could not send IGNORE_MEMORY mesage to model-checker");
193 void Client::ignoreHeap(void* address, std::size_t size)
195 xbt_mheap_t heap = mmalloc_get_current_heap();
197 s_mc_message_ignore_heap_t message;
198 message.type = MC_MESSAGE_IGNORE_HEAP;
199 message.address = address;
201 message.block = ((char*)address - (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++;
206 message.fragment = ((uintptr_t)(ADDR2UINT(address) % (BLOCKSIZE))) >> heap->heapinfo[message.block].type;
207 heap->heapinfo[message.block].busy_frag.ignore[message.fragment]++;
210 if (channel_.send(message))
211 xbt_die("Could not send ignored region to MCer");
214 void Client::unignoreHeap(void* address, std::size_t size)
216 s_mc_message_ignore_memory_t message;
217 message.type = MC_MESSAGE_UNIGNORE_HEAP;
218 message.addr = (std::uintptr_t)address;
220 if (channel_.send(message))
221 xbt_die("Could not send IGNORE_HEAP message to model-checker");
224 void Client::declareSymbol(const char* name, int* value)
226 s_mc_register_symbol_message_t message;
227 message.type = MC_MESSAGE_REGISTER_SYMBOL;
228 if (strlen(name) + 1 > sizeof(message.name))
229 xbt_die("Symbol is too long");
230 strncpy(message.name, name, sizeof(message.name));
231 message.callback = nullptr;
232 message.data = value;
233 if (channel_.send(message))
234 xbt_die("Could send REGISTER_SYMBOL message to model-checker");
237 void Client::declareStack(void* stack, size_t size, smx_actor_t process, ucontext_t* context)
239 xbt_mheap_t heap = mmalloc_get_current_heap();
241 s_stack_region_t region;
242 memset(®ion, 0, sizeof(region));
243 region.address = stack;
244 region.context = context;
246 region.block = ((char*)stack - (char*)heap->heapbase) / BLOCKSIZE + 1;
248 if (smpi_privatize_global_variables == SMPI_PRIVATIZE_MMAP && process)
249 region.process_index = process->pid - 1;
252 region.process_index = -1;
254 s_mc_message_stack_region_t message;
255 message.type = MC_MESSAGE_STACK_REGION;
256 message.stack_region = region;
257 if (channel_.send(message))
258 xbt_die("Could not send STACK_REGION to model-checker");