Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
[mc] Remove useless MC_MODE_CLIENT paths
[simgrid.git] / src / mc / mc_request.cpp
1 /* Copyright (c) 2008-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 <cassert>
8
9 #include <xbt/log.h>
10 #include <xbt/str.h>
11 #include <xbt/sysdep.h>
12 #include <xbt/dynar.h>
13 #include <xbt/swag.h>
14
15 #include "src/mc/mc_request.h"
16 #include "src/mc/mc_safety.h"
17 #include "src/mc/mc_private.h"
18 #include "src/mc/mc_smx.h"
19 #include "src/mc/mc_xbt.hpp"
20
21 using simgrid::mc::remote;
22
23 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_request, mc,
24                                 "Logging specific to MC (request)");
25
26 static char *pointer_to_string(void *pointer);
27 static char *buff_size_to_string(size_t size);
28
29 static inline
30 smx_synchro_t MC_get_comm(smx_simcall_t r)
31 {
32   switch (r->call ) {
33   case SIMCALL_COMM_WAIT:
34     return simcall_comm_wait__get__comm(r);
35   case SIMCALL_COMM_TEST:
36     return simcall_comm_test__get__comm(r);
37   default:
38     return nullptr;
39   }
40 }
41
42 static inline
43 smx_mailbox_t MC_get_rdv(smx_simcall_t r)
44 {
45   switch(r->call) {
46   case SIMCALL_COMM_ISEND:
47     return simcall_comm_isend__get__rdv(r);
48   case SIMCALL_COMM_IRECV:
49     return simcall_comm_irecv__get__rdv(r);
50   default:
51     return nullptr;
52   }
53 }
54
55 namespace simgrid {
56 namespace mc {
57
58 // Does half the job
59 static inline
60 bool request_depend_asymmetric(smx_simcall_t r1, smx_simcall_t r2)
61 {
62   if (r1->call == SIMCALL_COMM_ISEND && r2->call == SIMCALL_COMM_IRECV)
63     return false;
64
65   if (r1->call == SIMCALL_COMM_IRECV && r2->call == SIMCALL_COMM_ISEND)
66     return false;
67
68   // Those are internal requests, we do not need indirection
69   // because those objects are copies:
70   smx_synchro_t synchro1 = MC_get_comm(r1);
71   smx_synchro_t synchro2 = MC_get_comm(r2);
72
73   if ((r1->call == SIMCALL_COMM_ISEND || r1->call == SIMCALL_COMM_IRECV)
74       && r2->call == SIMCALL_COMM_WAIT) {
75
76     smx_mailbox_t rdv = MC_get_rdv(r1);
77
78     if (rdv != synchro2->comm.rdv_cpy
79         && simcall_comm_wait__get__timeout(r2) <= 0)
80       return false;
81
82     if ((r1->issuer != synchro2->comm.src_proc)
83         && (r1->issuer != synchro2->comm.dst_proc)
84         && simcall_comm_wait__get__timeout(r2) <= 0)
85       return false;
86
87     if ((r1->call == SIMCALL_COMM_ISEND)
88         && (synchro2->comm.type == SIMIX_COMM_SEND)
89         && (synchro2->comm.src_buff !=
90             simcall_comm_isend__get__src_buff(r1))
91         && simcall_comm_wait__get__timeout(r2) <= 0)
92       return false;
93
94     if ((r1->call == SIMCALL_COMM_IRECV)
95         && (synchro2->comm.type == SIMIX_COMM_RECEIVE)
96         && (synchro2->comm.dst_buff != simcall_comm_irecv__get__dst_buff(r1))
97         && simcall_comm_wait__get__timeout(r2) <= 0)
98       return false;
99   }
100
101   /* FIXME: the following rule assumes that the result of the
102    * isend/irecv call is not stored in a buffer used in the
103    * test call. */
104 #if 0
105   if((r1->call == SIMCALL_COMM_ISEND || r1->call == SIMCALL_COMM_IRECV)
106      &&  r2->call == SIMCALL_COMM_TEST)
107      return FALSE;
108 #endif
109
110   if (r1->call == SIMCALL_COMM_WAIT
111       && (r2->call == SIMCALL_COMM_WAIT || r2->call == SIMCALL_COMM_TEST)
112       && (synchro1->comm.src_proc == nullptr || synchro1->comm.dst_proc == nullptr))
113     return false;
114
115   if (r1->call == SIMCALL_COMM_TEST &&
116       (simcall_comm_test__get__comm(r1) == nullptr
117        || synchro1->comm.src_buff == nullptr
118        || synchro1->comm.dst_buff == nullptr))
119     return false;
120
121   if (r1->call == SIMCALL_COMM_TEST && r2->call == SIMCALL_COMM_WAIT
122       && synchro1->comm.src_buff == synchro2->comm.src_buff
123       && synchro1->comm.dst_buff == synchro2->comm.dst_buff)
124     return false;
125
126   if (r1->call == SIMCALL_COMM_WAIT && r2->call == SIMCALL_COMM_TEST
127       && synchro1->comm.src_buff != nullptr
128       && synchro1->comm.dst_buff != nullptr
129       && synchro2->comm.src_buff != nullptr
130       && synchro2->comm.dst_buff != nullptr
131       && synchro1->comm.dst_buff != synchro2->comm.src_buff
132       && synchro1->comm.dst_buff != synchro2->comm.dst_buff
133       && synchro2->comm.dst_buff != synchro1->comm.src_buff)
134     return false;
135
136   return true;
137 }
138
139 // Those are internal_req
140 bool request_depend(smx_simcall_t r1, smx_simcall_t r2)
141 {
142   if (r1->issuer == r2->issuer)
143     return false;
144
145   /* Wait with timeout transitions are not considered by the independance theorem, thus we consider them as dependant with all other transitions */
146   if ((r1->call == SIMCALL_COMM_WAIT && simcall_comm_wait__get__timeout(r1) > 0)
147       || (r2->call == SIMCALL_COMM_WAIT
148           && simcall_comm_wait__get__timeout(r2) > 0))
149     return TRUE;
150
151   if (r1->call != r2->call)
152     return request_depend_asymmetric(r1, r2)
153       && request_depend_asymmetric(r2, r1);
154
155   // Those are internal requests, we do not need indirection
156   // because those objects are copies:
157   smx_synchro_t synchro1 = MC_get_comm(r1);
158   smx_synchro_t synchro2 = MC_get_comm(r2);
159
160   switch(r1->call) {
161   case SIMCALL_COMM_ISEND:
162     return simcall_comm_isend__get__rdv(r1) == simcall_comm_isend__get__rdv(r2);
163   case SIMCALL_COMM_IRECV:
164     return simcall_comm_irecv__get__rdv(r1) == simcall_comm_irecv__get__rdv(r2);
165   case SIMCALL_COMM_WAIT:
166     if (synchro1->comm.src_buff == synchro2->comm.src_buff
167         && synchro1->comm.dst_buff == synchro2->comm.dst_buff)
168       return false;
169     else if (synchro1->comm.src_buff != nullptr
170         && synchro1->comm.dst_buff != nullptr
171         && synchro2->comm.src_buff != nullptr
172         && synchro2->comm.dst_buff != nullptr
173         && synchro1->comm.dst_buff != synchro2->comm.src_buff
174         && synchro1->comm.dst_buff != synchro2->comm.dst_buff
175         && synchro2->comm.dst_buff != synchro1->comm.src_buff)
176       return false;
177     else
178       return true;
179   default:
180     return true;
181   }
182 }
183
184 }
185 }
186
187 static char *pointer_to_string(void *pointer)
188 {
189
190   if (XBT_LOG_ISENABLED(mc_request, xbt_log_priority_verbose))
191     return bprintf("%p", pointer);
192
193   return xbt_strdup("(verbose only)");
194 }
195
196 static char *buff_size_to_string(size_t buff_size)
197 {
198
199   if (XBT_LOG_ISENABLED(mc_request, xbt_log_priority_verbose))
200     return bprintf("%zu", buff_size);
201
202   return xbt_strdup("(verbose only)");
203 }
204
205
206 std::string simgrid::mc::request_to_string(smx_simcall_t req, int value, simgrid::mc::RequestType request_type)
207 {
208   xbt_assert(mc_mode == MC_MODE_SERVER);
209
210   bool use_remote_comm = true;
211   switch(request_type) {
212   case simgrid::mc::RequestType::simix:
213     use_remote_comm = true;
214     break;
215   case simgrid::mc::RequestType::executed:
216   case simgrid::mc::RequestType::internal:
217     use_remote_comm = false;
218     break;
219   }
220
221   const char* type = nullptr;
222   char *args = nullptr;
223
224   smx_process_t issuer = MC_smx_simcall_get_issuer(req);
225
226   switch (req->call) {
227
228   case SIMCALL_COMM_ISEND: {
229     type = "iSend";
230     char* p = pointer_to_string(simcall_comm_isend__get__src_buff(req));
231     char* bs = buff_size_to_string(simcall_comm_isend__get__src_buff_size(req));
232     if (issuer->host)
233       args =
234           bprintf("src=(%lu)%s (%s), buff=%s, size=%s", issuer->pid,
235                   MC_smx_process_get_host_name(issuer),
236                   MC_smx_process_get_name(issuer),
237                   p, bs);
238     else
239       args =
240           bprintf("src=(%lu)%s, buff=%s, size=%s", issuer->pid,
241                   MC_smx_process_get_name(issuer), p, bs);
242     xbt_free(bs);
243     xbt_free(p);
244     break;
245   }
246
247   case SIMCALL_COMM_IRECV: {
248     size_t* remote_size = simcall_comm_irecv__get__dst_buff_size(req);
249
250     // size_t size = size_pointer ? *size_pointer : 0;
251     size_t size = 0;
252     if (remote_size)
253       mc_model_checker->process().read_bytes(&size, sizeof(size),
254         remote(remote_size));
255
256     type = "iRecv";
257     char* p = pointer_to_string(simcall_comm_irecv__get__dst_buff(req));
258     char* bs = buff_size_to_string(size);
259     if (issuer->host)
260       args =
261           bprintf("dst=(%lu)%s (%s), buff=%s, size=%s", issuer->pid,
262                   MC_smx_process_get_host_name(issuer),
263                   MC_smx_process_get_name(issuer),
264                   p, bs);
265     else
266       args =
267           bprintf("dst=(%lu)%s, buff=%s, size=%s", issuer->pid,
268                   MC_smx_process_get_name(issuer),
269                   p, bs);
270     xbt_free(bs);
271     xbt_free(p);
272     break;
273   }
274
275   case SIMCALL_COMM_WAIT: {
276     smx_synchro_t remote_act = simcall_comm_wait__get__comm(req);
277     char* p;
278     if (value == -1) {
279       type = "WaitTimeout";
280       p = pointer_to_string(remote_act);
281       args = bprintf("comm=%s", p);
282     } else {
283       type = "Wait";
284       p = pointer_to_string(remote_act);
285
286       s_smx_synchro_t synchro;
287       smx_synchro_t act;
288       if (use_remote_comm) {
289         mc_model_checker->process().read_bytes(&synchro,
290           sizeof(synchro), remote(remote_act));
291         act = &synchro;
292       } else
293         act = remote_act;
294
295       smx_process_t src_proc = MC_smx_resolve_process(simgrid::mc::remote(act->comm.src_proc));
296       smx_process_t dst_proc = MC_smx_resolve_process(simgrid::mc::remote(act->comm.dst_proc));
297       args = bprintf("comm=%s [(%lu)%s (%s)-> (%lu)%s (%s)]", p,
298                      src_proc ? src_proc->pid : 0,
299                      src_proc ? MC_smx_process_get_host_name(src_proc) : "",
300                      src_proc ? MC_smx_process_get_name(src_proc) : "",
301                      dst_proc ? dst_proc->pid : 0,
302                      dst_proc ? MC_smx_process_get_host_name(dst_proc) : "",
303                      dst_proc ? MC_smx_process_get_name(dst_proc) : "");
304     }
305     xbt_free(p);
306     break;
307   }
308
309   case SIMCALL_COMM_TEST: {
310     smx_synchro_t remote_act = simcall_comm_test__get__comm(req);
311     s_smx_synchro_t synchro;
312       smx_synchro_t act;
313       if (use_remote_comm) {
314         mc_model_checker->process().read_bytes(&synchro,
315           sizeof(synchro), remote(remote_act));
316         act = &synchro;
317       } else
318         act = remote_act;
319
320     char* p;
321     if (act->comm.src_proc == nullptr || act->comm.dst_proc == nullptr) {
322       type = "Test FALSE";
323       p = pointer_to_string(remote_act);
324       args = bprintf("comm=%s", p);
325     } else {
326       type = "Test TRUE";
327       p = pointer_to_string(remote_act);
328
329       smx_process_t src_proc = MC_smx_resolve_process(simgrid::mc::remote(act->comm.src_proc));
330       smx_process_t dst_proc = MC_smx_resolve_process(simgrid::mc::remote(act->comm.dst_proc));
331       args = bprintf("comm=%s [(%lu)%s (%s) -> (%lu)%s (%s)]", p,
332                      src_proc->pid,
333                      MC_smx_process_get_name(src_proc),
334                      MC_smx_process_get_host_name(src_proc),
335                      dst_proc->pid,
336                      MC_smx_process_get_name(dst_proc),
337                      MC_smx_process_get_host_name(dst_proc));
338     }
339     xbt_free(p);
340     break;
341   }
342
343   case SIMCALL_COMM_WAITANY: {
344     type = "WaitAny";
345     s_xbt_dynar_t comms;
346     mc_model_checker->process().read_bytes(
347       &comms, sizeof(comms), remote(simcall_comm_waitany__get__comms(req)));
348     if (!xbt_dynar_is_empty(&comms)) {
349       smx_synchro_t remote_sync;
350       read_element(mc_model_checker->process(),
351         &remote_sync, remote(simcall_comm_waitany__get__comms(req)), value,
352         sizeof(remote_sync));
353       char* p = pointer_to_string(remote_sync);
354       args = bprintf("comm=%s (%d of %lu)",
355         p, value + 1, xbt_dynar_length(&comms));
356       xbt_free(p);
357     } else
358       args = bprintf("comm at idx %d", value);
359     break;
360   }
361
362   case SIMCALL_COMM_TESTANY:
363     if (value == -1) {
364       type = "TestAny FALSE";
365       args = xbt_strdup("-");
366     } else {
367       type = "TestAny";
368       args =
369           bprintf("(%d of %zu)", value + 1,
370                   read_length(mc_model_checker->process(),
371                     simcall_comm_testany__get__comms(req)));
372     }
373     break;
374
375   case SIMCALL_MUTEX_TRYLOCK:
376   case SIMCALL_MUTEX_LOCK: {
377     if (req->call == SIMCALL_MUTEX_LOCK)
378       type = "Mutex LOCK";
379     else
380       type = "Mutex TRYLOCK";
381
382     s_smx_mutex_t mutex;
383     mc_model_checker->process().read_bytes(&mutex, sizeof(mutex),
384       remote(
385         req->call == SIMCALL_MUTEX_LOCK
386         ? simcall_mutex_lock__get__mutex(req)
387         : simcall_mutex_trylock__get__mutex(req)
388       ));
389     s_xbt_swag_t mutex_sleeping;
390     mc_model_checker->process().read_bytes(&mutex_sleeping, sizeof(mutex_sleeping),
391       remote(mutex.sleeping));
392
393     args = bprintf("locked = %d, owner = %d, sleeping = %d",
394       mutex.locked,
395       mutex.owner != nullptr ? (int) MC_smx_resolve_process(simgrid::mc::remote(mutex.owner))->pid : -1,
396       mutex_sleeping.count);
397     break;
398   }
399
400   case SIMCALL_MC_RANDOM:
401     type = "MC_RANDOM";
402     args = bprintf("%d", value);
403     break;
404
405   default:
406     THROW_UNIMPLEMENTED;
407   }
408
409   std::string str;
410   if (args != nullptr)
411     str = simgrid::xbt::string_printf("[(%lu)%s (%s)] %s(%s)", issuer->pid,
412                 MC_smx_process_get_host_name(issuer),
413                 MC_smx_process_get_name(issuer),
414                 type, args);
415   else
416     str = simgrid::xbt::string_printf("[(%lu)%s (%s)] %s ", issuer->pid,
417                 MC_smx_process_get_host_name(issuer),
418                 MC_smx_process_get_name(issuer),
419                 type);
420   xbt_free(args);
421   return str;
422 }
423
424 namespace simgrid {
425 namespace mc {
426
427 bool request_is_enabled_by_idx(smx_simcall_t req, unsigned int idx)
428 {
429   smx_synchro_t remote_act = nullptr;
430   switch (req->call) {
431
432   case SIMCALL_COMM_WAIT:
433     /* FIXME: check also that src and dst processes are not suspended */
434     remote_act = simcall_comm_wait__get__comm(req);
435     break;
436
437   case SIMCALL_COMM_WAITANY: {
438     read_element(
439       mc_model_checker->process(), &remote_act,
440       remote(simcall_comm_waitany__get__comms(req)),
441       idx, sizeof(remote_act));
442     }
443     break;
444
445   case SIMCALL_COMM_TESTANY: {
446     read_element(
447       mc_model_checker->process(), &remote_act,
448       remote(simcall_comm_testany__get__comms(req)),
449       idx, sizeof(remote_act));
450     }
451     break;
452
453   default:
454     return true;
455   }
456
457   s_smx_synchro_t synchro;
458   mc_model_checker->process().read_bytes(
459     &synchro, sizeof(synchro), remote(remote_act));
460   return synchro.comm.src_proc && synchro.comm.dst_proc;
461 }
462
463 bool process_is_enabled(smx_process_t process)
464 {
465   return simgrid::mc::request_is_enabled(&process->simcall);
466 }
467
468 static const char* colors[] = {
469   "blue",
470   "red",
471   "green3",
472   "goldenrod",
473   "brown",
474   "purple",
475   "magenta",
476   "turquoise4",
477   "gray25",
478   "forestgreen",
479   "hotpink",
480   "lightblue",
481   "tan",
482 };
483
484 static inline const char* get_color(int id)
485 {
486   return colors[id % (sizeof(colors) / sizeof(colors[0])) ];
487 }
488
489 std::string request_get_dot_output(smx_simcall_t req, int value)
490 {
491   std::string label;
492
493   const smx_process_t issuer = MC_smx_simcall_get_issuer(req);
494
495   switch (req->call) {
496   case SIMCALL_COMM_ISEND:
497     if (issuer->host)
498       label = simgrid::xbt::string_printf("[(%lu)%s] iSend", issuer->pid,
499                   MC_smx_process_get_host_name(issuer));
500     else
501       label = bprintf("[(%lu)] iSend", issuer->pid);
502     break;
503
504   case SIMCALL_COMM_IRECV:
505     if (issuer->host)
506       label = simgrid::xbt::string_printf("[(%lu)%s] iRecv", issuer->pid,
507                   MC_smx_process_get_host_name(issuer));
508     else
509       label = simgrid::xbt::string_printf("[(%lu)] iRecv", issuer->pid);
510     break;
511
512   case SIMCALL_COMM_WAIT: {
513     if (value == -1) {
514       if (issuer->host)
515         label = simgrid::xbt::string_printf("[(%lu)%s] WaitTimeout", issuer->pid,
516                     MC_smx_process_get_host_name(issuer));
517       else
518         label = simgrid::xbt::string_printf("[(%lu)] WaitTimeout", issuer->pid);
519     } else {
520       smx_synchro_t remote_act = simcall_comm_wait__get__comm(req);
521       s_smx_synchro_t synchro;
522       mc_model_checker->process().read_bytes(&synchro,
523         sizeof(synchro), remote(remote_act));
524
525       smx_process_t src_proc = MC_smx_resolve_process(simgrid::mc::remote(synchro.comm.src_proc));
526       smx_process_t dst_proc = MC_smx_resolve_process(simgrid::mc::remote(synchro.comm.dst_proc));
527       if (issuer->host)
528         label = simgrid::xbt::string_printf("[(%lu)%s] Wait [(%lu)->(%lu)]",
529                     issuer->pid,
530                     MC_smx_process_get_host_name(issuer),
531                     src_proc ? src_proc->pid : 0,
532                     dst_proc ? dst_proc->pid : 0);
533       else
534         label = simgrid::xbt::string_printf("[(%lu)] Wait [(%lu)->(%lu)]",
535                     issuer->pid,
536                     src_proc ? src_proc->pid : 0,
537                     dst_proc ? dst_proc->pid : 0);
538     }
539     break;
540   }
541
542   case SIMCALL_COMM_TEST: {
543     smx_synchro_t remote_act = simcall_comm_test__get__comm(req);
544     s_smx_synchro_t synchro;
545     mc_model_checker->process().read_bytes(&synchro,
546       sizeof(synchro), remote(remote_act));
547     if (synchro.comm.src_proc == nullptr || synchro.comm.dst_proc == nullptr) {
548       if (issuer->host)
549         label = simgrid::xbt::string_printf("[(%lu)%s] Test FALSE",
550                     issuer->pid,
551                     MC_smx_process_get_host_name(issuer));
552       else
553         label = bprintf("[(%lu)] Test FALSE", issuer->pid);
554     } else {
555       if (issuer->host)
556         label = simgrid::xbt::string_printf("[(%lu)%s] Test TRUE", issuer->pid,
557                     MC_smx_process_get_host_name(issuer));
558       else
559         label = simgrid::xbt::string_printf("[(%lu)] Test TRUE", issuer->pid);
560     }
561     break;
562   }
563
564   case SIMCALL_COMM_WAITANY: {
565     unsigned long comms_size = read_length(
566       mc_model_checker->process(), remote(simcall_comm_waitany__get__comms(req)));
567     if (issuer->host)
568       label = simgrid::xbt::string_printf("[(%lu)%s] WaitAny [%d of %lu]",
569                   issuer->pid,
570                   MC_smx_process_get_host_name(issuer), value + 1,
571                   comms_size);
572     else
573       label = simgrid::xbt::string_printf("[(%lu)] WaitAny [%d of %lu]",
574                   issuer->pid, value + 1, comms_size);
575     break;
576   }
577
578   case SIMCALL_COMM_TESTANY:
579     if (value == -1) {
580       if (issuer->host)
581         label = simgrid::xbt::string_printf("[(%lu)%s] TestAny FALSE",
582                     issuer->pid, MC_smx_process_get_host_name(issuer));
583       else
584         label = simgrid::xbt::string_printf("[(%lu)] TestAny FALSE", issuer->pid);
585     } else {
586       if (issuer->host)
587         label = simgrid::xbt::string_printf("[(%lu)%s] TestAny TRUE [%d of %lu]",
588                     issuer->pid,
589                     MC_smx_process_get_host_name(issuer), value + 1,
590                     xbt_dynar_length(simcall_comm_testany__get__comms(req)));
591       else
592         label = simgrid::xbt::string_printf("[(%lu)] TestAny TRUE [%d of %lu]",
593                     issuer->pid,
594                     value + 1,
595                     xbt_dynar_length(simcall_comm_testany__get__comms(req)));
596     }
597     break;
598
599   case SIMCALL_MUTEX_TRYLOCK:
600     label = simgrid::xbt::string_printf("[(%lu)] Mutex TRYLOCK", issuer->pid);
601     break;
602
603   case SIMCALL_MUTEX_LOCK:
604     label = simgrid::xbt::string_printf("[(%lu)] Mutex LOCK", issuer->pid);
605     break;
606
607   case SIMCALL_MC_RANDOM:
608     if (issuer->host)
609       label = simgrid::xbt::string_printf("[(%lu)%s] MC_RANDOM (%d)",
610                   issuer->pid, MC_smx_process_get_host_name(issuer), value);
611     else
612       label = simgrid::xbt::string_printf("[(%lu)] MC_RANDOM (%d)", issuer->pid, value);
613     break;
614
615   default:
616     THROW_UNIMPLEMENTED;
617   }
618
619   const char* color = get_color(issuer->pid - 1);
620   return  simgrid::xbt::string_printf(
621         "label = \"%s\", color = %s, fontcolor = %s", label.c_str(),
622         color, color);
623 }
624
625 }
626 }