lwres_resutil.html revision 75c0816e8295e180f4bc7f10db3d0d880383bc1c
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<!--
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw - Copyright (C) 2004, 2005 Internet Systems Consortium, Inc. ("ISC")
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw - Copyright (C) 2000, 2001 Internet Software Consortium.
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw -
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw - Permission to use, copy, modify, and distribute this software for any
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw - purpose with or without fee is hereby granted, provided that the above
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw - copyright notice and this permission notice appear in all copies.
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw -
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw - PERFORMANCE OF THIS SOFTWARE.
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw-->
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<!-- $Id: lwres_resutil.html,v 1.17 2005/05/13 03:14:16 marka Exp $ -->
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<html>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<head>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<title>lwres_resutil</title>
faa1795a28a5c712eed6d0a3f84d98c368a316c6jb<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw</head>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<a name="id2456836"></a><div class="titlepage"></div>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<div class="refnamediv">
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<h2>Name</h2>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<p>lwres_string_parse, lwres_addr_parse, lwres_getaddrsbyname, lwres_getnamebyaddr &#8212; lightweight resolver utility functions</p>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw</div>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<div class="refsynopsisdiv">
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<h2>Synopsis</h2>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<div class="funcsynopsis">
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<pre class="funcsynopsisinfo">#include &lt;lwres/lwres.h&gt;</pre>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em">
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<tr>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<td><code class="funcdef">
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amwlwres_result_t
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<b class="fsfunc">lwres_string_parse</b>(</code></td>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<td>lwres_buffer_t *�</td>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<td>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<var class="pdparam">b</var>, </td>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw</tr>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<tr>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<td>�</td>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<td>char **�</td>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<td>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<var class="pdparam">c</var>, </td>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw</tr>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<tr>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<td>�</td>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<td>lwres_uint16_t *�</td>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<td>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<var class="pdparam">len</var><code>)</code>;</td>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw</tr>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw</table>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em">
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<tr>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<td><code class="funcdef">
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amwlwres_result_t
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<b class="fsfunc">lwres_addr_parse</b>(</code></td>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<td>lwres_buffer_t *�</td>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<td>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<var class="pdparam">b</var>, </td>
6537f381d2d9e7b4e2f7b29c3e7a3f13be036f2eas</tr>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<tr>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<td>�</td>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<td>lwres_addr_t *�</td>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<td>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<var class="pdparam">addr</var><code>)</code>;</td>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw</tr>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw</table>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em">
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<tr>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<td><code class="funcdef">
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amwlwres_result_t
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<b class="fsfunc">lwres_getaddrsbyname</b>(</code></td>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<td>lwres_context_t *�</td>
6537f381d2d9e7b4e2f7b29c3e7a3f13be036f2eas<td>
faa1795a28a5c712eed6d0a3f84d98c368a316c6jb<var class="pdparam">ctx</var>, </td>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw</tr>
3db3f65c6274eb042354801a308c8e9bc4994553amw<tr>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<td>�</td>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<td>const char *�</td>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<td>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<var class="pdparam">name</var>, </td>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw</tr>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<tr>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<td>�</td>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<td>lwres_uint32_t �</td>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<td>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<var class="pdparam">addrtypes</var>, </td>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw</tr>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<tr>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<td>�</td>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<td>lwres_gabnresponse_t **�</td>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<td>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<var class="pdparam">structp</var><code>)</code>;</td>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw</tr>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw</table>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0">
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<tr>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<td><code class="funcdef">
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amwlwres_result_t
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<b class="fsfunc">lwres_getnamebyaddr</b>(</code></td>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<td>lwres_context_t *�</td>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<td>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<var class="pdparam">ctx</var>, </td>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw</tr>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<tr>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<td>�</td>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<td>lwres_uint32_t �</td>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<td>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<var class="pdparam">addrtype</var>, </td>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw</tr>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<tr>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<td>�</td>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<td>lwres_uint16_t �</td>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<td>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<var class="pdparam">addrlen</var>, </td>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw</tr>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<tr>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<td>�</td>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<td>const unsigned char *�</td>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<td>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<var class="pdparam">addr</var>, </td>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw</tr>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<tr>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<td>�</td>
<td>lwres_gnbaresponse_t **�</td>
<td>
<var class="pdparam">structp</var><code>)</code>;</td>
</tr>
</table>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2514292"></a><h2>DESCRIPTION</h2>
<p><code class="function">lwres_string_parse()</code>
retrieves a DNS-encoded string starting the current pointer of
lightweight resolver buffer <em class="parameter"><code>b</code></em>: i.e.
<code class="constant">b-&gt;current</code>. When the function returns,
the address of the first byte of the encoded string is returned
via <em class="parameter"><code>*c</code></em> and the length of that string is
given by <em class="parameter"><code>*len</code></em>. The buffer's current
pointer is advanced to point at the character following the
string length, the encoded string, and the trailing
<span class="type">NULL</span> character.
</p>
<p><code class="function">lwres_addr_parse()</code>
extracts an address from the buffer <em class="parameter"><code>b</code></em>.
The buffer's current pointer <code class="constant">b-&gt;current</code>
is presumed to point at an encoded address: the address preceded
by a 32-bit protocol family identifier and a 16-bit length
field. The encoded address is copied to
<code class="constant">addr-&gt;address</code> and
<code class="constant">addr-&gt;length</code> indicates the size in bytes
of the address that was copied.
<code class="constant">b-&gt;current</code> is advanced to point at the
next byte of available data in the buffer following the encoded
address.
</p>
<p><code class="function">lwres_getaddrsbyname()</code>
and <code class="function">lwres_getnamebyaddr()</code> use the
<span class="type">lwres_gnbaresponse_t</span> structure defined below:
</p>
<pre class="programlisting">
typedef struct {
lwres_uint32_t flags;
lwres_uint16_t naliases;
lwres_uint16_t naddrs;
char *realname;
char **aliases;
lwres_uint16_t realnamelen;
lwres_uint16_t *aliaslen;
lwres_addrlist_t addrs;
void *base;
size_t baselen;
} lwres_gabnresponse_t;
</pre>
<p>
The contents of this structure are not manipulated directly but
they are controlled through the
<span class="citerefentry"><span class="refentrytitle">lwres_gabn</span>(3)</span>
functions.
</p>
<p>
The lightweight resolver uses
<code class="function">lwres_getaddrsbyname()</code> to perform
foward lookups.
Hostname <em class="parameter"><code>name</code></em> is looked up using the
resolver
context <em class="parameter"><code>ctx</code></em> for memory allocation.
<em class="parameter"><code>addrtypes</code></em> is a bitmask indicating
which type of
addresses are to be looked up. Current values for this bitmask are
<span class="type">LWRES_ADDRTYPE_V4</span> for IPv4 addresses and
<span class="type">LWRES_ADDRTYPE_V6</span> for IPv6 addresses. Results of the
lookup are returned in <em class="parameter"><code>*structp</code></em>.
</p>
<p><code class="function">lwres_getnamebyaddr()</code>
performs reverse lookups. Resolver context
<em class="parameter"><code>ctx</code></em> is used for memory allocation. The
address type is indicated by <em class="parameter"><code>addrtype</code></em>:
<span class="type">LWRES_ADDRTYPE_V4</span> or
<span class="type">LWRES_ADDRTYPE_V6</span>. The address to be looked up is
given by <em class="parameter"><code>addr</code></em> and its length is
<em class="parameter"><code>addrlen</code></em> bytes. The result of the
function call is made available through
<em class="parameter"><code>*structp</code></em>.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2514499"></a><h2>RETURN VALUES</h2>
<p>
Successful calls to
<code class="function">lwres_string_parse()</code>
and
<code class="function">lwres_addr_parse()</code>
return
<span class="errorcode">LWRES_R_SUCCESS.</span>
Both functions return
<span class="errorcode">LWRES_R_FAILURE</span>
if the buffer is corrupt or
<span class="errorcode">LWRES_R_UNEXPECTEDEND</span>
if the buffer has less space than expected for the components of the
encoded string or address.
</p>
<p><code class="function">lwres_getaddrsbyname()</code>
returns <span class="errorcode">LWRES_R_SUCCESS</span> on success and it
returns <span class="errorcode">LWRES_R_NOTFOUND</span> if the hostname
<em class="parameter"><code>name</code></em> could not be found.
</p>
<p><span class="errorcode">LWRES_R_SUCCESS</span>
is returned by a successful call to
<code class="function">lwres_getnamebyaddr()</code>.
</p>
<p>
Both
<code class="function">lwres_getaddrsbyname()</code>
and
<code class="function">lwres_getnamebyaddr()</code>
return
<span class="errorcode">LWRES_R_NOMEMORY</span>
when memory allocation requests fail and
<span class="errorcode">LWRES_R_UNEXPECTEDEND</span>
if the buffers used for sending queries and receiving replies are too
small.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2514570"></a><h2>SEE ALSO</h2>
<p><span class="citerefentry"><span class="refentrytitle">lwres_buffer</span>(3)</span>,
<span class="citerefentry"><span class="refentrytitle">lwres_gabn</span>(3)</span>.
</p>
</div>
</div></body>
</html>