Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Splitting trace_mgr into a file per class
authorYann Duplouy <yann.duplouy@inria.fr>
Thu, 11 Apr 2019 10:00:07 +0000 (12:00 +0200)
committerYann Duplouy <yann.duplouy@inria.fr>
Fri, 12 Apr 2019 15:15:42 +0000 (17:15 +0200)
src/kernel/resource/profile/DatedValue.cpp [new file with mode: 0644]
src/kernel/resource/profile/DatedValue.hpp [new file with mode: 0644]
src/kernel/resource/profile/FutureEvtSet.cpp [new file with mode: 0644]
src/kernel/resource/profile/FutureEvtSet.hpp [new file with mode: 0644]
src/kernel/resource/profile/Profile.cpp [new file with mode: 0644]
src/kernel/resource/profile/Profile.hpp [new file with mode: 0644]
src/kernel/resource/profile/trace_mgr.cpp
src/kernel/resource/profile/trace_mgr.hpp

diff --git a/src/kernel/resource/profile/DatedValue.cpp b/src/kernel/resource/profile/DatedValue.cpp
new file mode 100644 (file)
index 0000000..b104af7
--- /dev/null
@@ -0,0 +1,25 @@
+/* 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. */
+
+//#include "src/kernel/resource/profile/DatedValue.hpp"
+#include <math.h>
+
+namespace simgrid {
+namespace kernel {
+namespace profile {
+
+bool DatedValue::operator==(DatedValue const& e2) const
+{
+  return (fabs(date_ - e2.date_) < 0.0001) && (fabs(value_ - e2.value_) < 0.0001);
+}
+std::ostream& operator<<(std::ostream& out, const DatedValue& e)
+{
+  out << e.date_ << " " << e.value_;
+  return out;
+}
+
+} // namespace profile
+} // namespace kernel
+} // namespace simgrid
\ No newline at end of file
diff --git a/src/kernel/resource/profile/DatedValue.hpp b/src/kernel/resource/profile/DatedValue.hpp
new file mode 100644 (file)
index 0000000..8530fb7
--- /dev/null
@@ -0,0 +1,35 @@
+/* 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. */
+
+#include <iostream>
+
+namespace simgrid {
+namespace kernel {
+namespace profile {
+
+/** @brief Modeling of the availability profile (due to an external load) or the churn
+ *
+ * There is 4 main concepts in this module:
+ * - #simgrid::kernel::profile::DatedValue: a pair <timestamp, value> (both are of type double)
+ * - #simgrid::kernel::profile::Profile: a list of dated values
+ * - #simgrid::kernel::profile::Event: links a given trace to a given SimGrid resource.
+ *   A Cpu for example has 2 kinds of events: state (ie, is it ON/OFF) and speed,
+ *   while a link has 3 iterators: state, bandwidth and latency.
+ * - #simgrid::kernel::profile::FutureEvtSet: makes it easy to find the next occuring event of all profiles
+ */
+class XBT_PUBLIC DatedValue {
+public:
+  double date_          = 0;
+  double value_         = 0;
+  explicit DatedValue() = default;
+  explicit DatedValue(double d, double v) : date_(d), value_(v) {}
+  bool operator==(DatedValue const& e2) const;
+  bool operator!=(DatedValue const& e2) const { return not(*this == e2); }
+};
+std::ostream& operator<<(std::ostream& out, const DatedValue& e);
+
+} // namespace profile
+} // namespace kernel
+} // namespace simgrid
\ No newline at end of file
diff --git a/src/kernel/resource/profile/FutureEvtSet.cpp b/src/kernel/resource/profile/FutureEvtSet.cpp
new file mode 100644 (file)
index 0000000..59b0bdc
--- /dev/null
@@ -0,0 +1,53 @@
+/* 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. */
+
+#include "src/kernel/resource/profile/FutureEvtSet.hpp"
+
+namespace simgrid {
+namespace kernel {
+namespace profile {
+       
+FutureEvtSet::FutureEvtSet() = default;
+FutureEvtSet::~FutureEvtSet()
+{
+  while (not heap_.empty()) {
+    delete heap_.top().second;
+    heap_.pop();
+  }
+}
+
+/** @brief Schedules an event to a future date */
+void FutureEvtSet::add_event(double date, Event* evt)
+{
+  heap_.emplace(date, evt);
+}
+
+/** @brief returns the date of the next occurring event (or -1 if empty) */
+double FutureEvtSet::next_date() const
+{
+  return heap_.empty() ? -1.0 : heap_.top().first;
+}
+
+/** @brief Retrieves the next occurring event, or nullptr if none happens before date */
+Event* FutureEvtSet::pop_leq(double date, double* value, resource::Resource** resource)
+{
+  double event_date = next_date();
+  if (event_date > date || heap_.empty())
+    return nullptr;
+
+  Event* event = heap_.top().second;
+  Profile* profile = event->profile;
+  DatedValue dateVal = profile->next(event);
+
+  *resource = event->resource;
+  *value = dateVal.value_;
+
+  heap_.pop();
+
+  return event;
+}
+} // namespace profile
+} // namespace kernel
+} // namespace simgrid
\ No newline at end of file
diff --git a/src/kernel/resource/profile/FutureEvtSet.hpp b/src/kernel/resource/profile/FutureEvtSet.hpp
new file mode 100644 (file)
index 0000000..f565f0a
--- /dev/null
@@ -0,0 +1,35 @@
+/* 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. */
+
+#include <queue>
+#ifndef FUTUREEVTSET_HPP
+#define FUTUREEVTSET_HPP
+
+namespace simgrid {
+namespace kernel {
+namespace profile {
+
+/** @brief Future Event Set (collection of iterators over the traces)
+ * That's useful to quickly know which is the next occurring event in a set of traces. */
+class XBT_PUBLIC FutureEvtSet {
+public:
+  FutureEvtSet();
+  FutureEvtSet(const FutureEvtSet&) = delete;
+  FutureEvtSet& operator=(const FutureEvtSet&) = delete;
+  virtual ~FutureEvtSet();
+  double next_date() const;
+  Event* pop_leq(double date, double* value, resource::Resource** resource);
+  void add_event(double date, Event* evt);
+
+private:
+  typedef std::pair<double, Event*> Qelt;
+  std::priority_queue<Qelt, std::vector<Qelt>, std::greater<Qelt>> heap_;
+};
+
+} // namespace profile
+} // namespace kernel
+} // namespace simgrid
+
+#endif
\ No newline at end of file
diff --git a/src/kernel/resource/profile/Profile.cpp b/src/kernel/resource/profile/Profile.cpp
new file mode 100644 (file)
index 0000000..73f2962
--- /dev/null
@@ -0,0 +1,128 @@
+/* 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. */
+
+#include "xbt/log.h"
+#include "xbt/sysdep.h"
+#include <ostream>
+#include "src/kernel/resource/profile/Profile.hpp"
+#include <boost/algorithm/string.hpp>
+#include "src/kernel/resource/profile/FutureEvtSet.cpp"
+#include "src/kernel/resource/profile/DatedValue.cpp"
+#include "simgrid/forward.h"
+#include <vector>
+
+static std::unordered_map<std::string, simgrid::kernel::profile::Profile*> trace_list;
+
+namespace simgrid {
+namespace kernel {
+namespace profile {
+
+Profile::Profile()
+{
+  /* Add the first fake event storing the time at which the trace begins */
+  DatedValue val(0, -1);
+  event_list.push_back(val);
+}
+Profile::~Profile()          = default;
+
+/** @brief Register this profile for that resource onto that FES,
+ * and get an iterator over the integrated trace  */
+Event* Profile::schedule(FutureEvtSet* fes, resource::Resource* resource)
+{
+  Event* event    = new Event();
+  event->profile  = this;
+  event->idx      = 0;
+  event->resource = resource;
+  event->free_me  = false;
+
+  xbt_assert((event->idx < event_list.size()), "Your profile should have at least one event!");
+
+  fes_ = fes;
+  fes_->add_event(0.0 /* start time */, event);
+
+  return event;
+}
+
+/** @brief Gets the next event from a profile */
+DatedValue Profile::next(Event* event)
+{
+  double event_date  = fes_->next_date();
+  DatedValue dateVal = event_list.at(event->idx);
+
+  if (event->idx < event_list.size() - 1) {
+    fes_->add_event(event_date + dateVal.date_, event);
+    event->idx++;
+  } else if (dateVal.date_ > 0) { /* Last element. Shall we loop? */
+    fes_->add_event(event_date + dateVal.date_, event);
+    event->idx = 1; /* idx=0 is a placeholder to store when events really start */
+  } else {          /* If we don't loop, we don't need this event anymore */
+    event->free_me = true;
+  }
+
+  return dateVal;
+}
+
+Profile* Profile::from_string(const std::string& name, const std::string& input, double periodicity)
+{
+  int linecount                                    = 0;
+  simgrid::kernel::profile::Profile* profile       = new simgrid::kernel::profile::Profile();
+  simgrid::kernel::profile::DatedValue* last_event = &(profile->event_list.back());
+
+  xbt_assert(trace_list.find(name) == trace_list.end(), "Refusing to define trace %s twice", name.c_str());
+
+  std::vector<std::string> list;
+  boost::split(list, input, boost::is_any_of("\n\r"));
+  for (auto val : list) {
+    simgrid::kernel::profile::DatedValue event;
+    linecount++;
+    boost::trim(val);
+    if (val[0] == '#' || val[0] == '\0' || val[0] == '%') // pass comments
+      continue;
+    if (sscanf(val.c_str(), "PERIODICITY %lg\n", &periodicity) == 1)
+      continue;
+    if (sscanf(val.c_str(), "LOOPAFTER %lg\n", &periodicity) == 1)
+      continue;
+
+    XBT_ATTRIB_UNUSED int res = sscanf(val.c_str(), "%lg  %lg\n", &event.date_, &event.value_);
+    xbt_assert(res == 2, "%s:%d: Syntax error in trace\n%s", name.c_str(), linecount, input.c_str());
+
+    xbt_assert(last_event->date_ <= event.date_,
+               "%s:%d: Invalid trace: Events must be sorted, but time %g > time %g.\n%s", name.c_str(), linecount,
+               last_event->date_, event.date_, input.c_str());
+    last_event->date_ = event.date_ - last_event->date_;
+
+    profile->event_list.push_back(event);
+    last_event = &(profile->event_list.back());
+  }
+  if (last_event) {
+    if (periodicity > 0) {
+      last_event->date_ = periodicity + profile->event_list.at(0).date_;
+    } else {
+      last_event->date_ = -1;
+    }
+  }
+
+  trace_list.insert({name, profile});
+
+  return profile;
+}
+Profile* Profile::from_file(const std::string& path)
+{
+  xbt_assert(not path.empty(), "Cannot parse a trace from an empty filename");
+  xbt_assert(trace_list.find(path) == trace_list.end(), "Refusing to define trace %s twice", path.c_str());
+
+  std::ifstream* f = surf_ifsopen(path);
+  xbt_assert(not f->fail(), "Cannot open file '%s' (path=%s)", path.c_str(), (boost::join(surf_path, ":")).c_str());
+
+  std::stringstream buffer;
+  buffer << f->rdbuf();
+  delete f;
+
+  return Profile::from_string(path, buffer.str(), -1);
+}
+       
+} // namespace profile
+} // namespace kernel
+} // namespace simgrid
diff --git a/src/kernel/resource/profile/Profile.hpp b/src/kernel/resource/profile/Profile.hpp
new file mode 100644 (file)
index 0000000..305808a
--- /dev/null
@@ -0,0 +1,53 @@
+/* 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. */
+
+#ifndef PROFILE_HPP
+#define PROFILE_HPP
+
+#include "src/kernel/resource/profile/DatedValue.hpp"
+#include "src/kernel/resource/profile/FutureEvtSet.hpp"
+#include <vector>
+#include <queue>
+
+namespace simgrid {
+namespace kernel {
+namespace profile {
+       
+class Event {
+public:
+  Profile* profile;
+  unsigned int idx;
+  resource::Resource* resource;
+  bool free_me;
+};
+       
+/** @brief A profile is a set of timed values, encoding the value that a variable takes at what time
+ *
+ * It is useful to model dynamic platforms, where an external load that makes the resource availability change over
+ * time. To model that, you have to set several profiles per resource: one for the on/off state and one for each
+ * numerical value (computational speed, bandwidth and/or latency).
+ */
+class XBT_PUBLIC Profile {
+public:
+  /**  Creates an empty trace */
+  explicit Profile();
+  virtual ~Profile();
+  Event* schedule(FutureEvtSet* fes, resource::Resource* resource);
+  DatedValue next(Event* event);
+
+  static Profile* from_file(const std::string& path);
+  static Profile* from_string(const std::string& name, const std::string& input, double periodicity);
+  // private:
+  std::vector<DatedValue> event_list;
+
+private:
+  FutureEvtSet* fes_ = nullptr;
+};
+
+} // namespace profile
+} // namespace kernel
+} // namespace simgrid
+
+#endif
\ No newline at end of file
index a796657..6c0d0db 100644 (file)
 #include <sstream>
 #include <unordered_map>
 
