platform-failures platform-properties plugin-hostload
replay-comm replay-storage
routing-get-clusters
- synchro-barrier synchro-mutex
+ synchro-barrier synchro-mutex synchro-semaphore
trace-platform)
add_executable (s4u-${example} ${example}/s4u-${example}.cpp)
target_link_libraries(s4u-${example} simgrid)
io-async io-file-system io-file-remote io-storage-raw
replay-comm replay-storage
routing-get-clusters
- synchro-barrier synchro-mutex
+ synchro-barrier synchro-mutex synchro-semaphore
)
ADD_TESH_FACTORIES(s4u-${example} "thread;ucontext;raw;boost"
--setenv bindir=${CMAKE_CURRENT_BINARY_DIR}/${example}
--- /dev/null
+/* Copyright (c) 2006-2018. The SimGrid Team. All rights reserved. */
+
+/* This program is free software; you can redistribute it and/or modify it
+ * under the terms of the license (GNU LGPL) which comes with this package. */
+
+#include "simgrid/s4u.hpp"
+
+#include <memory>
+
+XBT_LOG_NEW_DEFAULT_CATEGORY(s4u_test, "a sample log category");
+
+// This example implements a one-time use barrier with 1 semaphore and 1 mutex.
+
+static void worker(simgrid::s4u::SemaphorePtr semaphore, simgrid::s4u::MutexPtr mutex, int process_count, std::shared_ptr<int> count)
+{
+ mutex->lock();
+ XBT_INFO("Got mutex. Incrementing count.");
+ XBT_INFO("Count is %d", *count);
+ *count = (*count) + 1;
+ XBT_INFO("Count is now %d. Process count is %d.", *count, process_count);
+
+ if (*count == process_count) {
+ XBT_INFO("Releasing the semaphore %d times.", process_count-1);
+ for (int i = 0; i < process_count-1; i++) {
+ semaphore->release();
+ }
+
+ XBT_INFO("Releasing mutex.");
+ mutex->unlock();
+ }
+ else {
+ XBT_INFO("Releasing mutex.");
+ mutex->unlock();
+ XBT_INFO("Acquiring semaphore.");
+ semaphore->acquire();
+ }
+
+ XBT_INFO("Bye!");
+}
+
+static void master(unsigned int process_count)
+{
+ simgrid::s4u::SemaphorePtr semaphore = simgrid::s4u::Semaphore::create(0);
+ simgrid::s4u::MutexPtr mutex = simgrid::s4u::Mutex::create();
+ std::shared_ptr<int> count(new int);
+ *count = 0;
+
+ XBT_INFO("Spawning %d workers", process_count);
+ for (unsigned int i = 0; i < process_count; i++) {
+ simgrid::s4u::Actor::create("worker", simgrid::s4u::Host::by_name("Jupiter"), worker, semaphore, mutex, process_count, count);
+ }
+}
+
+int main(int argc, char **argv)
+{
+ // Parameter: Number of processes in the barrier
+ xbt_assert(argc >= 2, "Usage: %s <process-count>\n", argv[0]);
+ unsigned int process_count = std::stoi(argv[1]);
+ xbt_assert(process_count > 0, "<process-count> must be greater than 0");
+
+ simgrid::s4u::Engine e(&argc, argv);
+ e.load_platform("../../platforms/two_hosts.xml");
+ simgrid::s4u::Actor::create("master", simgrid::s4u::Host::by_name("Tremblay"), master, process_count);
+ e.run();
+
+ return 0;
+}
--- /dev/null
+#!/usr/bin/env tesh
+
+$ $SG_TEST_EXENV ${bindir:=.}/s4u-synchro-semaphore 1
+> [Tremblay:master:(1) 0.000000] [s4u_test/INFO] Spawning 1 workers
+> [Jupiter:worker:(2) 0.000000] [s4u_test/INFO] Got mutex. Incrementing count.
+> [Jupiter:worker:(2) 0.000000] [s4u_test/INFO] Count is 0
+> [Jupiter:worker:(2) 0.000000] [s4u_test/INFO] Count is now 1. Process count is 1.
+> [Jupiter:worker:(2) 0.000000] [s4u_test/INFO] Releasing the semaphore 0 times.
+> [Jupiter:worker:(2) 0.000000] [s4u_test/INFO] Releasing mutex.
+> [Jupiter:worker:(2) 0.000000] [s4u_test/INFO] Bye!
+
+$ $SG_TEST_EXENV ${bindir:=.}/s4u-synchro-semaphore 2
+> [Tremblay:master:(1) 0.000000] [s4u_test/INFO] Spawning 2 workers
+> [Jupiter:worker:(2) 0.000000] [s4u_test/INFO] Got mutex. Incrementing count.
+> [Jupiter:worker:(2) 0.000000] [s4u_test/INFO] Count is 0
+> [Jupiter:worker:(2) 0.000000] [s4u_test/INFO] Count is now 1. Process count is 2.
+> [Jupiter:worker:(2) 0.000000] [s4u_test/INFO] Releasing mutex.
+> [Jupiter:worker:(2) 0.000000] [s4u_test/INFO] Acquiring semaphore.
+> [Jupiter:worker:(3) 0.000000] [s4u_test/INFO] Got mutex. Incrementing count.
+> [Jupiter:worker:(3) 0.000000] [s4u_test/INFO] Count is 1
+> [Jupiter:worker:(3) 0.000000] [s4u_test/INFO] Count is now 2. Process count is 2.
+> [Jupiter:worker:(3) 0.000000] [s4u_test/INFO] Releasing the semaphore 1 times.
+> [Jupiter:worker:(2) 0.000000] [s4u_test/INFO] Bye!
+> [Jupiter:worker:(3) 0.000000] [s4u_test/INFO] Releasing mutex.
+> [Jupiter:worker:(3) 0.000000] [s4u_test/INFO] Bye!
+
+$ $SG_TEST_EXENV ${bindir:=.}/s4u-synchro-semaphore 3
+> [Tremblay:master:(1) 0.000000] [s4u_test/INFO] Spawning 3 workers
+> [Jupiter:worker:(2) 0.000000] [s4u_test/INFO] Got mutex. Incrementing count.
+> [Jupiter:worker:(2) 0.000000] [s4u_test/INFO] Count is 0
+> [Jupiter:worker:(2) 0.000000] [s4u_test/INFO] Count is now 1. Process count is 3.
+> [Jupiter:worker:(2) 0.000000] [s4u_test/INFO] Releasing mutex.
+> [Jupiter:worker:(2) 0.000000] [s4u_test/INFO] Acquiring semaphore.
+> [Jupiter:worker:(3) 0.000000] [s4u_test/INFO] Got mutex. Incrementing count.
+> [Jupiter:worker:(3) 0.000000] [s4u_test/INFO] Count is 1
+> [Jupiter:worker:(3) 0.000000] [s4u_test/INFO] Count is now 2. Process count is 3.
+> [Jupiter:worker:(3) 0.000000] [s4u_test/INFO] Releasing mutex.
+> [Jupiter:worker:(3) 0.000000] [s4u_test/INFO] Acquiring semaphore.
+> [Jupiter:worker:(4) 0.000000] [s4u_test/INFO] Got mutex. Incrementing count.
+> [Jupiter:worker:(4) 0.000000] [s4u_test/INFO] Count is 2
+> [Jupiter:worker:(4) 0.000000] [s4u_test/INFO] Count is now 3. Process count is 3.
+> [Jupiter:worker:(4) 0.000000] [s4u_test/INFO] Releasing the semaphore 2 times.
+> [Jupiter:worker:(2) 0.000000] [s4u_test/INFO] Bye!
+> [Jupiter:worker:(3) 0.000000] [s4u_test/INFO] Bye!
+> [Jupiter:worker:(4) 0.000000] [s4u_test/INFO] Releasing mutex.
+> [Jupiter:worker:(4) 0.000000] [s4u_test/INFO] Bye!
+
+$ $SG_TEST_EXENV ${bindir:=.}/s4u-synchro-semaphore 10
+> [Tremblay:master:(1) 0.000000] [s4u_test/INFO] Spawning 10 workers
+> [Jupiter:worker:(2) 0.000000] [s4u_test/INFO] Got mutex. Incrementing count.
+> [Jupiter:worker:(2) 0.000000] [s4u_test/INFO] Count is 0
+> [Jupiter:worker:(2) 0.000000] [s4u_test/INFO] Count is now 1. Process count is 10.
+> [Jupiter:worker:(2) 0.000000] [s4u_test/INFO] Releasing mutex.
+> [Jupiter:worker:(2) 0.000000] [s4u_test/INFO] Acquiring semaphore.
+> [Jupiter:worker:(3) 0.000000] [s4u_test/INFO] Got mutex. Incrementing count.
+> [Jupiter:worker:(3) 0.000000] [s4u_test/INFO] Count is 1
+> [Jupiter:worker:(3) 0.000000] [s4u_test/INFO] Count is now 2. Process count is 10.
+> [Jupiter:worker:(3) 0.000000] [s4u_test/INFO] Releasing mutex.
+> [Jupiter:worker:(3) 0.000000] [s4u_test/INFO] Acquiring semaphore.
+> [Jupiter:worker:(4) 0.000000] [s4u_test/INFO] Got mutex. Incrementing count.
+> [Jupiter:worker:(4) 0.000000] [s4u_test/INFO] Count is 2
+> [Jupiter:worker:(4) 0.000000] [s4u_test/INFO] Count is now 3. Process count is 10.
+> [Jupiter:worker:(4) 0.000000] [s4u_test/INFO] Releasing mutex.
+> [Jupiter:worker:(4) 0.000000] [s4u_test/INFO] Acquiring semaphore.
+> [Jupiter:worker:(5) 0.000000] [s4u_test/INFO] Got mutex. Incrementing count.
+> [Jupiter:worker:(5) 0.000000] [s4u_test/INFO] Count is 3
+> [Jupiter:worker:(5) 0.000000] [s4u_test/INFO] Count is now 4. Process count is 10.
+> [Jupiter:worker:(5) 0.000000] [s4u_test/INFO] Releasing mutex.
+> [Jupiter:worker:(5) 0.000000] [s4u_test/INFO] Acquiring semaphore.
+> [Jupiter:worker:(6) 0.000000] [s4u_test/INFO] Got mutex. Incrementing count.
+> [Jupiter:worker:(6) 0.000000] [s4u_test/INFO] Count is 4
+> [Jupiter:worker:(6) 0.000000] [s4u_test/INFO] Count is now 5. Process count is 10.
+> [Jupiter:worker:(6) 0.000000] [s4u_test/INFO] Releasing mutex.
+> [Jupiter:worker:(6) 0.000000] [s4u_test/INFO] Acquiring semaphore.
+> [Jupiter:worker:(7) 0.000000] [s4u_test/INFO] Got mutex. Incrementing count.
+> [Jupiter:worker:(7) 0.000000] [s4u_test/INFO] Count is 5
+> [Jupiter:worker:(7) 0.000000] [s4u_test/INFO] Count is now 6. Process count is 10.
+> [Jupiter:worker:(7) 0.000000] [s4u_test/INFO] Releasing mutex.
+> [Jupiter:worker:(7) 0.000000] [s4u_test/INFO] Acquiring semaphore.
+> [Jupiter:worker:(8) 0.000000] [s4u_test/INFO] Got mutex. Incrementing count.
+> [Jupiter:worker:(8) 0.000000] [s4u_test/INFO] Count is 6
+> [Jupiter:worker:(8) 0.000000] [s4u_test/INFO] Count is now 7. Process count is 10.
+> [Jupiter:worker:(8) 0.000000] [s4u_test/INFO] Releasing mutex.
+> [Jupiter:worker:(8) 0.000000] [s4u_test/INFO] Acquiring semaphore.
+> [Jupiter:worker:(9) 0.000000] [s4u_test/INFO] Got mutex. Incrementing count.
+> [Jupiter:worker:(9) 0.000000] [s4u_test/INFO] Count is 7
+> [Jupiter:worker:(9) 0.000000] [s4u_test/INFO] Count is now 8. Process count is 10.
+> [Jupiter:worker:(9) 0.000000] [s4u_test/INFO] Releasing mutex.
+> [Jupiter:worker:(9) 0.000000] [s4u_test/INFO] Acquiring semaphore.
+> [Jupiter:worker:(10) 0.000000] [s4u_test/INFO] Got mutex. Incrementing count.
+> [Jupiter:worker:(10) 0.000000] [s4u_test/INFO] Count is 8
+> [Jupiter:worker:(10) 0.000000] [s4u_test/INFO] Count is now 9. Process count is 10.
+> [Jupiter:worker:(10) 0.000000] [s4u_test/INFO] Releasing mutex.
+> [Jupiter:worker:(10) 0.000000] [s4u_test/INFO] Acquiring semaphore.
+> [Jupiter:worker:(11) 0.000000] [s4u_test/INFO] Got mutex. Incrementing count.
+> [Jupiter:worker:(11) 0.000000] [s4u_test/INFO] Count is 9
+> [Jupiter:worker:(11) 0.000000] [s4u_test/INFO] Count is now 10. Process count is 10.
+> [Jupiter:worker:(11) 0.000000] [s4u_test/INFO] Releasing the semaphore 9 times.
+> [Jupiter:worker:(2) 0.000000] [s4u_test/INFO] Bye!
+> [Jupiter:worker:(3) 0.000000] [s4u_test/INFO] Bye!
+> [Jupiter:worker:(4) 0.000000] [s4u_test/INFO] Bye!
+> [Jupiter:worker:(5) 0.000000] [s4u_test/INFO] Bye!
+> [Jupiter:worker:(6) 0.000000] [s4u_test/INFO] Bye!
+> [Jupiter:worker:(7) 0.000000] [s4u_test/INFO] Bye!
+> [Jupiter:worker:(8) 0.000000] [s4u_test/INFO] Bye!
+> [Jupiter:worker:(9) 0.000000] [s4u_test/INFO] Bye!
+> [Jupiter:worker:(10) 0.000000] [s4u_test/INFO] Bye!
+> [Jupiter:worker:(11) 0.000000] [s4u_test/INFO] Releasing mutex.
+> [Jupiter:worker:(11) 0.000000] [s4u_test/INFO] Bye!
class NetZone;
class VirtualMachine;
class File;
+
+class Semaphore;
+/** Smart pointer to a simgrid::s4u::Semaphore */
+typedef boost::intrusive_ptr<Semaphore> SemaphorePtr;
+XBT_PUBLIC void intrusive_ptr_release(Semaphore* m);
+XBT_PUBLIC void intrusive_ptr_add_ref(Semaphore* m);
+
class Storage;
} // namespace s4u
#include <simgrid/s4u/Mailbox.hpp>
#include <simgrid/s4u/Mutex.hpp>
#include <simgrid/s4u/NetZone.hpp>
+#include <simgrid/s4u/Semaphore.hpp>
#include <simgrid/s4u/Storage.hpp>
#include <simgrid/Exception.hpp>
--- /dev/null
+/* Copyright (c) 2006-2018. The SimGrid Team. All rights reserved. */
+
+/* This program is free software; you can redistribute it and/or modify it
+ * under the terms of the license (GNU LGPL) which comes with this package. */
+
+#ifndef SIMGRID_S4U_SEMAPHORE_HPP
+#define SIMGRID_S4U_SEMAPHORE_HPP
+
+#include <simgrid/forward.h>
+#include <simgrid/simix.h>
+
+namespace simgrid {
+namespace s4u {
+
+/** @brief A classical semaphore, but blocking in the simulation world
+ * @ingroup s4u_api
+ *
+ * It is strictly impossible to use a real semaphore, such as
+ * <a href="http://pubs.opengroup.org/onlinepubs/9699919799/functions/sem_init.html">sem_init</a>,
+ * because it would block the whole simulation.
+ * Instead, you should use the present class, that offers a very similar interface.
+ *
+ * As for any S4U object, Semaphores are using the @ref s4u_raii "RAII idiom" for memory management.
+ * Use createSemaphore() to get a ::SemaphorePtr to a newly created semaphore
+ * and only manipulate ::SemaphorePtr.
+ *
+ */
+class XBT_PUBLIC Semaphore {
+ smx_sem_t sem_;
+ std::atomic_int_fast32_t refcount_{0};
+
+ explicit Semaphore(unsigned int initial_capacity);
+ ~Semaphore();
+
+ friend void intrusive_ptr_add_ref(Semaphore* sem);
+ friend void intrusive_ptr_release(Semaphore* sem);
+
+public:
+ // No copy:
+ /** You cannot create a new semaphore by copying an existing one. Use SemaphorePtr instead */
+ Semaphore(Semaphore const&) = delete;
+ /** You cannot create a new semaphore by value assignment either. Use SemaphorePtr instead */
+ Semaphore& operator=(Semaphore const&) = delete;
+
+ /** Constructs a new semaphore */
+ static SemaphorePtr create(unsigned int initial_capacity);
+
+ void acquire();
+ void release();
+};
+
+}} // namespace simgrid::s4u
+
+#endif /* SIMGRID_S4U_SEMAPHORE_HPP */
--- /dev/null
+/* Copyright (c) 2006-201. The SimGrid Team. All rights reserved. */
+
+/* This program is free software; you can redistribute it and/or modify it
+ * under the terms of the license (GNU LGPL) which comes with this package. */
+
+#include "src/msg/msg_private.hpp"
+#include "src/simix/smx_synchro_private.hpp"
+#include "xbt/log.h"
+
+#include "simgrid/s4u/Semaphore.hpp"
+
+namespace simgrid {
+namespace s4u {
+
+Semaphore::Semaphore(unsigned int initial_capacity)
+{
+ sem_ = simgrid::simix::simcall([initial_capacity] { return SIMIX_sem_init(initial_capacity); });
+}
+
+Semaphore::~Semaphore()
+{
+ SIMIX_sem_destroy(sem_);
+}
+
+SemaphorePtr Semaphore::create(unsigned int initial_capacity)
+{
+ return SemaphorePtr(new Semaphore(initial_capacity));
+}
+
+void Semaphore::acquire()
+{
+ simcall_sem_acquire(sem_);
+}
+
+void Semaphore::release()
+{
+ simgrid::simix::simcall([this] { SIMIX_sem_release(sem_); });
+}
+
+void intrusive_ptr_add_ref(Semaphore* sem)
+{
+ xbt_assert(sem);
+ sem->refcount_.fetch_add(1, std::memory_order_relaxed);
+}
+
+void intrusive_ptr_release(Semaphore* sem)
+{
+ xbt_assert(sem);
+ if (sem->refcount_.fetch_sub(1, std::memory_order_release) == 1) {
+ std::atomic_thread_fence(std::memory_order_acquire);
+ delete sem;
+ }
+}
+
+}
+}
src/s4u/s4u_Mailbox.cpp
src/s4u/s4u_Mutex.cpp
src/s4u/s4u_Netzone.cpp
+ src/s4u/s4u_Semaphore.cpp
src/s4u/s4u_Storage.cpp
)
include/simgrid/s4u/Mailbox.hpp
include/simgrid/s4u/Mutex.hpp
include/simgrid/s4u/NetZone.hpp
+ include/simgrid/s4u/Semaphore.hpp
include/simgrid/s4u/Storage.hpp
include/simgrid/s4u/VirtualMachine.hpp
include/simgrid/s4u.hpp