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$
  34 .\"
  35 .Dd June 1, 2009
  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 .Dv IP_MINTTL
 117 may be used to set the minimum acceptable TTL a packet must have when
 118 received on a socket.
 119 All packets with a lower TTL are silently dropped.
 120 This option is only really useful when set to 255, preventing packets
 121 from outside the directly connected networks reaching local listeners
 122 on sockets.
 123 .Pp
 124 .Dv IP_DONTFRAG
 125 may be used to set the Don't Fragment flag on IP packets.
 126 Currently this option is respected only on
 127 .Xr udp 4
 128 and raw
 129 .Xr ip 4
 130 sockets, unless the
 131 .Dv IP_HDRINCL
 132 option has been set.
 133 On
 134 .Xr tcp 4
 135 sockets, the Don't Fragment flag is controlled by the Path
 136 MTU Discovery option.
 137 Sending a packet larger than the MTU size of the egress interface,
 138 determined by the destination address, returns an
 139 .Er EMSGSIZE
 140 error.
 141 .Pp
 142 If the
 143 .Dv IP_RECVDSTADDR
 144 option is enabled on a
 145 .Dv SOCK_DGRAM
 146 socket,
 147 the
 148 .Xr recvmsg 2
 149 call will return the destination
 150 .Tn IP
 151 address for a
 152 .Tn UDP
 153 datagram.
 154 The
 155 .Vt msg_control
 156 field in the
 157 .Vt msghdr
 158 structure points to a buffer
 159 that contains a
 160 .Vt cmsghdr
 161 structure followed by the
 162 .Tn IP
 163 address.
 164 The
 165 .Vt cmsghdr
 166 fields have the following values:
 167 .Bd -literal
 168 cmsg_len = sizeof(struct in_addr)
 169 cmsg_level = IPPROTO_IP
 170 cmsg_type = IP_RECVDSTADDR
 171 .Ed
 172 .Pp
 173 The source address to be used for outgoing
 174 .Tn UDP
 175 datagrams on a socket that is not bound to a specific
 176 .Tn IP
 177 address can be specified as ancillary data with a type code of
 178 .Dv IP_SENDSRCADDR .
 179 The msg_control field in the msghdr structure should point to a buffer
 180 that contains a
 181 .Vt cmsghdr
 182 structure followed by the
 183 .Tn IP
 184 address.
 185 The cmsghdr fields should have the following values:
 186 .Bd -literal
 187 cmsg_len = sizeof(struct in_addr)
 188 cmsg_level = IPPROTO_IP
 189 cmsg_type = IP_SENDSRCADDR
 190 .Ed
 191 .Pp
 192 For convenience,
 193 .Dv IP_SENDSRCADDR
 194 is defined to have the same value as
 195 .Dv IP_RECVDSTADDR ,
 196 so the
 197 .Dv IP_RECVDSTADDR
 198 control message from
 199 .Xr recvmsg 2
 200 can be used directly as a control message for
 201 .Xr sendmsg 2 .
 202 .\"
 203 .Pp
 204 If the
 205 .Dv IP_ONESBCAST
 206 option is enabled on a
 207 .Dv SOCK_DGRAM
 208 or a
 209 .Dv SOCK_RAW
 210 socket, the destination address of outgoing
 211 broadcast datagrams on that socket will be forced
 212 to the undirected broadcast address,
 213 .Dv INADDR_BROADCAST ,
 214 before transmission.
 215 This is in contrast to the default behavior of the
 216 system, which is to transmit undirected broadcasts
 217 via the first network interface with the
 218 .Dv IFF_BROADCAST flag set.
 219 .Pp
 220 This option allows applications to choose which
 221 interface is used to transmit an undirected broadcast
 222 datagram.
 223 For example, the following code would force an
 224 undirected broadcast to be transmitted via the interface
 225 configured with the broadcast address 192.168.2.255:
 226 .Bd -literal
 227 char msg[512];
 228 struct sockaddr_in sin;
 229 u_char onesbcast = 1;   /* 0 = disable (default), 1 = enable */
 230
 231 setsockopt(s, IPPROTO_IP, IP_ONESBCAST, &onesbcast, sizeof(onesbcast));
 232 sin.sin_addr.s_addr = inet_addr("192.168.2.255");
 233 sin.sin_port = htons(1234);
 234 sendto(s, msg, sizeof(msg), 0, &sin, sizeof(sin));
 235 .Ed
 236 .Pp
 237 It is the application's responsibility to set the
 238 .Dv IP_TTL option
 239 to an appropriate value in order to prevent broadcast storms.
 240 The application must have sufficient credentials to set the
 241 .Dv SO_BROADCAST
 242 socket level option, otherwise the
 243 .Dv IP_ONESBCAST option has no effect.
 244 .Pp
 245 If the
 246 .Dv IP_BINDANY
 247 option is enabled on a
 248 .Dv SOCK_STREAM ,
 249 .Dv SOCK_DGRAM
 250 or a
 251 .Dv SOCK_RAW
 252 socket, one can
 253 .Xr bind 2
 254 to any address, even one not bound to any available network interface in the
 255 system.
 256 This functionality (in conjunction with special firewall rules) can be used for
 257 implementing a transparent proxy.
 258 The
 259 .Dv PRIV_NETINET_BINDANY
 260 privilege is needed to set this option.
 261 .Pp
 262 If the
 263 .Dv IP_RECVTTL
 264 option is enabled on a
 265 .Dv SOCK_DGRAM
 266 socket, the
 267 .Xr recvmsg 2
 268 call will return the
 269 .Tn IP
 270 .Tn TTL
 271 (time to live) field for a
 272 .Tn UDP
 273 datagram.
 274 The msg_control field in the msghdr structure points to a buffer
 275 that contains a cmsghdr structure followed by the
 276 .Tn TTL .
 277 The cmsghdr fields have the following values:
 278 .Bd -literal
 279 cmsg_len = sizeof(u_char)
 280 cmsg_level = IPPROTO_IP
 281 cmsg_type = IP_RECVTTL
 282 .Ed
 283 .\"
 284 .Pp
 285 If the
 286 .Dv IP_RECVIF
 287 option is enabled on a
 288 .Dv SOCK_DGRAM
 289 socket, the
 290 .Xr recvmsg 2
 291 call returns a
 292 .Vt "struct sockaddr_dl"
 293 corresponding to the interface on which the
 294 packet was received.
 295 The
 296 .Va msg_control
 297 field in the
 298 .Vt msghdr
 299 structure points to a buffer that contains a
 300 .Vt cmsghdr
 301 structure followed by the
 302 .Vt "struct sockaddr_dl" .
 303 The
 304 .Vt cmsghdr
 305 fields have the following values:
 306 .Bd -literal
 307 cmsg_len = sizeof(struct sockaddr_dl)
 308 cmsg_level = IPPROTO_IP
 309 cmsg_type = IP_RECVIF
 310 .Ed
 311 .Pp
 312 .Dv IP_PORTRANGE
 313 may be used to set the port range used for selecting a local port number
 314 on a socket with an unspecified (zero) port number.
 315 It has the following
 316 possible values:
 317 .Bl -tag -width IP_PORTRANGE_DEFAULT
 318 .It Dv IP_PORTRANGE_DEFAULT
 319 use the default range of values, normally
 320 .Dv IPPORT_HIFIRSTAUTO
 321 through
 322 .Dv IPPORT_HILASTAUTO .
 323 This is adjustable through the sysctl setting:
 324 .Va net.inet.ip.portrange.first
 325 and
 326 .Va net.inet.ip.portrange.last .
 327 .It Dv IP_PORTRANGE_HIGH
 328 use a high range of values, normally
 329 .Dv IPPORT_HIFIRSTAUTO
 330 and
 331 .Dv IPPORT_HILASTAUTO .
 332 This is adjustable through the sysctl setting:
 333 .Va net.inet.ip.portrange.hifirst
 334 and
 335 .Va net.inet.ip.portrange.hilast .
 336 .It Dv IP_PORTRANGE_LOW
 337 use a low range of ports, which are normally restricted to
 338 privileged processes on
 339 .Ux
 340 systems.
 341 The range is normally from
 342 .Dv IPPORT_RESERVED
 343 \- 1 down to
 344 .Li IPPORT_RESERVEDSTART
 345 in descending order.
 346 This is adjustable through the sysctl setting:
 347 .Va net.inet.ip.portrange.lowfirst
 348 and
 349 .Va net.inet.ip.portrange.lowlast .
 350 .El
 351 .Pp
 352 The range of privileged ports which only may be opened by
 353 root-owned processes may be modified by the
 354 .Va net.inet.ip.portrange.reservedlow
 355 and
 356 .Va net.inet.ip.portrange.reservedhigh
 357 sysctl settings.
 358 The values default to the traditional range,
 359 0 through
 360 .Dv IPPORT_RESERVED
 361 \- 1
 362 (0 through 1023), respectively.
 363 Note that these settings do not affect and are not accounted for in the
 364 use or calculation of the other
 365 .Va net.inet.ip.portrange
 366 values above.
 367 Changing these values departs from
 368 .Ux
 369 tradition and has security
 370 consequences that the administrator should carefully evaluate before
 371 modifying these settings.
 372 .Pp
 373 Ports are allocated at random within the specified port range in order
 374 to increase the difficulty of random spoofing attacks.
 375 In scenarios such as benchmarking, this behavior may be undesirable.
 376 In these cases,
 377 .Va net.inet.ip.portrange.randomized
 378 can be used to toggle randomization off.
 379 If more than
 380 .Va net.inet.ip.portrange.randomcps
 381 ports have been allocated in the last second, then return to sequential
 382 port allocation.
 383 Return to random allocation only once the current port allocation rate
 384 drops below
 385 .Va net.inet.ip.portrange.randomcps
 386 for at least
 387 .Va net.inet.ip.portrange.randomtime
 388 seconds.
 389 The default values for
 390 .Va net.inet.ip.portrange.randomcps
 391 and
 392 .Va net.inet.ip.portrange.randomtime
 393 are 10 port allocations per second and 45 seconds correspondingly.
 394 .Ss "Multicast Options"
 395 .Pp
 396 .Tn IP
 397 multicasting is supported only on
 398 .Dv AF_INET
 399 sockets of type
 400 .Dv SOCK_DGRAM
 401 and
 402 .Dv SOCK_RAW ,
 403 and only on networks where the interface
 404 driver supports multicasting.
 405 .Pp
 406 The
 407 .Dv IP_MULTICAST_TTL
 408 option changes the time-to-live (TTL)
 409 for outgoing multicast datagrams
 410 in order to control the scope of the multicasts:
 411 .Bd -literal
 412 u_char ttl;     /* range: 0 to 255, default = 1 */
 413 setsockopt(s, IPPROTO_IP, IP_MULTICAST_TTL, &ttl, sizeof(ttl));
 414 .Ed
 415 .Pp
 416 Datagrams with a TTL of 1 are not forwarded beyond the local network.
 417 Multicast datagrams with a TTL of 0 will not be transmitted on any network,
 418 but may be delivered locally if the sending host belongs to the destination
 419 group and if multicast loopback has not been disabled on the sending socket
 420 (see below).
 421 Multicast datagrams with TTL greater than 1 may be forwarded
 422 to other networks if a multicast router is attached to the local network.
 423 .Pp
 424 For hosts with multiple interfaces, where an interface has not
 425 been specified for a multicast group membership,
 426 each multicast transmission is sent from the primary network interface.
 427 The
 428 .Dv IP_MULTICAST_IF
 429 option overrides the default for
 430 subsequent transmissions from a given socket:
 431 .Bd -literal
 432 struct in_addr addr;
 433 setsockopt(s, IPPROTO_IP, IP_MULTICAST_IF, &addr, sizeof(addr));
 434 .Ed
 435 .Pp
 436 where "addr" is the local
 437 .Tn IP
 438 address of the desired interface or
 439 .Dv INADDR_ANY
 440 to specify the default interface.
 441 .Pp
 442 To specify an interface by index, an instance of
 443 .Vt ip_mreqn
 444 may be passed instead.
 445 The
 446 .Vt imr_ifindex
 447 member should be set to the index of the desired interface,
 448 or 0 to specify the default interface.
 449 The kernel differentiates between these two structures by their size.
 450 .Pp
 451 The use of
 452 .Vt IP_MULTICAST_IF
 453 is
 454 .Em not recommended ,
 455 as multicast memberships are scoped to each
 456 individual interface.
 457 It is supported for legacy use only by applications,
 458 such as routing daemons, which expect to
 459 be able to transmit link-local IPv4 multicast datagrams (224.0.0.0/24)
 460 on multiple interfaces,
 461 without requesting an individual membership for each interface.
 462 .Pp
 463 .\"
 464 An interface's local IP address and multicast capability can
 465 be obtained via the
 466 .Dv SIOCGIFCONF
 467 and
 468 .Dv SIOCGIFFLAGS
 469 ioctls.
 470 Normal applications should not need to use this option.
 471 .Pp
 472 If a multicast datagram is sent to a group to which the sending host itself
 473 belongs (on the outgoing interface), a copy of the datagram is, by default,
 474 looped back by the IP layer for local delivery.
 475 The
 476 .Dv IP_MULTICAST_LOOP
 477 option gives the sender explicit control
 478 over whether or not subsequent datagrams are looped back:
 479 .Bd -literal
 480 u_char loop;    /* 0 = disable, 1 = enable (default) */
 481 setsockopt(s, IPPROTO_IP, IP_MULTICAST_LOOP, &loop, sizeof(loop));
 482 .Ed
 483 .Pp
 484 This option
 485 improves performance for applications that may have no more than one
 486 instance on a single host (such as a routing daemon), by eliminating
 487 the overhead of receiving their own transmissions.
 488 It should generally not
 489 be used by applications for which there may be more than one instance on a
 490 single host (such as a conferencing program) or for which the sender does
 491 not belong to the destination group (such as a time querying program).
 492 .Pp
 493 The sysctl setting
 494 .Va net.inet.ip.mcast.loop
 495 controls the default setting of the
 496 .Dv IP_MULTICAST_LOOP
 497 socket option for new sockets.
 498 .Pp
 499 A multicast datagram sent with an initial TTL greater than 1 may be delivered
 500 to the sending host on a different interface from that on which it was sent,
 501 if the host belongs to the destination group on that other interface.
 502 The loopback control option has no effect on such delivery.
 503 .Pp
 504 A host must become a member of a multicast group before it can receive
 505 datagrams sent to the group.
 506 To join a multicast group, use the
 507 .Dv IP_ADD_MEMBERSHIP
 508 option:
 509 .Bd -literal
 510 struct ip_mreq mreq;
 511 setsockopt(s, IPPROTO_IP, IP_ADD_MEMBERSHIP, &mreq, sizeof(mreq));
 512 .Ed
 513 .Pp
 514 where
 515 .Fa mreq
 516 is the following structure:
 517 .Bd -literal
 518 struct ip_mreq {
 519     struct in_addr imr_multiaddr; /* IP multicast address of group */
 520     struct in_addr imr_interface; /* local IP address of interface */
 521 }
 522 .Ed
 523 .Pp
 524 .Va imr_interface
 525 should be set to the
 526 .Tn IP
 527 address of a particular multicast-capable interface if
 528 the host is multihomed.
 529 It may be set to
 530 .Dv INADDR_ANY
 531 to choose the default interface, although this is not recommended;
 532 this is considered to be the first interface corresponding
 533 to the default route.
 534 Otherwise, the first multicast-capable interface
 535 configured in the system will be used.
 536 .Pp
 537 Prior to
 538 .Fx 7.0 ,
 539 if the
 540 .Va imr_interface
 541 member is within the network range
 542 .Li 0.0.0.0/8 ,
 543 it is treated as an interface index in the system interface MIB,
 544 as per the RIP Version 2 MIB Extension (RFC-1724).
 545 In versions of
 546 .Fx
 547 since 7.0, this behavior is no longer supported.
 548 Developers should
 549 instead use the RFC 3678 multicast source filter APIs; in particular,
 550 .Dv MCAST_JOIN_GROUP .
 551 .Pp
 552 Up to
 553 .Dv IP_MAX_MEMBERSHIPS
 554 memberships may be added on a single socket.
 555 Membership is associated with a single interface;
 556 programs running on multihomed hosts may need to
 557 join the same group on more than one interface.
 558 .Pp
 559 To drop a membership, use:
 560 .Bd -literal
 561 struct ip_mreq mreq;
 562 setsockopt(s, IPPROTO_IP, IP_DROP_MEMBERSHIP, &mreq, sizeof(mreq));
 563 .Ed
 564 .Pp
 565 where
 566 .Fa mreq
 567 contains the same values as used to add the membership.
 568 Memberships are dropped when the socket is closed or the process exits.
 569 .\" TODO: Update this piece when IPv4 source-address selection is implemented.
 570 .Pp
 571 The IGMP protocol uses the primary IP address of the interface
 572 as its identifier for group membership.
 573 This is the first IP address configured on the interface.
 574 If this address is removed or changed, the results are
 575 undefined, as the IGMP membership state will then be inconsistent.
 576 If multiple IP aliases are configured on the same interface,
 577 they will be ignored.
 578 .Pp
 579 This shortcoming was addressed in IPv6; MLDv2 requires
 580 that the unique link-local address for an interface is
 581 used to identify an MLDv2 listener.
 582 .Ss "Source-Specific Multicast Options"
 583 Since
 584 .Fx 8.0 ,
 585 the use of Source-Specific Multicast (SSM) is supported.
 586 These extensions require an IGMPv3 multicast router in order to
 587 make best use of them.
 588 If a legacy multicast router is present on the link,
 589 .Fx
 590 will simply downgrade to the version of IGMP spoken by the router,
 591 and the benefits of source filtering on the upstream link
 592 will not be present, although the kernel will continue to
 593 squelch transmissions from blocked sources.
 594 .Pp
 595 Each group membership on a socket now has a filter mode:
 596 .Bl -tag -width MCAST_EXCLUDE
 597 .It Dv MCAST_EXCLUDE
 598 Datagrams sent to this group are accepted,
 599 unless the source is in a list of blocked source addresses.
 600 .It Dv MCAST_INCLUDE
 601 Datagrams sent to this group are accepted
 602 only if the source is in a list of accepted source addresses.
 603 .El
 604 .Pp
 605 Groups joined using the legacy
 606 .Dv IP_ADD_MEMBERSHIP
 607 option are placed in exclusive-mode,
 608 and are able to request that certain sources are blocked or allowed.
 609 This is known as the
 610 .Em delta-based API .
 611 .Pp
 612 To block a multicast source on an existing group membership:
 613 .Bd -literal
 614 struct ip_mreq_source mreqs;
 615 setsockopt(s, IPPROTO_IP, IP_BLOCK_SOURCE, &mreqs, sizeof(mreqs));
 616 .Ed
 617 .Pp
 618 where
 619 .Fa mreqs
 620 is the following structure:
 621 .Bd -literal
 622 struct ip_mreq_source {
 623     struct in_addr imr_multiaddr; /* IP multicast address of group */
 624     struct in_addr imr_sourceaddr; /* IP address of source */
 625     struct in_addr imr_interface; /* local IP address of interface */
 626 }
 627 .Ed
 628 .Va imr_sourceaddr
 629 should be set to the address of the source to be blocked.
 630 .Pp
 631 To unblock a multicast source on an existing group:
 632 .Bd -literal
 633 struct ip_mreq_source mreqs;
 634 setsockopt(s, IPPROTO_IP, IP_UNBLOCK_SOURCE, &mreqs, sizeof(mreqs));
 635 .Ed
 636 .Pp
 637 The
 638 .Dv IP_BLOCK_SOURCE
 639 and
 640 .Dv IP_UNBLOCK_SOURCE
 641 options are
 642 .Em not permitted
 643 for inclusive-mode group memberships.
 644 .Pp
 645 To join a multicast group in
 646 .Dv MCAST_INCLUDE
 647 mode with a single source,
 648 or add another source to an existing inclusive-mode membership:
 649 .Bd -literal
 650 struct ip_mreq_source mreqs;
 651 setsockopt(s, IPPROTO_IP, IP_ADD_SOURCE_MEMBERSHIP, &mreqs, sizeof(mreqs));
 652 .Ed
 653 .Pp
 654 To leave a single source from an existing group in inclusive mode:
 655 .Bd -literal
 656 struct ip_mreq_source mreqs;
 657 setsockopt(s, IPPROTO_IP, IP_DROP_SOURCE_MEMBERSHIP, &mreqs, sizeof(mreqs));
 658 .Ed
 659 If this is the last accepted source for the group, the membership
 660 will be dropped.
 661 .Pp
 662 The
 663 .Dv IP_ADD_SOURCE_MEMBERSHIP
 664 and
 665 .Dv IP_DROP_SOURCE_MEMBERSHIP
 666 options are
 667 .Em not accepted
 668 for exclusive-mode group memberships.
 669 However, both exclusive and inclusive mode memberships
 670 support the use of the
 671 .Em full-state API
 672 documented in RFC 3678.
 673 For management of source filter lists using this API,
 674 please refer to
 675 .Xr sourcefilter 3 .
 676 .Pp
 677 The sysctl settings
 678 .Va net.inet.ip.mcast.maxsocksrc
 679 and
 680 .Va net.inet.ip.mcast.maxgrpsrc
 681 are used to specify an upper limit on the number of per-socket and per-group
 682 source filter entries which the kernel may allocate.
 683 .\"-----------------------
 684 .Ss "Raw IP Sockets"
 685 .Pp
 686 Raw
 687 .Tn IP
 688 sockets are connectionless,
 689 and are normally used with the
 690 .Xr sendto 2
 691 and
 692 .Xr recvfrom 2
 693 calls, though the
 694 .Xr connect 2
 695 call may also be used to fix the destination for future
 696 packets (in which case the
 697 .Xr read 2
 698 or
 699 .Xr recv 2
 700 and
 701 .Xr write 2
 702 or
 703 .Xr send 2
 704 system calls may be used).
 705 .Pp
 706 If
 707 .Fa proto
 708 is 0, the default protocol
 709 .Dv IPPROTO_RAW
 710 is used for outgoing
 711 packets, and only incoming packets destined for that protocol
 712 are received.
 713 If
 714 .Fa proto
 715 is non-zero, that protocol number will be used on outgoing packets
 716 and to filter incoming packets.
 717 .Pp
 718 Outgoing packets automatically have an
 719 .Tn IP
 720 header prepended to
 721 them (based on the destination address and the protocol
 722 number the socket is created with),
 723 unless the
 724 .Dv IP_HDRINCL
 725 option has been set.
 726 Incoming packets are received with
 727 .Tn IP
 728 header and options intact.
 729 .Pp
 730 .Dv IP_HDRINCL
 731 indicates the complete IP header is included with the data
 732 and may be used only with the
 733 .Dv SOCK_RAW
 734 type.
 735 .Bd -literal
 736 #include <netinet/in_systm.h>
 737 #include <netinet/ip.h>
 738
 739 int hincl = 1;                  /* 1 = on, 0 = off */
 740 setsockopt(s, IPPROTO_IP, IP_HDRINCL, &hincl, sizeof(hincl));
 741 .Ed
 742 .Pp
 743 Unlike previous
 744 .Bx
 745 releases, the program must set all
 746 the fields of the IP header, including the following:
 747 .Bd -literal
 748 ip->ip_v = IPVERSION;
 749 ip->ip_hl = hlen >> 2;
 750 ip->ip_id = 0;  /* 0 means kernel set appropriate value */
 751 ip->ip_off = offset;
 752 .Ed
 753 .Pp
 754 The
 755 .Va ip_len
 756 and
 757 .Va ip_off
 758 fields
 759 .Em must
 760 be provided in host byte order .
 761 All other fields must be provided in network byte order.
 762 See
 763 .Xr byteorder 3
 764 for more information on network byte order.
 765 If the
 766 .Va ip_id
 767 field is set to 0 then the kernel will choose an
 768 appropriate value.
 769 If the header source address is set to
 770 .Dv INADDR_ANY ,
 771 the kernel will choose an appropriate address.
 772 .Sh ERRORS
 773 A socket operation may fail with one of the following errors returned:
 774 .Bl -tag -width Er
 775 .It Bq Er EISCONN
 776 when trying to establish a connection on a socket which
 777 already has one, or when trying to send a datagram with the destination
 778 address specified and the socket is already connected;
 779 .It Bq Er ENOTCONN
 780 when trying to send a datagram, but
 781 no destination address is specified, and the socket has not been
 782 connected;
 783 .It Bq Er ENOBUFS
 784 when the system runs out of memory for
 785 an internal data structure;
 786 .It Bq Er EADDRNOTAVAIL
 787 when an attempt is made to create a
 788 socket with a network address for which no network interface
 789 exists.
 790 .It Bq Er EACCES
 791 when an attempt is made to create
 792 a raw IP socket by a non-privileged process.
 793 .El
 794 .Pp
 795 The following errors specific to
 796 .Tn IP
 797 may occur when setting or getting
 798 .Tn IP
 799 options:
 800 .Bl -tag -width Er
 801 .It Bq Er EINVAL
 802 An unknown socket option name was given.
 803 .It Bq Er EINVAL
 804 The IP option field was improperly formed;
 805 an option field was shorter than the minimum value
 806 or longer than the option buffer provided.
 807 .El
 808 .Pp
 809 The following errors may occur when attempting to send
 810 .Tn IP
 811 datagrams via a
 812 .Dq raw socket
 813 with the
 814 .Dv IP_HDRINCL
 815 option set:
 816 .Bl -tag -width Er
 817 .It Bq Er EINVAL
 818 The user-supplied
 819 .Va ip_len
 820 field was not equal to the length of the datagram written to the socket.
 821 .El
 822 .Sh SEE ALSO
 823 .Xr getsockopt 2 ,
 824 .Xr recv 2 ,
 825 .Xr send 2 ,
 826 .Xr byteorder 3 ,
 827 .Xr icmp 4 ,
 828 .Xr igmp 4 ,
 829 .Xr inet 4 ,
 830 .Xr intro 4 ,
 831 .Xr multicast 4 ,
 832 .Xr sourcefilter 3
 833 .Rs
 834 .%A D. Thaler
 835 .%A B. Fenner
 836 .%A B. Quinn
 837 .%T "Socket Interface Extensions for Multicast Source Filters"
 838 .%N RFC 3678
 839 .%D Jan 2004
 840 .Re
 841 .Sh HISTORY
 842 The
 843 .Nm
 844 protocol appeared in
 845 .Bx 4.2 .
 846 The
 847 .Vt ip_mreqn
 848 structure appeared in
 849 .Tn Linux 2.4 .