libstatgrab/docs/get_page_stats.xml

<?xml version="1.0"?>

<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
               "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">

<refentry id="get_page_stats">

  <refentryinfo>
    <date>$Date: 2004/03/11 17:35:24 $</date>
    <releaseinfo>$Id: get_page_stats.xml,v 1.3 2004/03/11 17:35:24 tdb Exp $</releaseinfo>
  </refentryinfo>
  
  <refmeta>
    <refentrytitle>get_page_stats</refentrytitle>
    <manvolnum>3</manvolnum>
    <refmiscinfo>i-scream</refmiscinfo>
  </refmeta>
  
  <refnamediv>
    <refname>get_page_stats</refname>
    <refname>get_page_stats_diff</refname>
    <refpurpose>get paging statistics</refpurpose>
  </refnamediv>
    
  <refsynopsisdiv>
    <funcsynopsis>
      <funcsynopsisinfo>#include &lt;statgrab.h&gt;</funcsynopsisinfo>
      <funcprototype>
        <funcdef>page_stat_t *<function>get_page_stats</function></funcdef>
        <void/>
      </funcprototype>
      <funcprototype>
        <funcdef>page_stat_t *<function>get_page_stats_diff</function></funcdef>
        <void/>
      </funcprototype>
    </funcsynopsis>
  </refsynopsisdiv>
    
  <refsect1>
    <title>Description</title>
    <para>
      <function>get_page_stats</function> and
      <function>get_page_stats_diff</function> both return a pointer to
      a static buffer of type <structname>page_stat_t</structname>.
    </para>
    <para>
      <function>get_page_stats</function> will return the number of
      pages the system has paged in and out since bootup.
      <function>get_page_stats_diff</function> will return the
      difference since last time it was called.  If it has not been
      called before, it will return
      <function>get_page_stats</function>.
    </para>
  </refsect1>
  
  <refsect1>
    <title>Return Values</title>

    <programlisting>
typedef struct{
        long long pages_pagein;
        long long pages_pageout;
        time_t systime;
}page_stat_t;
    </programlisting>

    <variablelist>
      <varlistentry>
        <term>
          <structfield>pages_pagein</structfield>
        </term>
        <listitem>
          <para>
            The number of pages swapped into memory.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <structfield>pages_pageout</structfield>
        </term>
        <listitem>
          <para>
            The number of pages swapped out of memory (to swap).
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <structfield>systime</structfield>
        </term>
        <listitem>
          <para>
            The time period over which <parameter>pages_pagein</parameter>
            and <parameter>pages_pageout</parameter> were transferred.
          </para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>

  <refsect1>
    <title>Bugs</title>
    <para>
      Solaris doesn't seem to report accurately. It reports the number
      of pages swapped into memory, not necessarily from swap. This
      feature isn't deemed entirely reliable.
    </para>
  </refsect1>

  <refsect1>
    <title>See Also</title>

    <simplelist type="inline">
      <member>
        <citerefentry>
          <refentrytitle>statgrab</refentrytitle>
          <manvolnum>3</manvolnum>
        </citerefentry>
      </member>
    </simplelist>
  </refsect1>
  
  <refsect1>
    <title>Website</title>
    
    <simplelist type="vert">
      <member>
        <ulink url="http://www.i-scream.org/libstatgrab/">
          http://www.i-scream.org/libstatgrab/
        </ulink>
      </member>
    </simplelist>
  </refsect1>

</refentry>
Revision:	1.4
Committed:	Sun May 2 09:35:15 2004 UTC (20 years, 6 months ago) by tdb
Content type:	text/xml
Branch:	MAIN
CVS Tags:	HEAD
Changes since 1.3:	+2 -2 lines
State:	*FILE REMOVED*
Log Message:	Do a repo copy of the documentation to their new names, then delete the old ones. They still need their content updating though. We also need docs for the new process stats stuff, the error reporting code, and I think the FS stats which seem to be missing.
#	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: 2004/03/11 17:35:24 $</date>
10	<releaseinfo>$Id: get_page_stats.xml,v 1.3 2004/03/11 17:35:24 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 <statgrab.h></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/libstatgrab/">
130	http://www.i-scream.org/libstatgrab/
131	</ulink>
132	</member>
133	</simplelist>
134	</refsect1>
135
136	</refentry>