NetServices Stack source
Dependents: HelloWorld ServoInterfaceBoardExample1 4180_Lab4
lwip/core/ipv4/ip_addr.c@0:632c9925f013, 2010-06-11 (annotated)
- Committer:
- donatien
- Date:
- Fri Jun 11 16:05:15 2010 +0000
- Revision:
- 0:632c9925f013
- Child:
- 5:dd63a1e02b1b
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
donatien | 0:632c9925f013 | 1 | /** |
donatien | 0:632c9925f013 | 2 | * @file |
donatien | 0:632c9925f013 | 3 | * This is the IPv4 address tools implementation. |
donatien | 0:632c9925f013 | 4 | * |
donatien | 0:632c9925f013 | 5 | */ |
donatien | 0:632c9925f013 | 6 | |
donatien | 0:632c9925f013 | 7 | /* |
donatien | 0:632c9925f013 | 8 | * Copyright (c) 2001-2004 Swedish Institute of Computer Science. |
donatien | 0:632c9925f013 | 9 | * All rights reserved. |
donatien | 0:632c9925f013 | 10 | * |
donatien | 0:632c9925f013 | 11 | * Redistribution and use in source and binary forms, with or without modification, |
donatien | 0:632c9925f013 | 12 | * are permitted provided that the following conditions are met: |
donatien | 0:632c9925f013 | 13 | * |
donatien | 0:632c9925f013 | 14 | * 1. Redistributions of source code must retain the above copyright notice, |
donatien | 0:632c9925f013 | 15 | * this list of conditions and the following disclaimer. |
donatien | 0:632c9925f013 | 16 | * 2. Redistributions in binary form must reproduce the above copyright notice, |
donatien | 0:632c9925f013 | 17 | * this list of conditions and the following disclaimer in the documentation |
donatien | 0:632c9925f013 | 18 | * and/or other materials provided with the distribution. |
donatien | 0:632c9925f013 | 19 | * 3. The name of the author may not be used to endorse or promote products |
donatien | 0:632c9925f013 | 20 | * derived from this software without specific prior written permission. |
donatien | 0:632c9925f013 | 21 | * |
donatien | 0:632c9925f013 | 22 | * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED |
donatien | 0:632c9925f013 | 23 | * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF |
donatien | 0:632c9925f013 | 24 | * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT |
donatien | 0:632c9925f013 | 25 | * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, |
donatien | 0:632c9925f013 | 26 | * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT |
donatien | 0:632c9925f013 | 27 | * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
donatien | 0:632c9925f013 | 28 | * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
donatien | 0:632c9925f013 | 29 | * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING |
donatien | 0:632c9925f013 | 30 | * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY |
donatien | 0:632c9925f013 | 31 | * OF SUCH DAMAGE. |
donatien | 0:632c9925f013 | 32 | * |
donatien | 0:632c9925f013 | 33 | * This file is part of the lwIP TCP/IP stack. |
donatien | 0:632c9925f013 | 34 | * |
donatien | 0:632c9925f013 | 35 | * Author: Adam Dunkels <adam@sics.se> |
donatien | 0:632c9925f013 | 36 | * |
donatien | 0:632c9925f013 | 37 | */ |
donatien | 0:632c9925f013 | 38 | |
donatien | 0:632c9925f013 | 39 | #include "lwip/opt.h" |
donatien | 0:632c9925f013 | 40 | #include "lwip/ip_addr.h" |
donatien | 0:632c9925f013 | 41 | #include "lwip/netif.h" |
donatien | 0:632c9925f013 | 42 | |
donatien | 0:632c9925f013 | 43 | /* used by IP_ADDR_ANY and IP_ADDR_BROADCAST in ip_addr.h */ |
donatien | 0:632c9925f013 | 44 | const ip_addr_t ip_addr_any = { IPADDR_ANY }; |
donatien | 0:632c9925f013 | 45 | const ip_addr_t ip_addr_broadcast = { IPADDR_BROADCAST }; |
donatien | 0:632c9925f013 | 46 | |
donatien | 0:632c9925f013 | 47 | /** |
donatien | 0:632c9925f013 | 48 | * Determine if an address is a broadcast address on a network interface |
donatien | 0:632c9925f013 | 49 | * |
donatien | 0:632c9925f013 | 50 | * @param addr address to be checked |
donatien | 0:632c9925f013 | 51 | * @param netif the network interface against which the address is checked |
donatien | 0:632c9925f013 | 52 | * @return returns non-zero if the address is a broadcast address |
donatien | 0:632c9925f013 | 53 | */ |
donatien | 0:632c9925f013 | 54 | u8_t ip_addr_isbroadcast(ip_addr_t *addr, struct netif *netif) |
donatien | 0:632c9925f013 | 55 | { |
donatien | 0:632c9925f013 | 56 | u32_t addr2test; |
donatien | 0:632c9925f013 | 57 | |
donatien | 0:632c9925f013 | 58 | addr2test = ip4_addr_get_u32(addr); |
donatien | 0:632c9925f013 | 59 | /* all ones (broadcast) or all zeroes (old skool broadcast) */ |
donatien | 0:632c9925f013 | 60 | if ((~addr2test == IPADDR_ANY) || |
donatien | 0:632c9925f013 | 61 | (addr2test == IPADDR_ANY)) |
donatien | 0:632c9925f013 | 62 | return 1; |
donatien | 0:632c9925f013 | 63 | /* no broadcast support on this network interface? */ |
donatien | 0:632c9925f013 | 64 | else if ((netif->flags & NETIF_FLAG_BROADCAST) == 0) |
donatien | 0:632c9925f013 | 65 | /* the given address cannot be a broadcast address |
donatien | 0:632c9925f013 | 66 | * nor can we check against any broadcast addresses */ |
donatien | 0:632c9925f013 | 67 | return 0; |
donatien | 0:632c9925f013 | 68 | /* address matches network interface address exactly? => no broadcast */ |
donatien | 0:632c9925f013 | 69 | else if (addr2test == ip4_addr_get_u32(&netif->ip_addr)) |
donatien | 0:632c9925f013 | 70 | return 0; |
donatien | 0:632c9925f013 | 71 | /* on the same (sub) network... */ |
donatien | 0:632c9925f013 | 72 | else if (ip_addr_netcmp(addr, &(netif->ip_addr), &(netif->netmask)) |
donatien | 0:632c9925f013 | 73 | /* ...and host identifier bits are all ones? =>... */ |
donatien | 0:632c9925f013 | 74 | && ((addr2test & ~ip4_addr_get_u32(&netif->netmask)) == |
donatien | 0:632c9925f013 | 75 | (IPADDR_BROADCAST & ~ip4_addr_get_u32(&netif->netmask)))) |
donatien | 0:632c9925f013 | 76 | /* => network broadcast address */ |
donatien | 0:632c9925f013 | 77 | return 1; |
donatien | 0:632c9925f013 | 78 | else |
donatien | 0:632c9925f013 | 79 | return 0; |
donatien | 0:632c9925f013 | 80 | } |
donatien | 0:632c9925f013 | 81 | |
donatien | 0:632c9925f013 | 82 | /* Here for now until needed in other places in lwIP */ |
donatien | 0:632c9925f013 | 83 | #ifndef isprint |
donatien | 0:632c9925f013 | 84 | #define in_range(c, lo, up) ((u8_t)c >= lo && (u8_t)c <= up) |
donatien | 0:632c9925f013 | 85 | #define isprint(c) in_range(c, 0x20, 0x7f) |
donatien | 0:632c9925f013 | 86 | #define isdigit(c) in_range(c, '0', '9') |
donatien | 0:632c9925f013 | 87 | #define isxdigit(c) (isdigit(c) || in_range(c, 'a', 'f') || in_range(c, 'A', 'F')) |
donatien | 0:632c9925f013 | 88 | #define islower(c) in_range(c, 'a', 'z') |
donatien | 0:632c9925f013 | 89 | #define isspace(c) (c == ' ' || c == '\f' || c == '\n' || c == '\r' || c == '\t' || c == '\v') |
donatien | 0:632c9925f013 | 90 | #endif |
donatien | 0:632c9925f013 | 91 | |
donatien | 0:632c9925f013 | 92 | /** |
donatien | 0:632c9925f013 | 93 | * Ascii internet address interpretation routine. |
donatien | 0:632c9925f013 | 94 | * The value returned is in network order. |
donatien | 0:632c9925f013 | 95 | * |
donatien | 0:632c9925f013 | 96 | * @param cp IP address in ascii represenation (e.g. "127.0.0.1") |
donatien | 0:632c9925f013 | 97 | * @return ip address in network order |
donatien | 0:632c9925f013 | 98 | */ |
donatien | 0:632c9925f013 | 99 | u32_t |
donatien | 0:632c9925f013 | 100 | ipaddr_addr(const char *cp) |
donatien | 0:632c9925f013 | 101 | { |
donatien | 0:632c9925f013 | 102 | ip_addr_t val; |
donatien | 0:632c9925f013 | 103 | |
donatien | 0:632c9925f013 | 104 | if (ipaddr_aton(cp, &val)) { |
donatien | 0:632c9925f013 | 105 | return ip4_addr_get_u32(&val); |
donatien | 0:632c9925f013 | 106 | } |
donatien | 0:632c9925f013 | 107 | return (IPADDR_NONE); |
donatien | 0:632c9925f013 | 108 | } |
donatien | 0:632c9925f013 | 109 | |
donatien | 0:632c9925f013 | 110 | /** |
donatien | 0:632c9925f013 | 111 | * Check whether "cp" is a valid ascii representation |
donatien | 0:632c9925f013 | 112 | * of an Internet address and convert to a binary address. |
donatien | 0:632c9925f013 | 113 | * Returns 1 if the address is valid, 0 if not. |
donatien | 0:632c9925f013 | 114 | * This replaces inet_addr, the return value from which |
donatien | 0:632c9925f013 | 115 | * cannot distinguish between failure and a local broadcast address. |
donatien | 0:632c9925f013 | 116 | * |
donatien | 0:632c9925f013 | 117 | * @param cp IP address in ascii represenation (e.g. "127.0.0.1") |
donatien | 0:632c9925f013 | 118 | * @param addr pointer to which to save the ip address in network order |
donatien | 0:632c9925f013 | 119 | * @return 1 if cp could be converted to addr, 0 on failure |
donatien | 0:632c9925f013 | 120 | */ |
donatien | 0:632c9925f013 | 121 | int |
donatien | 0:632c9925f013 | 122 | ipaddr_aton(const char *cp, ip_addr_t *addr) |
donatien | 0:632c9925f013 | 123 | { |
donatien | 0:632c9925f013 | 124 | u32_t val; |
donatien | 0:632c9925f013 | 125 | u8_t base; |
donatien | 0:632c9925f013 | 126 | char c; |
donatien | 0:632c9925f013 | 127 | u32_t parts[4]; |
donatien | 0:632c9925f013 | 128 | u32_t *pp = parts; |
donatien | 0:632c9925f013 | 129 | |
donatien | 0:632c9925f013 | 130 | c = *cp; |
donatien | 0:632c9925f013 | 131 | for (;;) { |
donatien | 0:632c9925f013 | 132 | /* |
donatien | 0:632c9925f013 | 133 | * Collect number up to ``.''. |
donatien | 0:632c9925f013 | 134 | * Values are specified as for C: |
donatien | 0:632c9925f013 | 135 | * 0x=hex, 0=octal, 1-9=decimal. |
donatien | 0:632c9925f013 | 136 | */ |
donatien | 0:632c9925f013 | 137 | if (!isdigit(c)) |
donatien | 0:632c9925f013 | 138 | return (0); |
donatien | 0:632c9925f013 | 139 | val = 0; |
donatien | 0:632c9925f013 | 140 | base = 10; |
donatien | 0:632c9925f013 | 141 | if (c == '0') { |
donatien | 0:632c9925f013 | 142 | c = *++cp; |
donatien | 0:632c9925f013 | 143 | if (c == 'x' || c == 'X') { |
donatien | 0:632c9925f013 | 144 | base = 16; |
donatien | 0:632c9925f013 | 145 | c = *++cp; |
donatien | 0:632c9925f013 | 146 | } else |
donatien | 0:632c9925f013 | 147 | base = 8; |
donatien | 0:632c9925f013 | 148 | } |
donatien | 0:632c9925f013 | 149 | for (;;) { |
donatien | 0:632c9925f013 | 150 | if (isdigit(c)) { |
donatien | 0:632c9925f013 | 151 | val = (val * base) + (int)(c - '0'); |
donatien | 0:632c9925f013 | 152 | c = *++cp; |
donatien | 0:632c9925f013 | 153 | } else if (base == 16 && isxdigit(c)) { |
donatien | 0:632c9925f013 | 154 | val = (val << 4) | (int)(c + 10 - (islower(c) ? 'a' : 'A')); |
donatien | 0:632c9925f013 | 155 | c = *++cp; |
donatien | 0:632c9925f013 | 156 | } else |
donatien | 0:632c9925f013 | 157 | break; |
donatien | 0:632c9925f013 | 158 | } |
donatien | 0:632c9925f013 | 159 | if (c == '.') { |
donatien | 0:632c9925f013 | 160 | /* |
donatien | 0:632c9925f013 | 161 | * Internet format: |
donatien | 0:632c9925f013 | 162 | * a.b.c.d |
donatien | 0:632c9925f013 | 163 | * a.b.c (with c treated as 16 bits) |
donatien | 0:632c9925f013 | 164 | * a.b (with b treated as 24 bits) |
donatien | 0:632c9925f013 | 165 | */ |
donatien | 0:632c9925f013 | 166 | if (pp >= parts + 3) |
donatien | 0:632c9925f013 | 167 | return (0); |
donatien | 0:632c9925f013 | 168 | *pp++ = val; |
donatien | 0:632c9925f013 | 169 | c = *++cp; |
donatien | 0:632c9925f013 | 170 | } else |
donatien | 0:632c9925f013 | 171 | break; |
donatien | 0:632c9925f013 | 172 | } |
donatien | 0:632c9925f013 | 173 | /* |
donatien | 0:632c9925f013 | 174 | * Check for trailing characters. |
donatien | 0:632c9925f013 | 175 | */ |
donatien | 0:632c9925f013 | 176 | if (c != '\0' && !isspace(c)) |
donatien | 0:632c9925f013 | 177 | return (0); |
donatien | 0:632c9925f013 | 178 | /* |
donatien | 0:632c9925f013 | 179 | * Concoct the address according to |
donatien | 0:632c9925f013 | 180 | * the number of parts specified. |
donatien | 0:632c9925f013 | 181 | */ |
donatien | 0:632c9925f013 | 182 | switch (pp - parts + 1) { |
donatien | 0:632c9925f013 | 183 | |
donatien | 0:632c9925f013 | 184 | case 0: |
donatien | 0:632c9925f013 | 185 | return (0); /* initial nondigit */ |
donatien | 0:632c9925f013 | 186 | |
donatien | 0:632c9925f013 | 187 | case 1: /* a -- 32 bits */ |
donatien | 0:632c9925f013 | 188 | break; |
donatien | 0:632c9925f013 | 189 | |
donatien | 0:632c9925f013 | 190 | case 2: /* a.b -- 8.24 bits */ |
donatien | 0:632c9925f013 | 191 | if (val > 0xffffffUL) |
donatien | 0:632c9925f013 | 192 | return (0); |
donatien | 0:632c9925f013 | 193 | val |= parts[0] << 24; |
donatien | 0:632c9925f013 | 194 | break; |
donatien | 0:632c9925f013 | 195 | |
donatien | 0:632c9925f013 | 196 | case 3: /* a.b.c -- 8.8.16 bits */ |
donatien | 0:632c9925f013 | 197 | if (val > 0xffff) |
donatien | 0:632c9925f013 | 198 | return (0); |
donatien | 0:632c9925f013 | 199 | val |= (parts[0] << 24) | (parts[1] << 16); |
donatien | 0:632c9925f013 | 200 | break; |
donatien | 0:632c9925f013 | 201 | |
donatien | 0:632c9925f013 | 202 | case 4: /* a.b.c.d -- 8.8.8.8 bits */ |
donatien | 0:632c9925f013 | 203 | if (val > 0xff) |
donatien | 0:632c9925f013 | 204 | return (0); |
donatien | 0:632c9925f013 | 205 | val |= (parts[0] << 24) | (parts[1] << 16) | (parts[2] << 8); |
donatien | 0:632c9925f013 | 206 | break; |
donatien | 0:632c9925f013 | 207 | } |
donatien | 0:632c9925f013 | 208 | if (addr) { |
donatien | 0:632c9925f013 | 209 | ip4_addr_set_u32(addr, htonl(val)); |
donatien | 0:632c9925f013 | 210 | } |
donatien | 0:632c9925f013 | 211 | return (1); |
donatien | 0:632c9925f013 | 212 | } |
donatien | 0:632c9925f013 | 213 | |
donatien | 0:632c9925f013 | 214 | /** |
donatien | 0:632c9925f013 | 215 | * Convert numeric IP address into decimal dotted ASCII representation. |
donatien | 0:632c9925f013 | 216 | * returns ptr to static buffer; not reentrant! |
donatien | 0:632c9925f013 | 217 | * |
donatien | 0:632c9925f013 | 218 | * @param addr ip address in network order to convert |
donatien | 0:632c9925f013 | 219 | * @return pointer to a global static (!) buffer that holds the ASCII |
donatien | 0:632c9925f013 | 220 | * represenation of addr |
donatien | 0:632c9925f013 | 221 | */ |
donatien | 0:632c9925f013 | 222 | char * |
donatien | 0:632c9925f013 | 223 | ipaddr_ntoa(ip_addr_t *addr) |
donatien | 0:632c9925f013 | 224 | { |
donatien | 0:632c9925f013 | 225 | static char str[16]; |
donatien | 0:632c9925f013 | 226 | return ipaddr_ntoa_r(addr, str, 16); |
donatien | 0:632c9925f013 | 227 | } |
donatien | 0:632c9925f013 | 228 | |
donatien | 0:632c9925f013 | 229 | /** |
donatien | 0:632c9925f013 | 230 | * Same as ipaddr_ntoa, but reentrant since a user-supplied buffer is used. |
donatien | 0:632c9925f013 | 231 | * |
donatien | 0:632c9925f013 | 232 | * @param addr ip address in network order to convert |
donatien | 0:632c9925f013 | 233 | * @param buf target buffer where the string is stored |
donatien | 0:632c9925f013 | 234 | * @param buflen length of buf |
donatien | 0:632c9925f013 | 235 | * @return either pointer to buf which now holds the ASCII |
donatien | 0:632c9925f013 | 236 | * representation of addr or NULL if buf was too small |
donatien | 0:632c9925f013 | 237 | */ |
donatien | 0:632c9925f013 | 238 | char *ipaddr_ntoa_r(ip_addr_t *addr, char *buf, int buflen) |
donatien | 0:632c9925f013 | 239 | { |
donatien | 0:632c9925f013 | 240 | u32_t s_addr; |
donatien | 0:632c9925f013 | 241 | char inv[3]; |
donatien | 0:632c9925f013 | 242 | char *rp; |
donatien | 0:632c9925f013 | 243 | u8_t *ap; |
donatien | 0:632c9925f013 | 244 | u8_t rem; |
donatien | 0:632c9925f013 | 245 | u8_t n; |
donatien | 0:632c9925f013 | 246 | u8_t i; |
donatien | 0:632c9925f013 | 247 | int len = 0; |
donatien | 0:632c9925f013 | 248 | |
donatien | 0:632c9925f013 | 249 | s_addr = ip4_addr_get_u32(addr); |
donatien | 0:632c9925f013 | 250 | |
donatien | 0:632c9925f013 | 251 | rp = buf; |
donatien | 0:632c9925f013 | 252 | ap = (u8_t *)&s_addr; |
donatien | 0:632c9925f013 | 253 | for(n = 0; n < 4; n++) { |
donatien | 0:632c9925f013 | 254 | i = 0; |
donatien | 0:632c9925f013 | 255 | do { |
donatien | 0:632c9925f013 | 256 | rem = *ap % (u8_t)10; |
donatien | 0:632c9925f013 | 257 | *ap /= (u8_t)10; |
donatien | 0:632c9925f013 | 258 | inv[i++] = '0' + rem; |
donatien | 0:632c9925f013 | 259 | } while(*ap); |
donatien | 0:632c9925f013 | 260 | while(i--) { |
donatien | 0:632c9925f013 | 261 | if (len++ >= buflen) { |
donatien | 0:632c9925f013 | 262 | return NULL; |
donatien | 0:632c9925f013 | 263 | } |
donatien | 0:632c9925f013 | 264 | *rp++ = inv[i]; |
donatien | 0:632c9925f013 | 265 | } |
donatien | 0:632c9925f013 | 266 | if (len++ >= buflen) { |
donatien | 0:632c9925f013 | 267 | return NULL; |
donatien | 0:632c9925f013 | 268 | } |
donatien | 0:632c9925f013 | 269 | *rp++ = '.'; |
donatien | 0:632c9925f013 | 270 | ap++; |
donatien | 0:632c9925f013 | 271 | } |
donatien | 0:632c9925f013 | 272 | *--rp = 0; |
donatien | 0:632c9925f013 | 273 | return buf; |
donatien | 0:632c9925f013 | 274 | } |