Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Add a tag cabinet to write new kind of cluster. See meta_cluster.xml
[simgrid.git] / include / simgrid / platf.h
1 /* platf.h - Public interface to the SimGrid platforms                      */
2
3 /* Copyright (c) 2004-2012. The SimGrid Team. All rights reserved.          */
4
5 /* This program is free software; you can redistribute it and/or modify it
6  * under the terms of the license (GNU LGPL) which comes with this package. */
7
8 #ifndef SG_PLATF_H
9 #define SG_PLATF_H
10
11 #include <xbt.h>
12
13 typedef void *sg_routing_link_t; /* The actual type is model-dependent so use void* instead*/
14 typedef struct s_routing_edge *sg_routing_edge_t;
15
16 XBT_PUBLIC(sg_routing_edge_t) sg_routing_edge_by_name_or_null(const char *name);
17
18
19
20 typedef struct tmgr_trace *tmgr_trace_t; /**< Opaque structure defining an availability trace */
21
22 /** opaque structure defining a event generator for availability based on a probability distribution */
23 typedef struct probabilist_event_generator *probabilist_event_generator_t;
24
25 XBT_PUBLIC(tmgr_trace_t) tmgr_trace_new_from_file(const char *filename);
26 XBT_PUBLIC(tmgr_trace_t) tmgr_trace_new_from_string(const char *id,
27                                                     const char *input,
28                                                     double periodicity);
29 XBT_PUBLIC(tmgr_trace_t) tmgr_trace_new_from_generator(const char *id,
30                                                   probabilist_event_generator_t generator1,
31                                                   probabilist_event_generator_t generator2,
32                                                   int is_state_trace);
33
34 XBT_PUBLIC(probabilist_event_generator_t) tmgr_event_generator_new_uniform(const char* id,
35                                                                            double min,
36                                                                            double max);
37 XBT_PUBLIC(probabilist_event_generator_t) tmgr_event_generator_new_exponential(const char* id,
38                                                                            double rate);
39 XBT_PUBLIC(probabilist_event_generator_t) tmgr_event_generator_new_weibull(const char* id,
40                                                                            double scale,
41                                                                            double shape);
42
43 /** Defines whether a given resource is working or not */
44 typedef enum {
45   SURF_RESOURCE_ON = 1,                   /**< Up & ready        */
46   SURF_RESOURCE_OFF = 0                   /**< Down & broken     */
47 } e_surf_resource_state_t;
48
49 typedef enum {
50   SURF_LINK_FULLDUPLEX = 2,
51   SURF_LINK_SHARED = 1,
52   SURF_LINK_FATPIPE = 0
53 } e_surf_link_sharing_policy_t;
54
55 /*
56  * Platform creation functions. Instead of passing 123 arguments to the creation functions
57  * (one for each possible XML attribute), we pass structures containing them all. It removes the
58  * chances of switching arguments by error, and reduce the burden when we add a new attribute:
59  * old models can just continue to ignore it without having to update their headers.
60  *
61  * It shouldn't be too costly at runtime, provided that structures living on the stack are
62  * used, instead of malloced structures.
63  */
64
65 typedef struct {
66   const char* id;
67   double power_peak;
68   int core_amount;
69   double power_scale;
70   tmgr_trace_t power_trace;
71   e_surf_resource_state_t initial_state;
72   tmgr_trace_t state_trace;
73   const char* coord;
74   xbt_dict_t properties;
75 } s_sg_platf_host_cbarg_t, *sg_platf_host_cbarg_t;
76
77 typedef struct {
78   const char* id;
79   const char* link_up;
80   const char* link_down;
81 } s_sg_platf_host_link_cbarg_t, *sg_platf_host_link_cbarg_t;
82
83
84 typedef struct {
85   const char* id;
86   const char* coord;
87 } s_sg_platf_router_cbarg_t, *sg_platf_router_cbarg_t;
88
89 typedef struct {
90   const char* id;
91   double bandwidth;
92   tmgr_trace_t bandwidth_trace;
93   double latency;
94   tmgr_trace_t latency_trace;
95   e_surf_resource_state_t state;
96   tmgr_trace_t state_trace;
97   e_surf_link_sharing_policy_t policy;
98   xbt_dict_t properties;
99 } s_sg_platf_link_cbarg_t, *sg_platf_link_cbarg_t;
100
101 typedef struct s_sg_platf_peer_cbarg *sg_platf_peer_cbarg_t;
102 typedef struct s_sg_platf_peer_cbarg {
103   const char* id;
104   double power;
105   double bw_in;
106   double bw_out;
107   double lat;
108   const char* coord;
109   tmgr_trace_t availability_trace;
110   tmgr_trace_t state_trace;
111 } s_sg_platf_peer_cbarg_t;
112
113 typedef struct s_sg_platf_linkctn_cbarg *sg_platf_linkctn_cbarg_t;
114 typedef struct s_sg_platf_linkctn_cbarg {
115   const char *id;
116   const char *direction;
117 } s_sg_platf_linkctn_cbarg_t;
118
119 typedef struct s_sg_platf_cluster_cbarg *sg_platf_cluster_cbarg_t;
120 typedef struct s_sg_platf_cluster_cbarg {
121   const char* id;
122   const char* prefix;
123   const char* suffix;
124   const char* radical;
125   double power;
126   int core_amount;
127   double bw;
128   double lat;
129   double bb_bw;
130   double bb_lat;
131   const char* router_id;
132   e_surf_link_sharing_policy_t sharing_policy;
133   e_surf_link_sharing_policy_t bb_sharing_policy;
134   const char* availability_trace; //don't convert to tmgr_trace_t since there is a trace per host and some rewriting is needed
135   const char* state_trace;
136 } s_sg_platf_cluster_cbarg_t;
137
138 typedef struct s_sg_platf_cabinet_cbarg *sg_platf_cabinet_cbarg_t;
139 typedef struct s_sg_platf_cabinet_cbarg {
140   const char* id;
141   const char* prefix;
142   const char* suffix;
143   const char* radical;
144   double power;
145   double bw;
146   double lat;
147 } s_sg_platf_cabinet_cbarg_t;
148
149 typedef struct {
150   const char* id;
151   const char* type_id;
152   const char* content;
153 } s_sg_platf_storage_cbarg_t, *sg_platf_storage_cbarg_t;
154
155 typedef struct {
156   const char* id;
157   const char* model;
158   const char* content;
159   xbt_dict_t properties;
160   unsigned long size; /* size in Gbytes */
161 } s_sg_platf_storage_type_cbarg_t, *sg_platf_storage_type_cbarg_t;
162
163 typedef struct {
164   const char* type_id;
165   const char* name;
166 } s_sg_platf_mstorage_cbarg_t, *sg_platf_mstorage_cbarg_t;
167
168 typedef struct {
169   const char* id;
170   const char* name;
171 } s_sg_platf_mount_cbarg_t, *sg_platf_mount_cbarg_t;
172
173
174 XBT_PUBLIC(void) sg_platf_begin(void);  // Start a new platform
175 XBT_PUBLIC(void) sg_platf_end(void); // Finish the creation of the platform
176
177 XBT_PUBLIC(void) sg_platf_new_AS_begin(const char *id, int mode); // Begin description of new AS
178 XBT_PUBLIC(void) sg_platf_new_AS_end(void);                            // That AS is fully described
179
180 XBT_PUBLIC(void) sg_platf_new_host   (sg_platf_host_cbarg_t   host);   // Add an host   to the currently described AS
181 XBT_PUBLIC(void) sg_platf_new_host_link(sg_platf_host_link_cbarg_t h); // Add an host_link to the currently described AS
182 XBT_PUBLIC(void) sg_platf_new_router (sg_platf_router_cbarg_t router); // Add a router  to the currently described AS
183 XBT_PUBLIC(void) sg_platf_new_link   (sg_platf_link_cbarg_t link);     // Add a link    to the currently described AS
184 XBT_PUBLIC(void) sg_platf_new_peer   (sg_platf_peer_cbarg_t peer);     // Add a peer    to the currently described AS
185 XBT_PUBLIC(void) sg_platf_new_cluster(sg_platf_cluster_cbarg_t clust); // Add a cluster to the currently described AS
186 XBT_PUBLIC(void) sg_platf_new_cabinet(sg_platf_cabinet_cbarg_t cabinet); // Add a cabinet to the currently described AS
187 XBT_PUBLIC(void) sg_platf_new_storage(sg_platf_storage_cbarg_t storage); // Add a storage to the currently described AS
188 XBT_PUBLIC(void) sg_platf_new_storage(sg_platf_storage_cbarg_t storage); // Add a storage to the currently described AS
189 XBT_PUBLIC(void) sg_platf_new_mstorage(sg_platf_mstorage_cbarg_t mstorage);
190 XBT_PUBLIC(void) sg_platf_new_storage_type(sg_platf_storage_type_cbarg_t storage_type);
191 XBT_PUBLIC(void) sg_platf_new_mount(sg_platf_mount_cbarg_t mount);
192
193 #endif                          /* SG_PLATF_H */