comparison lxcstats.h @ 12:dbf24a82f625 default tip

Fix doxygen comments and add a Doxyfile
author Louis Opter <kalessin@kalessin.fr>
date Fri, 07 Jan 2011 21:49:31 +0100
parents cff6be97dae1
children
comparison
equal deleted inserted replaced
11:cff6be97dae1 12:dbf24a82f625
19 * The code assumes that the cgroup hierarchy has been created by LXC. In the 19 * The code assumes that the cgroup hierarchy has been created by LXC. In the
20 * future this library could become a generic cgroup statistics library. 20 * future this library could become a generic cgroup statistics library.
21 * 21 *
22 * This library is used to implement the LXC plugin for Collectd. 22 * This library is used to implement the LXC plugin for Collectd.
23 * 23 *
24 * @section see_also See Also 24 * @section sec_api API
25 * 25 *
26 * - <a href="http://lxc.sourceforge.net/">LXC Containers</a>; 26 * The lxcstats.h header contains everything you need.
27 * - <a href="http://collectd.org/">Collectd</a>. 27 *
28 * @section sec_see_also See Also
29 *
30 * - <a href="http://lxc.sourceforge.net/">LXC &mdash; Linux Containers</a>;
31 * - <a href="http://collectd.org/">Collectd &mdash; The system statistics collection daemon</a>.
28 */ 32 */
29 33
30 /** 34 /**
31 * Opaque structure used as a context for all liblxcst functions. 35 * Opaque structure used as a context for all liblxcst functions.
32 */ 36 */
34 38
35 /** 39 /**
36 * This structure contains available statistics on a container. 40 * This structure contains available statistics on a container.
37 */ 41 */
38 struct lxcst { 42 struct lxcst {
39 char *name; /*< Name of the container */ 43 char *name; /**< Name of the container */
40 char *cgroup_dir;/*< cgroup directory of the container */ 44 char *cgroup_dir;/**< cgroup directory of the container */
41 struct { 45 struct {
42 uint32_t user; /*< CPU time spent in userland */ 46 uint32_t user; /**< CPU time spent in userland */
43 uint32_t system; /*< CPU time spent in kernelland */ 47 uint32_t system; /**< CPU time spent in kernelland */
44 uint32_t *percpu; /*< CPU time per CPU (zero-terminated array or NULL) */ 48 uint32_t *percpu; /**< CPU time per CPU (zero-terminated array or NULL) */
45 } cpuacct; /*< CPU accounting in USER_HZ */ 49 } cpuacct; /**< CPU accounting in USER_HZ */
46 struct { 50 struct {
47 uint64_t used; /*< RAM used by applications */ 51 uint64_t used; /**< RAM used by applications */
48 uint64_t mapped; /*< RAM used for mapped file (includes tmpfs/shmem) */ 52 uint64_t mapped; /**< RAM used for mapped file (includes tmpfs/shmem) */
49 uint64_t cached; /*< RAM cached by the kernel */ 53 uint64_t cached; /**< RAM cached by the kernel */
50 uint64_t swapped; /*< SWAP used */ 54 uint64_t swapped; /**< SWAP used */
51 } memory; /*< Memory accounting in bytes */ 55 } memory; /**< Memory accounting in bytes */
52 }; 56 };
53 57
54 /** 58 /**
55 * This structure contains globals statistics on LXC. 59 * This structure contains globals statistics on LXC.
56 * 60 *