Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Python: Add Comm.wait_any
[simgrid.git] / src / surf / surf_interface.cpp
index 8a8d2ee..8beb759 100644 (file)
@@ -1,4 +1,4 @@
-/* Copyright (c) 2004-2017. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2004-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. */
@@ -6,15 +6,20 @@
 #include "surf_interface.hpp"
 #include "mc/mc.h"
 #include "simgrid/s4u/Engine.hpp"
-#include "simgrid/sg_config.h"
-#include "src/instr/instr_private.hpp" // TRACE_is_enabled(). FIXME: remove by subscribing tracing to the surf signals
-#include "src/kernel/routing/NetPoint.hpp"
+#include "simgrid/sg_config.hpp"
+#include "src/internal_config.h"
+#include "src/simgrid/version.h"
 #include "src/surf/HostImpl.hpp"
+#include "src/surf/xml/platf.hpp"
+#include "surf/surf.hpp"
+#include "xbt/module.h"
 
 #include <fstream>
-#include <set>
 #include <string>
-#include <vector>
+
+#ifdef _WIN32
+#include <windows.h>
+#endif
 
 XBT_LOG_NEW_CATEGORY(surf, "All SURF categories");
 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_kernel, surf, "Logging specific to SURF (kernel)");
@@ -23,30 +28,29 @@ XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_kernel, surf, "Logging specific to SURF (ke
  * Utils *
  *********/
 
-std::vector<surf_model_t> * all_existing_models = nullptr; /* to destroy models correctly */
+std::vector<simgrid::kernel::resource::Model*> all_existing_models; /* to destroy models correctly */
 
-simgrid::trace_mgr::future_evt_set *future_evt_set = nullptr;
+simgrid::kernel::profile::FutureEvtSet future_evt_set;
 std::vector<std::string> surf_path;
-std::vector<simgrid::s4u::Host*> host_that_restart;
 /**  set of hosts for which one want to be notified if they ever restart. */
 std::set<std::string> watched_hosts;
-extern std::map<std::string, simgrid::surf::StorageType*> storage_types;
+extern std::map<std::string, simgrid::kernel::resource::StorageType*> storage_types;
 
-namespace simgrid {
-namespace surf {
+s_surf_model_description_t* surf_plugin_description = nullptr;
+XBT_PUBLIC void simgrid_add_plugin_description(const char* name, const char* description, void_f_void_t init_fun)
+{
+  static int plugin_amount = 0;
 
-simgrid::xbt::signal<void()> surfExitCallbacks;
-}
-}
+  /* no need to check for plugin name conflict: the compiler already ensures that the generated
+   * simgrid_##id##_plugin_register() is unique */
 
-#include <simgrid/plugins/energy.h> // FIXME: this plug-in should not be linked to the core
-#include <simgrid/plugins/load.h>   // FIXME: this plug-in should not be linked to the core
+  plugin_amount++;
+  surf_plugin_description = static_cast<s_surf_model_description_t*>(
+      xbt_realloc(surf_plugin_description, sizeof(s_surf_model_description_t) * (plugin_amount + 2)));
 
-s_surf_model_description_t surf_plugin_description[] = {
-    {"Energy", "Cpu energy consumption.", &sg_host_energy_plugin_init},
-    {"Load", "Cpu load.", &sg_host_load_plugin_init},
-    {nullptr, nullptr, nullptr} /* this array must be nullptr terminated */
-};
+  surf_plugin_description[plugin_amount - 1] = {name, description, init_fun};
+  surf_plugin_description[plugin_amount]     = {nullptr, nullptr, nullptr}; // this array must be null terminated
+}
 
 /* Don't forget to update the option description in smx_config when you change this */
 s_surf_model_description_t surf_network_model_description[] = {
@@ -122,23 +126,35 @@ double surf_get_clock()
   return NOW;
 }
 
