src/surf/trace_mgr.hpp

   1 /* Copyright (c) 2004-2007, 2009-2014. The SimGrid Team.
   2  * All rights reserved.                                                     */
   3
   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. */
   6
   7 #ifndef _SURF_TMGR_H
   8 #define _SURF_TMGR_H
   9
  10 #include "xbt/heap.h"
  11 #include "simgrid/forward.h"
  12
  13 SG_BEGIN_DECL()
  14 #include "xbt/heap.h"
  15
  16 typedef struct tmgr_event {
  17   double delta;
  18   double value;
  19 } s_tmgr_event_t, *tmgr_event_t;
  20
  21 /* Iterator within a trace */
  22 typedef struct tmgr_trace_iterator {
  23   tmgr_trace_t trace;
  24   unsigned int idx;
  25   sg_resource_t resource;
  26   int free_me;
  27 } s_tmgr_trace_event_t;
  28 typedef struct tmgr_trace_iterator *tmgr_trace_iterator_t;
  29
  30 /* Creation functions */
  31 XBT_PUBLIC(tmgr_trace_t) tmgr_empty_trace_new(void);
  32 XBT_PUBLIC(void) tmgr_trace_free(tmgr_trace_t trace);
  33 /**
  34  * \brief Free a trace event structure
  35  *
  36  * This function frees a trace_event if it can be freed, ie, if it has the free_me flag set to 1.
  37  * This flag indicates whether the structure is still used somewhere or not.
  38  * When the structure is freed, the argument is set to nullptr
  39 */
  40 XBT_PUBLIC(void) tmgr_trace_event_unref(tmgr_trace_iterator_t *trace_event);
  41
  42 XBT_PUBLIC(void) tmgr_finalize(void);
  43
  44 XBT_PUBLIC(tmgr_trace_t) tmgr_trace_new_from_file(const char *filename);
  45 XBT_PUBLIC(tmgr_trace_t) tmgr_trace_new_from_string(const char *id, const char *input, double periodicity);
  46
  47 SG_END_DECL()
  48
  49 #ifdef __cplusplus
  50 namespace simgrid {
  51 /** @brief Modeling of the resource variations, such as those due to an external load
  52  *
  53  * There is 3 main concepts in this module:
  54  * - #trace: a set of dated values, ie a list of pair <timestamp, value>
  55  * - #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.
  56  * - #future_evt_set: makes it easy to find the next occuring event of all traces
  57  */
  58   namespace trace_mgr {
  59
  60 /** @brief A trace_iterator links a trace to a resource */
  61 XBT_PUBLIC_CLASS trace_iterator {
  62
  63 };
  64
  65 /** @brief A trace is a set of timed values, encoding the value that a variable takes at what time *
  66  *
  67  * It is useful to model dynamic platforms, where an external load that makes the resource availability change over time.
  68  * 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).
  69  */
  70 XBT_PUBLIC_CLASS trace {
  71 public:
  72   /**  Creates an empty trace */
  73   trace();
  74   virtual ~trace();
  75 //private:
  76   xbt_dynar_t event_list;
  77 };
  78
  79 /** @brief Future Event Set (collection of iterators over the traces)
  80  * That's useful to quickly know which is the next occurring event in a set of traces. */
  81 XBT_PUBLIC_CLASS future_evt_set {
  82 public:
  83   future_evt_set();
  84   virtual ~future_evt_set();
  85   double next_date() const;
  86   tmgr_trace_iterator_t pop_leq(double date, double *value, simgrid::surf::Resource** resource);
  87   tmgr_trace_iterator_t add_trace(tmgr_trace_t trace, double start_time, simgrid::surf::Resource *resource);
  88
  89 private:
  90   // TODO: use a boost type for the heap (or a ladder queue)
  91   xbt_heap_t p_heap = xbt_heap_new(8, xbt_free_f); /* Content: only trace_events (yep, 8 is an arbitrary value) */
  92 };
  93
  94 }} // namespace simgrid::trace_mgr
  95 #endif /* C++ only */
  96
  97 #endif                          /* _SURF_TMGR_H */