1 /* Copyright (c) 2008-2015. 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. */
10 #include <xbt/dynar.hpp>
13 #include <xbt/sysdep.h>
15 #include "src/mc/mc_state.h"
16 #include "src/mc/mc_comm_pattern.h"
17 #include "src/mc/mc_request.h"
18 #include "src/mc/mc_safety.h"
19 #include "src/mc/mc_private.h"
20 #include "src/mc/mc_record.h"
21 #include "src/mc/mc_smx.h"
22 #include "src/mc/Client.hpp"
23 #include "src/mc/mc_exit.h"
25 using simgrid::mc::remote;
27 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_comm_determinism, mc,
28 "Logging specific to MC communication determinism detection");
32 /********** Global variables **********/
34 xbt_dynar_t initial_communications_pattern;
35 xbt_dynar_t incomplete_communications_pattern;
37 /********** Static functions ***********/
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 == nullptr && comm2->data == NULL)
54 if(comm1->data != nullptr && comm2->data !=NULL) {
55 if (!memcmp(comm1->data, comm2->data, comm1->data_size))
63 static char* print_determinism_result(e_mc_comm_pattern_difference_t diff, int process, mc_comm_pattern_t comm, unsigned int cursor) {
66 if(comm->type == SIMIX_COMM_SEND)
67 type = bprintf("The send communications pattern of the process %d is different!", process - 1);
69 type = bprintf("The recv communications pattern of the process %d is different!", process - 1);
73 res = bprintf("%s Different type for communication #%d", type, cursor);
76 res = bprintf("%s Different rdv for communication #%d", type, cursor);
79 res = bprintf("%s Different tag for communication #%d", type, cursor);
82 res = bprintf("%s Different source for communication #%d", type, cursor);
85 res = bprintf("%s Different destination for communication #%d", type, cursor);
88 res = bprintf("%s\n Different data size for communication #%d", type, cursor);
91 res = bprintf("%s\n Different data for communication #%d", type, cursor);
101 static void update_comm_pattern(mc_comm_pattern_t comm_pattern, smx_synchro_t comm_addr)
103 s_smx_synchro_t comm;
104 mc_model_checker->process().read(&comm, remote(comm_addr));
106 smx_process_t src_proc = MC_smx_resolve_process(comm.comm.src_proc);
107 smx_process_t dst_proc = MC_smx_resolve_process(comm.comm.dst_proc);
108 comm_pattern->src_proc = src_proc->pid;
109 comm_pattern->dst_proc = dst_proc->pid;
110 comm_pattern->src_host = MC_smx_process_get_host_name(src_proc);
111 comm_pattern->dst_host = MC_smx_process_get_host_name(dst_proc);
112 if (comm_pattern->data_size == -1 && comm.comm.src_buff != nullptr) {
114 mc_model_checker->process().read(
115 &buff_size, remote(comm.comm.dst_buff_size));
116 comm_pattern->data_size = buff_size;
117 comm_pattern->data = xbt_malloc0(comm_pattern->data_size);
118 mc_model_checker->process().read_bytes(
119 comm_pattern->data, comm_pattern->data_size,
120 remote(comm.comm.src_buff));
124 static void deterministic_comm_pattern(int process, mc_comm_pattern_t comm, int backtracking) {
126 mc_list_comm_pattern_t list =
127 xbt_dynar_get_as(initial_communications_pattern, process, mc_list_comm_pattern_t);
130 mc_comm_pattern_t initial_comm =
131 xbt_dynar_get_as(list->list, list->index_comm, mc_comm_pattern_t);
132 e_mc_comm_pattern_difference_t diff =
133 compare_comm_pattern(initial_comm, comm);
135 if (diff != NONE_DIFF) {
136 if (comm->type == SIMIX_COMM_SEND){
137 initial_global_state->send_deterministic = 0;
138 if(initial_global_state->send_diff != nullptr)
139 xbt_free(initial_global_state->send_diff);
140 initial_global_state->send_diff = print_determinism_result(diff, process, comm, list->index_comm + 1);
142 initial_global_state->recv_deterministic = 0;
143 if(initial_global_state->recv_diff != nullptr)
144 xbt_free(initial_global_state->recv_diff);
145 initial_global_state->recv_diff = print_determinism_result(diff, process, comm, list->index_comm + 1);
147 if(_sg_mc_send_determinism && !initial_global_state->send_deterministic){
148 XBT_INFO("*********************************************************");
149 XBT_INFO("***** Non-send-deterministic communications pattern *****");
150 XBT_INFO("*********************************************************");
151 XBT_INFO("%s", initial_global_state->send_diff);
152 xbt_free(initial_global_state->send_diff);
153 initial_global_state->send_diff = nullptr;
154 MC_print_statistics(mc_stats);
155 mc_model_checker->exit(SIMGRID_MC_EXIT_NON_DETERMINISM);
156 }else if(_sg_mc_comms_determinism && (!initial_global_state->send_deterministic && !initial_global_state->recv_deterministic)) {
157 XBT_INFO("****************************************************");
158 XBT_INFO("***** Non-deterministic communications pattern *****");
159 XBT_INFO("****************************************************");
160 XBT_INFO("%s", initial_global_state->send_diff);
161 XBT_INFO("%s", initial_global_state->recv_diff);
162 xbt_free(initial_global_state->send_diff);
163 initial_global_state->send_diff = nullptr;
164 xbt_free(initial_global_state->recv_diff);
165 initial_global_state->recv_diff = nullptr;
166 MC_print_statistics(mc_stats);
167 mc_model_checker->exit(SIMGRID_MC_EXIT_NON_DETERMINISM);
172 MC_comm_pattern_free(comm);
176 /********** Non Static functions ***********/
178 void MC_get_comm_pattern(xbt_dynar_t list, smx_simcall_t request, e_mc_call_type_t call_type, int backtracking)
180 const smx_process_t issuer = MC_smx_simcall_get_issuer(request);
181 mc_list_comm_pattern_t initial_pattern = xbt_dynar_get_as(
182 initial_communications_pattern, issuer->pid, mc_list_comm_pattern_t);
183 xbt_dynar_t incomplete_pattern = xbt_dynar_get_as(
184 incomplete_communications_pattern, issuer->pid, xbt_dynar_t);
186 mc_comm_pattern_t pattern = xbt_new0(s_mc_comm_pattern_t, 1);
187 pattern->data_size = -1;
188 pattern->data = nullptr;
190 initial_pattern->index_comm + xbt_dynar_length(incomplete_pattern);
192 if (call_type == MC_CALL_TYPE_SEND) {
193 /* Create comm pattern */
194 pattern->type = SIMIX_COMM_SEND;
195 pattern->comm_addr = simcall_comm_isend__get__result(request);
197 s_smx_synchro_t synchro = mc_model_checker->process().read<s_smx_synchro_t>(
198 (std::uint64_t) pattern->comm_addr);
200 char* remote_name = mc_model_checker->process().read<char*>(
201 (std::uint64_t)(synchro.comm.rdv ? &synchro.comm.rdv->name : &synchro.comm.rdv_cpy->name));
202 pattern->rdv = mc_model_checker->process().read_string(remote_name);
203 pattern->src_proc = MC_smx_resolve_process(synchro.comm.src_proc)->pid;
204 pattern->src_host = MC_smx_process_get_host_name(issuer);
206 struct s_smpi_mpi_request mpi_request =
207 mc_model_checker->process().read<s_smpi_mpi_request>(
208 (std::uint64_t) simcall_comm_isend__get__data(request));
209 pattern->tag = mpi_request.tag;
211 if(synchro.comm.src_buff != nullptr){
212 pattern->data_size = synchro.comm.src_buff_size;
213 pattern->data = xbt_malloc0(pattern->data_size);
214 mc_model_checker->process().read_bytes(
215 pattern->data, pattern->data_size, remote(synchro.comm.src_buff));
217 if(mpi_request.detached){
218 if (!initial_global_state->initial_communications_pattern_done) {
219 /* Store comm pattern */
222 initial_communications_pattern, pattern->src_proc, mc_list_comm_pattern_t
226 /* Evaluate comm determinism */
227 deterministic_comm_pattern(pattern->src_proc, pattern, backtracking);
229 initial_communications_pattern, pattern->src_proc, mc_list_comm_pattern_t
234 } else if (call_type == MC_CALL_TYPE_RECV) {
235 pattern->type = SIMIX_COMM_RECEIVE;
236 pattern->comm_addr = simcall_comm_irecv__get__result(request);
238 struct s_smpi_mpi_request mpi_request;
239 mc_model_checker->process().read(
240 &mpi_request, remote((struct s_smpi_mpi_request*)simcall_comm_irecv__get__data(request)));
241 pattern->tag = mpi_request.tag;
243 s_smx_synchro_t synchro;
244 mc_model_checker->process().read(&synchro, remote(pattern->comm_addr));
247 mc_model_checker->process().read(&remote_name,
248 remote(synchro.comm.rdv ? &synchro.comm.rdv->name : &synchro.comm.rdv_cpy->name));
249 pattern->rdv = mc_model_checker->process().read_string(remote_name);
250 pattern->dst_proc = MC_smx_resolve_process(synchro.comm.dst_proc)->pid;
251 pattern->dst_host = MC_smx_process_get_host_name(issuer);
253 xbt_die("Unexpected call_type %i", (int) call_type);
256 xbt_dynar_get_as(incomplete_communications_pattern, issuer->pid, xbt_dynar_t),
259 XBT_DEBUG("Insert incomplete comm pattern %p for process %lu", pattern, issuer->pid);
262 void MC_complete_comm_pattern(xbt_dynar_t list, smx_synchro_t comm_addr, unsigned int issuer, int backtracking) {
263 mc_comm_pattern_t current_comm_pattern;
264 unsigned int cursor = 0;
265 mc_comm_pattern_t comm_pattern;
268 /* Complete comm pattern */
269 xbt_dynar_foreach(xbt_dynar_get_as(incomplete_communications_pattern, issuer, xbt_dynar_t), cursor, current_comm_pattern)
270 if (current_comm_pattern->comm_addr == comm_addr) {
271 update_comm_pattern(current_comm_pattern, comm_addr);
274 xbt_dynar_get_as(incomplete_communications_pattern, issuer, xbt_dynar_t),
275 cursor, &comm_pattern);
276 XBT_DEBUG("Remove incomplete comm pattern for process %u at cursor %u", issuer, cursor);
281 xbt_die("Corresponding communication not found!");
283 mc_list_comm_pattern_t pattern = xbt_dynar_get_as(
284 initial_communications_pattern, issuer, mc_list_comm_pattern_t);
286 if (!initial_global_state->initial_communications_pattern_done)
287 /* Store comm pattern */
288 xbt_dynar_push(pattern->list, &comm_pattern);
290 /* Evaluate comm determinism */
291 deterministic_comm_pattern(issuer, comm_pattern, backtracking);
292 pattern->index_comm++;
297 /************************ Main algorithm ************************/
299 static int MC_modelcheck_comm_determinism_main(void);
301 static void MC_pre_modelcheck_comm_determinism(void)
303 mc_state_t initial_state = nullptr;
305 const int maxpid = MC_smx_get_maxpid();
307 if (_sg_mc_visited > 0)
308 simgrid::mc::visited_states = simgrid::xbt::newDeleteDynar<simgrid::mc::VisitedState>();
310 // Create initial_communications_pattern elements:
311 initial_communications_pattern = xbt_dynar_new(sizeof(mc_list_comm_pattern_t), MC_list_comm_pattern_free_voidp);
312 for (i=0; i < maxpid; i++){
313 mc_list_comm_pattern_t process_list_pattern = xbt_new0(s_mc_list_comm_pattern_t, 1);
314 process_list_pattern->list = xbt_dynar_new(sizeof(mc_comm_pattern_t), MC_comm_pattern_free_voidp);
315 process_list_pattern->index_comm = 0;
316 xbt_dynar_insert_at(initial_communications_pattern, i, &process_list_pattern);
319 // Create incomplete_communications_pattern elements:
320 incomplete_communications_pattern = xbt_dynar_new(sizeof(xbt_dynar_t), xbt_dynar_free_voidp);
321 for (i=0; i < maxpid; i++){
322 xbt_dynar_t process_pattern = xbt_dynar_new(sizeof(mc_comm_pattern_t), nullptr);
323 xbt_dynar_insert_at(incomplete_communications_pattern, i, &process_pattern);
326 initial_state = MC_state_new();
328 XBT_DEBUG("********* Start communication determinism verification *********");
330 /* Wait for requests (schedules processes) */
331 mc_model_checker->wait_for_requests();
333 /* Get an enabled process and insert it in the interleave set of the initial state */
334 for (auto& p : mc_model_checker->process().simix_processes())
335 if (simgrid::mc::process_is_enabled(&p.copy))
336 MC_state_interleave_process(initial_state, &p.copy);
338 xbt_fifo_unshift(mc_stack, initial_state);
341 static int MC_modelcheck_comm_determinism_main(void)
344 char *req_str = nullptr;
346 simgrid::mc::VisitedState* visited_state = nullptr;
347 smx_simcall_t req = nullptr;
348 mc_state_t state = nullptr, 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 == nullptr)) {
367 req_str = simgrid::mc::request_to_string(req, value, simgrid::mc::RequestType::simix);
368 XBT_DEBUG("Execute: %s", req_str);
371 if (dot_output != nullptr)
372 req_str = simgrid::mc::request_get_dot_output(req, value);
374 MC_state_set_executed_request(state, req, value);
375 mc_stats->executed_transitions++;
377 /* TODO : handle test and testany simcalls */
378 e_mc_call_type_t call = MC_CALL_TYPE_NONE;
379 if (_sg_mc_comms_determinism || _sg_mc_send_determinism)
380 call = MC_get_call_type(req);
382 /* Answer the request */
383 simgrid::mc::handle_simcall(req, value); /* After this call req is no longer useful */
385 if(!initial_global_state->initial_communications_pattern_done)
386 MC_handle_comm_pattern(call, req, value, initial_communications_pattern, 0);
388 MC_handle_comm_pattern(call, req, value, nullptr, 0);
390 /* Wait for requests (schedules processes) */
391 mc_model_checker->wait_for_requests();
393 /* Create the new expanded state */
394 next_state = MC_state_new();
396 if ((visited_state = simgrid::mc::is_visited_state(next_state)) == nullptr) {
398 /* Get enabled processes and insert them in the interleave set of the next state */
399 for (auto& p : mc_model_checker->process().simix_processes())
400 if (simgrid::mc::process_is_enabled(&p.copy))
401 MC_state_interleave_process(next_state, &p.copy);
403 if (dot_output != nullptr)
404 fprintf(dot_output, "\"%d\" -> \"%d\" [%s];\n", state->num, next_state->num, req_str);
406 } else if (dot_output != nullptr)
407 fprintf(dot_output, "\"%d\" -> \"%d\" [%s];\n",
408 state->num, visited_state->other_num == -1 ? visited_state->num : visited_state->other_num, req_str);
410 xbt_fifo_unshift(mc_stack, next_state);
412 if (dot_output != nullptr)
417 if (xbt_fifo_size(mc_stack) > _sg_mc_max_depth)
418 XBT_WARN("/!\\ Max depth reached ! /!\\ ");
419 else if (visited_state != nullptr)
420 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);
422 XBT_DEBUG("There are no more processes to interleave. (depth %d)", xbt_fifo_size(mc_stack));
424 if (!initial_global_state->initial_communications_pattern_done)
425 initial_global_state->initial_communications_pattern_done = 1;
427 /* Trash the current state, no longer needed */
428 xbt_fifo_shift(mc_stack);
429 MC_state_delete(state, !state->in_visited_states ? 1 : 0);
430 XBT_DEBUG("Delete state %d at depth %d", state->num, xbt_fifo_size(mc_stack) + 1);
432 visited_state = nullptr;
434 /* Check for deadlocks */
435 if (MC_deadlock_check()) {
436 MC_show_deadlock(nullptr);
437 return SIMGRID_MC_EXIT_DEADLOCK;
440 while ((state = (mc_state_t) xbt_fifo_shift(mc_stack)) != nullptr)
441 if (MC_state_interleave_size(state) && xbt_fifo_size(mc_stack) < _sg_mc_max_depth) {
442 /* We found a back-tracking point, let's loop */
443 XBT_DEBUG("Back-tracking to state %d at depth %d", state->num, xbt_fifo_size(mc_stack) + 1);
444 xbt_fifo_unshift(mc_stack, state);
448 XBT_DEBUG("Back-tracking to state %d at depth %d done", state->num, xbt_fifo_size(mc_stack));
452 XBT_DEBUG("Delete state %d at depth %d", state->num, xbt_fifo_size(mc_stack) + 1);
453 MC_state_delete(state, !state->in_visited_states ? 1 : 0);
459 MC_print_statistics(mc_stats);
460 return SIMGRID_MC_EXIT_SUCCESS;
463 int MC_modelcheck_comm_determinism(void)
465 XBT_INFO("Check communication determinism");
466 simgrid::mc::reduction_mode = simgrid::mc::ReductionMode::none;
467 mc_model_checker->wait_for_requests();
469 if (mc_mode == MC_MODE_CLIENT)
470 // This will move somehwere else:
471 simgrid::mc::Client::get()->handleMessages();
473 /* Create exploration stack */
474 mc_stack = xbt_fifo_new();
476 MC_pre_modelcheck_comm_determinism();
478 initial_global_state = xbt_new0(s_mc_global_t, 1);
479 initial_global_state->snapshot = simgrid::mc::take_snapshot(0);
480 initial_global_state->initial_communications_pattern_done = 0;
481 initial_global_state->recv_deterministic = 1;
482 initial_global_state->send_deterministic = 1;
483 initial_global_state->recv_diff = nullptr;
484 initial_global_state->send_diff = nullptr;
486 return MC_modelcheck_comm_determinism_main();