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