-/* Copyright (c) 2004-2007, 2009-2014. The SimGrid Team.
- * All rights reserved. */
+/* Copyright (c) 2004-2018. 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 _SURF_TMGR_H
-#define _SURF_TMGR_H
+#ifndef SURF_TMGR_H
+#define SURF_TMGR_H
-#include "xbt/heap.h"
-#include "xbt/dynar.h"
-#include "surf/maxmin.h"
-#include "surf/datatypes.h"
-#include "simgrid/platf_interface.h"
#include "simgrid/forward.h"
+#include "xbt/sysdep.h"
-SG_BEGIN_DECL()
-#include "xbt/base.h"
-#include "xbt/swag.h"
-#include "xbt/heap.h"
-#include "trace_mgr.hpp"
-#include "xbt/RngStream.h"
-
-typedef struct tmgr_event {
- double delta;
- double value;
-} s_tmgr_event_t, *tmgr_event_t;
-
-enum e_trace_type {
- e_trace_list, e_trace_probabilist
-};
-
-enum e_event_generator_type {
- e_generator_uniform, e_generator_exponential, e_generator_weibull
-};
-
-typedef struct probabilist_event_generator {
- enum e_event_generator_type type;
- RngStream rng_stream;
- double next_value;
- union {
- struct {
- double min;
- double max;
- } s_uniform_parameters;
- struct {
- double rate;
- } s_exponential_parameters;
- struct {
- double scale;
- double shape;
- } s_weibull_parameters;
- };
-} s_probabilist_event_generator_t;
-
-typedef struct tmgr_trace {
- enum e_trace_type type;
- union {
- struct {
- xbt_dynar_t event_list;
- } s_list;
- struct {
- probabilist_event_generator_t event_generator[2];
- int is_state_trace;
- int next_event;
- } s_probabilist;
- };
-} s_tmgr_trace_t;
+#include <queue>
+#include <vector>
/* Iterator within a trace */
-typedef struct tmgr_trace_iterator {
+namespace simgrid {
+namespace kernel {
+namespace resource {
+class TraceEvent {
+public:
tmgr_trace_t trace;
unsigned int idx;
- void *resource;
- int free_me;
-} s_tmgr_trace_event_t;
+ Resource* resource;
+ bool free_me;
+};
-XBT_PRIVATE double tmgr_event_generator_next_value(probabilist_event_generator_t generator);
+} // namespace resource
+} // namespace kernel
+} // namespace simgrid
+typedef simgrid::kernel::resource::TraceEvent* tmgr_trace_event_t;
+extern XBT_PRIVATE simgrid::trace_mgr::future_evt_set* future_evt_set;
-/* Creation functions */
-XBT_PUBLIC(tmgr_trace_t) tmgr_empty_trace_new(void);
-XBT_PUBLIC(void) tmgr_trace_free(tmgr_trace_t trace);
/**
* \brief Free a trace event structure
*
- * This function frees a trace_event if it can be freed, ie, if it has the free_me flag set to 1. This flag indicates whether the structure is still used somewhere or not.
- * \param trace_event Trace event structure
- * \return 1 if the structure was freed, 0 otherwise
+ * This function frees a trace_event if it can be freed, ie, if it has the free_me flag set to 1.
+ * This flag indicates whether the structure is still used somewhere or not.
+ * When the structure is freed, the argument is set to nullptr
*/
-XBT_PUBLIC(int) tmgr_trace_event_free(tmgr_trace_iterator_t trace_event);
+XBT_PUBLIC void tmgr_trace_event_unref(tmgr_trace_event_t* trace_event);
-XBT_PUBLIC(void) tmgr_finalize(void);
+XBT_PUBLIC void tmgr_finalize();
-SG_END_DECL()
+XBT_PUBLIC tmgr_trace_t tmgr_trace_new_from_file(std::string filename);
+XBT_PUBLIC tmgr_trace_t tmgr_trace_new_from_string(std::string id, std::string input, double periodicity);
-#ifdef __cplusplus
namespace simgrid {
- namespace trace_mgr {
+/** @brief Modeling of the availability profile (due to an external load) or the churn
+ *
+ * There is 4 main concepts in this module:
+ * - #simgrid::trace_mgr::DatedValue: a pair <timestamp, value> (both are of type double)
+ * - #simgrid::trace_mgr::trace: a list of dated values
+ * - #simgrid::trace_mgr::trace_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::trace_mgr::future_evt_set: makes it easy to find the next occuring event of all traces
+ */
+namespace trace_mgr {
+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 e2);
+ bool operator!=(DatedValue e2) { return not(*this == e2); }
+};
+std::ostream& operator<<(std::ostream& out, const DatedValue& e);
+
+/** @brief A trace_iterator links a trace to a resource */
+class XBT_PUBLIC trace_event {
+};
+
+/** @brief A trace 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 traces per resource: one for the on/off state and one for each numerical value (computational speed, bandwidth and latency).
+ */
+class XBT_PUBLIC trace {
+public:
+ /** Creates an empty trace */
+ explicit trace();
+ virtual ~trace();
+//private:
+ std::vector<DatedValue> event_list;
+};
-/* Future Event Set (collection of iterators over the traces)
+/** @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. */
-XBT_PUBLIC_CLASS future_evt_set {
+class XBT_PUBLIC future_evt_set {
public:
future_evt_set();
virtual ~future_evt_set();
- double next_date();
- tmgr_trace_iterator_t pop_leq(double date, double *value, void** resource);
- tmgr_trace_iterator_t add_trace(
- tmgr_trace_t trace,
- double start_time,
- unsigned int offset,
- void *model);
+ double next_date() const;
+ tmgr_trace_event_t pop_leq(double date, double* value, simgrid::kernel::resource::Resource** resource);
+ tmgr_trace_event_t add_trace(tmgr_trace_t trace, simgrid::kernel::resource::Resource * resource);
private:
- // TODO: use a boost type for the heap (or a ladder queue)
- xbt_heap_t p_heap = xbt_heap_new(8, xbt_free_f); /* Content: only trace_events (yep, 8 is an arbitrary value) */
+ typedef std::pair<double, tmgr_trace_event_t> Qelt;
+ std::priority_queue<Qelt, std::vector<Qelt>, std::greater<Qelt>> heap_;
};
}} // namespace simgrid::trace_mgr
-#endif /* C++ only */
-#endif /* _SURF_TMGR_H */
+#endif /* SURF_TMGR_H */