include/simgrid/forward.h

   1 /* Copyright (c) 2004-2015. The SimGrid Team.
   2  * All rights reserved.                                                     */
   3
   4 /* This program is free software; you can redistribute it and/or modify it
   5  * under the terms of the license (GNU LGPL) which comes with this package. */
   6
   7 #ifndef SG_PLATF_TYPES_H
   8 #define SG_PLATF_TYPES_H
   9
  10 #include <xbt.h>
  11
  12 #ifdef __cplusplus
  13
  14 namespace simgrid {
  15   namespace s4u {
  16     class Host;
  17   }
  18   namespace surf {
  19     class Cpu;
  20     class NetCard;
  21     class As;
  22     class Link;
  23   }
  24   namespace trace_mgr {
  25     class future_evt_set;
  26   }
  27 }
  28
  29 typedef simgrid::s4u::Host simgrid_Host;
  30 typedef simgrid::surf::Cpu surf_Cpu;
  31 typedef simgrid::surf::NetCard surf_NetCard;
  32 typedef simgrid::surf::As surf_As;
  33 typedef simgrid::surf::Link Link;
  34 typedef simgrid::trace_mgr::future_evt_set sg_future_evt_set;
  35
  36 #else
  37
  38 typedef struct simgrid_Host simgrid_Host;
  39 typedef struct surf_Cpu surf_Cpu;
  40 typedef struct surf_NetCard surf_NetCard;
  41 typedef struct surf_As surf_As;
  42 typedef struct Link Link;
  43 typedef struct future_evt_set sg_future_evt_set;
  44 #endif
  45
  46 typedef simgrid_Host* sg_host_t;
  47 typedef surf_Cpu *surf_cpu_t;
  48 typedef surf_NetCard *sg_netcard_t;
  49 typedef surf_As *AS_t;
  50 typedef sg_future_evt_set *sg_future_evt_set_t;
  51
  52 // Types which are in fact dictelmt:
  53 typedef xbt_dictelm_t sg_storage_t;
  54
  55 typedef struct tmgr_trace *tmgr_trace_t; /**< Opaque structure defining an availability trace */
  56
  57 typedef void *sg_routing_link_t; /* FIXME:The actual type is model-dependent so use void* instead*/
  58
  59 typedef enum {
  60   SURF_LINK_FULLDUPLEX = 2,
  61   SURF_LINK_SHARED = 1,
  62   SURF_LINK_FATPIPE = 0
  63 } e_surf_link_sharing_policy_t;
  64
  65 typedef enum {
  66   SURF_TRACE_CONNECT_KIND_HOST_AVAIL = 4,
  67   SURF_TRACE_CONNECT_KIND_POWER = 3,
  68   SURF_TRACE_CONNECT_KIND_LINK_AVAIL = 2,
  69   SURF_TRACE_CONNECT_KIND_BANDWIDTH = 1,
  70   SURF_TRACE_CONNECT_KIND_LATENCY = 0
  71 } e_surf_trace_connect_kind_t;
  72
  73 typedef enum {
  74   SURF_PROCESS_ON_FAILURE_DIE = 1,
  75   SURF_PROCESS_ON_FAILURE_RESTART = 0
  76 } e_surf_process_on_failure_t;
  77
  78 typedef enum {
  79   SURF_CLUSTER_FAT_TREE=2,
  80   SURF_CLUSTER_FLAT = 1,
  81   SURF_CLUSTER_TORUS = 0
  82 } e_surf_cluster_topology_t;
  83
  84
  85 /** @ingroup m_datatypes_management_details
  86  * @brief Type for any simgrid size
  87  */
  88 typedef unsigned long long sg_size_t;
  89
  90 /** @ingroup m_datatypes_management_details
  91  * @brief Type for any simgrid offset
  92  */
  93 typedef long long sg_offset_t;
  94
  95 /*
  96  * Platform creation functions. Instead of passing 123 arguments to the creation functions
  97  * (one for each possible XML attribute), we pass structures containing them all. It removes the
  98  * chances of switching arguments by error, and reduce the burden when we add a new attribute:
  99  * old models can just continue to ignore it without having to update their headers.
 100  *
 101  * It shouldn't be too costly at runtime, provided that structures living on the stack are
 102  * used, instead of malloced structures.
 103  */
 104
 105 typedef struct {
 106   const char* id;
 107   xbt_dynar_t speed_peak;
 108   int pstate;
 109   int core_amount;
 110   double speed_scale;
 111   tmgr_trace_t speed_trace;
 112   int initiallyOn;
 113   tmgr_trace_t state_trace;
 114   const char* coord;
 115   xbt_dict_t properties;
 116 } s_sg_platf_host_cbarg_t, *sg_platf_host_cbarg_t;
 117
 118 #define SG_PLATF_HOST_INITIALIZER { \
 119     NULL, 0, 1, 1, 1., NULL, 1/*ON*/, NULL, \
 120     NULL, NULL \
 121 }
 122
 123 typedef struct {
 124   const char* id;
 125   const char* link_up;
 126   const char* link_down;
 127 } s_sg_platf_host_link_cbarg_t, *sg_platf_host_link_cbarg_t;
 128
 129 #define SG_PLATF_HOST_LINK_INITIALIZER {NULL,NULL,NULL}
 130
 131 typedef struct {
 132   const char* id;
 133   const char* coord;
 134 } s_sg_platf_router_cbarg_t, *sg_platf_router_cbarg_t;
 135
 136 #define SG_PLATF_ROUTER_INITIALIZER {NULL,NULL}
 137
 138 typedef struct {
 139   const char* id;
 140   double bandwidth;
 141   tmgr_trace_t bandwidth_trace;
 142   double latency;
 143   tmgr_trace_t latency_trace;
 144   int initiallyOn;
 145   tmgr_trace_t state_trace;
 146   e_surf_link_sharing_policy_t policy;
 147   xbt_dict_t properties;
 148 } s_sg_platf_link_cbarg_t, *sg_platf_link_cbarg_t;
 149
 150 #define SG_PLATF_LINK_INITIALIZER {\
 151   NULL, 0., NULL, 0., NULL, 1/*ON*/, \
 152   NULL, SURF_LINK_SHARED, NULL \
 153 }
 154
 155 typedef struct s_sg_platf_peer_cbarg *sg_platf_peer_cbarg_t;
 156 typedef struct s_sg_platf_peer_cbarg {
 157   const char* id;
 158   double speed;
 159   double bw_in;
 160   double bw_out;
 161   double lat;
 162   const char* coord;
 163   tmgr_trace_t availability_trace;
 164   tmgr_trace_t state_trace;
 165 } s_sg_platf_peer_cbarg_t;
 166
 167 #define SG_PLATF_PEER_INITIALIZER {NULL,0.0,0.0,0.0,0.0,NULL,NULL,NULL}
 168
 169 typedef struct s_sg_platf_route_cbarg *sg_platf_route_cbarg_t;
 170 typedef struct s_sg_platf_route_cbarg {
 171   int symmetrical;
 172   const char *src;
 173   const char *dst;
 174   sg_netcard_t gw_src;
 175   sg_netcard_t gw_dst;
 176   xbt_dynar_t link_list;
 177 } s_sg_platf_route_cbarg_t;
 178
 179 #define SG_PLATF_ROUTE_INITIALIZER {1,NULL,NULL,NULL,NULL,NULL}
 180
 181 typedef struct s_sg_platf_cluster_cbarg *sg_platf_cluster_cbarg_t;
 182 typedef struct s_sg_platf_cluster_cbarg {
 183   const char* id;
 184   const char* prefix;
 185   const char* suffix;
 186   const char* radical;
 187   double speed;
 188   int core_amount;
 189   double bw;
 190   double lat;
 191   double bb_bw;
 192   double bb_lat;
 193   double loopback_bw;
 194   double loopback_lat;
 195   double limiter_link;
 196   e_surf_cluster_topology_t topology;
 197   const char* topo_parameters;
 198   xbt_dict_t properties;
 199   const char* router_id;
 200   e_surf_link_sharing_policy_t sharing_policy;
 201   e_surf_link_sharing_policy_t bb_sharing_policy;
 202   const char* availability_trace; //don't convert to tmgr_trace_t since there is a trace per host and some rewriting is needed
 203   const char* state_trace;
 204 } s_sg_platf_cluster_cbarg_t;
 205
 206 #define SG_PLATF_CLUSTER_INITIALIZER {NULL,NULL,NULL,NULL,0.0,1 \
 207   ,1.,1.,0.,0.,0.,0.,0. \
 208   ,SURF_CLUSTER_FLAT,NULL,NULL,NULL, \
 209   SURF_LINK_SHARED,SURF_LINK_SHARED,NULL \
 210   ,NULL}
 211
 212 typedef struct s_sg_platf_cabinet_cbarg *sg_platf_cabinet_cbarg_t;
 213 typedef struct s_sg_platf_cabinet_cbarg {
 214   const char* id;
 215   const char* prefix;
 216   const char* suffix;
 217   const char* radical;
 218   double speed;
 219   double bw;
 220   double lat;
 221 } s_sg_platf_cabinet_cbarg_t;
 222
 223 #define SG_PLATF_CABINET_INITIALIZER {NULL,NULL,NULL,NULL,0.0,0.0,0.0}
 224
 225 typedef struct {
 226   const char* id;
 227   const char* type_id;
 228   const char* content;
 229   const char* content_type;
 230   xbt_dict_t properties;
 231   const char* attach;
 232 } s_sg_platf_storage_cbarg_t, *sg_platf_storage_cbarg_t;
 233
 234 #define SG_PLATF_STORAGE_INITIALIZER {NULL,NULL,NULL,NULL,NULL,NULL}
 235
 236 typedef struct {
 237   const char* id;
 238   const char* model;
 239   const char* content;
 240   const char* content_type;
 241   xbt_dict_t properties;
 242   xbt_dict_t model_properties;
 243   sg_size_t size;
 244 } s_sg_platf_storage_type_cbarg_t, *sg_platf_storage_type_cbarg_t;
 245
 246 #define SG_PLATF_STORAGE_TYPE_INITIALIZER {NULL,NULL,NULL,NULL,NULL,NULL}
 247
 248 typedef struct {
 249   const char* type_id;
 250   const char* name;
 251 } s_sg_platf_mstorage_cbarg_t, *sg_platf_mstorage_cbarg_t;
 252
 253 #define SG_PLATF_MSTORAGE_INITIALIZER {NULL,NULL}
 254
 255 typedef struct {
 256   const char* storageId;
 257   const char* name;
 258 } s_sg_platf_mount_cbarg_t, *sg_platf_mount_cbarg_t;
 259
 260 #define SG_PLATF_MOUNT_INITIALIZER {NULL,NULL}
 261
 262 typedef struct s_sg_platf_prop_cbarg *sg_platf_prop_cbarg_t;
 263 typedef struct s_sg_platf_prop_cbarg {
 264   const char *id;
 265   const char *value;
 266 } s_sg_platf_prop_cbarg_t;
 267
 268 #define SG_PLATF_PROP_INITIALIZER {NULL,NULL}
 269
 270 typedef struct s_sg_platf_trace_cbarg *sg_platf_trace_cbarg_t;
 271 typedef struct s_sg_platf_trace_cbarg {
 272   const char *id;
 273   const char *file;
 274   double periodicity;
 275   const char *pc_data;
 276 } s_sg_platf_trace_cbarg_t;
 277
 278 #define SG_PLATF_TRACE_INITIALIZER {NULL,NULL,0.0,NULL}
 279
 280 typedef struct s_sg_platf_trace_connect_cbarg *sg_platf_trace_connect_cbarg_t;
 281 typedef struct s_sg_platf_trace_connect_cbarg {
 282   e_surf_trace_connect_kind_t kind;
 283   const char *trace;
 284   const char *element;
 285 } s_sg_platf_trace_connect_cbarg_t;
 286
 287 #define SG_PLATF_TRACE_CONNECT_INITIALIZER {SURF_TRACE_CONNECT_KIND_LATENCY,NULL,NULL}
 288
 289 typedef struct s_sg_platf_process_cbarg *sg_platf_process_cbarg_t;
 290 typedef struct s_sg_platf_process_cbarg {
 291   const char **argv;
 292   int argc;
 293   xbt_dict_t properties;
 294   const char *host;
 295   const char *function;
 296   double start_time;
 297   double kill_time;
 298   e_surf_process_on_failure_t on_failure;
 299 } s_sg_platf_process_cbarg_t;
 300
 301 #define SG_PLATF_PROCESS_INITIALIZER {NULL,0,NULL,NULL,NULL,-1.0,-1.0,SURF_PROCESS_ON_FAILURE_DIE}
 302
 303 typedef struct s_sg_platf_AS_cbarg *sg_platf_AS_cbarg_t;
 304 typedef struct s_sg_platf_AS_cbarg {
 305   const char *id;
 306   int routing;
 307 } s_sg_platf_AS_cbarg_t;
 308
 309 #define SG_PLATF_AS_INITIALIZER {NULL,0}
 310
 311 /** opaque structure defining a event generator for availability based on a probability distribution */
 312 typedef struct probabilist_event_generator *probabilist_event_generator_t;
 313
 314 #endif