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 simgrid size */
  97 typedef unsigned long long sg_size_t;
  98
  99 /*
 100  * Platform creation functions. Instead of passing 123 arguments to the creation functions
 101  * (one for each possible XML attribute), we pass structures containing them all. It removes the
 102  * chances of switching arguments by error, and reduce the burden when we add a new attribute:
 103  * old models can just continue to ignore it without having to update their headers.
 104  *
 105  * It shouldn't be too costly at runtime, provided that structures living on the stack are
 106  * used, instead of malloced structures.
 107  */
 108
 109 typedef struct {
 110   const char* id;
 111   xbt_dynar_t power_peak;
 112   int pstate;
 113   int core_amount;
 114   double power_scale;
 115   tmgr_trace_t power_trace;
 116   e_surf_resource_state_t initial_state;
 117   tmgr_trace_t state_trace;
 118   const char* coord;
 119   xbt_dict_t properties;
 120 } s_sg_platf_host_cbarg_t, *sg_platf_host_cbarg_t;
 121
 122 #define SG_PLATF_HOST_INITIALIZER { \
 123     .id = NULL,\
 124     .power_peak = 0,\
 125     .core_amount = 1.,\
 126     .power_scale = 1,\
 127     .initial_state = SURF_RESOURCE_ON,\
 128     .power_trace = NULL,\
 129     .state_trace = NULL,\
 130     .coord = NULL,\
 131     .properties = NULL\
 132     }
 133
 134 typedef struct {
 135   const char* id;
 136   const char* link_up;
 137   const char* link_down;
 138 } s_sg_platf_host_link_cbarg_t, *sg_platf_host_link_cbarg_t;
 139
 140 #define SG_PLATF_HOST_LINK_INITIALIZER {NULL,NULL,NULL}
 141
 142 typedef struct {
 143   const char* id;
 144   const char* coord;
 145 } s_sg_platf_router_cbarg_t, *sg_platf_router_cbarg_t;
 146
 147 #define SG_PLATF_ROUTER_INITIALIZER {NULL,NULL}
 148
 149 typedef struct {
 150   const char* id;
 151   double bandwidth;
 152   tmgr_trace_t bandwidth_trace;
 153   double latency;
 154   tmgr_trace_t latency_trace;
 155   e_surf_resource_state_t state;
 156   tmgr_trace_t state_trace;
 157   e_surf_link_sharing_policy_t policy;
 158   xbt_dict_t properties;
 159 } s_sg_platf_link_cbarg_t, *sg_platf_link_cbarg_t;
 160
 161 #define SG_PLATF_LINK_INITIALIZER {\
 162   .id = NULL,\
 163   .bandwidth = 0.,\
 164   .bandwidth_trace = NULL,\
 165   .latency = 0.,\
 166   .latency_trace = NULL,\
 167   .state = SURF_RESOURCE_ON,\
 168   .state_trace = NULL,\
 169   .policy = SURF_LINK_SHARED,\
 170   .properties = NULL\
 171 }
 172
 173 typedef struct s_sg_platf_peer_cbarg *sg_platf_peer_cbarg_t;
 174 typedef struct s_sg_platf_peer_cbarg {
 175   const char* id;
 176   double power;
 177   double bw_in;
 178   double bw_out;
 179   double lat;
 180   const char* coord;
 181   tmgr_trace_t availability_trace;
 182   tmgr_trace_t state_trace;
 183 } s_sg_platf_peer_cbarg_t;
 184
 185 #define SG_PLATF_PEER_INITIALIZER {NULL,NULL,NULL,NULL,NULL,NULL,NULL,NULL}
 186
 187 typedef struct s_sg_platf_route_cbarg *sg_platf_route_cbarg_t;
 188 typedef struct s_sg_platf_route_cbarg {
 189   int symmetrical;
 190   const char *src;
 191   const char *dst;
 192   sg_routing_edge_t gw_src;
 193   sg_routing_edge_t gw_dst;
 194   xbt_dynar_t link_list;
 195 } s_sg_platf_route_cbarg_t;
 196
 197 #define SG_PLATF_ROUTE_INITIALIZER {TRUE,NULL,NULL,NULL,NULL,NULL}
 198
 199 typedef struct s_sg_platf_cluster_cbarg *sg_platf_cluster_cbarg_t;
 200 typedef struct s_sg_platf_cluster_cbarg {
 201   const char* id;
 202   const char* prefix;
 203   const char* suffix;
 204   const char* radical;
 205   double power;
 206   int core_amount;
 207   double bw;
 208   double lat;
 209   double bb_bw;
 210   double bb_lat;
 211   double loopback_bw;
 212   double loopback_lat;
 213   double limiter_link;
 214   xbt_dict_t properties;
 215   const char* router_id;
 216   e_surf_link_sharing_policy_t sharing_policy;
 217   e_surf_link_sharing_policy_t bb_sharing_policy;
 218   const char* availability_trace; //don't convert to tmgr_trace_t since there is a trace per host and some rewriting is needed
 219   const char* state_trace;
 220 } s_sg_platf_cluster_cbarg_t;
 221
 222 #define SG_PLATF_CLUSTER_INITIALIZER {NULL,NULL,NULL,NULL,NULL,NULL \
 223   ,NULL,NULL,NULL,NULL,NULL,NULL,NULL,NULL,NULL,NULL}
 224
 225 typedef struct s_sg_platf_cabinet_cbarg *sg_platf_cabinet_cbarg_t;
 226 typedef struct s_sg_platf_cabinet_cbarg {
 227   const char* id;
 228   const char* prefix;
 229   const char* suffix;
 230   const char* radical;
 231   double power;
 232   double bw;
 233   double lat;
 234 } s_sg_platf_cabinet_cbarg_t;
 235
 236 #define SG_PLATF_CABINET_INITIALIZER {NULL,NULL,NULL,NULL,NULL,NULL,NULL}
 237
 238 typedef struct {
 239   const char* id;
 240   const char* type_id;
 241   const char* content;
 242   const char* content_type;
 243   xbt_dict_t properties;
 244 } s_sg_platf_storage_cbarg_t, *sg_platf_storage_cbarg_t;
 245
 246 #define SG_PLATF_STORAGE_INITIALIZER {NULL,NULL,NULL,NULL}
 247
 248 typedef struct {
 249   const char* id;
 250   const char* model;
 251   const char* content;
 252   const char* content_type;
 253   xbt_dict_t properties;
 254   sg_size_t size;
 255 } s_sg_platf_storage_type_cbarg_t, *sg_platf_storage_type_cbarg_t;
 256
 257 #define SG_PLATF_STORAGE_TYPE_INITIALIZER {NULL,NULL,NULL,NULL,NULL}
 258
 259 typedef struct {
 260   const char* type_id;
 261   const char* name;
 262 } s_sg_platf_mstorage_cbarg_t, *sg_platf_mstorage_cbarg_t;
 263
 264 #define SG_PLATF_MSTORAGE_INITIALIZER {NULL,NULL}
 265
 266 typedef struct {
 267   const char* storageId;
 268   const char* name;
 269 } s_sg_platf_mount_cbarg_t, *sg_platf_mount_cbarg_t;
 270
 271 #define SG_PLATF_MOUNT_INITIALIZER {NULL,NULL}
 272
 273 typedef struct s_sg_platf_prop_cbarg *sg_platf_prop_cbarg_t;
 274 typedef struct s_sg_platf_prop_cbarg {
 275   const char *id;
 276   const char *value;
 277 } s_sg_platf_prop_cbarg_t;
 278
 279 #define SG_PLATF_PROP_INITIALIZER {NULL,NULL}
 280
 281 typedef struct s_sg_platf_trace_cbarg *sg_platf_trace_cbarg_t;
 282 typedef struct s_sg_platf_trace_cbarg {
 283   const char *id;
 284   const char *file;
 285   double periodicity;
 286   const char *pc_data;
 287 } s_sg_platf_trace_cbarg_t;
 288
 289 #define SG_PLATF_TRACE_INITIALIZER {NULL,NULL,NULL,NULL}
 290
 291 typedef struct s_sg_platf_trace_connect_cbarg *sg_platf_trace_connect_cbarg_t;
 292 typedef struct s_sg_platf_trace_connect_cbarg {
 293   e_surf_trace_connect_kind_t kind;
 294   const char *trace;
 295   const char *element;
 296 } s_sg_platf_trace_connect_cbarg_t;
 297
 298 #define SG_PLATF_TRACE_CONNECT_INITIALIZER {NULL,NULL,NULL}
 299
 300 typedef struct s_sg_platf_process_cbarg *sg_platf_process_cbarg_t;
 301 typedef struct s_sg_platf_process_cbarg {
 302   const char **argv;
 303   int argc;
 304   xbt_dict_t properties;
 305   const char *host;
 306   const char *function;
 307   double start_time;
 308   double kill_time;
 309   e_surf_process_on_failure_t on_failure;
 310 } s_sg_platf_process_cbarg_t;
 311
 312 #define SG_PLATF_PROCESS_INITIALIZER {NULL,NULL,NULL,NULL,NULL,NULL,NULL,NULL}
 313
 314 typedef struct s_sg_platf_AS_cbarg *sg_platf_AS_cbarg_t;
 315 typedef struct s_sg_platf_AS_cbarg {
 316   const char *id;
 317   int routing;
 318 } s_sg_platf_AS_cbarg_t;
 319
 320 #define SG_PLATF_AS_INITIALIZER {NULL,0}
 321
 322 /* ***************************************** */
 323 /* TUTORIAL: New TAG                         */
 324
 325 typedef struct s_sg_platf_gpu_cbarg *sg_platf_gpu_cbarg_t;
 326 typedef struct s_sg_platf_gpu_cbarg {
 327   const char *name;
 328 } s_sg_platf_gpu_cbarg_t;
 329
 330 #define SG_PLATF_GPU_INITIALIZER {NULL}
 331
 332 /* ***************************************** */
 333
 334 #ifdef __cplusplus
 335 extern "C" {
 336 #endif
 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 #ifdef __cplusplus
 388 }
 389 #endif
 390
 391 #endif                          /* SG_PLATF_H */