-/* Copyright (c) 2015-2018. The SimGrid Team. All rights reserved. */
+/* Copyright (c) 2015-2022. 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_VM_HPP
#define SIMGRID_S4U_VM_HPP
+#include <simgrid/forward.h>
#include <simgrid/s4u/Host.hpp>
+#include <xbt/utility.hpp>
namespace simgrid {
namespace s4u {
+/** @brief Host extension for the VMs */
+class VmHostExt {
+public:
+ static xbt::Extension<s4u::Host, VmHostExt> EXTENSION_ID;
+
+ sg_size_t ramsize = 0; /* available ramsize (0= not taken into account) */
+ bool overcommit = true; /* Whether the host allows overcommiting more VM than the avail ramsize allows */
+ static void ensureVmExtInstalled();
+};
+
/** @ingroup s4u_api
*
* @tableofcontents
*
*/
class XBT_PUBLIC VirtualMachine : public s4u::Host {
- simgrid::vm::VirtualMachineImpl* pimpl_vm_ = nullptr;
- virtual ~VirtualMachine();
+ kernel::resource::VirtualMachineImpl* const pimpl_vm_;
+
+ /* Signals about the life cycle of the VM */
+ static xbt::signal<void(VirtualMachine&)> on_creation;
+ static xbt::signal<void(VirtualMachine const&)> on_start;
+ static xbt::signal<void(VirtualMachine const&)> on_started;
+ static xbt::signal<void(VirtualMachine const&)> on_shutdown;
+ static xbt::signal<void(VirtualMachine const&)> on_suspend;
+ static xbt::signal<void(VirtualMachine const&)> on_resume;
+ static xbt::signal<void(VirtualMachine const&)> on_migration_start;
+ static xbt::signal<void(VirtualMachine const&)> on_migration_end;
+ static xbt::signal<void(VirtualMachine const&)> on_destruction;
+
+#ifndef DOXYGEN
+ friend kernel::resource::VirtualMachineImpl; // calls signals from Impl
+ friend kernel::resource::HostImpl; // call private constructor
+ explicit VirtualMachine(kernel::resource::VirtualMachineImpl* impl);
+#endif
public:
- explicit VirtualMachine(std::string name, s4u::Host* physical_host, int core_amount);
- explicit VirtualMachine(std::string name, s4u::Host* physical_host, int core_amount, size_t ramsize);
+ XBT_ATTRIB_DEPRECATED_v336("Please use s4u::Host::create_vm") explicit VirtualMachine(const std::string& name,
+ Host* physical_host,
+ int core_amount,
+ size_t ramsize = 1024);
+#ifndef DOXYGEN
// No copy/move
VirtualMachine(VirtualMachine const&) = delete;
VirtualMachine& operator=(VirtualMachine const&) = delete;
+#endif
- enum class state {
+ // enum class State { ... }
+ XBT_DECLARE_ENUM_CLASS(State,
CREATED, /**< created, but not yet started */
RUNNING,
SUSPENDED, /**< Suspend/resume does not involve disk I/O, so we assume there is no transition states. */
DESTROYED
- };
+ );
- simgrid::vm::VirtualMachineImpl* get_impl() { return pimpl_vm_; }
+ kernel::resource::VirtualMachineImpl* get_vm_impl() const { return pimpl_vm_; }
void start();
void suspend();
void resume();
void shutdown();
- void destroy();
-
- simgrid::s4u::Host* get_pm();
- void set_pm(simgrid::s4u::Host* pm);
- size_t get_ramsize();
- void set_ramsize(size_t ramsize);
- void set_bound(double bound);
-
- VirtualMachine::state get_state();
- static simgrid::xbt::signal<void(VirtualMachine&)> on_start;
- static simgrid::xbt::signal<void(VirtualMachine&)> on_started;
- static simgrid::xbt::signal<void(VirtualMachine&)> on_shutdown;
- static simgrid::xbt::signal<void(VirtualMachine&)> on_suspend;
- static simgrid::xbt::signal<void(VirtualMachine&)> on_resume;
- static simgrid::xbt::signal<void(VirtualMachine&)> on_migration_start;
- static simgrid::xbt::signal<void(VirtualMachine&)> on_migration_end;
+ void destroy() override;
-#ifndef DOXYGEN
- // Deprecated methods
- /** @deprecated See VirtualMachine::get_state() */
- XBT_ATTRIB_DEPRECATED_v323("Please use VirtualMachine::get_state()") VirtualMachine::state getState()
- {
- return get_state();
- }
- /** @deprecated See VirtualMachine::get_impl() */
- XBT_ATTRIB_DEPRECATED_v323("Please use VirtualMachine::get_impl()") simgrid::vm::VirtualMachineImpl* getImpl()
+ Host* get_pm() const;
+ VirtualMachine* set_pm(Host* pm);
+ size_t get_ramsize() const;
+ VirtualMachine* set_ramsize(size_t ramsize);
+ VirtualMachine* set_bound(double bound);
+ void start_migration() const;
+ void end_migration() const;
+
+ State get_state() const;
+
+ /* Callbacks on signals */
+ static void on_creation_cb(const std::function<void(VirtualMachine&)>& cb) { on_creation.connect(cb); }
+ static void on_start_cb(const std::function<void(VirtualMachine const&)>& cb) { on_start.connect(cb); }
+ static void on_started_cb(const std::function<void(VirtualMachine const&)>& cb) { on_started.connect(cb); }
+ static void on_shutdown_cb(const std::function<void(VirtualMachine const&)>& cb) { on_shutdown.connect(cb); }
+ static void on_suspend_cb(const std::function<void(VirtualMachine const&)>& cb) { on_suspend.connect(cb); }
+ static void on_resume_cb(const std::function<void(VirtualMachine const&)>& cb) { on_resume.connect(cb); }
+ static void on_destruction_cb(const std::function<void(VirtualMachine const&)>& cb) { on_destruction.connect(cb); }
+ static void on_migration_start_cb(const std::function<void(VirtualMachine const&)>& cb)
{
- return pimpl_vm_;
+ on_migration_start.connect(cb);
}
- /** @deprecated See VirtualMachine::get_pm() */
- XBT_ATTRIB_DEPRECATED_v323("Please use VirtualMachine::get_pm()") simgrid::s4u::Host* getPm() { return get_pm(); }
- /** @deprecated See VirtualMachine::set_pm() */
- XBT_ATTRIB_DEPRECATED_v323("Please use VirtualMachine::set_pm()") void setPm(simgrid::s4u::Host* pm) { set_pm(pm); }
- /** @deprecated See VirtualMachine::get_ramsize() */
- XBT_ATTRIB_DEPRECATED_v323("Please use VirtualMachine::get_ramsize()") size_t getRamsize() { return get_ramsize(); }
- /** @deprecated See VirtualMachine::set_ramsize() */
- XBT_ATTRIB_DEPRECATED_v323("Please use VirtualMachine::set_ramsize()") void setRamsize(size_t ramsize)
+ static void on_migration_end_cb(const std::function<void(VirtualMachine const&)>& cb)
{
- set_ramsize(ramsize);
+ on_migration_end.connect(cb);
}
- /** @deprecated See VirtualMachine::set_bound() */
- XBT_ATTRIB_DEPRECATED_v323("Please use VirtualMachine::set_bound()") void setBound(double bound) { set_bound(bound); }
-#endif
};
-}
-} // namespace simgrid::s4u
+} // namespace s4u
+} // namespace simgrid
#endif
