Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
a10f8846a24a0ad6bab047f06a59b5e3b7c8696a
[simgrid.git] / include / simgrid / platf.h
1 /* platf.h - Public interface to the SimGrid platforms                      */
2
3 /* Copyright (c) 2004, 2005, 2006, 2007, 2009, 2010, 2011. The SimGrid Team.
4  * All rights reserved.                                                     */
5
6 /* This program is free software; you can redistribute it and/or modify it
7  * under the terms of the license (GNU LGPL) which comes with this package. */
8
9 #ifndef SG_PLATF_H
10 #define SG_PLATF_H
11
12 #include <xbt.h>                /* our toolbox */
13
14 typedef struct tmgr_trace *tmgr_trace_t; /**< Opaque structure defining an availability trace */
15
16 /** Defines whether a given resource is working or not */
17 typedef enum {
18   SURF_RESOURCE_ON = 1,                   /**< Up & ready        */
19   SURF_RESOURCE_OFF = 0                   /**< Down & broken     */
20 } e_surf_resource_state_t;
21
22
23 /*
24  * Platform creation functions. Instead of passing 123 arguments to the creation functions
25  * (one for each possible XML attribute), we pass structures containing them all. It removes the
26  * chances of switching arguments by error, and reduce the burden when we add a new attribute:
27  * old models can just continue to ignore it without having to update their headers.
28  *
29  * It shouldn't be too costly at runtime, provided that structures living on the stack are
30  * used, instead of malloced structures.
31  */
32
33 typedef struct {
34   const char* id;
35   double power_peak;
36   int core_amount;
37   double power_scale;
38   tmgr_trace_t power_trace;
39   e_surf_resource_state_t initial_state;
40   tmgr_trace_t state_trace;
41   const char* coord;
42   xbt_dict_t properties;
43 } s_sg_platf_host_cbarg_t, *sg_platf_host_cbarg_t;
44
45 typedef struct {
46   const char* V_router_id;
47   const char* V_router_coord;
48 } s_sg_platf_router_cbarg_t, *sg_platf_router_cbarg_t;
49
50 typedef struct {
51   const char* V_link_id;
52   double V_link_bandwidth;
53   tmgr_trace_t V_link_bandwidth_file;
54   double V_link_latency;
55   tmgr_trace_t V_link_latency_file;
56   e_surf_resource_state_t V_link_state;
57   tmgr_trace_t V_link_state_file;
58   int V_link_sharing_policy;
59   int V_policy_initial_link;
60   xbt_dict_t properties;
61 } s_sg_platf_link_cbarg_t, *sg_platf_link_cbarg_t;
62
63
64 XBT_PUBLIC(void) sg_platf_open(void);  // Start a new platform
65 XBT_PUBLIC(void) sg_platf_close(void); // Finish the creation of the platform
66
67 XBT_PUBLIC(void) sg_platf_new_AS_open(const char *id, const char *mode); // Begin description of new AS
68 XBT_PUBLIC(void) sg_platf_new_AS_close(void);                            // That AS is fully described
69
70 XBT_PUBLIC(void) sg_platf_new_host  (sg_platf_host_cbarg_t   host);   // Add an host  to the currently described AS
71 XBT_PUBLIC(void) sg_platf_new_router(sg_platf_router_cbarg_t router); // Add a router to the currently described AS
72 XBT_PUBLIC(void) sg_platf_new_link  (sg_platf_link_cbarg_t link);     // Add a link   to the currently described AS
73
74
75 #endif                          /* SG_PLATF_H */