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. */
8 #include "mc_comm_pattern.h"
9 #include "mc_request.h"
10 #include "mc_safety.h"
11 #include "mc_private.h"
12 #include "mc_record.h"
14 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_comm_determinism, mc,
15 "Logging specific to MC communication determinism detection");
17 /********** Global variables **********/
19 xbt_dynar_t initial_communications_pattern;
20 xbt_dynar_t incomplete_communications_pattern;
22 /********** Static functions ***********/
24 static void comm_pattern_free(mc_comm_pattern_t p)
32 static void list_comm_pattern_free(mc_list_comm_pattern_t l)
34 xbt_dynar_free(&(l->list));
39 static e_mc_comm_pattern_difference_t compare_comm_pattern(mc_comm_pattern_t comm1, mc_comm_pattern_t comm2) {
40 if(comm1->type != comm2->type)
42 if (strcmp(comm1->rdv, comm2->rdv) != 0)
44 if (comm1->src_proc != comm2->src_proc)
46 if (comm1->dst_proc != comm2->dst_proc)
48 if (comm1->data_size != comm2->data_size)
49 return DATA_SIZE_DIFF;
50 if(comm1->data == NULL && comm2->data == NULL)
52 /*if(comm1->data != NULL && comm2->data !=NULL) {
53 if (!memcmp(comm1->data, comm2->data, comm1->data_size))
62 static void print_determinism_result(e_mc_comm_pattern_difference_t diff, int process, mc_comm_pattern_t comm, unsigned int cursor) {
63 if (_sg_mc_comms_determinism && !initial_global_state->comm_deterministic) {
64 XBT_INFO("****************************************************");
65 XBT_INFO("***** Non-deterministic communications pattern *****");
66 XBT_INFO("****************************************************");
67 XBT_INFO("The communications pattern of the process %d is different!", process);
70 XBT_INFO("Different communication type for communication %s at index %d", comm->type == SIMIX_COMM_SEND ? "Send" : "Recv", cursor);
73 XBT_INFO("Different communication rdv for communication %s at index %d", comm->type == SIMIX_COMM_SEND ? "Send" : "Recv", cursor);
76 XBT_INFO("Different communication source process for communication %s at index %d", comm->type == SIMIX_COMM_SEND ? "Send" : "Recv", cursor);
79 XBT_INFO("Different communication destination process for communication %s at index %d", comm->type == SIMIX_COMM_SEND ? "Send" : "Recv", cursor);
82 XBT_INFO("Different communication data size for communication %s at index %d", comm->type == SIMIX_COMM_SEND ? "Send" : "Recv", cursor);
85 XBT_INFO("Different communication data for communication %s at index %d", comm->type == SIMIX_COMM_SEND ? "Send" : "Recv", cursor);
90 MC_print_statistics(mc_stats);
92 } else if (_sg_mc_send_determinism && !initial_global_state->send_deterministic) {
93 XBT_INFO("*********************************************************");
94 XBT_INFO("***** Non-send-deterministic communications pattern *****");
95 XBT_INFO("*********************************************************");
96 XBT_INFO("The communications pattern of the process %d is different!", process);
99 XBT_INFO("Different communication type for communication %s at index %d", comm->type == SIMIX_COMM_SEND ? "Send" : "Recv", cursor);
102 XBT_INFO("Different communication rdv for communication %s at index %d", comm->type == SIMIX_COMM_SEND ? "Send" : "Recv", cursor);
105 XBT_INFO("Different communication source process for communication %s at index %d", comm->type == SIMIX_COMM_SEND ? "Send" : "Recv", cursor);
108 XBT_INFO("Different communication destination process for communication %s at index %d", comm->type == SIMIX_COMM_SEND ? "Send" : "Recv", cursor);
111 XBT_INFO("Different communication data size for communication %s at index %d", comm->type == SIMIX_COMM_SEND ? "Send" : "Recv", cursor);
114 XBT_INFO("Different communication data for communication %s at index %d", comm->type == SIMIX_COMM_SEND ? "Send" : "Recv", cursor);
119 MC_print_statistics(mc_stats);
124 static void print_communications_pattern()
126 unsigned int cursor = 0, cursor2 = 0;
127 mc_comm_pattern_t current_comm;
128 mc_list_comm_pattern_t current_list;
129 unsigned int current_process = 1;
130 while (current_process < simix_process_maxpid) {
131 current_list = (mc_list_comm_pattern_t)xbt_dynar_get_as(initial_communications_pattern, current_process, mc_list_comm_pattern_t);
132 XBT_INFO("Communications from the process %u:", current_process);
133 while(cursor2 < current_list->index_comm){
134 current_comm = (mc_comm_pattern_t)xbt_dynar_get_as(current_list->list, cursor2, mc_comm_pattern_t);
135 if (current_comm->type == SIMIX_COMM_SEND) {
136 XBT_INFO("(%u) [(%lu) %s -> (%lu) %s] %s ", cursor,current_comm->src_proc,
137 current_comm->src_host, current_comm->dst_proc,
138 current_comm->dst_host, "iSend");
140 XBT_INFO("(%u) [(%lu) %s <- (%lu) %s] %s ", cursor, current_comm->dst_proc,
141 current_comm->dst_host, current_comm->src_proc,
142 current_comm->src_host, "iRecv");
152 static void print_incomplete_communications_pattern(){
153 unsigned int cursor = 0;
154 unsigned int current_process = 1;
155 xbt_dynar_t current_pattern;
156 mc_comm_pattern_t comm;
157 while (current_process < simix_process_maxpid) {
158 current_pattern = (xbt_dynar_t)xbt_dynar_get_as(incomplete_communications_pattern, current_process, xbt_dynar_t);
159 XBT_INFO("Incomplete communications from the process %u:", current_process);
160 xbt_dynar_foreach(current_pattern, cursor, comm) {
161 XBT_DEBUG("(%u) Communication %p", cursor, comm);
168 static void update_comm_pattern(mc_comm_pattern_t comm_pattern, smx_synchro_t comm)
171 comm_pattern->src_proc = comm->comm.src_proc->pid;
172 comm_pattern->dst_proc = comm->comm.dst_proc->pid;
173 comm_pattern->src_host = simcall_host_get_name(comm->comm.src_proc->smx_host);
174 comm_pattern->dst_host = simcall_host_get_name(comm->comm.dst_proc->smx_host);
175 if (comm_pattern->data_size == -1 && comm->comm.src_buff != NULL) {
176 comm_pattern->data_size = *(comm->comm.dst_buff_size);
177 comm_pattern->data = xbt_malloc0(comm_pattern->data_size);
178 addr_pointed = *(void **) comm->comm.src_buff;
179 if (addr_pointed > (void*) std_heap && addr_pointed < std_heap->breakval)
180 memcpy(comm_pattern->data, addr_pointed, comm_pattern->data_size);
182 memcpy(comm_pattern->data, comm->comm.src_buff, comm_pattern->data_size);
186 static void deterministic_comm_pattern(int process, mc_comm_pattern_t comm, int backtracking) {
188 mc_list_comm_pattern_t list_comm_pattern = (mc_list_comm_pattern_t)xbt_dynar_get_as(initial_communications_pattern, process, mc_list_comm_pattern_t);
191 mc_comm_pattern_t initial_comm = xbt_dynar_get_as(list_comm_pattern->list, comm->index, mc_comm_pattern_t);
192 e_mc_comm_pattern_difference_t diff;
194 if((diff = compare_comm_pattern(initial_comm, comm)) != NONE_DIFF){
195 if (comm->type == SIMIX_COMM_SEND)
196 initial_global_state->send_deterministic = 0;
197 initial_global_state->comm_deterministic = 0;
198 print_determinism_result(diff, process, comm, list_comm_pattern->index_comm + 1);
202 list_comm_pattern->index_comm++;
203 comm_pattern_free(comm);
207 /********** Non Static functions ***********/
209 void comm_pattern_free_voidp(void *p) {
210 comm_pattern_free((mc_comm_pattern_t) * (void **) p);
213 void list_comm_pattern_free_voidp(void *p) {
214 list_comm_pattern_free((mc_list_comm_pattern_t) * (void **) p);
217 void get_comm_pattern(xbt_dynar_t list, smx_simcall_t request, e_mc_call_type_t call_type)
220 mc_comm_pattern_t pattern = NULL;
221 pattern = xbt_new0(s_mc_comm_pattern_t, 1);
222 pattern->data_size = -1;
223 pattern->data = NULL;
225 pattern->index = ((mc_list_comm_pattern_t)xbt_dynar_get_as(initial_communications_pattern, request->issuer->pid, mc_list_comm_pattern_t))->index_comm + xbt_dynar_length((xbt_dynar_t)xbt_dynar_get_as(incomplete_communications_pattern, request->issuer->pid, xbt_dynar_t));
229 if (call_type == MC_CALL_TYPE_SEND) {
230 /* Create comm pattern */
231 pattern->type = SIMIX_COMM_SEND;
232 pattern->comm = simcall_comm_isend__get__result(request);
233 pattern->rdv = (pattern->comm->comm.rdv != NULL) ? strdup(pattern->comm->comm.rdv->name) : strdup(pattern->comm->comm.rdv_cpy->name);
234 pattern->src_proc = pattern->comm->comm.src_proc->pid;
235 pattern->src_host = simcall_host_get_name(request->issuer->smx_host);
236 if(pattern->comm->comm.src_buff != NULL){
237 pattern->data_size = pattern->comm->comm.src_buff_size;
238 pattern->data = xbt_malloc0(pattern->data_size);
239 addr_pointed = *(void **) pattern->comm->comm.src_buff;
240 if (addr_pointed > (void*) std_heap && addr_pointed < std_heap->breakval)
241 memcpy(pattern->data, addr_pointed, pattern->data_size);
243 memcpy(pattern->data, pattern->comm->comm.src_buff, pattern->data_size);
245 } else if (call_type == MC_CALL_TYPE_RECV) {
246 pattern->type = SIMIX_COMM_RECEIVE;
247 pattern->comm = simcall_comm_irecv__get__result(request);
248 pattern->rdv = (pattern->comm->comm.rdv != NULL) ? strdup(pattern->comm->comm.rdv->name) : strdup(pattern->comm->comm.rdv_cpy->name);
249 pattern->dst_proc = pattern->comm->comm.dst_proc->pid;
250 pattern->dst_host = simcall_host_get_name(request->issuer->smx_host);
252 xbt_die("Unexpected call_type %i", (int) call_type);
255 xbt_dynar_push((xbt_dynar_t)xbt_dynar_get_as(incomplete_communications_pattern, request->issuer->pid, xbt_dynar_t), &pattern);
257 XBT_DEBUG("Insert incomplete comm pattern %p for process %lu", pattern, request->issuer->pid);
260 void complete_comm_pattern(xbt_dynar_t list, smx_synchro_t comm, int backtracking) {
262 mc_comm_pattern_t current_comm_pattern;
263 unsigned int cursor = 0;
264 unsigned int src = comm->comm.src_proc->pid;
265 unsigned int dst = comm->comm.dst_proc->pid;
266 mc_comm_pattern_t src_comm_pattern;
267 mc_comm_pattern_t dst_comm_pattern;
268 int src_completed = 0, dst_completed = 0;
270 /* Complete comm pattern */
271 xbt_dynar_foreach((xbt_dynar_t)xbt_dynar_get_as(incomplete_communications_pattern, src, xbt_dynar_t), cursor, current_comm_pattern) {
272 if (current_comm_pattern-> comm == comm) {
273 update_comm_pattern(current_comm_pattern, comm);
275 xbt_dynar_remove_at((xbt_dynar_t)xbt_dynar_get_as(incomplete_communications_pattern, src, xbt_dynar_t), cursor, &src_comm_pattern);
276 XBT_DEBUG("Remove incomplete comm pattern for process %u at cursor %u", src, cursor);
281 xbt_die("Corresponding communication for the source process not found!");
285 xbt_dynar_foreach((xbt_dynar_t)xbt_dynar_get_as(incomplete_communications_pattern, dst, xbt_dynar_t), cursor, current_comm_pattern) {
286 if (current_comm_pattern-> comm == comm) {
287 update_comm_pattern(current_comm_pattern, comm);
289 xbt_dynar_remove_at((xbt_dynar_t)xbt_dynar_get_as(incomplete_communications_pattern, dst, xbt_dynar_t), cursor, &dst_comm_pattern);
290 XBT_DEBUG("Remove incomplete comm pattern for process %u at cursor %u", dst, cursor);
295 xbt_die("Corresponding communication for the destination process not found!");
297 if (!initial_global_state->initial_communications_pattern_done) {
298 /* Store comm pattern */
299 if(src_comm_pattern->index < xbt_dynar_length(((mc_list_comm_pattern_t)xbt_dynar_get_as(initial_communications_pattern, src, mc_list_comm_pattern_t))->list)){
300 xbt_dynar_set(((mc_list_comm_pattern_t)xbt_dynar_get_as(initial_communications_pattern, src, mc_list_comm_pattern_t))->list, src_comm_pattern->index, &src_comm_pattern);
301 ((mc_list_comm_pattern_t)xbt_dynar_get_as(initial_communications_pattern, src, mc_list_comm_pattern_t))->list->used++;
303 xbt_dynar_insert_at(((mc_list_comm_pattern_t)xbt_dynar_get_as(initial_communications_pattern, src, mc_list_comm_pattern_t))->list, src_comm_pattern->index, &src_comm_pattern);
306 if(dst_comm_pattern->index < xbt_dynar_length(((mc_list_comm_pattern_t)xbt_dynar_get_as(initial_communications_pattern, dst, mc_list_comm_pattern_t))->list)) {
307 xbt_dynar_set(((mc_list_comm_pattern_t)xbt_dynar_get_as(initial_communications_pattern, dst, mc_list_comm_pattern_t))->list, dst_comm_pattern->index, &dst_comm_pattern);
308 ((mc_list_comm_pattern_t)xbt_dynar_get_as(initial_communications_pattern, dst, mc_list_comm_pattern_t))->list->used++;
310 xbt_dynar_insert_at(((mc_list_comm_pattern_t)xbt_dynar_get_as(initial_communications_pattern, dst, mc_list_comm_pattern_t))->list, dst_comm_pattern->index, &dst_comm_pattern);
312 ((mc_list_comm_pattern_t)xbt_dynar_get_as(initial_communications_pattern, src, mc_list_comm_pattern_t))->index_comm++;
313 ((mc_list_comm_pattern_t)xbt_dynar_get_as(initial_communications_pattern, dst, mc_list_comm_pattern_t))->index_comm++;
315 /* Evaluate comm determinism */
316 deterministic_comm_pattern(src, src_comm_pattern, backtracking);
317 deterministic_comm_pattern(dst, dst_comm_pattern, backtracking);
321 /************************ Main algorithm ************************/
323 void MC_pre_modelcheck_comm_determinism(void)
326 int mc_mem_set = (mmalloc_get_current_heap() == mc_heap);
328 mc_state_t initial_state = NULL;
329 smx_process_t process;
335 if (_sg_mc_visited > 0)
336 visited_states = xbt_dynar_new(sizeof(mc_visited_state_t), visited_state_free_voidp);
338 initial_communications_pattern = xbt_dynar_new(sizeof(mc_list_comm_pattern_t), list_comm_pattern_free_voidp);
339 for (i=0; i<simix_process_maxpid; i++){
340 mc_list_comm_pattern_t process_list_pattern = xbt_new0(s_mc_list_comm_pattern_t, 1);
341 process_list_pattern->list = xbt_dynar_new(sizeof(mc_comm_pattern_t), comm_pattern_free_voidp);
342 process_list_pattern->index_comm = 0;
343 xbt_dynar_insert_at(initial_communications_pattern, i, &process_list_pattern);
345 incomplete_communications_pattern = xbt_dynar_new(sizeof(xbt_dynar_t), xbt_dynar_free_voidp);
346 for (i=0; i<simix_process_maxpid; i++){
347 xbt_dynar_t process_pattern = xbt_dynar_new(sizeof(mc_comm_pattern_t), NULL);
348 xbt_dynar_insert_at(incomplete_communications_pattern, i, &process_pattern);
351 initial_state = MC_state_new();
354 XBT_DEBUG("********* Start communication determinism verification *********");
356 /* Wait for requests (schedules processes) */
357 MC_wait_for_requests();
361 /* Get an enabled process and insert it in the interleave set of the initial state */
362 xbt_swag_foreach(process, simix_global->process_list) {
363 if (MC_process_is_enabled(process)) {
364 MC_state_interleave_process(initial_state, process);
368 xbt_fifo_unshift(mc_stack, initial_state);
374 void MC_modelcheck_comm_determinism(void)
377 char *req_str = NULL;
379 mc_visited_state_t visited_state = NULL;
380 smx_simcall_t req = NULL;
381 smx_process_t process = NULL;
382 mc_state_t state = NULL, next_state = NULL;
384 while (xbt_fifo_size(mc_stack) > 0) {
386 /* Get current state */
387 state = (mc_state_t) xbt_fifo_get_item_content(xbt_fifo_get_first_item(mc_stack));
389 XBT_DEBUG("**************************************************");
390 XBT_DEBUG("Exploration depth = %d (state = %d, interleaved processes = %d)",
391 xbt_fifo_size(mc_stack), state->num,
392 MC_state_interleave_size(state));
394 /* Update statistics */
395 mc_stats->visited_states++;
397 if ((xbt_fifo_size(mc_stack) <= _sg_mc_max_depth)
398 && (req = MC_state_get_request(state, &value))
399 && (visited_state == NULL)) {
401 req_str = MC_request_to_string(req, value);
402 XBT_DEBUG("Execute: %s", req_str);
405 if (dot_output != NULL) {
407 req_str = MC_request_get_dot_output(req, value);
411 MC_state_set_executed_request(state, req, value);
412 mc_stats->executed_transitions++;
414 /* TODO : handle test and testany simcalls */
415 e_mc_call_type_t call = MC_CALL_TYPE_NONE;
416 if (_sg_mc_comms_determinism || _sg_mc_send_determinism) {
417 call = mc_get_call_type(req);
420 /* Answer the request */
421 SIMIX_simcall_handle(req, value); /* After this call req is no longer useful */
424 if(!initial_global_state->initial_communications_pattern_done)
425 handle_comm_pattern(call, req, value, initial_communications_pattern, 0);
427 handle_comm_pattern(call, req, value, NULL, 0);
430 /* Wait for requests (schedules processes) */
431 MC_wait_for_requests();
433 /* Create the new expanded state */
436 next_state = MC_state_new();
438 if ((visited_state = is_visited_state(next_state)) == NULL) {
440 /* Get enabled processes and insert them in the interleave set of the next state */
441 xbt_swag_foreach(process, simix_global->process_list) {
442 if (MC_process_is_enabled(process)) {
443 MC_state_interleave_process(next_state, process);
447 if (dot_output != NULL)
448 fprintf(dot_output, "\"%d\" -> \"%d\" [%s];\n", state->num, next_state->num, req_str);
452 if (dot_output != NULL)
453 fprintf(dot_output, "\"%d\" -> \"%d\" [%s];\n", state->num, visited_state->other_num == -1 ? visited_state->num : visited_state->other_num, req_str);
457 xbt_fifo_unshift(mc_stack, next_state);
459 if (dot_output != NULL)
466 if (xbt_fifo_size(mc_stack) > _sg_mc_max_depth) {
467 XBT_WARN("/!\\ Max depth reached ! /!\\ ");
468 } else if (visited_state != NULL) {
469 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);
471 XBT_DEBUG("There are no more processes to interleave. (depth %d)", xbt_fifo_size(mc_stack));
476 if (!initial_global_state->initial_communications_pattern_done)
477 initial_global_state->initial_communications_pattern_done = 1;
479 /* Trash the current state, no longer needed */
480 xbt_fifo_shift(mc_stack);
481 MC_state_delete(state, !state->in_visited_states ? 1 : 0);
482 XBT_DEBUG("Delete state %d at depth %d", state->num, xbt_fifo_size(mc_stack) + 1);
486 visited_state = NULL;
488 /* Check for deadlocks */
489 if (MC_deadlock_check()) {
490 MC_show_deadlock(NULL);
496 while ((state = xbt_fifo_shift(mc_stack)) != NULL) {
497 if (MC_state_interleave_size(state) && xbt_fifo_size(mc_stack) < _sg_mc_max_depth) {
498 /* We found a back-tracking point, let's loop */
499 XBT_DEBUG("Back-tracking to state %d at depth %d", state->num, xbt_fifo_size(mc_stack) + 1);
500 xbt_fifo_unshift(mc_stack, state);
505 XBT_DEBUG("Back-tracking to state %d at depth %d done", state->num, xbt_fifo_size(mc_stack));
509 XBT_DEBUG("Delete state %d at depth %d", state->num, xbt_fifo_size(mc_stack) + 1);
510 MC_state_delete(state, !state->in_visited_states ? 1 : 0);
518 MC_print_statistics(mc_stats);