src/surf/surf_private.h

   1 /* Copyright (c) 2004-2015. 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_SURF_PRIVATE_H
   8 #define _SURF_SURF_PRIVATE_H
   9
  10 #include <xbt/base.h>
  11
  12 #include "surf/surf.h"
  13 #include "surf/maxmin.h"
  14 #include "surf/trace_mgr.h"
  15 #include "xbt/log.h"
  16 #include "surf/surfxml_parse.h"
  17 #include "surf/random_mgr.h"
  18 #include "src/instr/instr_private.h"
  19 #include "surf/surfxml_parse_values.h"
  20
  21 #define NO_MAX_DURATION -1.0
  22
  23 SG_BEGIN_DECL()
  24
  25 XBT_PUBLIC_DATA(xbt_dict_t) watched_hosts_lib;
  26
  27 extern XBT_PRIVATE const char *surf_action_state_names[6];
  28
  29 /** @ingroup SURF_interface
  30  * @brief Possible update mechanisms
  31  */
  32 typedef enum {
  33   UM_FULL,      /**< [TODO] */
  34   UM_LAZY,      /**< [TODO] */
  35   UM_UNDEFINED  /**< Mechanism not defined */
  36 } e_UM_t;
  37
  38 /* Generic functions common to all models */
  39
  40 XBT_PRIVATE FILE *surf_fopen(const char *name, const char *mode);
  41
  42 extern XBT_PRIVATE tmgr_history_t history;
  43
  44 /* The __surf_is_absolute_file_path() returns 1 if
  45  * file_path is a absolute file path, in the other
  46  * case the function returns 0.
  47  */
  48 XBT_PRIVATE int __surf_is_absolute_file_path(const char *file_path);
  49
  50 /**
  51  * Routing logic
  52  */
  53
  54 typedef struct s_model_type {
  55   const char *name;
  56   const char *desc;
  57   AS_t (*create) ();
  58   void (*end) (AS_t as);
  59 } s_routing_model_description_t, *routing_model_description_t;
  60
  61 /* This enum used in the routing structure helps knowing in which situation we are. */
  62 typedef enum {
  63   SURF_ROUTING_NULL = 0,   /**< Undefined type                                   */
  64   SURF_ROUTING_BASE,       /**< Base case: use simple link lists for routing     */
  65   SURF_ROUTING_RECURSIVE   /**< Recursive case: also return gateway informations */
  66 } e_surf_routing_hierarchy_t;
  67
  68 XBT_PUBLIC(void) routing_model_create(void *loopback);
  69 XBT_PUBLIC(void) routing_exit(void);
  70 XBT_PUBLIC(void) storage_register_callbacks(void);
  71
  72 XBT_PRIVATE void routing_new_cluster(sg_platf_cluster_cbarg_t cluster);
  73
  74 XBT_PUBLIC(void) routing_register_callbacks(void);
  75 XBT_PUBLIC(void) generic_free_route(sg_platf_route_cbarg_t route); // FIXME rename to routing_route_free
  76  // FIXME: make previous function private to routing again?
  77
  78
  79 XBT_PUBLIC(void) routing_get_route_and_latency(sg_netcard_t src, sg_netcard_t dst,
  80                               xbt_dynar_t * route, double *latency);
  81
  82 XBT_PUBLIC(void) generic_get_graph(xbt_graph_t graph, xbt_dict_t nodes, xbt_dict_t edges, AS_t rc);
  83 /**
  84  * Resource protected methods
  85  */
  86 XBT_PUBLIC(void) surfxml_bufferstack_push(int _new);
  87 XBT_PUBLIC(void) surfxml_bufferstack_pop(int _new);
  88 XBT_PUBLIC(void) parse_after_config(void);
  89
  90 XBT_PUBLIC_DATA(int) surfxml_bufferstack_size;
  91
  92 /********** Tracing **********/
  93 /* from surf_instr.c */
  94 void TRACE_surf_host_set_speed(double date, const char *resource, double power);
  95 void TRACE_surf_link_set_bandwidth(double date, const char *resource, double bandwidth);
  96
  97 /********** Instr. **********/
  98
  99 XBT_PRIVATE void sg_instr_AS_begin(sg_platf_AS_cbarg_t AS);
 100 XBT_PRIVATE void sg_instr_new_router(sg_platf_router_cbarg_t router);
 101 XBT_PRIVATE void sg_instr_new_host(sg_platf_host_cbarg_t host);
 102 XBT_PRIVATE void sg_instr_AS_end(void);
 103
 104 SG_END_DECL()
 105
 106 #endif                          /* _SURF_SURF_PRIVATE_H */