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