]> git.saurik.com Git - apple/xnu.git/blobdiff - bsd/netinet/in.h
xnu-3248.50.21.tar.gz
[apple/xnu.git] / bsd / netinet / in.h
index 7f23a9e6a6168eb1020c76fa158aa36f6cbd5a32..497a03cea1ef9800fc476751291bfe8e8537f083 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
+ * Copyright (c) 2000-2013 Apple Inc. All rights reserved.
  *
  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
  * 
 #include <sys/_types.h>
 #include <stdint.h>            /* uint(8|16|32)_t */
 
-#ifndef _IN_ADDR_T
-#define _IN_ADDR_T
-typedef        __uint32_t      in_addr_t;      /* base type for internet address */
+#ifndef KERNEL
+#include <Availability.h>
 #endif
 
-#ifndef _IN_PORT_T
-#define _IN_PORT_T
-typedef        __uint16_t      in_port_t;
-#endif
+#include <sys/_types/_in_addr_t.h>
+
+#include <sys/_types/_in_port_t.h>
 
 /*
  * POSIX 1003.1-2003
@@ -207,10 +205,11 @@ typedef   __uint16_t      in_port_t;
 #define        IPPROTO_ENCAP           98              /* encapsulation header */
 #define        IPPROTO_APES            99              /* any private encr. scheme */
 #define        IPPROTO_GMTP            100             /* GMTP*/
-#define        IPPROTO_IPCOMP  108             /* payload compression (IPComp) */
 /* 101-254: Partly Unassigned */
 #define        IPPROTO_PIM             103             /* Protocol Independent Mcast */
+#define IPPROTO_IPCOMP         108             /* payload compression (IPComp) */
 #define        IPPROTO_PGM             113             /* PGM */
+#define IPPROTO_SCTP           132             /* SCTP */
 /* 255: Reserved */
 /* BSD Private, local use, namespace incursion */
 #define        IPPROTO_DIVERT          254             /* divert pseudo-protocol */
