2 /* Copyright (c) 2007-2015. The SimGrid Team.
3 * All rights reserved. */
5 /* This program is free software; you can redistribute it and/or modify it
6 * under the terms of the license (GNU LGPL) which comes with this package. */
8 #include "src/surf/surf_interface.hpp"
9 #include "smx_private.h"
12 #include "src/simix/SynchroRaw.hpp"
14 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_synchro, simix,
15 "SIMIX Synchronization (mutex, semaphores and conditions)");
17 static smx_synchro_t SIMIX_synchro_wait(sg_host_t smx_host, double timeout);
18 static void _SIMIX_cond_wait(smx_cond_t cond, smx_mutex_t mutex, double timeout,
19 smx_process_t issuer, smx_simcall_t simcall);
20 static void _SIMIX_sem_wait(smx_sem_t sem, double timeout, smx_process_t issuer,
21 smx_simcall_t simcall);
23 /***************************** Raw synchronization *********************************/
25 static smx_synchro_t SIMIX_synchro_wait(sg_host_t smx_host, double timeout)
27 XBT_IN("(%p, %f)",smx_host,timeout);
29 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_finish(smx_synchro_t synchro)
69 XBT_IN("(%p)",synchro);
70 smx_simcall_t simcall = synchro->simcalls.front();
71 synchro->simcalls.pop_front();
73 switch (synchro->state) {
75 case SIMIX_SRC_TIMEOUT:
76 SMX_EXCEPTION(simcall->issuer, timeout_error, 0, "Synchro's wait timeout");
80 simcall->issuer->context->iwannadie = 1;
81 // SMX_EXCEPTION(simcall->issuer, host_error, 0, "Host failed");
89 SIMIX_synchro_stop_waiting(simcall->issuer, simcall);
90 simcall->issuer->waiting_synchro = nullptr;
92 SIMIX_simcall_answer(simcall);
95 /*********************************** Mutex ************************************/
102 XBT_IN("(%p)", this);
103 // Useful to initialize sleeping swag:
104 simgrid::simix::Process p;
105 this->sleeping = xbt_swag_new(xbt_swag_offset(p, synchro_hookup));
111 XBT_IN("(%p)", this);
112 xbt_swag_free(this->sleeping);
116 void Mutex::lock(smx_process_t issuer)
118 XBT_IN("(%p; %p)", this, issuer);
119 /* FIXME: check where to validate the arguments */
120 smx_synchro_t synchro = nullptr;
123 /* FIXME: check if the host is active ? */
124 /* Somebody using the mutex, use a synchronization to get host failures */
125 synchro = SIMIX_synchro_wait(issuer->host, -1);
126 synchro->simcalls.push_back(&issuer->simcall);
127 issuer->waiting_synchro = synchro;
128 xbt_swag_insert(issuer, this->sleeping);
132 this->owner = issuer;
133 SIMIX_simcall_answer(&issuer->simcall);
138 /** Tries to lock the mutex for a process
140 * \param issuer the process that tries to acquire the mutex
141 * \return whether we managed to lock the mutex
143 bool Mutex::try_lock(smx_process_t issuer)
145 XBT_IN("(%p, %p)", this, issuer);
152 this->owner = issuer;
157 /** Unlock a mutex for a process
159 * Unlocks the mutex and gives it to a process waiting for it.
160 * If the unlocker is not the owner of the mutex nothing happens.
161 * If there are no process waiting, it sets the mutex as free.
163 void Mutex::unlock(smx_process_t issuer)
165 XBT_IN("(%p, %p)", this, issuer);
167 /* If the mutex is not owned by the issuer, that's not good */
168 if (issuer != this->owner)
169 THROWF(mismatch_error, 0, "Cannot release that mutex: it was locked by %s (pid:%d), not by you.",
170 SIMIX_process_get_name(this->owner),SIMIX_process_get_PID(this->owner));
172 if (xbt_swag_size(this->sleeping) > 0) {
173 /*process to wake up */
174 smx_process_t p = (smx_process_t) xbt_swag_extract(this->sleeping);
175 delete p->waiting_synchro;
176 p->waiting_synchro = nullptr;
178 SIMIX_simcall_answer(&p->simcall);
180 /* nobody to wake up */
181 this->locked = false;
182 this->owner = nullptr;
190 void SIMIX_mutex_destroy(smx_mutex_t mutex)
192 if (mutex != nullptr)
193 intrusive_ptr_release(mutex);
196 XBT_PUBLIC(smx_mutex_t) SIMIX_mutex_dup(smx_mutex_t mutex)
198 if (mutex != nullptr)
199 intrusive_ptr_add_ref(mutex);
203 smx_mutex_t simcall_HANDLER_mutex_init(smx_simcall_t simcall)
205 return new simgrid::simix::Mutex();
210 void simcall_HANDLER_mutex_lock(smx_simcall_t simcall, smx_mutex_t mutex)
212 mutex->lock(simcall->issuer);
215 int simcall_HANDLER_mutex_trylock(smx_simcall_t simcall, smx_mutex_t mutex)
217 return mutex->try_lock(simcall->issuer);
220 void simcall_HANDLER_mutex_unlock(smx_simcall_t simcall, smx_mutex_t mutex)
222 mutex->unlock(simcall->issuer);
225 /********************************* Condition **********************************/
228 * \brief Initialize a condition.
230 * Allocates and creates the data for the condition.
231 * It have to be called before the use of the condition.
232 * \return A condition
234 smx_cond_t SIMIX_cond_init(void)
237 simgrid::simix::Process p;
238 smx_cond_t cond = xbt_new0(s_smx_cond_t, 1);
239 cond->sleeping = xbt_swag_new(xbt_swag_offset(p, synchro_hookup));
240 cond->mutex = nullptr;
246 * \brief Handle a condition waiting simcall without timeouts
247 * \param simcall the simcall
249 void simcall_HANDLER_cond_wait(smx_simcall_t simcall, smx_cond_t cond, smx_mutex_t mutex)
251 XBT_IN("(%p)",simcall);
252 smx_process_t issuer = simcall->issuer;
254 _SIMIX_cond_wait(cond, mutex, -1, issuer, simcall);
259 * \brief Handle a condition waiting simcall with timeouts
260 * \param simcall the simcall
262 void simcall_HANDLER_cond_wait_timeout(smx_simcall_t simcall, smx_cond_t cond,
263 smx_mutex_t mutex, double timeout)
265 XBT_IN("(%p)",simcall);
266 smx_process_t issuer = simcall->issuer;
268 _SIMIX_cond_wait(cond, mutex, timeout, issuer, simcall);
273 static void _SIMIX_cond_wait(smx_cond_t cond, smx_mutex_t mutex, double timeout,
274 smx_process_t issuer, smx_simcall_t simcall)
276 XBT_IN("(%p, %p, %f, %p,%p)",cond,mutex,timeout,issuer,simcall);
277 smx_synchro_t synchro = nullptr;
279 XBT_DEBUG("Wait condition %p", cond);
281 /* If there is a mutex unlock it */
282 /* FIXME: what happens if the issuer is not the owner of the mutex? */
283 if (mutex != nullptr) {
285 mutex->unlock(issuer);
288 synchro = SIMIX_synchro_wait(issuer->host, timeout);
289 synchro->simcalls.push_front(simcall);
290 issuer->waiting_synchro = synchro;
291 xbt_swag_insert(simcall->issuer, cond->sleeping);
296 * \brief Signalizes a condition.
298 * Signalizes a condition and wakes up a sleeping process.
299 * If there are no process sleeping, no action is done.
300 * \param cond A condition
302 void SIMIX_cond_signal(smx_cond_t cond)
305 smx_process_t proc = nullptr;
306 smx_mutex_t mutex = nullptr;
307 smx_simcall_t simcall = nullptr;
309 XBT_DEBUG("Signal condition %p", cond);
311 /* If there are processes waiting for the condition choose one and try
312 to make it acquire the mutex */
313 if ((proc = (smx_process_t) xbt_swag_extract(cond->sleeping))) {
315 /* Destroy waiter's synchronization */
316 delete proc->waiting_synchro;
317 proc->waiting_synchro = nullptr;
319 /* Now transform the cond wait simcall into a mutex lock one */
320 simcall = &proc->simcall;
321 if(simcall->call == SIMCALL_COND_WAIT)
322 mutex = simcall_cond_wait__get__mutex(simcall);
324 mutex = simcall_cond_wait_timeout__get__mutex(simcall);
325 simcall->call = SIMCALL_MUTEX_LOCK;
327 simcall_HANDLER_mutex_lock(simcall, mutex);
333 * \brief Broadcasts a condition.
335 * Signal ALL processes waiting on a condition.
336 * If there are no process waiting, no action is done.
337 * \param cond A condition
339 void SIMIX_cond_broadcast(smx_cond_t cond)
342 XBT_DEBUG("Broadcast condition %p", cond);
344 /* Signal the condition until nobody is waiting on it */
345 while (xbt_swag_size(cond->sleeping)) {
346 SIMIX_cond_signal(cond);
352 * \brief Destroys a condition.
354 * Destroys and frees the condition's memory.
355 * \param cond A condition
357 void SIMIX_cond_destroy(smx_cond_t cond)
360 XBT_DEBUG("Destroy condition %p", cond);
362 if (cond != nullptr) {
363 xbt_assert(xbt_swag_size(cond->sleeping) == 0,
364 "Cannot destroy conditional since someone is still using it");
366 xbt_swag_free(cond->sleeping);
372 /******************************** Semaphores **********************************/
373 #define SMX_SEM_NOLIMIT 99999
374 /** @brief Initialize a semaphore */
375 smx_sem_t SIMIX_sem_init(unsigned int value)
377 XBT_IN("(%u)",value);
378 simgrid::simix::Process p;
380 smx_sem_t sem = xbt_new0(s_smx_sem_t, 1);
381 sem->sleeping = xbt_swag_new(xbt_swag_offset(p, synchro_hookup));
387 /** @brief Destroys a semaphore */
388 void SIMIX_sem_destroy(smx_sem_t sem)
391 XBT_DEBUG("Destroy semaphore %p", sem);
392 if (sem != nullptr) {
393 xbt_assert(xbt_swag_size(sem->sleeping) == 0,
394 "Cannot destroy semaphore since someone is still using it");
395 xbt_swag_free(sem->sleeping);
401 void simcall_HANDLER_sem_release(smx_simcall_t simcall, smx_sem_t sem){
402 SIMIX_sem_release(sem);
404 /** @brief release the semaphore
406 * Unlock a process waiting on the semaphore.
407 * If no one was blocked, the semaphore capacity is increased by 1.
409 void SIMIX_sem_release(smx_sem_t sem)
414 XBT_DEBUG("Sem release semaphore %p", sem);
415 if ((proc = (smx_process_t) xbt_swag_extract(sem->sleeping))) {
416 delete proc->waiting_synchro;
417 proc->waiting_synchro = nullptr;
418 SIMIX_simcall_answer(&proc->simcall);
419 } else if (sem->value < SMX_SEM_NOLIMIT) {
425 /** @brief Returns true if acquiring this semaphore would block */
426 int SIMIX_sem_would_block(smx_sem_t sem)
430 return (sem->value <= 0);
433 int simcall_HANDLER_sem_get_capacity(smx_simcall_t simcall, smx_sem_t sem){
434 return SIMIX_sem_get_capacity(sem);
436 /** @brief Returns the current capacity of the semaphore */
437 int SIMIX_sem_get_capacity(smx_sem_t sem)
444 static void _SIMIX_sem_wait(smx_sem_t sem, double timeout, smx_process_t issuer,
445 smx_simcall_t simcall)
447 XBT_IN("(%p, %f, %p, %p)",sem,timeout,issuer,simcall);
448 smx_synchro_t synchro = nullptr;
450 XBT_DEBUG("Wait semaphore %p (timeout:%f)", sem, timeout);
451 if (sem->value <= 0) {
452 synchro = SIMIX_synchro_wait(issuer->host, timeout);
453 synchro->simcalls.push_front(simcall);
454 issuer->waiting_synchro = synchro;
455 xbt_swag_insert(issuer, sem->sleeping);
458 SIMIX_simcall_answer(simcall);
464 * \brief Handles a sem acquire simcall without timeout.
465 * \param simcall the simcall
467 void simcall_HANDLER_sem_acquire(smx_simcall_t simcall, smx_sem_t sem)
469 XBT_IN("(%p)",simcall);
470 _SIMIX_sem_wait(sem, -1, simcall->issuer, simcall);
475 * \brief Handles a sem acquire simcall with timeout.
476 * \param simcall the simcall
478 void simcall_HANDLER_sem_acquire_timeout(smx_simcall_t simcall, smx_sem_t sem, double timeout)
480 XBT_IN("(%p)",simcall);
481 _SIMIX_sem_wait(sem, timeout, simcall->issuer, simcall);
484 int simcall_HANDLER_sem_would_block(smx_simcall_t simcall, smx_sem_t sem) {
485 return SIMIX_sem_would_block(sem);