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 .\"
  35 .Dd March 3, 2001
  36 .Dt IP 4
  37 .Os
  38 .Sh NAME
  39 .Nm ip
  40 .Nd Internet Protocol
  41 .Sh SYNOPSIS
  42 .In sys/types.h
  43 .In sys/socket.h
  44 .In netinet/in.h
  45 .Ft int
  46 .Fn socket AF_INET SOCK_RAW proto
  47 .Sh DESCRIPTION
  48 .Tn IP
  49 is the transport layer protocol used
  50 by the Internet protocol family.
  51 Options may be set at the
  52 .Tn IP
  53 level
  54 when using higher-level protocols that are based on
  55 .Tn IP
  56 (such as
  57 .Tn TCP
  58 and
  59 .Tn UDP ) .
  60 It may also be accessed
  61 through a
  62 .Dq raw socket
  63 when developing new protocols, or
  64 special-purpose applications.
  65 .Pp
  66 There are several
  67 .Tn IP-level
  68 .Xr setsockopt 2
  69 and
  70 .Xr getsockopt 2
  71 options.
  72 .Dv IP_OPTIONS
  73 may be used to provide
  74 .Tn IP
  75 options to be transmitted in the
  76 .Tn IP
  77 header of each outgoing packet
  78 or to examine the header options on incoming packets.
  79 .Tn IP
  80 options may be used with any socket type in the Internet family.
  81 The format of
  82 .Tn IP
  83 options to be sent is that specified by the
  84 .Tn IP
  85 protocol specification (RFC-791), with one exception:
  86 the list of addresses for Source Route options must include the first-hop
  87 gateway at the beginning of the list of gateways.
  88 The first-hop gateway address will be extracted from the option list
  89 and the size adjusted accordingly before use.
  90 To disable previously specified options,
  91 use a zero-length buffer:
  92 .Bd -literal
  93 setsockopt(s, IPPROTO_IP, IP_OPTIONS, NULL, 0);
  94 .Ed
  95 .Pp
  96 .Dv IP_TOS
  97 and
  98 .Dv IP_TTL
  99 may be used to set the type-of-service and time-to-live
 100 fields in the
 101 .Tn IP
 102 header for
 103 .Dv SOCK_STREAM , SOCK_DGRAM ,
 104 and certain types of
 105 .Dv SOCK_RAW
 106 sockets.
 107 For example,
 108 .Bd -literal
 109 int tos = IPTOS_LOWDELAY;       /* see <netinet/ip.h> */
 110 setsockopt(s, IPPROTO_IP, IP_TOS, &tos, sizeof(tos));
 111
 112 int ttl = 60;                   /* max = 255 */
 113 setsockopt(s, IPPROTO_IP, IP_TTL, &ttl, sizeof(ttl));
 114 .Ed
 115 .Pp
 116 If the
 117 .Dv IP_RECVDSTADDR
 118 option is enabled on a
 119 .Dv SOCK_DGRAM
 120 socket,
 121 the
 122 .Xr recvmsg 2
 123 call will return the destination
 124 .Tn IP
 125 address for a
 126 .Tn UDP
 127 datagram.
 128 The msg_control field in the msghdr structure points to a buffer
 129 that contains a cmsghdr structure followed by the
 130 .Tn IP
 131 address.
 132 The cmsghdr fields have the following values:
 133 .Bd -literal
 134 cmsg_len = sizeof(struct in_addr)
 135 cmsg_level = IPPROTO_IP
 136 cmsg_type = IP_RECVDSTADDR
 137 .Ed
 138 .Pp
 139 .Dv IP_PORTRANGE
 140 may be used to set the port range used for selecting a local port number
 141 on a socket with an unspecified (zero) port number.
 142 It has the following
 143 possible values:
 144 .Bl -tag -width IP_PORTRANGE_DEFAULT
 145 .It Dv IP_PORTRANGE_DEFAULT
 146 use the default range of values, normally
 147 .Dv IPPORT_RESERVED
 148 through
 149 .Dv IPPORT_USERRESERVED .
 150 This is adjustable through the sysctl setting:
 151 .Sy net.inet.ip.portrange.first
 152 and
 153 .Sy net.inet.ip.portrange.last .
 154 .It Dv IP_PORTRANGE_HIGH
 155 use a high range of values, normally
 156 .Dv IPPORT_HIFIRSTAUTO
 157 and
 158 .Dv IPPORT_HILASTAUTO .
 159 This is adjustable through the sysctl setting:
 160 .Sy net.inet.ip.portrange.hifirst
 161 and
 162 .Sy net.inet.ip.portrange.hilast .
 163 .It Dv IP_PORTRANGE_LOW
 164 use a low range of ports, which are normally restricted to
 165 privileged processes on
 166 .Ux
 167 systems.  The range is normally from
 168 .Dv IPPORT_RESERVED - 1
 169 down to
 170 .Li IPPORT_RESERVEDSTART
 171 in descending order.
 172 This is adjustable through the sysctl setting:
 173 .Sy net.inet.ip.portrange.lowfirst
 174 and
 175 .Sy net.inet.ip.portrange.lowlast .
 176 .El
 177 .Ss "Multicast Options"
 178 .Pp
 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 .Pp
 304 Raw
 305 .Tn IP
 306 sockets are connectionless,
 307 and are normally used with the
 308 .Xr sendto 2
 309 and
 310 .Xr recvfrom 2
 311 calls, though the
 312 .Xr connect 2
 313 call may also be used to fix the destination for future
 314 packets (in which case the
 315 .Xr read 2
 316 or
 317 .Xr recv 2
 318 and
 319 .Xr write 2
 320 or
 321 .Xr send 2
 322 system calls may be used).
 323 .Pp
 324 If
 325 .Fa proto
 326 is 0, the default protocol
 327 .Dv IPPROTO_RAW
 328 is used for outgoing
 329 packets, and only incoming packets destined for that protocol
 330 are received.
 331 If
 332 .Fa proto
 333 is non-zero, that protocol number will be used on outgoing packets
 334 and to filter incoming packets.
 335 .Pp
 336 Outgoing packets automatically have an
 337 .Tn IP
 338 header prepended to
 339 them (based on the destination address and the protocol
 340 number the socket is created with),
 341 unless the
 342 .Dv IP_HDRINCL
 343 option has been set.
 344 Incoming packets are received with
 345 .Tn IP
 346 header and options intact.
 347 .Pp
 348 .Dv IP_HDRINCL
 349 indicates the complete IP header is included with the data
 350 and may be used only with the
 351 .Dv SOCK_RAW
 352 type.
 353 .Bd -literal
 354 #include <netinet/in_systm.h>
 355 #include <netinet/ip.h>
 356
 357 int hincl = 1;                  /* 1 = on, 0 = off */
 358 setsockopt(s, IPPROTO_IP, IP_HDRINCL, &hincl, sizeof(hincl));
 359 .Ed
 360 .Pp
 361 Unlike previous
 362 .Bx
 363 releases, the program must set all
 364 the fields of the IP header, including the following:
 365 .Bd -literal
 366 ip->ip_v = IPVERSION;
 367 ip->ip_hl = hlen >> 2;
 368 ip->ip_id = 0;  /* 0 means kernel set appropriate value */
 369 ip->ip_off = offset;
 370 .Ed
 371 .Pp
 372 If the header source address is set to
 373 .Dv INADDR_ANY ,
 374 the kernel will choose an appropriate address.
 375 .Sh ERRORS
 376 A socket operation may fail with one of the following errors returned:
 377 .Bl -tag -width Er
 378 .It Bq Er EISCONN
 379 when trying to establish a connection on a socket which
 380 already has one, or when trying to send a datagram with the destination
 381 address specified and the socket is already connected;
 382 .It Bq Er ENOTCONN
 383 when trying to send a datagram, but
 384 no destination address is specified, and the socket hasn't been
 385 connected;
 386 .It Bq Er ENOBUFS
 387 when the system runs out of memory for
 388 an internal data structure;
 389 .It Bq Er EADDRNOTAVAIL
 390 when an attempt is made to create a
 391 socket with a network address for which no network interface
 392 exists.
 393 .It Bq Er EACCES
 394 when an attempt is made to create
 395 a raw IP socket by a non-privileged process.
 396 .El
 397 .Pp
 398 The following errors specific to
 399 .Tn IP
 400 may occur when setting or getting
 401 .Tn IP
 402 options:
 403 .Bl -tag -width EADDRNOTAVAILxx
 404 .It Bq Er EINVAL
 405 An unknown socket option name was given.
 406 .It Bq Er EINVAL
 407 The IP option field was improperly formed;
 408 an option field was shorter than the minimum value
 409 or longer than the option buffer provided.
 410 .El
 411 .Sh SEE ALSO
 412 .Xr getsockopt 2 ,
 413 .Xr recv 2 ,
 414 .Xr send 2 ,
 415 .Xr icmp 4 ,
 416 .Xr inet 4 ,
 417 .Xr intro 4
 418 .Sh HISTORY
 419 The
 420 .Nm
 421 protocol appeared in
 422 .Bx 4.2 .