diff options
Diffstat (limited to 'static/freebsd/man9/fetch.9 3.html')
| -rw-r--r-- | static/freebsd/man9/fetch.9 3.html | 130 |
1 files changed, 0 insertions, 130 deletions
diff --git a/static/freebsd/man9/fetch.9 3.html b/static/freebsd/man9/fetch.9 3.html deleted file mode 100644 index 05657272..00000000 --- a/static/freebsd/man9/fetch.9 3.html +++ /dev/null @@ -1,130 +0,0 @@ -<table class="head"> - <tr> - <td class="head-ltitle">FETCH(9)</td> - <td class="head-vol">Kernel Developer's Manual</td> - <td class="head-rtitle">FETCH(9)</td> - </tr> -</table> -<div class="manual-text"> -<section class="Sh"> -<h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1> -<p class="Pp"><code class="Nm">fetch</code>, <code class="Nm">fubyte</code>, - <code class="Nm">fuword</code>, <code class="Nm">fuword16</code>, - <code class="Nm">fuword32</code>, <code class="Nm">fuword64</code>, - <code class="Nm">fueword</code>, <code class="Nm">fueword32</code>, - <code class="Nm">fueword64</code> — <span class="Nd">fetch data from - user-space</span></p> -</section> -<section class="Sh"> -<h1 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1> -<p class="Pp"><code class="In">#include - <<a class="In">sys/types.h</a>></code> - <br/> - <code class="In">#include <<a class="In">sys/systm.h</a>></code></p> -<p class="Pp"><var class="Ft">int</var> - <br/> - <code class="Fn">fubyte</code>(<var class="Fa" style="white-space: nowrap;">volatile - const void *base</var>);</p> -<p class="Pp"><var class="Ft">long</var> - <br/> - <code class="Fn">fuword</code>(<var class="Fa" style="white-space: nowrap;">volatile - const void *base</var>);</p> -<p class="Pp"><var class="Ft">int</var> - <br/> - <code class="Fn">fuword16</code>(<var class="Fa" style="white-space: nowrap;">volatile - const void *base</var>);</p> -<p class="Pp"><var class="Ft">int32_t</var> - <br/> - <code class="Fn">fuword32</code>(<var class="Fa" style="white-space: nowrap;">volatile - const void *base</var>);</p> -<p class="Pp"><var class="Ft">int64_t</var> - <br/> - <code class="Fn">fuword64</code>(<var class="Fa" style="white-space: nowrap;">volatile - const void *base</var>);</p> -<p class="Pp"><var class="Ft">int</var> - <br/> - <code class="Fn">fueword</code>(<var class="Fa" style="white-space: nowrap;">volatile - const void *base</var>, <var class="Fa" style="white-space: nowrap;">long - *val</var>);</p> -<p class="Pp"><var class="Ft">int</var> - <br/> - <code class="Fn">fueword32</code>(<var class="Fa" style="white-space: nowrap;">volatile - const void *base</var>, <var class="Fa" style="white-space: nowrap;">int32_t - *val</var>);</p> -<p class="Pp"><var class="Ft">int</var> - <br/> - <code class="Fn">fueword64</code>(<var class="Fa" style="white-space: nowrap;">volatile - const void *base</var>, <var class="Fa" style="white-space: nowrap;">int64_t - *val</var>);</p> -</section> -<section class="Sh"> -<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1> -<p class="Pp">The <code class="Nm">fetch</code> functions are designed to copy - small amounts of data from user-space of the current process. If the user - address is naturally aligned, then the operation will be performed - atomically. Otherwise it may fail or be performed non-atomically, depending - on the platform.</p> -<p class="Pp">The <code class="Nm">fetch</code> routines provide the following - functionality:</p> -<dl class="Bl-tag"> - <dt id="fubyte"><a class="permalink" href="#fubyte"><code class="Fn">fubyte</code></a>()</dt> - <dd>Fetches a byte of data from the user-space address - <span class="Pa">base</span>. The byte read is zero-extended into the - results variable.</dd> - <dt><code class="Fn">fuword</code>()</dt> - <dd>Fetches a word of data (long) from the user-space address - <span class="Pa">base</span>.</dd> - <dt id="fuword16"><a class="permalink" href="#fuword16"><code class="Fn">fuword16</code></a>()</dt> - <dd>Fetches 16 bits of data from the user-space address - <span class="Pa">base</span>. The half-word read is zero-extended into the - results variable.</dd> - <dt><code class="Fn">fuword32</code>()</dt> - <dd>Fetches 32 bits of data from the user-space address - <span class="Pa">base</span>.</dd> - <dt><code class="Fn">fuword64</code>()</dt> - <dd>Fetches 64 bits of data from the user-space address - <span class="Pa">base</span>.</dd> - <dt id="fueword"><a class="permalink" href="#fueword"><code class="Fn">fueword</code></a>()</dt> - <dd>Fetches a word of data (long) from the user-space address - <span class="Pa">base</span> and stores the result in the variable pointed - by <span class="Pa">val</span>.</dd> - <dt id="fueword32"><a class="permalink" href="#fueword32"><code class="Fn">fueword32</code></a>()</dt> - <dd>Fetches 32 bits of data from the user-space address - <span class="Pa">base</span> and stores the result in the variable pointed - by <span class="Pa">val</span>.</dd> - <dt id="fueword64"><a class="permalink" href="#fueword64"><code class="Fn">fueword64</code></a>()</dt> - <dd>Fetches 64 bits of data from the user-space address - <span class="Pa">base</span> and stores the result in the variable pointed - by <span class="Pa">val</span>.</dd> -</dl> -<p class="Pp" id="fuword">The callers of - <a class="permalink" href="#fuword"><code class="Fn">fuword</code></a>(), - <a class="permalink" href="#fuword32"><code class="Fn" id="fuword32">fuword32</code></a>() - and - <a class="permalink" href="#fuword64"><code class="Fn" id="fuword64">fuword64</code></a>() - functions cannot distinguish between -1 read from userspace and function - failure.</p> -</section> -<section class="Sh"> -<h1 class="Sh" id="RETURN_VALUES"><a class="permalink" href="#RETURN_VALUES">RETURN - VALUES</a></h1> -<p class="Pp">The <code class="Fn">fubyte</code>(), - <code class="Fn">fuword</code>(), <code class="Fn">fuword16</code>(), - <code class="Fn">fuword32</code>(), and <code class="Fn">fuword64</code>() - functions return the data fetched or -1 on failure. The - <code class="Fn">fueword</code>(), <code class="Fn">fueword32</code>() and - <code class="Fn">fueword64</code>() functions return 0 on success and -1 on - failure.</p> -</section> -<section class="Sh"> -<h1 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE - ALSO</a></h1> -<p class="Pp"><a class="Xr">copy(9)</a>, <a class="Xr">store(9)</a></p> -</section> -</div> -<table class="foot"> - <tr> - <td class="foot-date">July 22, 2021</td> - <td class="foot-os">FreeBSD 15.0</td> - </tr> -</table> |