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 /* FIXME: Where should the VM state be defined? */
  45 typedef enum {
  46   /* created, but not yet started */
  47   SURF_VM_STATE_CREATED,
  48
  49   SURF_VM_STATE_RUNNING,
  50   SURF_VM_STATE_MIGRATING,
  51
  52   /* Suspend/resume does not involve disk I/O, so we assume there is no transition states. */
  53   SURF_VM_STATE_SUSPENDED,
  54
  55   /* Save/restore involves disk I/O, so there should be transition states. */
  56   SURF_VM_STATE_SAVING,
  57   SURF_VM_STATE_SAVED,
  58   SURF_VM_STATE_RESTORING,
  59
  60 } e_surf_vm_state_t;
  61
  62
  63 typedef struct tmgr_trace *tmgr_trace_t; /**< Opaque structure defining an availability trace */
  64
  65 /** opaque structure defining a event generator for availability based on a probability distribution */
  66 typedef struct probabilist_event_generator *probabilist_event_generator_t;
  67
  68 XBT_PUBLIC(tmgr_trace_t) tmgr_trace_new_from_file(const char *filename);
  69 XBT_PUBLIC(tmgr_trace_t) tmgr_trace_new_from_string(const char *id,
  70                                                     const char *input,
  71                                                     double periodicity);
  72
  73 XBT_PUBLIC(tmgr_trace_t) tmgr_trace_generator_value(const char *id,
  74                                               probabilist_event_generator_t date_generator,
  75                                               probabilist_event_generator_t value_generator);
  76 XBT_PUBLIC(tmgr_trace_t) tmgr_trace_generator_state(const char *id,
  77                                               probabilist_event_generator_t date_generator,
  78                                               e_surf_resource_state_t first_event_value);
  79 XBT_PUBLIC(tmgr_trace_t) tmgr_trace_generator_avail_unavail(const char *id,
  80                                               probabilist_event_generator_t avail_duration_generator,
  81                                               probabilist_event_generator_t unavail_duration_generator,
  82                                               e_surf_resource_state_t first_event_value);
  83
  84 XBT_PUBLIC(probabilist_event_generator_t) tmgr_event_generator_new_uniform(const char* id,
  85                                                                            double min,
  86                                                                            double max);
  87 XBT_PUBLIC(probabilist_event_generator_t) tmgr_event_generator_new_exponential(const char* id,
  88                                                                            double rate);
  89 XBT_PUBLIC(probabilist_event_generator_t) tmgr_event_generator_new_weibull(const char* id,
  90                                                                            double scale,
  91                                                                            double shape);
  92 typedef xbt_dictelm_t sg_host_t;
  93 static inline char* sg_host_name(sg_host_t host) {
  94   return host->key;
  95 }
  96
  97
  98 /*
  99  * Platform creation functions. Instead of passing 123 arguments to the creation functions
 100  * (one for each possible XML attribute), we pass structures containing them all. It removes the
 101  * chances of switching arguments by error, and reduce the burden when we add a new attribute:
 102  * old models can just continue to ignore it without having to update their headers.
 103  *
 104  * It shouldn't be too costly at runtime, provided that structures living on the stack are
 105  * used, instead of malloced structures.
 106  */
 107
 108 typedef struct {
 109   const char* id;
 110   double power_peak;
 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   const char* router_id;
 210   e_surf_link_sharing_policy_t sharing_policy;
 211   e_surf_link_sharing_policy_t bb_sharing_policy;
 212   const char* availability_trace; //don't convert to tmgr_trace_t since there is a trace per host and some rewriting is needed
 213   const char* state_trace;
 214 } s_sg_platf_cluster_cbarg_t;
 215
 216 #define SG_PLATF_CLUSTER_INITIALIZER {NULL,NULL,NULL,NULL,NULL,NULL \
 217   ,NULL,NULL,NULL,NULL,NULL,NULL,NULL,NULL,NULL}
 218
 219 typedef struct s_sg_platf_cabinet_cbarg *sg_platf_cabinet_cbarg_t;
 220 typedef struct s_sg_platf_cabinet_cbarg {
 221   const char* id;
 222   const char* prefix;
 223   const char* suffix;
 224   const char* radical;
 225   double power;
 226   double bw;
 227   double lat;
 228 } s_sg_platf_cabinet_cbarg_t;
 229
 230 #define SG_PLATF_CABINET_INITIALIZER {NULL,NULL,NULL,NULL,NULL,NULL,NULL}
 231
 232 typedef struct {
 233   const char* id;
 234   const char* type_id;
 235   const char* content;
 236   xbt_dict_t properties;
 237 } s_sg_platf_storage_cbarg_t, *sg_platf_storage_cbarg_t;
 238
 239 #define SG_PLATF_STORAGE_INITIALIZER {NULL,NULL,NULL,NULL}
 240
 241 typedef struct {
 242   const char* id;
 243   const char* model;
 244   const char* content;
 245   xbt_dict_t properties;
 246   unsigned long size; /* size in Gbytes */
 247 } s_sg_platf_storage_type_cbarg_t, *sg_platf_storage_type_cbarg_t;
 248
 249 #define SG_PLATF_STORAGE_TYPE_INITIALIZER {NULL,NULL,NULL,NULL,NULL}
 250
 251 typedef struct {
 252   const char* type_id;
 253   const char* name;
 254 } s_sg_platf_mstorage_cbarg_t, *sg_platf_mstorage_cbarg_t;
 255
 256 #define SG_PLATF_MSTORAGE_INITIALIZER {NULL,NULL}
 257
 258 typedef struct {
 259   const char* id;
 260   const char* name;
 261 } s_sg_platf_mount_cbarg_t, *sg_platf_mount_cbarg_t;
 262
 263 #define SG_PLATF_MOUNT_INITIALIZER {NULL,NULL}
 264
 265 typedef struct s_sg_platf_prop_cbarg *sg_platf_prop_cbarg_t;
 266 typedef struct s_sg_platf_prop_cbarg {
 267   const char *id;
 268   const char *value;
 269 } s_sg_platf_prop_cbarg_t;
 270
 271 #define SG_PLATF_PROP_INITIALIZER {NULL,NULL}
 272
 273 typedef struct s_sg_platf_trace_cbarg *sg_platf_trace_cbarg_t;
 274 typedef struct s_sg_platf_trace_cbarg {
 275   const char *id;
 276   const char *file;
 277   double periodicity;
 278   const char *pc_data;
 279 } s_sg_platf_trace_cbarg_t;
 280
 281 #define SG_PLATF_TRACE_INITIALIZER {NULL,NULL,NULL,NULL}
 282
 283 typedef struct s_sg_platf_trace_connect_cbarg *sg_platf_trace_connect_cbarg_t;
 284 typedef struct s_sg_platf_trace_connect_cbarg {
 285   e_surf_trace_connect_kind_t kind;
 286   const char *trace;
 287   const char *element;
 288 } s_sg_platf_trace_connect_cbarg_t;
 289
 290 #define SG_PLATF_TRACE_CONNECT_INITIALIZER {NULL,NULL,NULL}
 291
 292 typedef struct s_sg_platf_process_cbarg *sg_platf_process_cbarg_t;
 293 typedef struct s_sg_platf_process_cbarg {
 294   const char **argv;
 295   int argc;
 296   xbt_dict_t properties;
 297   const char *host;
 298   const char *function;
 299   double start_time;
 300   double kill_time;
 301   e_surf_process_on_failure_t on_failure;
 302 } s_sg_platf_process_cbarg_t;
 303
 304 #define SG_PLATF_PROCESS_INITIALIZER {NULL,NULL,NULL,NULL,NULL,NULL,NULL,NULL}
 305
 306 typedef struct s_sg_platf_AS_cbarg *sg_platf_AS_cbarg_t;
 307 typedef struct s_sg_platf_AS_cbarg {
 308   const char *id;
 309   int routing;
 310 } s_sg_platf_AS_cbarg_t;
 311
 312 #define SG_PLATF_AS_INITIALIZER {NULL,0}
 313
 314 /* ***************************************** */
 315 /* TUTORIAL: New TAG                         */
 316
 317 typedef struct s_sg_platf_gpu_cbarg *sg_platf_gpu_cbarg_t;
 318 typedef struct s_sg_platf_gpu_cbarg {
 319   const char *name;
 320 } s_sg_platf_gpu_cbarg_t;
 321
 322 #define SG_PLATF_GPU_INITIALIZER {NULL}
 323
 324 /* ***************************************** */
 325
 326 XBT_PUBLIC(void) sg_platf_begin(void);  // Start a new platform
 327 XBT_PUBLIC(void) sg_platf_end(void); // Finish the creation of the platform
 328
 329 XBT_PUBLIC(void) sg_platf_new_AS_begin(sg_platf_AS_cbarg_t AS); // Begin description of new AS
 330 XBT_PUBLIC(void) sg_platf_new_AS_end(void);                            // That AS is fully described
 331
 332 XBT_PUBLIC(void) sg_platf_new_host   (sg_platf_host_cbarg_t   host);   // Add an host   to the currently described AS
 333 XBT_PUBLIC(void) sg_platf_new_host_link(sg_platf_host_link_cbarg_t h); // Add an host_link to the currently described AS
 334 XBT_PUBLIC(void) sg_platf_new_router (sg_platf_router_cbarg_t router); // Add a router  to the currently described AS
 335 XBT_PUBLIC(void) sg_platf_new_link   (sg_platf_link_cbarg_t link);     // Add a link    to the currently described AS
 336 XBT_PUBLIC(void) sg_platf_new_peer   (sg_platf_peer_cbarg_t peer);     // Add a peer    to the currently described AS
 337 XBT_PUBLIC(void) sg_platf_new_cluster(sg_platf_cluster_cbarg_t clust); // Add a cluster to the currently described AS
 338 XBT_PUBLIC(void) sg_platf_new_cabinet(sg_platf_cabinet_cbarg_t cabinet); // Add a cabinet to the currently described AS
 339
 340 XBT_PUBLIC(void) sg_platf_new_route (sg_platf_route_cbarg_t route); // Add a route
 341 XBT_PUBLIC(void) sg_platf_new_ASroute (sg_platf_route_cbarg_t ASroute); // Add an ASroute
 342 XBT_PUBLIC(void) sg_platf_new_bypassRoute (sg_platf_route_cbarg_t bypassroute); // Add a bypassRoute
 343 XBT_PUBLIC(void) sg_platf_new_bypassASroute (sg_platf_route_cbarg_t bypassASroute); // Add an bypassASroute
 344 XBT_PUBLIC(void) sg_platf_new_prop (sg_platf_prop_cbarg_t prop); // Add a prop
 345
 346 XBT_PUBLIC(void) sg_platf_new_trace(sg_platf_trace_cbarg_t trace);
 347 XBT_PUBLIC(void) sg_platf_trace_connect(sg_platf_trace_connect_cbarg_t trace_connect);
 348
 349 XBT_PUBLIC(void) sg_platf_new_storage(sg_platf_storage_cbarg_t storage); // Add a storage to the currently described AS
 350 XBT_PUBLIC(void) sg_platf_new_storage(sg_platf_storage_cbarg_t storage); // Add a storage to the currently described AS
 351 XBT_PUBLIC(void) sg_platf_new_mstorage(sg_platf_mstorage_cbarg_t mstorage);
 352 XBT_PUBLIC(void) sg_platf_new_storage_type(sg_platf_storage_type_cbarg_t storage_type);
 353 XBT_PUBLIC(void) sg_platf_new_mount(sg_platf_mount_cbarg_t mount);
 354
 355 XBT_PUBLIC(void) sg_platf_new_process(sg_platf_process_cbarg_t process);
 356
 357 /* ***************************************** */
 358 /* TUTORIAL: New TAG                         */
 359 XBT_PUBLIC(void) sg_platf_new_gpu(sg_platf_gpu_cbarg_t gpu);
 360 /* ***************************************** */
 361
 362 // Add route and Asroute without xml file with those functions
 363 XBT_PUBLIC(void) sg_platf_route_begin (sg_platf_route_cbarg_t route); // Initialize route
 364 XBT_PUBLIC(void) sg_platf_route_end (sg_platf_route_cbarg_t route); // Finalize and add a route
 365
 366 XBT_PUBLIC(void) sg_platf_ASroute_begin (sg_platf_route_cbarg_t ASroute); // Initialize ASroute
 367 XBT_PUBLIC(void) sg_platf_ASroute_end (sg_platf_route_cbarg_t ASroute); // Finalize and add a ASroute
 368
 369 XBT_PUBLIC(void) sg_platf_route_add_link (const char* link_id, sg_platf_route_cbarg_t route); // Add a link to link list
 370 XBT_PUBLIC(void) sg_platf_ASroute_add_link (const char* link_id, sg_platf_route_cbarg_t ASroute); // Add a link to link list
 371
 372 typedef void (*sg_platf_process_cb_t)(sg_platf_process_cbarg_t);
 373 XBT_PUBLIC(void) sg_platf_process_add_cb(sg_platf_process_cb_t fct);
 374
 375
 376 #endif                          /* SG_PLATF_H */