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 typedef struct ws_params {
  63   int ncpus;
  64   long ramsize;
  65   int overcommit;
  66 } s_ws_params_t, *ws_params_t;
  67
  68 typedef struct tmgr_trace *tmgr_trace_t; /**< Opaque structure defining an availability trace */
  69
  70 /** opaque structure defining a event generator for availability based on a probability distribution */
  71 typedef struct probabilist_event_generator *probabilist_event_generator_t;
  72
  73 XBT_PUBLIC(tmgr_trace_t) tmgr_trace_new_from_file(const char *filename);
  74 XBT_PUBLIC(tmgr_trace_t) tmgr_trace_new_from_string(const char *id,
  75                                                     const char *input,
  76                                                     double periodicity);
  77
  78 XBT_PUBLIC(tmgr_trace_t) tmgr_trace_generator_value(const char *id,
  79                                               probabilist_event_generator_t date_generator,
  80                                               probabilist_event_generator_t value_generator);
  81 XBT_PUBLIC(tmgr_trace_t) tmgr_trace_generator_state(const char *id,
  82                                               probabilist_event_generator_t date_generator,
  83                                               e_surf_resource_state_t first_event_value);
  84 XBT_PUBLIC(tmgr_trace_t) tmgr_trace_generator_avail_unavail(const char *id,
  85                                               probabilist_event_generator_t avail_duration_generator,
  86                                               probabilist_event_generator_t unavail_duration_generator,
  87                                               e_surf_resource_state_t first_event_value);
  88
  89 XBT_PUBLIC(probabilist_event_generator_t) tmgr_event_generator_new_uniform(const char* id,
  90                                                                            double min,
  91                                                                            double max);
  92 XBT_PUBLIC(probabilist_event_generator_t) tmgr_event_generator_new_exponential(const char* id,
  93                                                                            double rate);
  94 XBT_PUBLIC(probabilist_event_generator_t) tmgr_event_generator_new_weibull(const char* id,
  95                                                                            double scale,
  96                                                                            double shape);
  97 typedef xbt_dictelm_t sg_host_t;
  98 static inline char* sg_host_name(sg_host_t host) {
  99   return host->key;
 100 }
 101
 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   double power_peak;
 116   int core_amount;
 117   double power_scale;
 118   tmgr_trace_t power_trace;
 119   e_surf_resource_state_t initial_state;
 120   tmgr_trace_t state_trace;
 121   const char* coord;
 122   xbt_dict_t properties;
 123 } s_sg_platf_host_cbarg_t, *sg_platf_host_cbarg_t;
 124
 125 #define SG_PLATF_HOST_INITIALIZER { \
 126     .id = NULL,\
 127     .power_peak = 0,\
 128     .core_amount = 1.,\
 129     .power_scale = 1,\
 130     .initial_state = SURF_RESOURCE_ON,\
 131     .power_trace = NULL,\
 132     .state_trace = NULL,\
 133     .coord = NULL,\
 134     .properties = NULL\
 135     }
 136
 137 typedef struct {
 138   const char* id;
 139   const char* link_up;
 140   const char* link_down;
 141 } s_sg_platf_host_link_cbarg_t, *sg_platf_host_link_cbarg_t;
 142
 143 #define SG_PLATF_HOST_LINK_INITIALIZER {NULL,NULL,NULL}
 144
 145 typedef struct {
 146   const char* id;
 147   const char* coord;
 148 } s_sg_platf_router_cbarg_t, *sg_platf_router_cbarg_t;
 149
 150 #define SG_PLATF_ROUTER_INITIALIZER {NULL,NULL}
 151
 152 typedef struct {
 153   const char* id;
 154   double bandwidth;
 155   tmgr_trace_t bandwidth_trace;
 156   double latency;
 157   tmgr_trace_t latency_trace;
 158   e_surf_resource_state_t state;
 159   tmgr_trace_t state_trace;
 160   e_surf_link_sharing_policy_t policy;
 161   xbt_dict_t properties;
 162 } s_sg_platf_link_cbarg_t, *sg_platf_link_cbarg_t;
 163
 164 #define SG_PLATF_LINK_INITIALIZER {\
 165   .id = NULL,\
 166   .bandwidth = 0.,\
 167   .bandwidth_trace = NULL,\
 168   .latency = 0.,\
 169   .latency_trace = NULL,\
 170   .state = SURF_RESOURCE_ON,\
 171   .state_trace = NULL,\
 172   .policy = SURF_LINK_SHARED,\
 173   .properties = NULL\
 174 }
 175
 176 typedef struct s_sg_platf_peer_cbarg *sg_platf_peer_cbarg_t;
 177 typedef struct s_sg_platf_peer_cbarg {
 178   const char* id;
 179   double power;
 180   double bw_in;
 181   double bw_out;
 182   double lat;
 183   const char* coord;
 184   tmgr_trace_t availability_trace;
 185   tmgr_trace_t state_trace;
 186 } s_sg_platf_peer_cbarg_t;
 187
 188 #define SG_PLATF_PEER_INITIALIZER {NULL,NULL,NULL,NULL,NULL,NULL,NULL,NULL}
 189
 190 typedef struct s_sg_platf_route_cbarg *sg_platf_route_cbarg_t;
 191 typedef struct s_sg_platf_route_cbarg {
 192   int symmetrical;
 193   const char *src;
 194   const char *dst;
 195   sg_routing_edge_t gw_src;
 196   sg_routing_edge_t gw_dst;
 197   xbt_dynar_t link_list;
 198 } s_sg_platf_route_cbarg_t;
 199
 200 #define SG_PLATF_ROUTE_INITIALIZER {TRUE,NULL,NULL,NULL,NULL,NULL}
 201
 202 typedef struct s_sg_platf_cluster_cbarg *sg_platf_cluster_cbarg_t;
 203 typedef struct s_sg_platf_cluster_cbarg {
 204   const char* id;
 205   const char* prefix;
 206   const char* suffix;
 207   const char* radical;
 208   double power;
 209   int core_amount;
 210   double bw;
 211   double lat;
 212   double bb_bw;
 213   double bb_lat;
 214   const char* router_id;
 215   e_surf_link_sharing_policy_t sharing_policy;
 216   e_surf_link_sharing_policy_t bb_sharing_policy;
 217   const char* availability_trace; //don't convert to tmgr_trace_t since there is a trace per host and some rewriting is needed
 218   const char* state_trace;
 219 } s_sg_platf_cluster_cbarg_t;
 220
 221 #define SG_PLATF_CLUSTER_INITIALIZER {NULL,NULL,NULL,NULL,NULL,NULL \
 222   ,NULL,NULL,NULL,NULL,NULL,NULL,NULL,NULL,NULL}
 223
 224 typedef struct s_sg_platf_cabinet_cbarg *sg_platf_cabinet_cbarg_t;
 225 typedef struct s_sg_platf_cabinet_cbarg {
 226   const char* id;
 227   const char* prefix;
 228   const char* suffix;
 229   const char* radical;
 230   double power;
 231   double bw;
 232   double lat;
 233 } s_sg_platf_cabinet_cbarg_t;
 234
 235 #define SG_PLATF_CABINET_INITIALIZER {NULL,NULL,NULL,NULL,NULL,NULL,NULL}
 236
 237 typedef struct {
 238   const char* id;
 239   const char* type_id;
 240   const char* content;
 241   xbt_dict_t properties;
 242 } s_sg_platf_storage_cbarg_t, *sg_platf_storage_cbarg_t;
 243
 244 #define SG_PLATF_STORAGE_INITIALIZER {NULL,NULL,NULL,NULL}
 245
 246 typedef struct {
 247   const char* id;
 248   const char* model;
 249   const char* content;
 250   xbt_dict_t properties;
 251   unsigned long size; /* size in Gbytes */
 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* id;
 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
 381 #endif                          /* SG_PLATF_H */