Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Use the right version for the deprecate macro
[simgrid.git] / include / simgrid / s4u / VirtualMachine.hpp
index 1292c46924e10e5c5e900bba5bb52535e0cafc0b..6afde5be189d11e1eefd050e0b63c34a8fa7504a 100644 (file)
@@ -1,4 +1,4 @@
-/* Copyright (c) 2015-2021. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2015-2023. 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. */
@@ -10,8 +10,7 @@
 #include <simgrid/s4u/Host.hpp>
 #include <xbt/utility.hpp>
 
-namespace simgrid {
-namespace s4u {
+namespace simgrid::s4u {
 
 /** @brief Host extension for the VMs */
 class VmHostExt {
@@ -34,9 +33,28 @@ public:
 class XBT_PUBLIC VirtualMachine : public s4u::Host {
   kernel::resource::VirtualMachineImpl* const pimpl_vm_;
 
+  /* Signals about the life cycle of the VM */
+  static xbt::signal<void(VirtualMachine&)> on_vm_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_vm_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(const std::string& name, Host* physical_host, int core_amount);
-  explicit VirtualMachine(const std::string& name, 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
@@ -51,9 +69,6 @@ public:
     SUSPENDED, /**< Suspend/resume does not involve disk I/O, so we assume there is no transition states. */
     DESTROYED
   );
-#ifndef DOXYGEN
-  using state XBT_ATTRIB_DEPRECATED_v332("Please use VirtualMachine::State") = State;
-#endif
 
   kernel::resource::VirtualMachineImpl* get_vm_impl() const { return pimpl_vm_; }
   void start();
@@ -67,15 +82,19 @@ public:
   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;
-  static void on_creation_cb(const std::function<void(VirtualMachine&)>& cb) { on_creation.connect(cb); }
+
+  /* Callbacks on signals */
+  static void on_creation_cb(const std::function<void(VirtualMachine&)>& cb) { on_vm_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_destruction_cb(const std::function<void(VirtualMachine const&)>& cb) { on_vm_destruction.connect(cb); }
   static void on_migration_start_cb(const std::function<void(VirtualMachine const&)>& cb)
   {
     on_migration_start.connect(cb);
@@ -84,21 +103,7 @@ public:
   {
     on_migration_end.connect(cb);
   }
-#ifndef DOXYGEN
-  /* FIXME the signals should be private */
-  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;
-#endif
-private:
-  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;
 };
-} // namespace s4u
-} // namespace simgrid
+} // namespace simgrid::s4u
 
 #endif