Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
[mc] Remove useless extern "C" around logging categories
[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
14 #include "src/mc/mc_request.h"
15 #include "src/mc/mc_safety.h"
16 #include "src/mc/mc_private.h"
17 #include "src/mc/mc_smx.h"
18 #include "src/mc/mc_xbt.hpp"
19
20 using simgrid::mc::remote;
21
22 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_request, mc,
23                                 "Logging specific to MC (request)");
24
25 static char *pointer_to_string(void *pointer);
26 static char *buff_size_to_string(size_t size);
27
28 static inline
29 smx_synchro_t MC_get_comm(smx_simcall_t r)
30 {
31   switch (r->call ) {
32   case SIMCALL_COMM_WAIT:
33     return simcall_comm_wait__get__comm(r);
34   case SIMCALL_COMM_TEST:
35     return simcall_comm_test__get__comm(r);
36   default:
37     return nullptr;
38   }
39 }
40
41 static inline
42 smx_mailbox_t MC_get_rdv(smx_simcall_t r)
43 {
44   switch(r->call) {
45   case SIMCALL_COMM_ISEND:
46     return simcall_comm_isend__get__rdv(r);
47   case SIMCALL_COMM_IRECV:
48     return simcall_comm_irecv__get__rdv(r);
49   default:
50     return nullptr;
51   }
52 }
53
54 namespace simgrid {
55 namespace mc {
56
57 // Does half the job
58 static inline
59 bool request_depend_asymmetric(smx_simcall_t r1, smx_simcall_t r2)
60 {
61   if (r1->call == SIMCALL_COMM_ISEND && r2->call == SIMCALL_COMM_IRECV)
62     return false;
63
64   if (r1->call == SIMCALL_COMM_IRECV && r2->call == SIMCALL_COMM_ISEND)
65     return false;
66
67   // Those are internal requests, we do not need indirection
68   // because those objects are copies:
69   smx_synchro_t synchro1 = MC_get_comm(r1);
70   smx_synchro_t synchro2 = MC_get_comm(r2);
71
72   if ((r1->call == SIMCALL_COMM_ISEND || r1->call == SIMCALL_COMM_IRECV)
73       && r2->call == SIMCALL_COMM_WAIT) {
74
75     smx_mailbox_t rdv = MC_get_rdv(r1);
76
77     if (rdv != synchro2->comm.rdv_cpy
78         && simcall_comm_wait__get__timeout(r2) <= 0)
79       return false;
80
81     if ((r1->issuer != synchro2->comm.src_proc)
82         && (r1->issuer != synchro2->comm.dst_proc)
83         && simcall_comm_wait__get__timeout(r2) <= 0)
84       return false;
85
86     if ((r1->call == SIMCALL_COMM_ISEND)
87         && (synchro2->comm.type == SIMIX_COMM_SEND)
88         && (synchro2->comm.src_buff !=
89             simcall_comm_isend__get__src_buff(r1))
90         && simcall_comm_wait__get__timeout(r2) <= 0)
91       return false;
92
93     if ((r1->call == SIMCALL_COMM_IRECV)
94         && (synchro2->comm.type == SIMIX_COMM_RECEIVE)
95         && (synchro2->comm.dst_buff != simcall_comm_irecv__get__dst_buff(r1))
96         && simcall_comm_wait__get__timeout(r2) <= 0)
97       return false;
98   }
99
100   /* FIXME: the following rule assumes that the result of the
101    * isend/irecv call is not stored in a buffer used in the
102    * test call. */
103   /*if(   (r1->call == SIMCALL_COMM_ISEND || r1->call == SIMCALL_COMM_IRECV)
104      &&  r2->call == SIMCALL_COMM_TEST)
105      return FALSE; */
106
107   if (r1->call == SIMCALL_COMM_WAIT
108       && (r2->call == SIMCALL_COMM_WAIT || r2->call == SIMCALL_COMM_TEST)
109       && (synchro1->comm.src_proc == nullptr || synchro1->comm.dst_proc == NULL))
110     return false;
111
112   if (r1->call == SIMCALL_COMM_TEST &&
113       (simcall_comm_test__get__comm(r1) == nullptr
114        || synchro1->comm.src_buff == nullptr
115        || synchro1->comm.dst_buff == nullptr))
116     return false;
117
118   if (r1->call == SIMCALL_COMM_TEST && r2->call == SIMCALL_COMM_WAIT
119       && synchro1->comm.src_buff == synchro2->comm.src_buff
120       && synchro1->comm.dst_buff == synchro2->comm.dst_buff)
121     return false;
122
123   if (r1->call == SIMCALL_COMM_WAIT && r2->call == SIMCALL_COMM_TEST
124       && synchro1->comm.src_buff != nullptr
125       && synchro1->comm.dst_buff != nullptr
126       && synchro2->comm.src_buff != nullptr
127       && synchro2->comm.dst_buff != nullptr
128       && synchro1->comm.dst_buff != synchro2->comm.src_buff
129       && synchro1->comm.dst_buff != synchro2->comm.dst_buff
130       && synchro2->comm.dst_buff != synchro1->comm.src_buff)
131     return false;
132
133   return true;
134 }
135
136 // Those are MC_state_get_internal_request(state)
137 bool request_depend(smx_simcall_t r1, smx_simcall_t r2)
138 {
139   if (simgrid::mc::reduction_mode == simgrid::mc::ReductionMode::none)
140     return true;
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 char *simgrid::mc::request_to_string(smx_simcall_t req, int value, simgrid::mc::RequestType request_type)
207 {
208   bool use_remote_comm = true;
209   switch(request_type) {
210   case simgrid::mc::RequestType::simix:
211     use_remote_comm = true;
212     break;
213   case simgrid::mc::RequestType::executed:
214   case simgrid::mc::RequestType::internal:
215     use_remote_comm = false;
216     break;
217   }
218
219   const char* type = nullptr;
220   char *args = nullptr;
221
222   smx_process_t issuer = MC_smx_simcall_get_issuer(req);
223
224   switch (req->call) {
225
226   case SIMCALL_COMM_ISEND: {
227     type = "iSend";
228     char* p = pointer_to_string(simcall_comm_isend__get__src_buff(req));
229     char* bs = buff_size_to_string(simcall_comm_isend__get__src_buff_size(req));
230     if (issuer->host)
231       args =
232           bprintf("src=(%lu)%s (%s), buff=%s, size=%s", issuer->pid,
233                   MC_smx_process_get_host_name(issuer),
234                   MC_smx_process_get_name(issuer),
235                   p, bs);
236     else
237       args =
238           bprintf("src=(%lu)%s, buff=%s, size=%s", issuer->pid,
239                   MC_smx_process_get_name(issuer), p, bs);
240     xbt_free(bs);
241     xbt_free(p);
242     break;
243   }
244
245   case SIMCALL_COMM_IRECV: {
246     size_t* remote_size = simcall_comm_irecv__get__dst_buff_size(req);
247
248     // size_t size = size_pointer ? *size_pointer : 0;
249     size_t size = 0;
250     if (remote_size)
251       mc_model_checker->process().read_bytes(&size, sizeof(size),
252         remote(remote_size));
253
254     type = "iRecv";
255     char* p = pointer_to_string(simcall_comm_irecv__get__dst_buff(req));
256     char* bs = buff_size_to_string(size);
257     if (issuer->host)
258       args =
259           bprintf("dst=(%lu)%s (%s), buff=%s, size=%s", issuer->pid,
260                   MC_smx_process_get_host_name(issuer),
261                   MC_smx_process_get_name(issuer),
262                   p, bs);
263     else
264       args =
265           bprintf("dst=(%lu)%s, buff=%s, size=%s", issuer->pid,
266                   MC_smx_process_get_name(issuer),
267                   p, bs);
268     xbt_free(bs);
269     xbt_free(p);
270     break;
271   }
272
273   case SIMCALL_COMM_WAIT: {
274     smx_synchro_t remote_act = simcall_comm_wait__get__comm(req);
275     char* p;
276     if (value == -1) {
277       type = "WaitTimeout";
278       p = pointer_to_string(remote_act);
279       args = bprintf("comm=%s", p);
280     } else {
281       type = "Wait";
282       p = pointer_to_string(remote_act);
283
284       s_smx_synchro_t synchro;
285       smx_synchro_t act;
286       if (use_remote_comm) {
287         mc_model_checker->process().read_bytes(&synchro,
288           sizeof(synchro), remote(remote_act));
289         act = &synchro;
290       } else
291         act = remote_act;
292
293       smx_process_t src_proc = MC_smx_resolve_process(act->comm.src_proc);
294       smx_process_t dst_proc = MC_smx_resolve_process(act->comm.dst_proc);
295       args = bprintf("comm=%s [(%lu)%s (%s)-> (%lu)%s (%s)]", p,
296                      src_proc ? src_proc->pid : 0,
297                      src_proc ? MC_smx_process_get_host_name(src_proc) : "",
298                      src_proc ? MC_smx_process_get_name(src_proc) : "",
299                      dst_proc ? dst_proc->pid : 0,
300                      dst_proc ? MC_smx_process_get_host_name(dst_proc) : "",
301                      dst_proc ? MC_smx_process_get_name(dst_proc) : "");
302     }
303     xbt_free(p);
304     break;
305   }
306
307   case SIMCALL_COMM_TEST: {
308     smx_synchro_t remote_act = simcall_comm_test__get__comm(req);
309     s_smx_synchro_t synchro;
310       smx_synchro_t act;
311       if (use_remote_comm) {
312         mc_model_checker->process().read_bytes(&synchro,
313           sizeof(synchro), remote(remote_act));
314         act = &synchro;
315       } else
316         act = remote_act;
317
318     char* p;
319     if (act->comm.src_proc == nullptr || act->comm.dst_proc == NULL) {
320       type = "Test FALSE";
321       p = pointer_to_string(remote_act);
322       args = bprintf("comm=%s", p);
323     } else {
324       type = "Test TRUE";
325       p = pointer_to_string(remote_act);
326
327       smx_process_t src_proc = MC_smx_resolve_process(act->comm.src_proc);
328       smx_process_t dst_proc = MC_smx_resolve_process(act->comm.dst_proc);
329       args = bprintf("comm=%s [(%lu)%s (%s) -> (%lu)%s (%s)]", p,
330                      src_proc->pid,
331                      MC_smx_process_get_name(src_proc),
332                      MC_smx_process_get_host_name(src_proc),
333                      dst_proc->pid,
334                      MC_smx_process_get_name(dst_proc),
335                      MC_smx_process_get_host_name(dst_proc));
336     }
337     xbt_free(p);
338     break;
339   }
340
341   case SIMCALL_COMM_WAITANY: {
342     type = "WaitAny";
343     s_xbt_dynar_t comms;
344     mc_model_checker->process().read_bytes(
345       &comms, sizeof(comms), remote(simcall_comm_waitany__get__comms(req)));
346     if (!xbt_dynar_is_empty(&comms)) {
347       smx_synchro_t remote_sync;
348       read_element(mc_model_checker->process(),
349         &remote_sync, remote(simcall_comm_waitany__get__comms(req)), value,
350         sizeof(remote_sync));
351       char* p = pointer_to_string(remote_sync);
352       args = bprintf("comm=%s (%d of %lu)",
353         p, value + 1, xbt_dynar_length(&comms));
354       xbt_free(p);
355     } else
356       args = bprintf("comm at idx %d", value);
357     break;
358   }
359
360   case SIMCALL_COMM_TESTANY:
361     if (value == -1) {
362       type = "TestAny FALSE";
363       args = xbt_strdup("-");
364     } else {
365       type = "TestAny";
366       args =
367           bprintf("(%d of %zu)", value + 1,
368                   read_length(mc_model_checker->process(),
369                     simcall_comm_testany__get__comms(req)));
370     }
371     break;
372
373   case SIMCALL_MUTEX_TRYLOCK:
374   case SIMCALL_MUTEX_LOCK: {
375     if (req->call == SIMCALL_MUTEX_LOCK)
376       type = "Mutex LOCK";
377     else
378       type = "Mutex TRYLOCK";
379
380     s_smx_mutex_t mutex;
381     mc_model_checker->process().read_bytes(&mutex, sizeof(mutex),
382       remote(
383         req->call == SIMCALL_MUTEX_LOCK
384         ? simcall_mutex_lock__get__mutex(req)
385         : simcall_mutex_trylock__get__mutex(req)
386       ));
387     s_xbt_swag_t mutex_sleeping;
388     mc_model_checker->process().read_bytes(&mutex_sleeping, sizeof(mutex_sleeping),
389       remote(mutex.sleeping));
390
391     args = bprintf("locked = %d, owner = %d, sleeping = %d",
392       mutex.locked,
393       mutex.owner != nullptr ? (int) MC_smx_resolve_process(mutex.owner)->pid : -1,
394       mutex_sleeping.count);
395     break;
396   }
397
398   case SIMCALL_MC_RANDOM:
399     type = "MC_RANDOM";
400     args = bprintf("%d", value);
401     break;
402
403   default:
404     THROW_UNIMPLEMENTED;
405   }
406
407   char* str;
408   if (args != nullptr)
409     str =
410         bprintf("[(%lu)%s (%s)] %s(%s)", issuer->pid,
411                 MC_smx_process_get_host_name(issuer),
412                 MC_smx_process_get_name(issuer),
413                 type, args);
414   else
415     str =
416         bprintf("[(%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 char *request_get_dot_output(smx_simcall_t req, int value)
469 {
470   char *label = nullptr;
471
472   const smx_process_t issuer = MC_smx_simcall_get_issuer(req);
473
474   switch (req->call) {
475   case SIMCALL_COMM_ISEND:
476     if (issuer->host)
477       label =
478           bprintf("[(%lu)%s] iSend", issuer->pid,
479                   MC_smx_process_get_host_name(issuer));
480     else
481       label = bprintf("[(%lu)] iSend", issuer->pid);
482     break;
483
484   case SIMCALL_COMM_IRECV:
485     if (issuer->host)
486       label =
487           bprintf("[(%lu)%s] iRecv", issuer->pid,
488                   MC_smx_process_get_host_name(issuer));
489     else
490       label = bprintf("[(%lu)] iRecv", issuer->pid);
491     break;
492
493   case SIMCALL_COMM_WAIT: {
494     if (value == -1) {
495       if (issuer->host)
496         label =
497             bprintf("[(%lu)%s] WaitTimeout", issuer->pid,
498                     MC_smx_process_get_host_name(issuer));
499       else
500         label = bprintf("[(%lu)] WaitTimeout", issuer->pid);
501     } else {
502       smx_synchro_t remote_act = simcall_comm_wait__get__comm(req);
503       s_smx_synchro_t synchro;
504       mc_model_checker->process().read_bytes(&synchro,
505         sizeof(synchro), remote(remote_act));
506
507       smx_process_t src_proc = MC_smx_resolve_process(synchro.comm.src_proc);
508       smx_process_t dst_proc = MC_smx_resolve_process(synchro.comm.dst_proc);
509       if (issuer->host)
510         label =
511             bprintf("[(%lu)%s] Wait [(%lu)->(%lu)]", issuer->pid,
512                     MC_smx_process_get_host_name(issuer),
513                     src_proc ? src_proc->pid : 0,
514                     dst_proc ? dst_proc->pid : 0);
515       else
516         label =
517             bprintf("[(%lu)] Wait [(%lu)->(%lu)]", issuer->pid,
518                     src_proc ? src_proc->pid : 0,
519                     dst_proc ? dst_proc->pid : 0);
520     }
521     break;
522   }
523
524   case SIMCALL_COMM_TEST: {
525     smx_synchro_t remote_act = simcall_comm_test__get__comm(req);
526     s_smx_synchro_t synchro;
527     mc_model_checker->process().read_bytes(&synchro,
528       sizeof(synchro), remote(remote_act));
529     if (synchro.comm.src_proc == nullptr || synchro.comm.dst_proc == NULL) {
530       if (issuer->host)
531         label =
532             bprintf("[(%lu)%s] Test FALSE", issuer->pid,
533                     MC_smx_process_get_host_name(issuer));
534       else
535         label = bprintf("[(%lu)] Test FALSE", issuer->pid);
536     } else {
537       if (issuer->host)
538         label =
539             bprintf("[(%lu)%s] Test TRUE", issuer->pid,
540                     MC_smx_process_get_host_name(issuer));
541       else
542         label = bprintf("[(%lu)] Test TRUE", issuer->pid);
543     }
544     break;
545   }
546
547   case SIMCALL_COMM_WAITANY: {
548     unsigned long comms_size = read_length(
549       mc_model_checker->process(), remote(simcall_comm_waitany__get__comms(req)));
550     if (issuer->host)
551       label =
552           bprintf("[(%lu)%s] WaitAny [%d of %lu]", issuer->pid,
553                   MC_smx_process_get_host_name(issuer), value + 1,
554                   comms_size);
555     else
556       label =
557           bprintf("[(%lu)] WaitAny [%d of %lu]", issuer->pid, value + 1,
558                   comms_size);
559     break;
560   }
561
562   case SIMCALL_COMM_TESTANY:
563     if (value == -1) {
564       if (issuer->host)
565         label =
566             bprintf("[(%lu)%s] TestAny FALSE", issuer->pid,
567                     MC_smx_process_get_host_name(issuer));
568       else
569         label = bprintf("[(%lu)] TestAny FALSE", issuer->pid);
570     } else {
571       if (issuer->host)
572         label =
573             bprintf("[(%lu)%s] TestAny TRUE [%d of %lu]", issuer->pid,
574                     MC_smx_process_get_host_name(issuer), value + 1,
575                     xbt_dynar_length(simcall_comm_testany__get__comms(req)));
576       else
577         label =
578             bprintf("[(%lu)] TestAny TRUE [%d of %lu]", issuer->pid,
579                     value + 1,
580                     xbt_dynar_length(simcall_comm_testany__get__comms(req)));
581     }
582     break;
583
584   case SIMCALL_MUTEX_TRYLOCK:
585     label = bprintf("[(%lu)] Mutex TRYLOCK", issuer->pid);
586     break;
587
588   case SIMCALL_MUTEX_LOCK:
589     label = bprintf("[(%lu)] Mutex LOCK", issuer->pid);
590     break;
591
592   case SIMCALL_MC_RANDOM:
593     if (issuer->host)
594       label =
595           bprintf("[(%lu)%s] MC_RANDOM (%d)", issuer->pid,
596                   MC_smx_process_get_host_name(issuer), value);
597     else
598       label = bprintf("[(%lu)] MC_RANDOM (%d)", issuer->pid, value);
599     break;
600
601   default:
602     THROW_UNIMPLEMENTED;
603   }
604
605   char* str =
606       bprintf("label = \"%s\", color = %s, fontcolor = %s", label,
607               colors[issuer->pid - 1], colors[issuer->pid - 1]);
608   xbt_free(label);
609   return str;
610
611 }
612
613 }
614 }