1 /* Copyright (c) 2018-2021. The SimGrid Team. All rights reserved. */
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. */
6 #include "src/msg/msg_private.hpp"
9 #include "simgrid/forward.h"
10 #include "simgrid/s4u/Semaphore.hpp"
11 #include "src/kernel/activity/SemaphoreImpl.hpp"
12 #include "src/kernel/actor/SimcallObserver.hpp"
17 SemaphorePtr Semaphore::create(unsigned int initial_capacity)
19 auto* sem = new kernel::activity::SemaphoreImpl(initial_capacity);
20 return SemaphorePtr(&sem->sem(), false);
23 void Semaphore::acquire()
25 kernel::actor::ActorImpl* issuer = kernel::actor::ActorImpl::self();
26 kernel::actor::SemAcquireSimcall observer{issuer, pimpl_};
27 kernel::actor::simcall_blocking([&observer] { observer.get_sem()->acquire(observer.get_issuer(), -1.0); }, &observer);
30 bool Semaphore::acquire_timeout(double timeout)
32 kernel::actor::ActorImpl* issuer = kernel::actor::ActorImpl::self();
33 kernel::actor::SemAcquireSimcall observer{issuer, pimpl_, timeout};
34 return kernel::actor::simcall_blocking(
35 [&observer] { observer.get_sem()->acquire(observer.get_issuer(), observer.get_timeout()); }, &observer);
38 void Semaphore::release()
40 kernel::actor::simcall([this] { pimpl_->release(); });
43 int Semaphore::get_capacity() const
45 return kernel::actor::simcall([this] { return pimpl_->get_capacity(); });
48 bool Semaphore::would_block() const
50 return kernel::actor::simcall([this] { return pimpl_->would_block(); });
53 /* refcounting of the intrusive_ptr is delegated to the implementation object */
54 void intrusive_ptr_add_ref(const Semaphore* sem)
60 void intrusive_ptr_release(const Semaphore* sem)
67 } // namespace simgrid
69 /* **************************** Public C interface *************************** */
70 /** @brief creates a semaphore object of the given initial capacity */
71 sg_sem_t sg_sem_init(int initial_value)
73 return simgrid::s4u::Semaphore::create(initial_value).detach();
76 /** @brief locks on a semaphore object */
77 void sg_sem_acquire(sg_sem_t sem)
82 /** @brief locks on a semaphore object up until the provided timeout expires */
83 int sg_sem_acquire_timeout(sg_sem_t sem, double timeout)
85 return sem->acquire_timeout(timeout);
88 /** @brief releases the semaphore object */
89 void sg_sem_release(sg_sem_t sem)
94 int sg_sem_get_capacity(const_sg_sem_t sem)
96 return sem->get_capacity();
99 void sg_sem_destroy(const_sg_sem_t sem)
101 intrusive_ptr_release(sem);
104 /** @brief returns a boolean indicating if this semaphore would block at this very specific time
106 * Note that the returned value may be wrong right after the function call, when you try to use it...
107 * But that's a classical semaphore issue, and SimGrid's semaphore are not different to usual ones here.
109 int sg_sem_would_block(const_sg_sem_t sem)
111 return sem->would_block();