1 /* Copyright (c) 2004-2007, 2009-2014. The SimGrid Team.
2 * All rights reserved. */
4 /* This program is free software; you can redistribute it and/or modify it
5 * under the terms of the license (GNU LGPL) which comes with this package. */
11 #include "simgrid/forward.h"
16 typedef struct tmgr_event {
19 } s_tmgr_event_t, *tmgr_event_t;
21 typedef struct tmgr_trace {
22 xbt_dynar_t event_list;
25 /* Iterator within a trace */
26 typedef struct tmgr_trace_iterator {
29 sg_resource_t resource;
31 } s_tmgr_trace_event_t;
32 typedef struct tmgr_trace_iterator *tmgr_trace_iterator_t;
34 /* Creation functions */
35 XBT_PUBLIC(tmgr_trace_t) tmgr_empty_trace_new(void);
36 XBT_PUBLIC(void) tmgr_trace_free(tmgr_trace_t trace);
38 * \brief Free a trace event structure
40 * This function frees a trace_event if it can be freed, ie, if it has the free_me flag set to 1.
41 * This flag indicates whether the structure is still used somewhere or not.
42 * When the structure is freed, the argument is set to nullptr
44 XBT_PUBLIC(void) tmgr_trace_event_unref(tmgr_trace_iterator_t *trace_event);
46 XBT_PUBLIC(void) tmgr_finalize(void);
48 XBT_PUBLIC(tmgr_trace_t) tmgr_trace_new_from_file(const char *filename);
49 XBT_PUBLIC(tmgr_trace_t) tmgr_trace_new_from_string(const char *id, const char *input, double periodicity);
55 /** @brief Modeling of the resource variations, such as those due to an external load
57 * There is 3 main concepts in this module:
58 * - #trace: a set of dated values, ie a list of pair <timestamp, value>
59 * - #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.
60 * - #future_evt_set: makes it easy to find the next occuring event of all traces
64 /** @brief A trace_iterator links a trace to a resource */
65 XBT_PUBLIC_CLASS trace_iterator {
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, bandwidt and latency).
74 XBT_PUBLIC_CLASS trace {
76 /** Creates an empty trace */
81 /** @brief Future Event Set (collection of iterators over the traces)
82 * That's useful to quickly know which is the next occurring event in a set of traces. */
83 XBT_PUBLIC_CLASS future_evt_set {
86 virtual ~future_evt_set();
87 double next_date() const;
88 tmgr_trace_iterator_t pop_leq(double date, double *value, simgrid::surf::Resource** resource);
89 tmgr_trace_iterator_t add_trace(tmgr_trace_t trace, double start_time, simgrid::surf::Resource *resource);
92 // TODO: use a boost type for the heap (or a ladder queue)
93 xbt_heap_t p_heap = xbt_heap_new(8, xbt_free_f); /* Content: only trace_events (yep, 8 is an arbitrary value) */
96 }} // namespace simgrid::trace_mgr
99 #endif /* _SURF_TMGR_H */