]> git.proxmox.com Git - mirror_edk2.git/blame - NetworkPkg/Ip6Dxe/Ip6Option.c
UefiCpuPkg: Move AsmRelocateApLoopStart from Mpfuncs.nasm to AmdSev.nasm
[mirror_edk2.git] / NetworkPkg / Ip6Dxe / Ip6Option.c
CommitLineData
a3bcde70
HT
1/** @file\r
2 IP6 option support functions and routines.\r
3\r
4 Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved.<BR>\r
5\r
ecf98fbc 6 SPDX-License-Identifier: BSD-2-Clause-Patent\r
a3bcde70
HT
7\r
8**/\r
9\r
10#include "Ip6Impl.h"\r
11\r
12/**\r
13 Validate the IP6 option format for both the packets we received\r
14 and that we will transmit. It will compute the ICMPv6 error message fields\r
d1c85a17 15 if the option is malformatted.\r
a3bcde70
HT
16\r
17 @param[in] IpSb The IP6 service data.\r
18 @param[in] Packet The to be validated packet.\r
19 @param[in] Option The first byte of the option.\r
20 @param[in] OptionLen The length of the whole option.\r
21 @param[in] Pointer Identifies the octet offset within\r
22 the invoking packet where the error was detected.\r
23\r
24\r
25 @retval TRUE The option is properly formatted.\r
d1c85a17 26 @retval FALSE The option is malformatted.\r
a3bcde70
HT
27\r
28**/\r
29BOOLEAN\r
30Ip6IsOptionValid (\r
d1050b9d
MK
31 IN IP6_SERVICE *IpSb,\r
32 IN NET_BUF *Packet,\r
33 IN UINT8 *Option,\r
34 IN UINT8 OptionLen,\r
35 IN UINT32 Pointer\r
a3bcde70
HT
36 )\r
37{\r
d1050b9d
MK
38 UINT8 Offset;\r
39 UINT8 OptionType;\r
a3bcde70
HT
40\r
41 Offset = 0;\r
42\r
43 while (Offset < OptionLen) {\r
44 OptionType = *(Option + Offset);\r
45\r
46 switch (OptionType) {\r
d1050b9d
MK
47 case Ip6OptionPad1:\r
48 //\r
49 // It is a Pad1 option\r
50 //\r
51 Offset++;\r
a3bcde70 52 break;\r
d1050b9d
MK
53 case Ip6OptionPadN:\r
54 //\r
55 // It is a PadN option\r
56 //\r
57 Offset = (UINT8)(Offset + *(Option + Offset + 1) + 2);\r
58 break;\r
59 case Ip6OptionRouterAlert:\r
60 //\r
61 // It is a Router Alert Option\r
62 //\r
63 Offset += 4;\r
64 break;\r
65 default:\r
66 //\r
67 // The highest-order two bits specify the action must be taken if\r
68 // the processing IPv6 node does not recognize the option type.\r
69 //\r
70 switch (OptionType & Ip6OptionMask) {\r
71 case Ip6OptionSkip:\r
72 Offset = (UINT8)(Offset + *(Option + Offset + 1));\r
73 break;\r
74 case Ip6OptionDiscard:\r
75 return FALSE;\r
76 case Ip6OptionParameterProblem:\r
77 Pointer = Pointer + Offset + sizeof (EFI_IP6_HEADER);\r
78 Ip6SendIcmpError (\r
79 IpSb,\r
80 Packet,\r
81 NULL,\r
82 &Packet->Ip.Ip6->SourceAddress,\r
83 ICMP_V6_PARAMETER_PROBLEM,\r
84 2,\r
85 &Pointer\r
86 );\r
87 return FALSE;\r
88 case Ip6OptionMask:\r
89 if (!IP6_IS_MULTICAST (&Packet->Ip.Ip6->DestinationAddress)) {\r
90 Pointer = Pointer + Offset + sizeof (EFI_IP6_HEADER);\r
91 Ip6SendIcmpError (\r
92 IpSb,\r
93 Packet,\r
94 NULL,\r
95 &Packet->Ip.Ip6->SourceAddress,\r
96 ICMP_V6_PARAMETER_PROBLEM,\r
97 2,\r
98 &Pointer\r
99 );\r
100 }\r
101\r
102 return FALSE;\r
103 break;\r
a3bcde70
HT
104 }\r
105\r
a3bcde70 106 break;\r
a3bcde70 107 }\r
a3bcde70
HT
108 }\r
109\r
110 return TRUE;\r
111}\r
112\r
113/**\r
114 Validate the IP6 option format for both the packets we received\r
115 and that we will transmit. It supports the defined options in Neighbor\r
116 Discovery messages.\r
117\r
118 @param[in] Option The first byte of the option.\r
119 @param[in] OptionLen The length of the whole option.\r
120\r
121 @retval TRUE The option is properly formatted.\r
d1c85a17 122 @retval FALSE The option is malformatted.\r
a3bcde70
HT
123\r
124**/\r
125BOOLEAN\r
126Ip6IsNDOptionValid (\r
d1050b9d
MK
127 IN UINT8 *Option,\r
128 IN UINT16 OptionLen\r
a3bcde70
HT
129 )\r
130{\r
d1050b9d
MK
131 UINT32 Offset;\r
132 UINT16 Length;\r
133 IP6_OPTION_HEADER *OptionHeader;\r
9c20342e
MR
134\r
135 if (Option == NULL) {\r
136 ASSERT (Option != NULL);\r
137 return FALSE;\r
138 }\r
a3bcde70
HT
139\r
140 Offset = 0;\r
141\r
9c20342e
MR
142 //\r
143 // RFC 4861 states that Neighbor Discovery packet can contain zero or more\r
144 // options. Start processing the options if at least Type + Length fields\r
145 // fit within the input buffer.\r
146 //\r
147 while (Offset + sizeof (IP6_OPTION_HEADER) - 1 < OptionLen) {\r
d1050b9d
MK
148 OptionHeader = (IP6_OPTION_HEADER *)(Option + Offset);\r
149 Length = (UINT16)OptionHeader->Length * 8;\r
a3bcde70 150\r
9c20342e 151 switch (OptionHeader->Type) {\r
d1050b9d
MK
152 case Ip6OptionPrefixInfo:\r
153 if (Length != 32) {\r
154 return FALSE;\r
155 }\r
a3bcde70 156\r
d1050b9d 157 break;\r
a3bcde70 158\r
d1050b9d
MK
159 case Ip6OptionMtu:\r
160 if (Length != 8) {\r
161 return FALSE;\r
162 }\r
163\r
164 break;\r
165\r
166 default:\r
167 // RFC 4861 states that Length field cannot be 0.\r
168 if (Length == 0) {\r
169 return FALSE;\r
170 }\r
171\r
172 break;\r
9c20342e
MR
173 }\r
174\r
175 //\r
176 // Check whether recognized options are within the input buffer's scope.\r
177 //\r
178 switch (OptionHeader->Type) {\r
d1050b9d
MK
179 case Ip6OptionEtherSource:\r
180 case Ip6OptionEtherTarget:\r
181 case Ip6OptionPrefixInfo:\r
182 case Ip6OptionRedirected:\r
183 case Ip6OptionMtu:\r
184 if (Offset + Length > (UINT32)OptionLen) {\r
185 return FALSE;\r
186 }\r
a3bcde70 187\r
d1050b9d
MK
188 break;\r
189\r
190 default:\r
191 //\r
192 // Unrecognized options can be either valid (but unused) or invalid\r
193 // (garbage in between or right after valid options). Silently ignore.\r
194 //\r
195 break;\r
a3bcde70
HT
196 }\r
197\r
9c20342e
MR
198 //\r
199 // Advance to the next option.\r
200 // Length already considers option header's Type + Length.\r
201 //\r
202 Offset += Length;\r
a3bcde70
HT
203 }\r
204\r
205 return TRUE;\r
206}\r
207\r
a3bcde70
HT
208/**\r
209 Validate whether the NextHeader is a known valid protocol or one of the user configured\r
210 protocols from the upper layer.\r
211\r
212 @param[in] IpSb The IP6 service instance.\r
213 @param[in] NextHeader The next header field.\r
214\r
215 @retval TRUE The NextHeader is a known valid protocol or user configured.\r
216 @retval FALSE The NextHeader is not a known valid protocol.\r
217\r
218**/\r
219BOOLEAN\r
220Ip6IsValidProtocol (\r
d1050b9d
MK
221 IN IP6_SERVICE *IpSb,\r
222 IN UINT8 NextHeader\r
a3bcde70
HT
223 )\r
224{\r
d1050b9d
MK
225 LIST_ENTRY *Entry;\r
226 IP6_PROTOCOL *IpInstance;\r
227\r
228 if ((NextHeader == EFI_IP_PROTO_TCP) ||\r
229 (NextHeader == EFI_IP_PROTO_UDP) ||\r
230 (NextHeader == IP6_ICMP) ||\r
231 (NextHeader == IP6_ESP)\r
232 )\r
233 {\r
a3bcde70
HT
234 return TRUE;\r
235 }\r
236\r
237 if (IpSb == NULL) {\r
238 return FALSE;\r
239 }\r
240\r
241 if (IpSb->Signature != IP6_SERVICE_SIGNATURE) {\r
242 return FALSE;\r
243 }\r
244\r
245 NET_LIST_FOR_EACH (Entry, &IpSb->Children) {\r
246 IpInstance = NET_LIST_USER_STRUCT_S (Entry, IP6_PROTOCOL, Link, IP6_PROTOCOL_SIGNATURE);\r
247 if (IpInstance->State == IP6_STATE_CONFIGED) {\r
248 if (IpInstance->ConfigData.DefaultProtocol == NextHeader) {\r
249 return TRUE;\r
250 }\r
251 }\r
252 }\r
253\r
254 return FALSE;\r
255}\r
256\r
257/**\r
258 Validate the IP6 extension header format for both the packets we received\r
259 and that we will transmit. It will compute the ICMPv6 error message fields\r
d1c85a17 260 if the option is mal-formatted.\r
a3bcde70
HT
261\r
262 @param[in] IpSb The IP6 service instance. This is an optional parameter.\r
263 @param[in] Packet The data of the packet. Ignored if NULL.\r
264 @param[in] NextHeader The next header field in IPv6 basic header.\r
265 @param[in] ExtHdrs The first byte of the option.\r
266 @param[in] ExtHdrsLen The length of the whole option.\r
267 @param[in] Rcvd The option is from the packet we received if TRUE,\r
268 otherwise, the option we want to transmit.\r
269 @param[out] FormerHeader The offset of NextHeader which points to Fragment\r
270 Header when we received, of the ExtHdrs.\r
271 Ignored if we transmit.\r
272 @param[out] LastHeader The pointer of NextHeader of the last extension\r
273 header processed by IP6.\r
274 @param[out] RealExtsLen The length of extension headers processed by IP6 layer.\r
275 This is an optional parameter that may be NULL.\r
276 @param[out] UnFragmentLen The length of unfragmented length of extension headers.\r
277 This is an optional parameter that may be NULL.\r
278 @param[out] Fragmented Indicate whether the packet is fragmented.\r
279 This is an optional parameter that may be NULL.\r
280\r
d1c85a17
GL
281 @retval TRUE The option is properly formatted.\r
282 @retval FALSE The option is malformatted.\r
a3bcde70
HT
283\r
284**/\r
285BOOLEAN\r
286Ip6IsExtsValid (\r
d1050b9d
MK
287 IN IP6_SERVICE *IpSb OPTIONAL,\r
288 IN NET_BUF *Packet OPTIONAL,\r
289 IN UINT8 *NextHeader,\r
290 IN UINT8 *ExtHdrs,\r
291 IN UINT32 ExtHdrsLen,\r
292 IN BOOLEAN Rcvd,\r
293 OUT UINT32 *FormerHeader OPTIONAL,\r
294 OUT UINT8 **LastHeader,\r
295 OUT UINT32 *RealExtsLen OPTIONAL,\r
296 OUT UINT32 *UnFragmentLen OPTIONAL,\r
297 OUT BOOLEAN *Fragmented OPTIONAL\r
a3bcde70
HT
298 )\r
299{\r
d1050b9d
MK
300 UINT32 Pointer;\r
301 UINT32 Offset;\r
302 UINT8 *Option;\r
303 UINT8 OptionLen;\r
304 BOOLEAN Flag;\r
305 UINT8 CountD;\r
306 UINT8 CountA;\r
307 IP6_FRAGMENT_HEADER *FragmentHead;\r
308 UINT16 FragmentOffset;\r
309 IP6_ROUTING_HEADER *RoutingHead;\r
a3bcde70
HT
310\r
311 if (RealExtsLen != NULL) {\r
312 *RealExtsLen = 0;\r
313 }\r
314\r
315 if (UnFragmentLen != NULL) {\r
316 *UnFragmentLen = 0;\r
317 }\r
318\r
319 if (Fragmented != NULL) {\r
320 *Fragmented = FALSE;\r
321 }\r
322\r
323 *LastHeader = NextHeader;\r
324\r
d1050b9d 325 if ((ExtHdrs == NULL) && (ExtHdrsLen == 0)) {\r
a3bcde70
HT
326 return TRUE;\r
327 }\r
328\r
d1050b9d 329 if (((ExtHdrs == NULL) && (ExtHdrsLen != 0)) || ((ExtHdrs != NULL) && (ExtHdrsLen == 0))) {\r
a3bcde70
HT
330 return FALSE;\r
331 }\r
332\r
333 Pointer = 0;\r
334 Offset = 0;\r
335 Flag = FALSE;\r
336 CountD = 0;\r
337 CountA = 0;\r
338\r
339 while (Offset <= ExtHdrsLen) {\r
a3bcde70 340 switch (*NextHeader) {\r
d1050b9d
MK
341 case IP6_HOP_BY_HOP:\r
342 if (Offset != 0) {\r
343 if (!Rcvd) {\r
344 return FALSE;\r
345 }\r
346\r
347 //\r
348 // Hop-by-Hop Options header is restricted to appear immediately after an IPv6 header only.\r
349 // If not, generate a ICMP parameter problem message with code value of 1.\r
350 //\r
351 if (Pointer == 0) {\r
352 Pointer = sizeof (EFI_IP6_HEADER);\r
353 } else {\r
354 Pointer = Offset + sizeof (EFI_IP6_HEADER);\r
355 }\r
356\r
357 if ((IpSb != NULL) && (Packet != NULL) &&\r
358 !IP6_IS_MULTICAST (&Packet->Ip.Ip6->DestinationAddress))\r
359 {\r
360 Ip6SendIcmpError (\r
361 IpSb,\r
362 Packet,\r
363 NULL,\r
364 &Packet->Ip.Ip6->SourceAddress,\r
365 ICMP_V6_PARAMETER_PROBLEM,\r
366 1,\r
367 &Pointer\r
368 );\r
369 }\r
370\r
a3bcde70
HT
371 return FALSE;\r
372 }\r
d1050b9d
MK
373\r
374 Flag = TRUE;\r
375\r
376 //\r
377 // Fall through\r
378 //\r
379 case IP6_DESTINATION:\r
380 if (*NextHeader == IP6_DESTINATION) {\r
381 CountD++;\r
a3bcde70
HT
382 }\r
383\r
d1050b9d
MK
384 if (CountD > 2) {\r
385 return FALSE;\r
a3bcde70 386 }\r
a3bcde70 387\r
d1050b9d
MK
388 NextHeader = ExtHdrs + Offset;\r
389 Pointer = Offset;\r
a3bcde70 390\r
d1050b9d
MK
391 Offset++;\r
392 Option = ExtHdrs + Offset;\r
393 OptionLen = (UINT8)((*Option + 1) * 8 - 2);\r
394 Option++;\r
395 Offset++;\r
a3bcde70 396\r
d1050b9d
MK
397 if ((IpSb != NULL) && (Packet != NULL) && !Ip6IsOptionValid (IpSb, Packet, Option, OptionLen, Offset)) {\r
398 return FALSE;\r
399 }\r
a3bcde70 400\r
d1050b9d 401 Offset = Offset + OptionLen;\r
a3bcde70 402\r
d1050b9d
MK
403 if (Flag) {\r
404 if (UnFragmentLen != NULL) {\r
405 *UnFragmentLen = Offset;\r
406 }\r
a3bcde70 407\r
d1050b9d
MK
408 Flag = FALSE;\r
409 }\r
410\r
411 break;\r
a3bcde70 412\r
d1050b9d
MK
413 case IP6_ROUTING:\r
414 NextHeader = ExtHdrs + Offset;\r
415 RoutingHead = (IP6_ROUTING_HEADER *)NextHeader;\r
a3bcde70 416\r
d1050b9d
MK
417 //\r
418 // Type 0 routing header is defined in RFC2460 and deprecated in RFC5095.\r
419 // Thus all routing types are processed as unrecognized.\r
420 //\r
421 if (RoutingHead->SegmentsLeft == 0) {\r
422 //\r
423 // Ignore the routing header and proceed to process the next header.\r
424 //\r
425 Offset = Offset + (RoutingHead->HeaderLen + 1) * 8;\r
426\r
427 if (UnFragmentLen != NULL) {\r
428 *UnFragmentLen = Offset;\r
429 }\r
430 } else {\r
431 //\r
432 // Discard the packet and send an ICMP Parameter Problem, Code 0, message\r
433 // to the packet's source address, pointing to the unrecognized routing\r
434 // type.\r
435 //\r
436 Pointer = Offset + 2 + sizeof (EFI_IP6_HEADER);\r
437 if ((IpSb != NULL) && (Packet != NULL) &&\r
438 !IP6_IS_MULTICAST (&Packet->Ip.Ip6->DestinationAddress))\r
439 {\r
440 Ip6SendIcmpError (\r
441 IpSb,\r
442 Packet,\r
443 NULL,\r
444 &Packet->Ip.Ip6->SourceAddress,\r
445 ICMP_V6_PARAMETER_PROBLEM,\r
446 0,\r
447 &Pointer\r
448 );\r
449 }\r
450\r
451 return FALSE;\r
a3bcde70
HT
452 }\r
453\r
d1050b9d 454 break;\r
a3bcde70 455\r
d1050b9d 456 case IP6_FRAGMENT:\r
a3bcde70 457\r
d1050b9d
MK
458 //\r
459 // RFC2402, AH header should after fragment header.\r
460 //\r
461 if (CountA > 1) {\r
462 return FALSE;\r
463 }\r
a3bcde70 464\r
a3bcde70 465 //\r
d1050b9d
MK
466 // RFC2460, ICMP Parameter Problem message with code 0 should be sent\r
467 // if the length of a fragment is not a multiple of 8 octets and the M\r
468 // flag of that fragment is 1, pointing to the Payload length field of the\r
469 // fragment packet.\r
a3bcde70 470 //\r
d1050b9d
MK
471 if ((IpSb != NULL) && (Packet != NULL) && ((ExtHdrsLen % 8) != 0)) {\r
472 //\r
473 // Check whether it is the last fragment.\r
474 //\r
475 FragmentHead = (IP6_FRAGMENT_HEADER *)(ExtHdrs + Offset);\r
476 if (FragmentHead == NULL) {\r
477 return FALSE;\r
478 }\r
479\r
480 FragmentOffset = NTOHS (FragmentHead->FragmentOffset);\r
481\r
482 if (((FragmentOffset & 0x1) == 0x1) &&\r
483 !IP6_IS_MULTICAST (&Packet->Ip.Ip6->DestinationAddress))\r
484 {\r
485 Pointer = sizeof (UINT32);\r
486 Ip6SendIcmpError (\r
487 IpSb,\r
488 Packet,\r
489 NULL,\r
490 &Packet->Ip.Ip6->SourceAddress,\r
491 ICMP_V6_PARAMETER_PROBLEM,\r
492 0,\r
493 &Pointer\r
494 );\r
495 return FALSE;\r
496 }\r
497 }\r
498\r
499 if (Fragmented != NULL) {\r
500 *Fragmented = TRUE;\r
501 }\r
502\r
503 if (Rcvd && (FormerHeader != NULL)) {\r
504 *FormerHeader = (UINT32)(NextHeader - ExtHdrs);\r
505 }\r
506\r
507 NextHeader = ExtHdrs + Offset;\r
508 Offset = Offset + 8;\r
509 break;\r
a3bcde70 510\r
d1050b9d
MK
511 case IP6_AH:\r
512 if (++CountA > 1) {\r
513 return FALSE;\r
a3bcde70
HT
514 }\r
515\r
d1050b9d
MK
516 Option = ExtHdrs + Offset;\r
517 NextHeader = Option;\r
518 Option++;\r
a3bcde70 519 //\r
d1050b9d 520 // RFC2402, Payload length is specified in 32-bit words, minus "2".\r
a3bcde70 521 //\r
d1050b9d
MK
522 OptionLen = (UINT8)((*Option + 2) * 4);\r
523 Offset = Offset + OptionLen;\r
524 break;\r
a3bcde70 525\r
d1050b9d
MK
526 case IP6_NO_NEXT_HEADER:\r
527 *LastHeader = NextHeader;\r
a3bcde70 528 return FALSE;\r
d1050b9d 529 break;\r
a3bcde70 530\r
d1050b9d
MK
531 default:\r
532 if (Ip6IsValidProtocol (IpSb, *NextHeader)) {\r
533 *LastHeader = NextHeader;\r
a3bcde70 534\r
d1050b9d
MK
535 if (RealExtsLen != NULL) {\r
536 *RealExtsLen = Offset;\r
537 }\r
a3bcde70 538\r
d1050b9d
MK
539 return TRUE;\r
540 }\r
a3bcde70 541\r
a3bcde70 542 //\r
d1050b9d
MK
543 // The Next Header value is unrecognized by the node, discard the packet and\r
544 // send an ICMP parameter problem message with code value of 1.\r
a3bcde70 545 //\r
d1050b9d
MK
546 if (Offset == 0) {\r
547 //\r
548 // The Next Header directly follows IPv6 basic header.\r
549 //\r
550 Pointer = 6;\r
551 } else {\r
552 if (Pointer == 0) {\r
553 Pointer = sizeof (EFI_IP6_HEADER);\r
554 } else {\r
555 Pointer = Offset + sizeof (EFI_IP6_HEADER);\r
556 }\r
a3bcde70
HT
557 }\r
558\r
d1050b9d
MK
559 if ((IpSb != NULL) && (Packet != NULL) &&\r
560 !IP6_IS_MULTICAST (&Packet->Ip.Ip6->DestinationAddress))\r
561 {\r
a3bcde70
HT
562 Ip6SendIcmpError (\r
563 IpSb,\r
564 Packet,\r
565 NULL,\r
566 &Packet->Ip.Ip6->SourceAddress,\r
567 ICMP_V6_PARAMETER_PROBLEM,\r
d1050b9d 568 1,\r
a3bcde70
HT
569 &Pointer\r
570 );\r
a3bcde70 571 }\r
a3bcde70 572\r
a3bcde70 573 return FALSE;\r
a3bcde70
HT
574 }\r
575 }\r
576\r
577 *LastHeader = NextHeader;\r
578\r
579 if (RealExtsLen != NULL) {\r
580 *RealExtsLen = Offset;\r
581 }\r
582\r
583 return TRUE;\r
584}\r
585\r
586/**\r
587 Generate an IPv6 router alert option in network order and output it through Buffer.\r
588\r
589 @param[out] Buffer Points to a buffer to record the generated option.\r
590 @param[in, out] BufferLen The length of Buffer, in bytes.\r
591 @param[in] NextHeader The 8-bit selector indicates the type of header\r
592 immediately following the Hop-by-Hop Options header.\r
593\r
594 @retval EFI_BUFFER_TOO_SMALL The Buffer is too small to contain the generated\r
595 option. BufferLen is updated for the required size.\r
596\r
597 @retval EFI_SUCCESS The option is generated and filled in to Buffer.\r
598\r
599**/\r
600EFI_STATUS\r
601Ip6FillHopByHop (\r
d1050b9d
MK
602 OUT UINT8 *Buffer,\r
603 IN OUT UINTN *BufferLen,\r
604 IN UINT8 NextHeader\r
a3bcde70
HT
605 )\r
606{\r
d1050b9d 607 UINT8 BufferArray[8];\r
a3bcde70
HT
608\r
609 if (*BufferLen < 8) {\r
610 *BufferLen = 8;\r
611 return EFI_BUFFER_TOO_SMALL;\r
612 }\r
613\r
614 //\r
615 // Form the Hop-By-Hop option in network order.\r
616 // NextHeader (1 octet) + HdrExtLen (1 octet) + RouterAlertOption(4 octets) + PadN\r
617 // The Hdr Ext Len is the length in 8-octet units, and does not including the first 8 octets.\r
618 //\r
619 ZeroMem (BufferArray, sizeof (BufferArray));\r
620 BufferArray[0] = NextHeader;\r
621 BufferArray[2] = 0x5;\r
622 BufferArray[3] = 0x2;\r
623 BufferArray[6] = 1;\r
624\r
625 CopyMem (Buffer, BufferArray, sizeof (BufferArray));\r
626 return EFI_SUCCESS;\r
627}\r
628\r
629/**\r
630 Insert a Fragment Header to the Extension headers and output it in UpdatedExtHdrs.\r
631\r
632 @param[in] IpSb The IP6 service instance to transmit the packet.\r
633 @param[in] NextHeader The extension header type of first extension header.\r
634 @param[in] LastHeader The extension header type of last extension header.\r
635 @param[in] ExtHdrs The length of the original extension header.\r
636 @param[in] ExtHdrsLen The length of the extension headers.\r
637 @param[in] FragmentOffset The fragment offset of the data following the header.\r
638 @param[out] UpdatedExtHdrs The updated ExtHdrs with Fragment header inserted.\r
d1c85a17 639 It's caller's responsibility to free this buffer.\r
a3bcde70
HT
640\r
641 @retval EFI_OUT_OF_RESOURCES Failed to finish the operation due to lake of\r
642 resource.\r
643 @retval EFI_UNSUPPORTED The extension header specified in ExtHdrs is not\r
644 supported currently.\r
645 @retval EFI_SUCCESS The operation performed successfully.\r
646\r
647**/\r
648EFI_STATUS\r
649Ip6FillFragmentHeader (\r
d1050b9d
MK
650 IN IP6_SERVICE *IpSb,\r
651 IN UINT8 NextHeader,\r
652 IN UINT8 LastHeader,\r
653 IN UINT8 *ExtHdrs,\r
654 IN UINT32 ExtHdrsLen,\r
655 IN UINT16 FragmentOffset,\r
656 OUT UINT8 **UpdatedExtHdrs\r
a3bcde70
HT
657 )\r
658{\r
d1050b9d
MK
659 UINT32 Length;\r
660 UINT8 *Buffer;\r
661 UINT32 FormerHeader;\r
662 UINT32 Offset;\r
663 UINT32 Part1Len;\r
664 UINT32 HeaderLen;\r
665 UINT8 Current;\r
666 IP6_FRAGMENT_HEADER FragmentHead;\r
a3bcde70
HT
667\r
668 if (UpdatedExtHdrs == NULL) {\r
669 return EFI_INVALID_PARAMETER;\r
670 }\r
671\r
672 Length = ExtHdrsLen + sizeof (IP6_FRAGMENT_HEADER);\r
673 Buffer = AllocatePool (Length);\r
674 if (Buffer == NULL) {\r
675 return EFI_OUT_OF_RESOURCES;\r
676 }\r
677\r
d1050b9d
MK
678 Offset = 0;\r
679 Part1Len = 0;\r
680 FormerHeader = 0;\r
681 Current = NextHeader;\r
a3bcde70
HT
682\r
683 while ((ExtHdrs != NULL) && (Offset <= ExtHdrsLen)) {\r
684 switch (NextHeader) {\r
d1050b9d
MK
685 case IP6_ROUTING:\r
686 case IP6_HOP_BY_HOP:\r
687 case IP6_DESTINATION:\r
688 Current = NextHeader;\r
689 NextHeader = *(ExtHdrs + Offset);\r
690\r
691 if ((Current == IP6_DESTINATION) && (NextHeader != IP6_ROUTING)) {\r
692 //\r
693 // Destination Options header should occur at most twice, once before\r
694 // a Routing header and once before the upper-layer header. Here we\r
695 // find the one before the upper-layer header. Insert the Fragment\r
696 // Header before it.\r
697 //\r
698 CopyMem (Buffer, ExtHdrs, Part1Len);\r
699 *(Buffer + FormerHeader) = IP6_FRAGMENT;\r
700 //\r
701 // Exit the loop.\r
702 //\r
703 Offset = ExtHdrsLen + 1;\r
704 break;\r
705 }\r
a3bcde70 706\r
d1050b9d
MK
707 FormerHeader = Offset;\r
708 HeaderLen = (*(ExtHdrs + Offset + 1) + 1) * 8;\r
709 Part1Len = Part1Len + HeaderLen;\r
710 Offset = Offset + HeaderLen;\r
a3bcde70 711 break;\r
a3bcde70 712\r
d1050b9d
MK
713 case IP6_FRAGMENT:\r
714 Current = NextHeader;\r
a3bcde70 715\r
d1050b9d
MK
716 if (Part1Len != 0) {\r
717 CopyMem (Buffer, ExtHdrs, Part1Len);\r
718 }\r
a3bcde70 719\r
a3bcde70 720 *(Buffer + FormerHeader) = IP6_FRAGMENT;\r
d1050b9d 721\r
a3bcde70
HT
722 //\r
723 // Exit the loop.\r
724 //\r
725 Offset = ExtHdrsLen + 1;\r
726 break;\r
a3bcde70 727\r
d1050b9d
MK
728 case IP6_AH:\r
729 Current = NextHeader;\r
730 NextHeader = *(ExtHdrs + Offset);\r
731 //\r
732 // RFC2402, Payload length is specified in 32-bit words, minus "2".\r
733 //\r
734 HeaderLen = (*(ExtHdrs + Offset + 1) + 2) * 4;\r
735 Part1Len = Part1Len + HeaderLen;\r
736 Offset = Offset + HeaderLen;\r
737 break;\r
738\r
739 default:\r
740 if (Ip6IsValidProtocol (IpSb, NextHeader)) {\r
741 Current = NextHeader;\r
742 CopyMem (Buffer, ExtHdrs, Part1Len);\r
743 *(Buffer + FormerHeader) = IP6_FRAGMENT;\r
744 //\r
745 // Exit the loop.\r
746 //\r
747 Offset = ExtHdrsLen + 1;\r
748 break;\r
749 }\r
750\r
751 FreePool (Buffer);\r
752 return EFI_UNSUPPORTED;\r
a3bcde70
HT
753 }\r
754 }\r
755\r
756 //\r
757 // Append the Fragment header. If the fragment offset indicates the fragment\r
758 // is the first fragment.\r
759 //\r
760 if ((FragmentOffset & IP6_FRAGMENT_OFFSET_MASK) == 0) {\r
761 FragmentHead.NextHeader = Current;\r
762 } else {\r
763 FragmentHead.NextHeader = LastHeader;\r
764 }\r
765\r
766 FragmentHead.Reserved = 0;\r
767 FragmentHead.FragmentOffset = HTONS (FragmentOffset);\r
768 FragmentHead.Identification = mIp6Id;\r
769\r
770 CopyMem (Buffer + Part1Len, &FragmentHead, sizeof (IP6_FRAGMENT_HEADER));\r
771\r
772 if ((ExtHdrs != NULL) && (Part1Len < ExtHdrsLen)) {\r
773 //\r
774 // Append the part2 (fragmentable part) of Extension headers\r
775 //\r
776 CopyMem (\r
777 Buffer + Part1Len + sizeof (IP6_FRAGMENT_HEADER),\r
778 ExtHdrs + Part1Len,\r
779 ExtHdrsLen - Part1Len\r
780 );\r
781 }\r
782\r
783 *UpdatedExtHdrs = Buffer;\r
784\r
785 return EFI_SUCCESS;\r
786}\r