lib/libc/net/inet6_rth_space.3

   1 .\"     $KAME: inet6_rth_space.3,v 1.7 2005/01/05 03:00:44 itojun Exp $
   2 .\"
   3 .\" Copyright (C) 2004 WIDE Project.
   4 .\" All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\" 3. Neither the name of the project nor the names of its contributors
  15 .\"    may be used to endorse or promote products derived from this software
  16 .\"    without specific prior written permission.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
  19 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
  22 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28 .\" SUCH DAMAGE.
  29 .\"
  30 .\" $FreeBSD$
  31 .\"
  32 .Dd December 24, 2004
  33 .Dt INET6_RTH_SPACE 3
  34 .Os
  35 .\"
  36 .Sh NAME
  37 .Nm inet6_rth_space ,
  38 .Nm inet6_rth_init ,
  39 .Nm inet6_rth_add ,
  40 .Nm inet6_rth_reverse ,
  41 .Nm inet6_rth_segments ,
  42 .Nm inet6_rth_getaddr
  43 .Nd IPv6 Routing Header Options manipulation
  44 .\"
  45 .Sh SYNOPSIS
  46 .In netinet/in.h
  47 .Ft socklen_t
  48 .Fn inet6_rth_space "int" "int"
  49 .Ft "void *"
  50 .Fn inet6_rth_init "void *" "socklen_t" "int" "int"
  51 .Ft int
  52 .Fn inet6_rth_add "void *" "const struct in6_addr *"
  53 .Ft int
  54 .Fn inet6_rth_reverse "const void *" "void *"
  55 .Ft int
  56 .Fn inet6_rth_segments "const void *"
  57 .Ft "struct in6_addr *"
  58 .Fn inet6_rth_getaddr "const void *" "int"
  59 .\"
  60 .Sh DESCRIPTION
  61 The IPv6 Advanced API, RFC 3542, defines the functions that an
  62 application calls to build and examine IPv6 Routing headers.
  63 Routing headers are used to perform source routing in IPv6 networks.
  64 The RFC uses the word
  65 .Dq segments
  66 to describe addresses and that is the term used here as well.
  67 All of the functions are defined in the
  68 .In netinet/in.h
  69 header file.
  70 The functions described in this manual page all operate
  71 on routing header structures which are defined in
  72 .In netinet/ip6.h
  73 but which should not need to be modified outside the use of this API.
  74 The size and shape of the route header structures may change, so using
  75 the APIs is a more portable, long term, solution.
  76 .Pp
  77 The functions in the API are split into two groups, those that build a
  78 routing header and those that parse a received routing header.
  79 We will describe the builder functions followed by the parser functions.
  80 .Ss inet6_rth_space
  81 The
  82 .Fn inet6_rth_space
  83 function returns the number of bytes required to hold a Routing Header
  84 of the type, specified in the
  85 .Fa type
  86 argument and containing the number of addresses specified in the
  87 .Fa segments
  88 argument.
  89 When the type is
  90 .Dv IPV6_RTHDR_TYPE_0
  91 the number of segments must be from 0 through 127.
  92 Routing headers of type
  93 .Dv IPV6_RTHDR_TYPE_2
  94 contain only one segment, and are only used with Mobile IPv6.
  95 The return value from this function is the number of bytes required to
  96 store the routing header.
  97 If the value 0 is returned then either the
  98 route header type was not recognized or another error occurred.
  99 .Ss inet6_rth_init
 100 The
 101 .Fn inet6_rth_init
 102 function initializes the pre-allocated buffer pointed to by
 103 .Fa bp
 104 to contain a routing header of the specified type.
 105 The
 106 .Fa bp_len
 107 argument is used to verify that the buffer is large enough.
 108 The caller must allocate the buffer pointed to by bp.
 109 The necessary buffer size should be determined by calling
 110 .Fn inet6_rth_space
 111 described in the previous sections.
 112 .Pp
 113 The
 114 .Fn inet6_rth_init
 115 function returns a pointer to
 116 .Fa bp
 117 on success and
 118 .Dv NULL
 119 when there is an error.
 120 .Ss inet6_rth_add
 121 The
 122 .Fn inet6_rth_add
 123 function adds the IPv6 address pointed to by
 124 .Fa addr
 125 to the end of the routing header being constructed.
 126 .Pp
 127 A successful addition results in the function returning 0, otherwise
 128 \-1 is returned.
 129 .Ss inet6_rth_reverse
 130 The
 131 .Fn inet6_rth_reverse
 132 function takes a routing header, pointed to by the
 133 argument
 134 .Fa in ,
 135 and writes a new routing header into the argument pointed to by
 136 .Fa out .
 137 The routing header at that sends datagrams along the reverse of that
 138 route.
 139 Both arguments are allowed to point to the same buffer meaning
 140 that the reversal can occur in place.
 141 .Pp
 142 The return value of the function is 0 on success, or \-1 when
 143 there is an error.
 144 .\"
 145 .Pp
 146 The next set of functions operate on a routing header that the
 147 application wants to parse.
 148 In the usual case such a routing header
 149 is received from the network, although these functions can also be
 150 used with routing headers that the application itself created.
 151 .Ss inet6_rth_segments
 152 The
 153 .Fn inet6_rth_segments
 154 function returns the number of segments contained in the
 155 routing header pointed to by
 156 .Fa bp .
 157 The return value is the number of segments contained in the routing
 158 header, or \-1 if an error occurred.
 159 It is not an error for 0 to be
 160 returned as a routing header may contain 0 segments.
 161 .\"
 162 .Ss inet6_rth_getaddr
 163 The
 164 .Fn inet6_rth_getaddr
 165 function is used to retrieve a single address from a routing header.
 166 The
 167 .Fa index
 168 is the location in the routing header from which the application wants
 169 to retrieve an address.
 170 The
 171 .Fa index
 172 parameter must have a value between 0 and one less than the number of
 173 segments present in the routing header.
 174 The
 175 .Fn inet6_rth_segments
 176 function, described in the last section, should be used to determine
 177 the total number of segments in the routing header.
 178 The
 179 .Fn inet6_rth_getaddr
 180 function returns a pointer to an IPv6 address on success or
 181 .Dv NULL
 182 when an error has occurred.
 183 .\"
 184 .Sh EXAMPLES
 185 RFC 3542 gives extensive examples in Section 21, Appendix B.
 186 .Pp
 187 KAME also provides examples in the advapitest directory of its kit.
 188 .\"
 189 .Sh DIAGNOSTICS
 190 The
 191 .Fn inet6_rth_space
 192 and
 193 .Fn inet6_rth_getaddr
 194 functions return 0 on errors.
 195 .Pp
 196 The
 197 .Fn inet6_rthdr_init
 198 function returns
 199 .Dv NULL
 200 on error.
 201 The
 202 .Fn inet6_rth_add
 203 and
 204 .Fn inet6_rth_reverse
 205 functions return 0 on success, or \-1 upon an error.
 206 .\"
 207 .Sh SEE ALSO
 208 .Rs
 209 .%A W. Stevens
 210 .%A M. Thomas
 211 .%A E. Nordmark
 212 .%A T. Jinmei
 213 .%T "Advanced Sockets API for IPv6"
 214 .%N RFC 3542
 215 .%D May 2003
 216 .Re
 217 .Rs
 218 .%A S. Deering
 219 .%A R. Hinden
 220 .%T "Internet Protocol, Version 6 (IPv6) Specification"
 221 .%N RFC2460
 222 .%D December 1998
 223 .Re
 224 .Sh HISTORY
 225 The implementation first appeared in KAME advanced networking kit.