include/simgrid/platf.h

   1 /* platf.h - Public interface to the SimGrid platforms                      */
   2
   3 /* Copyright (c) 2004-2014. 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 <xbt.h>
  13
  14 SG_BEGIN_DECL()
  15
  16 typedef void *sg_routing_link_t; /* FIXME:The actual type is model-dependent so use void* instead*/
  17 typedef struct RoutingEdge *sg_routing_edge_t;
  18
  19 XBT_PUBLIC(sg_routing_edge_t) sg_routing_edge_by_name_or_null(const char *name);
  20
  21 /** @ingroup SURF_interface
  22 * @brief Defines whether a given resource is working or not */
  23 typedef enum {
  24   SURF_RESOURCE_ON = 1,                   /**< Up & ready        */
  25   SURF_RESOURCE_OFF = 0                   /**< Down & broken     */
  26 } e_surf_resource_state_t;
  27
  28 typedef enum {
  29   SURF_LINK_FULLDUPLEX = 2,
  30   SURF_LINK_SHARED = 1,
  31   SURF_LINK_FATPIPE = 0
  32 } e_surf_link_sharing_policy_t;
  33
  34 typedef enum {
  35   SURF_TRACE_CONNECT_KIND_HOST_AVAIL = 4,
  36   SURF_TRACE_CONNECT_KIND_POWER = 3,
  37   SURF_TRACE_CONNECT_KIND_LINK_AVAIL = 2,
  38   SURF_TRACE_CONNECT_KIND_BANDWIDTH = 1,
  39   SURF_TRACE_CONNECT_KIND_LATENCY = 0
  40 } e_surf_trace_connect_kind_t;
  41
  42 typedef enum {
  43   SURF_PROCESS_ON_FAILURE_DIE = 1,
  44   SURF_PROCESS_ON_FAILURE_RESTART = 0
  45 } e_surf_process_on_failure_t;
  46
  47 typedef enum {
  48   SURF_CLUSTER_FAT_TREE=2,
  49   SURF_CLUSTER_FLAT = 1,
  50   SURF_CLUSTER_TORUS = 0
  51 } e_surf_cluster_topology_t;
  52
  53
  54 typedef struct tmgr_trace *tmgr_trace_t; /**< Opaque structure defining an availability trace */
  55
  56 /** opaque structure defining a event generator for availability based on a probability distribution */
  57 typedef struct probabilist_event_generator *probabilist_event_generator_t;
  58
  59 XBT_PUBLIC(tmgr_trace_t) tmgr_trace_new_from_file(const char *filename);
  60 XBT_PUBLIC(tmgr_trace_t) tmgr_trace_new_from_string(const char *id,
  61                                                     const char *input,
  62                                                     double periodicity);
  63
  64 XBT_PUBLIC(tmgr_trace_t) tmgr_trace_generator_value(const char *id,
  65                                               probabilist_event_generator_t date_generator,
  66                                               probabilist_event_generator_t value_generator);
  67 XBT_PUBLIC(tmgr_trace_t) tmgr_trace_generator_state(const char *id,
  68                                               probabilist_event_generator_t date_generator,
  69                                               e_surf_resource_state_t first_event_value);
  70 XBT_PUBLIC(tmgr_trace_t) tmgr_trace_generator_avail_unavail(const char *id,
  71                                               probabilist_event_generator_t avail_duration_generator,
  72                                               probabilist_event_generator_t unavail_duration_generator,
  73                                               e_surf_resource_state_t first_event_value);
  74
  75 XBT_PUBLIC(probabilist_event_generator_t) tmgr_event_generator_new_uniform(const char* id,
  76                                                                            double min,
  77                                                                            double max);
  78 XBT_PUBLIC(probabilist_event_generator_t) tmgr_event_generator_new_exponential(const char* id,
  79                                                                            double rate);
  80 XBT_PUBLIC(probabilist_event_generator_t) tmgr_event_generator_new_weibull(const char* id,
  81                                                                            double scale,
  82                                                                            double shape);
  83
  84 typedef xbt_dictelm_t sg_host_t;
  85 static inline char* sg_host_name(sg_host_t host) {
  86   return host->key;
  87 }
  88
  89 typedef xbt_dictelm_t sg_storage_t;
  90 static inline char* sg_storage_name(sg_storage_t storage) {
  91   return storage->key;
  92 }
  93 /** @ingroup m_datatypes_management_details
  94  * @brief Type for any simgrid size
  95  */
  96 typedef unsigned long long sg_size_t;
  97
  98 /*
  99  * Platform creation functions. Instead of passing 123 arguments to the creation functions
 100  * (one for each possible XML attribute), we pass structures containing them all. It removes the
 101  * chances of switching arguments by error, and reduce the burden when we add a new attribute:
 102  * old models can just continue to ignore it without having to update their headers.
 103  *
 104  * It shouldn't be too costly at runtime, provided that structures living on the stack are
 105  * used, instead of malloced structures.
 106  */
 107
 108 typedef struct {
 109   const char* id;
 110   xbt_dynar_t power_peak;
 111   int pstate;
 112   int core_amount;
 113   double power_scale;
 114   tmgr_trace_t power_trace;
 115   e_surf_resource_state_t initial_state;
 116   tmgr_trace_t state_trace;
 117   const char* coord;
 118   xbt_dict_t properties;
 119 } s_sg_platf_host_cbarg_t, *sg_platf_host_cbarg_t;
 120
 121 #define SG_PLATF_HOST_INITIALIZER { \
 122     .id = NULL,\
 123     .power_peak = 0,\
 124     .core_amount = 1.,\
 125     .power_scale = 1,\
 126     .initial_state = SURF_RESOURCE_ON,\
 127     .power_trace = NULL,\
 128     .state_trace = NULL,\
 129     .coord = NULL,\
 130     .properties = NULL\
 131     }
 132
 133 typedef struct {
 134   const char* id;
 135   const char* link_up;
 136   const char* link_down;
 137 } s_sg_platf_host_link_cbarg_t, *sg_platf_host_link_cbarg_t;
 138
 139 #define SG_PLATF_HOST_LINK_INITIALIZER {NULL,NULL,NULL}
 140
 141 typedef struct {
 142   const char* id;
 143   const char* coord;
 144 } s_sg_platf_router_cbarg_t, *sg_platf_router_cbarg_t;
 145
 146 #define SG_PLATF_ROUTER_INITIALIZER {NULL,NULL}
 147
 148 typedef struct {
 149   const char* id;
 150   double bandwidth;
 151   tmgr_trace_t bandwidth_trace;
 152   double latency;
 153   tmgr_trace_t latency_trace;
 154   e_surf_resource_state_t state;
 155   tmgr_trace_t state_trace;
 156   e_surf_link_sharing_policy_t policy;
 157   xbt_dict_t properties;
 158 } s_sg_platf_link_cbarg_t, *sg_platf_link_cbarg_t;
 159
 160 #define SG_PLATF_LINK_INITIALIZER {\
 161   .id = NULL,\
 162   .bandwidth = 0.,\
 163   .bandwidth_trace = NULL,\
 164   .latency = 0.,\
 165   .latency_trace = NULL,\
 166   .state = SURF_RESOURCE_ON,\
 167   .state_trace = NULL,\
 168   .policy = SURF_LINK_SHARED,\
 169   .properties = NULL\
 170 }
 171
 172 typedef struct s_sg_platf_peer_cbarg *sg_platf_peer_cbarg_t;
 173 typedef struct s_sg_platf_peer_cbarg {
 174   const char* id;
 175   double power;
 176   double bw_in;
 177   double bw_out;
 178   double lat;
 179   const char* coord;
 180   tmgr_trace_t availability_trace;
 181   tmgr_trace_t state_trace;
 182 } s_sg_platf_peer_cbarg_t;
 183
 184 #define SG_PLATF_PEER_INITIALIZER {NULL,NULL,NULL,NULL,NULL,NULL,NULL,NULL}
 185
 186 typedef struct s_sg_platf_route_cbarg *sg_platf_route_cbarg_t;
 187 typedef struct s_sg_platf_route_cbarg {
 188   int symmetrical;
 189   const char *src;
 190   const char *dst;
 191   sg_routing_edge_t gw_src;
 192   sg_routing_edge_t gw_dst;
 193   xbt_dynar_t link_list;
 194 } s_sg_platf_route_cbarg_t;
 195
 196 #define SG_PLATF_ROUTE_INITIALIZER {TRUE,NULL,NULL,NULL,NULL,NULL}
 197
 198 typedef struct s_sg_platf_cluster_cbarg *sg_platf_cluster_cbarg_t;
 199 typedef struct s_sg_platf_cluster_cbarg {
 200   const char* id;
 201   const char* prefix;
 202   const char* suffix;
 203   const char* radical;
 204   double power;
 205   int core_amount;
 206   double bw;
 207   double lat;
 208   double bb_bw;
 209   double bb_lat;
 210   double loopback_bw;
 211   double loopback_lat;
 212   double limiter_link;
 213   e_surf_cluster_topology_t topology;
 214   const char* topo_parameters;
 215   xbt_dict_t properties;
 216   const char* router_id;
 217   e_surf_link_sharing_policy_t sharing_policy;
 218   e_surf_link_sharing_policy_t bb_sharing_policy;
 219   const char* availability_trace; //don't convert to tmgr_trace_t since there is a trace per host and some rewriting is needed
 220   const char* state_trace;
 221 } s_sg_platf_cluster_cbarg_t;
 222
 223 #define SG_PLATF_CLUSTER_INITIALIZER {NULL,NULL,NULL,NULL,NULL,NULL \
 224   ,NULL,NULL,NULL,NULL,NULL,NULL,NULL,NULL,NULL,NULL}
 225
 226 typedef struct s_sg_platf_cabinet_cbarg *sg_platf_cabinet_cbarg_t;
 227 typedef struct s_sg_platf_cabinet_cbarg {
 228   const char* id;
 229   const char* prefix;
 230   const char* suffix;
 231   const char* radical;
 232   double power;
 233   double bw;
 234   double lat;
 235 } s_sg_platf_cabinet_cbarg_t;
 236
 237 #define SG_PLATF_CABINET_INITIALIZER {NULL,NULL,NULL,NULL,NULL,NULL,NULL}
 238
 239 typedef struct {
 240   const char* id;
 241   const char* type_id;
 242   const char* content;
 243   const char* content_type;
 244   xbt_dict_t properties;
 245   const char* attach;
 246 } s_sg_platf_storage_cbarg_t, *sg_platf_storage_cbarg_t;
 247
 248 #define SG_PLATF_STORAGE_INITIALIZER {NULL,NULL,NULL,NULL}
 249
 250 typedef struct {
 251   const char* id;
 252   const char* model;
 253   const char* content;
 254   const char* content_type;
 255   xbt_dict_t properties;
 256   xbt_dict_t model_properties;
 257   sg_size_t size;
 258 } s_sg_platf_storage_type_cbarg_t, *sg_platf_storage_type_cbarg_t;
 259
 260 #define SG_PLATF_STORAGE_TYPE_INITIALIZER {NULL,NULL,NULL,NULL,NULL}
 261
 262 typedef struct {
 263   const char* type_id;
 264   const char* name;
 265 } s_sg_platf_mstorage_cbarg_t, *sg_platf_mstorage_cbarg_t;
 266
 267 #define SG_PLATF_MSTORAGE_INITIALIZER {NULL,NULL}
 268
 269 typedef struct {
 270   const char* storageId;
 271   const char* name;
 272 } s_sg_platf_mount_cbarg_t, *sg_platf_mount_cbarg_t;
 273
 274 #define SG_PLATF_MOUNT_INITIALIZER {NULL,NULL}
 275
 276 typedef struct s_sg_platf_prop_cbarg *sg_platf_prop_cbarg_t;
 277 typedef struct s_sg_platf_prop_cbarg {
 278   const char *id;
 279   const char *value;
 280 } s_sg_platf_prop_cbarg_t;
 281
 282 #define SG_PLATF_PROP_INITIALIZER {NULL,NULL}
 283
 284 typedef struct s_sg_platf_trace_cbarg *sg_platf_trace_cbarg_t;
 285 typedef struct s_sg_platf_trace_cbarg {
 286   const char *id;
 287   const char *file;
 288   double periodicity;
 289   const char *pc_data;
 290 } s_sg_platf_trace_cbarg_t;
 291
 292 #define SG_PLATF_TRACE_INITIALIZER {NULL,NULL,NULL,NULL}
 293
 294 typedef struct s_sg_platf_trace_connect_cbarg *sg_platf_trace_connect_cbarg_t;
 295 typedef struct s_sg_platf_trace_connect_cbarg {
 296   e_surf_trace_connect_kind_t kind;
 297   const char *trace;
 298   const char *element;
 299 } s_sg_platf_trace_connect_cbarg_t;
 300
 301 #define SG_PLATF_TRACE_CONNECT_INITIALIZER {NULL,NULL,NULL}
 302
 303 typedef struct s_sg_platf_process_cbarg *sg_platf_process_cbarg_t;
 304 typedef struct s_sg_platf_process_cbarg {
 305   const char **argv;
 306   int argc;
 307   xbt_dict_t properties;
 308   const char *host;
 309   const char *function;
 310   double start_time;
 311   double kill_time;
 312   e_surf_process_on_failure_t on_failure;
 313 } s_sg_platf_process_cbarg_t;
 314
 315 #define SG_PLATF_PROCESS_INITIALIZER {NULL,NULL,NULL,NULL,NULL,NULL,NULL,NULL}
 316
 317 typedef struct s_sg_platf_AS_cbarg *sg_platf_AS_cbarg_t;
 318 typedef struct s_sg_platf_AS_cbarg {
 319   const char *id;
 320   int routing;
 321 } s_sg_platf_AS_cbarg_t;
 322
 323 #define SG_PLATF_AS_INITIALIZER {NULL,0}
 324
 325 /* ***************************************** */
 326 /* TUTORIAL: New TAG                         */
 327
 328 typedef struct s_sg_platf_gpu_cbarg *sg_platf_gpu_cbarg_t;
 329 typedef struct s_sg_platf_gpu_cbarg {
 330   const char *name;
 331 } s_sg_platf_gpu_cbarg_t;
 332
 333 #define SG_PLATF_GPU_INITIALIZER {NULL}
 334
 335
 336 /* ***************************************** */
 337
 338 XBT_PUBLIC(void) sg_platf_begin(void);  // Start a new platform
 339 XBT_PUBLIC(void) sg_platf_end(void); // Finish the creation of the platform
 340
 341 XBT_PUBLIC(void) sg_platf_new_AS_begin(sg_platf_AS_cbarg_t AS); // Begin description of new AS
 342 XBT_PUBLIC(void) sg_platf_new_AS_end(void);                            // That AS is fully described
 343
 344 XBT_PUBLIC(void) sg_platf_new_host   (sg_platf_host_cbarg_t   host);   // Add an host   to the currently described AS
 345 XBT_PUBLIC(void) sg_platf_new_host_link(sg_platf_host_link_cbarg_t h); // Add an host_link to the currently described AS
 346 XBT_PUBLIC(void) sg_platf_new_router (sg_platf_router_cbarg_t router); // Add a router  to the currently described AS
 347 XBT_PUBLIC(void) sg_platf_new_link   (sg_platf_link_cbarg_t link);     // Add a link    to the currently described AS
 348 XBT_PUBLIC(void) sg_platf_new_peer   (sg_platf_peer_cbarg_t peer);     // Add a peer    to the currently described AS
 349 XBT_PUBLIC(void) sg_platf_new_cluster(sg_platf_cluster_cbarg_t clust); // Add a cluster to the currently described AS
 350 XBT_PUBLIC(void) sg_platf_new_cabinet(sg_platf_cabinet_cbarg_t cabinet); // Add a cabinet to the currently described AS
 351
 352 XBT_PUBLIC(void) sg_platf_new_route (sg_platf_route_cbarg_t route); // Add a route
 353 XBT_PUBLIC(void) sg_platf_new_ASroute (sg_platf_route_cbarg_t ASroute); // Add an ASroute
 354 XBT_PUBLIC(void) sg_platf_new_bypassRoute (sg_platf_route_cbarg_t bypassroute); // Add a bypassRoute
 355 XBT_PUBLIC(void) sg_platf_new_bypassASroute (sg_platf_route_cbarg_t bypassASroute); // Add an bypassASroute
 356 XBT_PUBLIC(void) sg_platf_new_prop (sg_platf_prop_cbarg_t prop); // Add a prop
 357
 358 XBT_PUBLIC(void) sg_platf_new_trace(sg_platf_trace_cbarg_t trace);
 359 XBT_PUBLIC(void) sg_platf_trace_connect(sg_platf_trace_connect_cbarg_t trace_connect);
 360
 361 XBT_PUBLIC(void) sg_platf_new_storage(sg_platf_storage_cbarg_t storage); // Add a storage to the currently described AS
 362 XBT_PUBLIC(void) sg_platf_new_storage(sg_platf_storage_cbarg_t storage); // Add a storage to the currently described AS
 363 XBT_PUBLIC(void) sg_platf_new_mstorage(sg_platf_mstorage_cbarg_t mstorage);
 364 XBT_PUBLIC(void) sg_platf_new_storage_type(sg_platf_storage_type_cbarg_t storage_type);
 365 XBT_PUBLIC(void) sg_platf_new_mount(sg_platf_mount_cbarg_t mount);
 366
 367 XBT_PUBLIC(void) sg_platf_new_process(sg_platf_process_cbarg_t process);
 368
 369 /* ***************************************** */
 370 /* TUTORIAL: New TAG                         */
 371 XBT_PUBLIC(void) sg_platf_new_gpu(sg_platf_gpu_cbarg_t gpu);
 372 /* ***************************************** */
 373
 374 // Add route and Asroute without xml file with those functions
 375 XBT_PUBLIC(void) sg_platf_route_begin (sg_platf_route_cbarg_t route); // Initialize route
 376 XBT_PUBLIC(void) sg_platf_route_end (sg_platf_route_cbarg_t route); // Finalize and add a route
 377
 378 XBT_PUBLIC(void) sg_platf_ASroute_begin (sg_platf_route_cbarg_t ASroute); // Initialize ASroute
 379 XBT_PUBLIC(void) sg_platf_ASroute_end (sg_platf_route_cbarg_t ASroute); // Finalize and add a ASroute
 380
 381 XBT_PUBLIC(void) sg_platf_route_add_link (const char* link_id, sg_platf_route_cbarg_t route); // Add a link to link list
 382 XBT_PUBLIC(void) sg_platf_ASroute_add_link (const char* link_id, sg_platf_route_cbarg_t ASroute); // Add a link to link list
 383
 384 typedef void (*sg_platf_process_cb_t)(sg_platf_process_cbarg_t);
 385 XBT_PUBLIC(void) sg_platf_process_add_cb(sg_platf_process_cb_t fct);
 386
 387 SG_END_DECL()
 388
 389 #endif                          /* SG_PLATF_H */