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