src/surf/surf_c_bindings.cpp

   1 /* Copyright (c) 2013-2021. The SimGrid Team. All rights reserved.          */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4  * under the terms of the license (GNU LGPL) which comes with this package. */
   5
   6 #include "simgrid/s4u/Engine.hpp"
   7 #include "src/include/surf/surf.hpp"
   8 #include "src/instr/instr_private.hpp"
   9 #include "src/kernel/EngineImpl.hpp"
  10 #include "src/kernel/resource/DiskImpl.hpp"
  11 #include "src/kernel/resource/profile/FutureEvtSet.hpp"
  12 #include "src/plugins/vm/VirtualMachineImpl.hpp"
  13
  14 #include <algorithm>
  15
  16 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(surf_kernel);
  17
  18 /*********
  19  * TOOLS *
  20  *********/
  21
  22 extern double NOW;
  23
  24 void surf_presolve()
  25 {
  26   XBT_DEBUG("Consume all trace events occurring before the starting time.");
  27   double next_event_date;
  28   while ((next_event_date = simgrid::kernel::profile::future_evt_set.next_date()) != -1.0) {
  29     if (next_event_date > NOW)
  30       break;
  31
  32     simgrid::kernel::profile::Event* event;
  33     double value                                  = -1.0;
  34     simgrid::kernel::resource::Resource* resource = nullptr;
  35     while ((event = simgrid::kernel::profile::future_evt_set.pop_leq(next_event_date, &value, &resource))) {
  36       if (value >= 0)
  37         resource->apply_event(event, value);
  38     }
  39   }
  40
  41   XBT_DEBUG("Set every models in the right state by updating them to 0.");
  42   for (auto const& model : simgrid::kernel::EngineImpl::get_instance()->get_all_models())
  43     model->update_actions_state(NOW, 0.0);
  44 }
  45
  46 /**
  47  * @brief Auxiliary function to get next event from a list of models
  48  *
  49  * @param models list of models to explore (cpu, host, vm) (IN)
  50  * @param time_delta delta for the next event (IN/OUT)
  51  */
  52 static void surf_update_next_event(std::vector<simgrid::kernel::resource::Model*> const& models, double& time_delta)
  53 {
  54   for (auto* model : models) {
  55     if (not model->next_occurring_event_is_idempotent()) {
  56       continue;
  57     }
  58     double next_event = model->next_occurring_event(NOW);
  59     if ((time_delta < 0.0 || next_event < time_delta) && next_event >= 0.0) {
  60       time_delta = next_event;
  61     }
  62   }
  63 }
  64
  65 double surf_solve(double max_date)
  66 {
  67   double time_delta                             = -1.0; /* duration */
  68   double value                                  = -1.0;
  69   simgrid::kernel::resource::Resource* resource = nullptr;
  70   simgrid::kernel::profile::Event* event        = nullptr;
  71
  72   if (max_date != -1.0) {
  73     xbt_assert(max_date >= NOW, "You asked to simulate up to %f, but that's in the past already", max_date);
  74
  75     time_delta = max_date - NOW;
  76   }
  77
  78   /* Physical models MUST be resolved first */
  79   XBT_DEBUG("Looking for next event in physical models");
  80   auto engine = simgrid::kernel::EngineImpl::get_instance();
  81   surf_update_next_event(engine->get_model_list(simgrid::kernel::resource::Model::Type::HOST), time_delta);
  82
  83   // following the order it was done in HostCLM03Model->next_occurring_event
  84   XBT_DEBUG("Looking for next event in CPU models");
  85   surf_update_next_event(engine->get_model_list(simgrid::kernel::resource::Model::Type::CPU_PM), time_delta);
  86
  87   XBT_DEBUG("Looking for next event in network models");
  88   surf_update_next_event(engine->get_model_list(simgrid::kernel::resource::Model::Type::NETWORK), time_delta);
  89   XBT_DEBUG("Looking for next event in disk models");
  90   surf_update_next_event(engine->get_model_list(simgrid::kernel::resource::Model::Type::DISK), time_delta);
  91
  92   XBT_DEBUG("Looking for next event in virtual models");
  93   surf_update_next_event(engine->get_model_list(simgrid::kernel::resource::Model::Type::VM), time_delta);
  94   surf_update_next_event(engine->get_model_list(simgrid::kernel::resource::Model::Type::CPU_VM), time_delta);
  95
  96   XBT_DEBUG("Min for resources (remember that NS3 don't update that value): %f", time_delta);
  97
  98   XBT_DEBUG("Looking for next trace event");
  99
 100   while (true) { // Handle next occurring events until none remains
 101     double next_event_date = simgrid::kernel::profile::future_evt_set.next_date();
 102     XBT_DEBUG("Next TRACE event: %f", next_event_date);
 103
 104     for (auto* model : engine->get_model_list(simgrid::kernel::resource::Model::Type::NETWORK)) {
 105       /* Skip all idempotent models, they were already treated above
 106        * NS3 is the one to handled here */
 107       if (model->next_occurring_event_is_idempotent())
 108         continue;
 109
 110       if (next_event_date != -1.0) {
 111         time_delta = std::min(next_event_date - NOW, time_delta);
 112       } else {
 113         time_delta = std::max(next_event_date - NOW, time_delta); // Get the positive component
 114       }
 115
 116       XBT_DEBUG("Run the NS3 network at most %fs", time_delta);
 117       // run until min or next flow
 118       double model_next_action_end = model->next_occurring_event(time_delta);
 119
 120       XBT_DEBUG("Min for network : %f", model_next_action_end);
 121       if (model_next_action_end >= 0.0)
 122         time_delta = model_next_action_end;
 123     }
 124
 125     if (next_event_date < 0.0 || (next_event_date > NOW + time_delta)) {
 126       // next event may have already occurred or will after the next resource change, then bail out
 127       XBT_DEBUG("no next usable TRACE event. Stop searching for it");
 128       break;
 129     }
 130
 131     XBT_DEBUG("Updating models (min = %g, NOW = %g, next_event_date = %g)", time_delta, NOW, next_event_date);
 132
 133     while ((event = simgrid::kernel::profile::future_evt_set.pop_leq(next_event_date, &value, &resource))) {
 134       if (resource->is_used() || (watched_hosts().find(resource->get_cname()) != watched_hosts().end())) {
 135         time_delta = next_event_date - NOW;
 136         XBT_DEBUG("This event invalidates the next_occurring_event() computation of models. Next event set to %f",
 137                   time_delta);
 138       }
 139       // FIXME: I'm too lame to update NOW live, so I change it and restore it so that the real update with surf_min
 140       // will work
 141       double round_start = NOW;
 142       NOW                = next_event_date;
 143       /* update state of the corresponding resource to the new value. Does not touch lmm.
 144          It will be modified if needed when updating actions */
 145       XBT_DEBUG("Calling update_resource_state for resource %s", resource->get_cname());
 146       resource->apply_event(event, value);
 147       NOW = round_start;
 148     }
 149   }
 150
 151   /* FIXME: Moved this test to here to avoid stopping simulation if there are actions running on cpus and all cpus are
 152    * with availability = 0. This may cause an infinite loop if one cpu has a trace with periodicity = 0 and the other a
 153    * trace with periodicity > 0.
 154    * The options are: all traces with same periodicity(0 or >0) or we need to change the way how the events are managed
 155    */
 156   if (time_delta < 0) {
 157     XBT_DEBUG("No next event at all. Bail out now.");
 158     return -1.0;
 159   }
 160
 161   XBT_DEBUG("Duration set to %f", time_delta);
 162
 163   // Bump the time: jump into the future
 164   NOW = NOW + time_delta;
 165
 166   // Inform the models of the date change
 167   for (auto const& model : simgrid::kernel::EngineImpl::get_instance()->get_all_models())
 168     model->update_actions_state(NOW, time_delta);
 169
 170   simgrid::s4u::Engine::on_time_advance(time_delta);
 171
 172   return time_delta;
 173 }