share/man/man4/ip.4

   1 .\" Copyright (c) 1983, 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)ip.4        8.2 (Berkeley) 11/30/93
  33 .\" $FreeBSD: src/share/man/man4/ip.4,v 1.13.2.9 2002/05/02 02:40:26 silby Exp $
  34 .\" $DragonFly: src/share/man/man4/ip.4,v 1.3 2006/02/10 19:01:09 swildner Exp $
  35 .\"
  36 .Dd March 3, 2001
  37 .Dt IP 4
  38 .Os
  39 .Sh NAME
  40 .Nm ip
  41 .Nd Internet Protocol
  42 .Sh SYNOPSIS
  43 .In sys/types.h
  44 .In sys/socket.h
  45 .In netinet/in.h
  46 .Ft int
  47 .Fn socket AF_INET SOCK_RAW proto
  48 .Sh DESCRIPTION
  49 .Tn IP
  50 is the transport layer protocol used
  51 by the Internet protocol family.
  52 Options may be set at the
  53 .Tn IP
  54 level
  55 when using higher-level protocols that are based on
  56 .Tn IP
  57 (such as
  58 .Tn TCP
  59 and
  60 .Tn UDP ) .
  61 It may also be accessed
  62 through a
  63 .Dq raw socket
  64 when developing new protocols, or
  65 special-purpose applications.
  66 .Pp
  67 There are several
  68 .Tn IP-level
  69 .Xr setsockopt 2
  70 and
  71 .Xr getsockopt 2
  72 options.
  73 .Dv IP_OPTIONS
  74 may be used to provide
  75 .Tn IP
  76 options to be transmitted in the
  77 .Tn IP
  78 header of each outgoing packet
  79 or to examine the header options on incoming packets.
  80 .Tn IP
  81 options may be used with any socket type in the Internet family.
  82 The format of
  83 .Tn IP
  84 options to be sent is that specified by the
  85 .Tn IP
  86 protocol specification (RFC-791), with one exception:
  87 the list of addresses for Source Route options must include the first-hop
  88 gateway at the beginning of the list of gateways.
  89 The first-hop gateway address will be extracted from the option list
  90 and the size adjusted accordingly before use.
  91 To disable previously specified options,
  92 use a zero-length buffer:
  93 .Bd -literal
  94 setsockopt(s, IPPROTO_IP, IP_OPTIONS, NULL, 0);
  95 .Ed
  96 .Pp
  97 .Dv IP_TOS
  98 and
  99 .Dv IP_TTL
 100 may be used to set the type-of-service and time-to-live
 101 fields in the
 102 .Tn IP
 103 header for
 104 .Dv SOCK_STREAM , SOCK_DGRAM ,
 105 and certain types of
 106 .Dv SOCK_RAW
 107 sockets.
 108 For example,
 109 .Bd -literal
 110 int tos = IPTOS_LOWDELAY;       /* see <netinet/ip.h> */
 111 setsockopt(s, IPPROTO_IP, IP_TOS, &tos, sizeof(tos));
 112
 113 int ttl = 60;                   /* max = 255 */
 114 setsockopt(s, IPPROTO_IP, IP_TTL, &ttl, sizeof(ttl));
 115 .Ed
 116 .Pp
 117 If the
 118 .Dv IP_RECVDSTADDR
 119 option is enabled on a
 120 .Dv SOCK_DGRAM
 121 socket,
 122 the
 123 .Xr recvmsg 2
 124 call will return the destination
 125 .Tn IP
 126 address for a
 127 .Tn UDP
 128 datagram.
 129 The msg_control field in the msghdr structure points to a buffer
 130 that contains a cmsghdr structure followed by the
 131 .Tn IP
 132 address.
 133 The cmsghdr fields have the following values:
 134 .Bd -literal
 135 cmsg_len = sizeof(struct in_addr)
 136 cmsg_level = IPPROTO_IP
 137 cmsg_type = IP_RECVDSTADDR
 138 .Ed
 139 .Pp
 140 .Dv IP_PORTRANGE
 141 may be used to set the port range used for selecting a local port number
 142 on a socket with an unspecified (zero) port number.
 143 It has the following
 144 possible values:
 145 .Bl -tag -width IP_PORTRANGE_DEFAULT
 146 .It Dv IP_PORTRANGE_DEFAULT
 147 use the default range of values, normally
 148 .Dv IPPORT_RESERVED
 149 through
 150 .Dv IPPORT_USERRESERVED .
 151 This is adjustable through the sysctl setting:
 152 .Sy net.inet.ip.portrange.first
 153 and
 154 .Sy net.inet.ip.portrange.last .
 155 .It Dv IP_PORTRANGE_HIGH
 156 use a high range of values, normally
 157 .Dv IPPORT_HIFIRSTAUTO
 158 and
 159 .Dv IPPORT_HILASTAUTO .
 160 This is adjustable through the sysctl setting:
 161 .Sy net.inet.ip.portrange.hifirst
 162 and
 163 .Sy net.inet.ip.portrange.hilast .
 164 .It Dv IP_PORTRANGE_LOW
 165 use a low range of ports, which are normally restricted to
 166 privileged processes on
 167 .Ux
 168 systems.  The range is normally from
 169 .Dv IPPORT_RESERVED - 1
 170 down to
 171 .Li IPPORT_RESERVEDSTART
 172 in descending order.
 173 This is adjustable through the sysctl setting:
 174 .Sy net.inet.ip.portrange.lowfirst
 175 and
 176 .Sy net.inet.ip.portrange.lowlast .
 177 .El
 178 .Ss "Multicast Options"
 179 .Tn IP
 180 multicasting is supported only on
 181 .Dv AF_INET
 182 sockets of type
 183 .Dv SOCK_DGRAM
 184 and
 185 .Dv SOCK_RAW ,
 186 and only on networks where the interface
 187 driver supports multicasting.
 188 .Pp
 189 The
 190 .Dv IP_MULTICAST_TTL
 191 option changes the time-to-live (TTL)
 192 for outgoing multicast datagrams
 193 in order to control the scope of the multicasts:
 194 .Bd -literal
 195 u_char ttl;     /* range: 0 to 255, default = 1 */
 196 setsockopt(s, IPPROTO_IP, IP_MULTICAST_TTL, &ttl, sizeof(ttl));
 197 .Ed
 198 .Pp
 199 Datagrams with a TTL of 1 are not forwarded beyond the local network.
 200 Multicast datagrams with a TTL of 0 will not be transmitted on any network,
 201 but may be delivered locally if the sending host belongs to the destination
 202 group and if multicast loopback has not been disabled on the sending socket
 203 (see below).  Multicast datagrams with TTL greater than 1 may be forwarded
 204 to other networks if a multicast router is attached to the local network.
 205 .Pp
 206 For hosts with multiple interfaces, each multicast transmission is
 207 sent from the primary network interface.
 208 The
 209 .Dv IP_MULTICAST_IF
 210 option overrides the default for
 211 subsequent transmissions from a given socket:
 212 .Bd -literal
 213 struct in_addr addr;
 214 setsockopt(s, IPPROTO_IP, IP_MULTICAST_IF, &addr, sizeof(addr));
 215 .Ed
 216 .Pp
 217 where "addr" is the local
 218 .Tn IP
 219 address of the desired interface or
 220 .Dv INADDR_ANY
 221 to specify the default interface.
 222 An interface's local IP address and multicast capability can
 223 be obtained via the
 224 .Dv SIOCGIFCONF
 225 and
 226 .Dv SIOCGIFFLAGS
 227 ioctls.
 228 Normal applications should not need to use this option.
 229 .Pp
 230 If a multicast datagram is sent to a group to which the sending host itself
 231 belongs (on the outgoing interface), a copy of the datagram is, by default,
 232 looped back by the IP layer for local delivery.
 233 The
 234 .Dv IP_MULTICAST_LOOP
 235 option gives the sender explicit control
 236 over whether or not subsequent datagrams are looped back:
 237 .Bd -literal
 238 u_char loop;    /* 0 = disable, 1 = enable (default) */
 239 setsockopt(s, IPPROTO_IP, IP_MULTICAST_LOOP, &loop, sizeof(loop));
 240 .Ed
 241 .Pp
 242 This option
 243 improves performance for applications that may have no more than one
 244 instance on a single host (such as a router daemon), by eliminating
 245 the overhead of receiving their own transmissions.  It should generally not
 246 be used by applications for which there may be more than one instance on a
 247 single host (such as a conferencing program) or for which the sender does
 248 not belong to the destination group (such as a time querying program).
 249 .Pp
 250 A multicast datagram sent with an initial TTL greater than 1 may be delivered
 251 to the sending host on a different interface from that on which it was sent,
 252 if the host belongs to the destination group on that other interface.  The
 253 loopback control option has no effect on such delivery.
 254 .Pp
 255 A host must become a member of a multicast group before it can receive
 256 datagrams sent to the group.  To join a multicast group, use the
 257 .Dv IP_ADD_MEMBERSHIP
 258 option:
 259 .Bd -literal
 260 struct ip_mreq mreq;
 261 setsockopt(s, IPPROTO_IP, IP_ADD_MEMBERSHIP, &mreq, sizeof(mreq));
 262 .Ed
 263 .Pp
 264 where
 265 .Fa mreq
 266 is the following structure:
 267 .Bd -literal
 268 struct ip_mreq {
 269     struct in_addr imr_multiaddr; /* IP multicast address of group */
 270     struct in_addr imr_interface; /* local IP address of interface */
 271 }
 272 .Ed
 273 .Pp
 274 .Dv imr_interface
 275 should
 276 be
 277 .Dv INADDR_ANY
 278 to choose the default multicast interface,
 279 or the
 280 .Tn IP
 281 address of a particular multicast-capable interface if
 282 the host is multihomed.
 283 Membership is associated with a single interface;
 284 programs running on multihomed hosts may need to
 285 join the same group on more than one interface.
 286 Up to
 287 .Dv IP_MAX_MEMBERSHIPS
 288 (currently 20) memberships may be added on a
 289 single socket.
 290 .Pp
 291 To drop a membership, use:
 292 .Bd -literal
 293 struct ip_mreq mreq;
 294 setsockopt(s, IPPROTO_IP, IP_DROP_MEMBERSHIP, &mreq, sizeof(mreq));
 295 .Ed
 296 .Pp
 297 where
 298 .Fa mreq
 299 contains the same values as used to add the membership.
 300 Memberships are dropped when the socket is closed or the process exits.
 301 .\"-----------------------
 302 .Ss "Raw IP Sockets"
 303 Raw
 304 .Tn IP
 305 sockets are connectionless,
 306 and are normally used with the
 307 .Xr sendto 2
 308 and
 309 .Xr recvfrom 2
 310 calls, though the
 311 .Xr connect 2
 312 call may also be used to fix the destination for future
 313 packets (in which case the
 314 .Xr read 2
 315 or
 316 .Xr recv 2
 317 and
 318 .Xr write 2
 319 or
 320 .Xr send 2
 321 system calls may be used).
 322 .Pp
 323 If
 324 .Fa proto
 325 is 0, the default protocol
 326 .Dv IPPROTO_RAW
 327 is used for outgoing
 328 packets, and only incoming packets destined for that protocol
 329 are received.
 330 If
 331 .Fa proto
 332 is non-zero, that protocol number will be used on outgoing packets
 333 and to filter incoming packets.
 334 .Pp
 335 Outgoing packets automatically have an
 336 .Tn IP
 337 header prepended to
 338 them (based on the destination address and the protocol
 339 number the socket is created with),
 340 unless the
 341 .Dv IP_HDRINCL
 342 option has been set.
 343 Incoming packets are received with
 344 .Tn IP
 345 header and options intact.
 346 .Pp
 347 .Dv IP_HDRINCL
 348 indicates the complete IP header is included with the data
 349 and may be used only with the
 350 .Dv SOCK_RAW
 351 type.
 352 .Bd -literal
 353 #include <netinet/in_systm.h>
 354 #include <netinet/ip.h>
 355
 356 int hincl = 1;                  /* 1 = on, 0 = off */
 357 setsockopt(s, IPPROTO_IP, IP_HDRINCL, &hincl, sizeof(hincl));
 358 .Ed
 359 .Pp
 360 Unlike previous
 361 .Bx
 362 releases, the program must set all
 363 the fields of the IP header, including the following:
 364 .Bd -literal
 365 ip->ip_v = IPVERSION;
 366 ip->ip_hl = hlen >> 2;
 367 ip->ip_id = 0;  /* 0 means kernel set appropriate value */
 368 ip->ip_off = offset;
 369 .Ed
 370 .Pp
 371 If the header source address is set to
 372 .Dv INADDR_ANY ,
 373 the kernel will choose an appropriate address.
 374 .Sh ERRORS
 375 A socket operation may fail with one of the following errors returned:
 376 .Bl -tag -width Er
 377 .It Bq Er EISCONN
 378 when trying to establish a connection on a socket which
 379 already has one, or when trying to send a datagram with the destination
 380 address specified and the socket is already connected;
 381 .It Bq Er ENOTCONN
 382 when trying to send a datagram, but
 383 no destination address is specified, and the socket hasn't been
 384 connected;
 385 .It Bq Er ENOBUFS
 386 when the system runs out of memory for
 387 an internal data structure;
 388 .It Bq Er EADDRNOTAVAIL
 389 when an attempt is made to create a
 390 socket with a network address for which no network interface
 391 exists.
 392 .It Bq Er EACCES
 393 when an attempt is made to create
 394 a raw IP socket by a non-privileged process.
 395 .El
 396 .Pp
 397 The following errors specific to
 398 .Tn IP
 399 may occur when setting or getting
 400 .Tn IP
 401 options:
 402 .Bl -tag -width EADDRNOTAVAILxx
 403 .It Bq Er EINVAL
 404 An unknown socket option name was given.
 405 .It Bq Er EINVAL
 406 The IP option field was improperly formed;
 407 an option field was shorter than the minimum value
 408 or longer than the option buffer provided.
 409 .El
 410 .Sh SEE ALSO
 411 .Xr getsockopt 2 ,
 412 .Xr recv 2 ,
 413 .Xr send 2 ,
 414 .Xr icmp 4 ,
 415 .Xr inet 4 ,
 416 .Xr intro 4
 417 .Sh HISTORY
 418 The
 419 .Nm
 420 protocol appeared in
 421 .Bx 4.2 .