WebSVN – HelenOS – Diff – /branches/network/uspace/srv/net/il/ip/ip_header.h


/*
 * Copyright (c) 2009 Lukas Mejdrech
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * - Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 * - Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the distribution.
 * - The name of the author may not be used to endorse or promote products
 *   derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
 
/** @addtogroup ip
 *  @{
 */
 
/** @file
 *  IP header and options definitions.
 *  Names according to the linux src/include/linux/ip.h header file.
 */
 
#ifndef __NET_IP_HEADER_H__
#define __NET_IP_HEADER_H__
 
#include <byteorder.h>
#include <sys/types.h>
 
/** Type definition of the internet header.
 *  @see ip_header
 */
typedef struct ip_header    ip_header_t;
 
/** Type definition of the internet header pointer.
 *  @see ip_header
 */
typedef ip_header_t *       ip_header_ref;
 
/** Internet header.
 *  The variable options should be included after the header itself and indicated by the increased header length value.
 */
struct ip_header{
#ifdef ARCH_IS_BIG_ENDIAN
    /** The Version field indicates the format of the internet header.
     */
    uint8_t     version:4;
    /** Internet Header Length is the length of the internet header in 32~bit words, and thus points to the beginning of the data.
     *  Note that the minimum value for a~correct header is~5.
     */
    uint8_t     ihl:4;
#else
    /** Internet Header Length is the length of the internet header in 32~bit words, and thus points to the beginning of the data.
     *  Note that the minimum value for a~correct header is~5.
     */
    uint8_t     ihl:4;
    /** The Version field indicates the format of the internet header.
     */
    uint8_t     version:4;
#endif
    /** The Type of Service provides an indication of the abstract parameters of the quality of service desired.
     *  These parameters are to be used to guide the selection of the actual service parameters when transmitting a~datagram through a~particular network.
     *  Several networks offer service precedence, which somehow treats high precedence traffic as more important than other traffic (generally by accepting only traffic above a~certain precedence at time of high load).
     *  The major choice is a~three way tradeoff between low-delay, high-reliability, and high-throughput.
     */
    uint8_t     tos;
    /** Total Length is the length of the datagram, measured in octets, including internet header and data.
     *  This field allows the length of a~datagram to be up to 65,535~octets.
     */
    uint16_t    total_length;
    /** An identifying value assigned by the sender to aid in assembling the fragments of a~datagram.
     */
    uint16_t    identification;
#ifdef ARCH_IS_BIG_ENDIAN
    /** Various control flags.
     *  @see
     */
    uint16_t    flags:3;
    /** This field indicates where in the datagram this fragment belongs.
     */
    uint16_t    fragment_offset:3;
#else
    /** This field indicates where in the datagram this fragment belongs.
     */
    uint16_t    fragment_offset:13;
    /** Various control flags.
     */
    uint16_t    flags:3;
#endif
    /** This field indicates the maximum time the datagram is allowed to remain in the internet system.
     *  If this field contains the value zero, then the datagram must be destroyed.
     *  This field is modified in internet header processing.
     *  The time is measured in units of seconds, but since every module that processes a~datagram must decrease the TTL by at least one even if it process the datagram in less than a~second, the TTL must be thought of only as an upper bound on the time a~datagram may exist.
     *  The intention is to cause undeliverable datagrams to be discarded, and to bound the maximum datagram lifetime.
     */
    uint8_t     ttl;
    /** This field indicates the next level protocol used in the data portion of the internet datagram.
     */
    uint8_t     protocol;
    /** A checksum of the header only.
     *  Since some header fields change (e.g., time to live), this is recomputed and verified at each point that the internet header is processed.
     *  The checksum algorithm is: The checksum field is the 16~bit one's complement of the one's complement sum of all 16~bit words in the header.
     *  For purposes of computing the checksum, the value of the checksum field is zero.
     */
    uint16_t    header_checksum;
    /** The source address.
     */
    uint32_t    source_address;
    /** The destination address.
     */
    uint32_t    destination_address;
} __attribute__ ((packed));
 
/** Type definition of the internet option header.
 *  @see ip_header
 */
typedef struct ip_option    ip_option_t;
 
/** Type definition of the internet option header pointer.
 *  @see ip_header
 */
