]> git.saurik.com Git - apple/xnu.git/blobdiff - bsd/netinet/in.h
xnu-1504.9.37.tar.gz
[apple/xnu.git] / bsd / netinet / in.h
index e62cdc73fa79885ec3e74711391693d7e6c78d2b..fc38f84015541afaaa41c810aa4585a6dcfaee08 100644 (file)
@@ -1,23 +1,29 @@
 /*
- * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
+ * Copyright (c) 2000-2008 Apple Inc. All rights reserved.
  *
- * @APPLE_LICENSE_HEADER_START@
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
  * 
- * The contents of this file constitute Original Code as defined in and
- * are subject to the Apple Public Source License Version 1.1 (the
- * "License").  You may not use this file except in compliance with the
- * License.  Please obtain a copy of the License at
- * http://www.apple.com/publicsource and read it before using this file.
+ * This file contains Original Code and/or Modifications of Original Code
+ * as defined in and that are subject to the Apple Public Source License
+ * Version 2.0 (the 'License'). You may not use this file except in
+ * compliance with the License. The rights granted to you under the License
+ * may not be used to create, or enable the creation or redistribution of,
+ * unlawful or unlicensed copies of an Apple operating system, or to
+ * circumvent, violate, or enable the circumvention or violation of, any
+ * terms of an Apple operating system software license agreement.
  * 
- * This Original Code and all software distributed under the License are
- * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
+ * Please obtain a copy of the License at
+ * http://www.opensource.apple.com/apsl/ and read it before using this file.
+ * 
+ * The Original Code and all software distributed under the License are
+ * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
- * License for the specific language governing rights and limitations
- * under the License.
+ * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
+ * Please see the License for the specific language governing rights and
+ * limitations under the License.
  * 
- * @APPLE_LICENSE_HEADER_END@
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  */
 /*
  * Copyright (c) 1982, 1986, 1990, 1993
  * SUCH DAMAGE.
  *
  *     @(#)in.h        8.3 (Berkeley) 1/3/94
+ * $FreeBSD: src/sys/netinet/in.h,v 1.48.2.2 2001/04/21 14:53:06 ume Exp $
  */
 
 #ifndef _NETINET_IN_H_
 #define _NETINET_IN_H_
+#include <sys/appleapiopts.h>
+#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 */
+#endif
+
+#ifndef _IN_PORT_T
+#define _IN_PORT_T
+typedef        __uint16_t      in_port_t;
+#endif
+
+/*
+ * POSIX 1003.1-2003
+ * "Inclusion of the <netinet/in.h> header may also make visible all
+ *  symbols from <inttypes.h> and <sys/socket.h>".
+ */
+#include <sys/socket.h>
+
+/*
+ * The following two #includes insure htonl and family are defined
+ */
+#include <machine/endian.h>
+#include <sys/_endian.h>
 
 /*
  * Constants and structures defined by the internet system,
  * Protocols (RFC 1700)
  */
 #define        IPPROTO_IP              0               /* dummy for IP */
-#define        IPPROTO_HOPOPTS 0               /* IP6 hop-by-hop options */
+#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
+#define        IPPROTO_HOPOPTS 0               /* IP6 hop-by-hop options */
+#endif /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */
 #define        IPPROTO_ICMP            1               /* control message protocol */
+#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
 #define        IPPROTO_IGMP            2               /* group mgmt protocol */
 #define        IPPROTO_GGP             3               /* gateway^2 (deprecated) */
-#define        IPPROTO_IPIP            4               /* IP encapsulation in IP */
-#define        IPPROTO_IPV4            4               /* IP header */
+#define IPPROTO_IPV4           4               /* IPv4 encapsulation */
+#define IPPROTO_IPIP           IPPROTO_IPV4    /* for compatibility */
+#endif /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */
 #define        IPPROTO_TCP             6               /* tcp */
+#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
 #define        IPPROTO_ST              7               /* Stream protocol II */
 #define        IPPROTO_EGP             8               /* exterior gateway protocol */
 #define        IPPROTO_PIGP            9               /* private interior gateway */
 #define        IPPROTO_EMCON           14              /* EMCON */
 #define        IPPROTO_XNET            15              /* Cross Net Debugger */
 #define        IPPROTO_CHAOS           16              /* Chaos*/
