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