Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Remove useless #ifdef __cplusplus from hpp files.
[simgrid.git] / src / surf / trace_mgr.hpp
1 /* Copyright (c) 2004-2017. 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 #ifndef SURF_TMGR_H
7 #define SURF_TMGR_H
8
9 #include "simgrid/forward.h"
10 #include "xbt/heap.h"
11 #include "xbt/sysdep.h"
12 #include <vector>
13
14 SG_BEGIN_DECL()
15
16 /* Iterator within a trace */
17 typedef struct tmgr_trace_event {
18   tmgr_trace_t trace;
19   unsigned int idx;
20   sg_resource_t resource;
21   int free_me;
22 } s_tmgr_trace_event_t;
23 typedef struct tmgr_trace_event* tmgr_trace_event_t;
24
25 /**
26  * \brief Free a trace event structure
27  *
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
31 */
32 XBT_PUBLIC(void) tmgr_trace_event_unref(tmgr_trace_event_t* trace_event);
33
34 XBT_PUBLIC(void) tmgr_finalize();
35
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);
38
39 SG_END_DECL()
40
41 namespace simgrid {
42 /** @brief Modeling of the availability profile (due to an external load) or the churn
43  *
44  * There is 4 main concepts in this module:
45  * - #DatedValue: a pair <timestamp, value> (both are of type double)
46  * - #trace: a list of dated values
47  * - #trace_event: links a given trace to a given SimGrid resource.
48  *   A Cpu for example has 2 kinds of events: state (ie, is it ON/OFF) and speed,
49  *   while a link has 3 iterators: state, bandwidth and latency.
50  * - #future_evt_set: makes it easy to find the next occuring event of all traces
51  */
52 namespace trace_mgr {
53 XBT_PUBLIC_CLASS DatedValue
54 {
55 public:
56   double date_          = 0;
57   double value_         = 0;
58   explicit DatedValue() = default;
59   explicit DatedValue(double d, double v) : date_(d), value_(v) {}
60   bool operator==(DatedValue e2);
61   bool operator!=(DatedValue e2) { return not(*this == e2); }
62 };
63 std::ostream& operator<<(std::ostream& out, const DatedValue& e);
64
65 /** @brief A trace_iterator links a trace to a resource */
66 XBT_PUBLIC_CLASS trace_event{
67
68 };
69
70 /** @brief A trace is a set of timed values, encoding the value that a variable takes at what time *
71  *
72  * It is useful to model dynamic platforms, where an external load that makes the resource availability change over time.
73  * 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  */
75 XBT_PUBLIC_CLASS trace {
76 public:
77   /**  Creates an empty trace */
78   explicit trace();
79   virtual ~trace();
80 //private:
81   std::vector<DatedValue> event_list;
82 };
83
84 /** @brief Future Event Set (collection of iterators over the traces)
85  * That's useful to quickly know which is the next occurring event in a set of traces. */
86 XBT_PUBLIC_CLASS future_evt_set {
87 public:
88   future_evt_set();
89   virtual ~future_evt_set();
90   double next_date() const;
91   tmgr_trace_event_t pop_leq(double date, double* value, simgrid::surf::Resource** resource);
92   tmgr_trace_event_t add_trace(tmgr_trace_t trace, simgrid::surf::Resource * resource);
93
94 private:
95   // TODO: use a boost type for the heap (or a ladder queue)
96   xbt_heap_t heap_ = xbt_heap_new(8, xbt_free_f); /* Content: only trace_events (yep, 8 is an arbitrary value) */
97 };
98
99 }} // namespace simgrid::trace_mgr
100
101 #endif /* SURF_TMGR_H */