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