Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Don't include private header from public ones.
[simgrid.git] / src / include / simgrid / platf_interface.h
1 /* platf_interface.h - Internal interface to the SimGrid platforms          */
2
3 /* Copyright (c) 2004-2007, 2009-2014. 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_INTERFACE_H
10 #define SG_PLATF_INTERFACE_H
11
12 #include "simgrid/platf.h" /* public interface */
13 #include "xbt/RngStream.h"
14
15 SG_BEGIN_DECL()
16
17 /* Module management functions */
18 XBT_PUBLIC(void) sg_platf_init(void);
19 XBT_PUBLIC(void) sg_platf_exit(void);
20
21 /* Managing the parsing callbacks */
22
23 typedef void (*sg_platf_host_cb_t)(sg_platf_host_cbarg_t);
24 typedef void (*sg_platf_host_link_cb_t)(sg_platf_host_link_cbarg_t);
25 typedef void (*sg_platf_router_cb_t)(sg_platf_router_cbarg_t);
26 typedef void (*sg_platf_link_cb_t)(sg_platf_link_cbarg_t);
27 typedef void (*sg_platf_peer_cb_t)(sg_platf_peer_cbarg_t);
28 typedef void (*sg_platf_cluster_cb_t)(sg_platf_cluster_cbarg_t);
29 typedef void (*sg_platf_cabinet_cb_t)(sg_platf_cabinet_cbarg_t);
30 typedef void (*sg_platf_AS_cb_t)(sg_platf_AS_cbarg_t);
31 typedef void (*sg_platf_prop_cb_t)(sg_platf_prop_cbarg_t);
32
33 typedef void (*sg_platf_route_cb_t)(sg_platf_route_cbarg_t);
34
35 typedef void (*sg_platf_trace_cb_t)(sg_platf_trace_cbarg_t);
36 typedef void (*sg_platf_trace_connect_cb_t)(sg_platf_trace_connect_cbarg_t);
37
38 typedef void (*sg_platf_storage_cb_t)(sg_platf_storage_cbarg_t);
39 typedef void (*sg_platf_storage_type_cb_t)(sg_platf_storage_type_cbarg_t);
40 typedef void (*sg_platf_mount_cb_t)(sg_platf_mount_cbarg_t);
41 typedef void (*sg_platf_mstorage_cb_t)(sg_platf_mstorage_cbarg_t);
42
43 /* ***************************************** */
44 /* TUTORIAL: New TAG                         */
45
46 typedef void (*sg_platf_gpu_cb_t)(sg_platf_gpu_cbarg_t);
47 XBT_PUBLIC(void) sg_platf_gpu_add_cb(sg_platf_gpu_cb_t);
48 /* ***************************************** */
49
50 XBT_PUBLIC(void) sg_platf_host_add_cb(sg_platf_host_cb_t);
51 XBT_PUBLIC(void) sg_platf_host_link_add_cb(sg_platf_host_link_cb_t);
52 XBT_PUBLIC(void) sg_platf_router_add_cb(sg_platf_router_cb_t);
53 XBT_PUBLIC(void) sg_platf_link_add_cb(sg_platf_link_cb_t);
54 XBT_PUBLIC(void) sg_platf_peer_add_cb(sg_platf_peer_cb_t fct);
55 XBT_PUBLIC(void) sg_platf_cluster_add_cb(sg_platf_cluster_cb_t fct);
56 XBT_PUBLIC(void) sg_platf_cabinet_add_cb(sg_platf_cabinet_cb_t fct);
57 XBT_PUBLIC(void) sg_platf_postparse_add_cb(void_f_void_t fct);
58 XBT_PUBLIC(void) sg_platf_AS_begin_add_cb(sg_platf_AS_cb_t fct);
59 XBT_PUBLIC(void) sg_platf_AS_end_add_cb(sg_platf_AS_cb_t fct);
60 XBT_PUBLIC(void) sg_platf_prop_add_cb(sg_platf_prop_cb_t fct);
61
62 XBT_PUBLIC(void) sg_platf_route_add_cb(sg_platf_route_cb_t);
63 XBT_PUBLIC(void) sg_platf_ASroute_add_cb(sg_platf_route_cb_t);
64 XBT_PUBLIC(void) sg_platf_bypassRoute_add_cb(sg_platf_route_cb_t);
65 XBT_PUBLIC(void) sg_platf_bypassASroute_add_cb(sg_platf_route_cb_t);
66
67 XBT_PUBLIC(void) sg_platf_trace_add_cb(sg_platf_trace_cb_t);
68 XBT_PUBLIC(void) sg_platf_trace_connect_add_cb(sg_platf_trace_connect_cb_t);
69
70 XBT_PUBLIC(void) sg_platf_storage_add_cb(sg_platf_storage_cb_t fct);
71 XBT_PUBLIC(void) sg_platf_mstorage_add_cb(sg_platf_mstorage_cb_t fct);
72 XBT_PUBLIC(void) sg_platf_storage_type_add_cb(sg_platf_storage_type_cb_t fct);
73 XBT_PUBLIC(void) sg_platf_mount_add_cb(sg_platf_mount_cb_t fct);
74
75 /** \brief Pick the right models for CPU, net and workstation, and call their model_init_preparse
76  *
77  * Must be called within parsing/creating the environment (after the <config>s, if any, and before <AS> or friends such as <cluster>)
78  */
79 XBT_PUBLIC(void) surf_config_models_setup(void);
80
81 /* RngStream management functions */
82 XBT_PUBLIC(void) sg_platf_rng_stream_init(unsigned long seed[6]);
83 XBT_PUBLIC(RngStream) sg_platf_rng_stream_get(const char* id);
84
85 SG_END_DECL()
86
87 #endif                          /* SG_PLATF_INTERFACE_H */