+#endif /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */
 #define        IPPROTO_UDP             17              /* user datagram protocol */
+#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
 #define        IPPROTO_MUX             18              /* Multiplexing */
 #define        IPPROTO_MEAS            19              /* DCN Measurement Subsystems */
 #define        IPPROTO_HMP             20              /* Host Monitoring */
 #define        IPPROTO_CMTP            38              /* Control Message Transport */
 #define        IPPROTO_TPXX            39              /* TP++ Transport */
 #define        IPPROTO_IL              40              /* IL transport protocol */
+#endif /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */
 #define        IPPROTO_IPV6            41              /* IP6 header */
+#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
 #define        IPPROTO_SDRP            42              /* Source Demand Routing */
 #define        IPPROTO_ROUTING 43              /* IP6 routing header */
 #define        IPPROTO_FRAGMENT        44              /* IP6 fragmentation header */
 #define        IPPROTO_GRE             47              /* General Routing Encap. */
 #define        IPPROTO_MHRP            48              /* Mobile Host Routing */
 #define        IPPROTO_BHA             49              /* BHA */
-#define        IPPROTO_ESP             50              /* SIPP Encap Sec. Payload */
-#define        IPPROTO_AH              51              /* SIPP Auth Header */
+#define        IPPROTO_ESP             50              /* IP6 Encap Sec. Payload */
+#define        IPPROTO_AH              51              /* IP6 Auth Header */
 #define        IPPROTO_INLSP           52              /* Integ. Net Layer Security */
 #define        IPPROTO_SWIPE           53              /* IP with encryption */
 #define        IPPROTO_NHRP            54              /* Next Hop Resolution */
 #define        IPPROTO_GMTP            100             /* GMTP*/
 #define        IPPROTO_IPCOMP  108             /* payload compression (IPComp) */
 /* 101-254: Partly Unassigned */
-#if defined(PM)
-#define        IPPROTO_PM              101             /* PM - Packet Management by SuMiRe */
-#endif
-#define        IPPROTO_PIM             103             /* Protocol Independent Mcast */
+#define        IPPROTO_PIM             103             /* Protocol Independent Mcast */
 #define        IPPROTO_PGM             113             /* PGM */
 /* 255: Reserved */
 /* BSD Private, local use, namespace incursion */
 #define        IPPROTO_DIVERT          254             /* divert pseudo-protocol */
+#endif /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */
 #define        IPPROTO_RAW             255             /* raw IP packet */
+
+#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
 #define        IPPROTO_MAX             256
 
 /* last return value of *_input(), meaning "all job for this pkt is done".  */
 #define        IPPROTO_DONE            257
+#endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */
 
 /*
  * Local port number conventions:
  *
  */
 
+#define        __DARWIN_IPPORT_RESERVED        1024
+
+#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
 /*
  * Ports < IPPORT_RESERVED are reserved for
  * privileged processes (e.g. root).         (IP_PORTRANGE_LOW)
  * Ports > IPPORT_USERRESERVED are reserved
  * for servers, not necessarily privileged.  (IP_PORTRANGE_DEFAULT)
  */
-#define        IPPORT_RESERVED         1024
+#ifndef IPPORT_RESERVED
+#define        IPPORT_RESERVED         __DARWIN_IPPORT_RESERVED
+#endif
 #define        IPPORT_USERRESERVED     5000
 
 /*
  * have a fit if we use.
  */
 #define IPPORT_RESERVEDSTART   600
+#endif /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */
 
 /*
  * Internet address (a structure for historical reasons)
  */
 struct in_addr {
-       u_int32_t s_addr;
+       in_addr_t s_addr;
 };
 
 /*
@@ -261,6 +310,10 @@ struct in_addr {
  * On subnets, the decomposition of addresses to host and net parts
  * is done according to subnet mask, not the masks here.
  */
+#define        INADDR_ANY              (u_int32_t)0x00000000
+#define        INADDR_BROADCAST        (u_int32_t)0xffffffff   /* must be masked */
+
+#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
 #define        IN_CLASSA(i)            (((u_int32_t)(i) & 0x80000000) == 0)
 #define        IN_CLASSA_NET           0xff000000
 #define        IN_CLASSA_NSHIFT        24
