Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Merge branch 'master' of git+ssh://scm.gforge.inria.fr//gitroot/simgrid/simgrid
[simgrid.git] / src / simix / smx_vm.cpp
index 1bf7c7a..073a9fb 100644 (file)
@@ -1,5 +1,4 @@
-/* Copyright (c) 2007-2015. The SimGrid Team.
- * All rights reserved.                                                     */
+/* Copyright (c) 2007-2015. 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. */
@@ -9,15 +8,14 @@
 #include "src/surf/virtual_machine.hpp"
 #include "src/surf/HostImpl.hpp"
 
-//If you need to log some stuffs, just uncomment these two lines and uses XBT_DEBUG for instance
 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_vm, simix, "Logging specific to SIMIX (vms)");
 
 /* **** create a VM **** */
 
 /**
- * \brief Internal function to create a SIMIX host.
- * \param name name of the host to create
- * \param data some user data (may be NULL)
+ * @brief Internal function to create a SIMIX host.
+ * @param name name of the host to create
+ * @param data some user data (may be nullptr)
  */
 sg_host_t SIMIX_vm_create(const char *name, sg_host_t ind_phys_host)
 {
@@ -52,7 +50,7 @@ static int __can_be_started(sg_host_t vm)
 
   int pm_overcommit = 0;
   long pm_ramsize = host_get_ramsize(pm, &pm_overcommit);
-  long vm_ramsize = host_get_ramsize(vm, NULL);
+  long vm_ramsize = host_get_ramsize(vm, nullptr);
 
   if (!pm_ramsize) {
     /* We assume users do not want to care about ramsize. */
@@ -60,7 +58,7 @@ static int __can_be_started(sg_host_t vm)
   }
 
   if (pm_overcommit) {
-    XBT_INFO("%s allows memory overcommit.", sg_host_get_name(pm));
+    XBT_VERB("%s allows memory overcommit.", sg_host_get_name(pm));
     return 1;
   }
 
@@ -70,7 +68,7 @@ static int __can_be_started(sg_host_t vm)
     unsigned int cursor = 0;
     sg_host_t another_vm;
     xbt_dynar_foreach(dyn_vms, cursor, another_vm) {
-      long another_vm_ramsize = host_get_ramsize(vm, NULL);
+      long another_vm_ramsize = host_get_ramsize(vm, nullptr);
       total_ramsize_of_vms += another_vm_ramsize;
     }
   }
