1 /**
2  * @file
3  * This file (together with sockets.h) aims to provide structs and functions from
4  * - arpa/inet.h
5  * - netinet/in.h
6  *
7  */
8 
9 /*
10  * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
11  * All rights reserved.
12  *
13  * Redistribution and use in source and binary forms, with or without modification,
14  * are permitted provided that the following conditions are met:
15  *
16  * 1. Redistributions of source code must retain the above copyright notice,
17  *    this list of conditions and the following disclaimer.
18  * 2. Redistributions in binary form must reproduce the above copyright notice,
19  *    this list of conditions and the following disclaimer in the documentation
20  *    and/or other materials provided with the distribution.
21  * 3. The name of the author may not be used to endorse or promote products
22  *    derived from this software without specific prior written permission.
23  *
24  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
25  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
26  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
27  * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
28  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
29  * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
30  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
31  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
32  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
33  * OF SUCH DAMAGE.
34  *
35  * This file is part of the lwIP TCP/IP stack.
36  *
37  * Author: Adam Dunkels <adam@sics.se>
38  *
39  */
40 #ifndef LWIP_HDR_INET_H
41 #define LWIP_HDR_INET_H
42 
43 #include "lwip/opt.h"
44 
45 #if LWIP_SOCKET_EXTERNAL_HEADERS
46 #include LWIP_SOCKET_EXTERNAL_HEADER_INET_H
47 #else /* LWIP_SOCKET_EXTERNAL_HEADERS */
48 
49 #include "lwip/def.h"
50 #include "lwip/ip_addr.h"
51 #include "lwip/ip6_addr.h"
52 
53 #ifdef __cplusplus
54 extern "C" {
55 #endif
56 
57 /* If your port already typedef's in_addr_t, define IN_ADDR_T_DEFINED
58    to prevent this code from redefining it. */
59 #if !defined(in_addr_t) && !defined(IN_ADDR_T_DEFINED)
60 typedef u32_t in_addr_t;
61 #endif
62 
63 struct in_addr {
64   in_addr_t s_addr;
65 };
66 
67 struct in6_addr {
68   union {
69     u32_t u32_addr[4];
70     u8_t  u8_addr[16];
71   } un;
72 #define s6_addr  un.u8_addr
73 };
74 
75 /** 255.255.255.255 */
76 #define INADDR_NONE         IPADDR_NONE
77 /** 127.0.0.1 */
78 #define INADDR_LOOPBACK     IPADDR_LOOPBACK
79 /** 0.0.0.0 */
80 #define INADDR_ANY          IPADDR_ANY
81 /** 255.255.255.255 */
82 #define INADDR_BROADCAST    IPADDR_BROADCAST
83 
84 /** This macro can be used to initialize a variable of type struct in6_addr
85     to the IPv6 wildcard address. */
86 #define IN6ADDR_ANY_INIT {{{0,0,0,0}}}
87 /** This macro can be used to initialize a variable of type struct in6_addr
88     to the IPv6 loopback address. */
89 #define IN6ADDR_LOOPBACK_INIT {{{0,0,0,PP_HTONL(1)}}}
90 /** This variable is initialized by the system to contain the wildcard IPv6 address. */
91 extern const struct in6_addr in6addr_any;
92 
93 /* Definitions of the bits in an (IPv4) Internet address integer.
94 
95    On subnets, host and network parts are found according to
96    the subnet mask, not these masks.  */
97 #define IN_CLASSA(a)        IP_CLASSA(a)
98 #define IN_CLASSA_NET       IP_CLASSA_NET
99 #define IN_CLASSA_NSHIFT    IP_CLASSA_NSHIFT
100 #define IN_CLASSA_HOST      IP_CLASSA_HOST
101 #define IN_CLASSA_MAX       IP_CLASSA_MAX
102 
103 #define IN_CLASSB(b)        IP_CLASSB(b)
104 #define IN_CLASSB_NET       IP_CLASSB_NET
105 #define IN_CLASSB_NSHIFT    IP_CLASSB_NSHIFT
106 #define IN_CLASSB_HOST      IP_CLASSB_HOST
107 #define IN_CLASSB_MAX       IP_CLASSB_MAX
108 
109 #define IN_CLASSC(c)        IP_CLASSC(c)
110 #define IN_CLASSC_NET       IP_CLASSC_NET
111 #define IN_CLASSC_NSHIFT    IP_CLASSC_NSHIFT
112 #define IN_CLASSC_HOST      IP_CLASSC_HOST
113 #define IN_CLASSC_MAX       IP_CLASSC_MAX
114 
115 #define IN_CLASSD(d)        IP_CLASSD(d)
116 #define IN_CLASSD_NET       IP_CLASSD_NET     /* These ones aren't really */
117 #define IN_CLASSD_NSHIFT    IP_CLASSD_NSHIFT  /*   net and host fields, but */
118 #define IN_CLASSD_HOST      IP_CLASSD_HOST    /*   routing needn't know. */
119 #define IN_CLASSD_MAX       IP_CLASSD_MAX
120 
121 #define IN_MULTICAST(a)     IP_MULTICAST(a)
122 
123 #define IN_EXPERIMENTAL(a)  IP_EXPERIMENTAL(a)
124 #define IN_BADCLASS(a)      IP_BADCLASS(a)
125 
126 #define IN_LOOPBACKNET      IP_LOOPBACKNET
127 
128 #define IN6_IS_ADDR_UNSPECIFIED(a)  ip6_addr_isany((ip6_addr_t*)(a))
129 #define IN6_IS_ADDR_LOOPBACK(a)     ip6_addr_isloopback((ip6_addr_t*)(a))
130 #define IN6_IS_ADDR_MULTICAST(a)    ip6_addr_ismulticast((ip6_addr_t*)(a))
131 #define IN6_IS_ADDR_LINKLOCAL(a)    ip6_addr_islinklocal((ip6_addr_t*)(a))
132 #define IN6_IS_ADDR_SITELOCAL(a)    ip6_addr_issitelocal((ip6_addr_t*)(a))
133 #define IN6_IS_ADDR_V4MAPPED(a)     ip6_addr_isipv4mappedipv6((ip6_addr_t*)(a))
134 #define IN6_IS_ADDR_V4COMPAT(a)     ip6_addr_isipv4compat((ip6_addr_t*)(a))
135 #define IN6_IS_ADDR_MC_NODELOCAL(a) ip6_addr_ismulticast_iflocal((ip6_addr_t*)(a))
136 #define IN6_IS_ADDR_MC_LINKLOCAL(a) ip6_addr_ismulticast_linklocal((ip6_addr_t*)(a))
137 #define IN6_IS_ADDR_MC_SITELOCAL(a) ip6_addr_ismulticast_sitelocal((ip6_addr_t*)(a))
138 #define IN6_IS_ADDR_MC_ORGLOCAL(a)  ip6_addr_ismulticast_orglocal((ip6_addr_t*)(a))
139 #define IN6_IS_ADDR_MC_GLOBAL(a)    ip6_addr_ismulticast_global((ip6_addr_t*)(a))
140 
141 #ifndef INET_ADDRSTRLEN
142 #define INET_ADDRSTRLEN     IP4ADDR_STRLEN_MAX
143 #endif
144 #if LWIP_IPV6
145 #ifndef INET6_ADDRSTRLEN
146 #define INET6_ADDRSTRLEN    IP6ADDR_STRLEN_MAX
147 #endif
148 #endif
149 
150 #if LWIP_IPV4
151 
152 #define inet_addr_from_ip4addr(target_inaddr, source_ipaddr) ((target_inaddr)->s_addr = ip4_addr_get_u32(source_ipaddr))
153 #define inet_addr_to_ip4addr(target_ipaddr, source_inaddr)   (ip4_addr_set_u32(target_ipaddr, (source_inaddr)->s_addr))
154 
155 /* directly map this to the lwip internal functions */
156 #define inet_addr(cp)                   ipaddr_addr(cp)
157 #define inet_aton(cp, addr)             ip4addr_aton(cp, (ip4_addr_t*)addr)
158 #define inet_ntoa(addr)                 ip4addr_ntoa((const ip4_addr_t*)&(addr))
159 #define inet_ntoa_r(addr, buf, buflen)  ip4addr_ntoa_r((const ip4_addr_t*)&(addr), buf, buflen)
160 
161 #endif /* LWIP_IPV4 */
162 
163 #if LWIP_IPV6
164 #define inet6_addr_from_ip6addr(target_in6addr, source_ip6addr) {(target_in6addr)->un.u32_addr[0] = (source_ip6addr)->addr[0]; \
165                                                                  (target_in6addr)->un.u32_addr[1] = (source_ip6addr)->addr[1]; \
166                                                                  (target_in6addr)->un.u32_addr[2] = (source_ip6addr)->addr[2]; \
167                                                                  (target_in6addr)->un.u32_addr[3] = (source_ip6addr)->addr[3];}
168 #define inet6_addr_to_ip6addr(target_ip6addr, source_in6addr)   {(target_ip6addr)->addr[0] = (source_in6addr)->un.u32_addr[0]; \
169                                                                  (target_ip6addr)->addr[1] = (source_in6addr)->un.u32_addr[1]; \
170                                                                  (target_ip6addr)->addr[2] = (source_in6addr)->un.u32_addr[2]; \
171                                                                  (target_ip6addr)->addr[3] = (source_in6addr)->un.u32_addr[3]; \
172                                                                  ip6_addr_clear_zone(target_ip6addr);}
173 
174 /* directly map this to the lwip internal functions */
175 #define inet6_aton(cp, addr)            ip6addr_aton(cp, (ip6_addr_t*)addr)
176 #define inet6_ntoa(addr)                ip6addr_ntoa((const ip6_addr_t*)&(addr))
177 #define inet6_ntoa_r(addr, buf, buflen) ip6addr_ntoa_r((const ip6_addr_t*)&(addr), buf, buflen)
178 
179 #endif /* LWIP_IPV6 */
180 
181 
182 #ifdef __cplusplus
183 }
184 #endif
185 
186 #endif /* LWIP_SOCKET_EXTERNAL_HEADERS */
187 
188 #endif /* LWIP_HDR_INET_H */
189