1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.28 $ -->
<refentry xml:id="function.libvirt-domain-memory-stats" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>libvirt_domain_memory_stats</refname>
<refpurpose>provide memory statistics for the domain.</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>libvirt_domain_memory_stats</methodname>
<methodparam ><type>resource</type><parameter>domain</parameter></methodparam>
<methodparam choice="opt"><type>integer</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<para>
This function provides memory statistics for the domain. Up to <constant>VIR_DOMAIN_MEMORY_STAT_NR</constant> elements will be populated in the returned array with memory statistics from the domain. Only statistics supported by the domain, the driver, and this version of libvirt will be returned. The array is indexed by the numerical values of appropriate constants.
<table frame='all'><title>Possible members of the array returned by libvirt_domain_memory_stats</title>
<tgroup cols='2'>
<tbody>
<row><entry><constant>VIR_DOMAIN_MEMORY_STAT_SWAP_IN</constant></entry><entry>The total amount of data read from swap space (in kb)</entry></row>
<row><entry><constant>VIR_DOMAIN_MEMORY_STAT_SWAP_OUT</constant></entry><entry>The total amount of memory written out to swap space (in kb)</entry></row>
<row><entry><constant>VIR_DOMAIN_MEMORY_STAT_MAJOR_FAULT</constant></entry><entry>The number of page faults that required disk IO to service.</entry></row>
<row><entry><constant>VIR_DOMAIN_MEMORY_STAT_MINOR_FAULT</constant></entry><entry>The number of page faults serviced without disk IO.</entry></row>
<row><entry><constant>VIR_DOMAIN_MEMORY_STAT_UNUSED</constant></entry><entry>The amount of memory which is not being used for any purpose (in kb).</entry></row>
<row><entry><constant>VIR_DOMAIN_MEMORY_STAT_AVAILABLE</constant></entry><entry>The total amount of memory available to the domain's OS (in kb).</entry></row>
<row><entry><constant>VIR_DOMAIN_MEMORY_STAT_NR</constant></entry><entry>.</entry></row>
</tbody>
</tgroup>
</table>
</para>
<note><title>Warning</title>
<para>.
This function returns values that may be bigger than 32bit integer limit. Please read this <link linkend="libvirt.longlong">note</link> for more details.
</para>
</note>
<note><title>Libvirt version</title>
<para>
This function has been added to Libvirt in version 0.7.5. You need this or newer version of Libvirt to be able to use this function.
</para>
</note>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>domain</parameter></term>
<listitem>
<para>
Domain resource of domain to get memory stats.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>flags</parameter></term>
<listitem>
<para>
unused, always pass 0 (or ommit the parameter as 0 is default value
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<!-- See also &return.success; -->
<para>
Array containig Up to <constant>VIR_DOMAIN_MEMORY_STAT_NR</constant> elements with statistics.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>libvirt_domain_block_stats</function></member>
<member><function>libvirt_domain_interface_stats</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
|