+/* returns whether #file_path is a absolute file path. Surprising, isn't it ? */
+static bool is_absolute_file_path(const std::string& file_path)
+{
 #ifdef _WIN32
-# define FILE_DELIM "\\"
+  WIN32_FIND_DATA wfd = {0};
+  HANDLE hFile        = FindFirstFile(file_path.c_str(), &wfd);
+
+  if (INVALID_HANDLE_VALUE == hFile)
+    return false;
+
+  FindClose(hFile);
+  return true;
 #else
-# define FILE_DELIM "/"         /* FIXME: move to better location */
+  return (file_path.c_str()[0] == '/');
 #endif
+}
 
-std::ifstream* surf_ifsopen(std::string name)
+std::ifstream* surf_ifsopen(const std::string& name)
 {
-  std::ifstream* fs = new std::ifstream();
   xbt_assert(not name.empty());
-  if (__surf_is_absolute_file_path(name.c_str())) { /* don't mess with absolute file names */
+
+  std::ifstream* fs = new std::ifstream();
+  if (is_absolute_file_path(name)) { /* don't mess with absolute file names */
     fs->open(name.c_str(), std::ifstream::in);
   }
 
   /* search relative files in the path */
   for (auto const& path_elm : surf_path) {
-    std::string buff = path_elm + FILE_DELIM + name;
+    std::string buff = path_elm + "/" + name;
     fs->open(buff.c_str(), std::ifstream::in);
 
     if (not fs->fail()) {
@@ -150,18 +166,16 @@ std::ifstream* surf_ifsopen(std::string name)
   return fs;
 }
 
-FILE *surf_fopen(const char *name, const char *mode)
+FILE* surf_fopen(const std::string& name, const char* mode)
 {
   FILE *file = nullptr;
 
-  xbt_assert(name);
-
-  if (__surf_is_absolute_file_path(name))       /* don't mess with absolute file names */
-    return fopen(name, mode);
+  if (is_absolute_file_path(name)) /* don't mess with absolute file names */
+    return fopen(name.c_str(), mode);
 
   /* search relative files in the path */
   for (auto const& path_elm : surf_path) {
-    std::string buff = path_elm + FILE_DELIM + name;
+    std::string buff = path_elm + "/" + name;
     file             = fopen(buff.c_str(), mode);
 
     if (file)
@@ -170,26 +184,6 @@ FILE *surf_fopen(const char *name, const char *mode)
   return nullptr;
 }
 
-/* The __surf_is_absolute_file_path() returns 1 if
- * file_path is a absolute file path, in the other
- * case the function returns 0.
- */
-int __surf_is_absolute_file_path(const char *file_path)
-{
-#ifdef _WIN32
-  WIN32_FIND_DATA wfd = { 0 };
-  HANDLE hFile = FindFirstFile(file_path, &wfd);
-
-  if (INVALID_HANDLE_VALUE == hFile)
-    return 0;
-
-  FindClose(hFile);
-  return 1;
-#else
-  return (file_path[0] == '/');
-#endif
-}
-
 /** Displays the long description of all registered models, and quit */
 void model_help(const char *category, s_surf_model_description_t * table)
 {
@@ -198,7 +192,7 @@ void model_help(const char *category, s_surf_model_description_t * table)
     printf("  %s: %s\n", table[i].name, table[i].description);
 }
 
-int find_model_description(s_surf_model_description_t* table, std::string name)
+int find_model_description(s_surf_model_description_t* table, const std::string& name)
 {
   for (int i = 0; table[i].name; i++)
     if (name == table[i].name)
@@ -225,7 +219,7 @@ void sg_version_check(int lib_version_major, int lib_version_minor, int lib_vers
     abort();
   }
   if (lib_version_patch != SIMGRID_VERSION_PATCH) {
-    if (SIMGRID_VERSION_PATCH >= 90 || lib_version_patch >= 90) {
+    if (SIMGRID_VERSION_PATCH > 89 || lib_version_patch > 89) {
       fprintf(
           stderr,
           "FATAL ERROR: Your program was compiled with SimGrid version %d.%d.%d, "
@@ -300,10 +294,6 @@ void surf_init(int *argc, char **argv)
   USER_HOST_LEVEL = simgrid::s4u::Host::extension_create(nullptr);
 
   xbt_init(argc, argv);
-  if (not all_existing_models)
-    all_existing_models = new std::vector<simgrid::surf::Model*>();
-  if (not future_evt_set)
-    future_evt_set = new simgrid::trace_mgr::future_evt_set();
 
   sg_config_init(argc, argv);
 
@@ -313,500 +303,21 @@ void surf_init(int *argc, char **argv)
 
 void surf_exit()
 {
-  TRACE_end();                  /* Just in case it was not called by the upper layer (or there is no upper layer) */
-
-  sg_host_exit();
-  sg_link_exit();
+  simgrid::s4u::Engine::shutdown();
   for (auto const& e : storage_types) {
-    simgrid::surf::StorageType* stype = e.second;
+    simgrid::kernel::resource::StorageType* stype = e.second;
     delete stype->properties;
     delete stype->model_properties;
     delete stype;
   }
-  for (auto const& s : *simgrid::surf::StorageImpl::storagesMap())
-    delete s.second;
-  delete simgrid::surf::StorageImpl::storagesMap();
 
-  for (auto const& model : *all_existing_models)
+  for (auto const& model : all_existing_models)
     delete model;
-  delete all_existing_models;
 
-  simgrid::surf::surfExitCallbacks();
-
-  if (future_evt_set) {
-    delete future_evt_set;
-    future_evt_set = nullptr;
-  }
+  xbt_free(surf_plugin_description);
 
   tmgr_finalize();
   sg_platf_exit();
-  simgrid::s4u::Engine::shutdown();
 
   NOW = 0;                      /* Just in case the user plans to restart the simulation afterward */
 }
-
-/*********
- * Model *
- *********/
-
-namespace simgrid {
-namespace surf {
-
-Model::Model()
-  : maxminSystem_(nullptr)
-{
-  readyActionSet_ = new ActionList();
-  runningActionSet_ = new ActionList();
-  failedActionSet_ = new ActionList();
-  doneActionSet_ = new ActionList();
-
-  modifiedSet_ = nullptr;
-  actionHeap_ = nullptr;
-  updateMechanism_ = UM_UNDEFINED;
-  selectiveUpdate_ = 0;
-}
-
-Model::~Model(){
-  delete readyActionSet_;
-  delete runningActionSet_;
-  delete failedActionSet_;
-  delete doneActionSet_;
-}
-
-double Model::nextOccuringEvent(double now)
-{
-  //FIXME: set the good function once and for all
-  if (updateMechanism_ == UM_LAZY)
-    return nextOccuringEventLazy(now);
-  else if (updateMechanism_ == UM_FULL)
-    return nextOccuringEventFull(now);
-  else
-    xbt_die("Invalid cpu update mechanism!");
-}
-
-double Model::nextOccuringEventLazy(double now)
-{
-  XBT_DEBUG("Before share resources, the size of modified actions set is %zu", modifiedSet_->size());
-  lmm_solve(maxminSystem_);
-  XBT_DEBUG("After share resources, The size of modified actions set is %zu", modifiedSet_->size());
-
-  while (not modifiedSet_->empty()) {
-    Action *action = &(modifiedSet_->front());
-    modifiedSet_->pop_front();
-    bool max_dur_flag = false;
-
-    if (action->getStateSet() != runningActionSet_)
-      continue;
-
-    /* bogus priority, skip it */
-    if (action->getPriority() <= 0 || action->getHat()==LATENCY)
-      continue;
-
-    action->updateRemainingLazy(now);
-
-    double min = -1;
-    double share = lmm_variable_getvalue(action->getVariable());
-
-    if (share > 0) {
-      double time_to_completion;
-      if (action->getRemains() > 0) {
-        time_to_completion = action->getRemainsNoUpdate() / share;
-      } else {
-        time_to_completion = 0.0;
-      }
-      min = now + time_to_completion; // when the task will complete if nothing changes
-    }
-
-    if ((action->getMaxDuration() > NO_MAX_DURATION) &&
-        (min <= -1 || action->getStartTime() + action->getMaxDuration() < min)) {
-      // when the task will complete anyway because of the deadline if any
-      min          = action->getStartTime() + action->getMaxDuration();
-      max_dur_flag = true;
-    }
-
-    XBT_DEBUG("Action(%p) corresponds to variable %d", action, action->getVariable()->id_int);
-
-    XBT_DEBUG("Action(%p) Start %f. May finish at %f (got a share of %f). Max_duration %f", action,
-        action->getStartTime(), min, share,
-        action->getMaxDuration());
-
-    if (min > -1) {
-      action->heapUpdate(actionHeap_, min, max_dur_flag ? MAX_DURATION : NORMAL);
-      XBT_DEBUG("Insert at heap action(%p) min %f now %f", action, min, now);
-    } else
-      DIE_IMPOSSIBLE;
-  }
-
-  //hereafter must have already the min value for this resource model
-  if (xbt_heap_size(actionHeap_) > 0) {
-    double min = xbt_heap_maxkey(actionHeap_) - now;
-    XBT_DEBUG("minimum with the HEAP %f", min);
-    return min;
-  } else {
-    XBT_DEBUG("The HEAP is empty, thus returning -1");
-    return -1;
-  }
-}
-
-double Model::nextOccuringEventFull(double /*now*/) {
-  maxminSystem_->solve_fun(maxminSystem_);
-
-  double min = -1;
-  for (auto it(getRunningActionSet()->begin()), itend(getRunningActionSet()->end()); it != itend ; ++it) {
-    Action *action = &*it;
-    double value = lmm_variable_getvalue(action->getVariable());
-    if (value > 0) {
-      if (action->getRemains() > 0)
-        value = action->getRemainsNoUpdate() / value;
-      else
-        value = 0.0;
-      if (min < 0 || value < min) {
-        min = value;
-        XBT_DEBUG("Updating min (value) with %p: %f", action, min);
-      }
-    }
-    if ((action->getMaxDuration() >= 0) && (min<0 || action->getMaxDuration() < min)) {
-      min = action->getMaxDuration();
-      XBT_DEBUG("Updating min (duration) with %p: %f", action, min);
-    }
-  }
-  XBT_DEBUG("min value : %f", min);
-
-  return min;
-}
-
-void Model::updateActionsState(double now, double delta)
-{
-  if (updateMechanism_ == UM_FULL)
-    updateActionsStateFull(now, delta);
-  else if (updateMechanism_ == UM_LAZY)
-    updateActionsStateLazy(now, delta);
-  else
-    xbt_die("Invalid cpu update mechanism!");
-}
-
-void Model::updateActionsStateLazy(double /*now*/, double /*delta*/)
-{
-  THROW_UNIMPLEMENTED;
-}
-
-void Model::updateActionsStateFull(double /*now*/, double /*delta*/)
-{
-  THROW_UNIMPLEMENTED;
-}
-
-}
-}
-
-/************
- * Resource *
- ************/
-
-namespace simgrid {
-namespace surf {
-
-Resource::Resource(Model* model, const std::string& name, lmm_constraint_t constraint)
-    : name_(name), model_(model), constraint_(constraint)
-{}
-
-Resource::~Resource() = default;
-
-bool Resource::isOn() const {
-  return isOn_;
-}
-bool Resource::isOff() const {
-  return not isOn_;
-}
-
-void Resource::turnOn()
-{
-  isOn_ = true;
-}
-
-void Resource::turnOff()
-{
-  isOn_ = false;
-}
-
-Model* Resource::model() const
-{
-  return model_;
-}
-
-const std::string& Resource::getName() const
-{
-  return name_;
-}
-
-const char* Resource::getCname() const
-{
-  return name_.c_str();
-}
-
-bool Resource::operator==(const Resource &other) const {
-  return name_ == other.name_;
-}
-
-lmm_constraint_t Resource::constraint() const
-{
-  return constraint_;
-}
-
-}
-}
-
-/**********
- * Action *
- **********/
-
-const char *surf_action_state_names[6] = {
-  "SURF_ACTION_READY",
-  "SURF_ACTION_RUNNING",
-  "SURF_ACTION_FAILED",
-  "SURF_ACTION_DONE",
-  "SURF_ACTION_TO_FREE",
-  "SURF_ACTION_NOT_IN_THE_SYSTEM"
-};
-
-/* added to manage the communication action's heap */
-void surf_action_lmm_update_index_heap(void *action, int i) {
-  static_cast<simgrid::surf::Action*>(action)->updateIndexHeap(i);
-}
-
-namespace simgrid {
-namespace surf {
-
-Action::Action(simgrid::surf::Model* model, double cost, bool failed) : Action(model, cost, failed, nullptr)
-{
-}
-
-Action::Action(simgrid::surf::Model* model, double cost, bool failed, lmm_variable_t var)
-    : remains_(cost), start_(surf_get_clock()), cost_(cost), model_(model), variable_(var)
-{
-  if (failed)
-    stateSet_ = getModel()->getFailedActionSet();
-  else
-    stateSet_ = getModel()->getRunningActionSet();
-
-  stateSet_->push_back(*this);
-}
-
-Action::~Action() {
-  xbt_free(category_);
-}
-
-void Action::finish(Action::State state)
-{
-  finishTime_ = surf_get_clock();
-  setState(state);
-}
-
-Action::State Action::getState()
-{
-  if (stateSet_ == model_->getReadyActionSet())
-    return Action::State::ready;
-  if (stateSet_ == model_->getRunningActionSet())
-    return Action::State::running;
-  if (stateSet_ == model_->getFailedActionSet())
-    return Action::State::failed;
-  if (stateSet_ == model_->getDoneActionSet())
-    return Action::State::done;
-  return Action::State::not_in_the_system;
-}
-
-void Action::setState(Action::State state)
-{
-  stateSet_->erase(stateSet_->iterator_to(*this));
-  switch (state) {
-  case Action::State::ready:
-    stateSet_ = model_->getReadyActionSet();
-    break;
-  case Action::State::running:
-    stateSet_ = model_->getRunningActionSet();
-    break;
-  case Action::State::failed:
-    stateSet_ = model_->getFailedActionSet();
-    break;
-  case Action::State::done:
-    stateSet_ = model_->getDoneActionSet();
-    break;
-  default:
-    stateSet_ = nullptr;
-    break;
-  }
-  if (stateSet_)
-    stateSet_->push_back(*this);
-}
-
-double Action::getBound()
-{
-  return (variable_) ? lmm_variable_getbound(variable_) : 0;
-}
-
-void Action::setBound(double bound)
-{
-  XBT_IN("(%p,%g)", this, bound);
-  if (variable_)
-    lmm_update_variable_bound(getModel()->getMaxminSystem(), variable_, bound);
-
-  if (getModel()->getUpdateMechanism() == UM_LAZY && getLastUpdate() != surf_get_clock())
-    heapRemove(getModel()->getActionHeap());
-  XBT_OUT();
-}
-
-double Action::getStartTime()
-{
-  return start_;
-}
-
-double Action::getFinishTime()
-{
-  return finishTime_;
-}
-
-void Action::setData(void* data)
-{
-  data_ = data;
-}
-
-void Action::setCategory(const char *category)
-{
-  category_ = xbt_strdup(category);
-}
-
-void Action::ref(){
-  refcount_++;
-}
-
-void Action::setMaxDuration(double duration)
-{
-  maxDuration_ = duration;
-  if (getModel()->getUpdateMechanism() == UM_LAZY)      // remove action from the heap
-    heapRemove(getModel()->getActionHeap());
-}
-
-void Action::setSharingWeight(double weight)
-{
-  XBT_IN("(%p,%g)", this, weight);
-  sharingWeight_ = weight;
-  lmm_update_variable_weight(getModel()->getMaxminSystem(), getVariable(), weight);
-
-  if (getModel()->getUpdateMechanism() == UM_LAZY)
-    heapRemove(getModel()->getActionHeap());
-  XBT_OUT();
-}
-
-void Action::cancel(){
-  setState(Action::State::failed);
-  if (getModel()->getUpdateMechanism() == UM_LAZY) {
-    if (action_lmm_hook.is_linked())
-      getModel()->getModifiedSet()->erase(getModel()->getModifiedSet()->iterator_to(*this));
-    heapRemove(getModel()->getActionHeap());
-  }
-}
-
-int Action::unref(){
-  refcount_--;
-  if (not refcount_) {
-    if (action_hook.is_linked())
-      stateSet_->erase(stateSet_->iterator_to(*this));
-    if (getVariable())
-      lmm_variable_free(getModel()->getMaxminSystem(), getVariable());
-    if (getModel()->getUpdateMechanism() == UM_LAZY) {
-      /* remove from heap */
-      heapRemove(getModel()->getActionHeap());
-      if (action_lmm_hook.is_linked())
-        getModel()->getModifiedSet()->erase(getModel()->getModifiedSet()->iterator_to(*this));
-    }
-    delete this;
-    return 1;
-  }
-  return 0;
-}
-
-void Action::suspend()
-{
-  XBT_IN("(%p)", this);
-  if (suspended_ != 2) {
-    lmm_update_variable_weight(getModel()->getMaxminSystem(), getVariable(), 0.0);
-    if (getModel()->getUpdateMechanism() == UM_LAZY){
-      heapRemove(getModel()->getActionHeap());
-      if (getModel()->getUpdateMechanism() == UM_LAZY && stateSet_ == getModel()->getRunningActionSet() &&
-          sharingWeight_ > 0) {
-        //If we have a lazy model, we need to update the remaining value accordingly
-        updateRemainingLazy(surf_get_clock());
-      }
-    }
-    suspended_ = 1;
-  }
-  XBT_OUT();
-}
-
-void Action::resume()
-{
-  XBT_IN("(%p)", this);
-  if (suspended_ != 2) {
-    lmm_update_variable_weight(getModel()->getMaxminSystem(), getVariable(), getPriority());
-    suspended_ = 0;
-    if (getModel()->getUpdateMechanism() == UM_LAZY)
-      heapRemove(getModel()->getActionHeap());
-  }
-  XBT_OUT();
-}
-
-bool Action::isSuspended()
-{
-  return suspended_ == 1;
-}
-/* insert action on heap using a given key and a hat (heap_action_type)
- * a hat can be of three types for communications:
- *
- * NORMAL = this is a normal heap entry stating the date to finish transmitting
- * LATENCY = this is a heap entry to warn us when the latency is payed
- * MAX_DURATION =this is a heap entry to warn us when the max_duration limit is reached
- */
-void Action::heapInsert(xbt_heap_t heap, double key, enum heap_action_type hat)
-{
-  hat_ = hat;
-  xbt_heap_push(heap, this, key);
-}
-
-void Action::heapRemove(xbt_heap_t heap)
-{
-  hat_ = NOTSET;
-  if (indexHeap_ >= 0) {
-    xbt_heap_remove(heap, indexHeap_);
-  }
-}
-
-void Action::heapUpdate(xbt_heap_t heap, double key, enum heap_action_type hat)
-{
-  hat_ = hat;
-  if (indexHeap_ >= 0) {
-    xbt_heap_update(heap, indexHeap_, key);
-  }else{
-    xbt_heap_push(heap, this, key);
-  }
-}
-
-void Action::updateIndexHeap(int i) {
-  indexHeap_ = i;
-}
-
-double Action::getRemains()
-{
-  XBT_IN("(%p)", this);
-  /* update remains before return it */
-  if (getModel()->getUpdateMechanism() == UM_LAZY)      /* update remains before return it */
-    updateRemainingLazy(surf_get_clock());
-  XBT_OUT();
-  return remains_;
-}
-
-double Action::getRemainsNoUpdate()
-{
-  return remains_;
-}
-
-}
-}