@@ -105,9 +103,9 @@ e_surf_vm_state_t SIMIX_vm_get_state(sg_host_t ind_vm)
 }
 
 /**
- * \brief Function to migrate a SIMIX VM host.
+ * @brief Function to migrate a SIMIX VM host.
  *
- * \param host the vm host to migrate (a sg_host_t)
+ * @param host the vm host to migrate (a sg_host_t)
  */
 void SIMIX_vm_migrate(sg_host_t ind_vm, sg_host_t ind_dst_pm)
 {
@@ -119,7 +117,7 @@ void SIMIX_vm_migrate(sg_host_t ind_vm, sg_host_t ind_dst_pm)
 }
 
 /**
- * \brief Encompassing simcall to prevent the removal of the src or the dst node at the end of a VM migration
+ * @brief Encompassing simcall to prevent the removal of the src or the dst node at the end of a VM migration
  *  The simcall actually invokes the following calls: 
  *     simcall_vm_set_affinity(vm, src_pm, 0); 
  *     simcall_vm_migrate(vm, dst_pm); 
@@ -127,9 +125,9 @@ void SIMIX_vm_migrate(sg_host_t ind_vm, sg_host_t ind_dst_pm)
  *
  * It is called at the end of the migration_rx_fun function from msg/msg_vm.c
  *
- * \param vm VM to migrate
- * \param src_pm  Source physical host
- * \param dst_pmt Destination physical host
+ * @param vm VM to migrate
+ * @param src_pm  Source physical host
+ * @param dst_pmt Destination physical host
  */
 void SIMIX_vm_migratefrom_resumeto(sg_host_t vm, sg_host_t src_pm, sg_host_t dst_pm)
 {
@@ -145,51 +143,48 @@ void SIMIX_vm_migratefrom_resumeto(sg_host_t vm, sg_host_t src_pm, sg_host_t dst
 } 
 
 /**
- * \brief Function to get the physical host of the given SIMIX VM host.
+ * @brief Function to get the physical host of the given SIMIX VM host.
  *
- * \param host the vm host to get_phys_host (a sg_host_t)
+ * @param host the vm host to get_phys_host (a sg_host_t)
  */
-void *SIMIX_vm_get_pm(sg_host_t ind_vm)
+void *SIMIX_vm_get_pm(sg_host_t host)
 {
-  /* jump to vm_ws_get_pm(). this will return the vm name. */
-  return surf_vm_get_pm(ind_vm);
+  return surf_vm_get_pm(host);
 }
 
 /**
- * \brief Function to set the CPU bound of the given SIMIX VM host.
+ * @brief Function to set the CPU bound of the given SIMIX VM host.
  *
- * \param host the vm host (a sg_host_t)
- * \param bound bound (a double)
+ * @param host the vm host (a sg_host_t)
+ * @param bound bound (a double)
  */
-void SIMIX_vm_set_bound(sg_host_t ind_vm, double bound)
+void SIMIX_vm_set_bound(sg_host_t host, double bound)
 {
-  /* jump to vm_ws_set_vm_bound(). */
-  surf_vm_set_bound(ind_vm, bound);
+  surf_vm_set_bound(host, bound);
 }
 
 /**
- * \brief Function to set the CPU affinity of the given SIMIX VM host.
+ * @brief Function to set the CPU affinity of the given SIMIX VM host.
  *
- * \param host the vm host (a sg_host_t)
- * \param host the pm host (a sg_host_t)
- * \param mask affinity mask (a unsigned long)
+ * @param host the vm host (a sg_host_t)
+ * @param host the pm host (a sg_host_t)
+ * @param mask affinity mask (a unsigned long)
  */
 void SIMIX_vm_set_affinity(sg_host_t ind_vm, sg_host_t ind_pm, unsigned long mask)
 {
   /* make sure this at the MSG layer. */
   xbt_assert(SIMIX_vm_get_pm(ind_vm) == ind_pm);
 
-  /* jump to vm_ws_set_vm_affinity(). */
   surf_vm_set_affinity(ind_vm, ind_pm, mask);
 }
 
 
 /**
- * \brief Function to suspend a SIMIX VM host. This function stops the execution of the
+ * @brief Function to suspend a SIMIX VM host. This function stops the execution of the
  * VM. All the processes on this VM will pause. The state of the VM is
  * preserved on memory. We can later resume it again.
  *
- * \param host the vm host to suspend (a sg_host_t)
+ * @param host the vm host to suspend (a sg_host_t)
  */
 void SIMIX_vm_suspend(sg_host_t ind_vm, smx_process_t issuer)
 {
@@ -205,7 +200,7 @@ void SIMIX_vm_suspend(sg_host_t ind_vm, smx_process_t issuer)
 
   smx_process_t smx_process, smx_process_safe;
   xbt_swag_foreach_safe(smx_process, smx_process_safe, sg_host_simix(ind_vm)->process_list) {
-    XBT_DEBUG("suspend %s", smx_process->name);
+    XBT_DEBUG("suspend %s", smx_process->name.c_str());
     SIMIX_process_suspend(smx_process, issuer);
   }
 
@@ -226,10 +221,10 @@ void simcall_HANDLER_vm_suspend(smx_simcall_t simcall, sg_host_t ind_vm)
 
 
 /**
- * \brief Function to resume a SIMIX VM host. This function restart the execution of the
+ * @brief Function to resume a SIMIX VM host. This function restart the execution of the
  * VM. All the processes on this VM will run again.
  *
- * \param host the vm host to resume (a sg_host_t)
+ * @param host the vm host to resume (a sg_host_t)
  */
 void SIMIX_vm_resume(sg_host_t ind_vm, smx_process_t issuer)
 {
@@ -245,7 +240,7 @@ void SIMIX_vm_resume(sg_host_t ind_vm, smx_process_t issuer)
 
   smx_process_t smx_process, smx_process_safe;
   xbt_swag_foreach_safe(smx_process, smx_process_safe, sg_host_simix(ind_vm)->process_list) {
-    XBT_DEBUG("resume %s", smx_process->name);
+    XBT_DEBUG("resume %s", smx_process->name.c_str());
     SIMIX_process_resume(smx_process, issuer);
   }
 }
@@ -257,11 +252,11 @@ void simcall_HANDLER_vm_resume(smx_simcall_t simcall, sg_host_t ind_vm)
 
 
 /**
- * \brief Function to save a SIMIX VM host.
+ * @brief Function to save a SIMIX VM host.
  * This function is the same as vm_suspend, but the state of the VM is saved to the disk, and not preserved on memory.
  * We can later restore it again.
  *
- * \param host the vm host to save (a sg_host_t)
+ * @param host the vm host to save (a sg_host_t)
  */
 void SIMIX_vm_save(sg_host_t ind_vm, smx_process_t issuer)
 {
@@ -278,7 +273,7 @@ void SIMIX_vm_save(sg_host_t ind_vm, smx_process_t issuer)
 
   smx_process_t smx_process, smx_process_safe;
   xbt_swag_foreach_safe(smx_process, smx_process_safe, sg_host_simix(ind_vm)->process_list) {
-    XBT_DEBUG("suspend %s", smx_process->name);
+    XBT_DEBUG("suspend %s", smx_process->name.c_str());
     SIMIX_process_suspend(smx_process, issuer);
   }
 }
@@ -290,10 +285,10 @@ void simcall_HANDLER_vm_save(smx_simcall_t simcall, sg_host_t ind_vm)
 
 
 /**
- * \brief Function to restore a SIMIX VM host. This function restart the execution of the
+ * @brief Function to restore a SIMIX VM host. This function restart the execution of the
  * VM. All the processes on this VM will run again.
  *
- * \param host the vm host to restore (a sg_host_t)
+ * @param host the vm host to restore (a sg_host_t)
  */
 void SIMIX_vm_restore(sg_host_t ind_vm, smx_process_t issuer)
 {
@@ -309,7 +304,7 @@ void SIMIX_vm_restore(sg_host_t ind_vm, smx_process_t issuer)
 
   smx_process_t smx_process, smx_process_safe;
   xbt_swag_foreach_safe(smx_process, smx_process_safe, sg_host_simix(ind_vm)->process_list) {
-    XBT_DEBUG("resume %s", smx_process->name);
+    XBT_DEBUG("resume %s", smx_process->name.c_str());
     SIMIX_process_resume(smx_process, issuer);
   }
 }
@@ -321,11 +316,11 @@ void simcall_HANDLER_vm_restore(smx_simcall_t simcall, sg_host_t ind_vm)
 
 
 /**
- * \brief Function to shutdown a SIMIX VM host. This function powers off the
+ * @brief Function to shutdown a SIMIX VM host. This function powers off the
  * VM. All the processes on this VM will be killed. But, the state of the VM is
  * preserved on memory. We can later start it again.
  *
- * \param host the vm host to shutdown (a sg_host_t)
+ * @param host the vm host to shutdown (a sg_host_t)
  */
 void SIMIX_vm_shutdown(sg_host_t ind_vm, smx_process_t issuer)
 {
@@ -339,7 +334,7 @@ void SIMIX_vm_shutdown(sg_host_t ind_vm, smx_process_t issuer)
 
   smx_process_t smx_process, smx_process_safe;
   xbt_swag_foreach_safe(smx_process, smx_process_safe, sg_host_simix(ind_vm)->process_list) {
-    XBT_DEBUG("kill %s", smx_process->name);
+    XBT_DEBUG("kill %s", smx_process->name.c_str());
     SIMIX_process_kill(smx_process, issuer);
   }
 
@@ -356,21 +351,21 @@ void simcall_HANDLER_vm_shutdown(smx_simcall_t simcall, sg_host_t ind_vm)
 
 
 /**
- * \brief Function to destroy a SIMIX VM host.
+ * @brief Function to destroy a SIMIX VM host.
  *
- * \param host the vm host to destroy (a sg_host_t)
+ * @param vm the vm host to destroy (a sg_host_t)
  */
-void SIMIX_vm_destroy(sg_host_t ind_vm)
+void SIMIX_vm_destroy(sg_host_t vm)
 {
   /* this code basically performs a similar thing like SIMIX_host_destroy() */
 
-  const char *hostname = sg_host_get_name(ind_vm);
+  const char *hostname = sg_host_get_name(vm);
 
   XBT_DEBUG("destroy %s", hostname);
 
   /* this will call the registered callback function, i.e., SIMIX_host_destroy().  */
-  sg_host_simix_destroy(ind_vm);
+  sg_host_simix_destroy(vm);
 
   /* jump to vm_ws_destroy(). The surf level resource will be freed. */
-  surf_vm_destroy(ind_vm);
+  surf_vm_destroy(vm);
 }