src/surf/xml/platf_private.hpp

   1 /* platf_private.h - Interface to the SimGrid platforms which visibility should be limited to this directory */
   2
   3 /* Copyright (c) 2004-2015. The SimGrid Team.
   4  * All rights reserved.                                                     */
   5
   6 /* This program is free software; you can redistribute it and/or modify it
   7  * under the terms of the license (GNU LGPL) which comes with this package. */
   8
   9 #ifndef SG_PLATF_H
  10 #define SG_PLATF_H
  11
  12 #include "simgrid/host.h"
  13 #include "src/surf/xml/platf.hpp"
  14 #include <map>
  15 #include <string>
  16 #include <vector>
  17
  18 SG_BEGIN_DECL()
  19 #include "src/surf/xml/simgrid_dtd.h"
  20
  21 #ifndef YY_TYPEDEF_YY_SIZE_T
  22 #define YY_TYPEDEF_YY_SIZE_T
  23 typedef size_t yy_size_t;
  24 #endif
  25
  26 typedef enum {
  27   SURF_CLUSTER_DRAGONFLY=3,
  28   SURF_CLUSTER_FAT_TREE=2,
  29   SURF_CLUSTER_FLAT = 1,
  30   SURF_CLUSTER_TORUS = 0
  31 } e_surf_cluster_topology_t;
  32
  33 /* ***************************************** */
  34 /*
  35  * Platform creation functions. Instead of passing 123 arguments to the creation functions
  36  * (one for each possible XML attribute), we pass structures containing them all. It removes the
  37  * chances of switching arguments by error, and reduce the burden when we add a new attribute:
  38  * old models can just continue to ignore it without having to update their headers.
  39  *
  40  * It shouldn't be too costly at runtime, provided that structures living on the stack are
  41  * used, instead of malloced structures.
  42  */
  43
  44 typedef struct {
  45   const char* id;
  46   std::vector<double> speed_per_pstate;
  47   int pstate;
  48   int core_amount;
  49   tmgr_trace_t speed_trace;
  50   tmgr_trace_t state_trace;
  51   const char* coord;
  52   xbt_dict_t properties;
  53 } s_sg_platf_host_cbarg_t;
  54 typedef s_sg_platf_host_cbarg_t* sg_platf_host_cbarg_t;
  55
  56 typedef struct {
  57   const char* id;
  58   const char* link_up;
  59   const char* link_down;
  60 } s_sg_platf_host_link_cbarg_t;
  61 typedef s_sg_platf_host_link_cbarg_t* sg_platf_host_link_cbarg_t;
  62
  63 class LinkCreationArgs {
  64 public:
  65   std::string id;
  66   double bandwidth                    = 0;
  67   tmgr_trace_t bandwidth_trace        = nullptr;
  68   double latency                      = 0;
  69   tmgr_trace_t latency_trace          = nullptr;
  70   tmgr_trace_t state_trace            = nullptr;
  71   e_surf_link_sharing_policy_t policy = SURF_LINK_FATPIPE;
  72   xbt_dict_t properties               = nullptr;
  73 };
  74
  75 typedef struct s_sg_platf_peer_cbarg *sg_platf_peer_cbarg_t;
  76 typedef struct s_sg_platf_peer_cbarg {
  77   const char* id;
  78   double speed;
  79   double bw_in;
  80   double bw_out;
  81   const char* coord;
  82   tmgr_trace_t speed_trace;
  83   tmgr_trace_t state_trace;
  84 } s_sg_platf_peer_cbarg_t;
  85
  86 typedef struct s_sg_platf_route_cbarg *sg_platf_route_cbarg_t;
  87 typedef struct s_sg_platf_route_cbarg {
  88   bool symmetrical;
  89   sg_netpoint_t src;
  90   sg_netpoint_t dst;
  91   sg_netpoint_t gw_src;
  92   sg_netpoint_t gw_dst;
  93   std::vector<simgrid::surf::LinkImpl*>* link_list;
  94 } s_sg_platf_route_cbarg_t;
  95
  96 typedef struct s_sg_platf_cluster_cbarg *sg_platf_cluster_cbarg_t;
  97 typedef struct s_sg_platf_cluster_cbarg {
  98   const char* id;
  99   const char* prefix;
 100   const char* suffix;
 101   std::vector<int>* radicals;
 102   std::vector<double> speeds;
 103   int core_amount;
 104   double bw;
 105   double lat;
 106   double bb_bw;
 107   double bb_lat;
 108   double loopback_bw;
 109   double loopback_lat;
 110   double limiter_link;
 111   e_surf_cluster_topology_t topology;
 112   const char* topo_parameters;
 113   xbt_dict_t properties;
 114   const char* router_id;
 115   e_surf_link_sharing_policy_t sharing_policy;
 116   e_surf_link_sharing_policy_t bb_sharing_policy;
 117 } s_sg_platf_cluster_cbarg_t;
 118
 119 typedef struct s_sg_platf_cabinet_cbarg* sg_platf_cabinet_cbarg_t;
 120 typedef struct s_sg_platf_cabinet_cbarg {
 121   const char* id;
 122   const char* prefix;
 123   const char* suffix;
 124   std::vector<int>* radicals;
 125   double speed;
 126   double bw;
 127   double lat;
 128 } s_sg_platf_cabinet_cbarg_t;
 129
 130 typedef struct s_sg_platf_storage_cbarg* sg_platf_storage_cbarg_t;
 131 typedef struct s_sg_platf_storage_cbarg {
 132   const char* id;
 133   const char* type_id;
 134   const char* content;
 135   xbt_dict_t properties;
 136   const char* attach;
 137 } s_sg_platf_storage_cbarg_t;
 138
 139 typedef struct s_sg_platf_storage_type_cbarg* sg_platf_storage_type_cbarg_t;
 140 typedef struct s_sg_platf_storage_type_cbarg {
 141   const char* id;
 142   const char* model;
 143   const char* content;
 144   xbt_dict_t properties;
 145   std::map<std::string, std::string>* model_properties;
 146   sg_size_t size;
 147 } s_sg_platf_storage_type_cbarg_t;
 148
 149 typedef struct s_sg_platf_mount_cbarg* sg_platf_mount_cbarg_t;
 150 typedef struct s_sg_platf_mount_cbarg {
 151   const char* storageId;
 152   const char* name;
 153 } s_sg_platf_mount_cbarg_t;
 154
 155 typedef struct s_sg_platf_prop_cbarg *sg_platf_prop_cbarg_t;
 156 typedef struct s_sg_platf_prop_cbarg {
 157   const char *id;
 158   const char *value;
 159 } s_sg_platf_prop_cbarg_t;
 160
 161 typedef struct s_sg_platf_trace_cbarg *sg_platf_trace_cbarg_t;
 162 typedef struct s_sg_platf_trace_cbarg {
 163   const char *id;
 164   const char *file;
 165   double periodicity;
 166   const char *pc_data;
 167 } s_sg_platf_trace_cbarg_t;
 168
 169 typedef struct s_sg_platf_trace_connect_cbarg *sg_platf_trace_connect_cbarg_t;
 170 typedef struct s_sg_platf_trace_connect_cbarg {
 171   e_surf_trace_connect_kind_t kind;
 172   const char *trace;
 173   const char *element;
 174 } s_sg_platf_trace_connect_cbarg_t;
 175
 176 typedef struct s_sg_platf_process_cbarg *sg_platf_process_cbarg_t;
 177 typedef struct s_sg_platf_process_cbarg {
 178   const char **argv;
 179   int argc;
 180   xbt_dict_t properties;
 181   const char *host;
 182   const char *function;
 183   double start_time;
 184   double kill_time;
 185   e_surf_process_on_failure_t on_failure;
 186 } s_sg_platf_process_cbarg_t;
 187
 188 typedef struct s_sg_platf_AS_cbarg *sg_platf_AS_cbarg_t;
 189 typedef struct s_sg_platf_AS_cbarg {
 190   const char *id;
 191   int routing;
 192 } s_sg_platf_AS_cbarg_t;
 193
 194 #define SG_PLATF_AS_INITIALIZER {nullptr,0}
 195
 196 /********** Routing **********/
 197 void routing_cluster_add_backbone(simgrid::surf::LinkImpl* bb);
 198 /*** END of the parsing cruft ***/
 199
 200 XBT_PUBLIC(void) sg_platf_begin();  // Start a new platform
 201 XBT_PUBLIC(void) sg_platf_end(); // Finish the creation of the platform
 202
 203 XBT_PUBLIC(simgrid::s4u::NetZone*) sg_platf_new_AS_begin(sg_platf_AS_cbarg_t AS); // Begin description of new AS
 204 XBT_PUBLIC(void) sg_platf_new_AS_seal();                     // That AS is fully described
 205
 206 XBT_PUBLIC(void) sg_platf_new_host   (sg_platf_host_cbarg_t   host);   // Add an host   to the currently described AS
 207 XBT_PUBLIC(void) sg_platf_new_hostlink(sg_platf_host_link_cbarg_t h); // Add an host_link to the currently described AS
 208 XBT_PUBLIC(simgrid::kernel::routing::NetPoint*)
 209 sg_platf_new_router(const char* name, const char* coords);             // Add a router  to the currently described AS
 210 XBT_PUBLIC(void) sg_platf_new_link(LinkCreationArgs* link);            // Add a link    to the currently described AS
 211 XBT_PUBLIC(void) sg_platf_new_peer   (sg_platf_peer_cbarg_t peer);     // Add a peer    to the currently described AS
 212 XBT_PUBLIC(void) sg_platf_new_cluster(sg_platf_cluster_cbarg_t clust); // Add a cluster to the currently described AS
 213 XBT_PUBLIC(void) sg_platf_new_cabinet(sg_platf_cabinet_cbarg_t cabinet); // Add a cabinet to the currently described AS
 214
 215 XBT_PUBLIC(void) sg_platf_new_route (sg_platf_route_cbarg_t route); // Add a route
 216 XBT_PUBLIC(void) sg_platf_new_bypassRoute (sg_platf_route_cbarg_t bypassroute); // Add a bypassRoute
 217
 218 XBT_PUBLIC(void) sg_platf_new_trace(sg_platf_trace_cbarg_t trace);
 219
 220 XBT_PUBLIC(void) sg_platf_new_storage(sg_platf_storage_cbarg_t storage); // Add a storage to the currently described AS
 221 XBT_PUBLIC(void) sg_platf_new_storage_type(sg_platf_storage_type_cbarg_t storage_type);
 222 XBT_PUBLIC(void) sg_platf_new_mount(sg_platf_mount_cbarg_t mount);
 223
 224 XBT_PUBLIC(void) sg_platf_new_process(sg_platf_process_cbarg_t process);
 225 XBT_PRIVATE void sg_platf_trace_connect(sg_platf_trace_connect_cbarg_t trace_connect);
 226
 227 /* Prototypes of the functions offered by flex */
 228 XBT_PUBLIC(int) surf_parse_lex();
 229 XBT_PUBLIC(int) surf_parse_get_lineno();
 230 XBT_PUBLIC(FILE *) surf_parse_get_in();
 231 XBT_PUBLIC(FILE *) surf_parse_get_out();
 232 XBT_PUBLIC(int) surf_parse_get_leng();
 233 XBT_PUBLIC(char *) surf_parse_get_text();
 234 XBT_PUBLIC(void) surf_parse_set_lineno(int line_number);
 235 XBT_PUBLIC(void) surf_parse_set_in(FILE * in_str);
 236 XBT_PUBLIC(void) surf_parse_set_out(FILE * out_str);
 237 XBT_PUBLIC(int) surf_parse_get_debug();
 238 XBT_PUBLIC(void) surf_parse_set_debug(int bdebug);
 239 XBT_PUBLIC(int) surf_parse_lex_destroy();
 240
 241 /* To include files (?) */
 242 XBT_PRIVATE void surfxml_bufferstack_push(int _new);
 243 XBT_PRIVATE void surfxml_bufferstack_pop(int _new);
 244 XBT_PUBLIC_DATA(int) surfxml_bufferstack_size;
 245
 246 XBT_PUBLIC(void) routing_route_free(sg_platf_route_cbarg_t route);
 247 /********** Instr. **********/
 248 XBT_PRIVATE void sg_instr_AS_begin(sg_platf_AS_cbarg_t AS);
 249 XBT_PRIVATE void sg_instr_new_router(const char* name);
 250 XBT_PRIVATE void sg_instr_new_host(simgrid::s4u::Host& host);
 251 XBT_PRIVATE void sg_instr_AS_end();
 252
 253 SG_END_DECL()
 254
 255 namespace simgrid {
 256 namespace surf {
 257
 258 extern XBT_PRIVATE simgrid::xbt::signal<void(sg_platf_cluster_cbarg_t)> on_cluster;
 259
 260 }
 261 }
 262
 263 #endif                          /* SG_PLATF_H */