share/man/man4/ip6.4

   1 .\"     $KAME: ip6.4,v 1.23 2005/01/11 05:56:25 itojun Exp $
   2 .\"     $OpenBSD: ip6.4,v 1.21 2005/01/06 03:50:46 itojun Exp $
   3 .\"
   4 .\" Copyright (c) 1983, 1991, 1993
   5 .\"     The Regents of the University of California.  All rights reserved.
   6 .\"
   7 .\" Redistribution and use in source and binary forms, with or without
   8 .\" modification, are permitted provided that the following conditions
   9 .\" are met:
  10 .\" 1. Redistributions of source code must retain the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer.
  12 .\" 2. Redistributions in binary form must reproduce the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer in the
  14 .\"    documentation and/or other materials provided with the distribution.
  15 .\" 3. Neither the name of the University nor the names of its contributors
  16 .\"    may be used to endorse or promote products derived from this software
  17 .\"    without specific prior written permission.
  18 .\"
  19 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  20 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  23 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  24 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  25 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  26 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  27 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  28 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  29 .\" SUCH DAMAGE.
  30 .\"
  31 .\" $FreeBSD$
  32 .\"
  33 .Dd September 29, 2006
  34 .Dt IP6 4
  35 .Os
  36 .Sh NAME
  37 .Nm ip6
  38 .Nd Internet Protocol version 6 (IPv6) network layer
  39 .Sh SYNOPSIS
  40 .In sys/socket.h
  41 .In netinet/in.h
  42 .Ft int
  43 .Fn socket AF_INET6 SOCK_RAW proto
  44 .Sh DESCRIPTION
  45 The IPv6 network layer is used by the IPv6 protocol family for
  46 transporting data.
  47 IPv6 packets contain an IPv6 header that is not provided as part of the
  48 payload contents when passed to an application.
  49 IPv6 header options affect the behavior of this protocol and may be used
  50 by high-level protocols (such as the
  51 .Xr tcp 4
  52 and
  53 .Xr udp 4
  54 protocols) as well as directly by
  55 .Dq raw sockets ,
  56 which process IPv6 messages at a lower-level and may be useful for
  57 developing new protocols and special-purpose applications.
  58 .Ss Header
  59 All IPv6 packets begin with an IPv6 header.
  60 When data received by the kernel are passed to the application, this
  61 header is not included in buffer, even when raw sockets are being used.
  62 Likewise, when data are sent to the kernel for transmit from the
  63 application, the buffer is not examined for an IPv6 header:
  64 the kernel always constructs the header.
  65 To directly access IPv6 headers from received packets and specify them
  66 as part of the buffer passed to the kernel, link-level access
  67 .Po
  68 .Xr bpf 4 ,
  69 for example
  70 .Pc
  71 must instead be utilized.
  72 .Pp
  73 The header has the following definition:
  74 .Bd -literal -offset indent
  75 struct ip6_hdr {
  76      union {
  77           struct ip6_hdrctl {
  78                u_int32_t ip6_un1_flow;  /* 20 bits of flow ID */
  79                u_int16_t ip6_un1_plen;  /* payload length */
  80                u_int8_t  ip6_un1_nxt;   /* next header */
  81                u_int8_t  ip6_un1_hlim;  /* hop limit */
  82           } ip6_un1;
  83           u_int8_t ip6_un2_vfc;   /* version and class */
  84      } ip6_ctlun;
  85      struct in6_addr ip6_src;   /* source address */
  86      struct in6_addr ip6_dst;   /* destination address */
  87 } __packed;
  88
  89 #define ip6_vfc         ip6_ctlun.ip6_un2_vfc
  90 #define ip6_flow        ip6_ctlun.ip6_un1.ip6_un1_flow
  91 #define ip6_plen        ip6_ctlun.ip6_un1.ip6_un1_plen
  92 #define ip6_nxt         ip6_ctlun.ip6_un1.ip6_un1_nxt
  93 #define ip6_hlim        ip6_ctlun.ip6_un1.ip6_un1_hlim
  94 #define ip6_hops        ip6_ctlun.ip6_un1.ip6_un1_hlim
  95 .Ed
  96 .Pp
  97 All fields are in network-byte order.
  98 Any options specified (see
  99 .Sx Options
 100 below) must also be specified in network-byte order.
 101 .Pp
 102 .Va ip6_flow
 103 specifies the flow ID.
 104 .Va ip6_plen
 105 specifies the payload length.
 106 .Va ip6_nxt
 107 specifies the type of the next header.
 108 .Va ip6_hlim
 109 specifies the hop limit.
 110 .Pp
 111 The top 4 bits of
 112 .Va ip6_vfc
 113 specify the class and the bottom 4 bits specify the version.
 114 .Pp
 115 .Va ip6_src
 116 and
 117 .Va ip6_dst
 118 specify the source and destination addresses.
 119 .Pp
 120 The IPv6 header may be followed by any number of extension headers that start
 121 with the following generic definition:
 122 .Bd -literal -offset indent
 123 struct ip6_ext {
 124      u_int8_t ip6e_nxt;
 125      u_int8_t ip6e_len;
 126 } __packed;
 127 .Ed
 128 .Ss Options
 129 IPv6 allows header options on packets to manipulate the behavior of the
 130 protocol.
 131 These options and other control requests are accessed with the
 132 .Xr getsockopt 2
 133 and
 134 .Xr setsockopt 2
 135 system calls at level
 136 .Dv IPPROTO_IPV6
 137 and by using ancillary data in
 138 .Xr recvmsg 2
 139 and
 140 .Xr sendmsg 2 .
 141 They can be used to access most of the fields in the IPv6 header and
 142 extension headers.
 143 .Pp
 144 The following socket options are supported:
 145 .Bl -tag -width Ds
 146 .\" .It Dv IPV6_OPTIONS
 147 .It Dv IPV6_UNICAST_HOPS Fa "int *"
 148 Get or set the default hop limit header field for outgoing unicast
 149 datagrams sent on this socket.
 150 A value of \-1 resets to the default value.
 151 .\" .It Dv IPV6_RECVOPTS Fa "int *"
 152 .\" Get or set the status of whether all header options will be
 153 .\" delivered along with the datagram when it is received.
 154 .\" .It Dv IPV6_RECVRETOPTS Fa "int *"
 155 .\" Get or set the status of whether header options will be delivered
 156 .\" for reply.
 157 .\" .It Dv IPV6_RECVDSTADDR Fa "int *"
 158 .\" Get or set the status of whether datagrams are received with
 159 .\" destination addresses.
 160 .\" .It Dv IPV6_RETOPTS
 161 .\" Get or set IPv6 options.
 162 .It Dv IPV6_MULTICAST_IF Fa "u_int *"
 163 Get or set the interface from which multicast packets will be sent.
 164 For hosts with multiple interfaces, each multicast transmission is sent
 165 from the primary network interface.
 166 The interface is specified as its index as provided by
 167 .Xr if_nametoindex 3 .
 168 A value of zero specifies the default interface.
 169 .It Dv IPV6_MULTICAST_HOPS Fa "int *"
 170 Get or set the default hop limit header field for outgoing multicast
 171 datagrams sent on this socket.
 172 This option controls the scope of multicast datagram transmissions.
 173 .Pp
 174 Datagrams with a hop limit of 1 are not forwarded beyond the local
 175 network.
 176 Multicast datagrams with a hop limit of zero will not be transmitted on
 177 any network but may be delivered locally if the sending host belongs to
 178 the destination group and if multicast loopback (see below) has not been
 179 disabled on the sending socket.
 180 Multicast datagrams with a hop limit greater than 1 may be forwarded to
 181 the other networks if a multicast router (such as
 182 .Xr mrouted 8 Pq Pa ports/net/mrouted )
 183 is attached to the local network.
 184 .It Dv IPV6_MULTICAST_LOOP Fa "u_int *"
 185 Get or set the status of whether multicast datagrams will be looped back
 186 for local delivery when a multicast datagram is sent to a group to which
 187 the sending host belongs.
 188 .Pp
 189 This option improves performance for applications that may have no more
 190 than one instance on a single host (such as a router daemon) by
 191 eliminating the overhead of receiving their own transmissions.
 192 It should generally not be used by applications for which there may be
 193 more than one instance on a single host (such as a conferencing program)
 194 or for which the sender does not belong to the destination group
 195 (such as a time-querying program).
 196 .Pp
 197 A multicast datagram sent with an initial hop limit greater than 1 may
 198 be delivered to the sending host on a different interface from that on
 199 which it was sent if the host belongs to the destination group on that
 200 other interface.
 201 The multicast loopback control option has no effect on such delivery.
 202 .It Dv IPV6_JOIN_GROUP Fa "struct ipv6_mreq *"
 203 Join a multicast group.
 204 A host must become a member of a multicast group before it can receive
 205 datagrams sent to the group.
 206 .Bd -literal
 207 struct ipv6_mreq {
 208         struct in6_addr ipv6mr_multiaddr;
 209         unsigned int    ipv6mr_interface;
 210 };
 211 .Ed
 212 .Pp
 213 .Va ipv6mr_interface
 214 may be set to zeroes to choose the default multicast interface or to the
 215 index of a particular multicast-capable interface if the host is
 216 multihomed.
 217 Membership is associated with a single interface; programs running on
 218 multihomed hosts may need to join the same group on more than one
 219 interface.
 220 .Pp
 221 If the multicast address is unspecified (i.e., all zeroes), messages
 222 from all multicast addresses will be accepted by this group.
 223 Note that setting to this value requires superuser privileges.
 224 .It Dv IPV6_LEAVE_GROUP Fa "struct ipv6_mreq *"
 225 Drop membership from the associated multicast group.
 226 Memberships are automatically dropped when the socket is closed or when
 227 the process exits.
 228 .It Dv IPV6_PORTRANGE Fa "int *"
 229 Get or set the allocation policy of ephemeral ports for when the kernel
 230 automatically binds a local address to this socket.
 231 The following values are available:
 232 .Pp
 233 .Bl -tag -width IPV6_PORTRANGE_DEFAULT -compact
 234 .It Dv IPV6_PORTRANGE_DEFAULT
 235 Use the regular range of non-reserved ports (varies, see
 236 .Xr sysctl 8 ) .
 237 .It Dv IPV6_PORTRANGE_HIGH
 238 Use a high range (varies, see
 239 .Xr sysctl 8 ) .
 240 .It Dv IPV6_PORTRANGE_LOW
 241 Use a low, reserved range (600\-1023).
 242 .El
 243 .It Dv IPV6_PKTINFO Fa "int *"
 244 Get or set whether additional information about subsequent packets will
 245 be provided as ancillary data along with the payload in subsequent
 246 .Xr recvmsg 2
 247 calls.
 248 The information is stored in the following structure in the ancillary
 249 data returned:
 250 .Bd -literal
 251 struct in6_pktinfo {
 252         struct in6_addr ipi6_addr;    /* src/dst IPv6 address */
 253         unsigned int    ipi6_ifindex; /* send/recv if index */
 254 };
 255 .Ed
 256 .It Dv IPV6_HOPLIMIT Fa "int *"
 257 Get or set whether the hop limit header field from subsequent packets
 258 will be provided as ancillary data along with the payload in subsequent
 259 .Xr recvmsg 2
 260 calls.
 261 The value is stored as an
 262 .Vt int
 263 in the ancillary data returned.
 264 .\" .It Dv IPV6_NEXTHOP Fa "int *"
 265 .\" Get or set whether the address of the next hop for subsequent
 266 .\" packets will be provided as ancillary data along with the payload in
 267 .\" subsequent
 268 .\" .Xr recvmsg 2
 269 .\" calls.
 270 .\" The option is stored as a
 271 .\" .Vt sockaddr
 272 .\" structure in the ancillary data returned.
 273 .\" .Pp
 274 .\" This option requires superuser privileges.
 275 .It Dv IPV6_HOPOPTS Fa "int *"
 276 Get or set whether the hop-by-hop options from subsequent packets will be
 277 provided as ancillary data along with the payload in subsequent
 278 .Xr recvmsg 2
 279 calls.
 280 The option is stored in the following structure in the ancillary data
 281 returned:
 282 .Bd -literal
 283 struct ip6_hbh {
 284         u_int8_t ip6h_nxt;      /* next header */
 285         u_int8_t ip6h_len;      /* length in units of 8 octets */
 286 /* followed by options */
 287 } __packed;
 288 .Ed
 289 .Pp
 290 The
 291 .Fn inet6_option_space
 292 routine and family of routines may be used to manipulate this data.
 293 .Pp
 294 This option requires superuser privileges.
 295 .It Dv IPV6_DSTOPTS Fa "int *"
 296 Get or set whether the destination options from subsequent packets will
 297 be provided as ancillary data along with the payload in subsequent
 298 .Xr recvmsg 2
 299 calls.
 300 The option is stored in the following structure in the ancillary data
 301 returned:
 302 .Bd -literal
 303 struct ip6_dest {
 304         u_int8_t ip6d_nxt;      /* next header */
 305         u_int8_t ip6d_len;      /* length in units of 8 octets */
 306 /* followed by options */
 307 } __packed;
 308 .Ed
 309 .Pp
 310 The
 311 .Fn inet6_option_space
 312 routine and family of routines may be used to manipulate this data.
 313 .Pp
 314 This option requires superuser privileges.
 315 .It Dv IPV6_RTHDR Fa "int *"
 316 Get or set whether the routing header from subsequent packets will be
 317 provided as ancillary data along with the payload in subsequent
 318 .Xr recvmsg 2
 319 calls.
 320 The header is stored in the following structure in the ancillary data
 321 returned:
 322 .Bd -literal
 323 struct ip6_rthdr {
 324         u_int8_t ip6r_nxt;      /* next header */
 325         u_int8_t ip6r_len;      /* length in units of 8 octets */
 326         u_int8_t ip6r_type;     /* routing type */
 327         u_int8_t ip6r_segleft;  /* segments left */
 328 /* followed by routing-type-specific data */
 329 } __packed;
 330 .Ed
 331 .Pp
 332 The
 333 .Fn inet6_option_space
 334 routine and family of routines may be used to manipulate this data.
 335 .Pp
 336 This option requires superuser privileges.
 337 .It Dv IPV6_PKTOPTIONS Fa "struct cmsghdr *"
 338 Get or set all header options and extension headers at one time on the
 339 last packet sent or received on the socket.
 340 All options must fit within the size of an mbuf (see
 341 .Xr mbuf 9 ) .
 342 Options are specified as a series of
 343 .Vt cmsghdr
 344 structures followed by corresponding values.
 345 .Va cmsg_level
 346 is set to
 347 .Dv IPPROTO_IPV6 ,
 348 .Va cmsg_type
 349 to one of the other values in this list, and trailing data to the option
 350 value.
 351 When setting options, if the length
 352 .Va optlen
 353 to
 354 .Xr setsockopt 2
 355 is zero, all header options will be reset to their default values.
 356 Otherwise, the length should specify the size the series of control
 357 messages consumes.
 358 .Pp
 359 Instead of using
 360 .Xr sendmsg 2
 361 to specify option values, the ancillary data used in these calls that
 362 correspond to the desired header options may be directly specified as
 363 the control message in the series of control messages provided as the
 364 argument to
 365 .Xr setsockopt 2 .
 366 .It Dv IPV6_CHECKSUM Fa "int *"
 367 Get or set the byte offset into a packet where the 16-bit checksum is
 368 located.
 369 When set, this byte offset is where incoming packets will be expected
 370 to have checksums of their data stored and where outgoing packets will
 371 have checksums of their data computed and stored by the kernel.
 372 A value of \-1 specifies that no checksums will be checked on incoming
 373 packets and that no checksums will be computed or stored on outgoing
 374 packets.
 375 The offset of the checksum for ICMPv6 sockets cannot be relocated or
 376 turned off.
 377 .It Dv IPV6_V6ONLY Fa "int *"
 378 Get or set whether only IPv6 connections can be made to this socket.
 379 For wildcard sockets, this can restrict connections to IPv6 only.
 380 .\"With
 381 .\".Ox
 382 .\"IPv6 sockets are always IPv6-only, so the socket option is read-only
 383 .\"(not modifiable).
 384 .It Dv IPV6_FAITH Fa "int *"
 385 Get or set the status of whether
 386 .Xr faith 4
 387 connections can be made to this socket.
 388 .It Dv IPV6_USE_MIN_MTU Fa "int *"
 389 Get or set whether the minimal IPv6 maximum transmission unit (MTU) size
 390 will be used to avoid fragmentation from occurring for subsequent
 391 outgoing datagrams.
 392 .It Dv IPV6_AUTH_LEVEL Fa "int *"
 393 Get or set the
 394 .Xr ipsec 4
 395 authentication level.
 396 .It Dv IPV6_ESP_TRANS_LEVEL Fa "int *"
 397 Get or set the ESP transport level.
 398 .It Dv IPV6_ESP_NETWORK_LEVEL Fa "int *"
 399 Get or set the ESP encapsulation level.
 400 .It Dv IPV6_IPCOMP_LEVEL Fa "int *"
 401 Get or set the
 402 .Xr ipcomp 4
 403 level.
 404 .El
 405 .Pp
 406 The
 407 .Dv IPV6_PKTINFO ,
 408 .\" .Dv IPV6_NEXTHOP ,
 409 .Dv IPV6_HOPLIMIT ,
 410 .Dv IPV6_HOPOPTS ,
 411 .Dv IPV6_DSTOPTS ,
 412 and
 413 .Dv IPV6_RTHDR
 414 options will return ancillary data along with payload contents in subsequent
 415 .Xr recvmsg 2
 416 calls with
 417 .Va cmsg_level
 418 set to
 419 .Dv IPPROTO_IPV6
 420 and
 421 .Va cmsg_type
 422 set to respective option name value (e.g.,
 423 .Dv IPV6_HOPTLIMIT ) .
 424 These options may also be used directly as ancillary
 425 .Va cmsg_type
 426 values in
 427 .Xr sendmsg 2
 428 to set options on the packet being transmitted by the call.
 429 The
 430 .Va cmsg_level
 431 value must be
 432 .Dv IPPROTO_IPV6 .
 433 For these options, the ancillary data object value format is the same
 434 as the value returned as explained for each when received with
 435 .Xr recvmsg 2 .
 436 .Pp
 437 Note that using
 438 .Xr sendmsg 2
 439 to specify options on particular packets works only on UDP and raw sockets.
 440 To manipulate header options for packets on TCP sockets, only the socket
 441 options may be used.
 442 .Pp
 443 In some cases, there are multiple APIs defined for manipulating an IPv6
 444 header field.
 445 A good example is the outgoing interface for multicast datagrams, which
 446 can be set by the
 447 .Dv IPV6_MULTICAST_IF
 448 socket option, through the
 449 .Dv IPV6_PKTINFO
 450 option, and through the
 451 .Va sin6_scope_id
 452 field of the socket address passed to the
 453 .Xr sendto 2
 454 system call.
 455 .Pp
 456 Resolving these conflicts is implementation dependent.
 457 This implementation determines the value in the following way:
 458 options specified by using ancillary data (i.e.,
 459 .Xr sendmsg 2 )
 460 are considered first,
 461 options specified by using
 462 .Dv IPV6_PKTOPTIONS
 463 to set
 464 .Dq sticky
 465 options are considered second,
 466 options specified by using the individual, basic, and direct socket
 467 options (e.g.,
 468 .Dv IPV6_UNICAST_HOPS )
 469 are considered third,
 470 and options specified in the socket address supplied to
 471 .Xr sendto 2
 472 are the last choice.
 473 .Ss Multicasting
 474 IPv6 multicasting is supported only on
 475 .Dv AF_INET6
 476 sockets of type
 477 .Dv SOCK_DGRAM
 478 and
 479 .Dv SOCK_RAW ,
 480 and only on networks where the interface driver supports
 481 multicasting.
 482 Socket options (see above) that manipulate membership of
 483 multicast groups and other multicast options include
 484 .Dv IPV6_MULTICAST_IF ,
 485 .Dv IPV6_MULTICAST_HOPS ,
 486 .Dv IPV6_MULTICAST_LOOP ,
 487 .Dv IPV6_LEAVE_GROUP ,
 488 and
 489 .Dv IPV6_JOIN_GROUP .
 490 .Ss Raw Sockets
 491 Raw IPv6 sockets are connectionless and are normally used with the
 492 .Xr sendto 2
 493 and
 494 .Xr recvfrom 2
 495 calls, although the
 496 .Xr connect 2
 497 call may be used to fix the destination address for future outgoing
 498 packets so that
 499 .Xr send 2
 500 may instead be used and the
 501 .Xr bind 2
 502 call may be used to fix the source address for future outgoing
 503 packets instead of having the kernel choose a source address.
 504 .Pp
 505 By using
 506 .Xr connect 2
 507 or
 508 .Xr bind 2 ,
 509 raw socket input is constrained to only packets with their
 510 source address matching the socket destination address if
 511 .Xr connect 2
 512 was used and to packets with their destination address
 513 matching the socket source address if
 514 .Xr bind 2
 515 was used.
 516 .Pp
 517 If the
 518 .Ar proto
 519 argument to
 520 .Xr socket 2
 521 is zero, the default protocol
 522 .Pq Dv IPPROTO_RAW
 523 is used for outgoing packets.
 524 For incoming packets, protocols recognized by kernel are
 525 .Sy not
 526 passed to the application socket (e.g.,
 527 .Xr tcp 4
 528 and
 529 .Xr udp 4 )
 530 except for some ICMPv6 messages.
 531 The ICMPv6 messages not passed to raw sockets include echo, timestamp,
 532 and address mask requests.
 533 If
 534 .Ar proto
 535 is non-zero, only packets with this protocol will be passed to the
 536 socket.
 537 .Pp
 538 IPv6 fragments are also not passed to application sockets until
 539 they have been reassembled.
 540 If reception of all packets is desired, link-level access (such as
 541 .Xr bpf 4 )
 542 must be used instead.
 543 .Pp
 544 Outgoing packets automatically have an IPv6 header prepended to them
 545 (based on the destination address and the protocol number the socket
 546 was created with).
 547 Incoming packets are received by an application without the IPv6 header
 548 or any extension headers.
 549 .Pp
 550 Outgoing packets will be fragmented automatically by the kernel if they
 551 are too large.
 552 Incoming packets will be reassembled before being sent to the raw socket,
 553 so packet fragments or fragment headers will never be seen on a raw socket.
 554 .Sh EXAMPLES
 555 The following determines the hop limit on the next packet received:
 556 .Bd -literal
 557 struct iovec iov[2];
 558 u_char buf[BUFSIZ];
 559 struct cmsghdr *cm;
 560 struct msghdr m;
 561 int found, optval;
 562 u_char data[2048];
 563
 564 /* Create socket. */
 565
 566 (void)memset(&m, 0, sizeof(m));
 567 (void)memset(&iov, 0, sizeof(iov));
 568
 569 iov[0].iov_base = data;         /* buffer for packet payload */
 570 iov[0].iov_len = sizeof(data);  /* expected packet length */
 571
 572 m.msg_name = &from;             /* sockaddr_in6 of peer */
 573 m.msg_namelen = sizeof(from);
 574 m.msg_iov = iov;
 575 m.msg_iovlen = 1;
 576 m.msg_control = (caddr_t)buf;   /* buffer for control messages */
 577 m.msg_controllen = sizeof(buf);
 578
 579 /*
 580  * Enable the hop limit value from received packets to be
 581  * returned along with the payload.
 582  */
 583 optval = 1;
 584 if (setsockopt(s, IPPROTO_IPV6, IPV6_HOPLIMIT, &optval,
 585     sizeof(optval)) == -1)
 586         err(1, "setsockopt");
 587
 588 found = 0;
 589 while (!found) {
 590         if (recvmsg(s, &m, 0) == -1)
 591                 err(1, "recvmsg");
 592         for (cm = CMSG_FIRSTHDR(&m); cm != NULL;
 593              cm = CMSG_NXTHDR(&m, cm)) {
 594                 if (cm->cmsg_level == IPPROTO_IPV6 &&
 595                     cm->cmsg_type == IPV6_HOPLIMIT &&
 596                     cm->cmsg_len == CMSG_LEN(sizeof(int))) {
 597                         found = 1;
 598                         (void)printf("hop limit: %d\en",
 599                             *(int *)CMSG_DATA(cm));
 600                         break;
 601                 }
 602         }
 603 }
 604 .Ed
 605 .Sh DIAGNOSTICS
 606 A socket operation may fail with one of the following errors returned:
 607 .Bl -tag -width EADDRNOTAVAILxx
 608 .It Bq Er EISCONN
 609 when trying to establish a connection on a socket which
 610 already has one or when trying to send a datagram with the destination
 611 address specified and the socket is already connected.
 612 .It Bq Er ENOTCONN
 613 when trying to send a datagram, but
 614 no destination address is specified, and the socket has not been
 615 connected.
 616 .It Bq Er ENOBUFS
 617 when the system runs out of memory for
 618 an internal data structure.
 619 .It Bq Er EADDRNOTAVAIL
 620 when an attempt is made to create a
 621 socket with a network address for which no network interface
 622 exists.
 623 .It Bq Er EACCES
 624 when an attempt is made to create
 625 a raw IPv6 socket by a non-privileged process.
 626 .El
 627 .Pp
 628 The following errors specific to IPv6 may occur when setting or getting
 629 header options:
 630 .Bl -tag -width EADDRNOTAVAILxx
 631 .It Bq Er EINVAL
 632 An unknown socket option name was given.
 633 .It Bq Er EINVAL
 634 An ancillary data object was improperly formed.
 635 .El
 636 .Sh SEE ALSO
 637 .Xr getsockopt 2 ,
 638 .Xr recv 2 ,
 639 .Xr send 2 ,
 640 .Xr setsockopt 2 ,
 641 .Xr socket 2 ,
 642 .\" .Xr inet6_option_space 3 ,
 643 .\" .Xr inet6_rthdr_space 3 ,
 644 .Xr if_nametoindex 3 ,
 645 .Xr bpf 4 ,
 646 .Xr icmp6 4 ,
 647 .Xr inet6 4 ,
 648 .Xr netintro 4 ,
 649 .Xr tcp 4 ,
 650 .Xr udp 4
 651 .Rs
 652 .%A W. Stevens
 653 .%A M. Thomas
 654 .%T Advanced Sockets API for IPv6
 655 .%R RFC 2292
 656 .%D February 1998
 657 .Re
 658 .Rs
 659 .%A S. Deering
 660 .%A R. Hinden
 661 .%T Internet Protocol, Version 6 (IPv6) Specification
 662 .%R RFC 2460
 663 .%D December 1998
 664 .Re
 665 .Rs
 666 .%A R. Gilligan
 667 .%A S. Thomson
 668 .%A J. Bound
 669 .%A W. Stevens
 670 .%T Basic Socket Interface Extensions for IPv6
 671 .%R RFC 2553
 672 .%D March 1999
 673 .Re
 674 .Rs
 675 .%A W. Stevens
 676 .%A B. Fenner
 677 .%A A. Rudoff
 678 .%T UNIX Network Programming, third edition
 679 .Re
 680 .Sh STANDARDS
 681 Most of the socket options are defined in RFC 2292 or RFC 2553.
 682 The
 683 .Dv IPV6_V6ONLY
 684 socket option is defined in RFC 3542.
 685 The
 686 .Dv IPV6_PORTRANGE
 687 socket option and the conflict resolution rule are not defined in the
 688 RFCs and should be considered implementation dependent.