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
  84 /*
  85  * Platform creation functions. Instead of passing 123 arguments to the creation functions
  86  * (one for each possible XML attribute), we pass structures containing them all. It removes the
  87  * chances of switching arguments by error, and reduce the burden when we add a new attribute:
  88  * old models can just continue to ignore it without having to update their headers.
  89  *
  90  * It shouldn't be too costly at runtime, provided that structures living on the stack are
  91  * used, instead of malloced structures.
  92  */
  93
  94 typedef struct {
  95   const char* id;
  96   xbt_dynar_t power_peak;
  97   int pstate;
  98   int core_amount;
  99   double power_scale;
 100   tmgr_trace_t power_trace;
 101   e_surf_resource_state_t initial_state;
 102   tmgr_trace_t state_trace;
 103   const char* coord;
 104   xbt_dict_t properties;
 105 } s_sg_platf_host_cbarg_t, *sg_platf_host_cbarg_t;
 106
 107 #define SG_PLATF_HOST_INITIALIZER { \
 108     .id = NULL,\
 109     .power_peak = 0,\
 110     .core_amount = 1.,\
 111     .power_scale = 1,\
 112     .initial_state = SURF_RESOURCE_ON,\
 113     .power_trace = NULL,\
 114     .state_trace = NULL,\
 115     .coord = NULL,\
 116     .properties = NULL\
 117     }
 118
 119 typedef struct {
 120   const char* id;
 121   const char* link_up;
 122   const char* link_down;
 123 } s_sg_platf_host_link_cbarg_t, *sg_platf_host_link_cbarg_t;
 124
 125 #define SG_PLATF_HOST_LINK_INITIALIZER {NULL,NULL,NULL}
 126
 127 typedef struct {
 128   const char* id;
 129   const char* coord;
 130 } s_sg_platf_router_cbarg_t, *sg_platf_router_cbarg_t;
 131
 132 #define SG_PLATF_ROUTER_INITIALIZER {NULL,NULL}
 133
 134 typedef struct {
 135   const char* id;
 136   double bandwidth;
 137   tmgr_trace_t bandwidth_trace;
 138   double latency;
 139   tmgr_trace_t latency_trace;
 140   e_surf_resource_state_t state;
 141   tmgr_trace_t state_trace;
 142   e_surf_link_sharing_policy_t policy;
 143   xbt_dict_t properties;
 144 } s_sg_platf_link_cbarg_t, *sg_platf_link_cbarg_t;
 145
 146 #define SG_PLATF_LINK_INITIALIZER {\
 147   .id = NULL,\
 148   .bandwidth = 0.,\
 149   .bandwidth_trace = NULL,\
 150   .latency = 0.,\
 151   .latency_trace = NULL,\
 152   .state = SURF_RESOURCE_ON,\
 153   .state_trace = NULL,\
 154   .policy = SURF_LINK_SHARED,\
 155   .properties = NULL\
 156 }
 157
 158 typedef struct s_sg_platf_peer_cbarg *sg_platf_peer_cbarg_t;
 159 typedef struct s_sg_platf_peer_cbarg {
 160   const char* id;
 161   double power;
 162   double bw_in;
 163   double bw_out;
 164   double lat;
 165   const char* coord;
 166   tmgr_trace_t availability_trace;
 167   tmgr_trace_t state_trace;
 168 } s_sg_platf_peer_cbarg_t;
 169
 170 #define SG_PLATF_PEER_INITIALIZER {NULL,NULL,NULL,NULL,NULL,NULL,NULL,NULL}
 171
 172 typedef struct s_sg_platf_route_cbarg *sg_platf_route_cbarg_t;
 173 typedef struct s_sg_platf_route_cbarg {
 174   int symmetrical;
 175   const char *src;
 176   const char *dst;
 177   sg_routing_edge_t gw_src;
 178   sg_routing_edge_t gw_dst;
 179   xbt_dynar_t link_list;
 180 } s_sg_platf_route_cbarg_t;
 181
 182 #define SG_PLATF_ROUTE_INITIALIZER {TRUE,NULL,NULL,NULL,NULL,NULL}
 183
 184 typedef struct s_sg_platf_cluster_cbarg *sg_platf_cluster_cbarg_t;
 185 typedef struct s_sg_platf_cluster_cbarg {
 186   const char* id;
 187   const char* prefix;
 188   const char* suffix;
 189   const char* radical;
 190   double power;
 191   int core_amount;
 192   double bw;
 193   double lat;
 194   double bb_bw;
 195   double bb_lat;
 196   double loopback_bw;
 197   double loopback_lat;
 198   double limiter_link;
 199   xbt_dict_t properties;
 200   const char* router_id;
 201   e_surf_link_sharing_policy_t sharing_policy;
 202   e_surf_link_sharing_policy_t bb_sharing_policy;
 203   const char* availability_trace; //don't convert to tmgr_trace_t since there is a trace per host and some rewriting is needed
 204   const char* state_trace;
 205 } s_sg_platf_cluster_cbarg_t;
 206
 207 #define SG_PLATF_CLUSTER_INITIALIZER {NULL,NULL,NULL,NULL,NULL,NULL \
 208   ,NULL,NULL,NULL,NULL,NULL,NULL,NULL,NULL,NULL,NULL}
 209
 210 typedef struct s_sg_platf_cabinet_cbarg *sg_platf_cabinet_cbarg_t;
 211 typedef struct s_sg_platf_cabinet_cbarg {
 212   const char* id;
 213   const char* prefix;
 214   const char* suffix;
 215   const char* radical;
 216   double power;
 217   double bw;
 218   double lat;
 219 } s_sg_platf_cabinet_cbarg_t;
 220
 221 #define SG_PLATF_CABINET_INITIALIZER {NULL,NULL,NULL,NULL,NULL,NULL,NULL}
 222
 223 typedef struct {
 224   const char* id;
 225   const char* type_id;
 226   const char* content;
 227   const char* content_type;
 228   xbt_dict_t properties;
 229 } s_sg_platf_storage_cbarg_t, *sg_platf_storage_cbarg_t;
 230
 231 #define SG_PLATF_STORAGE_INITIALIZER {NULL,NULL,NULL,NULL}
 232
 233 typedef struct {
 234   const char* id;
 235   const char* model;
 236   const char* content;
 237   const char* content_type;
 238   xbt_dict_t properties;
 239   size_t size;
 240 } s_sg_platf_storage_type_cbarg_t, *sg_platf_storage_type_cbarg_t;
 241
 242 #define SG_PLATF_STORAGE_TYPE_INITIALIZER {NULL,NULL,NULL,NULL,NULL}
 243
 244 typedef struct {
 245   const char* type_id;
 246   const char* name;
 247 } s_sg_platf_mstorage_cbarg_t, *sg_platf_mstorage_cbarg_t;
 248
 249 #define SG_PLATF_MSTORAGE_INITIALIZER {NULL,NULL}
 250
 251 typedef struct {
 252   const char* storageId;
 253   const char* name;
 254 } s_sg_platf_mount_cbarg_t, *sg_platf_mount_cbarg_t;
 255
 256 #define SG_PLATF_MOUNT_INITIALIZER {NULL,NULL}
 257
 258 typedef struct s_sg_platf_prop_cbarg *sg_platf_prop_cbarg_t;
 259 typedef struct s_sg_platf_prop_cbarg {
 260   const char *id;
 261   const char *value;
 262 } s_sg_platf_prop_cbarg_t;
 263
 264 #define SG_PLATF_PROP_INITIALIZER {NULL,NULL}
 265
 266 typedef struct s_sg_platf_trace_cbarg *sg_platf_trace_cbarg_t;
 267 typedef struct s_sg_platf_trace_cbarg {
 268   const char *id;
 269   const char *file;
 270   double periodicity;
 271   const char *pc_data;
 272 } s_sg_platf_trace_cbarg_t;
 273
 274 #define SG_PLATF_TRACE_INITIALIZER {NULL,NULL,NULL,NULL}
 275
 276 typedef struct s_sg_platf_trace_connect_cbarg *sg_platf_trace_connect_cbarg_t;
 277 typedef struct s_sg_platf_trace_connect_cbarg {
 278   e_surf_trace_connect_kind_t kind;
 279   const char *trace;
 280   const char *element;
 281 } s_sg_platf_trace_connect_cbarg_t;
 282
 283 #define SG_PLATF_TRACE_CONNECT_INITIALIZER {NULL,NULL,NULL}
 284
 285 typedef struct s_sg_platf_process_cbarg *sg_platf_process_cbarg_t;
 286 typedef struct s_sg_platf_process_cbarg {
 287   const char **argv;
 288   int argc;
 289   xbt_dict_t properties;
 290   const char *host;
 291   const char *function;
 292   double start_time;
 293   double kill_time;
 294   e_surf_process_on_failure_t on_failure;
 295 } s_sg_platf_process_cbarg_t;
 296
 297 #define SG_PLATF_PROCESS_INITIALIZER {NULL,NULL,NULL,NULL,NULL,NULL,NULL,NULL}
 298
 299 typedef struct s_sg_platf_AS_cbarg *sg_platf_AS_cbarg_t;
 300 typedef struct s_sg_platf_AS_cbarg {
 301   const char *id;
 302   int routing;
 303 } s_sg_platf_AS_cbarg_t;
 304
 305 #define SG_PLATF_AS_INITIALIZER {NULL,0}
 306
 307 /* ***************************************** */
 308 /* TUTORIAL: New TAG                         */
 309
 310 typedef struct s_sg_platf_gpu_cbarg *sg_platf_gpu_cbarg_t;
 311 typedef struct s_sg_platf_gpu_cbarg {
 312   const char *name;
 313 } s_sg_platf_gpu_cbarg_t;
 314
 315 #define SG_PLATF_GPU_INITIALIZER {NULL}
 316
 317 /* ***************************************** */
 318
 319 XBT_PUBLIC(void) sg_platf_begin(void);  // Start a new platform
 320 XBT_PUBLIC(void) sg_platf_end(void); // Finish the creation of the platform
 321
 322 XBT_PUBLIC(void) sg_platf_new_AS_begin(sg_platf_AS_cbarg_t AS); // Begin description of new AS
 323 XBT_PUBLIC(void) sg_platf_new_AS_end(void);                            // That AS is fully described
 324
 325 XBT_PUBLIC(void) sg_platf_new_host   (sg_platf_host_cbarg_t   host);   // Add an host   to the currently described AS
 326 XBT_PUBLIC(void) sg_platf_new_host_link(sg_platf_host_link_cbarg_t h); // Add an host_link to the currently described AS
 327 XBT_PUBLIC(void) sg_platf_new_router (sg_platf_router_cbarg_t router); // Add a router  to the currently described AS
 328 XBT_PUBLIC(void) sg_platf_new_link   (sg_platf_link_cbarg_t link);     // Add a link    to the currently described AS
 329 XBT_PUBLIC(void) sg_platf_new_peer   (sg_platf_peer_cbarg_t peer);     // Add a peer    to the currently described AS
 330 XBT_PUBLIC(void) sg_platf_new_cluster(sg_platf_cluster_cbarg_t clust); // Add a cluster to the currently described AS
 331 XBT_PUBLIC(void) sg_platf_new_cabinet(sg_platf_cabinet_cbarg_t cabinet); // Add a cabinet to the currently described AS
 332
 333 XBT_PUBLIC(void) sg_platf_new_route (sg_platf_route_cbarg_t route); // Add a route
 334 XBT_PUBLIC(void) sg_platf_new_ASroute (sg_platf_route_cbarg_t ASroute); // Add an ASroute
 335 XBT_PUBLIC(void) sg_platf_new_bypassRoute (sg_platf_route_cbarg_t bypassroute); // Add a bypassRoute
 336 XBT_PUBLIC(void) sg_platf_new_bypassASroute (sg_platf_route_cbarg_t bypassASroute); // Add an bypassASroute
 337 XBT_PUBLIC(void) sg_platf_new_prop (sg_platf_prop_cbarg_t prop); // Add a prop
 338
 339 XBT_PUBLIC(void) sg_platf_new_trace(sg_platf_trace_cbarg_t trace);
 340 XBT_PUBLIC(void) sg_platf_trace_connect(sg_platf_trace_connect_cbarg_t trace_connect);
 341
 342 XBT_PUBLIC(void) sg_platf_new_storage(sg_platf_storage_cbarg_t storage); // Add a storage to the currently described AS
 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_mstorage(sg_platf_mstorage_cbarg_t mstorage);
 345 XBT_PUBLIC(void) sg_platf_new_storage_type(sg_platf_storage_type_cbarg_t storage_type);
 346 XBT_PUBLIC(void) sg_platf_new_mount(sg_platf_mount_cbarg_t mount);
 347
 348 XBT_PUBLIC(void) sg_platf_new_process(sg_platf_process_cbarg_t process);
 349
 350 /* ***************************************** */
 351 /* TUTORIAL: New TAG                         */
 352 XBT_PUBLIC(void) sg_platf_new_gpu(sg_platf_gpu_cbarg_t gpu);
 353 /* ***************************************** */
 354
 355 // Add route and Asroute without xml file with those functions
 356 XBT_PUBLIC(void) sg_platf_route_begin (sg_platf_route_cbarg_t route); // Initialize route
 357 XBT_PUBLIC(void) sg_platf_route_end (sg_platf_route_cbarg_t route); // Finalize and add a route
 358
 359 XBT_PUBLIC(void) sg_platf_ASroute_begin (sg_platf_route_cbarg_t ASroute); // Initialize ASroute
 360 XBT_PUBLIC(void) sg_platf_ASroute_end (sg_platf_route_cbarg_t ASroute); // Finalize and add a ASroute
 361
 362 XBT_PUBLIC(void) sg_platf_route_add_link (const char* link_id, sg_platf_route_cbarg_t route); // Add a link to link list
 363 XBT_PUBLIC(void) sg_platf_ASroute_add_link (const char* link_id, sg_platf_route_cbarg_t ASroute); // Add a link to link list
 364
 365 typedef void (*sg_platf_process_cb_t)(sg_platf_process_cbarg_t);
 366 XBT_PUBLIC(void) sg_platf_process_add_cb(sg_platf_process_cb_t fct);
 367
 368
 369 #endif                          /* SG_PLATF_H */