1 /* platf.h - Public interface to the SimGrid platforms */
3 /* Copyright (c) 2004, 2005, 2006, 2007, 2009, 2010, 2011. The SimGrid Team.
4 * All rights reserved. */
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. */
14 typedef struct tmgr_trace *tmgr_trace_t; /**< Opaque structure defining an availability trace */
15 XBT_PUBLIC(tmgr_trace_t) tmgr_trace_new(const char *filename);
16 XBT_PUBLIC(tmgr_trace_t) tmgr_trace_new_from_string(const char *id,
20 /** Defines whether a given resource is working or not */
22 SURF_RESOURCE_ON = 1, /**< Up & ready */
23 SURF_RESOURCE_OFF = 0 /**< Down & broken */
24 } e_surf_resource_state_t;
27 SURF_LINK_FULLDUPLEX = 2,
30 } e_surf_link_sharing_policy_t;
33 * Platform creation functions. Instead of passing 123 arguments to the creation functions
34 * (one for each possible XML attribute), we pass structures containing them all. It removes the
35 * chances of switching arguments by error, and reduce the burden when we add a new attribute:
36 * old models can just continue to ignore it without having to update their headers.
38 * It shouldn't be too costly at runtime, provided that structures living on the stack are
39 * used, instead of malloced structures.
47 tmgr_trace_t power_trace;
48 e_surf_resource_state_t initial_state;
49 tmgr_trace_t state_trace;
51 xbt_dict_t properties;
52 } s_sg_platf_host_cbarg_t, *sg_platf_host_cbarg_t;
57 } s_sg_platf_router_cbarg_t, *sg_platf_router_cbarg_t;
62 tmgr_trace_t bandwidth_trace;
64 tmgr_trace_t latency_trace;
65 e_surf_resource_state_t state;
66 tmgr_trace_t state_trace;
67 e_surf_link_sharing_policy_t policy;
68 xbt_dict_t properties;
69 } s_sg_platf_link_cbarg_t, *sg_platf_link_cbarg_t;
71 typedef struct s_surf_parsing_peer_arg *sg_platf_peer_cbarg_t;
72 typedef struct s_surf_parsing_peer_arg {
79 tmgr_trace_t availability_trace;
80 tmgr_trace_t state_trace;
81 } s_surf_parsing_peer_arg_t;
84 XBT_PUBLIC(void) sg_platf_open(void); // Start a new platform
85 XBT_PUBLIC(void) sg_platf_close(void); // Finish the creation of the platform
87 XBT_PUBLIC(void) sg_platf_new_AS_open(const char *id, const char *mode); // Begin description of new AS
88 XBT_PUBLIC(void) sg_platf_new_AS_close(void); // That AS is fully described
90 XBT_PUBLIC(void) sg_platf_new_host (sg_platf_host_cbarg_t host); // Add an host to the currently described AS
91 XBT_PUBLIC(void) sg_platf_new_router(sg_platf_router_cbarg_t router); // Add a router to the currently described AS
92 XBT_PUBLIC(void) sg_platf_new_link (sg_platf_link_cbarg_t link); // Add a link to the currently described AS
93 XBT_PUBLIC(void) sg_platf_new_peer(sg_platf_peer_cbarg_t peer); // Add a peer to the currently described AS
96 #endif /* SG_PLATF_H */