Rev 4722 | Rev 4731 | Go to most recent revision | Only display areas with differences | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed
Rev 4722 | Rev 4728 | ||
---|---|---|---|
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 | * IP header and options definitions. |
34 | * IP header and options definitions. |
35 | * Names according to the linux src/include/linux/ip.h header file. |
35 | * Based on the RFC~791. |
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 | /** Returns the actual IP header length. |
|
- | 45 | * @param header The IP packet header. Input parameter. |
|
- | 46 | */ |
|
- | 47 | #define IP_HEADER_LENGTH( header ) (( header )->header_length * 4u ) |
|
- | 48 | ||
- | 49 | /** Returns the actual IP header length. |
|
- | 50 | * @param header The IP packet header. Input parameter. |
|
- | 51 | */ |
|
- | 52 | #define IP_COMPUTE_HEADER_LENGTH( length ) (( uint8_t ) (( length ) / 4u )) |
|
- | 53 | ||
- | 54 | /** Returns the actual IP packet total length. |
|
- | 55 | * @param header The IP packet header. Input parameter. |
|
- | 56 | */ |
|
- | 57 | #define IP_TOTAL_LENGTH( header ) ntohs(( header )->total_length ) |
|
- | 58 | ||
- | 59 | /** Returns the actual IP packet data length. |
|
- | 60 | * @param header The IP packet header. Input parameter. |
|
- | 61 | */ |
|
- | 62 | #define IP_HEADER_DATA_LENGTH( header ) ( IP_TOTAL_LENGTH( header ) - IP_HEADER_LENGTH( header )) |
|
- | 63 | ||
- | 64 | /** Returns the IP packet header checksum. |
|
- | 65 | * @param header The IP packet header. Input parameter. |
|
- | 66 | */ |
|
- | 67 | #define IP_HEADER_CHECKSUM( header ) ( htons( ip_checksum(( uint8_t * )( header ), IP_HEADER_LENGTH( header )))) |
|
- | 68 | ||
- | 69 | /** Returns the fragment offest. |
|
- | 70 | * @param length The prefixed data total length. Input parameter. |
|
- | 71 | */ |
|
- | 72 | #define IP_COMPUTE_FRAGMENT_OFFSET( length ) (( length ) / 8 ) |
|
- | 73 | ||
44 | /** Type definition of the internet header. |
74 | /** Type definition of the internet header. |
45 | * @see ip_header |
75 | * @see ip_header |
46 | */ |
76 | */ |
47 | typedef struct ip_header ip_header_t; |
77 | typedef struct ip_header ip_header_t; |
48 | 78 | ||
49 | /** Type definition of the internet header pointer. |
79 | /** Type definition of the internet header pointer. |
50 | * @see ip_header |
80 | * @see ip_header |
51 | */ |
81 | */ |
52 | typedef ip_header_t * ip_header_ref; |
82 | typedef ip_header_t * ip_header_ref; |
53 | 83 | ||
54 | /** Internet header. |
84 | /** Internet header. |
55 | * The variable options should be included after the header itself and indicated by the increased header length value. |
85 | * The variable options should be included after the header itself and indicated by the increased header length value. |
56 | */ |
86 | */ |
57 | struct ip_header{ |
87 | struct ip_header{ |
58 | #ifdef ARCH_IS_BIG_ENDIAN |
88 | #ifdef ARCH_IS_BIG_ENDIAN |
59 | /** The Version field indicates the format of the internet header. |
89 | /** The Version field indicates the format of the internet header. |
60 | */ |
90 | */ |
61 | uint8_t version:4; |
91 | 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. |
92 | /** 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. |
93 | * Note that the minimum value for a~correct header is~5. |
64 | */ |
94 | */ |
65 | uint8_t ihl:4; |
95 | uint8_t header_length:4; |
66 | #else |
96 | #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. |
97 | /** 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. |
98 | * Note that the minimum value for a~correct header is~5. |
69 | */ |
99 | */ |
70 | uint8_t ihl:4; |
100 | uint8_t header_length:4; |
71 | /** The Version field indicates the format of the internet header. |
101 | /** The Version field indicates the format of the internet header. |
72 | */ |
102 | */ |
73 | uint8_t version:4; |
103 | uint8_t version:4; |
74 | #endif |
104 | #endif |
75 | /** The Type of Service provides an indication of the abstract parameters of the quality of service desired. |
105 | /** 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. |
106 | * 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). |
107 | * 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. |
108 | * The major choice is a~three way tradeoff between low-delay, high-reliability, and high-throughput. |
79 | */ |
109 | */ |
80 | uint8_t tos; |
110 | uint8_t tos; |
81 | /** Total Length is the length of the datagram, measured in octets, including internet header and data. |
111 | /** 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. |
112 | * This field allows the length of a~datagram to be up to 65,535~octets. |
83 | */ |
113 | */ |
84 | uint16_t total_length; |
114 | uint16_t total_length; |
85 | /** An identifying value assigned by the sender to aid in assembling the fragments of a~datagram. |
115 | /** An identifying value assigned by the sender to aid in assembling the fragments of a~datagram. |
86 | */ |
116 | */ |
87 | uint16_t identification; |
117 | uint16_t identification; |
88 | #ifdef ARCH_IS_BIG_ENDIAN |
118 | #ifdef ARCH_IS_BIG_ENDIAN |
89 | /** Various control flags. |
119 | /** Various control flags. |
90 | * @see |
120 | * @see |
91 | */ |
121 | */ |
92 | uint16_t flags:3; |
122 | uint16_t flags:3; |
93 | /** This field indicates where in the datagram this fragment belongs. |
123 | /** This field indicates where in the datagram this fragment belongs. |
94 | */ |
124 | */ |
95 | uint16_t fragment_offset:3; |
125 | uint16_t fragment_offset:3; |
96 | #else |
126 | #else |
97 | /** This field indicates where in the datagram this fragment belongs. |
127 | /** This field indicates where in the datagram this fragment belongs. |
98 | */ |
128 | */ |
99 | uint16_t fragment_offset:13; |
129 | uint16_t fragment_offset:13; |
100 | /** Various control flags. |
130 | /** Various control flags. |
101 | */ |
131 | */ |
102 | uint16_t flags:3; |
132 | uint16_t flags:3; |
103 | #endif |
133 | #endif |
104 | /** This field indicates the maximum time the datagram is allowed to remain in the internet system. |
134 | /** This field indicates the maximum time the datagram is allowed to remain in the internet system. |
105 | * If this field contains the value zero, then the datagram must be destroyed. |
135 | * If this field contains the value zero, then the datagram must be destroyed. |
106 | * This field is modified in internet header processing. |
136 | * This field is modified in internet header processing. |
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. |
137 | * 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. |
108 | * The intention is to cause undeliverable datagrams to be discarded, and to bound the maximum datagram lifetime. |
138 | * The intention is to cause undeliverable datagrams to be discarded, and to bound the maximum datagram lifetime. |
109 | */ |
139 | */ |
110 | uint8_t ttl; |
140 | uint8_t ttl; |
111 | /** This field indicates the next level protocol used in the data portion of the internet datagram. |
141 | /** This field indicates the next level protocol used in the data portion of the internet datagram. |
112 | */ |
142 | */ |
113 | uint8_t protocol; |
143 | uint8_t protocol; |
114 | /** A checksum of the header only. |
144 | /** A checksum of the header only. |
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. |
145 | * Since some header fields change (e.g., time to live), this is recomputed and verified at each point that the internet header is processed. |
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. |
146 | * 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. |
117 | * For purposes of computing the checksum, the value of the checksum field is zero. |
147 | * For purposes of computing the checksum, the value of the checksum field is zero. |
118 | */ |
148 | */ |
119 | uint16_t header_checksum; |
149 | uint16_t header_checksum; |
120 | /** The source address. |
150 | /** The source address. |
121 | */ |
151 | */ |
122 | uint32_t source_address; |
152 | uint32_t source_address; |
123 | /** The destination address. |
153 | /** The destination address. |
124 | */ |
154 | */ |
125 | uint32_t destination_address; |
155 | uint32_t destination_address; |
126 | } __attribute__ ((packed)); |
156 | } __attribute__ ((packed)); |
127 | 157 | ||
128 | /** Type definition of the internet option header. |
158 | /** Type definition of the internet option header. |
129 | * @see ip_header |
159 | * @see ip_header |
130 | */ |
160 | */ |
131 | typedef struct ip_option ip_option_t; |
161 | typedef struct ip_option ip_option_t; |
132 | 162 | ||
133 | /** Type definition of the internet option header pointer. |
163 | /** Type definition of the internet option header pointer. |
134 | * @see ip_header |
164 | * @see ip_header |
135 | */ |
165 | */ |
136 | typedef ip_option_t * ip_option_ref; |
166 | typedef ip_option_t * ip_option_ref; |
137 | 167 | ||
138 | /** Internet option header. |
168 | /** Internet option header. |
139 | * Only type field is always valid. |
169 | * Only type field is always valid. |
140 | * Other fields' validity depends on the option type. |
170 | * Other fields' validity depends on the option type. |
141 | */ |
171 | */ |
142 | struct ip_option{ |
172 | struct ip_option{ |
143 | /** A single octet of option-type. |
173 | /** A single octet of option-type. |
144 | */ |
174 | */ |
145 | uint8_t type; |
175 | uint8_t type; |
146 | /** An option length octet. |
176 | /** An option length octet. |
147 | */ |
177 | */ |
148 | uint8_t length; |
178 | uint8_t length; |
149 | /** A~pointer. |
179 | /** A~pointer. |
150 | */ |
180 | */ |
151 | uint8_t pointer; |
181 | uint8_t pointer; |
152 | #ifdef ARCH_IS_BIG_ENDIAN |
182 | #ifdef ARCH_IS_BIG_ENDIAN |
153 | /** The number of IP modules that cannot register timestamps due to lack of space. |
183 | /** The number of IP modules that cannot register timestamps due to lack of space. |
154 | */ |
184 | */ |
155 | uint8_t overflow:4; |
185 | uint8_t overflow:4; |
156 | /** Various internet timestamp control flags. |
186 | /** Various internet timestamp control flags. |
157 | */ |
187 | */ |
158 | uint8_t flags:4; |
188 | uint8_t flags:4; |
159 | #else |
189 | #else |
160 | /** Various internet timestamp control flags. |
190 | /** Various internet timestamp control flags. |
161 | */ |
191 | */ |
162 | uint8_t flags:4; |
192 | uint8_t flags:4; |
163 | /** The number of IP modules that cannot register timestamps due to lack of space. |
193 | /** The number of IP modules that cannot register timestamps due to lack of space. |
164 | */ |
194 | */ |
165 | uint8_t overflow:4; |
195 | uint8_t overflow:4; |
166 | #endif |
196 | #endif |
167 | } __attribute__ ((packed)); |
197 | } __attribute__ ((packed)); |
168 | 198 | ||
169 | /** @name IP flags definitions |
199 | /** @name IP flags definitions |
170 | */ |
200 | */ |
171 | /*@{*/ |
201 | /*@{*/ |
172 | 202 | ||
173 | /** Fragment flag field shift. |
203 | /** Fragment flag field shift. |
174 | */ |
204 | */ |
175 | #define IPFLAG_FRAGMENT_SHIFT 1 |
205 | #define IPFLAG_FRAGMENT_SHIFT 1 |
176 | 206 | ||
177 | /** Fragmented flag field shift. |
207 | /** Fragmented flag field shift. |
178 | */ |
208 | */ |
179 | #define IPFLAG_FRAGMENTED_SHIFT 0 |
209 | #define IPFLAG_FRAGMENTED_SHIFT 0 |
180 | 210 | ||
181 | /** May fragment flag value. |
211 | /** May fragment flag value. |
182 | * Allows the packet fragmentation. |
212 | * Allows the packet fragmentation. |
183 | */ |
213 | */ |
184 | #define IPFLAG_MAY_FRAGMENT ( 0x0 << IPFLAG_FRAGMENT_SHIFT ) |
214 | #define IPFLAG_MAY_FRAGMENT ( 0x0 << IPFLAG_FRAGMENT_SHIFT ) |
185 | 215 | ||
186 | /** Don't fragment flag value. |
216 | /** Don't fragment flag value. |
187 | * Permits the packet fragmentation. |
217 | * Permits the packet fragmentation. |
188 | */ |
218 | */ |
189 | #define IPFLAG_DONT_FRAGMENT ( 0x1 << IPFLAG_FRAGMENT_SHIFT ) |
219 | #define IPFLAG_DONT_FRAGMENT ( 0x1 << IPFLAG_FRAGMENT_SHIFT ) |
190 | 220 | ||
191 | /** Last fragment flag value. |
221 | /** Last fragment flag value. |
192 | * Indicates the last packet fragment. |
222 | * Indicates the last packet fragment. |
193 | */ |
223 | */ |
194 | #define IPFLAG_LAST_FRAGMENT ( 0x0 << IPFLAG_FRAGMENTED_SHIFT ) |
224 | #define IPFLAG_LAST_FRAGMENT ( 0x0 << IPFLAG_FRAGMENTED_SHIFT ) |
195 | 225 | ||
196 | /** More fragments flag value. |
226 | /** More fragments flag value. |
197 | * Indicates that more packet fragments follow. |
227 | * Indicates that more packet fragments follow. |
198 | */ |
228 | */ |
199 | #define IPFLAG_MORE_FRAGMENTS ( 0x1 << IPFLAG_FRAGMENTED_SHIFT ) |
229 | #define IPFLAG_MORE_FRAGMENTS ( 0x1 << IPFLAG_FRAGMENTED_SHIFT ) |
200 | 230 | ||
201 | /*@}*/ |
231 | /*@}*/ |
202 | 232 | ||
203 | /* |
- | |
204 | #define IPOPT_OPTVAL 0 |
- | |
205 | #define IPOPT_OLEN 1 |
- | |
206 | #define IPOPT_OFFSET 2 |
- | |
207 | #define IPOPT_MINOFF 4 |
- | |
208 | #define MAX_IPOPTLEN 40 |
- | |
209 | */ |
- | |
210 | - | ||
211 | /** Type definition of the internet version 4 pseudo header. |
233 | /** Type definition of the internet version 4 pseudo header. |
212 | * @see ipv4_pseudo_header |
234 | * @see ipv4_pseudo_header |
213 | */ |
235 | */ |
214 | typedef struct ipv4_pseudo_header ipv4_pseudo_header_t; |
236 | typedef struct ipv4_pseudo_header ipv4_pseudo_header_t; |
215 | 237 | ||
216 | /** Type definition of the internet version 4 pseudo header pointer. |
238 | /** Type definition of the internet version 4 pseudo header pointer. |
217 | * @see ipv4_pseudo_header |
239 | * @see ipv4_pseudo_header |
218 | */ |
240 | */ |
219 | typedef ipv4_pseudo_header_t * ipv4_pseudo_header_ref; |
241 | typedef ipv4_pseudo_header_t * ipv4_pseudo_header_ref; |
220 | 242 | ||
221 | /** Internet version 4 pseudo header. |
243 | /** Internet version 4 pseudo header. |
222 | */ |
244 | */ |
223 | struct ipv4_pseudo_header{ |
245 | struct ipv4_pseudo_header{ |
224 | /** The source address. |
246 | /** The source address. |
225 | */ |
247 | */ |
226 | uint32_t source_address; |
248 | uint32_t source_address; |
227 | /** The destination address. |
249 | /** The destination address. |
228 | */ |
250 | */ |
229 | uint32_t destination_address; |
251 | uint32_t destination_address; |
230 | /** Zero byte. |
252 | /** Reserved byte. |
- | 253 | * Must be zero. |
|
231 | */ |
254 | */ |
232 | uint8_t zero; |
255 | uint8_t reserved; |
233 | /** This field indicates the next level protocol used in the data portion of the internet datagram. |
256 | /** This field indicates the next level protocol used in the data portion of the internet datagram. |
234 | */ |
257 | */ |
235 | uint8_t protocol; |
258 | uint8_t protocol; |
236 | /** Data length is the length of the datagram, measured in octets. |
259 | /** Data length is the length of the datagram, measured in octets. |
237 | */ |
260 | */ |
238 | uint16_t data_length; |
261 | uint16_t data_length; |
239 | } __attribute__ ((packed)); |
262 | } __attribute__ ((packed)); |
240 | 263 | ||
241 | #endif |
264 | #endif |
242 | 265 | ||
243 | /** @} |
266 | /** @} |
244 | */ |
267 | */ |
245 | 268 |