include/simgrid/platf.h

   1 /* platf.h - Public interface to the SimGrid platforms                      */
   2
   3 /* Copyright (c) 2004-2015. 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 #include <simgrid/host.h>
  14
  15 SG_BEGIN_DECL()
  16
  17 typedef void *sg_routing_link_t; /* FIXME:The actual type is model-dependent so use void* instead*/
  18 typedef RoutingEdge *sg_routing_edge_t;
  19
  20 XBT_PUBLIC(sg_routing_edge_t) sg_routing_edge_by_name_or_null(const char *name);
  21
  22 /** @ingroup SURF_interface
  23 * @brief Defines whether a given resource is working or not */
  24 typedef enum {
  25   SURF_RESOURCE_ON = 1,                   /**< Up & ready        */
  26   SURF_RESOURCE_OFF = 0                   /**< Down & broken     */
  27 } e_surf_resource_state_t;
  28
  29 typedef enum {
  30   SURF_LINK_FULLDUPLEX = 2,
  31   SURF_LINK_SHARED = 1,
  32   SURF_LINK_FATPIPE = 0
  33 } e_surf_link_sharing_policy_t;
  34
  35 typedef enum {
  36   SURF_TRACE_CONNECT_KIND_HOST_AVAIL = 4,
  37   SURF_TRACE_CONNECT_KIND_POWER = 3,
  38   SURF_TRACE_CONNECT_KIND_LINK_AVAIL = 2,
  39   SURF_TRACE_CONNECT_KIND_BANDWIDTH = 1,
  40   SURF_TRACE_CONNECT_KIND_LATENCY = 0
  41 } e_surf_trace_connect_kind_t;
  42
  43 typedef enum {
  44   SURF_PROCESS_ON_FAILURE_DIE = 1,
  45   SURF_PROCESS_ON_FAILURE_RESTART = 0
  46 } e_surf_process_on_failure_t;
  47
  48 typedef enum {
  49   SURF_CLUSTER_FAT_TREE=2,
  50   SURF_CLUSTER_FLAT = 1,
  51   SURF_CLUSTER_TORUS = 0
  52 } e_surf_cluster_topology_t;
  53
  54
  55 typedef struct tmgr_trace *tmgr_trace_t; /**< Opaque structure defining an availability trace */
  56
  57 /** opaque structure defining a event generator for availability based on a probability distribution */
  58 typedef struct probabilist_event_generator *probabilist_event_generator_t;
  59
  60 XBT_PUBLIC(tmgr_trace_t) tmgr_trace_new_from_file(const char *filename);
  61 XBT_PUBLIC(tmgr_trace_t) tmgr_trace_new_from_string(const char *id,
  62                                                     const char *input,
  63                                                     double periodicity);
  64
  65 XBT_PUBLIC(tmgr_trace_t) tmgr_trace_generator_value(const char *id,
  66                                               probabilist_event_generator_t date_generator,
  67                                               probabilist_event_generator_t value_generator);
  68 XBT_PUBLIC(tmgr_trace_t) tmgr_trace_generator_state(const char *id,
  69                                               probabilist_event_generator_t date_generator,
  70                                               e_surf_resource_state_t first_event_value);
  71 XBT_PUBLIC(tmgr_trace_t) tmgr_trace_generator_avail_unavail(const char *id,
  72                                               probabilist_event_generator_t avail_duration_generator,
  73                                               probabilist_event_generator_t unavail_duration_generator,
  74                                               e_surf_resource_state_t first_event_value);
  75
  76 XBT_PUBLIC(probabilist_event_generator_t) tmgr_event_generator_new_uniform(const char* id,
  77                                                                            double min,
  78                                                                            double max);
  79 XBT_PUBLIC(probabilist_event_generator_t) tmgr_event_generator_new_exponential(const char* id,
  80                                                                            double rate);
  81 XBT_PUBLIC(probabilist_event_generator_t) tmgr_event_generator_new_weibull(const char* id,
  82                                                                            double scale,
  83                                                                            double shape);
  84
  85 static inline char* sg_host_name(sg_host_t host) {
  86   return host->key;
  87 }
  88
  89 typedef xbt_dictelm_t sg_storage_t;
  90 static inline char* sg_storage_name(sg_storage_t storage) {
  91   return storage->key;
  92 }
  93 /** @ingroup m_datatypes_management_details
  94  * @brief Type for any simgrid size
  95  */
  96 typedef unsigned long long sg_size_t;
  97
  98 /** @ingroup m_datatypes_management_details
  99  * @brief Type for any simgrid offset
 100  */
 101 typedef long long sg_offset_t;
 102
 103 /*
 104  * Platform creation functions. Instead of passing 123 arguments to the creation functions
 105  * (one for each possible XML attribute), we pass structures containing them all. It removes the
 106  * chances of switching arguments by error, and reduce the burden when we add a new attribute:
 107  * old models can just continue to ignore it without having to update their headers.
 108  *
 109  * It shouldn't be too costly at runtime, provided that structures living on the stack are
 110  * used, instead of malloced structures.
 111  */
 112
 113 typedef struct {
 114   const char* id;
 115   xbt_dynar_t power_peak;
 116   int pstate;
 117   int core_amount;
 118   double power_scale;
 119   tmgr_trace_t power_trace;
 120   e_surf_resource_state_t initial_state;
 121   tmgr_trace_t state_trace;
 122   const char* coord;
 123   xbt_dict_t properties;
 124 } s_sg_platf_host_cbarg_t, *sg_platf_host_cbarg_t;
 125
 126 #define SG_PLATF_HOST_INITIALIZER { \
 127     NULL, 0, 1, 1, 1., NULL, SURF_RESOURCE_ON, NULL, \
 128     NULL, NULL \
 129 }
 130
 131 typedef struct {
 132   const char* id;
 133   const char* link_up;
 134   const char* link_down;
 135 } s_sg_platf_host_link_cbarg_t, *sg_platf_host_link_cbarg_t;
 136
 137 #define SG_PLATF_HOST_LINK_INITIALIZER {NULL,NULL,NULL}
 138
 139 typedef struct {
 140   const char* id;
 141   const char* coord;
 142 } s_sg_platf_router_cbarg_t, *sg_platf_router_cbarg_t;
 143
 144 #define SG_PLATF_ROUTER_INITIALIZER {NULL,NULL}
 145
 146 typedef struct {
 147   const char* id;
 148   double bandwidth;
 149   tmgr_trace_t bandwidth_trace;
 150   double latency;
 151   tmgr_trace_t latency_trace;
 152   e_surf_resource_state_t state;
 153   tmgr_trace_t state_trace;
 154   e_surf_link_sharing_policy_t policy;
 155   xbt_dict_t properties;
 156 } s_sg_platf_link_cbarg_t, *sg_platf_link_cbarg_t;
 157
 158 #define SG_PLATF_LINK_INITIALIZER {\
 159   NULL, 0., NULL, 0., NULL, SURF_RESOURCE_ON, \
 160   NULL, SURF_LINK_SHARED, NULL \
 161 }
 162
 163 typedef struct s_sg_platf_peer_cbarg *sg_platf_peer_cbarg_t;
 164 typedef struct s_sg_platf_peer_cbarg {
 165   const char* id;
 166   double power;
 167   double bw_in;
 168   double bw_out;
 169   double lat;
 170   const char* coord;
 171   tmgr_trace_t availability_trace;
 172   tmgr_trace_t state_trace;
 173 } s_sg_platf_peer_cbarg_t;
 174
 175 #define SG_PLATF_PEER_INITIALIZER {NULL,0.0,0.0,0.0,0.0,NULL,NULL,NULL}
 176
 177 typedef struct s_sg_platf_route_cbarg *sg_platf_route_cbarg_t;
 178 typedef struct s_sg_platf_route_cbarg {
 179   int symmetrical;
 180   const char *src;
 181   const char *dst;
 182   sg_routing_edge_t gw_src;
 183   sg_routing_edge_t gw_dst;
 184   xbt_dynar_t link_list;
 185 } s_sg_platf_route_cbarg_t;
 186
 187 #define SG_PLATF_ROUTE_INITIALIZER {1,NULL,NULL,NULL,NULL,NULL}
 188
 189 typedef struct s_sg_platf_cluster_cbarg *sg_platf_cluster_cbarg_t;
 190 typedef struct s_sg_platf_cluster_cbarg {
 191   const char* id;
 192   const char* prefix;
 193   const char* suffix;
 194   const char* radical;
 195   double power;
 196   int core_amount;
 197   double bw;
 198   double lat;
 199   double bb_bw;
 200   double bb_lat;
 201   double loopback_bw;
 202   double loopback_lat;
 203   double limiter_link;
 204   e_surf_cluster_topology_t topology;
 205   const char* topo_parameters;
 206   xbt_dict_t properties;
 207   const char* router_id;
 208   e_surf_link_sharing_policy_t sharing_policy;
 209   e_surf_link_sharing_policy_t bb_sharing_policy;
 210   const char* availability_trace; //don't convert to tmgr_trace_t since there is a trace per host and some rewriting is needed
 211   const char* state_trace;
 212 } s_sg_platf_cluster_cbarg_t;
 213
 214 #define SG_PLATF_CLUSTER_INITIALIZER {NULL,NULL,NULL,NULL,0.0,1 \
 215   ,1.,1.,0.,0.,0.,0.,0. \
 216   ,SURF_CLUSTER_FLAT,NULL,NULL,NULL, \
 217   SURF_LINK_SHARED,SURF_LINK_SHARED,NULL \
 218   ,NULL}
 219
 220 typedef struct s_sg_platf_cabinet_cbarg *sg_platf_cabinet_cbarg_t;
 221 typedef struct s_sg_platf_cabinet_cbarg {
 222   const char* id;
 223   const char* prefix;
 224   const char* suffix;
 225   const char* radical;
 226   double power;
 227   double bw;
 228   double lat;
 229 } s_sg_platf_cabinet_cbarg_t;
 230
 231 #define SG_PLATF_CABINET_INITIALIZER {NULL,NULL,NULL,NULL,0.0,0.0,0.0}
 232
 233 typedef struct {
 234   const char* id;
 235   const char* type_id;
 236   const char* content;
 237   const char* content_type;
 238   xbt_dict_t properties;
 239   const char* attach;
 240 } s_sg_platf_storage_cbarg_t, *sg_platf_storage_cbarg_t;
 241
 242 #define SG_PLATF_STORAGE_INITIALIZER {NULL,NULL,NULL,NULL,NULL,NULL}
 243
 244 typedef struct {
 245   const char* id;
 246   const char* model;
 247   const char* content;
 248   const char* content_type;
 249   xbt_dict_t properties;
 250   xbt_dict_t model_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,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,0.0,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 {SURF_TRACE_CONNECT_KIND_LATENCY,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,0,NULL,NULL,NULL,-1.0,-1.0,SURF_PROCESS_ON_FAILURE_DIE}
 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
 332 XBT_PUBLIC(void) sg_platf_begin(void);  // Start a new platform
 333 XBT_PUBLIC(void) sg_platf_end(void); // Finish the creation of the platform
 334
 335 XBT_PUBLIC(void) sg_platf_new_AS_begin(sg_platf_AS_cbarg_t AS); // Begin description of new AS
 336 XBT_PUBLIC(void) sg_platf_new_AS_end(void);                            // That AS is fully described
 337
 338 XBT_PUBLIC(void) sg_platf_new_host   (sg_platf_host_cbarg_t   host);   // Add an host   to the currently described AS
 339 XBT_PUBLIC(void) sg_platf_new_host_link(sg_platf_host_link_cbarg_t h); // Add an host_link to the currently described AS
 340 XBT_PUBLIC(void) sg_platf_new_router (sg_platf_router_cbarg_t router); // Add a router  to the currently described AS
 341 XBT_PUBLIC(void) sg_platf_new_link   (sg_platf_link_cbarg_t link);     // Add a link    to the currently described AS
 342 XBT_PUBLIC(void) sg_platf_new_peer   (sg_platf_peer_cbarg_t peer);     // Add a peer    to the currently described AS
 343 XBT_PUBLIC(void) sg_platf_new_cluster(sg_platf_cluster_cbarg_t clust); // Add a cluster to the currently described AS
 344 XBT_PUBLIC(void) sg_platf_new_cabinet(sg_platf_cabinet_cbarg_t cabinet); // Add a cabinet to the currently described AS
 345
 346 XBT_PUBLIC(void) sg_platf_new_route (sg_platf_route_cbarg_t route); // Add a route
 347 XBT_PUBLIC(void) sg_platf_new_ASroute (sg_platf_route_cbarg_t ASroute); // Add an ASroute
 348 XBT_PUBLIC(void) sg_platf_new_bypassRoute (sg_platf_route_cbarg_t bypassroute); // Add a bypassRoute
 349 XBT_PUBLIC(void) sg_platf_new_bypassASroute (sg_platf_route_cbarg_t bypassASroute); // Add an bypassASroute
 350 XBT_PUBLIC(void) sg_platf_new_prop (sg_platf_prop_cbarg_t prop); // Add a prop
 351
 352 XBT_PUBLIC(void) sg_platf_new_trace(sg_platf_trace_cbarg_t trace);
 353 XBT_PUBLIC(void) sg_platf_trace_connect(sg_platf_trace_connect_cbarg_t trace_connect);
 354
 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 */