typedef ip_option_t *       ip_option_ref;
 
/** Internet option header.
 *  Only type field is always valid.
 *  Other fields' validity depends on the option type.
 */
struct ip_option{
    /** A single octet of option-type.
     */
    uint8_t     type;
    /** An option length octet.
     */
    uint8_t     length;
    /** A~pointer.
     */
    uint8_t     pointer;
#ifdef ARCH_IS_BIG_ENDIAN
    /** The number of IP modules that cannot register timestamps due to lack of space.
     */
    uint8_t overflow:4;
    /** Various internet timestamp control flags.
     */
    uint8_t flags:4;
#else
    /** Various internet timestamp control flags.
     */
    uint8_t flags:4;
    /** The number of IP modules that cannot register timestamps due to lack of space.
     */
    uint8_t overflow:4;
#endif
} __attribute__ ((packed));
 
/** @name IP flags definitions
 */
/*@{*/
 
/** Fragment flag field shift.
 */
#define IPFLAG_FRAGMENT_SHIFT       1
 
/** Fragmented flag field shift.
 */
#define IPFLAG_FRAGMENTED_SHIFT     0
 
/** May fragment flag value.
 *  Allows the packet fragmentation.
 */
#define IPFLAG_MAY_FRAGMENT         ( 0x0 << IPFLAG_FRAGMENT_SHIFT )
 
/** Don't fragment flag value.
 *  Permits the packet fragmentation.
 */
#define IPFLAG_DONT_FRAGMENT        ( 0x1 << IPFLAG_FRAGMENT_SHIFT )
 
/** Last fragment flag value.
 *  Indicates the last packet fragment.
 */
#define IPFLAG_LAST_FRAGMENT        ( 0x0 << IPFLAG_FRAGMENTED_SHIFT )
 
/** More fragments flag value.
 *  Indicates that more packet fragments follow.
 */
#define IPFLAG_MORE_FRAGMENTS       ( 0x1 << IPFLAG_FRAGMENTED_SHIFT )
 
/*@}*/
 
/*
#define IPOPT_OPTVAL 0
#define IPOPT_OLEN   1
#define IPOPT_OFFSET 2
#define IPOPT_MINOFF 4
#define MAX_IPOPTLEN 40
*/
 
#endif
 
/** @}
 */
 