-XBT_LOG_NEW_DEFAULT_SUBCATEGORY(profile, resource, "Surf profile management");
-
-static std::unordered_map<std::string, simgrid::kernel::profile::Profile*> trace_list;
-
-namespace simgrid {
-namespace kernel {
-namespace profile {
-
-bool DatedValue::operator==(DatedValue const& e2) const
-{
-  return (fabs(date_ - e2.date_) < 0.0001) && (fabs(value_ - e2.value_) < 0.0001);
-}
-std::ostream& operator<<(std::ostream& out, const DatedValue& e)
-{
-  out << e.date_ << " " << e.value_;
-  return out;
-}
-
-Profile::Profile()
-{
-  /* Add the first fake event storing the time at which the trace begins */
-  DatedValue val(0, -1);
-  event_list.push_back(val);
-}
-Profile::~Profile()          = default;
-
-/** @brief Register this profile for that resource onto that FES,
- * and get an iterator over the integrated trace  */
-Event* Profile::schedule(FutureEvtSet* fes, resource::Resource* resource)
-{
-  Event* event    = new Event();
-  event->profile  = this;
-  event->idx      = 0;
-  event->resource = resource;
-  event->free_me  = false;
-
-  xbt_assert((event->idx < event_list.size()), "Your profile should have at least one event!");
-
-  fes_ = fes;
-  fes_->add_event(0.0 /* start time */, event);
-
-  return event;
-}
-
-/** @brief Gets the next event from a profile */
-DatedValue Profile::next(Event* event)
-{
-  double event_date  = fes_->next_date();
-  DatedValue dateVal = event_list.at(event->idx);
-
-  if (event->idx < event_list.size() - 1) {
-    fes_->add_event(event_date + dateVal.date_, event);
-    event->idx++;
-  } else if (dateVal.date_ > 0) { /* Last element. Shall we loop? */
-    fes_->add_event(event_date + dateVal.date_, event);
-    event->idx = 1; /* idx=0 is a placeholder to store when events really start */
-  } else {          /* If we don't loop, we don't need this event anymore */
-    event->free_me = true;
-  }
-
-  return dateVal;
-}
-
-Profile* Profile::from_string(const std::string& name, const std::string& input, double periodicity)
-{
-  int linecount                                    = 0;
-  simgrid::kernel::profile::Profile* profile       = new simgrid::kernel::profile::Profile();
-  simgrid::kernel::profile::DatedValue* last_event = &(profile->event_list.back());
-
-  xbt_assert(trace_list.find(name) == trace_list.end(), "Refusing to define trace %s twice", name.c_str());
-
-  std::vector<std::string> list;
-  boost::split(list, input, boost::is_any_of("\n\r"));
-  for (auto val : list) {
-    simgrid::kernel::profile::DatedValue event;
-    linecount++;
-    boost::trim(val);
-    if (val[0] == '#' || val[0] == '\0' || val[0] == '%') // pass comments
-      continue;
-    if (sscanf(val.c_str(), "PERIODICITY %lg\n", &periodicity) == 1)
-      continue;
-    if (sscanf(val.c_str(), "LOOPAFTER %lg\n", &periodicity) == 1)
-      continue;
-
-    XBT_ATTRIB_UNUSED int res = sscanf(val.c_str(), "%lg  %lg\n", &event.date_, &event.value_);
-    xbt_assert(res == 2, "%s:%d: Syntax error in trace\n%s", name.c_str(), linecount, input.c_str());
+#include "src/kernel/resource/profile/Profile.cpp"
 
-    xbt_assert(last_event->date_ <= event.date_,
-               "%s:%d: Invalid trace: Events must be sorted, but time %g > time %g.\n%s", name.c_str(), linecount,
-               last_event->date_, event.date_, input.c_str());
-    last_event->date_ = event.date_ - last_event->date_;
+/** This file has been splitted into three different files:
+  - Profile, defining the class Profile and functions that allow to use provided profiles;
+  - DatedValue, the class of a DatedValue (a value and a timestamp);
+  - FutureEvtSet, a set of events happening in the future. **/
 
-    profile->event_list.push_back(event);
-    last_event = &(profile->event_list.back());
-  }
-  if (last_event) {
-    if (periodicity > 0) {
-      last_event->date_ = periodicity + profile->event_list.at(0).date_;
-    } else {
-      last_event->date_ = -1;
-    }
-  }
-
-  trace_list.insert({name, profile});
-
-  return profile;
-}
-Profile* Profile::from_file(const std::string& path)
-{
-  xbt_assert(not path.empty(), "Cannot parse a trace from an empty filename");
-  xbt_assert(trace_list.find(path) == trace_list.end(), "Refusing to define trace %s twice", path.c_str());
-
-  std::ifstream* f = surf_ifsopen(path);
-  xbt_assert(not f->fail(), "Cannot open file '%s' (path=%s)", path.c_str(), (boost::join(surf_path, ":")).c_str());
-
-  std::stringstream buffer;
-  buffer << f->rdbuf();
-  delete f;
-
-  return Profile::from_string(path, buffer.str(), -1);
-}
-FutureEvtSet::FutureEvtSet() = default;
-FutureEvtSet::~FutureEvtSet()
-{
-  while (not heap_.empty()) {
-    delete heap_.top().second;
-    heap_.pop();
-  }
-}
-
-/** @brief Schedules an event to a future date */
-void FutureEvtSet::add_event(double date, Event* evt)
-{
-  heap_.emplace(date, evt);
-}
-
-/** @brief returns the date of the next occurring event (or -1 if empty) */
-double FutureEvtSet::next_date() const
-{
-  return heap_.empty() ? -1.0 : heap_.top().first;
-}
-
-/** @brief Retrieves the next occurring event, or nullptr if none happens before date */
-Event* FutureEvtSet::pop_leq(double date, double* value, resource::Resource** resource)
-{
-  double event_date = next_date();
-  if (event_date > date || heap_.empty())
-    return nullptr;
-
-  Event* event = heap_.top().second;
-  Profile* profile = event->profile;
-  DatedValue dateVal = profile->next(event);
-
-  *resource = event->resource;
-  *value = dateVal.value_;
-
-  heap_.pop();
-
-  return event;
-}
-} // namespace profile
-} // namespace kernel
-} // namespace simgrid
+XBT_LOG_NEW_DEFAULT_SUBCATEGORY(profile, resource, "Surf profile management");
 void tmgr_finalize()
 {
   for (auto const& kv : trace_list)
@@ -192,4 +37,4 @@ void tmgr_trace_event_unref(simgrid::kernel::profile::Event** event)
     delete *event;
     *event = nullptr;
   }
