include/simgrid/platf.h

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