Rev 4505	Rev 4704
1	/*	1	/*
2	* Copyright (c) 2009 Lukas Mejdrech	2	* Copyright (c) 2009 Lukas Mejdrech
3	* All rights reserved.	3	* All rights reserved.
4	*	4	*
5	* Redistribution and use in source and binary forms, with or without	5	* Redistribution and use in source and binary forms, with or without
6	* modification, are permitted provided that the following conditions	6	* modification, are permitted provided that the following conditions
7	* are met:	7	* are met:
8	*	8	*
9	* - Redistributions of source code must retain the above copyright	9	* - Redistributions of source code must retain the above copyright
10	* notice, this list of conditions and the following disclaimer.	10	* notice, this list of conditions and the following disclaimer.
11	* - Redistributions in binary form must reproduce the above copyright	11	* - Redistributions in binary form must reproduce the above copyright
12	* notice, this list of conditions and the following disclaimer in the	12	* notice, this list of conditions and the following disclaimer in the
13	* documentation and/or other materials provided with the distribution.	13	* documentation and/or other materials provided with the distribution.
14	* - The name of the author may not be used to endorse or promote products	14	* - The name of the author may not be used to endorse or promote products
15	* derived from this software without specific prior written permission.	15	* derived from this software without specific prior written permission.
16	*	16	*
17	* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR	17	* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18	* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES	18	* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19	* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.	19	* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20	* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,	20	* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21	* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT	21	* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22	* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,	22	* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23	* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY	23	* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24	* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT	24	* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25	* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF	25	* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26	* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.	26	* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27	*/	27	*/
28		28
29	/** @addtogroup ip	29	/** @addtogroup ip
30	* @{	30	* @{
31	*/	31	*/
32		32
33	/** @file	33	/** @file
34	* Internet protocol header and options definitions.	34	* IP header and options definitions.
35	* Names according to the linux src/include/linux/ip.h header file.	35	* Names according to the linux src/include/linux/ip.h header file.
36	*/	36	*/
37		37
38	#ifndef __NET_IP_HEADER_H__	38	#ifndef __NET_IP_HEADER_H__
39	#define __NET_IP_HEADER_H__	39	#define __NET_IP_HEADER_H__
40		40
41	#include <byteorder.h>	41	#include <byteorder.h>
42	#include <sys/types.h>	42	#include <sys/types.h>
43		43
44	/** Type definition of the internet header.	44	/** Type definition of the internet header.
45	* @see ip_header	45	* @see ip_header
46	*/	46	*/
47	typedef struct ip_header ip_header_t;	47	typedef struct ip_header ip_header_t;
48		48
49	/** Type definition of the internet header pointer.	49	/** Type definition of the internet header pointer.
50	* @see ip_header	50	* @see ip_header
51	*/	51	*/
52	typedef ip_header_t * ip_header_ref;	52	typedef ip_header_t * ip_header_ref;
53		53
54	/** Internet header.	54	/** Internet header.
55	* The variable options should be included after the header itself and indicated by the increased header length value.	55	* The variable options should be included after the header itself and indicated by the increased header length value.
56	*/	56	*/
57	struct ip_header{	57	struct ip_header{
58	#ifdef ARCH_IS_BIG_ENDIAN	58	#ifdef ARCH_IS_BIG_ENDIAN
59	/** The Version field indicates the format of the internet header.	59	/** The Version field indicates the format of the internet header.
60	*/	60	*/
61	uint8_t version:4;	61	uint8_t version:4;
62	/** Internet Header Length is the length of the internet header in 32~bit words, and thus points to the beginning of the data.	62	/** Internet Header Length is the length of the internet header in 32~bit words, and thus points to the beginning of the data.
63	* Note that the minimum value for a~correct header is~5.	63	* Note that the minimum value for a~correct header is~5.
64	*/	64	*/
65	uint8_t ihl:4;	65	uint8_t ihl:4;
66	#else	66	#else
67	/** Internet Header Length is the length of the internet header in 32~bit words, and thus points to the beginning of the data.	67	/** Internet Header Length is the length of the internet header in 32~bit words, and thus points to the beginning of the data.
68	* Note that the minimum value for a~correct header is~5.	68	* Note that the minimum value for a~correct header is~5.
69	*/	69	*/
70	uint8_t ihl:4;	70	uint8_t ihl:4;
71	/** The Version field indicates the format of the internet header.	71	/** The Version field indicates the format of the internet header.
72	*/	72	*/
73	uint8_t version:4;	73	uint8_t version:4;
74	#endif	74	#endif
75	/** The Type of Service provides an indication of the abstract parameters of the quality of service desired.	75	/** The Type of Service provides an indication of the abstract parameters of the quality of service desired.
76	* These parameters are to be used to guide the selection of the actual service parameters when transmitting a~datagram through a~particular network.	76	* These parameters are to be used to guide the selection of the actual service parameters when transmitting a~datagram through a~particular network.
77	* Several networks offer service precedence, which somehow treats high precedence traffic as more important than other traffic (generally by accepting only traffic above a~certain precedence at time of high load).	77	* Several networks offer service precedence, which somehow treats high precedence traffic as more important than other traffic (generally by accepting only traffic above a~certain precedence at time of high load).
78	* The major choice is a~three way tradeoff between low-delay, high-reliability, and high-throughput.	78	* The major choice is a~three way tradeoff between low-delay, high-reliability, and high-throughput.
79	*/	79	*/
80	uint8_t tos;	80	uint8_t tos;
81	/** Total Length is the length of the datagram, measured in octets, including internet header and data.	81	/** Total Length is the length of the datagram, measured in octets, including internet header and data.
82	* This field allows the length of a~datagram to be up to 65,535~octets.	82	* This field allows the length of a~datagram to be up to 65,535~octets.
83	*/	83	*/
84	uint16_t total_length;	84	uint16_t total_length;
85	/** An identifying value assigned by the sender to aid in assembling the fragments of a~datagram.	85	/** An identifying value assigned by the sender to aid in assembling the fragments of a~datagram.
86	*/	86	*/
87	uint16_t identification;	87	uint16_t identification;
88	#ifdef ARCH_IS_BIG_ENDIAN	88	#ifdef ARCH_IS_BIG_ENDIAN
89	/** Various control flags.	89	/** Various control flags.
-		90	* @see
90	*/	91	*/
91	uint16_t flags:3;	92	uint16_t flags:3;
92	/** This field indicates where in the datagram this fragment belongs.	93	/** This field indicates where in the datagram this fragment belongs.
93	*/	94	*/
94	uint16_t fragment_offset:3;	95	uint16_t fragment_offset:3;
95	#else	96	#else
96	/** This field indicates where in the datagram this fragment belongs.	97	/** This field indicates where in the datagram this fragment belongs.
97	*/	98	*/
98	uint16_t fragment_offset:13;	99	uint16_t fragment_offset:13;
99	/** Various control flags.	100	/** Various control flags.
100	*/	101	*/
101	uint16_t flags:3;	102	uint16_t flags:3;
102	#endif	103	#endif
103	/** This field indicates the maximum time the datagram is allowed to remain in the internet system.	104	/** This field indicates the maximum time the datagram is allowed to remain in the internet system.
104	* If this field contains the value zero, then the datagram must be destroyed.	105	* If this field contains the value zero, then the datagram must be destroyed.
105	* This field is modified in internet header processing.	106	* This field is modified in internet header processing.
106	* The time is measured in units of seconds, but since every module that processes a~datagram must decrease the TTL by at least one even if it process the datagram in less than a~second, the TTL must be thought of only as an upper bound on the time a~datagram may exist.	107	* The time is measured in units of seconds, but since every module that processes a~datagram must decrease the TTL by at least one even if it process the datagram in less than a~second, the TTL must be thought of only as an upper bound on the time a~datagram may exist.
107	* The intention is to cause undeliverable datagrams to be discarded, and to bound the maximum datagram lifetime.	108	* The intention is to cause undeliverable datagrams to be discarded, and to bound the maximum datagram lifetime.
108	*/	109	*/
109	uint8_t ttl;	110	uint8_t ttl;
110	/** This field indicates the next level protocol used in the data portion of the internet datagram.	111	/** This field indicates the next level protocol used in the data portion of the internet datagram.
111	*/	112	*/
112	uint8_t protocol;	113	uint8_t protocol;
113	/** A checksum of the header only.	114	/** A checksum of the header only.
114	* Since some header fields change (e.g., time to live), this is recomputed and verified at each point that the internet header is processed.	115	* Since some header fields change (e.g., time to live), this is recomputed and verified at each point that the internet header is processed.
115	* The checksum algorithm is: The checksum field is the 16~bit one's complement of the one's complement sum of all 16~bit words in the header.	116	* The checksum algorithm is: The checksum field is the 16~bit one's complement of the one's complement sum of all 16~bit words in the header.
116	* For purposes of computing the checksum, the value of the checksum field is zero.	117	* For purposes of computing the checksum, the value of the checksum field is zero.
117	*/	118	*/
118	uint16_t header_checksum;	119	uint16_t header_checksum;
119	/** The source address.	120	/** The source address.
120	*/	121	*/
121	uint32_t source_address;	122	uint32_t source_address;
122	/** The destination address.	123	/** The destination address.
123	*/	124	*/
124	uint32_t destination_address;	125	uint32_t destination_address;
125	} __attribute__ ((packed));	126	} __attribute__ ((packed));
126		127
127	/** Type definition of the internet option header.	128	/** Type definition of the internet option header.
128	* @see ip_header	129	* @see ip_header
129	*/	130	*/
130	typedef struct ip_option ip_option_t;	131	typedef struct ip_option ip_option_t;
131		132
132	/** Type definition of the internet option header pointer.	133	/** Type definition of the internet option header pointer.
133	* @see ip_header	134	* @see ip_header
134	*/	135	*/
135	typedef ip_option_t * ip_option_ref;	136	typedef ip_option_t * ip_option_ref;
136		137
137	/** Internet option header.	138	/** Internet option header.
138	* Only type field is always valid.	139	* Only type field is always valid.
139	* Other fields' validity depends on the option type.	140	* Other fields' validity depends on the option type.
140	*/	141	*/
141	struct ip_option{	142	struct ip_option{
142	/** A single octet of option-type.	143	/** A single octet of option-type.
143	*/	144	*/
144	uint8_t type;	145	uint8_t type;
145	/** An option length octet.	146	/** An option length octet.
146	*/	147	*/
147	uint8_t length;	148	uint8_t length;
148	/** A~pointer.	149	/** A~pointer.
149	*/	150	*/
150	uint8_t pointer;	151	uint8_t pointer;
151	#ifdef ARCH_IS_BIG_ENDIAN	152	#ifdef ARCH_IS_BIG_ENDIAN
152	/** The number of IP modules that cannot register timestamps due to lack of space.	153	/** The number of IP modules that cannot register timestamps due to lack of space.
153	*/	154	*/
154	uint8_t overflow:4;	155	uint8_t overflow:4;
155	/** Various internet timestamp control flags.	156	/** Various internet timestamp control flags.
156	*/	157	*/
157	uint8_t flags:4;	158	uint8_t flags:4;
158	#else	159	#else
159	/** Various internet timestamp control flags.	160	/** Various internet timestamp control flags.
160	*/	161	*/
161	uint8_t flags:4;	162	uint8_t flags:4;
162	/** The number of IP modules that cannot register timestamps due to lack of space.	163	/** The number of IP modules that cannot register timestamps due to lack of space.
163	*/	164	*/
164	uint8_t overflow:4;	165	uint8_t overflow:4;
165	#endif	166	#endif
166	} __attribute__ ((packed));	167	} __attribute__ ((packed));
167		168
-		169	/** @name IP flags definitions
-		170	*/
-		171	/@{/
-		172
-		173	/** Fragment flag field shift.
-		174	*/
168	#define IPFLAG_FRAGMENT_SHIFT 1	175	#define IPFLAG_FRAGMENT_SHIFT 1
-		176
-		177	/** Fragmented flag field shift.
-		178	*/
169	#define IPFLAG_FRAGMENTED_SHIFT 0	179	#define IPFLAG_FRAGMENTED_SHIFT 0
170		180
-		181	/** May fragment flag value.
-		182	* Allows the packet fragmentation.
-		183	*/
171	#define IPFLAG_MAY_FRAGMENT ( 0x0 << IPFLAG_FRAGMENT_SHIFT )	184	#define IPFLAG_MAY_FRAGMENT ( 0x0 << IPFLAG_FRAGMENT_SHIFT )
-		185
-		186	/** Don't fragment flag value.
-		187	* Permits the packet fragmentation.
-		188	*/
172	#define IPFLAG_DONT_FRAGMENT ( 0x1 << IPFLAG_FRAGMENT_SHIFT )	189	#define IPFLAG_DONT_FRAGMENT ( 0x1 << IPFLAG_FRAGMENT_SHIFT )
173		190
-		191	/** Last fragment flag value.
-		192	* Indicates the last packet fragment.
-		193	*/
174	#define IPFLAG_LAST_FRAGMENT ( 0x0 << IPFLAG_FRAGMENTED_SHIFT )	194	#define IPFLAG_LAST_FRAGMENT ( 0x0 << IPFLAG_FRAGMENTED_SHIFT )
-		195
-		196	/** More fragments flag value.
-		197	* Indicates that more packet fragments follow.
-		198	*/
175	#define IPFLAG_MORE_FRAGMENTS ( 0x1 << IPFLAG_FRAGMENTED_SHIFT )	199	#define IPFLAG_MORE_FRAGMENTS ( 0x1 << IPFLAG_FRAGMENTED_SHIFT )
176		200
-		201	/@}/
-		202
177	/*	203	/*
178	#define IPOPT_OPTVAL 0	204	#define IPOPT_OPTVAL 0
179	#define IPOPT_OLEN 1	205	#define IPOPT_OLEN 1
180	#define IPOPT_OFFSET 2	206	#define IPOPT_OFFSET 2
181	#define IPOPT_MINOFF 4	207	#define IPOPT_MINOFF 4
182	#define MAX_IPOPTLEN 40	208	#define MAX_IPOPTLEN 40
183	*/	209	*/
184		210
185	#endif	211	#endif
186		212
187	/** @}	213	/** @}
188	*/	214	*/
189		215

Subversion Repositories HelenOS

(root)/branches/network/uspace/srv/net/il/ip/ip_header.h – Rev 4505 → 4704