-}
+}
\ No newline at end of file
index c0abe9e..9930b14 100644 (file)
@@ -7,27 +7,12 @@
 #define SURF_PMGR_H
 
 #include "simgrid/forward.h"
+#include "src/kernel/resource/profile/Profile.hpp"
 #include "xbt/sysdep.h"
 
 #include <queue>
 #include <vector>
 
-/* Iterator within a trace */
-namespace simgrid {
-namespace kernel {
-namespace profile {
-/** @brief Links a profile to a resource */
-class Event {
-public:
-  Profile* profile;
-  unsigned int idx;
-  resource::Resource* resource;
-  bool free_me;
-};
-
-} // namespace profile
-} // namespace kernel
-} // namespace simgrid
 extern XBT_PRIVATE simgrid::kernel::profile::FutureEvtSet future_evt_set;
 
 /**
@@ -38,76 +23,8 @@ extern XBT_PRIVATE simgrid::kernel::profile::FutureEvtSet future_evt_set;
  * When the structure is freed, the argument is set to nullptr
  */
 XBT_PUBLIC void tmgr_trace_event_unref(simgrid::kernel::profile::Event** trace_event);
-
 XBT_PUBLIC void tmgr_finalize();
 
-namespace simgrid {
-namespace kernel {
-namespace profile {
-
-/** @brief Modeling of the availability profile (due to an external load) or the churn
- *
- * There is 4 main concepts in this module:
- * - #simgrid::kernel::profile::DatedValue: a pair <timestamp, value> (both are of type double)
- * - #simgrid::kernel::profile::Profile: a list of dated values
- * - #simgrid::kernel::profile::Event: links a given trace to a given SimGrid resource.
- *   A Cpu for example has 2 kinds of events: state (ie, is it ON/OFF) and speed,
- *   while a link has 3 iterators: state, bandwidth and latency.
- * - #simgrid::kernel::profile::FutureEvtSet: makes it easy to find the next occuring event of all profiles
- */
-class XBT_PUBLIC DatedValue {
-public:
-  double date_          = 0;
-  double value_         = 0;
-  explicit DatedValue() = default;
-  explicit DatedValue(double d, double v) : date_(d), value_(v) {}
-  bool operator==(DatedValue const& e2) const;
-  bool operator!=(DatedValue const& e2) const { return not(*this == e2); }
-};
-std::ostream& operator<<(std::ostream& out, const DatedValue& e);
-
-/** @brief A profile is a set of timed values, encoding the value that a variable takes at what time
- *
- * It is useful to model dynamic platforms, where an external load that makes the resource availability change over
- * time. To model that, you have to set several profiles per resource: one for the on/off state and one for each
- * numerical value (computational speed, bandwidth and/or latency).
- */
-class XBT_PUBLIC Profile {
-public:
-  /**  Creates an empty trace */
-  explicit Profile();
-  virtual ~Profile();
-  Event* schedule(FutureEvtSet* fes, resource::Resource* resource);
-  DatedValue next(Event* event);
-
-  static Profile* from_file(const std::string& path);
-  static Profile* from_string(const std::string& name, const std::string& input, double periodicity);
-  // private:
-  std::vector<DatedValue> event_list;
-
-private:
-  FutureEvtSet* fes_ = nullptr;
-};
-
-/** @brief Future Event Set (collection of iterators over the traces)
- * That's useful to quickly know which is the next occurring event in a set of traces. */
-class XBT_PUBLIC FutureEvtSet {
-public:
-  FutureEvtSet();
-  FutureEvtSet(const FutureEvtSet&) = delete;
-  FutureEvtSet& operator=(const FutureEvtSet&) = delete;
-  virtual ~FutureEvtSet();
-  double next_date() const;
-  Event* pop_leq(double date, double* value, resource::Resource** resource);
-  void add_event(double date, Event* evt);
-
-private:
-  typedef std::pair<double, Event*> Qelt;
-  std::priority_queue<Qelt, std::vector<Qelt>, std::greater<Qelt>> heap_;
-};
 
-} // namespace profile
-} // namespace kernel
-} // namespace simgrid
 
 #endif /* SURF_PMGR_H */