1 /* Copyright (c) 2004-2005, 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. */
7 #include "xbt/sysdep.h"
11 #include "src/surf/trace_mgr.hpp"
12 #include "surf_private.h"
13 #include "xbt/RngStream.h"
16 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_trace, surf, "Surf trace management");
18 static xbt_dict_t trace_list = NULL;
20 simgrid::trace_mgr::future_evt_set::future_evt_set() {
23 simgrid::trace_mgr::future_evt_set::~future_evt_set()
25 xbt_heap_free(p_heap);
28 #if 0 /* probabilistic dead code. Should be reimplemented, not killed (please) */
30 * \brief Create a #tmgr_trace_t from probabilist generators
32 * This trace will generate an infinite set of events.
33 * It needs two #probabilist_event_generator_t. The date when the event are
34 * triggered is directed by date_generator, and will be interpreted as seconds.
35 * The value of the event is set by value_generator. The value should be between
38 * \param id The name of the trace
39 * \param date_generator The #probabilist_event_generator_t which generates the time
41 * \param generator2 The #probabilist_event_generator_t which generates the value
43 * \return The new #tmgr_trace_t
45 tmgr_trace_t tmgr_trace_generator_value(const char *id,
46 probabilist_event_generator_t date_generator,
47 probabilist_event_generator_t value_generator)
49 tmgr_trace_t trace = NULL;
51 trace = xbt_new0(s_tmgr_trace_t, 1);
52 trace->type = e_trace_probabilist;
54 trace->s_probabilist.event_generator[0] = date_generator;
55 trace->s_probabilist.event_generator[1] = value_generator;
56 trace->s_probabilist.is_state_trace = 0;
62 * \brief Create a #tmgr_trace_t from probabilist generators
64 * This trace will generate an infinite set of events. Value of the events
65 * will be alternatively 0 and 1, so this should be used as a state trace.
67 * \param id The name of the trace
68 * \param date_generator The #probabilist_event_generator_t which generates the time
70 * \param first_event_value Set the first event value
71 * \return The new #tmgr_trace_t
73 tmgr_trace_t tmgr_trace_generator_state(const char *id,
74 probabilist_event_generator_t date_generator,
75 int first_event_hostIsOn)
77 tmgr_trace_t trace = NULL;
79 trace = xbt_new0(s_tmgr_trace_t, 1);
80 trace->type = e_trace_probabilist;
82 trace->s_probabilist.event_generator[0] = date_generator;
83 trace->s_probabilist.event_generator[1] = date_generator;
84 trace->s_probabilist.is_state_trace = 1;
85 trace->s_probabilist.next_event = first_event_hostIsOn;
91 * \brief Create a #tmgr_trace_t from probabilist generators
93 * This trace will generate an infinite set of events. Value of the events
94 * will be alternatively 0 and 1, so this should be used as a state trace.
96 * \param id The name of the trace
97 * \param avail_duration_generator The #probabilist_event_generator_t which
98 * set the duration of the available state, (ie 1 value)
99 * \param unavail_duration_generator The #probabilist_event_generator_t which
100 * set the duration of the unavailable state, (ie 0 value)
101 * \param first_event_value Set the first event value
102 * \return The new #tmgr_trace_t
104 tmgr_trace_t tmgr_trace_generator_avail_unavail(const char *id,
105 probabilist_event_generator_t avail_duration_generator,
106 probabilist_event_generator_t unavail_duration_generator,
107 int first_event_hostIsOn)
109 tmgr_trace_t trace = NULL;
111 trace = xbt_new0(s_tmgr_trace_t, 1);
112 trace->type = e_trace_probabilist;
114 trace->s_probabilist.event_generator[0] = unavail_duration_generator;
115 trace->s_probabilist.event_generator[1] = avail_duration_generator;
116 trace->s_probabilist.is_state_trace = 1;
117 trace->s_probabilist.next_event = first_event_hostIsOn;
123 * \brief Create a new #probabilist_event_generator_t following the uniform distribution
125 * This generator will generate uniformly distributed random values between min and max
126 * The id is important : it controls the seed of the generator. So, generators with the
127 * same id and the same parameters will generate the same values.
129 * \param id The name of the generator
130 * \param min The minimal generated value
131 * \param max The maximal generated value
132 * \return a new #probabilist_event_generator_t
134 probabilist_event_generator_t tmgr_event_generator_new_uniform(const char* id,
138 probabilist_event_generator_t event_generator = NULL;
139 RngStream rng_stream = NULL;
141 rng_stream = sg_platf_rng_stream_get(id);
143 event_generator = xbt_new0(s_probabilist_event_generator_t, 1);
144 event_generator->type = e_generator_uniform;
145 event_generator->s_uniform_parameters.min = min;
146 event_generator->s_uniform_parameters.max = max;
147 event_generator->rng_stream = rng_stream;
149 tmgr_event_generator_next_value(event_generator);
151 return event_generator;
156 * \brief Create a new #probabilist_event_generator_t following the exponential distribution
158 * This generator will generate random values following the exponential distribution.
159 * The mean value is 1/rate .
160 * The id is important : it controls the seed of the generator. So, generators with the
161 * same id and the same parameters will generate the same values.
163 * \param id The name of the generator
164 * \param rate The rate parameter
165 * \return a new #probabilist_event_generator_t
167 probabilist_event_generator_t tmgr_event_generator_new_exponential(const char* id,
170 probabilist_event_generator_t event_generator = NULL;
171 RngStream rng_stream = NULL;
173 rng_stream = sg_platf_rng_stream_get(id);
175 event_generator = xbt_new0(s_probabilist_event_generator_t, 1);
176 event_generator->type = e_generator_exponential;
177 event_generator->s_exponential_parameters.rate = rate;
178 event_generator->rng_stream = rng_stream;
180 tmgr_event_generator_next_value(event_generator);
182 return event_generator;
186 * \brief Create a new #probabilist_event_generator_t following the weibull distribution
188 * This generator will generate random values following the weibull distribution.
189 * The id is important : it controls the seed of the generator. So, generators with the
190 * same id and the same parameters will generate the same values.
192 * \param id The name of the generator
193 * \param scale The scale parameter
194 * \param shape The shape parameter
195 * \return a new #probabilist_event_generator_t
197 probabilist_event_generator_t tmgr_event_generator_new_weibull(const char* id,
201 probabilist_event_generator_t event_generator = NULL;
202 RngStream rng_stream = NULL;
204 rng_stream = sg_platf_rng_stream_get(id);
206 event_generator = xbt_new0(s_probabilist_event_generator_t, 1);
207 event_generator->type = e_generator_weibull;
208 event_generator->s_weibull_parameters.scale = scale;
209 event_generator->s_weibull_parameters.shape = shape;
210 event_generator->rng_stream = rng_stream;
212 tmgr_event_generator_next_value(event_generator);
214 return event_generator;
217 * \brief Get the next random value of a #probabilist_event_generator_t
218 * \param generator The #probabilist_event_generator_t
219 * \return the next random value
221 double tmgr_event_generator_next_value(probabilist_event_generator_t generator)
224 switch(generator->type) {
225 case e_generator_uniform:
226 generator->next_value = (RngStream_RandU01(generator->rng_stream)
227 * (generator->s_uniform_parameters.max - generator->s_uniform_parameters.min))
228 + generator->s_uniform_parameters.min;
230 case e_generator_exponential:
231 generator->next_value = -log(RngStream_RandU01(generator->rng_stream))
232 / generator->s_exponential_parameters.rate;
234 case e_generator_weibull:
235 generator->next_value = generator->s_weibull_parameters.scale
236 * pow( -log(RngStream_RandU01(generator->rng_stream)),
237 1.0 / generator->s_weibull_parameters.shape );
240 return generator->next_value;
242 #endif /* probabilistic dead code */
244 tmgr_trace_t tmgr_trace_new_from_string(const char *id, const char *input,
247 tmgr_trace_t trace = NULL;
249 s_tmgr_event_t event;
250 tmgr_event_t last_event = NULL;
256 trace = (tmgr_trace_t)xbt_dict_get_or_null(trace_list, id);
258 XBT_WARN("Ignoring redefinition of trace %s", id);
263 xbt_assert(periodicity >= 0,
264 "Invalid periodicity %g (must be positive)", periodicity);
266 trace = xbt_new0(s_tmgr_trace_t, 1);
267 trace->event_list = xbt_dynar_new(sizeof(s_tmgr_event_t), NULL);
269 list = xbt_str_split(input, "\n\r");
271 xbt_dynar_foreach(list, cpt, val) {
273 xbt_str_trim(val, " \t\n\r\x0B");
274 if (val[0] == '#' || val[0] == '\0' || val[0] == '%')
277 if (sscanf(val, "PERIODICITY " "%lg" "\n", &periodicity) == 1)
280 if (sscanf(val, "%lg" " " "%lg" "\n", &event.delta, &event.value) != 2)
281 xbt_die("%s:%d: Syntax error in trace\n%s", id, linecount, input);
284 if (last_event->delta > event.delta) {
285 xbt_die("%s:%d: Invalid trace: Events must be sorted, "
286 "but time %g > time %g.\n%s",
287 id, linecount, last_event->delta, event.delta, input);
289 last_event->delta = event.delta - last_event->delta;
291 if(event.delta > 0.0){
292 s_tmgr_event_t first_event;
293 first_event.delta=event.delta;
294 first_event.value=-1.0;
295 xbt_dynar_push(trace->event_list, &first_event);
298 xbt_dynar_push(trace->event_list, &event);
299 last_event = (tmgr_event_t)xbt_dynar_get_ptr(trace->event_list, xbt_dynar_length(trace->event_list) - 1);
302 last_event->delta = periodicity;
305 trace_list = xbt_dict_new_homogeneous((void (*)(void *)) tmgr_trace_free);
307 xbt_dict_set(trace_list, id, (void *) trace, NULL);
309 xbt_dynar_free(&list);
313 tmgr_trace_t tmgr_trace_new_from_file(const char *filename)
315 tmgr_trace_t trace = NULL;
317 if ((!filename) || (strcmp(filename, "") == 0))
321 trace = (tmgr_trace_t)xbt_dict_get_or_null(trace_list, filename);
323 XBT_WARN("Ignoring redefinition of trace %s", filename);
328 FILE *f = surf_fopen(filename, "r");
329 xbt_assert(f != NULL,
330 "Cannot open file '%s' (path=%s)", filename, xbt_str_join(surf_path, ":"));
332 char *tstr = xbt_str_from_file(f);
334 trace = tmgr_trace_new_from_string(filename, tstr, 0.);
340 tmgr_trace_t tmgr_empty_trace_new(void)
342 tmgr_trace_t trace = NULL;
343 s_tmgr_event_t event;
345 trace = xbt_new0(s_tmgr_trace_t, 1);
346 trace->event_list = xbt_dynar_new(sizeof(s_tmgr_event_t), NULL);
350 xbt_dynar_push(trace->event_list, &event);
355 void tmgr_trace_free(tmgr_trace_t trace)
360 xbt_dynar_free(&(trace->event_list));
364 /** @brief Registers a new trace into the future event set, and get an iterator over the integrated trace */
365 tmgr_trace_iterator_t simgrid::trace_mgr::future_evt_set::add_trace(
366 tmgr_trace_t trace, double start_time, surf::Resource *resource)
368 tmgr_trace_iterator_t trace_iterator = NULL;
370 trace_iterator = xbt_new0(s_tmgr_trace_event_t, 1);
371 trace_iterator->trace = trace;
372 trace_iterator->idx = 0;
373 trace_iterator->resource = resource;
375 xbt_assert((trace_iterator->idx < xbt_dynar_length(trace->event_list)),
376 "Your trace should have at least one event!");
378 xbt_heap_push(p_heap, trace_iterator, start_time);
380 return trace_iterator;
383 /** @brief returns the date of the next occurring event (pure function) */
384 double simgrid::trace_mgr::future_evt_set::next_date() const
386 if (xbt_heap_size(p_heap))
387 return (xbt_heap_maxkey(p_heap));
392 /** @brief Retrieves the next occurring event, or NULL if none happens before #date */
393 tmgr_trace_iterator_t simgrid::trace_mgr::future_evt_set::pop_leq(
394 double date, double *value, simgrid::surf::Resource **resource)
396 double event_date = next_date();
397 if (event_date > date)
400 tmgr_trace_iterator_t trace_iterator = (tmgr_trace_iterator_t)xbt_heap_pop(p_heap);
401 if (trace_iterator == NULL)
404 tmgr_trace_t trace = trace_iterator->trace;
405 *resource = trace_iterator->resource;
407 tmgr_event_t event = (tmgr_event_t)xbt_dynar_get_ptr(trace->event_list, trace_iterator->idx);
409 *value = event->value;
411 if (trace_iterator->idx < xbt_dynar_length(trace->event_list) - 1) {
412 xbt_heap_push(p_heap, trace_iterator, event_date + event->delta);
413 trace_iterator->idx++;
414 } else if (event->delta > 0) { /* Last element, checking for periodicity */
415 xbt_heap_push(p_heap, trace_iterator, event_date + event->delta);
416 trace_iterator->idx = 1; /* not 0 as the first event is a placeholder to handle when events really start */
417 } else { /* We don't need this trace_event anymore */
418 trace_iterator->free_me = 1;
421 return trace_iterator;
424 void tmgr_finalize(void)
426 xbt_dict_free(&trace_list);
429 void tmgr_trace_event_unref(tmgr_trace_iterator_t *trace_event)
431 if ((*trace_event)->free_me) {
432 xbt_free(*trace_event);
433 *trace_event = nullptr;