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