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->tag != comm2->tag)
50 /*if (comm1->data_size != comm2->data_size)
51 return DATA_SIZE_DIFF;
52 if(comm1->data == NULL && comm2->data == NULL)
54 if(comm1->data != NULL && comm2->data !=NULL) {
55 if (!memcmp(comm1->data, comm2->data, comm1->data_size))
64 static void print_determinism_result(e_mc_comm_pattern_difference_t diff, int process, mc_comm_pattern_t comm, unsigned int cursor) {
65 if (_sg_mc_comms_determinism && !initial_global_state->comm_deterministic) {
66 XBT_INFO("****************************************************");
67 XBT_INFO("***** Non-deterministic communications pattern *****");
68 XBT_INFO("****************************************************");
69 XBT_INFO("The communications pattern of the process %d is different!", process);
72 XBT_INFO("Different communication type for communication %s at index %d", comm->type == SIMIX_COMM_SEND ? "Send" : "Recv", cursor);
75 XBT_INFO("Different communication rdv for communication %s at index %d", comm->type == SIMIX_COMM_SEND ? "Send" : "Recv", cursor);
78 XBT_INFO("Different communication tag for communication %s at index %d", comm->type == SIMIX_COMM_SEND ? "Send" : "Recv", cursor);
81 XBT_INFO("Different communication source process for communication %s at index %d", comm->type == SIMIX_COMM_SEND ? "Send" : "Recv", cursor);
84 XBT_INFO("Different communication destination process for communication %s at index %d", comm->type == SIMIX_COMM_SEND ? "Send" : "Recv", cursor);
87 XBT_INFO("Different communication data size for communication %s at index %d", comm->type == SIMIX_COMM_SEND ? "Send" : "Recv", cursor);
90 XBT_INFO("Different communication data for communication %s at index %d", comm->type == SIMIX_COMM_SEND ? "Send" : "Recv", cursor);
95 MC_print_statistics(mc_stats);
97 } else if (_sg_mc_send_determinism && !initial_global_state->send_deterministic) {
98 XBT_INFO("*********************************************************");
99 XBT_INFO("***** Non-send-deterministic communications pattern *****");
100 XBT_INFO("*********************************************************");
101 XBT_INFO("The communications pattern of the process %d is different!", process);
104 XBT_INFO("Different communication type for communication %s at index %d", comm->type == SIMIX_COMM_SEND ? "Send" : "Recv", cursor);
107 XBT_INFO("Different communication rdv for communication %s at index %d", comm->type == SIMIX_COMM_SEND ? "Send" : "Recv", cursor);
110 XBT_INFO("Different communication tag for communication %s at index %d", comm->type == SIMIX_COMM_SEND ? "Send" : "Recv", cursor);
113 XBT_INFO("Different communication source process for communication %s at index %d", comm->type == SIMIX_COMM_SEND ? "Send" : "Recv", cursor);
116 XBT_INFO("Different communication destination process for communication %s at index %d", comm->type == SIMIX_COMM_SEND ? "Send" : "Recv", cursor);
119 XBT_INFO("Different communication data size for communication %s at index %d", comm->type == SIMIX_COMM_SEND ? "Send" : "Recv", cursor);
122 XBT_INFO("Different communication data for communication %s at index %d", comm->type == SIMIX_COMM_SEND ? "Send" : "Recv", cursor);
127 MC_print_statistics(mc_stats);
132 static void update_comm_pattern(mc_comm_pattern_t comm_pattern, smx_synchro_t comm)
135 comm_pattern->src_proc = comm->comm.src_proc->pid;
136 comm_pattern->dst_proc = comm->comm.dst_proc->pid;
137 comm_pattern->src_host = simcall_host_get_name(comm->comm.src_proc->smx_host);
138 comm_pattern->dst_host = simcall_host_get_name(comm->comm.dst_proc->smx_host);
139 if (comm_pattern->data_size == -1 && comm->comm.src_buff != NULL) {
140 comm_pattern->data_size = *(comm->comm.dst_buff_size);
141 comm_pattern->data = xbt_malloc0(comm_pattern->data_size);
142 addr_pointed = *(void **) comm->comm.src_buff;
143 if (addr_pointed > (void*) std_heap && addr_pointed < std_heap->breakval)
144 memcpy(comm_pattern->data, addr_pointed, comm_pattern->data_size);
146 memcpy(comm_pattern->data, comm->comm.src_buff, comm_pattern->data_size);
150 static void deterministic_comm_pattern(int process, mc_comm_pattern_t comm, int backtracking) {
152 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);
155 mc_comm_pattern_t initial_comm = xbt_dynar_get_as(list_comm_pattern->list, comm->index, mc_comm_pattern_t);
156 e_mc_comm_pattern_difference_t diff;
158 if((diff = compare_comm_pattern(initial_comm, comm)) != NONE_DIFF){
159 if (comm->type == SIMIX_COMM_SEND)
160 initial_global_state->send_deterministic = 0;
161 initial_global_state->comm_deterministic = 0;
162 print_determinism_result(diff, process, comm, list_comm_pattern->index_comm + 1);
166 list_comm_pattern->index_comm++;
167 comm_pattern_free(comm);
171 /********** Non Static functions ***********/
173 void comm_pattern_free_voidp(void *p) {
174 comm_pattern_free((mc_comm_pattern_t) * (void **) p);
177 void list_comm_pattern_free_voidp(void *p) {
178 list_comm_pattern_free((mc_list_comm_pattern_t) * (void **) p);
181 void get_comm_pattern(xbt_dynar_t list, smx_simcall_t request, e_mc_call_type_t call_type)
184 mc_comm_pattern_t pattern = NULL;
185 pattern = xbt_new0(s_mc_comm_pattern_t, 1);
186 pattern->data_size = -1;
187 pattern->data = NULL;
189 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));
193 if (call_type == MC_CALL_TYPE_SEND) {
194 /* Create comm pattern */
195 pattern->type = SIMIX_COMM_SEND;
196 pattern->comm = simcall_comm_isend__get__result(request);
197 pattern->rdv = (pattern->comm->comm.rdv != NULL) ? strdup(pattern->comm->comm.rdv->name) : strdup(pattern->comm->comm.rdv_cpy->name);
198 pattern->src_proc = pattern->comm->comm.src_proc->pid;
199 pattern->src_host = simcall_host_get_name(request->issuer->smx_host);
200 pattern->tag = ((MPI_Request)simcall_comm_isend__get__data(request))->tag;
201 if(pattern->comm->comm.src_buff != NULL){
202 pattern->data_size = pattern->comm->comm.src_buff_size;
203 pattern->data = xbt_malloc0(pattern->data_size);
204 addr_pointed = *(void **) pattern->comm->comm.src_buff;
205 if (addr_pointed > (void*) std_heap && addr_pointed < std_heap->breakval)
206 memcpy(pattern->data, addr_pointed, pattern->data_size);
208 memcpy(pattern->data, pattern->comm->comm.src_buff, pattern->data_size);
210 } else if (call_type == MC_CALL_TYPE_RECV) {
211 pattern->type = SIMIX_COMM_RECEIVE;
212 pattern->comm = simcall_comm_irecv__get__result(request);
213 pattern->tag = ((MPI_Request)simcall_comm_irecv__get__data(request))->tag;
214 pattern->rdv = (pattern->comm->comm.rdv != NULL) ? strdup(pattern->comm->comm.rdv->name) : strdup(pattern->comm->comm.rdv_cpy->name);
215 pattern->dst_proc = pattern->comm->comm.dst_proc->pid;
216 pattern->dst_host = simcall_host_get_name(request->issuer->smx_host);
218 xbt_die("Unexpected call_type %i", (int) call_type);
221 xbt_dynar_push((xbt_dynar_t)xbt_dynar_get_as(incomplete_communications_pattern, request->issuer->pid, xbt_dynar_t), &pattern);
223 XBT_DEBUG("Insert incomplete comm pattern %p for process %lu", pattern, request->issuer->pid);
226 void complete_comm_pattern(xbt_dynar_t list, smx_synchro_t comm, int backtracking) {
228 mc_comm_pattern_t current_comm_pattern;
229 unsigned int cursor = 0;
230 unsigned int src = comm->comm.src_proc->pid;
231 unsigned int dst = comm->comm.dst_proc->pid;
232 mc_comm_pattern_t src_comm_pattern;
233 mc_comm_pattern_t dst_comm_pattern;
234 int src_completed = 0, dst_completed = 0;
236 /* Complete comm pattern */
237 xbt_dynar_foreach((xbt_dynar_t)xbt_dynar_get_as(incomplete_communications_pattern, src, xbt_dynar_t), cursor, current_comm_pattern) {
238 if (current_comm_pattern-> comm == comm) {
239 update_comm_pattern(current_comm_pattern, comm);
241 xbt_dynar_remove_at((xbt_dynar_t)xbt_dynar_get_as(incomplete_communications_pattern, src, xbt_dynar_t), cursor, &src_comm_pattern);
242 XBT_DEBUG("Remove incomplete comm pattern for process %u at cursor %u", src, cursor);
247 xbt_die("Corresponding communication for the source process not found!");
251 xbt_dynar_foreach((xbt_dynar_t)xbt_dynar_get_as(incomplete_communications_pattern, dst, xbt_dynar_t), cursor, current_comm_pattern) {
252 if (current_comm_pattern-> comm == comm) {
253 update_comm_pattern(current_comm_pattern, comm);
255 xbt_dynar_remove_at((xbt_dynar_t)xbt_dynar_get_as(incomplete_communications_pattern, dst, xbt_dynar_t), cursor, &dst_comm_pattern);
256 XBT_DEBUG("Remove incomplete comm pattern for process %u at cursor %u", dst, cursor);
261 xbt_die("Corresponding communication for the destination process not found!");
263 if (!initial_global_state->initial_communications_pattern_done) {
264 /* Store comm pattern */
265 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)){
266 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);
267 ((mc_list_comm_pattern_t)xbt_dynar_get_as(initial_communications_pattern, src, mc_list_comm_pattern_t))->list->used++;
269 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);
272 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)) {
273 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);
274 ((mc_list_comm_pattern_t)xbt_dynar_get_as(initial_communications_pattern, dst, mc_list_comm_pattern_t))->list->used++;
276 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);
278 ((mc_list_comm_pattern_t)xbt_dynar_get_as(initial_communications_pattern, src, mc_list_comm_pattern_t))->index_comm++;
279 ((mc_list_comm_pattern_t)xbt_dynar_get_as(initial_communications_pattern, dst, mc_list_comm_pattern_t))->index_comm++;
281 /* Evaluate comm determinism */
282 deterministic_comm_pattern(src, src_comm_pattern, backtracking);
283 deterministic_comm_pattern(dst, dst_comm_pattern, backtracking);
287 /************************ Main algorithm ************************/
289 void MC_pre_modelcheck_comm_determinism(void)
292 int mc_mem_set = (mmalloc_get_current_heap() == mc_heap);
294 mc_state_t initial_state = NULL;
295 smx_process_t process;
301 if (_sg_mc_visited > 0)
302 visited_states = xbt_dynar_new(sizeof(mc_visited_state_t), visited_state_free_voidp);
304 initial_communications_pattern = xbt_dynar_new(sizeof(mc_list_comm_pattern_t), list_comm_pattern_free_voidp);
305 for (i=0; i<simix_process_maxpid; i++){
306 mc_list_comm_pattern_t process_list_pattern = xbt_new0(s_mc_list_comm_pattern_t, 1);
307 process_list_pattern->list = xbt_dynar_new(sizeof(mc_comm_pattern_t), comm_pattern_free_voidp);
308 process_list_pattern->index_comm = 0;
309 xbt_dynar_insert_at(initial_communications_pattern, i, &process_list_pattern);
311 incomplete_communications_pattern = xbt_dynar_new(sizeof(xbt_dynar_t), xbt_dynar_free_voidp);
312 for (i=0; i<simix_process_maxpid; i++){
313 xbt_dynar_t process_pattern = xbt_dynar_new(sizeof(mc_comm_pattern_t), NULL);
314 xbt_dynar_insert_at(incomplete_communications_pattern, i, &process_pattern);
317 initial_state = MC_state_new();
320 XBT_DEBUG("********* Start communication determinism verification *********");
322 /* Wait for requests (schedules processes) */
323 MC_wait_for_requests();
327 /* Get an enabled process and insert it in the interleave set of the initial state */
328 xbt_swag_foreach(process, simix_global->process_list) {
329 if (MC_process_is_enabled(process)) {
330 MC_state_interleave_process(initial_state, process);
334 xbt_fifo_unshift(mc_stack, initial_state);
340 void MC_modelcheck_comm_determinism(void)
343 char *req_str = NULL;
345 mc_visited_state_t visited_state = NULL;
346 smx_simcall_t req = NULL;
347 smx_process_t process = NULL;
348 mc_state_t state = NULL, next_state = NULL;
350 while (xbt_fifo_size(mc_stack) > 0) {
352 /* Get current state */
353 state = (mc_state_t) xbt_fifo_get_item_content(xbt_fifo_get_first_item(mc_stack));
355 XBT_DEBUG("**************************************************");
356 XBT_DEBUG("Exploration depth = %d (state = %d, interleaved processes = %d)",
357 xbt_fifo_size(mc_stack), state->num,
358 MC_state_interleave_size(state));
360 /* Update statistics */
361 mc_stats->visited_states++;
363 if ((xbt_fifo_size(mc_stack) <= _sg_mc_max_depth)
364 && (req = MC_state_get_request(state, &value))
365 && (visited_state == NULL)) {
367 req_str = MC_request_to_string(req, value);
368 XBT_DEBUG("Execute: %s", req_str);
371 if (dot_output != NULL) {
373 req_str = MC_request_get_dot_output(req, value);
377 MC_state_set_executed_request(state, req, value);
378 mc_stats->executed_transitions++;
380 /* TODO : handle test and testany simcalls */
381 e_mc_call_type_t call = MC_CALL_TYPE_NONE;
382 if (_sg_mc_comms_determinism || _sg_mc_send_determinism) {
383 call = mc_get_call_type(req);
386 /* Answer the request */
387 SIMIX_simcall_handle(req, value); /* After this call req is no longer useful */
390 if(!initial_global_state->initial_communications_pattern_done)
391 handle_comm_pattern(call, req, value, initial_communications_pattern, 0);
393 handle_comm_pattern(call, req, value, NULL, 0);
396 /* Wait for requests (schedules processes) */
397 MC_wait_for_requests();
399 /* Create the new expanded state */
402 next_state = MC_state_new();
404 if ((visited_state = is_visited_state(next_state)) == NULL) {
406 /* Get enabled processes and insert them in the interleave set of the next state */
407 xbt_swag_foreach(process, simix_global->process_list) {
408 if (MC_process_is_enabled(process)) {
409 MC_state_interleave_process(next_state, process);
413 if (dot_output != NULL)
414 fprintf(dot_output, "\"%d\" -> \"%d\" [%s];\n", state->num, next_state->num, req_str);
418 if (dot_output != NULL)
419 fprintf(dot_output, "\"%d\" -> \"%d\" [%s];\n", state->num, visited_state->other_num == -1 ? visited_state->num : visited_state->other_num, req_str);
423 xbt_fifo_unshift(mc_stack, next_state);
425 if (dot_output != NULL)
432 if (xbt_fifo_size(mc_stack) > _sg_mc_max_depth) {
433 XBT_WARN("/!\\ Max depth reached ! /!\\ ");
434 } else if (visited_state != NULL) {
435 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);
437 XBT_DEBUG("There are no more processes to interleave. (depth %d)", xbt_fifo_size(mc_stack));
442 if (!initial_global_state->initial_communications_pattern_done)
443 initial_global_state->initial_communications_pattern_done = 1;
445 /* Trash the current state, no longer needed */
446 xbt_fifo_shift(mc_stack);
447 MC_state_delete(state, !state->in_visited_states ? 1 : 0);
448 XBT_DEBUG("Delete state %d at depth %d", state->num, xbt_fifo_size(mc_stack) + 1);
452 visited_state = NULL;
454 /* Check for deadlocks */
455 if (MC_deadlock_check()) {
456 MC_show_deadlock(NULL);
462 while ((state = xbt_fifo_shift(mc_stack)) != NULL) {
463 if (MC_state_interleave_size(state) && xbt_fifo_size(mc_stack) < _sg_mc_max_depth) {
464 /* We found a back-tracking point, let's loop */
465 XBT_DEBUG("Back-tracking to state %d at depth %d", state->num, xbt_fifo_size(mc_stack) + 1);
466 xbt_fifo_unshift(mc_stack, state);
471 XBT_DEBUG("Back-tracking to state %d at depth %d done", state->num, xbt_fifo_size(mc_stack));
475 XBT_DEBUG("Delete state %d at depth %d", state->num, xbt_fifo_size(mc_stack) + 1);
476 MC_state_delete(state, !state->in_visited_states ? 1 : 0);
484 MC_print_statistics(mc_stats);