-/* Copyright (c) 2015-2017. The SimGrid Team. All rights reserved. */
+/* Copyright (c) 2015-2019. 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. */
+#include "simgrid/Exception.hpp"
#include "simgrid/s4u/Actor.hpp"
-#include "src/instr/instr_private.hpp"
+#include "simgrid/vm.h"
+#include "src/include/surf/surf.hpp"
#include "src/plugins/vm/VirtualMachineImpl.hpp"
#include "src/plugins/vm/VmHostExt.hpp"
-#include "src/simix/smx_host_private.hpp"
#include "src/surf/cpu_cas01.hpp"
-#include <src/plugins/vm/VmLiveMigration.hpp>
-XBT_LOG_NEW_DEFAULT_CATEGORY(s4u_vm, "S4U virtual machines");
+XBT_LOG_NEW_DEFAULT_SUBCATEGORY(s4u_vm, s4u, "S4U virtual machines");
namespace simgrid {
namespace s4u {
+simgrid::xbt::signal<void(VirtualMachine const&)> VirtualMachine::on_start;
+simgrid::xbt::signal<void(VirtualMachine const&)> VirtualMachine::on_started;
+simgrid::xbt::signal<void(VirtualMachine const&)> VirtualMachine::on_shutdown;
+simgrid::xbt::signal<void(VirtualMachine const&)> VirtualMachine::on_suspend;
+simgrid::xbt::signal<void(VirtualMachine const&)> VirtualMachine::on_resume;
+simgrid::xbt::signal<void(VirtualMachine const&)> VirtualMachine::on_migration_start;
+simgrid::xbt::signal<void(VirtualMachine const&)> VirtualMachine::on_migration_end;
-VirtualMachine::VirtualMachine(const char* name, s4u::Host* pm, int coreAmount)
- : VirtualMachine(name, pm, coreAmount, 0)
+VirtualMachine::VirtualMachine(const std::string& name, s4u::Host* physical_host, int core_amount)
+ : VirtualMachine(name, physical_host, core_amount, 1024)
{
}
-VirtualMachine::VirtualMachine(const char* name, s4u::Host* pm, int coreAmount, size_t ramsize)
- : Host(name), pimpl_vm_(new vm::VirtualMachineImpl(this, pm, coreAmount, ramsize))
+VirtualMachine::VirtualMachine(const std::string& name, s4u::Host* physical_host, int core_amount, size_t ramsize)
+ : Host(name), pimpl_vm_(new vm::VirtualMachineImpl(this, physical_host, core_amount, ramsize))
{
- XBT_DEBUG("Create VM %s", name);
+ XBT_DEBUG("Create VM %s", get_cname());
/* Currently, a VM uses the network resource of its physical host */
- pimpl_netpoint = pm->pimpl_netpoint;
- // Create a VCPU for this VM
- surf::CpuCas01* sub_cpu = dynamic_cast<surf::CpuCas01*>(pm->pimpl_cpu);
-
- pimpl_cpu = surf_cpu_model_vm->createCpu(this, sub_cpu->getSpeedPeakList(), coreAmount);
- if (sub_cpu->getPState() != 0)
- pimpl_cpu->setPState(sub_cpu->getPState());
+ set_netpoint(physical_host->get_netpoint());
- /* Make a process container */
- extension_set<simgrid::simix::Host>(new simgrid::simix::Host());
+ // Create a VCPU for this VM
+ std::vector<double> speeds;
+ for (int i = 0; i < physical_host->get_pstate_count(); i++)
+ speeds.push_back(physical_host->get_pstate_speed(i));
- if (TRACE_msg_vm_is_enabled()) {
- container_t host_container = simgrid::instr::Container::byName(pm->getName());
- new simgrid::instr::Container(name, "MSG_VM", host_container);
- }
+ surf_cpu_model_vm->create_cpu(this, speeds, core_amount);
+ if (physical_host->get_pstate() != 0)
+ set_pstate(physical_host->get_pstate());
}
VirtualMachine::~VirtualMachine()
{
- onDestruction(*this);
-
- XBT_DEBUG("destroy %s", getCname());
+ on_destruction(*this);
- /* FIXME: this is really strange that everything fails if the next line is removed.
- * This is as if we shared these data with the PM, which definitely should not be the case...
- *
- * We need to test that suspending a VM does not suspends the processes running on its PM, for example.
- * Or we need to simplify this code enough to make it actually readable (but this sounds harder than testing)
- */
- extension_set<simgrid::simix::Host>(nullptr);
+ XBT_DEBUG("destroy %s", get_cname());
/* Don't free these things twice: they are the ones of my physical host */
- pimpl_netpoint = nullptr;
+ set_netpoint(nullptr);
}
void VirtualMachine::start()
{
- simgrid::simix::kernelImmediate([this]() {
- simgrid::vm::VmHostExt::ensureVmExtInstalled();
+ on_start(*this);
- simgrid::s4u::Host* pm = this->pimpl_vm_->getPm();
- if (pm->extension<simgrid::vm::VmHostExt>() == nullptr)
- pm->extension_set(new simgrid::vm::VmHostExt());
+ kernel::actor::simcall([this]() {
+ vm::VmHostExt::ensureVmExtInstalled();
- long pm_ramsize = pm->extension<simgrid::vm::VmHostExt>()->ramsize;
- int pm_overcommit = pm->extension<simgrid::vm::VmHostExt>()->overcommit;
- long vm_ramsize = this->getRamsize();
+ Host* pm = this->pimpl_vm_->get_physical_host();
+ if (pm->extension<vm::VmHostExt>() == nullptr)
+ pm->extension_set(new vm::VmHostExt());
+
+ long pm_ramsize = pm->extension<vm::VmHostExt>()->ramsize;
+ int pm_overcommit = pm->extension<vm::VmHostExt>()->overcommit;
+ long vm_ramsize = this->get_ramsize();
if (pm_ramsize && not pm_overcommit) { /* Only verify that we don't overcommit on need */
/* Retrieve the memory occupied by the VMs on that host. Yep, we have to traverse all VMs of all hosts for that */
long total_ramsize_of_vms = 0;
- for (simgrid::s4u::VirtualMachine* const& ws_vm : simgrid::vm::VirtualMachineImpl::allVms_)
- if (pm == ws_vm->pimpl_vm_->getPm())
- total_ramsize_of_vms += ws_vm->pimpl_vm_->getRamsize();
+ for (VirtualMachine* const& ws_vm : vm::VirtualMachineImpl::allVms_)
+ if (pm == ws_vm->get_pm())
+ total_ramsize_of_vms += ws_vm->get_ramsize();
if (vm_ramsize > pm_ramsize - total_ramsize_of_vms) {
- XBT_WARN("cannnot start %s@%s due to memory shortage: vm_ramsize %ld, free %ld, pm_ramsize %ld (bytes).",
- this->getCname(), pm->getCname(), vm_ramsize, pm_ramsize - total_ramsize_of_vms, pm_ramsize);
- THROWF(vm_error, 0, "Memory shortage on host '%s', VM '%s' cannot be started", pm->getCname(),
- this->getCname());
+ XBT_WARN("cannot start %s@%s due to memory shortage: vm_ramsize %ld, free %ld, pm_ramsize %ld (bytes).",
+ this->get_cname(), pm->get_cname(), vm_ramsize, pm_ramsize - total_ramsize_of_vms, pm_ramsize);
+ throw VmFailureException(XBT_THROW_POINT,
+ xbt::string_printf("Memory shortage on host '%s', VM '%s' cannot be started",
+ pm->get_cname(), this->get_cname()));
}
}
- this->pimpl_vm_->setState(SURF_VM_STATE_RUNNING);
+ this->pimpl_vm_->set_state(VirtualMachine::state::RUNNING);
});
+
+ on_started(*this);
}
void VirtualMachine::suspend()
{
- smx_actor_t issuer = SIMIX_process_self();
- simgrid::simix::kernelImmediate([this, issuer]() { pimpl_vm_->suspend(issuer); });
- XBT_DEBUG("vm_suspend done");
+ on_suspend(*this);
+ kernel::actor::ActorImpl* issuer = kernel::actor::ActorImpl::self();
+ kernel::actor::simcall([this, issuer]() { pimpl_vm_->suspend(issuer); });
}
void VirtualMachine::resume()
{
pimpl_vm_->resume();
+ on_resume(*this);
}
void VirtualMachine::shutdown()
{
- smx_actor_t issuer = SIMIX_process_self();
- simgrid::simix::kernelImmediate([this, issuer]() { pimpl_vm_->shutdown(issuer); });
+ kernel::actor::ActorImpl* issuer = kernel::actor::ActorImpl::self();
+ kernel::actor::simcall([this, issuer]() { pimpl_vm_->shutdown(issuer); });
+ on_shutdown(*this);
+}
+
+void VirtualMachine::destroy()
+{
+ /* First, terminate all processes on the VM if necessary */
+ shutdown();
+
+ /* Then, destroy the VM object */
+ Host::destroy();
}
-bool VirtualMachine::isMigrating()
+simgrid::s4u::Host* VirtualMachine::get_pm() const
{
- return pimpl_vm_ && pimpl_vm_->isMigrating;
+ return pimpl_vm_->get_physical_host();
}
-simgrid::s4u::Host* VirtualMachine::getPm()
+void VirtualMachine::set_pm(simgrid::s4u::Host* pm)
{
- return pimpl_vm_->getPm();
+ kernel::actor::simcall([this, pm]() { pimpl_vm_->set_physical_host(pm); });
}
-e_surf_vm_state_t VirtualMachine::getState()
+VirtualMachine::state VirtualMachine::get_state()
{
- return pimpl_vm_->getState();
+ return kernel::actor::simcall([this]() { return pimpl_vm_->get_state(); });
}
-size_t VirtualMachine::getRamsize()
+size_t VirtualMachine::get_ramsize() const
{
- return pimpl_vm_->getRamsize();
+ return pimpl_vm_->get_ramsize();
}
-void VirtualMachine::setRamsize(size_t ramsize)
+void VirtualMachine::set_ramsize(size_t ramsize)
{
- pimpl_vm_->setRamsize(ramsize);
+ pimpl_vm_->set_ramsize(ramsize);
}
/** @brief Set a CPU bound for a given VM.
* @ingroup msg_VMs
* 2. Note that bound == 0 means no bound (i.e., unlimited). But, if a host has multiple CPU cores, the CPU share of a
* computation task (or a VM) never exceeds the capacity of a CPU core.
*/
-void VirtualMachine::setBound(double bound)
+void VirtualMachine::set_bound(double bound)
+{
+ kernel::actor::simcall([this, bound]() { pimpl_vm_->set_bound(bound); });
+}
+
+} // namespace simgrid
+} // namespace s4u
+
+/* **************************** Public C interface *************************** */
+
+/** @brief Create a new VM object with the default parameters
+ * A VM is treated as a host. The name of the VM must be unique among all hosts.
+ */
+sg_vm_t sg_vm_create_core(sg_host_t pm, const char* name)
{
- simgrid::simix::kernelImmediate([this, bound]() { pimpl_vm_->setBound(bound); });
+ return sg_vm_create_multicore(pm, name, 1);
}
-/** @brief Retrieve a copy of the parameters of that VM/PM
- * @details The ramsize and overcommit fields are used on the PM too */
-void VirtualMachine::getParameters(vm_params_t params)
+/** @brief Create a new VM object with the default parameters, but with a specified amount of cores
+ * A VM is treated as a host. The name of the VM must be unique among all hosts.
+ */
+sg_vm_t sg_vm_create_multicore(sg_host_t pm, const char* name, int coreAmount)
{
- pimpl_vm_->getParams(params);
+ return new simgrid::s4u::VirtualMachine(name, pm, coreAmount);
}
-/** @brief Sets the params of that VM/PM */
-void VirtualMachine::setParameters(vm_params_t params)
+
+const char* sg_vm_get_name(const_sg_vm_t vm)
{
- simgrid::simix::kernelImmediate([this, params] { pimpl_vm_->setParams(params); });
+ return vm->get_cname();
}
-} // namespace simgrid
-} // namespace s4u
+/** @brief Get the physical host of a given VM. */
+sg_host_t sg_vm_get_pm(const_sg_vm_t vm)
+{
+ return vm->get_pm();
+}
+
+void sg_vm_set_ramsize(sg_vm_t vm, size_t size)
+{
+ vm->set_ramsize(size);
+}
+
+size_t sg_vm_get_ramsize(const_sg_vm_t vm)
+{
+ return vm->get_ramsize();
+}
+
+void sg_vm_set_bound(sg_vm_t vm, double bound)
+{
+ vm->set_bound(bound);
+}
+
+/** @brief Returns whether the given VM has just created, not running. */
+int sg_vm_is_created(sg_vm_t vm)
+{
+ return vm->get_state() == simgrid::s4u::VirtualMachine::state::CREATED;
+}
+
+/** @brief Returns whether the given VM is currently running */
+int sg_vm_is_running(sg_vm_t vm)
+{
+ return vm->get_state() == simgrid::s4u::VirtualMachine::state::RUNNING;
+}
+
+/** @brief Returns whether the given VM is currently suspended, not running. */
+int sg_vm_is_suspended(sg_vm_t vm)
+{
+ return vm->get_state() == simgrid::s4u::VirtualMachine::state::SUSPENDED;
+}
+
+/** @brief Start a vm (i.e., boot the guest operating system)
+ * If the VM cannot be started (because of memory over-provisioning), an exception is generated.
+ */
+void sg_vm_start(sg_vm_t vm)
+{
+ vm->start();
+}
+
+/** @brief Immediately suspend the execution of all processes within the given VM.
+ *
+ * This function stops the execution of the VM. All the processes on this VM
+ * will pause. The state of the VM is preserved. We can later resume it again.
+ *
+ * No suspension cost occurs.
+ */
+void sg_vm_suspend(sg_vm_t vm)
+{
+ vm->suspend();
+}
+
+/** @brief Resume the execution of the VM. All processes on the VM run again.
+ * No resume cost occurs.
+ */
+void sg_vm_resume(sg_vm_t vm)
+{
+ vm->resume();
+}
+
+/** @brief Immediately kills all processes within the given VM.
+ *
+ @beginrst
+
+ The memory allocated by these actors is leaked, unless you used :cpp:func:`simgrid::s4u::Actor::on_exit`.
+
+ @endrst
+ *
+ * No extra delay occurs by default. You may let your actor sleep by a specific amount to simulate any extra delay that you want.
+ */
+void sg_vm_shutdown(sg_vm_t vm)
+{
+ vm->shutdown();
+}
+
+/** @brief Destroy a VM. Destroy the VM object from the simulation. */
+void sg_vm_destroy(sg_vm_t vm)
+{
+ vm->destroy();
+}
