examples/s4u/engine-filtering/s4u-engine-filtering.cpp

   1 /* Copyright (c) 2017-2019. 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.hpp>
   7
   8 /* This example shows how to use simgrid::s4u::Engine::get_filtered_hosts() to retrieve
   9  * all hosts that match a given criteria. This criteria can be specified either with:
  10  *   - an inlined callback
  11  *   - a boolean function, such as filter_speed_more_than_50Mf() below
  12  *   - a functor (= function object), that can either be stateless such as filter::SingleCore below, or that can save
  13  *     state such as filter::FrequencyChanged below
  14  *
  15  * This file provides examples for each of these categories. You should implement your own filters in your code.
  16  */
  17
  18 XBT_LOG_NEW_DEFAULT_CATEGORY(s4u_engine_filtering, "Messages specific for this s4u example");
  19
  20 namespace filter {
  21 /* First example of thing that we can use as a filtering criteria: a simple boolean function */
  22 static bool filter_speed_more_than_50Mf(simgrid::s4u::Host* host)
  23 {
  24   return host->get_speed() > 50E6;
  25 }
  26
  27 /* Second kind of thing that we can use as a filtering criteria: a functor (=function object).
  28  * This one is a bit stupid: it's a lot of boilerplate over a dummy boolean function.
  29  */
  30 class SingleCore {
  31 public:
  32   bool operator()(simgrid::s4u::Host* host) { return host->get_core_count() == 1; }
  33 };
  34
  35 /* This functor is a bit more complex, as it saves the current state when created.
  36  * Then, it allows to easily retrieve the hosts which frequency changed since the functor creation.
  37  */
  38 class FrequencyChanged {
  39   std::map<simgrid::s4u::Host*, int> host_list;
  40
  41 public:
  42   explicit FrequencyChanged(simgrid::s4u::Engine& e)
  43   {
  44     std::vector<simgrid::s4u::Host*> list = e.get_all_hosts();
  45     for (auto& host : list) {
  46       host_list.insert({host, host->get_pstate()});
  47     }
  48   }
  49
  50   bool operator()(simgrid::s4u::Host* host) { return host->get_pstate() != host_list.at(host); }
  51
  52   double get_old_speed(simgrid::s4u::Host* host) { return host_list.at(host); }
  53 };
  54 }
  55 int main(int argc, char* argv[])
  56 {
  57   simgrid::s4u::Engine e(&argc, argv);
  58   e.load_platform(argv[1]);
  59
  60   /* Use a lambda function to filter hosts: We only want multicore hosts */
  61   XBT_INFO("Hosts currently registered with this engine: %zu", e.get_host_count());
  62   std::vector<simgrid::s4u::Host*> list =
  63       e.get_filtered_hosts([](simgrid::s4u::Host* host) { return host->get_core_count() > 1; });
  64
  65   for (auto& host : list)
  66     XBT_INFO("The following hosts have more than one core: %s", host->get_cname());
  67
  68   xbt_assert(list.size() == 1);
  69
  70   /* Use a function object (functor) without memory */
  71   list = e.get_filtered_hosts(filter::SingleCore());
  72
  73   for (auto& host : list)
  74     XBT_INFO("The following hosts are SingleCore: %s", host->get_cname());
  75
  76   /* Use a function object that uses memory to filter */
  77   XBT_INFO("A simple example: Let's retrieve all hosts that changed their frequency");
  78   filter::FrequencyChanged filter(e);
  79   e.host_by_name("MyHost2")->set_pstate(2);
  80   list = e.get_filtered_hosts(filter);
  81
  82   for (auto& host : list)
  83     XBT_INFO("The following hosts changed their frequency: %s (from %.1ff to %.1ff)", host->get_cname(),
  84              host->get_pstate_speed(filter.get_old_speed(host)), host->get_speed());
  85
  86   /* You can also just use any regular function (namespaced on need) to filter  */
  87   list = e.get_filtered_hosts(filter::filter_speed_more_than_50Mf);
  88
  89   for (auto& host : list)
  90     XBT_INFO("The following hosts have a frequency > 50Mf: %s", host->get_cname());
  91
  92   return 0;
  93 }