/usr/share/gtk-doc/html/libkmod-3/libkmod-libkmod-loaded.html is in libkmod-dev 22-1ubuntu4.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>libkmod-loaded: libkmod Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="libkmod Reference Manual">
<link rel="up" href="ch01.html" title="libkmod">
<link rel="prev" href="libkmod-libkmod-module.html" title="libkmod-module">
<link rel="next" href="api-index-full.html" title="API Index">
<meta name="generator" content="GTK-Doc V1.24 (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="#libkmod-libkmod-loaded.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="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="libkmod-libkmod-module.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="api-index-full.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="libkmod-libkmod-loaded"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libkmod-libkmod-loaded.top_of_page"></a>libkmod-loaded</span></h2>
<p>libkmod-loaded — currently loaded modules</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libkmod-libkmod-loaded.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">int</span>
</td>
<td class="function_name">
<a class="link" href="libkmod-libkmod-loaded.html#kmod-module-new-from-loaded" title="kmod_module_new_from_loaded ()">kmod_module_new_from_loaded</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="libkmod-libkmod-loaded.html#kmod-module-get-initstate" title="kmod_module_get_initstate ()">kmod_module_get_initstate</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">char</span> *
</td>
<td class="function_name">
<a class="link" href="libkmod-libkmod-loaded.html#kmod-module-initstate-str" title="kmod_module_initstate_str ()">kmod_module_initstate_str</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">long</span>
</td>
<td class="function_name">
<a class="link" href="libkmod-libkmod-loaded.html#kmod-module-get-size" title="kmod_module_get_size ()">kmod_module_get_size</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="libkmod-libkmod-loaded.html#kmod-module-get-refcnt" title="kmod_module_get_refcnt ()">kmod_module_get_refcnt</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">struct <a class="link" href="libkmod-libkmod-list.html#kmod-list" title="struct kmod_list"><span class="returnvalue">kmod_list</span></a> *
</td>
<td class="function_name">
<a class="link" href="libkmod-libkmod-loaded.html#kmod-module-get-holders" title="kmod_module_get_holders ()">kmod_module_get_holders</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libkmod-libkmod-loaded.description"></a><h2>Description</h2>
<p>Information about currently loaded modules, as reported by Linux kernel.
These information are not cached by libkmod and are always read from /sys
and /proc/modules.</p>
</div>
<div class="refsect1">
<a name="libkmod-libkmod-loaded.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="kmod-module-new-from-loaded"></a><h3>kmod_module_new_from_loaded ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
kmod_module_new_from_loaded (<em class="parameter"><code><span class="type">struct kmod_ctx</span> *ctx</code></em>,
<em class="parameter"><code><span class="type">struct kmod_list</span> **list</code></em>);</pre>
<p>Create a new list of kmod modules with all modules currently loaded in
kernel. It uses /proc/modules to get the names of loaded modules and to
create kmod modules by calling <a class="link" href="libkmod-libkmod-module.html#kmod-module-new-from-name" title="kmod_module_new_from_name ()"><code class="function">kmod_module_new_from_name()</code></a> in each of them.
They are put in <em class="parameter"><code>list</code></em>
in no particular order.</p>
<p>The initial refcount is 1, and needs to be decremented to release the
resources of the kmod_module. The returned <em class="parameter"><code>list</code></em>
must be released by
calling <a class="link" href="libkmod-libkmod-module.html#kmod-module-unref-list" title="kmod_module_unref_list ()"><code class="function">kmod_module_unref_list()</code></a>. Since libkmod keeps track of all
kmod_modules created, they are all released upon <em class="parameter"><code>ctx</code></em>
destruction too. Do
not unref <em class="parameter"><code>ctx</code></em>
before all the desired operations with the returned list are
completed.</p>
<div class="refsect3">
<a name="id-1.2.6.5.2.6"></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>ctx</p></td>
<td class="parameter_description"><p>kmod library context</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>list</p></td>
<td class="parameter_description"><p>where to save the list of loaded modules</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.6.5.2.7"></a><h4>Returns</h4>
<p> 0 on success or < 0 on error.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="kmod-module-get-initstate"></a><h3>kmod_module_get_initstate ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
kmod_module_get_initstate (<em class="parameter"><code>const <span class="type">struct kmod_module</span> *mod</code></em>);</pre>
<p>Get the initstate of this <em class="parameter"><code>mod</code></em>
, as returned by Linux Kernel, by reading
/sys filesystem.</p>
<div class="refsect3">
<a name="id-1.2.6.5.3.5"></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>mod</p></td>
<td class="parameter_description"><p>kmod module</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.6.5.3.6"></a><h4>Returns</h4>
<p> < 0 on error or module state if module is found in kernel, valid states are
KMOD_MODULE_BUILTIN: module is builtin;
KMOD_MODULE_LIVE: module is live in kernel;
KMOD_MODULE_COMING: module is being loaded;
KMOD_MODULE_GOING: module is being unloaded.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="kmod-module-initstate-str"></a><h3>kmod_module_initstate_str ()</h3>
<pre class="programlisting">const <span class="returnvalue">char</span> *
kmod_module_initstate_str (<em class="parameter"><code><span class="type">enum kmod_module_initstate</span> state</code></em>);</pre>
<p>Translate a initstate to a string.</p>
<div class="refsect3">
<a name="id-1.2.6.5.4.5"></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>state</p></td>
<td class="parameter_description"><p>the state as returned by <a class="link" href="libkmod-libkmod-loaded.html#kmod-module-get-initstate" title="kmod_module_get_initstate ()"><code class="function">kmod_module_get_initstate()</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.6.5.4.6"></a><h4>Returns</h4>
<p> the string associated to the <em class="parameter"><code>state</code></em>
. This string is statically
allocated, do not free it.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="kmod-module-get-size"></a><h3>kmod_module_get_size ()</h3>
<pre class="programlisting"><span class="returnvalue">long</span>
kmod_module_get_size (<em class="parameter"><code>const <span class="type">struct kmod_module</span> *mod</code></em>);</pre>
<p>Get the size of this kmod module as returned by Linux kernel. If supported,
the size is read from the coresize attribute in /sys/module. For older
kernels, this falls back on /proc/modules and searches for the specified
module to get its size.</p>
<div class="refsect3">
<a name="id-1.2.6.5.5.5"></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>mod</p></td>
<td class="parameter_description"><p>kmod module</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.6.5.5.6"></a><h4>Returns</h4>
<p> the size of this kmod module.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="kmod-module-get-refcnt"></a><h3>kmod_module_get_refcnt ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
kmod_module_get_refcnt (<em class="parameter"><code>const <span class="type">struct kmod_module</span> *mod</code></em>);</pre>
<p>Get the ref count of this <em class="parameter"><code>mod</code></em>
, as returned by Linux Kernel, by reading
/sys filesystem.</p>
<div class="refsect3">
<a name="id-1.2.6.5.6.5"></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>mod</p></td>
<td class="parameter_description"><p>kmod module</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.6.5.6.6"></a><h4>Returns</h4>
<p> 0 on success or < 0 on failure.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="kmod-module-get-holders"></a><h3>kmod_module_get_holders ()</h3>
<pre class="programlisting">struct <a class="link" href="libkmod-libkmod-list.html#kmod-list" title="struct kmod_list"><span class="returnvalue">kmod_list</span></a> *
kmod_module_get_holders (<em class="parameter"><code>const <span class="type">struct kmod_module</span> *mod</code></em>);</pre>
<p>Get a list of kmod modules that are holding this <em class="parameter"><code>mod</code></em>
, as returned by Linux
Kernel. After use, free the <em class="parameter"><code>list</code></em>
by calling <a class="link" href="libkmod-libkmod-module.html#kmod-module-unref-list" title="kmod_module_unref_list ()"><code class="function">kmod_module_unref_list()</code></a>.</p>
<div class="refsect3">
<a name="id-1.2.6.5.7.5"></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>mod</p></td>
<td class="parameter_description"><p>kmod module</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.6.5.7.6"></a><h4>Returns</h4>
<p> a new list of kmod modules on success or NULL on failure.</p>
</div>
</div>
</div>
<div class="refsect1">
<a name="libkmod-libkmod-loaded.other_details"></a><h2>Types and Values</h2>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.24</div>
</body>
</html>
|