@@ -287,9 +340,7 @@ struct in_addr {
 #define        IN_EXPERIMENTAL(i)      (((u_int32_t)(i) & 0xf0000000) == 0xf0000000)
 #define        IN_BADCLASS(i)          (((u_int32_t)(i) & 0xf0000000) == 0xf0000000)
 
-#define        INADDR_ANY              (u_int32_t)0x00000000
 #define        INADDR_LOOPBACK         (u_int32_t)0x7f000001
-#define        INADDR_BROADCAST        (u_int32_t)0xffffffff   /* must be masked */
 #ifndef KERNEL
 #define        INADDR_NONE             0xffffffff              /* -1 return */
 #endif
@@ -299,21 +350,28 @@ struct in_addr {
 #define        INADDR_ALLRTRS_GROUP    (u_int32_t)0xe0000002   /* 224.0.0.2 */
 #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)
+#endif
+
 #define        IN_LOOPBACKNET          127                     /* official! */
+#endif /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */
 
 /*
  * Socket address, internet style.
  */
 struct sockaddr_in {
-       u_char  sin_len;
-       u_char  sin_family;
-       u_short sin_port;
+       __uint8_t       sin_len;
+       sa_family_t     sin_family;
+       in_port_t       sin_port;
        struct  in_addr sin_addr;
-       char    sin_zero[8];
+       char            sin_zero[8];
 };
 
 #define INET_ADDRSTRLEN                 16
 
+#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
 /*
  * Structure used to describe IP options.
  * Used to store options internally, to pass them to a process,
@@ -349,25 +407,51 @@ struct ip_opts {
 #define IP_RSVP_VIF_ON         17   /* set RSVP per-vif socket */
 #define IP_RSVP_VIF_OFF                18   /* unset RSVP per-vif socket */
 #define IP_PORTRANGE           19   /* int; range to choose for unspec port */
-#define IP_RECVIF              20   /* bool; receive reception if w/dgram */
-#define IP_IPSEC_POLICY                21   /* int; set/get security policy */
-#define IP_FAITH               22   /* bool; accept FAITH'ed connections */
+#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 */
+#ifdef __APPLE__
 #define IP_STRIPHDR            23   /* bool: drop receive of raw IP header */
-
-
-#define IP_FW_ADD              50   /* add a firewall rule to chain */
-#define IP_FW_DEL              51   /* delete a firewall rule from chain */
-#define IP_FW_FLUSH            52   /* flush firewall rule chain */
-#define IP_FW_ZERO             53   /* clear single/all firewall counter(s) */
-#define IP_FW_GET              54   /* get entire firewall rule chain */
-#define IP_NAT                 55   /* set/get NAT opts */
-#define IP_FW_RESETLOG         56   /* reset logging counters */
+#endif
+#define IP_RECVTTL             24   /* bool; receive reception TTL w/dgram */
+#define        IP_BOUND_IF             25   /* set/get bound interface */
+
+
+#define        IP_FW_ADD               40   /* add a firewall rule to chain */
+#define        IP_FW_DEL               41   /* delete a firewall rule from chain */
+#define        IP_FW_FLUSH             42   /* flush firewall rule chain */
+#define        IP_FW_ZERO              43   /* clear single/all firewall counter(s) */
+#define        IP_FW_GET               44   /* get entire firewall rule chain */
+#define        IP_FW_RESETLOG          45   /* reset logging counters */
+
+/* These older firewall socket option codes are maintained for backward compatibility. */
+#define        IP_OLD_FW_ADD           50   /* add a firewall rule to chain */
+#define        IP_OLD_FW_DEL           51   /* delete a firewall rule from chain */
+#define        IP_OLD_FW_FLUSH         52   /* flush firewall rule chain */
+#define        IP_OLD_FW_ZERO          53   /* clear single/all firewall counter(s) */
+#define        IP_OLD_FW_GET           54   /* get entire firewall rule chain */
+#define IP_NAT__XXX                    55   /* set/get NAT opts XXX Deprecated, do not use */
+#define        IP_OLD_FW_RESETLOG      56   /* reset logging counters */
 
 #define        IP_DUMMYNET_CONFIGURE   60   /* add/configure a dummynet pipe */
 #define        IP_DUMMYNET_DEL         61   /* delete a dummynet pipe from chain */
 #define        IP_DUMMYNET_FLUSH       62   /* flush dummynet */
 #define        IP_DUMMYNET_GET         64   /* get entire dummynet pipes */
 
+#define        IP_TRAFFIC_MGT_BACKGROUND       65   /* int*; get background IO flags; set background IO */
+
+#ifdef PRIVATE
+#define        IP_FORCE_OUT_IFP        69   /* deprecated; use IP_BOUND_IF instead */
+#endif
+
+/* Background socket configuration flags */
+#ifdef __APPLE_API_UNSTABLE
+#define TRAFFIC_MGT_SO_BACKGROUND      0x0001  /* background socket */
+#define TRAFFIC_MGT_SO_BG_SUPPRESSED   0x0002  /* currently throttled */
+#define TRAFFIC_MGT_SO_BG_REGULATE     0x0004  /* traffic is regulated */
+#endif /* __APPLE_API_UNSTABLE */
+
 /*
  * Defaults and limits for options
  */
@@ -391,13 +475,16 @@ struct ip_mreq {
 #define        IP_PORTRANGE_HIGH       1       /* "high" - request firewall bypass */
 #define        IP_PORTRANGE_LOW        2       /* "low" - vouchsafe security */
 
+
 /*
  * Definitions for inet sysctl operations.
  *
  * Third level is protocol number.
  * Fourth level is desired variable within that protocol.
  */
-#define        IPPROTO_MAXID   (IPPROTO_ESP + 1)       /* don't list to IPPROTO_MAX */
+#define        IPPROTO_MAXID   (IPPROTO_AH + 1)        /* don't list to IPPROTO_MAX */
+
+#ifdef KERNEL_PRIVATE
 
 #define        CTL_IPPROTO_NAMES { \
        { "ip", CTLTYPE_NODE }, \
@@ -454,6 +541,8 @@ struct ip_mreq {
        { "ipsec", CTLTYPE_NODE }, \
 }
 
+#endif /* KERNEL_PRIVATE */
+
 /*
  * Names for IP sysctl objects
  */
@@ -469,14 +558,16 @@ struct ip_mreq {
 #define        IPCTL_SOURCEROUTE       8       /* may perform source routes */
 #define        IPCTL_DIRECTEDBROADCAST 9       /* may re-broadcast received packets */
 #define IPCTL_INTRQMAXLEN      10      /* max length of netisr queue */
-#define IPCTL_INTRQDROPS       11      /* number of netisr q drops */
+#define        IPCTL_INTRQDROPS        11      /* number of netisr q drops */
 #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
-#define IPCTL_GIF_TTL          16      /* default TTL for gif encap packet */
+#define        IPCTL_FASTFORWARDING    14      /* use fast IP forwarding code */
+#define        IPCTL_KEEPFAITH         15      /* FAITH IPv4->IPv6 translater ctl */
+#define        IPCTL_GIF_TTL           16      /* default TTL for gif encap packet */
 #define        IPCTL_MAXID             17
 
+#ifdef KERNEL_PRIVATE
+
 #define        IPCTL_NAMES { \
        { 0, 0 }, \
        { "forwarding", CTLTYPE_INT }, \
@@ -496,6 +587,10 @@ struct ip_mreq {
        { "keepfaith", CTLTYPE_INT }, \
        { "gifttl", CTLTYPE_INT }, \
 }
+#endif /* KERNEL_PRIVATE */
+
+#endif /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */
+
 
 /* INET6 stuff */
 #define __KAME_NETINET_IN_H_INCLUDED_
@@ -503,14 +598,39 @@ struct ip_mreq {
 #undef __KAME_NETINET_IN_H_INCLUDED_
 
 #ifdef KERNEL
+#ifdef KERNEL_PRIVATE
 struct ifnet; struct mbuf;     /* forward declarations for Standard C */
 
-int     in_broadcast __P((struct in_addr, struct ifnet *));
-int     in_canforward __P((struct in_addr));
-int     in_cksum __P((struct mbuf *, int));
-int     in_localaddr __P((struct in_addr));
-char   *inet_ntoa __P((struct in_addr)); /* in libkern */
-u_long in_netof __P((struct in_addr));
+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))
+
+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);
+
+extern int in_localaddr(struct in_addr);
+extern u_int32_t in_netof(struct in_addr);
+
+extern int inaddr_local(struct in_addr);
+#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 */
 #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
+
+#endif /* _NETINET_IN_H_ */