Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
428e2b7f6c2454e921b4128eaa19ff5274737899
[simgrid.git] / include / simgrid / host.h
1 /* Copyright (c) 2013-2015. The SimGrid Team.
2  * All rights reserved.                                                     */
3
4 /* This program is free software; you can redistribute it and/or modify it
5  * under the terms of the license (GNU LGPL) which comes with this package. */
6
7 #ifndef SIMGRID_HOST_H_
8 #define SIMGRID_HOST_H_
9
10 #include <stddef.h>
11
12 #include <xbt/dict.h>
13 #include <xbt/dynar.h>
14
15 #include <simgrid/forward.h>
16
17 #ifdef __cplusplus
18 #include <simgrid/Host.hpp>
19 #endif
20
21 SG_BEGIN_DECL()
22
23 XBT_PUBLIC(size_t) sg_host_count();
24 XBT_PUBLIC(size_t) sg_host_extension_create(void(*deleter)(void*));
25 XBT_PUBLIC(void*) sg_host_extension_get(sg_host_t host, size_t rank);
26 XBT_PUBLIC(sg_host_t) sg_host_by_name(const char *name);
27 XBT_PUBLIC(sg_host_t) sg_host_by_name_or_create(const char *name);
28 XBT_PUBLIC(const char*) sg_host_get_name(sg_host_t host);
29 XBT_PUBLIC(xbt_dynar_t) sg_hosts_as_dynar(void);
30
31 // ========== User Data ==============
32 XBT_PUBLIC(void*) sg_host_user(sg_host_t host);
33 XBT_PUBLIC(void) sg_host_user_set(sg_host_t host, void* userdata);
34 XBT_PUBLIC(void) sg_host_user_destroy(sg_host_t host);
35
36 // ========== MSG Layer ==============
37 typedef struct s_msg_host_priv *msg_host_priv_t;
38 msg_host_priv_t sg_host_msg(sg_host_t host);
39 XBT_PUBLIC(void) sg_host_msg_set(sg_host_t host, msg_host_priv_t priv);
40 XBT_PUBLIC(void) sg_host_msg_destroy(sg_host_t host);
41
42 // ========== SD Layer ==============
43 typedef struct SD_workstation *SD_workstation_priv_t;
44 SD_workstation_priv_t sg_host_sd(sg_host_t host);
45 XBT_PUBLIC(void) sg_host_sd_set(sg_host_t host, SD_workstation_priv_t priv);
46 XBT_PUBLIC(void) sg_host_sd_destroy(sg_host_t host);
47
48 // ========== Simix layer =============
49 typedef struct s_smx_host_priv *smx_host_priv_t;
50 XBT_PUBLIC(smx_host_priv_t) sg_host_simix(sg_host_t host);
51 XBT_PUBLIC(void) sg_host_simix_set(sg_host_t host, smx_host_priv_t priv);
52 XBT_PUBLIC(void) sg_host_simix_destroy(sg_host_t host);
53
54 // Module initializer. Won't survive the conversion to C++. Hopefully.
55 XBT_PUBLIC(void) sg_host_init(void);
56
57 // =========== user-level functions ===============
58 XBT_PUBLIC(double) sg_host_get_available_speed(sg_host_t host);
59 XBT_PUBLIC(int) sg_host_is_on(sg_host_t host);
60
61 XBT_PUBLIC(int) sg_host_get_nb_pstates(sg_host_t host);
62 XBT_PUBLIC(int) sg_host_get_pstate(sg_host_t host);
63 XBT_PUBLIC(double) sg_host_get_consumed_energy(sg_host_t host);
64
65 SG_END_DECL()
66
67 #endif /* SIMGRID_HOST_H_ */