Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
More ptrace portability in model checker.
[simgrid.git] / src / mc / Client.cpp
1 /* Copyright (c) 2015. The SimGrid Team.
2  * All rights reserved.                                                     */
3
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. */
6
7 #include <cstdlib>
8 #include <cerrno>
9
10 #include <sys/types.h>
11 #include <sys/ptrace.h>
12 #include <sys/socket.h>
13
14 #include <xbt/log.h>
15 #include <xbt/sysdep.h>
16 #include <xbt/mmalloc.h>
17 #include <xbt/swag.h>
18
19 #include <simgrid/modelchecker.h>
20
21 #include "src/internal_config.h"
22
23 #include "src/mc/mc_protocol.h"
24 #include "src/mc/Client.hpp"
25 #include "src/mc/mc_request.h"
26
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"
30
31 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_client, mc, "MC client logic");
32
33 namespace simgrid {
34 namespace mc {
35
36 std::unique_ptr<Client> Client::client_;
37
38 Client* Client::initialize()
39 {
40   // We are not in MC mode:
41   // TODO, handle this more gracefully.
42   if (!getenv(MC_ENV_SOCKET_FD))
43     return nullptr;
44
45   // Do not break if we are called multiple times:
46   if (client_)
47     return client_.get();
48
49   _sg_do_model_check = 1;
50
51   // Fetch socket from MC_ENV_SOCKET_FD:
52   char* fd_env = std::getenv(MC_ENV_SOCKET_FD);
53   if (!fd_env)
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);
57
58   // Check the socket type/validity:
59   int type;
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");
66
67   client_ = std::unique_ptr<Client>(new simgrid::mc::Client(fd));
68
69   // Wait for the model-checker:
70   errno = 0;
71 #if defined __linux__
72   ptrace(PTRACE_TRACEME, 0, nullptr, nullptr);
73 #elif defined BSD
74   ptrace(PT_TRACE_ME, 0, nullptr, 0);
75 #else
76 # error "no ptrace equivalent coded for this platform"
77 #endif
78   if(errno != 0 || raise(SIGSTOP) != 0)
79     xbt_die("Could not wait for the model-checker");
80
81   client_->handleMessages();
82   return client_.get();
83 }
84
85 void Client::handleMessages()
86 {
87   while (1) {
88     XBT_DEBUG("Waiting messages from model-checker");
89
90     char message_buffer[MC_MESSAGE_LENGTH];
91     ssize_t s;
92
93     if ((s = channel_.receive(&message_buffer, sizeof(message_buffer))) < 0)
94       xbt_die("Could not receive commands from the model-checker");
95
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) {
101
102     case MC_MESSAGE_DEADLOCK_CHECK:
103       {
104         // Check deadlock:
105         bool deadlock = false;
106         smx_actor_t process;
107         if (xbt_swag_size(simix_global->process_list)) {
108           deadlock = true;
109           xbt_swag_foreach(process, simix_global->process_list)
110             if (simgrid::mc::process_is_enabled(process)) {
111               deadlock = false;
112               break;
113             }
114         }
115
116         // Send result:
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");
122       }
123       break;
124
125     case MC_MESSAGE_CONTINUE:
126       return;
127
128     case MC_MESSAGE_SIMCALL_HANDLE:
129       {
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);
135         if (!process)
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");
140       }
141       break;
142
143     case MC_MESSAGE_RESTORE:
144       {
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));
149 #if HAVE_SMPI
150         smpi_really_switch_data_segment(message.index);
151 #endif
152       }
153       break;
154
155     default:
156       xbt_die("Received unexpected message %s (%i)",
157         MC_message_type_name(message.type),
158         message.type
159       );
160     }
161   }
162 }
163
164 void Client::mainLoop(void)
165 {
166   while (1) {
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();
171   }
172 }
173
174 void Client::reportAssertionFailure(const char* description)
175 {
176   if (channel_.send(MC_MESSAGE_ASSERTION_FAILED))
177     xbt_die("Could not send assertion to model-checker");
178   this->handleMessages();
179 }
180
181 void Client::ignoreMemory(void* addr, std::size_t size)
182 {
183   s_mc_ignore_memory_message_t message;
184   message.type = MC_MESSAGE_IGNORE_MEMORY;
185   message.addr = (std::uintptr_t) addr;
186   message.size = size;
187   if (channel_.send(message))
188     xbt_die("Could not send IGNORE_MEMORY mesage to model-checker");
189 }
190
191 void Client::ignoreHeap(void* address, std::size_t size)
192 {
193   xbt_mheap_t heap = mmalloc_get_current_heap();
194
195   s_mc_ignore_heap_message_t message;
196   message.type = MC_MESSAGE_IGNORE_HEAP;
197   message.address = address;
198   message.size = size;
199   message.block =
200    ((char *) 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++;
205   } else {
206     message.fragment =
207         ((uintptr_t) (ADDR2UINT(address) % (BLOCKSIZE))) >>
208         heap->heapinfo[message.block].type;
209     heap->heapinfo[message.block].busy_frag.ignore[message.fragment]++;
210   }
211
212   if (channel_.send(message))
213     xbt_die("Could not send ignored region to MCer");
214 }
215
216 void Client::unignoreHeap(void* address, std::size_t size)
217 {
218   s_mc_ignore_memory_message_t message;
219   message.type = MC_MESSAGE_UNIGNORE_HEAP;
220   message.addr = (std::uintptr_t) address;
221   message.size = size;
222   if (channel_.send(message))
223     xbt_die("Could not send IGNORE_HEAP mesasge to model-checker");
224 }
225
226 void Client::declareSymbol(const char *name, int* value)
227 {
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");
237 }
238
239 void Client::declareStack(void *stack, size_t size, smx_actor_t process, ucontext_t* context)
240 {
241   xbt_mheap_t heap = mmalloc_get_current_heap();
242
243   s_stack_region_t region;
244   memset(&region, 0, sizeof(region));
245   region.address = stack;
246   region.context = context;
247   region.size = size;
248   region.block =
249       ((char *) stack -
250        (char *) heap->heapbase) / BLOCKSIZE + 1;
251 #if HAVE_SMPI
252   if (smpi_privatize_global_variables && process)
253     region.process_index = smpi_process_index_of_smx_process(process);
254   else
255 #endif
256   region.process_index = -1;
257
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");
263 }
264
265 }
266 }