/* platf.h - Public interface to the SimGrid platforms */
-/* Copyright (c) 2004-2012. The SimGrid Team. All rights reserved. */
+/* Copyright (c) 2004-2014. The SimGrid Team.
+ * All rights reserved. */
/* This program is free software; you can redistribute it and/or modify it
* under the terms of the license (GNU LGPL) which comes with this package. */
#include <xbt.h>
-typedef void *sg_routing_link_t; /* The actual type is model-dependent so use void* instead*/
-typedef struct s_routing_edge *sg_routing_edge_t;
+SG_BEGIN_DECL()
+
+typedef void *sg_routing_link_t; /* FIXME:The actual type is model-dependent so use void* instead*/
+typedef struct RoutingEdge *sg_routing_edge_t;
XBT_PUBLIC(sg_routing_edge_t) sg_routing_edge_by_name_or_null(const char *name);
-/** Defines whether a given resource is working or not */
+/** @ingroup SURF_interface
+* @brief Defines whether a given resource is working or not */
typedef enum {
SURF_RESOURCE_ON = 1, /**< Up & ready */
SURF_RESOURCE_OFF = 0 /**< Down & broken */
SURF_TRACE_CONNECT_KIND_LINK_AVAIL = 2,
SURF_TRACE_CONNECT_KIND_BANDWIDTH = 1,
SURF_TRACE_CONNECT_KIND_LATENCY = 0
-} e_surf_trace_connect_kin_t;
+} e_surf_trace_connect_kind_t;
typedef enum {
SURF_PROCESS_ON_FAILURE_DIE = 1,
SURF_PROCESS_ON_FAILURE_RESTART = 0
} e_surf_process_on_failure_t;
+typedef enum {
+ SURF_CLUSTER_FAT_TREE=2,
+ SURF_CLUSTER_FLAT = 1,
+ SURF_CLUSTER_TORUS = 0
+} e_surf_cluster_topology_t;
+
typedef struct tmgr_trace *tmgr_trace_t; /**< Opaque structure defining an availability trace */
double scale,
double shape);
+typedef xbt_dictelm_t sg_host_t;
+static inline char* sg_host_name(sg_host_t host) {
+ return host->key;
+}
+
+typedef xbt_dictelm_t sg_storage_t;
+static inline char* sg_storage_name(sg_storage_t storage) {
+ return storage->key;
+}
+/** @ingroup m_datatypes_management_details
+ * @brief Type for any simgrid size
+ */
+typedef unsigned long long sg_size_t;
+
/*
* Platform creation functions. Instead of passing 123 arguments to the creation functions
* (one for each possible XML attribute), we pass structures containing them all. It removes the
typedef struct {
const char* id;
- double power_peak;
+ xbt_dynar_t power_peak;
+ int pstate;
int core_amount;
double power_scale;
tmgr_trace_t power_trace;
xbt_dict_t properties;
} s_sg_platf_host_cbarg_t, *sg_platf_host_cbarg_t;
+#define SG_PLATF_HOST_INITIALIZER { \
+ .id = NULL,\
+ .power_peak = 0,\
+ .core_amount = 1.,\
+ .power_scale = 1,\
+ .initial_state = SURF_RESOURCE_ON,\
+ .power_trace = NULL,\
+ .state_trace = NULL,\
+ .coord = NULL,\
+ .properties = NULL\
+ }
+
typedef struct {
const char* id;
const char* link_up;
const char* link_down;
} s_sg_platf_host_link_cbarg_t, *sg_platf_host_link_cbarg_t;
+#define SG_PLATF_HOST_LINK_INITIALIZER {NULL,NULL,NULL}
typedef struct {
const char* id;
const char* coord;
} s_sg_platf_router_cbarg_t, *sg_platf_router_cbarg_t;
+#define SG_PLATF_ROUTER_INITIALIZER {NULL,NULL}
+
typedef struct {
const char* id;
double bandwidth;
xbt_dict_t properties;
} s_sg_platf_link_cbarg_t, *sg_platf_link_cbarg_t;
+#define SG_PLATF_LINK_INITIALIZER {\
+ .id = NULL,\
+ .bandwidth = 0.,\
+ .bandwidth_trace = NULL,\
+ .latency = 0.,\
+ .latency_trace = NULL,\
+ .state = SURF_RESOURCE_ON,\
+ .state_trace = NULL,\
+ .policy = SURF_LINK_SHARED,\
+ .properties = NULL\
+}
+
typedef struct s_sg_platf_peer_cbarg *sg_platf_peer_cbarg_t;
typedef struct s_sg_platf_peer_cbarg {
const char* id;
tmgr_trace_t state_trace;
} s_sg_platf_peer_cbarg_t;
+#define SG_PLATF_PEER_INITIALIZER {NULL,NULL,NULL,NULL,NULL,NULL,NULL,NULL}
+
typedef struct s_sg_platf_route_cbarg *sg_platf_route_cbarg_t;
typedef struct s_sg_platf_route_cbarg {
int symmetrical;
xbt_dynar_t link_list;
} s_sg_platf_route_cbarg_t;
+#define SG_PLATF_ROUTE_INITIALIZER {TRUE,NULL,NULL,NULL,NULL,NULL}
+
typedef struct s_sg_platf_cluster_cbarg *sg_platf_cluster_cbarg_t;
typedef struct s_sg_platf_cluster_cbarg {
const char* id;
double lat;
double bb_bw;
double bb_lat;
+ double loopback_bw;
+ double loopback_lat;
+ double limiter_link;
+ e_surf_cluster_topology_t topology;
+ const char* topo_parameters;
+ xbt_dict_t properties;
const char* router_id;
e_surf_link_sharing_policy_t sharing_policy;
e_surf_link_sharing_policy_t bb_sharing_policy;
const char* state_trace;
} s_sg_platf_cluster_cbarg_t;
+#define SG_PLATF_CLUSTER_INITIALIZER {NULL,NULL,NULL,NULL,NULL,NULL \
+ ,NULL,NULL,NULL,NULL,NULL,NULL,NULL,NULL,NULL,NULL}
+
typedef struct s_sg_platf_cabinet_cbarg *sg_platf_cabinet_cbarg_t;
typedef struct s_sg_platf_cabinet_cbarg {
const char* id;
double lat;
} s_sg_platf_cabinet_cbarg_t;
+#define SG_PLATF_CABINET_INITIALIZER {NULL,NULL,NULL,NULL,NULL,NULL,NULL}
+
typedef struct {
const char* id;
const char* type_id;
const char* content;
+ const char* content_type;
+ xbt_dict_t properties;
+ const char* attach;
} s_sg_platf_storage_cbarg_t, *sg_platf_storage_cbarg_t;
+#define SG_PLATF_STORAGE_INITIALIZER {NULL,NULL,NULL,NULL}
+
typedef struct {
const char* id;
const char* model;
const char* content;
+ const char* content_type;
xbt_dict_t properties;
- unsigned long size; /* size in Gbytes */
+ xbt_dict_t model_properties;
+ sg_size_t size;
} s_sg_platf_storage_type_cbarg_t, *sg_platf_storage_type_cbarg_t;
+#define SG_PLATF_STORAGE_TYPE_INITIALIZER {NULL,NULL,NULL,NULL,NULL}
+
typedef struct {
const char* type_id;
const char* name;
} s_sg_platf_mstorage_cbarg_t, *sg_platf_mstorage_cbarg_t;
+#define SG_PLATF_MSTORAGE_INITIALIZER {NULL,NULL}
+
typedef struct {
- const char* id;
+ const char* storageId;
const char* name;
} s_sg_platf_mount_cbarg_t, *sg_platf_mount_cbarg_t;
+#define SG_PLATF_MOUNT_INITIALIZER {NULL,NULL}
+
typedef struct s_sg_platf_prop_cbarg *sg_platf_prop_cbarg_t;
typedef struct s_sg_platf_prop_cbarg {
const char *id;
const char *value;
} s_sg_platf_prop_cbarg_t;
+#define SG_PLATF_PROP_INITIALIZER {NULL,NULL}
+
typedef struct s_sg_platf_trace_cbarg *sg_platf_trace_cbarg_t;
typedef struct s_sg_platf_trace_cbarg {
const char *id;
const char *pc_data;
} s_sg_platf_trace_cbarg_t;
+#define SG_PLATF_TRACE_INITIALIZER {NULL,NULL,NULL,NULL}
+
typedef struct s_sg_platf_trace_connect_cbarg *sg_platf_trace_connect_cbarg_t;
typedef struct s_sg_platf_trace_connect_cbarg {
- e_surf_trace_connect_kin_t kind;
+ e_surf_trace_connect_kind_t kind;
const char *trace;
const char *element;
} s_sg_platf_trace_connect_cbarg_t;
+#define SG_PLATF_TRACE_CONNECT_INITIALIZER {NULL,NULL,NULL}
+
typedef struct s_sg_platf_process_cbarg *sg_platf_process_cbarg_t;
typedef struct s_sg_platf_process_cbarg {
const char **argv;
e_surf_process_on_failure_t on_failure;
} s_sg_platf_process_cbarg_t;
+#define SG_PLATF_PROCESS_INITIALIZER {NULL,NULL,NULL,NULL,NULL,NULL,NULL,NULL}
+
+typedef struct s_sg_platf_AS_cbarg *sg_platf_AS_cbarg_t;
+typedef struct s_sg_platf_AS_cbarg {
+ const char *id;
+ int routing;
+} s_sg_platf_AS_cbarg_t;
+
+#define SG_PLATF_AS_INITIALIZER {NULL,0}
+
+/* ***************************************** */
+/* TUTORIAL: New TAG */
+
+typedef struct s_sg_platf_gpu_cbarg *sg_platf_gpu_cbarg_t;
+typedef struct s_sg_platf_gpu_cbarg {
+ const char *name;
+} s_sg_platf_gpu_cbarg_t;
+
+#define SG_PLATF_GPU_INITIALIZER {NULL}
+
+
+/* ***************************************** */
+
XBT_PUBLIC(void) sg_platf_begin(void); // Start a new platform
XBT_PUBLIC(void) sg_platf_end(void); // Finish the creation of the platform
-XBT_PUBLIC(void) sg_platf_new_AS_begin(const char *id, int mode); // Begin description of new AS
+XBT_PUBLIC(void) sg_platf_new_AS_begin(sg_platf_AS_cbarg_t AS); // Begin description of new AS
XBT_PUBLIC(void) sg_platf_new_AS_end(void); // That AS is fully described
XBT_PUBLIC(void) sg_platf_new_host (sg_platf_host_cbarg_t host); // Add an host to the currently described AS
XBT_PUBLIC(void) sg_platf_new_prop (sg_platf_prop_cbarg_t prop); // Add a prop
XBT_PUBLIC(void) sg_platf_new_trace(sg_platf_trace_cbarg_t trace);
-XBT_PUBLIC(void) sg_platf_new_trace_connect(sg_platf_trace_connect_cbarg_t trace_connect);
+XBT_PUBLIC(void) sg_platf_trace_connect(sg_platf_trace_connect_cbarg_t trace_connect);
XBT_PUBLIC(void) sg_platf_new_storage(sg_platf_storage_cbarg_t storage); // Add a storage to the currently described AS
XBT_PUBLIC(void) sg_platf_new_storage(sg_platf_storage_cbarg_t storage); // Add a storage to the currently described AS
XBT_PUBLIC(void) sg_platf_new_process(sg_platf_process_cbarg_t process);
+/* ***************************************** */
+/* TUTORIAL: New TAG */
+XBT_PUBLIC(void) sg_platf_new_gpu(sg_platf_gpu_cbarg_t gpu);
+/* ***************************************** */
+
// Add route and Asroute without xml file with those functions
XBT_PUBLIC(void) sg_platf_route_begin (sg_platf_route_cbarg_t route); // Initialize route
XBT_PUBLIC(void) sg_platf_route_end (sg_platf_route_cbarg_t route); // Finalize and add a route
XBT_PUBLIC(void) sg_platf_route_add_link (const char* link_id, sg_platf_route_cbarg_t route); // Add a link to link list
XBT_PUBLIC(void) sg_platf_ASroute_add_link (const char* link_id, sg_platf_route_cbarg_t ASroute); // Add a link to link list
+typedef void (*sg_platf_process_cb_t)(sg_platf_process_cbarg_t);
+XBT_PUBLIC(void) sg_platf_process_add_cb(sg_platf_process_cb_t fct);
+
+SG_END_DECL()
+
#endif /* SG_PLATF_H */
