Blob Blame History Raw
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>cpu: Libgtop Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="Libgtop Reference Manual">
<link rel="up" href="libgtop-lib.html" title="Libgtop Library Reference">
<link rel="prev" href="libgtop-msg-limits.html" title="msg_limits">
<link rel="next" href="libgtop-swap.html" title="swap">
<meta name="generator" content="GTK-Doc V1.25 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#libgtop-cpu.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="libgtop-lib.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="libgtop-msg-limits.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="libgtop-swap.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="libgtop-cpu"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libgtop-cpu.top_of_page"></a>cpu</span></h2>
<p>cpu</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libgtop-cpu.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="libgtop-cpu.html#glibtop-get-cpu" title="glibtop_get_cpu ()">glibtop_get_cpu</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="libgtop-cpu.html#glibtop-get-cpu-l" title="glibtop_get_cpu_l ()">glibtop_get_cpu_l</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="libgtop-cpu.html#glibtop-get-cpu-p" title="glibtop_get_cpu_p ()">glibtop_get_cpu_p</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="libgtop-cpu.html#glibtop-get-cpu-s" title="glibtop_get_cpu_s ()">glibtop_get_cpu_s</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libgtop-cpu.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="libgtop-cpu.html#GLIBTOP-CPU-TOTAL:CAPS" title="GLIBTOP_CPU_TOTAL">GLIBTOP_CPU_TOTAL</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="libgtop-cpu.html#GLIBTOP-CPU-USER:CAPS" title="GLIBTOP_CPU_USER">GLIBTOP_CPU_USER</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="libgtop-cpu.html#GLIBTOP-CPU-NICE:CAPS" title="GLIBTOP_CPU_NICE">GLIBTOP_CPU_NICE</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="libgtop-cpu.html#GLIBTOP-CPU-SYS:CAPS" title="GLIBTOP_CPU_SYS">GLIBTOP_CPU_SYS</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="libgtop-cpu.html#GLIBTOP-CPU-IDLE:CAPS" title="GLIBTOP_CPU_IDLE">GLIBTOP_CPU_IDLE</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="libgtop-cpu.html#GLIBTOP-CPU-FREQUENCY:CAPS" title="GLIBTOP_CPU_FREQUENCY">GLIBTOP_CPU_FREQUENCY</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="libgtop-cpu.html#GLIBTOP-XCPU-TOTAL:CAPS" title="GLIBTOP_XCPU_TOTAL">GLIBTOP_XCPU_TOTAL</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="libgtop-cpu.html#GLIBTOP-XCPU-USER:CAPS" title="GLIBTOP_XCPU_USER">GLIBTOP_XCPU_USER</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="libgtop-cpu.html#GLIBTOP-XCPU-NICE:CAPS" title="GLIBTOP_XCPU_NICE">GLIBTOP_XCPU_NICE</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="libgtop-cpu.html#GLIBTOP-XCPU-SYS:CAPS" title="GLIBTOP_XCPU_SYS">GLIBTOP_XCPU_SYS</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="libgtop-cpu.html#GLIBTOP-XCPU-IDLE:CAPS" title="GLIBTOP_XCPU_IDLE">GLIBTOP_XCPU_IDLE</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="libgtop-cpu.html#GLIBTOP-XCPU-FLAGS:CAPS" title="GLIBTOP_XCPU_FLAGS">GLIBTOP_XCPU_FLAGS</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="libgtop-cpu.html#GLIBTOP-CPU-IOWAIT:CAPS" title="GLIBTOP_CPU_IOWAIT">GLIBTOP_CPU_IOWAIT</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="libgtop-cpu.html#GLIBTOP-CPU-IRQ:CAPS" title="GLIBTOP_CPU_IRQ">GLIBTOP_CPU_IRQ</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="libgtop-cpu.html#GLIBTOP-CPU-SOFTIRQ:CAPS" title="GLIBTOP_CPU_SOFTIRQ">GLIBTOP_CPU_SOFTIRQ</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="libgtop-cpu.html#GLIBTOP-XCPU-IOWAIT:CAPS" title="GLIBTOP_XCPU_IOWAIT">GLIBTOP_XCPU_IOWAIT</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="libgtop-cpu.html#GLIBTOP-XCPU-IRQ:CAPS" title="GLIBTOP_XCPU_IRQ">GLIBTOP_XCPU_IRQ</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="libgtop-cpu.html#GLIBTOP-XCPU-SOFTIRQ:CAPS" title="GLIBTOP_XCPU_SOFTIRQ">GLIBTOP_XCPU_SOFTIRQ</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="libgtop-cpu.html#GLIBTOP-MAX-CPU:CAPS" title="GLIBTOP_MAX_CPU">GLIBTOP_MAX_CPU</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="libgtop-cpu.html#GLIBTOP-NCPU:CAPS" title="GLIBTOP_NCPU">GLIBTOP_NCPU</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="libgtop-cpu.html#glibtop-cpu" title="struct glibtop_cpu">glibtop_cpu</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="libgtop-cpu.html#glibtop-get-cpu-r" title="glibtop_get_cpu_r">glibtop_get_cpu_r</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libgtop-cpu.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;glibtop/cpu.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="libgtop-cpu.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="libgtop-cpu.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="glibtop-get-cpu"></a><h3>glibtop_get_cpu ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
glibtop_get_cpu (<em class="parameter"><code><a class="link" href="libgtop-cpu.html#glibtop-cpu" title="struct glibtop_cpu"><span class="type">glibtop_cpu</span></a> *buf</code></em>);</pre>
<p>Get the CPU usage.</p>
<p>All CPU units are measured in <span class="type">jiffies</span> which are normally
1/100th of a second (in which case <span class="type">frequency</span> equals 100),
but can also be in any other unit. To get seconds, divide them by </p>
<span class="type">frequency</span>.
<div class="refsect3">
<a name="glibtop-get-cpu.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>buf</p></td>
<td class="parameter_description"><p>A location to return the CPU usage.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="glibtop-get-cpu-l"></a><h3>glibtop_get_cpu_l ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
glibtop_get_cpu_l (<em class="parameter"><code><a class="link" href="libgtop-GlibTop.html#glibtop" title="struct glibtop"><span class="type">glibtop</span></a> *server</code></em>,
                   <em class="parameter"><code><a class="link" href="libgtop-cpu.html#glibtop-cpu" title="struct glibtop_cpu"><span class="type">glibtop_cpu</span></a> *buf</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="glibtop-get-cpu-p"></a><h3>glibtop_get_cpu_p ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
glibtop_get_cpu_p (<em class="parameter"><code><a class="link" href="libgtop-GlibTop.html#glibtop" title="struct glibtop"><span class="type">glibtop</span></a> *server</code></em>,
                   <em class="parameter"><code><a class="link" href="libgtop-cpu.html#glibtop-cpu" title="struct glibtop_cpu"><span class="type">glibtop_cpu</span></a> *buf</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="glibtop-get-cpu-s"></a><h3>glibtop_get_cpu_s ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
glibtop_get_cpu_s (<em class="parameter"><code><a class="link" href="libgtop-GlibTop.html#glibtop" title="struct glibtop"><span class="type">glibtop</span></a> *server</code></em>,
                   <em class="parameter"><code><a class="link" href="libgtop-cpu.html#glibtop-cpu" title="struct glibtop_cpu"><span class="type">glibtop_cpu</span></a> *buf</code></em>);</pre>
</div>
</div>
<div class="refsect1">
<a name="libgtop-cpu.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GLIBTOP-CPU-TOTAL:CAPS"></a><h3>GLIBTOP_CPU_TOTAL</h3>
<pre class="programlisting">#define GLIBTOP_CPU_TOTAL 0
</pre>
</div>
<hr>
<div class="refsect2">
<a name="GLIBTOP-CPU-USER:CAPS"></a><h3>GLIBTOP_CPU_USER</h3>
<pre class="programlisting">#define GLIBTOP_CPU_USER 1
</pre>
</div>
<hr>
<div class="refsect2">
<a name="GLIBTOP-CPU-NICE:CAPS"></a><h3>GLIBTOP_CPU_NICE</h3>
<pre class="programlisting">#define GLIBTOP_CPU_NICE 2
</pre>
</div>
<hr>
<div class="refsect2">
<a name="GLIBTOP-CPU-SYS:CAPS"></a><h3>GLIBTOP_CPU_SYS</h3>
<pre class="programlisting">#define GLIBTOP_CPU_SYS		3
</pre>
</div>
<hr>
<div class="refsect2">
<a name="GLIBTOP-CPU-IDLE:CAPS"></a><h3>GLIBTOP_CPU_IDLE</h3>
<pre class="programlisting">#define GLIBTOP_CPU_IDLE 4
</pre>
</div>
<hr>
<div class="refsect2">
<a name="GLIBTOP-CPU-FREQUENCY:CAPS"></a><h3>GLIBTOP_CPU_FREQUENCY</h3>
<pre class="programlisting">#define GLIBTOP_CPU_FREQUENCY 5
</pre>
</div>
<hr>
<div class="refsect2">
<a name="GLIBTOP-XCPU-TOTAL:CAPS"></a><h3>GLIBTOP_XCPU_TOTAL</h3>
<pre class="programlisting">#define GLIBTOP_XCPU_TOTAL 6
</pre>
</div>
<hr>
<div class="refsect2">
<a name="GLIBTOP-XCPU-USER:CAPS"></a><h3>GLIBTOP_XCPU_USER</h3>
<pre class="programlisting">#define GLIBTOP_XCPU_USER 7
</pre>
</div>
<hr>
<div class="refsect2">
<a name="GLIBTOP-XCPU-NICE:CAPS"></a><h3>GLIBTOP_XCPU_NICE</h3>
<pre class="programlisting">#define GLIBTOP_XCPU_NICE 8
</pre>
</div>
<hr>
<div class="refsect2">
<a name="GLIBTOP-XCPU-SYS:CAPS"></a><h3>GLIBTOP_XCPU_SYS</h3>
<pre class="programlisting">#define GLIBTOP_XCPU_SYS 9
</pre>
</div>
<hr>
<div class="refsect2">
<a name="GLIBTOP-XCPU-IDLE:CAPS"></a><h3>GLIBTOP_XCPU_IDLE</h3>
<pre class="programlisting">#define GLIBTOP_XCPU_IDLE 10
</pre>
</div>
<hr>
<div class="refsect2">
<a name="GLIBTOP-XCPU-FLAGS:CAPS"></a><h3>GLIBTOP_XCPU_FLAGS</h3>
<pre class="programlisting">#define GLIBTOP_XCPU_FLAGS 11
</pre>
</div>
<hr>
<div class="refsect2">
<a name="GLIBTOP-CPU-IOWAIT:CAPS"></a><h3>GLIBTOP_CPU_IOWAIT</h3>
<pre class="programlisting">#define GLIBTOP_CPU_IOWAIT 12
</pre>
</div>
<hr>
<div class="refsect2">
<a name="GLIBTOP-CPU-IRQ:CAPS"></a><h3>GLIBTOP_CPU_IRQ</h3>
<pre class="programlisting">#define GLIBTOP_CPU_IRQ		13
</pre>
</div>
<hr>
<div class="refsect2">
<a name="GLIBTOP-CPU-SOFTIRQ:CAPS"></a><h3>GLIBTOP_CPU_SOFTIRQ</h3>
<pre class="programlisting">#define GLIBTOP_CPU_SOFTIRQ 14
</pre>
</div>
<hr>
<div class="refsect2">
<a name="GLIBTOP-XCPU-IOWAIT:CAPS"></a><h3>GLIBTOP_XCPU_IOWAIT</h3>
<pre class="programlisting">#define GLIBTOP_XCPU_IOWAIT 15
</pre>
</div>
<hr>
<div class="refsect2">
<a name="GLIBTOP-XCPU-IRQ:CAPS"></a><h3>GLIBTOP_XCPU_IRQ</h3>
<pre class="programlisting">#define GLIBTOP_XCPU_IRQ 16
</pre>
</div>
<hr>
<div class="refsect2">
<a name="GLIBTOP-XCPU-SOFTIRQ:CAPS"></a><h3>GLIBTOP_XCPU_SOFTIRQ</h3>
<pre class="programlisting">#define GLIBTOP_XCPU_SOFTIRQ 17
</pre>
</div>
<hr>
<div class="refsect2">
<a name="GLIBTOP-MAX-CPU:CAPS"></a><h3>GLIBTOP_MAX_CPU</h3>
<pre class="programlisting">#define GLIBTOP_MAX_CPU		18
</pre>
</div>
<hr>
<div class="refsect2">
<a name="GLIBTOP-NCPU:CAPS"></a><h3>GLIBTOP_NCPU</h3>
<pre class="programlisting">#define GLIBTOP_NCPU		1024
</pre>
</div>
<hr>
<div class="refsect2">
<a name="glibtop-cpu"></a><h3>struct glibtop_cpu</h3>
<pre class="programlisting">struct glibtop_cpu {
	guint64 flags;
	guint64 total;				/* GLIBTOP_CPU_TOTAL		*/
	guint64 user;				/* GLIBTOP_CPU_USER		*/
	guint64 nice;				/* GLIBTOP_CPU_NICE		*/
	guint64 sys;				/* GLIBTOP_CPU_SYS		*/
	guint64 idle;				/* GLIBTOP_CPU_IDLE		*/
	guint64 iowait;				/* GLIBTOP_CPU_IOWAIT		*/
	guint64 irq;				/* GLIBTOP_CPU_IRQ		*/
	guint64 softirq;			/* GLIBTOP_CPU_SOFTIRQ		*/
	guint64 frequency;			/* GLIBTOP_CPU_FREQUENCY */
	guint64 xcpu_total [GLIBTOP_NCPU]; /* GLIBTOP_XCPU_TOTAL		*/
	guint64 xcpu_user [GLIBTOP_NCPU]; /* GLIBTOP_XCPU_USER		*/
	guint64 xcpu_nice [GLIBTOP_NCPU]; /* GLIBTOP_XCPU_NICE		*/
	guint64 xcpu_sys  [GLIBTOP_NCPU]; /* GLIBTOP_XCPU_SYS		*/
	guint64 xcpu_idle [GLIBTOP_NCPU]; /* GLIBTOP_XCPU_IDLE		*/
	guint64 xcpu_iowait [GLIBTOP_NCPU]; /* GLIBTOP_XCPU_IOWAIT		*/
	guint64 xcpu_irq [GLIBTOP_NCPU]; /* GLIBTOP_XCPU_IRQ		*/
	guint64 xcpu_softirq  [GLIBTOP_NCPU]; /* GLIBTOP_XCPU_SOFTIRQ		*/
	guint64 xcpu_flags;	                /* GLIBTOP_XCPU_IDLE		*/
};
</pre>
</div>
<hr>
<div class="refsect2">
<a name="glibtop-get-cpu-r"></a><h3>glibtop_get_cpu_r</h3>
<pre class="programlisting">#define glibtop_get_cpu_r glibtop_get_cpu_p
</pre>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25</div>
</body>
</html>