From 1ee4b856922e6a71a805e54ef5ae8c537155fa93 Mon Sep 17 00:00:00 2001 From: Martin Quinson Date: Fri, 17 Jun 2016 09:47:49 +0200 Subject: [PATCH] small cleanups in s4u::hosts: improve doc, kill useless function --- doc/doxygen/module-s4u.doc | 4 +++- include/simgrid/host.h | 1 - include/simgrid/s4u/actor.hpp | 2 +- include/simgrid/s4u/host.hpp | 20 +++++++++++--------- src/simgrid/host.cpp | 5 ----- src/surf/vm_hl13.cpp | 2 +- 6 files changed, 16 insertions(+), 18 deletions(-) diff --git a/doc/doxygen/module-s4u.doc b/doc/doxygen/module-s4u.doc index 9e629e1e6d..3e269ff5b4 100644 --- a/doc/doxygen/module-s4u.doc +++ b/doc/doxygen/module-s4u.doc @@ -16,11 +16,13 @@ Unsurprisingly, the S4U interface matches the concepts presented in @ref starting_components "the introduction": - @ref s4u_actor + - @ref s4u_host @{ */ -/** @defgroup s4u_actor Actors: simulation agents */ +/** @defgroup s4u_actor Actors: simulation agents */ +/** @defgroup s4u_host Hosts: simulated machine on which the actors are located */ /** @} */ diff --git a/include/simgrid/host.h b/include/simgrid/host.h index 70bbccaea6..3879b924dd 100644 --- a/include/simgrid/host.h +++ b/include/simgrid/host.h @@ -26,7 +26,6 @@ XBT_PUBLIC(sg_host_t *) sg_host_list(void); XBT_PUBLIC(size_t) sg_host_extension_create(void(*deleter)(void*)); XBT_PUBLIC(void*) sg_host_extension_get(sg_host_t host, size_t rank); XBT_PUBLIC(sg_host_t) sg_host_by_name(const char *name); -XBT_PUBLIC(sg_host_t) sg_host_by_name_or_create(const char *name); XBT_PUBLIC(const char*) sg_host_get_name(sg_host_t host); XBT_PUBLIC(xbt_dynar_t) sg_hosts_as_dynar(void); diff --git a/include/simgrid/s4u/actor.hpp b/include/simgrid/s4u/actor.hpp index fc067f1551..f008ae1fd2 100644 --- a/include/simgrid/s4u/actor.hpp +++ b/include/simgrid/s4u/actor.hpp @@ -14,7 +14,7 @@ namespace simgrid { namespace s4u { -/** @addtogroup s4u_actor +/** @ingroup s4u_actor * * @tableofcontents * diff --git a/include/simgrid/s4u/host.hpp b/include/simgrid/s4u/host.hpp index 3d741de67b..a50d15c2d5 100644 --- a/include/simgrid/s4u/host.hpp +++ b/include/simgrid/s4u/host.hpp @@ -21,21 +21,22 @@ namespace simgrid { namespace xbt { -extern template class XBT_PUBLIC() Extendable; + extern template class XBT_PUBLIC() Extendable; } - namespace s4u { -/** @brief Simulated machine that can host some actors +/** @ingroup s4u_host + * + * @tableofcontents * - * It represents some physical resource with computing and networking capabilities. + * An host represents some physical resource with computing and networking capabilities. * * All hosts are automatically created during the call of the method * @link{simgrid::s4u::Engine::loadPlatform()}. * You cannot create a host yourself. * - * You can retrieve a particular host using @link{simgrid::s4u::Host.byName()}, - * and actors can retrieve the host on which they run using @link{simgrid::s4u::Host.current()}. + * You can retrieve a particular host using simgrid::s4u::Host::byName() + * and actors can retrieve the host on which they run using simgrid::s4u::Host::current(). */ XBT_PUBLIC_CLASS Host : public simgrid::xbt::Extendable { @@ -44,11 +45,12 @@ private: explicit Host(const char *name); public: // TODO, make me private ~Host(); -public: + /** Do not use this function, it should be private */ + static Host* by_name_or_create(const char* name); + /** Retrieves an host from its name, or return nullptr */ static Host* by_name_or_null(const char* name); - static Host* by_name_or_create(const char* name); - /** Retrieves an host from its name. */ + /** Retrieves an host from its name, or die */ static s4u::Host *by_name(std::string name); /** Retrieves the host on which the current actor is running */ static s4u::Host *current(); diff --git a/src/simgrid/host.cpp b/src/simgrid/host.cpp index f3954fcd37..7d386319d5 100644 --- a/src/simgrid/host.cpp +++ b/src/simgrid/host.cpp @@ -53,11 +53,6 @@ sg_host_t sg_host_by_name(const char *name) return simgrid::s4u::Host::by_name_or_null(name); } -sg_host_t sg_host_by_name_or_create(const char *name) -{ - return simgrid::s4u::Host::by_name_or_create(name); -} - xbt_dynar_t sg_hosts_as_dynar(void) { xbt_dynar_t res = xbt_dynar_new(sizeof(sg_host_t),nullptr); diff --git a/src/surf/vm_hl13.cpp b/src/surf/vm_hl13.cpp index 399d2ce02a..90855a80c6 100644 --- a/src/surf/vm_hl13.cpp +++ b/src/surf/vm_hl13.cpp @@ -105,7 +105,7 @@ VMHL13::VMHL13(VMModel *model, const char* name, sg_host_t host_PM) * from the VM name, we have to make sure that the system does not call the * free callback for the network resource object. The network resource object * is still used by the physical machine. */ - sg_host_t host_VM = sg_host_by_name_or_create(name); + sg_host_t host_VM = simgrid::s4u::Host::by_name_or_create(name); host_VM->pimpl_netcard = host_PM->pimpl_netcard; p_vm_state = SURF_VM_STATE_CREATED; -- 2.20.1