Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
yet another bunch of int -> unsigned long
[simgrid.git] / include / simgrid / s4u / VirtualMachine.hpp
index b6863b3..76e8380 100644 (file)
@@ -1,4 +1,4 @@
-/* Copyright (c) 2015-2016. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2015-2021. 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,42 +6,69 @@
 #ifndef SIMGRID_S4U_VM_HPP
 #define SIMGRID_S4U_VM_HPP
 
-#include <simgrid/s4u/forward.hpp>
-#include <simgrid/s4u/host.hpp>
-#include <xbt/base.h>
+#include <simgrid/forward.h>
+#include <simgrid/s4u/Host.hpp>
+#include <xbt/utility.hpp>
 
 namespace simgrid {
-
 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 {
+  vm::VirtualMachineImpl* const pimpl_vm_;
+  ~VirtualMachine() override;
 
 public:
-  explicit VirtualMachine(const char* name, s4u::Host* hostPm);
+  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);
 
+#ifndef DOXYGEN
   // No copy/move
   VirtualMachine(VirtualMachine const&) = delete;
   VirtualMachine& operator=(VirtualMachine const&) = delete;
+#endif
 
-private:
-  virtual ~VirtualMachine();
+  // 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
+  );
+#ifndef DOXYGEN
+  using state XBT_ATTRIB_DEPRECATED_v332("Please use VirtualMachine::State") = State;
+#endif
 
-public:
-  bool isMigrating();
+  vm::VirtualMachineImpl* get_vm_impl() const { return pimpl_vm_; }
+  void start();
+  void suspend();
+  void resume();
+  void shutdown();
+  void destroy() override;
+
+  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 parameters(vm_params_t params);
-  void setParameters(vm_params_t params);
+  State get_state() const;
+  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;
 };
-}
-} // namespace simgrid::s4u
+} // namespace s4u
+} // namespace simgrid
 
-#endif /* SIMGRID_S4U_HOST_HPP */
+#endif