include/simgrid/platf.h

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