1 /* Copyright (c) 2004-2017. The SimGrid Team. All rights reserved. */
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. */
9 #include "simgrid/forward.h"
10 #include "xbt/sysdep.h"
16 /* Iterator within a trace */
17 struct s_tmgr_trace_event_t {
20 sg_resource_t resource;
23 typedef s_tmgr_trace_event_t* tmgr_trace_event_t;
26 * \brief Free a trace event structure
28 * This function frees a trace_event if it can be freed, ie, if it has the free_me flag set to 1.
29 * This flag indicates whether the structure is still used somewhere or not.
30 * When the structure is freed, the argument is set to nullptr
32 XBT_PUBLIC(void) tmgr_trace_event_unref(tmgr_trace_event_t* trace_event);
34 XBT_PUBLIC(void) tmgr_finalize();
36 XBT_PUBLIC(tmgr_trace_t) tmgr_trace_new_from_file(std::string filename);
37 XBT_PUBLIC(tmgr_trace_t) tmgr_trace_new_from_string(std::string id, std::string input, double periodicity);
41 /** @brief Modeling of the availability profile (due to an external load) or the churn
43 * There is 4 main concepts in this module:
44 * - #DatedValue: a pair <timestamp, value> (both are of type double)
45 * - #trace: a list of dated values
46 * - #trace_event: links a given trace to a given SimGrid resource.
47 * A Cpu for example has 2 kinds of events: state (ie, is it ON/OFF) and speed,
48 * while a link has 3 iterators: state, bandwidth and latency.
49 * - #future_evt_set: makes it easy to find the next occuring event of all traces
52 XBT_PUBLIC_CLASS DatedValue
57 explicit DatedValue() = default;
58 explicit DatedValue(double d, double v) : date_(d), value_(v) {}
59 bool operator==(DatedValue e2);
60 bool operator!=(DatedValue e2) { return not(*this == e2); }
62 std::ostream& operator<<(std::ostream& out, const DatedValue& e);
64 /** @brief A trace_iterator links a trace to a resource */
65 XBT_PUBLIC_CLASS trace_event{
69 /** @brief A trace is a set of timed values, encoding the value that a variable takes at what time *
71 * It is useful to model dynamic platforms, where an external load that makes the resource availability change over time.
72 * 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).
74 XBT_PUBLIC_CLASS trace {
76 /** Creates an empty trace */
80 std::vector<DatedValue> event_list;
83 /** @brief Future Event Set (collection of iterators over the traces)
84 * That's useful to quickly know which is the next occurring event in a set of traces. */
85 XBT_PUBLIC_CLASS future_evt_set {
88 virtual ~future_evt_set();
89 double next_date() const;
90 tmgr_trace_event_t pop_leq(double date, double* value, simgrid::surf::Resource** resource);
91 tmgr_trace_event_t add_trace(tmgr_trace_t trace, simgrid::surf::Resource * resource);
94 typedef std::pair<double, tmgr_trace_event_t> Qelt;
95 std::priority_queue<Qelt, std::vector<Qelt>, std::greater<Qelt>> heap_;
98 }} // namespace simgrid::trace_mgr
100 #endif /* SURF_TMGR_H */