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"
11 #include "xbt/sysdep.h"
16 /* Iterator within a trace */
17 typedef struct tmgr_trace_event {
20 sg_resource_t resource;
22 } s_tmgr_trace_event_t;
23 typedef struct tmgr_trace_event* 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(const char* filename);
37 XBT_PUBLIC(tmgr_trace_t) tmgr_trace_new_from_string(const char* id, std::string input, double periodicity);
43 /** @brief Modeling of the availability profile (due to an external load) or the churn
45 * There is 4 main concepts in this module:
46 * - #DatedValue: a pair <timestamp, value> (both are of type double)
47 * - #trace: a list of dated values
48 * - #trace_event: links a given trace to a given SimGrid resource.
49 * A Cpu for example has 2 kinds of events: state (ie, is it ON/OFF) and speed,
50 * while a link has 3 iterators: state, bandwidth and latency.
51 * - #future_evt_set: makes it easy to find the next occuring event of all traces
54 XBT_PUBLIC_CLASS DatedValue
59 explicit DatedValue() = default;
60 explicit DatedValue(double d, double v) : date_(d), value_(v) {}
61 bool operator==(DatedValue e2);
62 bool operator!=(DatedValue e2) { return not(*this == e2); }
64 std::ostream& operator<<(std::ostream& out, const DatedValue& e);
66 /** @brief A trace_iterator links a trace to a resource */
67 XBT_PUBLIC_CLASS trace_event{
71 /** @brief A trace is a set of timed values, encoding the value that a variable takes at what time *
73 * It is useful to model dynamic platforms, where an external load that makes the resource availability change over time.
74 * 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).
76 XBT_PUBLIC_CLASS trace {
78 /** Creates an empty trace */
82 std::vector<DatedValue> event_list;
85 /** @brief Future Event Set (collection of iterators over the traces)
86 * That's useful to quickly know which is the next occurring event in a set of traces. */
87 XBT_PUBLIC_CLASS future_evt_set {
90 virtual ~future_evt_set();
91 double next_date() const;
92 tmgr_trace_event_t pop_leq(double date, double* value, simgrid::surf::Resource** resource);
93 tmgr_trace_event_t add_trace(tmgr_trace_t trace, simgrid::surf::Resource * resource);
96 // TODO: use a boost type for the heap (or a ladder queue)
97 xbt_heap_t heap_ = xbt_heap_new(8, xbt_free_f); /* Content: only trace_events (yep, 8 is an arbitrary value) */
100 }} // namespace simgrid::trace_mgr
101 #endif /* C++ only */
103 #endif /* SURF_TMGR_H */