1 /* Copyright (c) 2007, 2008, 2009, 2010. 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. */
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_req_t req);
18 static void _SIMIX_sem_wait(smx_sem_t sem, double timeout, smx_process_t issuer,
20 static void SIMIX_sem_block_onto(smx_sem_t sem);
22 /***************************** Synchro action *********************************/
24 static smx_action_t SIMIX_synchro_wait(smx_host_t smx_host, double timeout)
26 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_model->extension.workstation.sleep(smx_host->host, timeout);
34 surf_workstation_model->action_data_set(action->synchro.sleep, action);
39 void SIMIX_synchro_stop_waiting(smx_process_t process, smx_req_t req)
41 XBT_IN("(%p, %p)",process,req);
45 xbt_swag_remove(process, req->mutex_lock.mutex->sleeping);
49 xbt_swag_remove(process, req->cond_wait.cond->sleeping);
52 case REQ_COND_WAIT_TIMEOUT:
53 xbt_swag_remove(process, req->cond_wait_timeout.cond->sleeping);
57 xbt_swag_remove(process, req->sem_acquire.sem->sleeping);
60 case REQ_SEM_ACQUIRE_TIMEOUT:
61 xbt_swag_remove(process, req->sem_acquire_timeout.sem->sleeping);
70 void SIMIX_synchro_destroy(smx_action_t action)
72 XBT_IN("(%p)",action);
73 XBT_DEBUG("Destroying synchro %p", action);
74 action->synchro.sleep->model_type->action_unref(action->synchro.sleep);
75 xbt_free(action->name);
76 xbt_mallocator_release(simix_global->action_mallocator, action);
80 void SIMIX_post_synchro(smx_action_t action)
82 XBT_IN("(%p)",action);
83 if (surf_workstation_model->action_state_get(action->synchro.sleep) == SURF_ACTION_FAILED)
84 action->state = SIMIX_FAILED;
85 else if(surf_workstation_model->action_state_get(action->synchro.sleep) == SURF_ACTION_DONE)
86 action->state = SIMIX_SRC_TIMEOUT;
88 SIMIX_synchro_finish(action);
92 static void SIMIX_synchro_finish(smx_action_t action)
94 XBT_IN("(%p)",action);
95 smx_req_t req = xbt_fifo_shift(action->request_list);
97 switch (action->state) {
99 case SIMIX_SRC_TIMEOUT:
101 THROWF(timeout_error, 0, "Synchro's wait timeout");
102 } CATCH(req->issuer->running_ctx->exception) {
103 req->issuer->doexception = 1;
109 THROWF(host_error, 0, "Host failed");
110 } CATCH(req->issuer->running_ctx->exception) {
111 req->issuer->doexception = 1;
120 SIMIX_synchro_stop_waiting(req->issuer, req);
121 SIMIX_synchro_destroy(action);
122 SIMIX_request_answer(req);
125 /*********************************** Mutex ************************************/
128 * \brief Initialize a mutex.
130 * Allocs and creates the data for the mutex.
133 smx_mutex_t SIMIX_mutex_init(void)
136 s_smx_process_t p; /* useful to initialize sleeping swag */
138 smx_mutex_t mutex = xbt_new0(s_smx_mutex_t, 1);
140 mutex->sleeping = xbt_swag_new(xbt_swag_offset(p, synchro_hookup));
146 * \brief Handle mutex lock request
147 * \param req The request
149 void SIMIX_pre_mutex_lock(smx_req_t req)
152 /* FIXME: check where to validate the arguments */
153 smx_action_t sync_act = NULL;
154 smx_mutex_t mutex = req->mutex_lock.mutex;
155 smx_process_t process = req->issuer;
158 /* FIXME: check if the host is active ? */
159 /* Somebody using the mutex, use a synchro action to get host failures */
160 sync_act = SIMIX_synchro_wait(process->smx_host, -1);
161 xbt_fifo_push(sync_act->request_list, req);
162 req->issuer->waiting_action = sync_act;
163 xbt_swag_insert(req->issuer, mutex->sleeping);
167 mutex->owner = req->issuer;
168 SIMIX_request_answer(req);
174 * \brief Tries to lock a mutex.
176 * Tries to lock a mutex, return 1 if the mutex is unlocked, else 0.
177 * This function does not block and wait for the mutex to be unlocked.
178 * \param mutex The mutex
179 * \param issuer The process that tries to acquire the mutex
180 * \return 1 - mutex free, 0 - mutex used
182 int SIMIX_mutex_trylock(smx_mutex_t mutex, smx_process_t issuer)
184 XBT_IN("(%p, %p)",mutex,issuer);
191 mutex->owner = issuer;
197 * \brief Unlocks a mutex.
199 * Unlocks the mutex and gives it to a process waiting for it.
200 * If the unlocker is not the owner of the mutex nothing happens.
201 * If there are no process waiting, it sets the mutex as free.
202 * \param mutex The mutex
203 * \param issuer The process trying to unlock the mutex
205 void SIMIX_mutex_unlock(smx_mutex_t mutex, smx_process_t issuer)
207 XBT_IN("(%p, %p)",mutex,issuer);
208 smx_process_t p; /*process to wake up */
210 /* If the mutex is not owned by the issuer do nothing */
211 if (issuer != mutex->owner){
216 if (xbt_swag_size(mutex->sleeping) > 0) {
217 p = xbt_swag_extract(mutex->sleeping);
218 SIMIX_synchro_destroy(p->waiting_action);
219 p->waiting_action = NULL;
221 SIMIX_request_answer(&p->request);
223 /* nobody to wake up */
231 * \brief Destroys a mutex.
233 * Destroys and frees the mutex's memory.
234 * \param mutex A mutex
236 void SIMIX_mutex_destroy(smx_mutex_t mutex)
238 XBT_IN("(%p)",mutex);
240 xbt_swag_free(mutex->sleeping);
246 /********************************* Condition **********************************/
249 * \brief Initialize a condition.
251 * Allocates and creates the data for the condition.
252 * It have to be called before the use of the condition.
253 * \return A condition
255 smx_cond_t SIMIX_cond_init()
259 smx_cond_t cond = xbt_new0(s_smx_cond_t, 1);
260 cond->sleeping = xbt_swag_new(xbt_swag_offset(p, synchro_hookup));
267 * \brief Handle condition waiting requests without timeouts
270 void SIMIX_pre_cond_wait(smx_req_t req)
273 smx_process_t issuer = req->issuer;
274 smx_cond_t cond = req->cond_wait.cond;
275 smx_mutex_t mutex = req->cond_wait.mutex;
277 _SIMIX_cond_wait(cond, mutex, -1, issuer, req);
282 * \brief Handle condition waiting requests with timeouts
285 void SIMIX_pre_cond_wait_timeout(smx_req_t req)
288 smx_process_t issuer = req->issuer;
289 smx_cond_t cond = req->cond_wait_timeout.cond;
290 smx_mutex_t mutex = req->cond_wait_timeout.mutex;
291 double timeout = req->cond_wait_timeout.timeout;
293 _SIMIX_cond_wait(cond, mutex, timeout, issuer, req);
298 static void _SIMIX_cond_wait(smx_cond_t cond, smx_mutex_t mutex, double timeout,
299 smx_process_t issuer, smx_req_t req)
301 XBT_IN("(%p, %p, %f, %p,%p)",cond,mutex,timeout,issuer,req);
302 smx_action_t sync_act = NULL;
304 XBT_DEBUG("Wait condition %p", cond);
306 /* If there is a mutex unlock it */
307 /* FIXME: what happens if the issuer is not the owner of the mutex? */
310 SIMIX_mutex_unlock(mutex, issuer);
313 sync_act = SIMIX_synchro_wait(issuer->smx_host, timeout);
314 xbt_fifo_unshift(sync_act->request_list, req);
315 issuer->waiting_action = sync_act;
316 xbt_swag_insert(req->issuer, cond->sleeping);
321 * \brief Signalizes a condition.
323 * Signalizes a condition and wakes up a sleeping process.
324 * If there are no process sleeping, no action is done.
325 * \param cond A condition
327 void SIMIX_cond_signal(smx_cond_t cond)
330 smx_process_t proc = NULL;
331 smx_mutex_t mutex = NULL;
332 smx_req_t req = NULL;
334 XBT_DEBUG("Signal condition %p", cond);
336 /* If there are processes waiting for the condition choose one and try
337 to make it acquire the mutex */
338 if ((proc = xbt_swag_extract(cond->sleeping))) {
340 /* Destroy waiter's synchro action */
341 SIMIX_synchro_destroy(proc->waiting_action);
342 proc->waiting_action = NULL;
344 /* Now transform the cond wait request into a mutex lock one */
345 req = &proc->request;
346 if(req->call == REQ_COND_WAIT)
347 mutex = req->cond_wait.mutex;
349 mutex = req->cond_wait_timeout.mutex;
351 req->call = REQ_MUTEX_LOCK;
352 req->mutex_lock.mutex = mutex;
354 SIMIX_pre_mutex_lock(req);
360 * \brief Broadcasts a condition.
362 * Signal ALL processes waiting on a condition.
363 * If there are no process waiting, no action is done.
364 * \param cond A condition
366 void SIMIX_cond_broadcast(smx_cond_t cond)
369 XBT_DEBUG("Broadcast condition %p", cond);
371 /* Signal the condition until nobody is waiting on it */
372 while (xbt_swag_size(cond->sleeping)) {
373 SIMIX_cond_signal(cond);
379 * \brief Destroys a contidion.
381 * Destroys and frees the condition's memory.
382 * \param cond A condition
384 void SIMIX_cond_destroy(smx_cond_t cond)
387 XBT_DEBUG("Destroy condition %p", cond);
390 xbt_assert(xbt_swag_size(cond->sleeping) == 0,
391 "Cannot destroy conditional since someone is still using it");
393 xbt_swag_free(cond->sleeping);
399 /******************************** Semaphores **********************************/
400 #define SMX_SEM_NOLIMIT 99999
401 /** @brief Initialize a semaphore */
402 smx_sem_t SIMIX_sem_init(unsigned int value)
404 XBT_IN("(%d)",value);
407 smx_sem_t sem = xbt_new0(s_smx_sem_t, 1);
408 sem->sleeping = xbt_swag_new(xbt_swag_offset(p, synchro_hookup));
414 /** @brief Destroys a semaphore */
415 void SIMIX_sem_destroy(smx_sem_t sem)
418 XBT_DEBUG("Destroy semaphore %p", sem);
420 xbt_assert(xbt_swag_size(sem->sleeping) == 0,
421 "Cannot destroy semaphore since someone is still using it");
422 xbt_swag_free(sem->sleeping);
428 /** @brief release the semaphore
430 * Unlock a process waiting on the semaphore.
431 * If no one was blocked, the semaphore capacity is increased by 1.
433 void SIMIX_sem_release(smx_sem_t sem)
438 XBT_DEBUG("Sem release semaphore %p", sem);
439 if ((proc = xbt_swag_extract(sem->sleeping))) {
440 proc = xbt_swag_extract(sem->sleeping);
441 SIMIX_synchro_destroy(proc->waiting_action);
442 proc->waiting_action = NULL;
443 SIMIX_request_answer(&proc->request);
444 } else if (sem->value < SMX_SEM_NOLIMIT) {
450 /** @brief Returns true if acquiring this semaphore would block */
451 XBT_INLINE int SIMIX_sem_would_block(smx_sem_t sem)
455 return (sem->value <= 0);
458 /** @brief Returns the current capacity of the semaphore */
459 int SIMIX_sem_get_capacity(smx_sem_t sem)
466 static void _SIMIX_sem_wait(smx_sem_t sem, double timeout, smx_process_t issuer,
469 XBT_IN("(%p, %f, %p, %p)",sem,timeout,issuer,req);
470 smx_action_t sync_act = NULL;
472 XBT_DEBUG("Wait semaphore %p (timeout:%f)", sem, timeout);
473 if (sem->value <= 0) {
474 sync_act = SIMIX_synchro_wait(issuer->smx_host, timeout);
475 xbt_fifo_unshift(sync_act->request_list, req);
476 issuer->waiting_action = sync_act;
477 xbt_swag_insert(issuer, sem->sleeping);
480 SIMIX_request_answer(req);
486 * \brief Handle sem acquire requests without timeouts
488 void SIMIX_pre_sem_acquire(smx_req_t req)
491 _SIMIX_sem_wait(req->sem_acquire.sem, -1, req->issuer, req);
496 * \brief Handle sem acquire requests with timeouts
498 void SIMIX_pre_sem_acquire_timeout(smx_req_t req)
501 _SIMIX_sem_wait(req->sem_acquire_timeout.sem,
502 req->sem_acquire_timeout.timeout, req->issuer, req);