Net - | Mbed

Users » mbed714 » Code » Net

lwip/include/ipv4/lwip/ip_addr.h@0:d616ece2d859, 2010-09-18 (annotated)

Committer:: mbed714
Date:: Sat Sep 18 23:05:49 2010 +0000
Revision:: 0:d616ece2d859

Who changed what in which revision?

User	Revision	Line number	New contents of line
mbed714	0:d616ece2d859	1	/*
mbed714	0:d616ece2d859	2	* Copyright (c) 2001-2004 Swedish Institute of Computer Science.
mbed714	0:d616ece2d859	3	* All rights reserved.
mbed714	0:d616ece2d859	4	*
mbed714	0:d616ece2d859	5	* Redistribution and use in source and binary forms, with or without modification,
mbed714	0:d616ece2d859	6	* are permitted provided that the following conditions are met:
mbed714	0:d616ece2d859	7	*
mbed714	0:d616ece2d859	8	* 1. Redistributions of source code must retain the above copyright notice,
mbed714	0:d616ece2d859	9	* this list of conditions and the following disclaimer.
mbed714	0:d616ece2d859	10	* 2. Redistributions in binary form must reproduce the above copyright notice,
mbed714	0:d616ece2d859	11	* this list of conditions and the following disclaimer in the documentation
mbed714	0:d616ece2d859	12	* and/or other materials provided with the distribution.
mbed714	0:d616ece2d859	13	* 3. The name of the author may not be used to endorse or promote products
mbed714	0:d616ece2d859	14	* derived from this software without specific prior written permission.
mbed714	0:d616ece2d859	15	*
mbed714	0:d616ece2d859	16	* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
mbed714	0:d616ece2d859	17	* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
mbed714	0:d616ece2d859	18	* MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
mbed714	0:d616ece2d859	19	* SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
mbed714	0:d616ece2d859	20	* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
mbed714	0:d616ece2d859	21	* OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
mbed714	0:d616ece2d859	22	* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
mbed714	0:d616ece2d859	23	* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
mbed714	0:d616ece2d859	24	* IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
mbed714	0:d616ece2d859	25	* OF SUCH DAMAGE.
mbed714	0:d616ece2d859	26	*
mbed714	0:d616ece2d859	27	* This file is part of the lwIP TCP/IP stack.
mbed714	0:d616ece2d859	28	*
mbed714	0:d616ece2d859	29	* Author: Adam Dunkels <adam@sics.se>
mbed714	0:d616ece2d859	30	*
mbed714	0:d616ece2d859	31	*/
mbed714	0:d616ece2d859	32	#ifndef __LWIP_IP_ADDR_H__
mbed714	0:d616ece2d859	33	#define __LWIP_IP_ADDR_H__
mbed714	0:d616ece2d859	34
mbed714	0:d616ece2d859	35	#include "lwip/opt.h"
mbed714	0:d616ece2d859	36	#include "lwip/def.h"
mbed714	0:d616ece2d859	37
mbed714	0:d616ece2d859	38	#ifdef __cplusplus
mbed714	0:d616ece2d859	39	extern "C" {
mbed714	0:d616ece2d859	40	#endif
mbed714	0:d616ece2d859	41
mbed714	0:d616ece2d859	42	/* This is the aligned version of ip_addr_t,
mbed714	0:d616ece2d859	43	used as local variable, on the stack, etc. */
mbed714	0:d616ece2d859	44	struct ip_addr {
mbed714	0:d616ece2d859	45	u32_t addr;
mbed714	0:d616ece2d859	46	};
mbed714	0:d616ece2d859	47
mbed714	0:d616ece2d859	48	/* This is the packed version of ip_addr_t,
mbed714	0:d616ece2d859	49	used in network headers that are itself packed */
mbed714	0:d616ece2d859	50	#ifdef PACK_STRUCT_USE_INCLUDES
mbed714	0:d616ece2d859	51	# include "arch/bpstruct.h"
mbed714	0:d616ece2d859	52	#endif
mbed714	0:d616ece2d859	53	PACK_STRUCT_BEGIN
mbed714	0:d616ece2d859	54	struct ip_addr_packed {
mbed714	0:d616ece2d859	55	PACK_STRUCT_FIELD(u32_t addr);
mbed714	0:d616ece2d859	56	} PACK_STRUCT_STRUCT;
mbed714	0:d616ece2d859	57	PACK_STRUCT_END
mbed714	0:d616ece2d859	58	#ifdef PACK_STRUCT_USE_INCLUDES
mbed714	0:d616ece2d859	59	# include "arch/epstruct.h"
mbed714	0:d616ece2d859	60	#endif
mbed714	0:d616ece2d859	61
mbed714	0:d616ece2d859	62	/** ip_addr_t uses a struct for convenience only, so that the same defines can
mbed714	0:d616ece2d859	63	* operate both on ip_addr_t as well as on ip_addr_p_t. */
mbed714	0:d616ece2d859	64	typedef struct ip_addr ip_addr_t;
mbed714	0:d616ece2d859	65	typedef struct ip_addr_packed ip_addr_p_t;
mbed714	0:d616ece2d859	66
mbed714	0:d616ece2d859	67	/*
mbed714	0:d616ece2d859	68	* struct ipaddr2 is used in the definition of the ARP packet format in
mbed714	0:d616ece2d859	69	* order to support compilers that don't have structure packing.
mbed714	0:d616ece2d859	70	*/
mbed714	0:d616ece2d859	71	#ifdef PACK_STRUCT_USE_INCLUDES
mbed714	0:d616ece2d859	72	# include "arch/bpstruct.h"
mbed714	0:d616ece2d859	73	#endif
mbed714	0:d616ece2d859	74	PACK_STRUCT_BEGIN
mbed714	0:d616ece2d859	75	struct ip_addr2 {
mbed714	0:d616ece2d859	76	PACK_STRUCT_FIELD(u16_t addrw[2]);
mbed714	0:d616ece2d859	77	} PACK_STRUCT_STRUCT;
mbed714	0:d616ece2d859	78	PACK_STRUCT_END
mbed714	0:d616ece2d859	79	#ifdef PACK_STRUCT_USE_INCLUDES
mbed714	0:d616ece2d859	80	# include "arch/epstruct.h"
mbed714	0:d616ece2d859	81	#endif
mbed714	0:d616ece2d859	82
mbed714	0:d616ece2d859	83	/* Forward declaration to not include netif.h */
mbed714	0:d616ece2d859	84	struct netif;
mbed714	0:d616ece2d859	85
mbed714	0:d616ece2d859	86	extern const ip_addr_t ip_addr_any;
mbed714	0:d616ece2d859	87	extern const ip_addr_t ip_addr_broadcast;
mbed714	0:d616ece2d859	88
mbed714	0:d616ece2d859	89	/** IP_ADDR_ can be used as a fixed IP address
mbed714	0:d616ece2d859	90	* for the wildcard and the broadcast address
mbed714	0:d616ece2d859	91	*/
mbed714	0:d616ece2d859	92	#define IP_ADDR_ANY ((ip_addr_t *)&ip_addr_any)
mbed714	0:d616ece2d859	93	#define IP_ADDR_BROADCAST ((ip_addr_t *)&ip_addr_broadcast)
mbed714	0:d616ece2d859	94
mbed714	0:d616ece2d859	95	/** 255.255.255.255 */
mbed714	0:d616ece2d859	96	#define IPADDR_NONE ((u32_t)0xffffffffUL)
mbed714	0:d616ece2d859	97	/** 127.0.0.1 */
mbed714	0:d616ece2d859	98	#define IPADDR_LOOPBACK ((u32_t)0x7f000001UL)
mbed714	0:d616ece2d859	99	/** 0.0.0.0 */
mbed714	0:d616ece2d859	100	#define IPADDR_ANY ((u32_t)0x00000000UL)
mbed714	0:d616ece2d859	101	/** 255.255.255.255 */
mbed714	0:d616ece2d859	102	#define IPADDR_BROADCAST ((u32_t)0xffffffffUL)
mbed714	0:d616ece2d859	103
mbed714	0:d616ece2d859	104	/* Definitions of the bits in an Internet address integer.
mbed714	0:d616ece2d859	105
mbed714	0:d616ece2d859	106	On subnets, host and network parts are found according to
mbed714	0:d616ece2d859	107	the subnet mask, not these masks. */
mbed714	0:d616ece2d859	108	#define IP_CLASSA(a) ((((u32_t)(a)) & 0x80000000UL) == 0)
mbed714	0:d616ece2d859	109	#define IP_CLASSA_NET 0xff000000
mbed714	0:d616ece2d859	110	#define IP_CLASSA_NSHIFT 24
mbed714	0:d616ece2d859	111	#define IP_CLASSA_HOST (0xffffffff & ~IP_CLASSA_NET)
mbed714	0:d616ece2d859	112	#define IP_CLASSA_MAX 128
mbed714	0:d616ece2d859	113
mbed714	0:d616ece2d859	114	#define IP_CLASSB(a) ((((u32_t)(a)) & 0xc0000000UL) == 0x80000000UL)
mbed714	0:d616ece2d859	115	#define IP_CLASSB_NET 0xffff0000
mbed714	0:d616ece2d859	116	#define IP_CLASSB_NSHIFT 16
mbed714	0:d616ece2d859	117	#define IP_CLASSB_HOST (0xffffffff & ~IP_CLASSB_NET)
mbed714	0:d616ece2d859	118	#define IP_CLASSB_MAX 65536
mbed714	0:d616ece2d859	119
mbed714	0:d616ece2d859	120	#define IP_CLASSC(a) ((((u32_t)(a)) & 0xe0000000UL) == 0xc0000000UL)
mbed714	0:d616ece2d859	121	#define IP_CLASSC_NET 0xffffff00
mbed714	0:d616ece2d859	122	#define IP_CLASSC_NSHIFT 8
mbed714	0:d616ece2d859	123	#define IP_CLASSC_HOST (0xffffffff & ~IP_CLASSC_NET)
mbed714	0:d616ece2d859	124
mbed714	0:d616ece2d859	125	#define IP_CLASSD(a) (((u32_t)(a) & 0xf0000000UL) == 0xe0000000UL)
mbed714	0:d616ece2d859	126	#define IP_CLASSD_NET 0xf0000000 /* These ones aren't really */
mbed714	0:d616ece2d859	127	#define IP_CLASSD_NSHIFT 28 /* net and host fields, but */
mbed714	0:d616ece2d859	128	#define IP_CLASSD_HOST 0x0fffffff /* routing needn't know. */
mbed714	0:d616ece2d859	129	#define IP_MULTICAST(a) IP_CLASSD(a)
mbed714	0:d616ece2d859	130
mbed714	0:d616ece2d859	131	#define IP_EXPERIMENTAL(a) (((u32_t)(a) & 0xf0000000UL) == 0xf0000000UL)
mbed714	0:d616ece2d859	132	#define IP_BADCLASS(a) (((u32_t)(a) & 0xf0000000UL) == 0xf0000000UL)
mbed714	0:d616ece2d859	133
mbed714	0:d616ece2d859	134	#define IP_LOOPBACKNET 127 /* official! */
mbed714	0:d616ece2d859	135
mbed714	0:d616ece2d859	136
mbed714	0:d616ece2d859	137	#if BYTE_ORDER == BIG_ENDIAN
mbed714	0:d616ece2d859	138	/** Set an IP address given by the four byte-parts */
mbed714	0:d616ece2d859	139	#define IP4_ADDR(ipaddr, a,b,c,d) \
mbed714	0:d616ece2d859	140	(ipaddr)->addr = ((u32_t)((a) & 0xff) << 24) \| \
mbed714	0:d616ece2d859	141	((u32_t)((b) & 0xff) << 16) \| \
mbed714	0:d616ece2d859	142	((u32_t)((c) & 0xff) << 8) \| \
mbed714	0:d616ece2d859	143	(u32_t)((d) & 0xff)
mbed714	0:d616ece2d859	144	#else
mbed714	0:d616ece2d859	145	/** Set an IP address given by the four byte-parts.
mbed714	0:d616ece2d859	146	Little-endian version that prevents the use of htonl. */
mbed714	0:d616ece2d859	147	#define IP4_ADDR(ipaddr, a,b,c,d) \
mbed714	0:d616ece2d859	148	(ipaddr)->addr = ((u32_t)((d) & 0xff) << 24) \| \
mbed714	0:d616ece2d859	149	((u32_t)((c) & 0xff) << 16) \| \
mbed714	0:d616ece2d859	150	((u32_t)((b) & 0xff) << 8) \| \
mbed714	0:d616ece2d859	151	(u32_t)((a) & 0xff)
mbed714	0:d616ece2d859	152	#endif
mbed714	0:d616ece2d859	153
mbed714	0:d616ece2d859	154	/** MEMCPY-like copying of IP addresses where addresses are known to be
mbed714	0:d616ece2d859	155	* 16-bit-aligned if the port is correctly configured (so a port could define
mbed714	0:d616ece2d859	156	* this to copying 2 u16_t's) - no NULL-pointer-checking needed. */
mbed714	0:d616ece2d859	157	#ifndef IPADDR2_COPY
mbed714	0:d616ece2d859	158	#define IPADDR2_COPY(dest, src) SMEMCPY(dest, src, sizeof(ip_addr_t))
mbed714	0:d616ece2d859	159	#endif
mbed714	0:d616ece2d859	160
mbed714	0:d616ece2d859	161	/** Copy IP address - faster than ip_addr_set: no NULL check */
mbed714	0:d616ece2d859	162	#define ip_addr_copy(dest, src) ((dest).addr = (src).addr)
mbed714	0:d616ece2d859	163	/** Safely copy one IP address to another (src may be NULL) */
mbed714	0:d616ece2d859	164	#define ip_addr_set(dest, src) ((dest)->addr = \
mbed714	0:d616ece2d859	165	((src) == NULL ? 0 : \
mbed714	0:d616ece2d859	166	(src)->addr))
mbed714	0:d616ece2d859	167	/** Set complete address to zero */
mbed714	0:d616ece2d859	168	#define ip_addr_set_zero(ipaddr) ((ipaddr)->addr = 0)
mbed714	0:d616ece2d859	169	/** Set address to IPADDR_ANY (no need for htonl()) */
mbed714	0:d616ece2d859	170	#define ip_addr_set_any(ipaddr) ((ipaddr)->addr = IPADDR_ANY)
mbed714	0:d616ece2d859	171	/** Set address to loopback address */
mbed714	0:d616ece2d859	172	#define ip_addr_set_loopback(ipaddr) ((ipaddr)->addr = PP_HTONL(IPADDR_LOOPBACK))
mbed714	0:d616ece2d859	173	/** Safely copy one IP address to another and change byte order
mbed714	0:d616ece2d859	174	* from host- to network-order. */
mbed714	0:d616ece2d859	175	#define ip_addr_set_hton(dest, src) ((dest)->addr = \
mbed714	0:d616ece2d859	176	((src) == NULL ? 0:\
mbed714	0:d616ece2d859	177	htonl((src)->addr)))
mbed714	0:d616ece2d859	178	/** IPv4 only: set the IP address given as an u32_t */
mbed714	0:d616ece2d859	179	#define ip4_addr_set_u32(dest_ipaddr, src_u32) ((dest_ipaddr)->addr = (src_u32))
mbed714	0:d616ece2d859	180	/** IPv4 only: get the IP address as an u32_t */
mbed714	0:d616ece2d859	181	#define ip4_addr_get_u32(src_ipaddr) ((src_ipaddr)->addr)
mbed714	0:d616ece2d859	182
mbed714	0:d616ece2d859	183	/** Get the network address by combining host address with netmask */
mbed714	0:d616ece2d859	184	#define ip_addr_get_network(target, host, netmask) ((target)->addr = ((host)->addr) & ((netmask)->addr))
mbed714	0:d616ece2d859	185
mbed714	0:d616ece2d859	186	/**
mbed714	0:d616ece2d859	187	* Determine if two address are on the same network.
mbed714	0:d616ece2d859	188	*
mbed714	0:d616ece2d859	189	* @arg addr1 IP address 1
mbed714	0:d616ece2d859	190	* @arg addr2 IP address 2
mbed714	0:d616ece2d859	191	* @arg mask network identifier mask
mbed714	0:d616ece2d859	192	* @return !0 if the network identifiers of both address match
mbed714	0:d616ece2d859	193	*/
mbed714	0:d616ece2d859	194	#define ip_addr_netcmp(addr1, addr2, mask) (((addr1)->addr & \
mbed714	0:d616ece2d859	195	(mask)->addr) == \
mbed714	0:d616ece2d859	196	((addr2)->addr & \
mbed714	0:d616ece2d859	197	(mask)->addr))
mbed714	0:d616ece2d859	198	#define ip_addr_cmp(addr1, addr2) ((addr1)->addr == (addr2)->addr)
mbed714	0:d616ece2d859	199
mbed714	0:d616ece2d859	200	#define ip_addr_isany(addr1) ((addr1) == NULL \|\| (addr1)->addr == IPADDR_ANY)
mbed714	0:d616ece2d859	201
mbed714	0:d616ece2d859	202	#define ip_addr_isbroadcast(ipaddr, netif) ip4_addr_isbroadcast((ipaddr)->addr, (netif))
mbed714	0:d616ece2d859	203	u8_t ip4_addr_isbroadcast(u32_t addr, const struct netif *netif);
mbed714	0:d616ece2d859	204
mbed714	0:d616ece2d859	205	#define ip_addr_netmask_valid(netmask) ip4_addr_netmask_valid((netmask)->addr)
mbed714	0:d616ece2d859	206	u8_t ip4_addr_netmask_valid(u32_t netmask);
mbed714	0:d616ece2d859	207
mbed714	0:d616ece2d859	208	#define ip_addr_ismulticast(addr1) (((addr1)->addr & PP_HTONL(0xf0000000UL)) == PP_HTONL(0xe0000000UL))
mbed714	0:d616ece2d859	209
mbed714	0:d616ece2d859	210	#define ip_addr_islinklocal(addr1) (((addr1)->addr & PP_HTONL(0xffff0000UL)) == PP_HTONL(0xa9fe0000UL))
mbed714	0:d616ece2d859	211
mbed714	0:d616ece2d859	212	#define ip_addr_debug_print(debug, ipaddr) \
mbed714	0:d616ece2d859	213	LWIP_DEBUGF(debug, ("%"U16_F".%"U16_F".%"U16_F".%"U16_F, \
mbed714	0:d616ece2d859	214	ipaddr != NULL ? ip4_addr1_16(ipaddr) : 0, \
mbed714	0:d616ece2d859	215	ipaddr != NULL ? ip4_addr2_16(ipaddr) : 0, \
mbed714	0:d616ece2d859	216	ipaddr != NULL ? ip4_addr3_16(ipaddr) : 0, \
mbed714	0:d616ece2d859	217	ipaddr != NULL ? ip4_addr4_16(ipaddr) : 0))
mbed714	0:d616ece2d859	218
mbed714	0:d616ece2d859	219	/* Get one byte from the 4-byte address */
mbed714	0:d616ece2d859	220	#define ip4_addr1(ipaddr) (((u8_t*)(ipaddr))[0])
mbed714	0:d616ece2d859	221	#define ip4_addr2(ipaddr) (((u8_t*)(ipaddr))[1])
mbed714	0:d616ece2d859	222	#define ip4_addr3(ipaddr) (((u8_t*)(ipaddr))[2])
mbed714	0:d616ece2d859	223	#define ip4_addr4(ipaddr) (((u8_t*)(ipaddr))[3])
mbed714	0:d616ece2d859	224	/* These are cast to u16_t, with the intent that they are often arguments
mbed714	0:d616ece2d859	225	* to printf using the U16_F format from cc.h. */
mbed714	0:d616ece2d859	226	#define ip4_addr1_16(ipaddr) ((u16_t)ip4_addr1(ipaddr))
mbed714	0:d616ece2d859	227	#define ip4_addr2_16(ipaddr) ((u16_t)ip4_addr2(ipaddr))
mbed714	0:d616ece2d859	228	#define ip4_addr3_16(ipaddr) ((u16_t)ip4_addr3(ipaddr))
mbed714	0:d616ece2d859	229	#define ip4_addr4_16(ipaddr) ((u16_t)ip4_addr4(ipaddr))
mbed714	0:d616ece2d859	230
mbed714	0:d616ece2d859	231	/** For backwards compatibility */
mbed714	0:d616ece2d859	232	#define ip_ntoa(ipaddr) ipaddr_ntoa(ipaddr)
mbed714	0:d616ece2d859	233
mbed714	0:d616ece2d859	234	u32_t ipaddr_addr(const char *cp);
mbed714	0:d616ece2d859	235	int ipaddr_aton(const char cp, ip_addr_t addr);
mbed714	0:d616ece2d859	236	/** returns ptr to static buffer; not reentrant! */
mbed714	0:d616ece2d859	237	char ipaddr_ntoa(const ip_addr_t addr);
mbed714	0:d616ece2d859	238	char ipaddr_ntoa_r(const ip_addr_t addr, char *buf, int buflen);
mbed714	0:d616ece2d859	239
mbed714	0:d616ece2d859	240	#ifdef __cplusplus
mbed714	0:d616ece2d859	241	}
mbed714	0:d616ece2d859	242	#endif
mbed714	0:d616ece2d859	243
mbed714	0:d616ece2d859	244	#endif /* __LWIP_IP_ADDR_H__ */

Repository toolbox

Export to desktop IDE

Repository details

Type:	Library
Created:	18 Sep 2010
Imports:	1
Forks:	0
Commits:	1
Dependents:	0
Dependencies:	0
Followers:	1

This repository is Public (Unlisted).

lwip/include/ipv4/lwip/ip_addr.h@0:d616ece2d859, 2010-09-18 (annotated)

Who changed what in which revision?

Repository toolbox

Repository details

Important Information for this Arm website

Access Warning