src/include/surf/trace_mgr.h

   1 /* Copyright (c) 2004, 2005, 2006, 2007, 2009, 2010. 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/platf_interface.h"
  15
  16 /* Creation functions */
  17 XBT_PUBLIC(tmgr_history_t) tmgr_history_new(void);
  18 XBT_PUBLIC(void) tmgr_history_free(tmgr_history_t history);
  19
  20 XBT_PUBLIC(tmgr_trace_t) tmgr_trace_new(const char *filename);
  21 XBT_PUBLIC(tmgr_trace_t) tmgr_trace_new_from_string(const char *id,
  22                                                     const char *input,
  23                                                     double periodicity);
  24 XBT_PUBLIC(tmgr_trace_t) tmgr_empty_trace_new(void);
  25 XBT_INLINE XBT_PUBLIC(void) tmgr_trace_free(tmgr_trace_t trace);
  26 /**
  27  * \brief Free a trace event structure
  28  *
  29  * This function frees a trace_event if it can be freed, ie, if it has the free_me flag set to 1. This flag indicates whether the structure is still used somewhere or not.
  30  * \param       trace_event             Trace event structure
  31  * \return 1 if the structure was freed, 0 otherwise
  32 */
  33 XBT_PUBLIC(int) tmgr_trace_event_free(tmgr_trace_event_t trace_event);
  34
  35 XBT_PUBLIC(tmgr_trace_event_t) tmgr_history_add_trace(tmgr_history_t
  36                                                       history,
  37                                                       tmgr_trace_t trace,
  38                                                       double start_time,
  39                                                       unsigned int offset,
  40                                                       void *model);
  41
  42 /* Access functions */
  43 XBT_PUBLIC(double) tmgr_history_next_date(tmgr_history_t history);
  44 XBT_PUBLIC(tmgr_trace_event_t)
  45     tmgr_history_get_next_event_leq(tmgr_history_t history, double date,
  46                                 double *value, void **model);
  47
  48 XBT_PUBLIC(void) tmgr_finalize(void);
  49
  50 #endif                          /* _SURF_TMGR_H */