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. */
10 #include "simgrid/forward.h"
15 typedef struct tmgr_event {
18 } s_tmgr_event_t, *tmgr_event_t;
20 /* Iterator within a trace */
21 typedef struct tmgr_trace_iterator {
24 sg_resource_t resource;
26 } s_tmgr_trace_event_t;
27 typedef struct tmgr_trace_iterator *tmgr_trace_iterator_t;
29 /* Creation functions */
30 XBT_PUBLIC(tmgr_trace_t) tmgr_empty_trace_new(void);
31 XBT_PUBLIC(void) tmgr_trace_free(tmgr_trace_t trace);
33 * \brief Free a trace event structure
35 * This function frees a trace_event if it can be freed, ie, if it has the free_me flag set to 1.
36 * This flag indicates whether the structure is still used somewhere or not.
37 * When the structure is freed, the argument is set to nullptr
39 XBT_PUBLIC(void) tmgr_trace_event_unref(tmgr_trace_iterator_t *trace_event);
41 XBT_PUBLIC(void) tmgr_finalize(void);
43 XBT_PUBLIC(tmgr_trace_t) tmgr_trace_new_from_file(const char *filename);
44 XBT_PUBLIC(tmgr_trace_t) tmgr_trace_new_from_string(const char *id, const char *input, double periodicity);
50 /** @brief Modeling of the resource variations, such as those due to an external load
52 * There is 3 main concepts in this module:
53 * - #trace: a set of dated values, ie a list of pair <timestamp, value>
54 * - #trace_iterator: links a given trace to a given simgrid resource. A Cpu for example has 2 iterators: state (ie, is it ON/OFF) and speed, while a link has 3 iterators: state, bandwidth and latency.
55 * - #future_evt_set: makes it easy to find the next occuring event of all traces
59 /** @brief A trace_iterator links a trace to a resource */
60 XBT_PUBLIC_CLASS trace_iterator {
64 /** @brief A trace is a set of timed values, encoding the value that a variable takes at what time *
66 * It is useful to model dynamic platforms, where an external load that makes the resource availability change over time.
67 * 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).
69 XBT_PUBLIC_CLASS trace {
71 /** Creates an empty trace */
75 std::vector<s_tmgr_event_t> event_list;
78 /** @brief Future Event Set (collection of iterators over the traces)
79 * That's useful to quickly know which is the next occurring event in a set of traces. */
80 XBT_PUBLIC_CLASS future_evt_set {
83 virtual ~future_evt_set();
84 double next_date() const;
85 tmgr_trace_iterator_t pop_leq(double date, double *value, simgrid::surf::Resource** resource);
86 tmgr_trace_iterator_t add_trace(tmgr_trace_t trace, double start_time, simgrid::surf::Resource *resource);
89 // TODO: use a boost type for the heap (or a ladder queue)
90 xbt_heap_t p_heap = xbt_heap_new(8, xbt_free_f); /* Content: only trace_events (yep, 8 is an arbitrary value) */
93 }} // namespace simgrid::trace_mgr
96 #endif /* SURF_TMGR_H */