ViewVC Help
View File | Revision Log | Show Annotations | Revision Graph | Root Listing
root/i-scream/projects/libstatgrab/docs/sg_get_page_stats.xml
Revision: 1.2
Committed: Thu Oct 2 17:38:03 2003 UTC (21 years, 1 month ago) by tdb
Content type: text/xml
Branch: MAIN
CVS Tags: LIBSTATGRAB_0_9, LIBSTATGRAB_0_8_2, LIBSTATGRAB_0_8_1, LIBSTATGRAB_0_8, LIBSTATGRAB_0_7, LIBSTATGRAB_0_6_1, LIBSTATGRAB_0_6
Changes since 1.1: +11 -3 lines
Log Message:
Add a central page statgrab(3) which links all the functions together. Add
a link in the See Also section of each manual page back to the central one.

File Contents

# Content
1 <?xml version="1.0"?>
2
3 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
4 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
5
6 <refentry id="get_page_stats">
7
8 <refentryinfo>
9 <date>$Date: 2003/10/02 16:00:05 $</date>
10 <releaseinfo>$Id: get_page_stats.xml,v 1.1 2003/10/02 16:00:05 tdb Exp $</releaseinfo>
11 </refentryinfo>
12
13 <refmeta>
14 <refentrytitle>get_page_stats</refentrytitle>
15 <manvolnum>3</manvolnum>
16 <refmiscinfo>i-scream</refmiscinfo>
17 </refmeta>
18
19 <refnamediv>
20 <refname>get_page_stats</refname>
21 <refname>get_page_stats_diff</refname>
22 <refpurpose>get paging statistics</refpurpose>
23 </refnamediv>
24
25 <refsynopsisdiv>
26 <funcsynopsis>
27 <funcsynopsisinfo>#include &lt;statgrab.h&gt;</funcsynopsisinfo>
28 <funcprototype>
29 <funcdef>page_stat_t *<function>get_page_stats</function></funcdef>
30 <void/>
31 </funcprototype>
32 <funcprototype>
33 <funcdef>page_stat_t *<function>get_page_stats_diff</function></funcdef>
34 <void/>
35 </funcprototype>
36 </funcsynopsis>
37 </refsynopsisdiv>
38
39 <refsect1>
40 <title>Description</title>
41 <para>
42 <function>get_page_stats</function> and
43 <function>get_page_stats_diff</function> both return a pointer to
44 a static buffer of type <structname>page_stat_t</structname>.
45 </para>
46 <para>
47 <function>get_page_stats</function> will return the number of
48 pages the system has paged in and out since bootup.
49 <function>get_page_stats_diff</function> will return the
50 difference since last time it was called. If it has not been
51 called before, it will return
52 <function>get_page_stats</function>.
53 </para>
54 </refsect1>
55
56 <refsect1>
57 <title>Return Values</title>
58
59 <programlisting>
60 typedef struct{
61 long long pages_pagein;
62 long long pages_pageout;
63 time_t systime;
64 }page_stat_t;
65 </programlisting>
66
67 <variablelist>
68 <varlistentry>
69 <term>
70 <structfield>pages_pagein</structfield>
71 </term>
72 <listitem>
73 <para>
74 The number of pages swapped into memory.
75 </para>
76 </listitem>
77 </varlistentry>
78 <varlistentry>
79 <term>
80 <structfield>pages_pageout</structfield>
81 </term>
82 <listitem>
83 <para>
84 The number of pages swapped out of memory (to swap).
85 </para>
86 </listitem>
87 </varlistentry>
88 <varlistentry>
89 <term>
90 <structfield>systime</structfield>
91 </term>
92 <listitem>
93 <para>
94 The time period over which <parameter>pages_pagein</parameter>
95 and <parameter>pages_pageout</parameter> were transferred.
96 </para>
97 </listitem>
98 </varlistentry>
99 </variablelist>
100 </refsect1>
101
102 <refsect1>
103 <title>Bugs</title>
104 <para>
105 Solaris doesn't seem to report accurately. It reports the number
106 of pages swapped into memory, not necessarily from swap. This
107 feature isn't deemed entirely reliable.
108 </para>
109 </refsect1>
110
111 <refsect1>
112 <title>See Also</title>
113
114 <simplelist type="inline">
115 <member>
116 <citerefentry>
117 <refentrytitle>statgrab</refentrytitle>
118 <manvolnum>3</manvolnum>
119 </citerefentry>
120 </member>
121 </simplelist>
122 </refsect1>
123
124 <refsect1>
125 <title>Website</title>
126
127 <simplelist type="vert">
128 <member>
129 <ulink url="http://www.i-scream.org">http://www.i-scream.org</ulink>
130 </member>
131 </simplelist>
132 </refsect1>
133
134 </refentry>