ip_addr.h

00001 /*
00002  * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
00003  * All rights reserved.
00004  *
00005  * Redistribution and use in source and binary forms, with or without modification,
00006  * are permitted provided that the following conditions are met:
00007  *
00008  * 1. Redistributions of source code must retain the above copyright notice,
00009  *    this list of conditions and the following disclaimer.
00010  * 2. Redistributions in binary form must reproduce the above copyright notice,
00011  *    this list of conditions and the following disclaimer in the documentation
00012  *    and/or other materials provided with the distribution.
00013  * 3. The name of the author may not be used to endorse or promote products
00014  *    derived from this software without specific prior written permission.
00015  *
00016  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
00017  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
00018  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
00019  * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00020  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
00021  * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
00022  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
00023  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
00024  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
00025  * OF SUCH DAMAGE.
00026  *
00027  * This file is part of the lwIP TCP/IP stack.
00028  *
00029  * Author: Adam Dunkels <adam@sics.se>
00030  *
00031  */
00032 #ifndef __LWIP_IP_ADDR_H__
00033 #define __LWIP_IP_ADDR_H__
00034 
00035 #include "lwip/opt.h"
00036 
00037 #ifdef __cplusplus
00038 extern "C" {
00039 #endif
00040 
00041 #ifdef PACK_STRUCT_USE_INCLUDES
00042 #  include "arch/bpstruct.h"
00043 #endif
00044 PACK_STRUCT_BEGIN
00045 struct ip_addr {
00046   PACK_STRUCT_FIELD(u32_t addr);
00047 } PACK_STRUCT_STRUCT;
00048 PACK_STRUCT_END
00049 #ifdef PACK_STRUCT_USE_INCLUDES
00050 #  include "arch/epstruct.h"
00051 #endif
00052 
00053 
00054 /*
00055  * struct ipaddr2 is used in the definition of the ARP packet format in
00056  * order to support compilers that don't have structure packing.
00057  */
00058 #ifdef PACK_STRUCT_USE_INCLUDES
00059 #  include "arch/bpstruct.h"
00060 #endif
00061 PACK_STRUCT_BEGIN
00062 struct ip_addr2 {
00063   PACK_STRUCT_FIELD(u16_t addrw[2]);
00064 } PACK_STRUCT_STRUCT;
00065 PACK_STRUCT_END
00066 #ifdef PACK_STRUCT_USE_INCLUDES
00067 #  include "arch/epstruct.h"
00068 #endif
00069 
00070 /* For compatibility with BSD code */
00071 struct in_addr {
00072   u32_t s_addr;
00073 };
00074 
00075 struct netif;
00076 
00077 extern const struct ip_addr ip_addr_any;
00078 extern const struct ip_addr ip_addr_broadcast;
00079 
00080 /** IP_ADDR_ can be used as a fixed IP address
00081  *  for the wildcard and the broadcast address
00082  */
00083 #define IP_ADDR_ANY         ((struct ip_addr *)&ip_addr_any)
00084 #define IP_ADDR_BROADCAST   ((struct ip_addr *)&ip_addr_broadcast)
00085 
00086 #define INADDR_NONE         ((u32_t)0xffffffffUL)  /* 255.255.255.255 */
00087 #define INADDR_LOOPBACK     ((u32_t)0x7f000001UL)  /* 127.0.0.1 */
00088 
00089 /* Definitions of the bits in an Internet address integer.
00090 
00091    On subnets, host and network parts are found according to
00092    the subnet mask, not these masks.  */
00093 
00094 #define IN_CLASSA(a)        ((((u32_t)(a)) & 0x80000000UL) == 0)
00095 #define IN_CLASSA_NET       0xff000000
00096 #define IN_CLASSA_NSHIFT    24
00097 #define IN_CLASSA_HOST      (0xffffffff & ~IN_CLASSA_NET)
00098 #define IN_CLASSA_MAX       128
00099 
00100 #define IN_CLASSB(a)        ((((u32_t)(a)) & 0xc0000000UL) == 0x80000000UL)
00101 #define IN_CLASSB_NET       0xffff0000
00102 #define IN_CLASSB_NSHIFT    16
00103 #define IN_CLASSB_HOST      (0xffffffff & ~IN_CLASSB_NET)
00104 #define IN_CLASSB_MAX       65536
00105 
00106 #define IN_CLASSC(a)        ((((u32_t)(a)) & 0xe0000000UL) == 0xc0000000UL)
00107 #define IN_CLASSC_NET       0xffffff00
00108 #define IN_CLASSC_NSHIFT    8
00109 #define IN_CLASSC_HOST      (0xffffffff & ~IN_CLASSC_NET)
00110 
00111 #define IN_CLASSD(a)        (((u32_t)(a) & 0xf0000000UL) == 0xe0000000UL)
00112 #define IN_CLASSD_NET       0xf0000000          /* These ones aren't really */
00113 #define IN_CLASSD_NSHIFT    28                  /*   net and host fields, but */
00114 #define IN_CLASSD_HOST      0x0fffffff          /*   routing needn't know. */
00115 #define IN_MULTICAST(a)     IN_CLASSD(a)
00116 
00117 #define IN_EXPERIMENTAL(a)  (((u32_t)(a) & 0xf0000000UL) == 0xf0000000UL)
00118 #define IN_BADCLASS(a)      (((u32_t)(a) & 0xf0000000UL) == 0xf0000000UL)
00119 
00120 #define IN_LOOPBACKNET      127                 /* official! */
00121 
00122 #define IP4_ADDR(ipaddr, a,b,c,d) \
00123         (ipaddr)->addr = htonl(((u32_t)((a) & 0xff) << 24) | \
00124                                ((u32_t)((b) & 0xff) << 16) | \
00125                                ((u32_t)((c) & 0xff) << 8) | \
00126                                 (u32_t)((d) & 0xff))
00127 
00128 #define ip_addr_set(dest, src) (dest)->addr = \
00129                                ((src) == NULL? 0:\
00130                                (src)->addr)
00131 /**
00132  * Determine if two address are on the same network.
00133  *
00134  * @arg addr1 IP address 1
00135  * @arg addr2 IP address 2
00136  * @arg mask network identifier mask
00137  * @return !0 if the network identifiers of both address match
00138  */
00139 #define ip_addr_netcmp(addr1, addr2, mask) (((addr1)->addr & \
00140                                               (mask)->addr) == \
00141                                              ((addr2)->addr & \
00142                                               (mask)->addr))
00143 #define ip_addr_cmp(addr1, addr2) ((addr1)->addr == (addr2)->addr)
00144 
00145 #define ip_addr_isany(addr1) ((addr1) == NULL || (addr1)->addr == 0)
00146 
00147 u8_t ip_addr_isbroadcast(struct ip_addr *, struct netif *);
00148 
00149 #define ip_addr_ismulticast(addr1) (((addr1)->addr & ntohl(0xf0000000UL)) == ntohl(0xe0000000UL))
00150 
00151 #define ip_addr_islinklocal(addr1) (((addr1)->addr & ntohl(0xffff0000UL)) == ntohl(0xa9fe0000UL))
00152 
00153 #define ip_addr_debug_print(debug, ipaddr) \
00154         LWIP_DEBUGF(debug, ("%"U16_F".%"U16_F".%"U16_F".%"U16_F, \
00155                 ipaddr ? (u16_t)(ntohl((ipaddr)->addr) >> 24) & 0xff : 0, \
00156                 ipaddr ? (u16_t)(ntohl((ipaddr)->addr) >> 16) & 0xff : 0, \
00157                 ipaddr ? (u16_t)(ntohl((ipaddr)->addr) >> 8) & 0xff : 0, \
00158                 ipaddr ? (u16_t)ntohl((ipaddr)->addr) & 0xff : 0))
00159 
00160 /* These are cast to u16_t, with the intent that they are often arguments
00161  * to printf using the U16_F format from cc.h. */
00162 #define ip4_addr1(ipaddr) ((u16_t)(ntohl((ipaddr)->addr) >> 24) & 0xff)
00163 #define ip4_addr2(ipaddr) ((u16_t)(ntohl((ipaddr)->addr) >> 16) & 0xff)
00164 #define ip4_addr3(ipaddr) ((u16_t)(ntohl((ipaddr)->addr) >> 8) & 0xff)
00165 #define ip4_addr4(ipaddr) ((u16_t)(ntohl((ipaddr)->addr)) & 0xff)
00166 
00167 #ifdef __cplusplus
00168 }
00169 #endif
00170 
00171 #endif /* __LWIP_IP_ADDR_H__ */