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