1 /* Copyright (c) 2008-2014. 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. */
7 #include "mc_private.h"
9 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_comm_determinism, mc,
10 "Logging specific to MC communication determinism detection");
12 /********** Global variables **********/
14 xbt_dynar_t initial_communications_pattern;
15 xbt_dynar_t incomplete_communications_pattern;
16 xbt_dynar_t communications_pattern;
19 /********** Static functions ***********/
21 static void comm_pattern_free(mc_comm_pattern_t p)
29 static void comm_pattern_free_voidp(void *p)
31 comm_pattern_free((mc_comm_pattern_t) * (void **) p);
34 static mc_comm_pattern_t get_comm_pattern_from_idx(xbt_dynar_t pattern,
36 e_smx_comm_type_t type,
39 mc_comm_pattern_t current_comm;
40 while (*idx < xbt_dynar_length(pattern)) {
42 (mc_comm_pattern_t) xbt_dynar_get_as(pattern, *idx, mc_comm_pattern_t);
43 if (current_comm->type == type && type == SIMIX_COMM_SEND) {
44 if (current_comm->src_proc == proc)
46 } else if (current_comm->type == type && type == SIMIX_COMM_RECEIVE) {
47 if (current_comm->dst_proc == proc)
55 static int compare_comm_pattern(mc_comm_pattern_t comm1,
56 mc_comm_pattern_t comm2)
58 if (strcmp(comm1->rdv, comm2->rdv) != 0)
60 if (comm1->src_proc != comm2->src_proc)
62 if (comm1->dst_proc != comm2->dst_proc)
64 if (comm1->data_size != comm2->data_size)
66 if (memcmp(comm1->data, comm2->data, comm1->data_size) != 0)
71 static void deterministic_pattern(xbt_dynar_t pattern, int partial)
74 unsigned int cursor = 0, send_index = 0, recv_index = 0;
75 mc_comm_pattern_t comm1, comm2;
76 unsigned int current_process = 1; /* Process 0 corresponds to maestro */
77 unsigned int nb_comms1, nb_comms2;
78 xbt_dynar_t process_comms_pattern1, process_comms_pattern2;
80 while (current_process < simix_process_maxpid) {
81 process_comms_pattern1 = (xbt_dynar_t)xbt_dynar_get_as(initial_communications_pattern, current_process, xbt_dynar_t);
82 process_comms_pattern2 = (xbt_dynar_t)xbt_dynar_get_as(pattern, current_process, xbt_dynar_t);
83 nb_comms1 = xbt_dynar_length(process_comms_pattern1);
84 nb_comms2 = xbt_dynar_length(process_comms_pattern2);
85 if(!xbt_dynar_is_empty((xbt_dynar_t)xbt_dynar_get_as(incomplete_communications_pattern, current_process, xbt_dynar_t)))
86 xbt_die("Damn ! Some communications from the process %u are incomplete (%lu)! That means one or several simcalls are not handle.", current_process, xbt_dynar_length((xbt_dynar_t)xbt_dynar_get_as(incomplete_communications_pattern, current_process, xbt_dynar_t)));
87 if (!partial && (nb_comms1 != nb_comms2)) {
88 XBT_INFO("The total number of communications is different between the compared patterns for the process %u.\n Communication determinism verification for this process cannot be performed.", current_process);
89 initial_global_state->send_deterministic = -1;
90 initial_global_state->comm_deterministic = -1;
92 while (cursor < nb_comms2) {
93 comm1 = (mc_comm_pattern_t)xbt_dynar_get_as(process_comms_pattern1, cursor, mc_comm_pattern_t);
94 if (comm1->type == SIMIX_COMM_SEND) {
95 comm2 = get_comm_pattern_from_idx(process_comms_pattern2, &send_index, comm1->type, current_process);
96 if (compare_comm_pattern(comm1, comm2)) {
97 XBT_INFO("The communications pattern of the process %u is different! (Different communication : %u)", current_process, cursor+1);
98 initial_global_state->send_deterministic = 0;
99 initial_global_state->comm_deterministic = 0;
103 } else if (comm1->type == SIMIX_COMM_RECEIVE) {
104 comm2 = get_comm_pattern_from_idx(process_comms_pattern2, &recv_index, comm1->type, current_process);
105 if (compare_comm_pattern(comm1, comm2)) {
106 initial_global_state->comm_deterministic = 0;
107 if (!_sg_mc_send_determinism){
108 XBT_INFO("The communications pattern of the process %u is different! (Different communication : %u)", current_process, cursor+1);
124 static void print_communications_pattern(xbt_dynar_t comms_pattern)
126 unsigned int cursor = 0;
127 mc_comm_pattern_t current_comm;
128 unsigned int current_process = 1;
129 xbt_dynar_t current_pattern;
130 while (current_process < simix_process_maxpid) {
131 current_pattern = (xbt_dynar_t)xbt_dynar_get_as(comms_pattern, current_process, xbt_dynar_t);
132 XBT_INFO("Communications from the process %u:", current_process);
133 xbt_dynar_foreach(current_pattern, cursor, current_comm) {
134 if (current_comm->type == SIMIX_COMM_SEND) {
135 XBT_INFO("[(%lu) %s -> (%lu) %s] %s ", current_comm->src_proc,
136 current_comm->src_host, current_comm->dst_proc,
137 current_comm->dst_host, "iSend");
139 XBT_INFO("[(%lu) %s <- (%lu) %s] %s ", current_comm->dst_proc,
140 current_comm->dst_host, current_comm->src_proc,
141 current_comm->src_host, "iRecv");
149 static void update_comm_pattern(mc_comm_pattern_t comm_pattern, smx_action_t comm)
152 comm_pattern->src_proc = comm->comm.src_proc->pid;
153 comm_pattern->dst_proc = comm->comm.dst_proc->pid;
154 comm_pattern->src_host =
155 simcall_host_get_name(comm->comm.src_proc->smx_host);
156 comm_pattern->dst_host =
157 simcall_host_get_name(comm->comm.dst_proc->smx_host);
158 if (comm_pattern->data_size == -1) {
159 comm_pattern->data_size = *(comm->comm.dst_buff_size);
160 comm_pattern->data = xbt_malloc0(comm_pattern->data_size);
161 addr_pointed = *(void **) comm->comm.src_buff;
162 if (addr_pointed > (void*) std_heap && addr_pointed < std_heap->breakval)
163 memcpy(comm_pattern->data, addr_pointed, comm_pattern->data_size);
165 memcpy(comm_pattern->data, comm->comm.src_buff, comm_pattern->data_size);
169 /********** Non Static functions ***********/
171 void get_comm_pattern(xbt_dynar_t list, smx_simcall_t request, mc_call_type call_type)
173 mc_comm_pattern_t pattern = NULL;
174 pattern = xbt_new0(s_mc_comm_pattern_t, 1);
175 pattern->num = ++nb_comm_pattern;
176 pattern->data_size = -1;
178 if (call_type == MC_CALL_TYPE_SEND) { // ISEND
179 pattern->type = SIMIX_COMM_SEND;
180 pattern->comm = simcall_comm_isend__get__result(request);
181 pattern->src_proc = pattern->comm->comm.src_proc->pid;
182 pattern->src_host = simcall_host_get_name(request->issuer->smx_host);
183 pattern->data_size = pattern->comm->comm.src_buff_size;
184 pattern->data = xbt_malloc0(pattern->data_size);
185 addr_pointed = *(void **) pattern->comm->comm.src_buff;
186 if (addr_pointed > (void*) std_heap && addr_pointed < std_heap->breakval)
187 memcpy(pattern->data, addr_pointed, pattern->data_size);
189 memcpy(pattern->data, pattern->comm->comm.src_buff, pattern->data_size);
190 } else if (call_type == MC_CALL_TYPE_RECV) { // IRECV
191 pattern->type = SIMIX_COMM_RECEIVE;
192 pattern->comm = simcall_comm_irecv__get__result(request);
193 pattern->dst_proc = pattern->comm->comm.dst_proc->pid;
194 pattern->dst_host = simcall_host_get_name(request->issuer->smx_host);
196 xbt_die("Unexpected call_type %i", (int) call_type);
199 if (pattern->comm->comm.rdv != NULL)
200 pattern->rdv = strdup(pattern->comm->comm.rdv->name);
202 pattern->rdv = strdup(pattern->comm->comm.rdv_cpy->name);
204 xbt_dynar_push((xbt_dynar_t)xbt_dynar_get_as(list, request->issuer->pid, xbt_dynar_t), &pattern);
206 xbt_dynar_push_as((xbt_dynar_t)xbt_dynar_get_as(incomplete_communications_pattern, request->issuer->pid, xbt_dynar_t), int, xbt_dynar_length((xbt_dynar_t)xbt_dynar_get_as(list, request->issuer->pid, xbt_dynar_t)) - 1);
210 void complete_comm_pattern(xbt_dynar_t list, smx_action_t comm)
212 mc_comm_pattern_t current_comm_pattern;
213 unsigned int cursor = 0;
215 unsigned int src = comm->comm.src_proc->pid;
216 unsigned int dst = comm->comm.dst_proc->pid;
217 int src_completed = 0, dst_completed = 0;
219 /* Looking for the corresponding communication in the comm pattern list of the src process */
220 xbt_dynar_foreach((xbt_dynar_t)xbt_dynar_get_as(incomplete_communications_pattern, src, xbt_dynar_t), cursor, index){
221 current_comm_pattern = (mc_comm_pattern_t) xbt_dynar_get_as((xbt_dynar_t)xbt_dynar_get_as(list, src, xbt_dynar_t), index, mc_comm_pattern_t);
222 if(current_comm_pattern->comm == comm){
223 update_comm_pattern(current_comm_pattern, comm);
224 xbt_dynar_remove_at((xbt_dynar_t)xbt_dynar_get_as(incomplete_communications_pattern, src, xbt_dynar_t), cursor, NULL);
231 xbt_die("Corresponding communication for the source process not found!");
235 /* Looking for the corresponding communication in the comm pattern list of the dst process */
236 xbt_dynar_foreach((xbt_dynar_t)xbt_dynar_get_as(incomplete_communications_pattern, dst, xbt_dynar_t), cursor, index){
237 current_comm_pattern = (mc_comm_pattern_t) xbt_dynar_get_as((xbt_dynar_t)xbt_dynar_get_as(list, dst, xbt_dynar_t), index, mc_comm_pattern_t);
238 if(current_comm_pattern->comm == comm){
239 update_comm_pattern(current_comm_pattern, comm);
240 xbt_dynar_remove_at((xbt_dynar_t)xbt_dynar_get_as(incomplete_communications_pattern, dst, xbt_dynar_t), cursor, NULL);
247 xbt_die("Corresponding communication for the dest process not found!");
252 /************************ Main algorithm ************************/
254 void MC_pre_modelcheck_comm_determinism(void)
257 int mc_mem_set = (mmalloc_get_current_heap() == mc_heap);
259 mc_state_t initial_state = NULL;
260 smx_process_t process;
266 if (_sg_mc_visited > 0)
267 visited_states = xbt_dynar_new(sizeof(mc_visited_state_t), visited_state_free_voidp);
269 initial_communications_pattern = xbt_dynar_new(sizeof(xbt_dynar_t), xbt_dynar_free_voidp);
270 for (i=0; i<simix_process_maxpid; i++){
271 xbt_dynar_t process_pattern = xbt_dynar_new(sizeof(mc_comm_pattern_t), comm_pattern_free_voidp);
272 xbt_dynar_insert_at(initial_communications_pattern, i, &process_pattern);
274 communications_pattern = xbt_dynar_new(sizeof(xbt_dynar_t), xbt_dynar_free_voidp);
275 for (i=0; i<simix_process_maxpid; i++){
276 xbt_dynar_t process_pattern = xbt_dynar_new(sizeof(mc_comm_pattern_t), comm_pattern_free_voidp);
277 xbt_dynar_insert_at(communications_pattern, i, &process_pattern);
279 incomplete_communications_pattern = xbt_dynar_new(sizeof(xbt_dynar_t), xbt_dynar_free_voidp);
280 for (i=0; i<simix_process_maxpid; i++){
281 xbt_dynar_t process_pattern = xbt_dynar_new(sizeof(int), NULL);
282 xbt_dynar_insert_at(incomplete_communications_pattern, i, &process_pattern);
287 initial_state = MC_state_new();
291 XBT_DEBUG("********* Start communication determinism verification *********");
293 /* Wait for requests (schedules processes) */
294 MC_wait_for_requests();
298 /* Get an enabled process and insert it in the interleave set of the initial state */
299 xbt_swag_foreach(process, simix_global->process_list) {
300 if (MC_process_is_enabled(process)) {
301 MC_state_interleave_process(initial_state, process);
305 xbt_fifo_unshift(mc_stack, initial_state);
311 void MC_modelcheck_comm_determinism(void)
314 char *req_str = NULL;
316 mc_visited_state_t visited_state = NULL;
317 smx_simcall_t req = NULL;
318 smx_process_t process = NULL;
319 mc_state_t state = NULL, next_state = NULL;
320 xbt_dynar_t current_pattern;
322 while (xbt_fifo_size(mc_stack) > 0) {
324 /* Get current state */
327 xbt_fifo_get_item_content(xbt_fifo_get_first_item(mc_stack));
329 XBT_DEBUG("**************************************************");
330 XBT_DEBUG("Exploration depth = %d (state = %d, interleaved processes = %d)",
331 xbt_fifo_size(mc_stack), state->num,
332 MC_state_interleave_size(state));
334 /* Update statistics */
335 mc_stats->visited_states++;
337 if ((xbt_fifo_size(mc_stack) <= _sg_mc_max_depth)
338 && (req = MC_state_get_request(state, &value))
339 && (visited_state == NULL)) {
341 MC_LOG_REQUEST(mc_comm_determinism, req, value);
343 if (dot_output != NULL) {
345 req_str = MC_request_get_dot_output(req, value);
349 MC_state_set_executed_request(state, req, value);
350 mc_stats->executed_transitions++;
352 /* TODO : handle test and testany simcalls */
353 mc_call_type call = MC_CALL_TYPE_NONE;
354 if (_sg_mc_comms_determinism || _sg_mc_send_determinism) {
355 call = mc_get_call_type(req);
358 /* Answer the request */
359 SIMIX_simcall_enter(req, value); /* After this call req is no longer usefull */
362 current_pattern = !initial_global_state->initial_communications_pattern_done ? initial_communications_pattern : communications_pattern;
363 mc_update_comm_pattern(call, req, value, current_pattern);
366 /* Wait for requests (schedules processes) */
367 MC_wait_for_requests();
369 /* Create the new expanded state */
372 next_state = MC_state_new();
374 if ((visited_state = is_visited_state()) == NULL) {
376 /* Get enabled processes and insert them in the interleave set of the next state */
377 xbt_swag_foreach(process, simix_global->process_list) {
378 if (MC_process_is_enabled(process)) {
379 MC_state_interleave_process(next_state, process);
383 if (dot_output != NULL)
384 fprintf(dot_output, "\"%d\" -> \"%d\" [%s];\n", state->num,
385 next_state->num, req_str);
389 if (dot_output != NULL)
390 fprintf(dot_output, "\"%d\" -> \"%d\" [%s];\n", state->num,
391 visited_state->other_num == -1 ? visited_state->num : visited_state->other_num, req_str);
395 xbt_fifo_unshift(mc_stack, next_state);
397 if (dot_output != NULL)
404 if (xbt_fifo_size(mc_stack) > _sg_mc_max_depth) {
405 XBT_WARN("/!\\ Max depth reached ! /!\\ ");
406 } else if (visited_state != NULL) {
407 XBT_DEBUG("State already visited (equal to state %d), exploration stopped on this path.", visited_state->other_num == -1 ? visited_state->num : visited_state->other_num);
409 XBT_DEBUG("There are no more processes to interleave. (depth %d)", xbt_fifo_size(mc_stack));
414 if (initial_global_state->initial_communications_pattern_done) {
415 if (!visited_state) {
416 deterministic_pattern(communications_pattern, 0);
418 deterministic_pattern(communications_pattern, 1);
421 if (_sg_mc_comms_determinism && !initial_global_state->comm_deterministic) {
422 XBT_INFO("****************************************************");
423 XBT_INFO("***** Non-deterministic communications pattern *****");
424 XBT_INFO("****************************************************");
425 XBT_INFO("** Initial communications pattern (per process): **");
426 print_communications_pattern(initial_communications_pattern);
427 XBT_INFO("** Communications pattern counter-example (per process): **");
428 print_communications_pattern(communications_pattern);
429 MC_print_statistics(mc_stats);
432 } else if (_sg_mc_send_determinism && !initial_global_state->send_deterministic) {
434 ("*********************************************************");
436 ("***** Non-send-deterministic communications pattern *****");
438 ("*********************************************************");
439 XBT_INFO("** Initial communications pattern: **");
440 print_communications_pattern(initial_communications_pattern);
441 XBT_INFO("** Communications pattern counter-example: **");
442 print_communications_pattern(communications_pattern);
443 MC_print_statistics(mc_stats);
449 initial_global_state->initial_communications_pattern_done = 1;
452 /* Trash the current state, no longer needed */
453 xbt_fifo_shift(mc_stack);
454 MC_state_delete(state);
455 XBT_DEBUG("Delete state %d at depth %d", state->num,
456 xbt_fifo_size(mc_stack) + 1);
460 visited_state = NULL;
462 /* Check for deadlocks */
463 if (MC_deadlock_check()) {
464 MC_show_deadlock(NULL);
470 while ((state = xbt_fifo_shift(mc_stack)) != NULL) {
471 if (MC_state_interleave_size(state)
472 && xbt_fifo_size(mc_stack) < _sg_mc_max_depth) {
473 /* We found a back-tracking point, let's loop */
474 XBT_DEBUG("Back-tracking to state %d at depth %d", state->num,
475 xbt_fifo_size(mc_stack) + 1);
476 xbt_fifo_unshift(mc_stack, state);
479 MC_replay(mc_stack, -1);
481 XBT_DEBUG("Back-tracking to state %d at depth %d done", state->num,
482 xbt_fifo_size(mc_stack));
485 XBT_DEBUG("Delete state %d at depth %d", state->num,
486 xbt_fifo_size(mc_stack) + 1);
487 MC_state_delete(state);
495 MC_print_statistics(mc_stats);