add signals for VM live migration start/end

[simgrid.git] / include / simgrid / s4u / VirtualMachine.hpp

diff --git a/include/simgrid/s4u/VirtualMachine.hpp b/include/simgrid/s4u/VirtualMachine.hpp
index 2085fae..f7bb2c7 100644 (file)
--- a/include/simgrid/s4u/VirtualMachine.hpp
+++ b/include/simgrid/s4u/VirtualMachine.hpp
@@ -1,4 +1,4 @@
-/* Copyright (c) 2015-2017. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2015-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. */
@@ -6,58 +6,79 @@
 #ifndef SIMGRID_S4U_VM_HPP
 #define SIMGRID_S4U_VM_HPP
 
-#include "simgrid/datatypes.h"
-#include "simgrid/s4u/Host.hpp"
-#include "simgrid/s4u/forward.hpp"
-
-typedef enum {
-  SURF_VM_STATE_CREATED, /**< created, but not yet started */
-  SURF_VM_STATE_RUNNING,
-  SURF_VM_STATE_SUSPENDED, /**< Suspend/resume does not involve disk I/O, so we assume there is no transition states. */
-  SURF_VM_STATE_DESTROYED
-} e_surf_vm_state_t;
+#include <simgrid/s4u/Host.hpp>
 
 namespace simgrid {
-namespace vm {
-class VirtualMachineImpl;
-};
 namespace s4u {
 
 /** @ingroup s4u_api
  *
  * @tableofcontents
  *
- * A VM is a virtual machine that contains actors. The total computing power that the contained
- * processes can get is constrained to the virtual machine size.
+ * A VM represents a virtual machine (or a container) that hosts actors.
+ * The total computing power that the contained actors can get is constrained to the virtual machine size.
  *
  */
-XBT_PUBLIC_CLASS VirtualMachine : public s4u::Host
-{
+class XBT_PUBLIC VirtualMachine : public s4u::Host {
+  simgrid::vm::VirtualMachineImpl* pimpl_vm_ = nullptr;
+  virtual ~VirtualMachine();
 
 public:
-  explicit VirtualMachine(const char* name, s4u::Host* hostPm);
+  explicit VirtualMachine(const char* name, s4u::Host* physical_host, int core_amount);
+  explicit VirtualMachine(const char* name, s4u::Host* physical_host, int core_amount, size_t ramsize);
 
   // No copy/move
   VirtualMachine(VirtualMachine const&) = delete;
   VirtualMachine& operator=(VirtualMachine const&) = delete;
 
-private:
-  virtual ~VirtualMachine();
+  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
+  };
 
-public:
-  bool isMigrating();
+  simgrid::vm::VirtualMachineImpl* get_impl() { return pimpl_vm_; }
+  void start();
+  void suspend();
+  void resume();
+  void shutdown();
+  void destroy();
 
-  void parameters(vm_params_t params);
-  void setParameters(vm_params_t params);
-  double getRamsize();
-  simgrid::s4u::Host* pm();
+  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);
 
-  e_surf_vm_state_t getState();
+  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;
 
-  /* FIXME: protect me */
-  simgrid::vm::VirtualMachineImpl* pimpl_vm_ = nullptr;
+  // Deprecated methods
+  XBT_ATTRIB_DEPRECATED_v323("Please use VirtualMachine::get_state()") VirtualMachine::state getState()
+  {
+    return get_state();
+  }
+  XBT_ATTRIB_DEPRECATED_v323("Please use VirtualMachine::get_impl()") simgrid::vm::VirtualMachineImpl* getImpl()
+  {
+    return pimpl_vm_;
+  }
+  XBT_ATTRIB_DEPRECATED_v323("Please use VirtualMachine::get_pm()") simgrid::s4u::Host* getPm() { return get_pm(); }
+  XBT_ATTRIB_DEPRECATED_v323("Please use VirtualMachine::set_pm()") void setPm(simgrid::s4u::Host* pm) { set_pm(pm); }
+  XBT_ATTRIB_DEPRECATED_v323("Please use VirtualMachine::get_ramsize()") size_t getRamsize() { return get_ramsize(); }
+  XBT_ATTRIB_DEPRECATED_v323("Please use VirtualMachine::set_ramsize()") void setRamsize(size_t ramsize)
+  {
+    set_ramsize(ramsize);
+  }
+  XBT_ATTRIB_DEPRECATED_v323("Please use VirtualMachine::set_bound()") void setBound(double bound) { set_bound(bound); }
 };
 }
 } // namespace simgrid::s4u
 
-#endif /* SIMGRID_S4U_HOST_HPP */
+#endif