src/kernel/resource/profile/Profile_test.cpp

   1 /* Copyright (c) 2017-2020. 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 "catch.hpp"
   7
   8 #include "simgrid/kernel/resource/Resource.hpp"
   9 #include "src/kernel/resource/profile/DatedValue.hpp"
  10 #include "src/kernel/resource/profile/Event.hpp"
  11 #include "src/kernel/resource/profile/Profile.hpp"
  12 #include "src/kernel/resource/profile/StochasticDatedValue.hpp"
  13 #include "src/surf/surf_interface.hpp"
  14
  15 #include "xbt/log.h"
  16 #include "xbt/misc.h"
  17 #include "xbt/random.hpp"
  18
  19 #include <cmath>
  20
  21 XBT_LOG_NEW_DEFAULT_CATEGORY(unit, "Unit tests of the Trace Manager");
  22
  23 double thedate;
  24 class MockedResource : public simgrid::kernel::resource::Resource {
  25 public:
  26   explicit MockedResource() : simgrid::kernel::resource::Resource(nullptr, "fake", nullptr) {}
  27   void apply_event(simgrid::kernel::profile::Event* event, double value) override
  28   {
  29     XBT_VERB("t=%.1f: Change value to %lg (idx: %u)", thedate, value, event->idx);
  30     tmgr_trace_event_unref(&event);
  31   }
  32   bool is_used() const override { return true; }
  33 };
  34
  35 static std::vector<simgrid::kernel::profile::DatedValue> trace2vector(const char* str)
  36 {
  37   std::vector<simgrid::kernel::profile::DatedValue> res;
  38   simgrid::kernel::profile::Profile* trace = simgrid::kernel::profile::Profile::from_string("TheName", str, 0);
  39   XBT_VERB("---------------------------------------------------------");
  40   XBT_VERB("data>>\n%s<<data\n", str);
  41   for (auto const& evt : trace->event_list)
  42     XBT_VERB("event: d:%lg v:%lg", evt.date_, evt.value_);
  43
  44   MockedResource daResource;
  45   simgrid::kernel::profile::FutureEvtSet fes;
  46   simgrid::kernel::profile::Event* insertedIt = trace->schedule(&fes, &daResource);
  47
  48   while (fes.next_date() <= 20.0 && fes.next_date() >= 0) {
  49     thedate = fes.next_date();
  50     double value;
  51     simgrid::kernel::resource::Resource* resource;
  52     simgrid::kernel::profile::Event* it = fes.pop_leq(thedate, &value, &resource);
  53     if (it == nullptr)
  54       continue;
  55
  56     REQUIRE(it == insertedIt); // Check that we find what we've put
  57     if (value >= 0) {
  58       res.emplace_back(thedate, value);
  59     } else {
  60       XBT_DEBUG("%.1f: ignore an event (idx: %u)\n", thedate, it->idx);
  61     }
  62     resource->apply_event(it, value);
  63   }
  64   tmgr_finalize();
  65   return res;
  66 }
  67
  68 static std::vector<simgrid::kernel::profile::StochasticDatedValue> trace2selist(const char* str)
  69 {
  70   simgrid::kernel::profile::Profile* trace = simgrid::kernel::profile::Profile::from_string("TheName", str, 0);
  71   std::vector<simgrid::kernel::profile::StochasticDatedValue> stocevlist = trace->stochastic_event_list;
  72   tmgr_finalize();
  73   return stocevlist;
  74 }
  75
  76 TEST_CASE("kernel::profile: Resource profiles, defining the external load", "kernel::profile")
  77 {
  78   SECTION("No event, no loop")
  79   {
  80     std::vector<simgrid::kernel::profile::DatedValue> got = trace2vector("");
  81     std::vector<simgrid::kernel::profile::DatedValue> want;
  82     REQUIRE(want == got);
  83   }
  84
  85   SECTION("One event no loop")
  86   {
  87     std::vector<simgrid::kernel::profile::DatedValue> got = trace2vector("9.0 3.0\n");
  88
  89     std::vector<simgrid::kernel::profile::DatedValue> want;
  90     want.emplace_back(9, 3);
  91     REQUIRE(want == got);
  92   }
  93
  94   SECTION("Two events, no loop")
  95   {
  96     std::vector<simgrid::kernel::profile::DatedValue> got = trace2vector("3.0 1.0\n"
  97                                                                          "9.0 3.0\n");
  98
  99     std::vector<simgrid::kernel::profile::DatedValue> want;
 100     want.emplace_back(3, 1);
 101     want.emplace_back(9, 3);
 102
 103     REQUIRE(want == got);
 104   }
 105
 106   SECTION("Three events, no loop")
 107   {
 108     std::vector<simgrid::kernel::profile::DatedValue> got = trace2vector("3.0 1.0\n"
 109                                                                          "5.0 2.0\n"
 110                                                                          "9.0 3.0\n");
 111
 112     std::vector<simgrid::kernel::profile::DatedValue> want;
 113     want.emplace_back(3, 1);
 114     want.emplace_back(5, 2);
 115     want.emplace_back(9, 3);
 116
 117     REQUIRE(want == got);
 118   }
 119
 120   SECTION("Two events, looping")
 121   {
 122     std::vector<simgrid::kernel::profile::DatedValue> got = trace2vector("1.0 1.0\n"
 123                                                                          "3.0 3.0\n"
 124                                                                          "LOOPAFTER 2\n");
 125
 126     std::vector<simgrid::kernel::profile::DatedValue> want;
 127     want.emplace_back(1, 1);
 128     want.emplace_back(3, 3);
 129     want.emplace_back(6, 1);
 130     want.emplace_back(8, 3);
 131     want.emplace_back(11, 1);
 132     want.emplace_back(13, 3);
 133     want.emplace_back(16, 1);
 134     want.emplace_back(18, 3);
 135
 136     REQUIRE(want == got);
 137   }
 138
 139   SECTION("Two events, looping, start at 0")
 140   {
 141     std::vector<simgrid::kernel::profile::DatedValue> got = trace2vector("0.0 1\n"
 142                                                                          "5.0 2\n"
 143                                                                          "LOOPAFTER 5\n");
 144
 145     std::vector<simgrid::kernel::profile::DatedValue> want;
 146     want.emplace_back(0, 1);
 147     want.emplace_back(5, 2);
 148     want.emplace_back(10, 1);
 149     want.emplace_back(15, 2);
 150     want.emplace_back(20, 1);
 151
 152     REQUIRE(want == got);
 153   }
 154
 155   SECTION("One stochastic event (parsing)")
 156   {
 157     std::vector<simgrid::kernel::profile::StochasticDatedValue> got = trace2selist("STOCHASTIC\n"
 158                                                                                    "DET 0 UNIF 10 20");
 159
 160     std::vector<simgrid::kernel::profile::StochasticDatedValue> want;
 161     want.push_back(simgrid::kernel::profile::StochasticDatedValue(0, -1)); // The initial fake event
 162     want.push_back(simgrid::kernel::profile::StochasticDatedValue(simgrid::kernel::profile::Dist_Det, {0},
 163                                                                   simgrid::kernel::profile::Dist_Unif, {10, 20}));
 164
 165     REQUIRE(want == got);
 166   }
 167
 168   SECTION("Several stochastic events (all possible parsing forms)")
 169   {
 170     std::vector<simgrid::kernel::profile::StochasticDatedValue> got = trace2selist("STOCHASTIC\n"
 171                                                                                    "DET 0 DET 4\n"
 172                                                                                    "NORMAL 25 10 DET 3\n"
 173                                                                                    "UNIF 10 20 NORMAL 25 10\n"
 174                                                                                    "DET 5 UNIF 5 25");
 175
 176     std::vector<simgrid::kernel::profile::StochasticDatedValue> want;
 177     want.push_back(simgrid::kernel::profile::StochasticDatedValue(0, -1));
 178     want.push_back(simgrid::kernel::profile::StochasticDatedValue(simgrid::kernel::profile::Dist_Det, {0},
 179                                                                   simgrid::kernel::profile::Dist_Det, {4}));
 180     want.push_back(simgrid::kernel::profile::StochasticDatedValue(simgrid::kernel::profile::Dist_Norm, {25, 10},
 181                                                                   simgrid::kernel::profile::Dist_Det, {3}));
 182     want.push_back(simgrid::kernel::profile::StochasticDatedValue(simgrid::kernel::profile::Dist_Unif, {10, 20},
 183                                                                   simgrid::kernel::profile::Dist_Norm, {25, 10}));
 184     want.push_back(simgrid::kernel::profile::StochasticDatedValue(simgrid::kernel::profile::Dist_Det, {5},
 185                                                                   simgrid::kernel::profile::Dist_Unif, {5, 25}));
 186
 187     REQUIRE(want == got);
 188   }
 189
 190   SECTION("Two stochastic events (drawing each distribution)")
 191   {
 192     simgrid::xbt::random::set_implem_xbt();
 193     simgrid::xbt::random::set_mersenne_seed(12345);
 194     std::vector<simgrid::kernel::profile::DatedValue> got = trace2vector("STOCHASTIC\n"
 195                                                                          "DET 0 UNIF 10 20\n"
 196                                                                          "EXP 0.05 NORMAL 15 5");
 197
 198     std::vector<simgrid::kernel::profile::DatedValue> want;
 199     // The following values were drawn using the XBT_RNG_xbt method /outside/ the testcase.
 200     want.push_back(simgrid::kernel::profile::DatedValue(0, 19.29616086867082813683));
 201     want.push_back(simgrid::kernel::profile::DatedValue(2.32719992449416279712, 20.16807234800742065772));
 202
 203     REQUIRE(want == got);
 204   }
 205
 206   SECTION("Two stochastic events, with a loop")
 207   {
 208     simgrid::xbt::random::set_implem_xbt();
 209     simgrid::xbt::random::set_mersenne_seed(12345);
 210     std::vector<simgrid::kernel::profile::DatedValue> got = trace2vector("STOCHASTIC LOOP\n"
 211                                                                          "DET 0 UNIF 10 20\n"
 212                                                                          "EXP 0.05 NORMAL 15 5\n"
 213                                                                          "UNIF 1 2 DET 0");
 214
 215     // In this case, the main use of the last stochastic event is to set when the first event takes place.
 216
 217     std::vector<simgrid::kernel::profile::DatedValue> want;
 218     want.push_back(simgrid::kernel::profile::DatedValue(0, 19.29616086867082813683));
 219     want.push_back(simgrid::kernel::profile::DatedValue(2.32719992449416279712, 20.16807234800742065772));
 220     want.push_back(simgrid::kernel::profile::DatedValue(3.51111873684917075167, 0));
 221     want.push_back(simgrid::kernel::profile::DatedValue(3.51111873684917075167, 10.39759496468994726115));
 222
 223     REQUIRE(want == got);
 224   }
 225 }