include/simgrid/platf.h

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