@@ -341,6 +340,7 @@ struct in_addr {
 #define        IN_BADCLASS(i)          (((u_int32_t)(i) & 0xf0000000) == 0xf0000000)
 
 #define        INADDR_LOOPBACK         (u_int32_t)0x7f000001
+
 #ifndef KERNEL
 #define        INADDR_NONE             0xffffffff              /* -1 return */
 #endif
@@ -348,11 +348,25 @@ struct in_addr {
 #define        INADDR_UNSPEC_GROUP     (u_int32_t)0xe0000000   /* 224.0.0.0 */
 #define        INADDR_ALLHOSTS_GROUP   (u_int32_t)0xe0000001   /* 224.0.0.1 */
 #define        INADDR_ALLRTRS_GROUP    (u_int32_t)0xe0000002   /* 224.0.0.2 */
+#define        INADDR_ALLRPTS_GROUP    (u_int32_t)0xe0000016   /* 224.0.0.22, IGMPv3 */
+#define        INADDR_CARP_GROUP       (u_int32_t)0xe0000012   /* 224.0.0.18 */
+#define        INADDR_PFSYNC_GROUP     (u_int32_t)0xe00000f0   /* 224.0.0.240 */
+#define        INADDR_ALLMDNS_GROUP    (u_int32_t)0xe00000fb   /* 224.0.0.251 */
 #define        INADDR_MAX_LOCAL_GROUP  (u_int32_t)0xe00000ff   /* 224.0.0.255 */
 
 #ifdef __APPLE__
 #define IN_LINKLOCALNETNUM     (u_int32_t)0xA9FE0000 /* 169.254.0.0 */
 #define IN_LINKLOCAL(i)                (((u_int32_t)(i) & IN_CLASSB_NET) == IN_LINKLOCALNETNUM)
+#define IN_LOOPBACK(i)         (((u_int32_t)(i) & 0xff000000) == 0x7f000000)
+#define IN_ZERONET(i)          (((u_int32_t)(i) & 0xff000000) == 0)
+
+#define        IN_PRIVATE(i)   ((((u_int32_t)(i) & 0xff000000) == 0x0a000000) || \
+                        (((u_int32_t)(i) & 0xfff00000) == 0xac100000) || \
+                        (((u_int32_t)(i) & 0xffff0000) == 0xc0a80000))
+
+#define        IN_LOCAL_GROUP(i)       (((u_int32_t)(i) & 0xffffff00) == 0xe0000000)
+#define        IN_ANY_LOCAL(i)         (IN_LINKLOCAL(i) || IN_LOCAL_GROUP(i))
 #endif
 
 #define        IN_LOOPBACKNET          127                     /* official! */
@@ -366,9 +380,38 @@ struct sockaddr_in {
        sa_family_t     sin_family;
        in_port_t       sin_port;
        struct  in_addr sin_addr;
-       char            sin_zero[8];            /* XXX bwg2001-004 */
+       char            sin_zero[8];
 };
 
+#ifdef PRIVATE
+/*
+ * sockaddr_in with scope ID field; this is used internally to keep
+ * track of scoped route entries in the routing table.  The fact that
+ * such a value is embedded in the structure is an artifact of the
+ * current implementation which could change in future.
+ */
+struct sockaddr_inifscope {
+       __uint8_t       sin_len;
+       sa_family_t     sin_family;
+       in_port_t       sin_port;
+       struct  in_addr sin_addr;
+       /*
+        * To avoid possible conflict with an overlaid sockaddr_inarp
+        * having sin_other set to SIN_PROXY, we use the first 4-bytes
+        * of sin_zero since sin_srcaddr is one of the unused fields
+        * in sockaddr_inarp.
+        */
+       union {
+               char    sin_zero[8];
+               struct {
+                       __uint32_t      ifscope;
+               } _in_index;
+       } un;
+#define        sin_scope_id    un._in_index.ifscope
+};
+
+#endif /* PRIVATE */
+
 #define INET_ADDRSTRLEN                 16
 
 #if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
@@ -410,11 +453,14 @@ struct ip_opts {
 #define        IP_RECVIF               20   /* bool; receive reception if w/dgram */
 /* for IPSEC */
 #define        IP_IPSEC_POLICY         21   /* int; set/get security policy */
-#define        IP_FAITH                22   /* bool; accept FAITH'ed connections */
+#define        IP_FAITH                22   /* deprecated */
 #ifdef __APPLE__
 #define IP_STRIPHDR            23   /* bool: drop receive of raw IP header */
 #endif
-#define IP_RECVTTL                     24      /* bool; receive reception TTL w/dgram */
+#define IP_RECVTTL             24   /* bool; receive reception TTL w/dgram */
+#define        IP_BOUND_IF             25   /* int; set/get bound interface */
+#define        IP_PKTINFO              26   /* get pktinfo on recv socket, set src on sent dgram  */
+#define        IP_RECVPKTINFO          IP_PKTINFO      /* receive pktinfo w/dgram */
 
 
 #define        IP_FW_ADD               40   /* add a firewall rule to chain */
@@ -439,24 +485,53 @@ struct ip_opts {
 #define        IP_DUMMYNET_GET         64   /* get entire dummynet pipes */
 
 #define        IP_TRAFFIC_MGT_BACKGROUND       65   /* int*; get background IO flags; set background IO */
+#define        IP_MULTICAST_IFINDEX    66   /* int*; set/get IP multicast i/f index */
 
-#ifdef PRIVATE
-/* This is a hack, this is only a hack. */
-#define        IP_FORCE_OUT_IFP        69      /* char ifname[] - send traffic on this interface */
-#endif
+/* IPv4 Source Filter Multicast API [RFC3678] */
+#define        IP_ADD_SOURCE_MEMBERSHIP        70   /* join a source-specific group */
+#define        IP_DROP_SOURCE_MEMBERSHIP       71   /* drop a single source */
+#define        IP_BLOCK_SOURCE                 72   /* block a source */
+#define        IP_UNBLOCK_SOURCE               73   /* unblock a source */
 
-/* Background socket configuration flags */
-#ifdef __APPLE_API_UNSTABLE
-#define TRAFFIC_MGT_SO_BACKGROUND      0x0001
-#define TRAFFIC_MGT_SO_BG_SUPPRESSED   0x0002
-#endif /* __APPLE_API_UNSTABLE */
+/* The following option is private; do not use it from user applications. */
+#define        IP_MSFILTER                     74   /* set/get filter list */
+
+/* Protocol Independent Multicast API [RFC3678] */
+#define        MCAST_JOIN_GROUP                80   /* join an any-source group */
+#define        MCAST_LEAVE_GROUP               81   /* leave all sources for group */
+#define        MCAST_JOIN_SOURCE_GROUP         82   /* join a source-specific group */
+#define        MCAST_LEAVE_SOURCE_GROUP        83   /* leave a single source */
+#define        MCAST_BLOCK_SOURCE              84   /* block a source */
+#define        MCAST_UNBLOCK_SOURCE            85   /* unblock a source */
+
+#ifdef PRIVATE
+#define        IP_FORCE_OUT_IFP        69   /* deprecated; use IP_BOUND_IF instead */
+#define        IP_NO_IFT_CELLULAR      6969 /* for internal use only */
+#define        IP_NO_IFT_PDP           IP_NO_IFT_CELLULAR /* deprecated */
+#define        IP_OUT_IF               9696 /* for internal use only */
+#endif /* PRIVATE */
 
 /*
  * Defaults and limits for options
  */
 #define        IP_DEFAULT_MULTICAST_TTL  1     /* normally limit m'casts to 1 hop  */
 #define        IP_DEFAULT_MULTICAST_LOOP 1     /* normally hear sends if a member  */
-#define        IP_MAX_MEMBERSHIPS      20      /* per socket */
+
+/*
+ * The imo_membership vector for each socket is now dynamically allocated at
+ * run-time, bounded by USHRT_MAX, and is reallocated when needed, sized
+ * according to a power-of-two increment.
+ */
+#define        IP_MIN_MEMBERSHIPS      31
+#define        IP_MAX_MEMBERSHIPS      4095
+
+/*
+ * Default resource limits for IPv4 multicast source filtering.
+ * These may be modified by sysctl.
+ */
+#define        IP_MAX_GROUP_SRC_FILTER         512     /* sources per group */
+#define        IP_MAX_SOCK_SRC_FILTER          128     /* sources per socket/group */
+#define        IP_MAX_SOCK_MUTE_FILTER         128     /* XXX no longer used */
 
 /*
  * Argument structure for IP_ADD_MEMBERSHIP and IP_DROP_MEMBERSHIP.
@@ -466,6 +541,105 @@ struct ip_mreq {
        struct  in_addr imr_interface;  /* local IP address of interface */
 };
 
+/*
+ * Modified argument structure for IP_MULTICAST_IF, obtained from Linux.
+ * This is used to specify an interface index for multicast sends, as
+ * the IPv4 legacy APIs do not support this (unless IP_SENDIF is available).
+ */
+struct ip_mreqn {
+       struct  in_addr imr_multiaddr;  /* IP multicast address of group */
+       struct  in_addr imr_address;    /* local IP address of interface */
+       int             imr_ifindex;    /* Interface index; cast to uint32_t */
+};
+
+#pragma pack(4)
+/*
+ * Argument structure for IPv4 Multicast Source Filter APIs. [RFC3678]
+ */
+struct ip_mreq_source {
+       struct  in_addr imr_multiaddr;  /* IP multicast address of group */
+       struct  in_addr imr_sourceaddr; /* IP address of source */
+       struct  in_addr imr_interface;  /* local IP address of interface */
+};
+
+/*
+ * Argument structures for Protocol-Independent Multicast Source
+ * Filter APIs. [RFC3678]
+ */
+struct group_req {
+       uint32_t                gr_interface;   /* interface index */
+       struct sockaddr_storage gr_group;       /* group address */
+};
+
+struct group_source_req {
+       uint32_t                gsr_interface;  /* interface index */
+       struct sockaddr_storage gsr_group;      /* group address */
+       struct sockaddr_storage gsr_source;     /* source address */
+};
+
+#ifndef __MSFILTERREQ_DEFINED
+#define __MSFILTERREQ_DEFINED
+/*
+ * The following structure is private; do not use it from user applications.
+ * It is used to communicate IP_MSFILTER/IPV6_MSFILTER information between
+ * the RFC 3678 libc functions and the kernel.
+ */
+struct __msfilterreq {
+       uint32_t                 msfr_ifindex;  /* interface index */
+       uint32_t                 msfr_fmode;    /* filter mode for group */
+       uint32_t                 msfr_nsrcs;    /* # of sources in msfr_srcs */
+       uint32_t                __msfr_align;   
+       struct sockaddr_storage  msfr_group;    /* group address */
+       struct sockaddr_storage *msfr_srcs;
+};
+
+#ifdef BSD_KERNEL_PRIVATE
+struct __msfilterreq32 {
+       uint32_t                 msfr_ifindex;  /* interface index */
+       uint32_t                 msfr_fmode;    /* filter mode for group */
+       uint32_t                 msfr_nsrcs;    /* # of sources in msfr_srcs */
+       uint32_t                __msfr_align;   
+       struct sockaddr_storage  msfr_group;    /* group address */
+       user32_addr_t            msfr_srcs;
+};
+
+struct __msfilterreq64 {
+       uint32_t                 msfr_ifindex;  /* interface index */
+       uint32_t                 msfr_fmode;    /* filter mode for group */
+       uint32_t                 msfr_nsrcs;    /* # of sources in msfr_srcs */
+       uint32_t                __msfr_align;   
+       struct sockaddr_storage  msfr_group;    /* group address */
+       user64_addr_t            msfr_srcs;
+};
+#endif /* BSD_KERNEL_PRIVATE */
+#endif /* __MSFILTERREQ_DEFINED */
+
+#pragma pack()
+struct sockaddr;
+
+#ifndef KERNEL
+/*
+ * Advanced (Full-state) APIs [RFC3678]
+ * The RFC specifies uint_t for the 6th argument to [sg]etsourcefilter().
+ * We use uint32_t here to be consistent.
+ */
+int    setipv4sourcefilter(int, struct in_addr, struct in_addr, uint32_t,
+           uint32_t, struct in_addr *) __OSX_AVAILABLE_STARTING(__MAC_10_7, __IPHONE_4_3);
+int    getipv4sourcefilter(int, struct in_addr, struct in_addr, uint32_t *,
+           uint32_t *, struct in_addr *) __OSX_AVAILABLE_STARTING(__MAC_10_7, __IPHONE_4_3);
+int    setsourcefilter(int, uint32_t, struct sockaddr *, socklen_t,
+           uint32_t, uint32_t, struct sockaddr_storage *) __OSX_AVAILABLE_STARTING(__MAC_10_7, __IPHONE_4_3);
+int    getsourcefilter(int, uint32_t, struct sockaddr *, socklen_t,
+           uint32_t *, uint32_t *, struct sockaddr_storage *) __OSX_AVAILABLE_STARTING(__MAC_10_7, __IPHONE_4_3);
+#endif
+
+/*
+ * Filter modes; also used to represent per-socket filter mode internally.
+ */
+#define        MCAST_UNDEFINED 0       /* fmode: not yet defined */
+#define        MCAST_INCLUDE   1       /* fmode: include these source(s) */
+#define        MCAST_EXCLUDE   2       /* fmode: exclude these source(s) */
+
 /*
  * Argument for IP_PORTRANGE:
  * - which range to search when port is unspecified at bind() or connect()
@@ -475,6 +649,31 @@ struct ip_mreq {
 #define        IP_PORTRANGE_LOW        2       /* "low" - vouchsafe security */
 
 
+/*
+ * IP_PKTINFO: Packet information (equivalent to  RFC2292 sec 5 for IPv4)
+ * This structure is used for 
+ *
+ * 1) Receiving ancilliary data about the datagram if IP_PKTINFO sockopt is 
+ *    set on the socket. In this case ipi_ifindex will contain the interface
+ *    index the datagram was received on, ipi_addr is the IP address the 
+ *    datagram was received to.
+ *
+ * 2) Sending a datagram using a specific interface or IP source address.
+ *    if ipi_ifindex is set to non-zero when in_pktinfo is passed as 
+ *    ancilliary data of type IP_PKTINFO, this will be used as the source
+ *    interface to send the datagram from. If ipi_ifindex is null, ip_spec_dst
+ *    will be used for the source address.
+ *
+ *    Note: if IP_BOUND_IF is set on the socket, ipi_ifindex in the ancillary
+ *    IP_PKTINFO option silently overrides the bound interface when it is
+ *    specified during send time.
+ */
+struct in_pktinfo {
+       unsigned int    ipi_ifindex;    /* send/recv interface index */
+       struct in_addr  ipi_spec_dst;   /* Local address */
+       struct in_addr  ipi_addr;       /* IP Header dst address */
+};
+
 /*
  * Definitions for inet sysctl operations.
  *
@@ -483,8 +682,7 @@ struct ip_mreq {
  */
 #define        IPPROTO_MAXID   (IPPROTO_AH + 1)        /* don't list to IPPROTO_MAX */
 
-#ifdef KERNEL_PRIVATE
-
+#ifdef BSD_KERNEL_PRIVATE
 #define        CTL_IPPROTO_NAMES { \
        { "ip", CTLTYPE_NODE }, \
        { "icmp", CTLTYPE_NODE }, \
@@ -539,8 +737,7 @@ struct ip_mreq {
        { 0, 0 }, \
        { "ipsec", CTLTYPE_NODE }, \
 }
-
-#endif /* KERNEL_PRIVATE */
+#endif /* BSD_KERNEL_PRIVATE */
 
 /*
  * Names for IP sysctl objects
@@ -561,11 +758,11 @@ struct ip_mreq {
 #define        IPCTL_STATS             12      /* ipstat structure */
 #define        IPCTL_ACCEPTSOURCEROUTE 13      /* may accept source routed packets */
 #define        IPCTL_FASTFORWARDING    14      /* use fast IP forwarding code */
-#define        IPCTL_KEEPFAITH         15      /* FAITH IPv4->IPv6 translater ctl */
+#define        IPCTL_KEEPFAITH         15      /* deprecated */
 #define        IPCTL_GIF_TTL           16      /* default TTL for gif encap packet */
 #define        IPCTL_MAXID             17
 
-#ifdef KERNEL_PRIVATE
+#ifdef BSD_KERNEL_PRIVATE
 
 #define        IPCTL_NAMES { \
        { 0, 0 }, \
@@ -586,40 +783,99 @@ struct ip_mreq {
        { "keepfaith", CTLTYPE_INT }, \
        { "gifttl", CTLTYPE_INT }, \
 }
-#endif /* KERNEL_PRIVATE */
-
+#endif /* BSD_KERNEL_PRIVATE */
 #endif /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */
 
-
 /* INET6 stuff */
 #define __KAME_NETINET_IN_H_INCLUDED_
 #include <netinet6/in6.h>
 #undef __KAME_NETINET_IN_H_INCLUDED_
 
-#ifdef KERNEL
-#ifdef KERNEL_PRIVATE
-struct ifnet; struct mbuf;     /* forward declarations for Standard C */
-
-extern int in_broadcast(struct in_addr, struct ifnet *);
-extern int in_canforward(struct in_addr);
-
-#define        in_cksum(m, l)          inet_cksum(m, 0, 0, l)
-#define        in_cksum_skip(m, l, o)  inet_cksum(m, 0, o, (l) - (o))
+#ifdef PRIVATE
+/* 
+ * Minimal sized structure to hold an IPv4 or IPv6 socket address
+ * as sockaddr_storage can waste memory
+ */
+union sockaddr_in_4_6 {
+       struct sockaddr         sa;
+       struct sockaddr_in      sin;
+       struct sockaddr_in6     sin6;
+};
+#endif /* PRIVATE */
 
-extern u_int16_t inet_cksum(struct mbuf *m, unsigned int proto,
-    unsigned int offset, unsigned int transport_len);
-extern u_short in_addword(u_short, u_short);
-extern u_short in_pseudo(u_int, u_int, u_int);
+#ifdef KERNEL
+#ifdef BSD_KERNEL_PRIVATE
+#include <mach/boolean.h>
+
+struct ip;
+struct ifnet;
+struct mbuf;
+
+extern boolean_t in_broadcast(struct in_addr, struct ifnet *);
+extern boolean_t in_canforward(struct in_addr);
+extern u_int32_t in_netof(struct in_addr);
+
+extern uint16_t inet_cksum(struct mbuf *, uint32_t, uint32_t, uint32_t);
+extern uint16_t in_addword(uint16_t, uint16_t);
+extern uint16_t in_pseudo(uint32_t, uint32_t, uint32_t);
+extern uint16_t in_pseudo64(uint64_t, uint64_t, uint64_t);
+extern uint16_t in_cksum_hdr_opt(const struct ip *);
+extern uint16_t ip_cksum_hdr_dir(struct mbuf *, uint32_t, int);
+extern uint32_t in_finalize_cksum(struct mbuf *, uint32_t, uint32_t);
+extern uint16_t b_sum16(const void *buf, int len);
+
+#define        in_cksum(_m, _l)                        \
+       inet_cksum(_m, 0, 0, _l)
+#define        ip_cksum_hdr_in(_m, _l)                 \
+       ip_cksum_hdr_dir(_m, _l, 0)
+#define        ip_cksum_hdr_out(_m, _l)                \
+       ip_cksum_hdr_dir(_m, _l, 1)
+
+#define        in_cksum_hdr(_ip)                       \
+       (~b_sum16(_ip, sizeof (struct ip)) & 0xffff)
+
+#define        in_cksum_offset(_m, _o)         \
+       ((void) in_finalize_cksum(_m, _o, CSUM_DELAY_IP))
+#define        in_delayed_cksum(_m)            \
+       ((void) in_finalize_cksum(_m, 0, CSUM_DELAY_DATA))
+#define        in_delayed_cksum_offset(_m, _o) \
+       ((void) in_finalize_cksum(_m, _o, CSUM_DELAY_DATA))
+
+#define        in_hosteq(s, t) ((s).s_addr == (t).s_addr)
+#define        in_nullhost(x)  ((x).s_addr == INADDR_ANY)
+#define        in_allhosts(x)  ((x).s_addr == htonl(INADDR_ALLHOSTS_GROUP))
+
+#define        SIN(s)          ((struct sockaddr_in *)(void *)s)
+#define        satosin(sa)     SIN(sa)
+#define        sintosa(sin)    ((struct sockaddr *)(void *)(sin))
+#define        SINIFSCOPE(s)   ((struct sockaddr_inifscope *)(void *)(s))
+#endif /* BSD_KERNEL_PRIVATE */
 
+#ifdef KERNEL_PRIVATE
+/* exported for ApplicationFirewall */
 extern int in_localaddr(struct in_addr);
-extern u_long in_netof(struct in_addr);
-
 extern int inaddr_local(struct in_addr);
+
+extern char    *inet_ntoa(struct in_addr);
+extern char    *inet_ntoa_r(struct in_addr ina, char *buf,
+    size_t buflen);
+extern int     inet_pton(int af, const char *, void *);
 #endif /* KERNEL_PRIVATE */
+
 #define MAX_IPv4_STR_LEN       16
 #define MAX_IPv6_STR_LEN       64
 
-extern const char *inet_ntop(int, const void *, char *, socklen_t); /* in libkern */
+extern int      inet_aton(const char *, struct in_addr *); /* in libkern */
+extern const char *inet_ntop(int, const void *, char *, socklen_t); /* in libkern*/
 #endif /* KERNEL */
 
+#ifndef KERNEL
+#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
+__BEGIN_DECLS
+int        bindresvport(int, struct sockaddr_in *);
+struct sockaddr;
+int        bindresvport_sa(int, struct sockaddr *);
+__END_DECLS
+#endif
+#endif /* !KERNEL */
 #endif /* _NETINET_IN_H_ */