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