Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
MC: checker kindly ask the app whether an actor is enabled instead of reading tons...
[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, "This must be called from the client");
37 #endif
38
39   smx_actor_t process;
40   unsigned int iter;
41
42   while (not xbt_dynar_is_empty(simix_global->process_to_run)) {
43     SIMIX_process_runall();
44     xbt_dynar_foreach(simix_global->process_that_ran, iter, process) {
45       smx_simcall_t req = &process->simcall;
46       if (req->call != SIMCALL_NONE && not simgrid::mc::request_is_visible(req))
47         SIMIX_simcall_handle(req, 0);
48     }
49   }
50 #if SIMGRID_HAVE_MC
51   xbt_dynar_reset(simix_global->actors_vector);
52   for (std::pair<aid_t, smx_actor_t> kv : simix_global->process_list) {
53     xbt_dynar_push_as(simix_global->actors_vector, smx_actor_t, kv.second);
54   }
55 #endif
56 }
57
58 /** @brief returns if there this transition can proceed in a finite amount of time
59  *
60  * It is used in the model-checker to not get into self-deadlock where it would execute a never ending transition.
61  *
62  * Only WAIT operations (on comm, on mutex, etc) can ever return false because they could lock the MC exploration.
63  * Wait operations are OK and return true in only two situations:
64  *  - if the wait will succeed immediately (if both peer of the comm are there already or if the mutex is available)
65  *  - if a timeout is provided, because we can fire the timeout if the transition is not ready without blocking in this
66  * transition for ever.
67  *
68  */
69 // Called from both MCer and MCed:
70 bool actor_is_enabled(smx_actor_t actor)
71 {
72 #if SIMGRID_HAVE_MC
73   // If in the MCer, ask the client app since it has all the data
74   if (mc_model_checker != nullptr) {
75     return mc_model_checker->process().actor_is_enabled(actor->pid);
76   }
77 #endif
78
79   // Now, we are in the client app, no need for remote memory reading.
80   smx_simcall_t req = &actor->simcall;
81
82   switch (req->call) {
83     case SIMCALL_NONE:
84       return false;
85
86     case SIMCALL_COMM_WAIT: {
87       /* FIXME: check also that src and dst processes are not suspended */
88       simgrid::kernel::activity::CommImpl* act =
89           static_cast<simgrid::kernel::activity::CommImpl*>(simcall_comm_wait__getraw__comm(req));
90
91       if (act->src_timeout || act->dst_timeout) {
92         /* If it has a timeout it will be always be enabled (regardless of who declared the timeout),
93          * because even if the communication is not ready, it can timeout and won't block. */
94         if (_sg_mc_timeout == 1)
95           return true;
96       }
97       /* On the other hand if it hasn't a timeout, check if the comm is ready.*/
98       else if (act->detached && act->src_proc == nullptr && act->type == SIMIX_COMM_READY)
99         return (act->dst_proc != nullptr);
100       return (act->src_proc && act->dst_proc);
101     }
102
103     case SIMCALL_COMM_WAITANY: {
104       xbt_dynar_t comms;
105       simgrid::kernel::activity::CommImpl* act =
106           static_cast<simgrid::kernel::activity::CommImpl*>(simcall_comm_wait__getraw__comm(req));
107
108       comms = simcall_comm_waitany__get__comms(req);
109
110       for (unsigned int index = 0; index < comms->used; ++index) {
111         act = xbt_dynar_get_as(comms, index, simgrid::kernel::activity::CommImpl*);
112         if (act->src_proc && act->dst_proc)
113           return true;
114       }
115       return false;
116     }
117
118     case SIMCALL_MUTEX_LOCK: {
119       smx_mutex_t mutex = simcall_mutex_lock__get__mutex(req);
120
121       if (mutex->owner == nullptr)
122         return true;
123       else
124         return mutex->owner->pid == req->issuer->pid;
125     }
126
127     case SIMCALL_SEM_ACQUIRE: {
128       static int warned = 0;
129       if (not warned)
130         XBT_INFO("Using semaphore in model-checked code is still experimental. Use at your own risk");
131       warned = 1;
132       return true;
133     }
134
135     case SIMCALL_COND_WAIT: {
136       static int warned = 0;
137       if (not warned)
138         XBT_INFO("Using condition variables in model-checked code is still experimental. Use at your own risk");
139       warned = 1;
140       return true;
141     }
142
143     default:
144       /* The rest of the requests are always enabled */
145       return true;
146   }
147 }
148
149 /* This is the list of requests that are visible from the checker algorithm.
150  * Any other requests are handled right away on the application side.
151  */
152 bool request_is_visible(smx_simcall_t req)
153 {
154 #if SIMGRID_HAVE_MC
155   xbt_assert(mc_model_checker == nullptr, "This should be called from the client side");
156 #endif
157
158   return req->call == SIMCALL_COMM_ISEND
159       || req->call == SIMCALL_COMM_IRECV
160       || req->call == SIMCALL_COMM_WAIT
161       || req->call == SIMCALL_COMM_WAITANY
162       || req->call == SIMCALL_COMM_TEST
163       || req->call == SIMCALL_COMM_TESTANY
164       || req->call == SIMCALL_MC_RANDOM
165       || req->call == SIMCALL_MUTEX_LOCK
166       || req->call == SIMCALL_MUTEX_TRYLOCK
167       ;
168 }
169
170 }
171 }
172
173 static int prng_random(int min, int max)
174 {
175   unsigned long output_size = ((unsigned long) max - (unsigned long) min) + 1;
176   unsigned long input_size = (unsigned long) RAND_MAX + 1;
177   unsigned long reject_size = input_size % output_size;
178   unsigned long accept_size = input_size - reject_size; // module*accept_size
179
180   // Use rejection in order to avoid skew
181   unsigned long x;
182   do {
183 #ifndef _WIN32
184     x = (unsigned long) random();
185 #else
186     x = (unsigned long) rand();
187 #endif
188   } while( x >= accept_size );
189   return min + (x % output_size);
190 }
191
192 int simcall_HANDLER_mc_random(smx_simcall_t simcall, int min, int max)
193 {
194   if (not MC_is_active() && not MC_record_path)
195     return prng_random(min, max);
196   return simcall->mc_value;
197 }