Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
fix some more MC examples
[simgrid.git] / src / mc / mc_base.cpp
1 /* Copyright (c) 2008-2017. The SimGrid Team. All rights reserved.          */
2
3 /* This program is free software; you can redistribute it and/or modify it
4  * under the terms of the license (GNU LGPL) which comes with this package. */
5
6 #include <simgrid_config.h>
7
8 #include "mc/mc.h"
9 #include "src/mc/mc_base.h"
10 #include "src/mc/mc_replay.h"
11 #include "src/simix/smx_private.h"
12
13 #if SIMGRID_HAVE_MC
14 #include "src/mc/ModelChecker.hpp"
15
16 using simgrid::mc::remote;
17 #endif
18
19 XBT_LOG_NEW_DEFAULT_CATEGORY(mc, "All MC categories");
20
21 int MC_random(int min, int max)
22 {
23 #if SIMGRID_HAVE_MC
24   xbt_assert(mc_model_checker == nullptr);
25 #endif
26   /* TODO, if the MC is disabled we do not really need to make a simcall for this :) */
27   return simcall_mc_random(min, max);
28 }
29
30 namespace simgrid {
31 namespace mc {
32
33 void wait_for_requests()
34 {
35 #if SIMGRID_HAVE_MC
36   xbt_assert(mc_model_checker == nullptr);
37 #endif
38
39   smx_actor_t process;
40   smx_simcall_t req;
41   unsigned int iter;
42
43   while (not xbt_dynar_is_empty(simix_global->process_to_run)) {
44     SIMIX_process_runall();
45     xbt_dynar_foreach(simix_global->process_that_ran, iter, process) {
46       req = &process->simcall;
47       if (req->call != SIMCALL_NONE && not simgrid::mc::request_is_visible(req))
48         SIMIX_simcall_handle(req, 0);
49     }
50   }
51 #if SIMGRID_HAVE_MC
52   xbt_dynar_reset(simix_global->actors_vector);
53   for (std::pair<aid_t, smx_actor_t> kv : simix_global->process_list) {
54     xbt_dynar_push_as(simix_global->actors_vector, smx_actor_t, kv.second);
55   }
56 #endif
57 }
58
59 /** @brief returns if there this transition can proceed in a finite amount of time
60  *
61  * It is used in the model-checker to not get into self-deadlock where it would execute a never ending transition.
62  *
63  * Only WAIT operations (on comm, on mutex, etc) can ever return false because they could lock the MC exploration.
64  * Wait operations are OK and return true in only two situations:
65  *  - if the wait will succeed immediately (if both peer of the comm are there already or if the mutex is available)
66  *  - if a timeout is provided, because we can fire the timeout if the transition is not ready without blocking in this transition for ever.
67  *
68  */
69 // Called from both MCer and MCed:
70 bool request_is_enabled(smx_simcall_t req)
71 {
72   // TODO, add support for the subtypes?
73
74   switch (req->call) {
75   case SIMCALL_NONE:
76     return false;
77
78   case SIMCALL_COMM_WAIT:
79   {
80     /* FIXME: check also that src and dst processes are not suspended */
81     simgrid::kernel::activity::CommImpl* act =
82         static_cast<simgrid::kernel::activity::CommImpl*>(simcall_comm_wait__getraw__comm(req));
83
84 #if SIMGRID_HAVE_MC
85     // Fetch from MCed memory:
86     // HACK, type puning
87     if (mc_model_checker != nullptr) {
88       simgrid::mc::Remote<simgrid::kernel::activity::CommImpl> temp_comm;
89       mc_model_checker->process().read(temp_comm, remote(act));
90       act = static_cast<simgrid::kernel::activity::CommImpl*>(temp_comm.getBuffer());
91     }
92 #endif
93
94     if (simcall_comm_wait__get__timeout(req) >= 0) {
95       /* If it has a timeout it will be always be enabled, because even if the
96        * communication is not ready, it can timeout and won't block. */
97       if (_sg_mc_timeout == 1)
98         return true;
99     }
100     /* On the other hand if it hasn't a timeout, check if the comm is ready.*/
101     else if (act->detached && act->src_proc == nullptr
102           && act->type == SIMIX_COMM_READY)
103         return (act->dst_proc != nullptr);
104     return (act->src_proc && act->dst_proc);
105   }
106
107   case SIMCALL_COMM_WAITANY: {
108     xbt_dynar_t comms;
109     simgrid::kernel::activity::CommImpl* act =
110         static_cast<simgrid::kernel::activity::CommImpl*>(simcall_comm_wait__getraw__comm(req));
111
112 #if SIMGRID_HAVE_MC
113     s_xbt_dynar_t comms_buffer;
114     size_t buffer_size = 0;
115     if (mc_model_checker != nullptr) {
116       // Read dynar:
117       mc_model_checker->process().read(
118         &comms_buffer, remote(simcall_comm_waitany__get__comms(req)));
119       assert(comms_buffer.elmsize == sizeof(act));
120       buffer_size = comms_buffer.elmsize * comms_buffer.used;
121       comms = &comms_buffer;
122     } else
123       comms = simcall_comm_waitany__get__comms(req);
124
125     // Read all the dynar buffer:
126     char buffer[buffer_size];
127     if (mc_model_checker != nullptr)
128       mc_model_checker->process().read_bytes(buffer, sizeof(buffer),
129         remote(comms->data));
130 #else
131     comms = simcall_comm_waitany__get__comms(req);
132 #endif
133
134     for (unsigned int index = 0; index < comms->used; ++index) {
135 #if SIMGRID_HAVE_MC
136       // Fetch act from MCed memory:
137       // HACK, type puning
138       simgrid::mc::Remote<simgrid::kernel::activity::CommImpl> temp_comm;
139       if (mc_model_checker != nullptr) {
140         memcpy(&act, buffer + comms->elmsize * index, sizeof(act));
141         mc_model_checker->process().read(temp_comm, remote(act));
142         act = static_cast<simgrid::kernel::activity::CommImpl*>(temp_comm.getBuffer());
143       }
144       else
145 #endif
146         act = xbt_dynar_get_as(comms, index, simgrid::kernel::activity::CommImpl*);
147       if (act->src_proc && act->dst_proc)
148         return true;
149     }
150     return false;
151   }
152
153   case SIMCALL_MUTEX_LOCK: {
154     smx_mutex_t mutex = simcall_mutex_lock__get__mutex(req);
155 #if SIMGRID_HAVE_MC
156     simgrid::mc::Remote<simgrid::simix::MutexImpl> temp_mutex;
157     if (mc_model_checker != nullptr) {
158       mc_model_checker->process().read(temp_mutex.getBuffer(), remote(mutex));
159       mutex = temp_mutex.getBuffer();
160     }
161 #endif
162
163     if(mutex->owner == nullptr)
164       return true;
165 #if SIMGRID_HAVE_MC
166     else if (mc_model_checker != nullptr) {
167       simgrid::mc::Process& modelchecked = mc_model_checker->process();
168       // TODO, *(mutex->owner) :/
169       return modelchecked.resolveActor(simgrid::mc::remote(mutex->owner))->pid ==
170              modelchecked.resolveActor(simgrid::mc::remote(req->issuer))->pid;
171     }
172 #endif
173     else
174       return mutex->owner->pid == req->issuer->pid;
175     }
176
177     case SIMCALL_SEM_ACQUIRE: {
178       static int warned = 0;
179       if (not warned)
180         XBT_INFO("Using semaphore in model-checked code is still experimental. Use at your own risk");
181       warned = 1;
182       return true;
183     }
184
185     case SIMCALL_COND_WAIT: {
186       static int warned = 0;
187       if (not warned)
188         XBT_INFO("Using condition variables in model-checked code is still experimental. Use at your own risk");
189       warned = 1;
190       return true;
191     }
192
193     default:
194       /* The rest of the requests are always enabled */
195       return true;
196   }
197 }
198
199 bool request_is_visible(smx_simcall_t req)
200 {
201   return req->call == SIMCALL_COMM_ISEND
202       || req->call == SIMCALL_COMM_IRECV
203       || req->call == SIMCALL_COMM_WAIT
204       || req->call == SIMCALL_COMM_WAITANY
205       || req->call == SIMCALL_COMM_TEST
206       || req->call == SIMCALL_COMM_TESTANY
207       || req->call == SIMCALL_MC_RANDOM
208       || req->call == SIMCALL_MUTEX_LOCK
209       || req->call == SIMCALL_MUTEX_TRYLOCK
210       ;
211 }
212
213 }
214 }
215
216 static int prng_random(int min, int max)
217 {
218   unsigned long output_size = ((unsigned long) max - (unsigned long) min) + 1;
219   unsigned long input_size = (unsigned long) RAND_MAX + 1;
220   unsigned long reject_size = input_size % output_size;
221   unsigned long accept_size = input_size - reject_size; // module*accept_size
222
223   // Use rejection in order to avoid skew
224   unsigned long x;
225   do {
226 #ifndef _WIN32
227     x = (unsigned long) random();
228 #else
229     x = (unsigned long) rand();
230 #endif
231   } while( x >= accept_size );
232   return min + (x % output_size);
233 }
234
235 int simcall_HANDLER_mc_random(smx_simcall_t simcall, int min, int max)
236 {
237   if (not MC_is_active() && not MC_record_path)
238     return prng_random(min, max);
239   return simcall->mc_value;
240 }