1 /* Copyright (c) 2007-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. */
7 #include "smx_private.h"
11 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_synchro, simix,
12 "Logging specific to SIMIX (synchronization)");
14 static smx_action_t SIMIX_synchro_wait(smx_host_t smx_host, double timeout);
15 static void SIMIX_synchro_finish(smx_action_t action);
16 static void _SIMIX_cond_wait(smx_cond_t cond, smx_mutex_t mutex, double timeout,
17 smx_process_t issuer, smx_simcall_t simcall);
18 static void _SIMIX_sem_wait(smx_sem_t sem, double timeout, smx_process_t issuer,
19 smx_simcall_t simcall);
21 /***************************** Synchro action *********************************/
23 static smx_action_t SIMIX_synchro_wait(smx_host_t smx_host, double timeout)
25 XBT_IN("(%p, %f)",smx_host,timeout);
28 action = xbt_mallocator_get(simix_global->action_mallocator);
29 action->type = SIMIX_ACTION_SYNCHRO;
30 action->name = xbt_strdup("synchro");
31 action->synchro.sleep =
32 surf_workstation_sleep(smx_host, timeout);
34 surf_action_set_data(action->synchro.sleep, action);
39 void SIMIX_synchro_stop_waiting(smx_process_t process, smx_simcall_t simcall)
41 XBT_IN("(%p, %p)",process,simcall);
42 switch (simcall->call) {
44 case SIMCALL_MUTEX_LOCK:
45 xbt_swag_remove(process, simcall_mutex_lock__get__mutex(simcall)->sleeping);
48 case SIMCALL_COND_WAIT:
49 xbt_swag_remove(process, simcall_cond_wait__get__cond(simcall)->sleeping);
52 case SIMCALL_COND_WAIT_TIMEOUT:
53 xbt_swag_remove(process, simcall_cond_wait_timeout__get__cond(simcall)->sleeping);
56 case SIMCALL_SEM_ACQUIRE:
57 xbt_swag_remove(process, simcall_sem_acquire__get__sem(simcall)->sleeping);
60 case SIMCALL_SEM_ACQUIRE_TIMEOUT:
61 xbt_swag_remove(process, simcall_sem_acquire_timeout__get__sem(simcall)->sleeping);
70 void SIMIX_synchro_destroy(smx_action_t action)
72 XBT_IN("(%p)",action);
73 XBT_DEBUG("Destroying synchro %p", action);
74 xbt_assert(action->type == SIMIX_ACTION_SYNCHRO);
75 surf_action_unref(action->synchro.sleep);
76 xbt_free(action->name);
77 xbt_mallocator_release(simix_global->action_mallocator, action);
81 void SIMIX_post_synchro(smx_action_t action)
83 XBT_IN("(%p)",action);
84 xbt_assert(action->type == SIMIX_ACTION_SYNCHRO);
85 if (surf_action_get_state(action->synchro.sleep) == SURF_ACTION_FAILED)
86 action->state = SIMIX_FAILED;
87 else if(surf_action_get_state(action->synchro.sleep) == SURF_ACTION_DONE)
88 action->state = SIMIX_SRC_TIMEOUT;
90 SIMIX_synchro_finish(action);
94 static void SIMIX_synchro_finish(smx_action_t action)
96 XBT_IN("(%p)",action);
97 smx_simcall_t simcall = xbt_fifo_shift(action->simcalls);
99 switch (action->state) {
101 case SIMIX_SRC_TIMEOUT:
102 SMX_EXCEPTION(simcall->issuer, timeout_error, 0, "Synchro's wait timeout");
106 simcall->issuer->context->iwannadie = 1;
107 // SMX_EXCEPTION(simcall->issuer, host_error, 0, "Host failed");
115 SIMIX_synchro_stop_waiting(simcall->issuer, simcall);
116 simcall->issuer->waiting_action = NULL;
117 SIMIX_synchro_destroy(action);
118 SIMIX_simcall_answer(simcall);
121 /*********************************** Mutex ************************************/
123 smx_mutex_t SIMIX_pre_mutex_init(smx_simcall_t simcall){
124 return SIMIX_mutex_init();
127 * \brief Initialize a mutex.
129 * Allocs and creates the data for the mutex.
132 smx_mutex_t SIMIX_mutex_init(void)
135 s_smx_process_t p; /* useful to initialize sleeping swag */
137 smx_mutex_t mutex = xbt_new0(s_smx_mutex_t, 1);
139 mutex->sleeping = xbt_swag_new(xbt_swag_offset(p, synchro_hookup));
145 * \brief Handles a mutex lock simcall.
146 * \param simcall the simcall
148 void SIMIX_pre_mutex_lock(smx_simcall_t simcall, smx_mutex_t mutex)
150 XBT_IN("(%p)",simcall);
151 /* FIXME: check where to validate the arguments */
152 smx_action_t sync_act = NULL;
153 smx_process_t process = simcall->issuer;
156 /* FIXME: check if the host is active ? */
157 /* Somebody using the mutex, use a synchro action to get host failures */
158 sync_act = SIMIX_synchro_wait(process->smx_host, -1);
159 xbt_fifo_push(sync_act->simcalls, simcall);
160 simcall->issuer->waiting_action = sync_act;
161 xbt_swag_insert(simcall->issuer, mutex->sleeping);
165 mutex->owner = simcall->issuer;
166 SIMIX_simcall_answer(simcall);
171 int SIMIX_pre_mutex_trylock(smx_simcall_t simcall, smx_mutex_t mutex){
172 return SIMIX_mutex_trylock(mutex, simcall->issuer);
175 * \brief Tries to lock a mutex.
177 * Tries to lock a mutex, return 1 if the mutex is unlocked, else 0.
178 * This function does not block and wait for the mutex to be unlocked.
179 * \param mutex The mutex
180 * \param issuer The process that tries to acquire the mutex
181 * \return 1 - mutex free, 0 - mutex used
183 int SIMIX_mutex_trylock(smx_mutex_t mutex, smx_process_t issuer)
185 XBT_IN("(%p, %p)",mutex,issuer);
192 mutex->owner = issuer;
197 void SIMIX_pre_mutex_unlock(smx_simcall_t simcall, smx_mutex_t mutex){
198 SIMIX_mutex_unlock(mutex, simcall->issuer);
201 * \brief Unlocks a mutex.
203 * Unlocks the mutex and gives it to a process waiting for it.
204 * If the unlocker is not the owner of the mutex nothing happens.
205 * If there are no process waiting, it sets the mutex as free.
206 * \param mutex The mutex
207 * \param issuer The process trying to unlock the mutex
209 void SIMIX_mutex_unlock(smx_mutex_t mutex, smx_process_t issuer)
211 XBT_IN("(%p, %p)",mutex,issuer);
212 smx_process_t p; /*process to wake up */
214 /* If the mutex is not owned by the issuer do nothing */
215 if (issuer != mutex->owner){
220 if (xbt_swag_size(mutex->sleeping) > 0) {
221 p = xbt_swag_extract(mutex->sleeping);
222 SIMIX_synchro_destroy(p->waiting_action);
223 p->waiting_action = NULL;
225 SIMIX_simcall_answer(&p->simcall);
227 /* nobody to wake up */
234 void SIMIX_pre_mutex_destroy(smx_simcall_t simcall, smx_mutex_t mutex){
235 SIMIX_mutex_destroy(mutex);
238 * \brief Destroys a mutex.
240 * Destroys and frees the mutex's memory.
241 * \param mutex A mutex
243 void SIMIX_mutex_destroy(smx_mutex_t mutex)
245 XBT_IN("(%p)",mutex);
247 xbt_swag_free(mutex->sleeping);
253 /********************************* Condition **********************************/
255 smx_cond_t SIMIX_pre_cond_init(smx_simcall_t simcall){
256 return SIMIX_cond_init();
259 * \brief Initialize a condition.
261 * Allocates and creates the data for the condition.
262 * It have to be called before the use of the condition.
263 * \return A condition
265 smx_cond_t SIMIX_cond_init(void)
269 smx_cond_t cond = xbt_new0(s_smx_cond_t, 1);
270 cond->sleeping = xbt_swag_new(xbt_swag_offset(p, synchro_hookup));
277 * \brief Handle a condition waiting simcall without timeouts
278 * \param simcall the simcall
280 void SIMIX_pre_cond_wait(smx_simcall_t simcall, smx_cond_t cond, smx_mutex_t mutex)
282 XBT_IN("(%p)",simcall);
283 smx_process_t issuer = simcall->issuer;
285 _SIMIX_cond_wait(cond, mutex, -1, issuer, simcall);
290 * \brief Handle a condition waiting simcall with timeouts
291 * \param simcall the simcall
293 void SIMIX_pre_cond_wait_timeout(smx_simcall_t simcall, smx_cond_t cond,
294 smx_mutex_t mutex, double timeout)
296 XBT_IN("(%p)",simcall);
297 smx_process_t issuer = simcall->issuer;
299 _SIMIX_cond_wait(cond, mutex, timeout, issuer, simcall);
304 static void _SIMIX_cond_wait(smx_cond_t cond, smx_mutex_t mutex, double timeout,
305 smx_process_t issuer, smx_simcall_t simcall)
307 XBT_IN("(%p, %p, %f, %p,%p)",cond,mutex,timeout,issuer,simcall);
308 smx_action_t sync_act = NULL;
310 XBT_DEBUG("Wait condition %p", cond);
312 /* If there is a mutex unlock it */
313 /* FIXME: what happens if the issuer is not the owner of the mutex? */
316 SIMIX_mutex_unlock(mutex, issuer);
319 sync_act = SIMIX_synchro_wait(issuer->smx_host, timeout);
320 xbt_fifo_unshift(sync_act->simcalls, simcall);
321 issuer->waiting_action = sync_act;
322 xbt_swag_insert(simcall->issuer, cond->sleeping);
326 void SIMIX_pre_cond_signal(smx_simcall_t simcall, smx_cond_t cond){
327 SIMIX_cond_signal(cond);
330 * \brief Signalizes a condition.
332 * Signalizes a condition and wakes up a sleeping process.
333 * If there are no process sleeping, no action is done.
334 * \param cond A condition
336 void SIMIX_cond_signal(smx_cond_t cond)
339 smx_process_t proc = NULL;
340 smx_mutex_t mutex = NULL;
341 smx_simcall_t simcall = NULL;
343 XBT_DEBUG("Signal condition %p", cond);
345 /* If there are processes waiting for the condition choose one and try
346 to make it acquire the mutex */
347 if ((proc = xbt_swag_extract(cond->sleeping))) {
349 /* Destroy waiter's synchro action */
350 SIMIX_synchro_destroy(proc->waiting_action);
351 proc->waiting_action = NULL;
353 /* Now transform the cond wait simcall into a mutex lock one */
354 simcall = &proc->simcall;
355 if(simcall->call == SIMCALL_COND_WAIT)
356 mutex = simcall_cond_wait__get__mutex(simcall);
358 mutex = simcall_cond_wait_timeout__get__mutex(simcall);
359 simcall->call = SIMCALL_MUTEX_LOCK;
361 SIMIX_pre_mutex_lock(simcall, mutex);
366 void SIMIX_pre_cond_broadcast(smx_simcall_t simcall, smx_cond_t cond){
367 SIMIX_cond_broadcast(cond);
370 * \brief Broadcasts a condition.
372 * Signal ALL processes waiting on a condition.
373 * If there are no process waiting, no action is done.
374 * \param cond A condition
376 void SIMIX_cond_broadcast(smx_cond_t cond)
379 XBT_DEBUG("Broadcast condition %p", cond);
381 /* Signal the condition until nobody is waiting on it */
382 while (xbt_swag_size(cond->sleeping)) {
383 SIMIX_cond_signal(cond);
388 void SIMIX_pre_cond_destroy(smx_simcall_t simcall, smx_cond_t cond){
389 SIMIX_cond_destroy(cond);
392 * \brief Destroys a contidion.
394 * Destroys and frees the condition's memory.
395 * \param cond A condition
397 void SIMIX_cond_destroy(smx_cond_t cond)
400 XBT_DEBUG("Destroy condition %p", cond);
403 xbt_assert(xbt_swag_size(cond->sleeping) == 0,
404 "Cannot destroy conditional since someone is still using it");
406 xbt_swag_free(cond->sleeping);
412 /******************************** Semaphores **********************************/
413 #define SMX_SEM_NOLIMIT 99999
414 smx_sem_t SIMIX_pre_sem_init(smx_simcall_t simcall, unsigned int value){
415 return SIMIX_sem_init(value);
417 /** @brief Initialize a semaphore */
418 smx_sem_t SIMIX_sem_init(unsigned int value)
420 XBT_IN("(%u)",value);
423 smx_sem_t sem = xbt_new0(s_smx_sem_t, 1);
424 sem->sleeping = xbt_swag_new(xbt_swag_offset(p, synchro_hookup));
430 void SIMIX_pre_sem_destroy(smx_simcall_t simcall, smx_sem_t sem){
431 SIMIX_sem_destroy(sem);
433 /** @brief Destroys a semaphore */
434 void SIMIX_sem_destroy(smx_sem_t sem)
437 XBT_DEBUG("Destroy semaphore %p", sem);
439 xbt_assert(xbt_swag_size(sem->sleeping) == 0,
440 "Cannot destroy semaphore since someone is still using it");
441 xbt_swag_free(sem->sleeping);
447 void SIMIX_pre_sem_release(smx_simcall_t simcall, smx_sem_t sem){
448 SIMIX_sem_release(sem);
450 /** @brief release the semaphore
452 * Unlock a process waiting on the semaphore.
453 * If no one was blocked, the semaphore capacity is increased by 1.
455 void SIMIX_sem_release(smx_sem_t sem)
460 XBT_DEBUG("Sem release semaphore %p", sem);
461 if ((proc = xbt_swag_extract(sem->sleeping))) {
462 SIMIX_synchro_destroy(proc->waiting_action);
463 proc->waiting_action = NULL;
464 SIMIX_simcall_answer(&proc->simcall);
465 } else if (sem->value < SMX_SEM_NOLIMIT) {
471 /** @brief Returns true if acquiring this semaphore would block */
472 int SIMIX_sem_would_block(smx_sem_t sem)
476 return (sem->value <= 0);
479 int SIMIX_pre_sem_get_capacity(smx_simcall_t simcall, smx_sem_t sem){
480 return SIMIX_sem_get_capacity(sem);
482 /** @brief Returns the current capacity of the semaphore */
483 int SIMIX_sem_get_capacity(smx_sem_t sem)
490 static void _SIMIX_sem_wait(smx_sem_t sem, double timeout, smx_process_t issuer,
491 smx_simcall_t simcall)
493 XBT_IN("(%p, %f, %p, %p)",sem,timeout,issuer,simcall);
494 smx_action_t sync_act = NULL;
496 XBT_DEBUG("Wait semaphore %p (timeout:%f)", sem, timeout);
497 if (sem->value <= 0) {
498 sync_act = SIMIX_synchro_wait(issuer->smx_host, timeout);
499 xbt_fifo_unshift(sync_act->simcalls, simcall);
500 issuer->waiting_action = sync_act;
501 xbt_swag_insert(issuer, sem->sleeping);
504 SIMIX_simcall_answer(simcall);
510 * \brief Handles a sem acquire simcall without timeout.
511 * \param simcall the simcall
513 void SIMIX_pre_sem_acquire(smx_simcall_t simcall, smx_sem_t sem)
515 XBT_IN("(%p)",simcall);
516 _SIMIX_sem_wait(sem, -1, simcall->issuer, simcall);
521 * \brief Handles a sem acquire simcall with timeout.
522 * \param simcall the simcall
524 void SIMIX_pre_sem_acquire_timeout(smx_simcall_t simcall, smx_sem_t sem, double timeout)
526 XBT_IN("(%p)",simcall);
527 _SIMIX_sem_wait(sem, timeout, simcall->issuer, simcall);