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 "xbt/dynar.h"
  12 #include "surf/maxmin.h"
  13 #include "surf/datatypes.h"
  14 #include "simgrid/forward.h"
  15
  16 SG_BEGIN_DECL()
  17 #include "xbt/base.h"
  18 #include "xbt/swag.h"
  19 #include "xbt/heap.h"
  20 #include "trace_mgr.hpp"
  21 #include "xbt/RngStream.h"
  22
  23 typedef struct tmgr_event {
  24   double delta;
  25   double value;
  26 } s_tmgr_event_t, *tmgr_event_t;
  27
  28 enum e_trace_type {
  29   e_trace_list, e_trace_probabilist
  30 };
  31
  32 enum e_event_generator_type {
  33   e_generator_uniform, e_generator_exponential, e_generator_weibull
  34 };
  35
  36 typedef struct probabilist_event_generator {
  37   enum e_event_generator_type type;
  38   RngStream rng_stream;
  39   double next_value;
  40   union {
  41     struct {
  42       double min;
  43       double max;
  44     } s_uniform_parameters;
  45     struct {
  46       double rate;
  47     } s_exponential_parameters;
  48     struct {
  49       double scale;
  50       double shape;
  51     } s_weibull_parameters;
  52   };
  53 } s_probabilist_event_generator_t;
  54
  55 typedef struct tmgr_trace {
  56   xbt_dynar_t event_list;
  57 } s_tmgr_trace_t;
  58
  59 /* Iterator within a trace */
  60 typedef struct tmgr_trace_iterator {
  61   tmgr_trace_t trace;
  62   unsigned int idx;
  63   sg_resource_t resource;
  64   int free_me;
  65 } s_tmgr_trace_event_t;
  66
  67 /* Creation functions */
  68 XBT_PUBLIC(tmgr_trace_t) tmgr_empty_trace_new(void);
  69 XBT_PUBLIC(void) tmgr_trace_free(tmgr_trace_t trace);
  70 /**
  71  * \brief Free a trace event structure
  72  *
  73  * This function frees a trace_event if it can be freed, ie, if it has the free_me flag set to 1.
  74  * This flag indicates whether the structure is still used somewhere or not.
  75  * When the structure is freed, the argument is set to nullptr
  76 */
  77 XBT_PUBLIC(void) tmgr_trace_event_unref(tmgr_trace_iterator_t *trace_event);
  78
  79 XBT_PUBLIC(void) tmgr_finalize(void);
  80
  81 XBT_PUBLIC(tmgr_trace_t) tmgr_trace_new_from_file(const char *filename);
  82 XBT_PUBLIC(tmgr_trace_t) tmgr_trace_new_from_string(const char *id, const char *input, double periodicity);
  83
  84 SG_END_DECL()
  85
  86 #ifdef __cplusplus
  87 namespace simgrid {
  88 /** @brief Modeling of the resource variations, such as those due to an external load
  89  *
  90  * There is 3 main concepts in this module:
  91  * - #trace: a set of dated values, ie a list of pair <timestamp, value>
  92  * - #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.
  93  * - #future_evt_set: makes it easy to find the next occuring event of all traces
  94  */
  95   namespace trace_mgr {
  96
  97 /** @brief A trace_iterator links a trace to a resource */
  98 XBT_PUBLIC_CLASS trace_iterator {
  99
 100 };
 101
 102 /** @brief A trace is a set of timed values, encoding the value that a variable takes at what time *
 103  *
 104  * It is useful to model dynamic platforms, where an external load that makes the resource availability change over time.
 105  * 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).
 106  */
 107 XBT_PUBLIC_CLASS trace {
 108 public:
 109   /**  Creates an empty trace */
 110   trace() {}
 111   virtual ~trace() {}
 112 };
 113
 114 /** @brief Future Event Set (collection of iterators over the traces)
 115  * That's useful to quickly know which is the next occurring event in a set of traces. */
 116 XBT_PUBLIC_CLASS future_evt_set {
 117 public:
 118   future_evt_set();
 119   virtual ~future_evt_set();
 120   double next_date() const;
 121   tmgr_trace_iterator_t pop_leq(double date, double *value, simgrid::surf::Resource** resource);
 122   tmgr_trace_iterator_t add_trace(tmgr_trace_t trace, double start_time, simgrid::surf::Resource *resource);
 123
 124 private:
 125   // TODO: use a boost type for the heap (or a ladder queue)
 126   xbt_heap_t p_heap = xbt_heap_new(8, xbt_free_f); /* Content: only trace_events (yep, 8 is an arbitrary value) */
 127 };
 128
 129 }} // namespace simgrid::trace_mgr
 130 #endif /* C++ only */
 131
 132 #endif                          /* _SURF_TMGR_H */