src/surf/surf_interface.cpp

   1 /* Copyright (c) 2004-2023. 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 <xbt/module.h>
   8
   9 #include "mc/mc.h"
  10 #include "simgrid/sg_config.hpp"
  11 #include "src/kernel/resource/profile/FutureEvtSet.hpp"
  12 #include "src/kernel/resource/profile/Profile.hpp"
  13 #include "src/surf/HostImpl.hpp"
  14 #include "src/surf/surf_interface.hpp"
  15
  16 #include <fstream>
  17 #include <string>
  18
  19 /*********
  20  * Utils *
  21  *********/
  22
  23 std::vector<std::string> surf_path;
  24
  25 const std::vector<surf_model_description_t> surf_network_model_description = {
  26     {"LV08",
  27      "Realistic network analytic model (slow-start modeled by multiplying latency by 13.01, bandwidth by .97; "
  28      "bottleneck sharing uses a payload of S=20537 for evaluating RTT). ",
  29      &surf_network_model_init_LegrandVelho},
  30     {"Constant",
  31      "Simplistic network model where all communication take a constant time (one second). This model "
  32      "provides the lowest realism, but is (marginally) faster.",
  33      &surf_network_model_init_Constant},
  34     {"SMPI",
  35      "Realistic network model specifically tailored for HPC settings (accurate modeling of slow start with "
  36      "correction factors on three intervals: < 1KiB, < 64 KiB, >= 64 KiB)",
  37      &surf_network_model_init_SMPI},
  38     {"IB", "Realistic network model specifically tailored for HPC settings, with Infiniband contention model",
  39      &surf_network_model_init_IB},
  40     {"CM02",
  41      "Legacy network analytic model (Very similar to LV08, but without corrective factors. The timings of "
  42      "small messages are thus poorly modeled).",
  43      &surf_network_model_init_CM02},
  44     {"ns-3", "Network pseudo-model using the ns-3 tcp model instead of an analytic model",
  45      &surf_network_model_init_NS3},
  46 };
  47
  48 #if !HAVE_SMPI
  49 void surf_network_model_init_IB()
  50 {
  51   xbt_die("Please activate SMPI support in cmake to use the IB network model.");
  52 }
  53 #endif
  54 #if !SIMGRID_HAVE_NS3
  55 void surf_network_model_init_NS3()
  56 {
  57   xbt_die("Please activate ns-3 support in cmake and install the dependencies to use the NS3 network model.");
  58 }
  59 #endif
  60
  61 const std::vector<surf_model_description_t> surf_cpu_model_description = {
  62     {"Cas01", "Simplistic CPU model (time=size/speed).", &surf_cpu_model_init_Cas01},
  63 };
  64
  65 const std::vector<surf_model_description_t> surf_disk_model_description = {
  66     {"S19", "Simplistic disk model.", &surf_disk_model_init_S19},
  67 };
  68
  69 const std::vector<surf_model_description_t> surf_host_model_description = {
  70     {"default", "Default host model. Currently, CPU:Cas01, network:LV08 (with cross traffic enabled), and disk:S19",
  71      &surf_host_model_init_current_default},
  72     {"compound", "Host model that is automatically chosen if you change the CPU, network, and disk models",
  73      &surf_host_model_init_compound},
  74     {"ptask_L07", "Host model somehow similar to Cas01+CM02+S19 but allowing parallel tasks",
  75      &surf_host_model_init_ptask_L07},
  76 };
  77
  78 const std::vector<surf_model_description_t> surf_optimization_mode_description = {
  79     {"Lazy", "Lazy action management (partial invalidation in lmm + heap in action remaining).", nullptr},
  80     {"TI",
  81      "Trace integration. Highly optimized mode when using availability traces (only available for the Cas01 CPU "
  82      "model for now).",
  83      nullptr},
  84     {"Full", "Full update of remaining and variables. Slow but may be useful when debugging.", nullptr},
  85 };
  86
  87 /** Displays the long description of all registered models, and quit */
  88 void model_help(const char* category, const std::vector<surf_model_description_t>& table)
  89 {
  90   XBT_HELP("Long description of the %s models accepted by this simulator:", category);
  91   for (auto const& item : table)
  92     XBT_HELP("  %s: %s", item.name, item.description);
  93 }
  94
  95 const surf_model_description_t* find_model_description(const std::vector<surf_model_description_t>& table,
  96                                                        const std::string& name)
  97 {
  98   if (auto pos = std::find_if(table.begin(), table.end(),
  99                               [&name](const surf_model_description_t& item) { return item.name == name; });
 100       pos != table.end())
 101     return &*pos;
 102
 103   std::string sep;
 104   std::string name_list;
 105   for (auto const& item : table) {
 106     name_list += sep + item.name;
 107     sep = ", ";
 108   }
 109   xbt_die("Model '%s' is invalid! Valid models are: %s.", name.c_str(), name_list.c_str());
 110 }