1 /* Copyright (c) 2007-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. */
7 #include "src/surf/surf_interface.hpp"
8 #include "smx_private.h"
11 #include "src/simix/SynchroRaw.hpp"
13 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_synchro, simix,
14 "SIMIX Synchronization (mutex, semaphores and conditions)");
16 static smx_synchro_t SIMIX_synchro_wait(sg_host_t smx_host, double timeout);
17 static void _SIMIX_cond_wait(smx_cond_t cond, smx_mutex_t mutex, double timeout,
18 smx_process_t issuer, smx_simcall_t simcall);
19 static void _SIMIX_sem_wait(smx_sem_t sem, double timeout, smx_process_t issuer,
20 smx_simcall_t simcall);
22 /***************************** Raw synchronization *********************************/
24 static smx_synchro_t SIMIX_synchro_wait(sg_host_t smx_host, double timeout)
26 XBT_IN("(%p, %f)",smx_host,timeout);
28 simgrid::simix::Raw *sync = new simgrid::simix::Raw();
30 sync->sleep = surf_host_sleep(smx_host, timeout);
31 sync->sleep->setData(sync);
36 void SIMIX_synchro_stop_waiting(smx_process_t process, smx_simcall_t simcall)
38 XBT_IN("(%p, %p)",process,simcall);
39 switch (simcall->call) {
41 case SIMCALL_MUTEX_LOCK:
42 xbt_swag_remove(process, simcall_mutex_lock__get__mutex(simcall)->sleeping);
45 case SIMCALL_COND_WAIT:
46 xbt_swag_remove(process, simcall_cond_wait__get__cond(simcall)->sleeping);
49 case SIMCALL_COND_WAIT_TIMEOUT:
50 xbt_swag_remove(process, simcall_cond_wait_timeout__get__cond(simcall)->sleeping);
53 case SIMCALL_SEM_ACQUIRE:
54 xbt_swag_remove(process, simcall_sem_acquire__get__sem(simcall)->sleeping);
57 case SIMCALL_SEM_ACQUIRE_TIMEOUT:
58 xbt_swag_remove(process, simcall_sem_acquire_timeout__get__sem(simcall)->sleeping);
67 void SIMIX_synchro_destroy(smx_synchro_t synchro)
69 XBT_DEBUG("Destroying synchro %p", synchro);
70 simgrid::simix::Raw *raw = static_cast<simgrid::simix::Raw*>(synchro);
75 void SIMIX_synchro_finish(smx_synchro_t synchro)
77 XBT_IN("(%p)",synchro);
78 smx_simcall_t simcall = (smx_simcall_t) xbt_fifo_shift(synchro->simcalls);
80 switch (synchro->state) {
82 case SIMIX_SRC_TIMEOUT:
83 SMX_EXCEPTION(simcall->issuer, timeout_error, 0, "Synchro's wait timeout");
87 simcall->issuer->context->iwannadie = 1;
88 // SMX_EXCEPTION(simcall->issuer, host_error, 0, "Host failed");
96 SIMIX_synchro_stop_waiting(simcall->issuer, simcall);
97 simcall->issuer->waiting_synchro = NULL;
98 SIMIX_synchro_destroy(synchro);
99 SIMIX_simcall_answer(simcall);
102 /*********************************** Mutex ************************************/
104 smx_mutex_t simcall_HANDLER_mutex_init(smx_simcall_t simcall){
105 return SIMIX_mutex_init();
108 * \brief Initialize a mutex.
110 * Allocs and creates the data for the mutex.
113 smx_mutex_t SIMIX_mutex_init(void)
116 s_smx_process_t p; /* useful to initialize sleeping swag */
118 smx_mutex_t mutex = xbt_new0(s_smx_mutex_t, 1);
120 mutex->sleeping = xbt_swag_new(xbt_swag_offset(p, synchro_hookup));
126 * \brief Handles a mutex lock simcall.
127 * \param simcall the simcall
129 void simcall_HANDLER_mutex_lock(smx_simcall_t simcall, smx_mutex_t mutex)
131 XBT_IN("(%p)",simcall);
132 /* FIXME: check where to validate the arguments */
133 smx_synchro_t synchro = NULL;
134 smx_process_t process = simcall->issuer;
137 /* FIXME: check if the host is active ? */
138 /* Somebody using the mutex, use a synchronization to get host failures */
139 synchro = SIMIX_synchro_wait(process->host, -1);
140 xbt_fifo_push(synchro->simcalls, simcall);
141 simcall->issuer->waiting_synchro = synchro;
142 xbt_swag_insert(simcall->issuer, mutex->sleeping);
146 mutex->owner = simcall->issuer;
147 SIMIX_simcall_answer(simcall);
152 int simcall_HANDLER_mutex_trylock(smx_simcall_t simcall, smx_mutex_t mutex){
153 return SIMIX_mutex_trylock(mutex, simcall->issuer);
156 * \brief Tries to lock a mutex.
158 * Tries to lock a mutex, return 1 if the mutex is unlocked, else 0.
159 * This function does not block and wait for the mutex to be unlocked.
160 * \param mutex The mutex
161 * \param issuer The process that tries to acquire the mutex
162 * \return 1 - mutex free, 0 - mutex used
164 int SIMIX_mutex_trylock(smx_mutex_t mutex, smx_process_t issuer)
166 XBT_IN("(%p, %p)",mutex,issuer);
173 mutex->owner = issuer;
178 void simcall_HANDLER_mutex_unlock(smx_simcall_t simcall, smx_mutex_t mutex){
179 SIMIX_mutex_unlock(mutex, simcall->issuer);
182 * \brief Unlocks a mutex.
184 * Unlocks the mutex and gives it to a process waiting for it.
185 * If the unlocker is not the owner of the mutex nothing happens.
186 * If there are no process waiting, it sets the mutex as free.
187 * \param mutex The mutex
188 * \param issuer The process trying to unlock the mutex
190 void SIMIX_mutex_unlock(smx_mutex_t mutex, smx_process_t issuer)
192 XBT_IN("(%p, %p)",mutex,issuer);
194 /* If the mutex is not owned by the issuer, that's not good */
195 if (issuer != mutex->owner)
196 THROWF(mismatch_error, 0, "Cannot release that mutex: it was locked by %s (pid:%d), not by you.",
197 SIMIX_process_get_name(mutex->owner),SIMIX_process_get_PID(mutex->owner));
199 if (xbt_swag_size(mutex->sleeping) > 0) {
200 /*process to wake up */
201 smx_process_t p = (smx_process_t) xbt_swag_extract(mutex->sleeping);
202 SIMIX_synchro_destroy(p->waiting_synchro);
203 p->waiting_synchro = NULL;
205 SIMIX_simcall_answer(&p->simcall);
207 /* nobody to wake up */
215 * \brief Destroys a mutex.
217 * Destroys and frees the mutex's memory.
218 * \param mutex A mutex
220 void SIMIX_mutex_destroy(smx_mutex_t mutex)
222 XBT_IN("(%p)",mutex);
224 xbt_swag_free(mutex->sleeping);
230 /********************************* Condition **********************************/
233 * \brief Initialize a condition.
235 * Allocates and creates the data for the condition.
236 * It have to be called before the use of the condition.
237 * \return A condition
239 smx_cond_t SIMIX_cond_init(void)
243 smx_cond_t cond = xbt_new0(s_smx_cond_t, 1);
244 cond->sleeping = xbt_swag_new(xbt_swag_offset(p, synchro_hookup));
251 * \brief Handle a condition waiting simcall without timeouts
252 * \param simcall the simcall
254 void simcall_HANDLER_cond_wait(smx_simcall_t simcall, smx_cond_t cond, smx_mutex_t mutex)
256 XBT_IN("(%p)",simcall);
257 smx_process_t issuer = simcall->issuer;
259 _SIMIX_cond_wait(cond, mutex, -1, issuer, simcall);
264 * \brief Handle a condition waiting simcall with timeouts
265 * \param simcall the simcall
267 void simcall_HANDLER_cond_wait_timeout(smx_simcall_t simcall, smx_cond_t cond,
268 smx_mutex_t mutex, double timeout)
270 XBT_IN("(%p)",simcall);
271 smx_process_t issuer = simcall->issuer;
273 _SIMIX_cond_wait(cond, mutex, timeout, issuer, simcall);
278 static void _SIMIX_cond_wait(smx_cond_t cond, smx_mutex_t mutex, double timeout,
279 smx_process_t issuer, smx_simcall_t simcall)
281 XBT_IN("(%p, %p, %f, %p,%p)",cond,mutex,timeout,issuer,simcall);
282 smx_synchro_t synchro = NULL;
284 XBT_DEBUG("Wait condition %p", cond);
286 /* If there is a mutex unlock it */
287 /* FIXME: what happens if the issuer is not the owner of the mutex? */
290 SIMIX_mutex_unlock(mutex, issuer);
293 synchro = SIMIX_synchro_wait(issuer->host, timeout);
294 xbt_fifo_unshift(synchro->simcalls, simcall);
295 issuer->waiting_synchro = synchro;
296 xbt_swag_insert(simcall->issuer, cond->sleeping);
301 * \brief Signalizes a condition.
303 * Signalizes a condition and wakes up a sleeping process.
304 * If there are no process sleeping, no action is done.
305 * \param cond A condition
307 void SIMIX_cond_signal(smx_cond_t cond)
310 smx_process_t proc = NULL;
311 smx_mutex_t mutex = NULL;
312 smx_simcall_t simcall = NULL;
314 XBT_DEBUG("Signal condition %p", cond);
316 /* If there are processes waiting for the condition choose one and try
317 to make it acquire the mutex */
318 if ((proc = (smx_process_t) xbt_swag_extract(cond->sleeping))) {
320 /* Destroy waiter's synchronization */
321 SIMIX_synchro_destroy(proc->waiting_synchro);
322 proc->waiting_synchro = NULL;
324 /* Now transform the cond wait simcall into a mutex lock one */
325 simcall = &proc->simcall;
326 if(simcall->call == SIMCALL_COND_WAIT)
327 mutex = simcall_cond_wait__get__mutex(simcall);
329 mutex = simcall_cond_wait_timeout__get__mutex(simcall);
330 simcall->call = SIMCALL_MUTEX_LOCK;
332 simcall_HANDLER_mutex_lock(simcall, mutex);
338 * \brief Broadcasts a condition.
340 * Signal ALL processes waiting on a condition.
341 * If there are no process waiting, no action is done.
342 * \param cond A condition
344 void SIMIX_cond_broadcast(smx_cond_t cond)
347 XBT_DEBUG("Broadcast condition %p", cond);
349 /* Signal the condition until nobody is waiting on it */
350 while (xbt_swag_size(cond->sleeping)) {
351 SIMIX_cond_signal(cond);
357 * \brief Destroys a condition.
359 * Destroys and frees the condition's memory.
360 * \param cond A condition
362 void SIMIX_cond_destroy(smx_cond_t cond)
365 XBT_DEBUG("Destroy condition %p", cond);
368 xbt_assert(xbt_swag_size(cond->sleeping) == 0,
369 "Cannot destroy conditional since someone is still using it");
371 xbt_swag_free(cond->sleeping);
377 /******************************** Semaphores **********************************/
378 #define SMX_SEM_NOLIMIT 99999
379 /** @brief Initialize a semaphore */
380 smx_sem_t SIMIX_sem_init(unsigned int value)
382 XBT_IN("(%u)",value);
385 smx_sem_t sem = xbt_new0(s_smx_sem_t, 1);
386 sem->sleeping = xbt_swag_new(xbt_swag_offset(p, synchro_hookup));
392 /** @brief Destroys a semaphore */
393 void SIMIX_sem_destroy(smx_sem_t sem)
396 XBT_DEBUG("Destroy semaphore %p", sem);
398 xbt_assert(xbt_swag_size(sem->sleeping) == 0,
399 "Cannot destroy semaphore since someone is still using it");
400 xbt_swag_free(sem->sleeping);
406 void simcall_HANDLER_sem_release(smx_simcall_t simcall, smx_sem_t sem){
407 SIMIX_sem_release(sem);
409 /** @brief release the semaphore
411 * Unlock a process waiting on the semaphore.
412 * If no one was blocked, the semaphore capacity is increased by 1.
414 void SIMIX_sem_release(smx_sem_t sem)
419 XBT_DEBUG("Sem release semaphore %p", sem);
420 if ((proc = (smx_process_t) xbt_swag_extract(sem->sleeping))) {
421 SIMIX_synchro_destroy(proc->waiting_synchro);
422 proc->waiting_synchro = NULL;
423 SIMIX_simcall_answer(&proc->simcall);
424 } else if (sem->value < SMX_SEM_NOLIMIT) {
430 /** @brief Returns true if acquiring this semaphore would block */
431 int SIMIX_sem_would_block(smx_sem_t sem)
435 return (sem->value <= 0);
438 int simcall_HANDLER_sem_get_capacity(smx_simcall_t simcall, smx_sem_t sem){
439 return SIMIX_sem_get_capacity(sem);
441 /** @brief Returns the current capacity of the semaphore */
442 int SIMIX_sem_get_capacity(smx_sem_t sem)
449 static void _SIMIX_sem_wait(smx_sem_t sem, double timeout, smx_process_t issuer,
450 smx_simcall_t simcall)
452 XBT_IN("(%p, %f, %p, %p)",sem,timeout,issuer,simcall);
453 smx_synchro_t synchro = NULL;
455 XBT_DEBUG("Wait semaphore %p (timeout:%f)", sem, timeout);
456 if (sem->value <= 0) {
457 synchro = SIMIX_synchro_wait(issuer->host, timeout);
458 xbt_fifo_unshift(synchro->simcalls, simcall);
459 issuer->waiting_synchro = synchro;
460 xbt_swag_insert(issuer, sem->sleeping);
463 SIMIX_simcall_answer(simcall);
469 * \brief Handles a sem acquire simcall without timeout.
470 * \param simcall the simcall
472 void simcall_HANDLER_sem_acquire(smx_simcall_t simcall, smx_sem_t sem)
474 XBT_IN("(%p)",simcall);
475 _SIMIX_sem_wait(sem, -1, simcall->issuer, simcall);
480 * \brief Handles a sem acquire simcall with timeout.
481 * \param simcall the simcall
483 void simcall_HANDLER_sem_acquire_timeout(smx_simcall_t simcall, smx_sem_t sem, double timeout)
485 XBT_IN("(%p)",simcall);
486 _SIMIX_sem_wait(sem, timeout, simcall->issuer, simcall);
489 int simcall_HANDLER_sem_would_block(smx_simcall_t simcall, smx_sem_t sem) {
490 return SIMIX_sem_would_block(sem);