2 Ihis library is only intended to be used by UEFI network stack modules.
3 It provides basic functions for the UEFI network stack.
5 Copyright (c) 2005 - 2009, Intel Corporation
6 All rights reserved. This program and the accompanying materials
7 are licensed and made available under the terms and conditions of the BSD License
8 which accompanies this distribution. The full text of the license may be found at
9 http://opensource.org/licenses/bsd-license.php
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
19 #include <Protocol/Ip6.h>
21 typedef UINT32 IP4_ADDR
;
22 typedef UINT32 TCP_SEQNO
;
23 typedef UINT16 TCP_PORTNO
;
26 NET_ETHER_ADDR_LEN
= 6,
27 NET_IFTYPE_ETHERNET
= 0x01,
29 EFI_IP_PROTO_UDP
= 0x11,
30 EFI_IP_PROTO_TCP
= 0x06,
31 EFI_IP_PROTO_ICMP
= 0x01,
34 // The address classification
51 IP6_NO_NEXT_HEADER
= 59
52 } IP6_EXTENSION_HEADER_TYPE
;
57 // Ethernet head definition
60 UINT8 DstMac
[NET_ETHER_ADDR_LEN
];
61 UINT8 SrcMac
[NET_ETHER_ADDR_LEN
];
67 // The EFI_IP4_HEADER is hard to use because the source and
68 // destination address are defined as EFI_IPv4_ADDRESS, which
69 // is a structure. Two structures can't be compared or masked
70 // directly. This is why there is an internal representation.
88 // ICMP head definition. Each ICMP message is categorized as either an error
89 // message or query message. Two message types have their own head format.
99 UINT32 Fourth
; // 4th filed of the head, it depends on Type.
101 } IP4_ICMP_ERROR_HEAD
;
107 } IP4_ICMP_QUERY_HEAD
;
118 EFI_IP6_HEADER IpHead
;
119 } IP6_ICMP_ERROR_HEAD
;
124 } IP6_ICMP_INFORMATION_HEAD
;
127 // UDP header definition
137 // TCP header definition
154 #define NET_MAC_EQUAL(pMac1, pMac2, Len) \
155 (CompareMem ((pMac1), (pMac2), Len) == 0)
157 #define NET_MAC_IS_MULTICAST(Mac, BMac, Len) \
158 (((*((UINT8 *) Mac) & 0x01) == 0x01) && (!NET_MAC_EQUAL (Mac, BMac, Len)))
160 #define NTOHL(x) (UINT32)((((UINT32) (x) & 0xff) << 24) | \
161 (((UINT32) (x) & 0xff00) << 8) | \
162 (((UINT32) (x) & 0xff0000) >> 8) | \
163 (((UINT32) (x) & 0xff000000) >> 24))
165 #define HTONL(x) NTOHL(x)
167 #define NTOHS(x) (UINT16)((((UINT16) (x) & 0xff) << 8) | \
168 (((UINT16) (x) & 0xff00) >> 8))
170 #define HTONS(x) NTOHS(x)
173 // Test the IP's attribute, All the IPs are in host byte order.
175 #define IP4_IS_MULTICAST(Ip) (((Ip) & 0xF0000000) == 0xE0000000)
176 #define IP4_IS_LOCAL_BROADCAST(Ip) ((Ip) == 0xFFFFFFFF)
177 #define IP4_NET_EQUAL(Ip1, Ip2, NetMask) (((Ip1) & (NetMask)) == ((Ip2) & (NetMask)))
178 #define IP4_IS_VALID_NETMASK(Ip) (NetGetMaskLength (Ip) != IP4_MASK_NUM)
180 #define IP6_IS_MULTICAST(Ip6) (((Ip6)->Addr[0]) == 0xFF)
183 // Convert the EFI_IP4_ADDRESS to plain UINT32 IP4 address.
185 #define EFI_IP4(EfiIpAddr) (*(IP4_ADDR *) ((EfiIpAddr).Addr))
186 #define EFI_NTOHL(EfiIp) (NTOHL (EFI_IP4 ((EfiIp))))
187 #define EFI_IP4_EQUAL(Ip1, Ip2) (CompareMem ((Ip1), (Ip2), sizeof (EFI_IPv4_ADDRESS)) == 0)
189 #define EFI_IP6_EQUAL(Ip1, Ip2) (CompareMem ((Ip1), (Ip2), sizeof (EFI_IPv6_ADDRESS)) == 0)
193 Return the length of the mask.
195 Return the length of the mask. Valid values are 0 to 32.
196 If the mask is invalid, return the invalid length 33, which is IP4_MASK_NUM.
197 NetMask is in the host byte order.
199 @param[in] NetMask The netmask to get the length from.
201 @return The length of the netmask, or IP4_MASK_NUM (33) if the mask is invalid.
211 Return the class of the IP address, such as class A, B, C.
212 Addr is in host byte order.
214 The address of class A starts with 0.
215 If the address belong to class A, return IP4_ADDR_CLASSA.
216 The address of class B starts with 10.
217 If the address belong to class B, return IP4_ADDR_CLASSB.
218 The address of class C starts with 110.
219 If the address belong to class C, return IP4_ADDR_CLASSC.
220 The address of class D starts with 1110.
221 If the address belong to class D, return IP4_ADDR_CLASSD.
222 The address of class E starts with 1111.
223 If the address belong to class E, return IP4_ADDR_CLASSE.
226 @param[in] Addr The address to get the class from.
228 @return IP address class, such as IP4_ADDR_CLASSA.
238 Check whether the IP is a valid unicast address according to
239 the netmask. If NetMask is zero, use the IP address's class to get the default mask.
241 If Ip is 0, IP is not a valid unicast address.
242 Class D address is used for multicasting and class E address is reserved for future. If Ip
243 belongs to class D or class E, Ip is not a valid unicast address.
244 If all bits of the host address of Ip are 0 or 1, Ip is not a valid unicast address.
246 @param[in] Ip The IP to check against.
247 @param[in] NetMask The mask of the IP.
249 @return TRUE if Ip is a valid unicast address on the network, otherwise FALSE.
260 Check whether the incoming IPv6 address is a valid unicast address.
262 If the address is a multicast address has binary 0xFF at the start, it is not
263 a valid unicast address. If the address is unspecified ::, it is not a valid
264 unicast address to be assigned to any node. If the address is loopback address
265 ::1, it is also not a valid unicast address to be assigned to any physical
268 @param[in] Ip6 The IPv6 address to check against.
270 @return TRUE if Ip6 is a valid unicast address on the network, otherwise FALSE.
275 IN EFI_IPv6_ADDRESS
*Ip6
278 extern IP4_ADDR gIp4AllMasks
[IP4_MASK_NUM
];
281 extern EFI_IPv4_ADDRESS mZeroIp4Addr
;
283 #define NET_IS_DIGIT(Ch) (('0' <= (Ch)) && ((Ch) <= '9'))
284 #define NET_ROUNDUP(size, unit) (((size) + (unit) - 1) & (~((unit) - 1)))
285 #define NET_IS_LOWER_CASE_CHAR(Ch) (('a' <= (Ch)) && ((Ch) <= 'z'))
286 #define NET_IS_UPPER_CASE_CHAR(Ch) (('A' <= (Ch)) && ((Ch) <= 'Z'))
288 #define TICKS_PER_MS 10000U
289 #define TICKS_PER_SECOND 10000000U
291 #define NET_RANDOM(Seed) ((UINT32) ((UINT32) (Seed) * 1103515245UL + 12345) % 4294967295UL)
294 Extract a UINT32 from a byte stream.
296 This function copies a UINT32 from a byte stream, and then converts it from Network
297 byte order to host byte order. Use this function to avoid alignment error.
299 @param[in] Buf The buffer to extract the UINT32.
301 @return The UINT32 extracted.
311 Puts a UINT32 into the byte stream in network byte order.
313 Converts a UINT32 from host byte order to network byte order, and then copies it to the
316 @param[in, out] Buf The buffer to put the UINT32.
317 @param[in] Data The data to put.
328 Initialize a random seed using current time.
330 Get current time first. Then initialize a random seed based on some basic
331 mathematical operations on the hour, day, minute, second, nanosecond and year
334 @return The random seed, initialized with current time.
344 #define NET_LIST_USER_STRUCT(Entry, Type, Field) \
345 BASE_CR(Entry, Type, Field)
347 #define NET_LIST_USER_STRUCT_S(Entry, Type, Field, Sig) \
348 CR(Entry, Type, Field, Sig)
351 // Iterate through the double linked list. It is NOT delete safe
353 #define NET_LIST_FOR_EACH(Entry, ListHead) \
354 for(Entry = (ListHead)->ForwardLink; Entry != (ListHead); Entry = Entry->ForwardLink)
357 // Iterate through the double linked list. This is delete-safe.
358 // Don't touch NextEntry. Also, don't use this macro if list
359 // entries other than the Entry may be deleted when processing
360 // the current Entry.
362 #define NET_LIST_FOR_EACH_SAFE(Entry, NextEntry, ListHead) \
363 for(Entry = (ListHead)->ForwardLink, NextEntry = Entry->ForwardLink; \
364 Entry != (ListHead); \
365 Entry = NextEntry, NextEntry = Entry->ForwardLink \
369 // Make sure the list isn't empty before getting the first/last record.
371 #define NET_LIST_HEAD(ListHead, Type, Field) \
372 NET_LIST_USER_STRUCT((ListHead)->ForwardLink, Type, Field)
374 #define NET_LIST_TAIL(ListHead, Type, Field) \
375 NET_LIST_USER_STRUCT((ListHead)->BackLink, Type, Field)
379 Remove the first node entry on the list, and return the removed node entry.
381 Removes the first node entry from a doubly linked list. It is up to the caller of
382 this function to release the memory used by the first node, if that is required. On
383 exit, the removed node is returned.
385 If Head is NULL, then ASSERT().
386 If Head was not initialized, then ASSERT().
387 If PcdMaximumLinkedListLength is not zero, and the number of nodes in the
388 linked list including the head node is greater than or equal to PcdMaximumLinkedListLength,
391 @param[in, out] Head The list header.
393 @return The first node entry that is removed from the list, NULL if the list is empty.
399 IN OUT LIST_ENTRY
*Head
403 Remove the last node entry on the list and return the removed node entry.
405 Removes the last node entry from a doubly linked list. It is up to the caller of
406 this function to release the memory used by the first node, if that is required. On
407 exit, the removed node is returned.
409 If Head is NULL, then ASSERT().
410 If Head was not initialized, then ASSERT().
411 If PcdMaximumLinkedListLength is not zero, and the number of nodes in the
412 linked list including the head node is greater than or equal to PcdMaximumLinkedListLength,
415 @param[in, out] Head The list head.
417 @return The last node entry that is removed from the list, NULL if the list is empty.
423 IN OUT LIST_ENTRY
*Head
427 Insert a new node entry after a designated node entry of a doubly linked list.
429 Inserts a new node entry designated by NewEntry after the node entry designated by PrevEntry
430 of the doubly linked list.
432 @param[in, out] PrevEntry The entry after which to insert.
433 @param[in, out] NewEntry The new entry to insert.
439 IN OUT LIST_ENTRY
*PrevEntry
,
440 IN OUT LIST_ENTRY
*NewEntry
444 Insert a new node entry before a designated node entry of a doubly linked list.
446 Inserts a new node entry designated by NewEntry before the node entry designated by PostEntry
447 of the doubly linked list.
449 @param[in, out] PostEntry The entry to insert before.
450 @param[in, out] NewEntry The new entry to insert.
455 NetListInsertBefore (
456 IN OUT LIST_ENTRY
*PostEntry
,
457 IN OUT LIST_ENTRY
*NewEntry
462 // Object container: EFI network stack spec defines various kinds of
463 // tokens. The drivers can share code to manage those objects.
477 #define NET_MAP_INCREAMENT 64
480 Initialize the netmap. Netmap is a reposity to keep the <Key, Value> pairs.
482 Initialize the forward and backward links of two head nodes donated by Map->Used
483 and Map->Recycled of two doubly linked lists.
484 Initializes the count of the <Key, Value> pairs in the netmap to zero.
486 If Map is NULL, then ASSERT().
487 If the address of Map->Used is NULL, then ASSERT().
488 If the address of Map->Recycled is NULl, then ASSERT().
490 @param[in, out] Map The netmap to initialize.
500 To clean up the netmap, that is, release allocated memories.
502 Removes all nodes of the Used doubly linked list and frees memory of all related netmap items.
503 Removes all nodes of the Recycled doubly linked list and free memory of all related netmap items.
504 The number of the <Key, Value> pairs in the netmap is set to zero.
506 If Map is NULL, then ASSERT().
508 @param[in, out] Map The netmap to clean up.
518 Test whether the netmap is empty and return true if it is.
520 If the number of the <Key, Value> pairs in the netmap is zero, return TRUE.
522 If Map is NULL, then ASSERT().
525 @param[in] Map The net map to test.
527 @return TRUE if the netmap is empty, otherwise FALSE.
537 Return the number of the <Key, Value> pairs in the netmap.
539 @param[in] Map The netmap to get the entry number.
541 @return The entry number in the netmap.
551 Allocate an item to save the <Key, Value> pair to the head of the netmap.
553 Allocate an item to save the <Key, Value> pair and add corresponding node entry
554 to the beginning of the Used doubly linked list. The number of the <Key, Value>
555 pairs in the netmap increase by 1.
557 If Map is NULL, then ASSERT().
559 @param[in, out] Map The netmap to insert into.
560 @param[in] Key The user's key.
561 @param[in] Value The user's value for the key.
563 @retval EFI_OUT_OF_RESOURCES Failed to allocate the memory for the item.
564 @retval EFI_SUCCESS The item is inserted to the head.
572 IN VOID
*Value OPTIONAL
576 Allocate an item to save the <Key, Value> pair to the tail of the netmap.
578 Allocate an item to save the <Key, Value> pair and add corresponding node entry
579 to the tail of the Used doubly linked list. The number of the <Key, Value>
580 pairs in the netmap increase by 1.
582 If Map is NULL, then ASSERT().
584 @param[in, out] Map The netmap to insert into.
585 @param[in] Key The user's key.
586 @param[in] Value The user's value for the key.
588 @retval EFI_OUT_OF_RESOURCES Failed to allocate the memory for the item.
589 @retval EFI_SUCCESS The item is inserted to the tail.
597 IN VOID
*Value OPTIONAL
601 Finds the key in the netmap and returns the point to the item containing the Key.
603 Iterate the Used doubly linked list of the netmap to get every item. Compare the key of every
604 item with the key to search. It returns the point to the item contains the Key if found.
606 If Map is NULL, then ASSERT().
608 @param[in] Map The netmap to search within.
609 @param[in] Key The key to search.
611 @return The point to the item contains the Key, or NULL if Key isn't in the map.
622 Remove the node entry of the item from the netmap and return the key of the removed item.
624 Remove the node entry of the item from the Used doubly linked list of the netmap.
625 The number of the <Key, Value> pairs in the netmap decrease by 1. Then add the node
626 entry of the item to the Recycled doubly linked list of the netmap. If Value is not NULL,
627 Value will point to the value of the item. It returns the key of the removed item.
629 If Map is NULL, then ASSERT().
630 If Item is NULL, then ASSERT().
631 if item in not in the netmap, then ASSERT().
633 @param[in, out] Map The netmap to remove the item from.
634 @param[in, out] Item The item to remove.
635 @param[out] Value The variable to receive the value if not NULL.
637 @return The key of the removed item.
644 IN OUT NET_MAP_ITEM
*Item
,
645 OUT VOID
**Value OPTIONAL
649 Remove the first node entry on the netmap and return the key of the removed item.
651 Remove the first node entry from the Used doubly linked list of the netmap.
652 The number of the <Key, Value> pairs in the netmap decrease by 1. Then add the node
653 entry to the Recycled doubly linked list of the netmap. If parameter Value is not NULL,
654 parameter Value will point to the value of the item. It returns the key of the removed item.
656 If Map is NULL, then ASSERT().
657 If the Used doubly linked list is empty, then ASSERT().
659 @param[in, out] Map The netmap to remove the head from.
660 @param[out] Value The variable to receive the value if not NULL.
662 @return The key of the item removed.
669 OUT VOID
**Value OPTIONAL
673 Remove the last node entry on the netmap and return the key of the removed item.
675 Remove the last node entry from the Used doubly linked list of the netmap.
676 The number of the <Key, Value> pairs in the netmap decrease by 1. Then add the node
677 entry to the Recycled doubly linked list of the netmap. If parameter Value is not NULL,
678 parameter Value will point to the value of the item. It returns the key of the removed item.
680 If Map is NULL, then ASSERT().
681 If the Used doubly linked list is empty, then ASSERT().
683 @param[in, out] Map The netmap to remove the tail from.
684 @param[out] Value The variable to receive the value if not NULL.
686 @return The key of the item removed.
693 OUT VOID
**Value OPTIONAL
698 (*NET_MAP_CALLBACK
) (
700 IN NET_MAP_ITEM
*Item
,
705 Iterate through the netmap and call CallBack for each item.
707 It will contiue the traverse if CallBack returns EFI_SUCCESS, otherwise, break
708 from the loop. It returns the CallBack's last return value. This function is
709 delete safe for the current item.
711 If Map is NULL, then ASSERT().
712 If CallBack is NULL, then ASSERT().
714 @param[in] Map The Map to iterate through.
715 @param[in] CallBack The callback function to call for each item.
716 @param[in] Arg The opaque parameter to the callback.
718 @retval EFI_SUCCESS There is no item in the netmap or CallBack for each item
720 @retval Others It returns the CallBack's last return value.
727 IN NET_MAP_CALLBACK CallBack
,
733 // Helper functions to implement driver binding and service binding protocols.
736 Create a child of the service that is identified by ServiceBindingGuid.
738 Get the ServiceBinding Protocol first, then use it to create a child.
740 If ServiceBindingGuid is NULL, then ASSERT().
741 If ChildHandle is NULL, then ASSERT().
743 @param[in] Controller The controller which has the service installed.
744 @param[in] Image The image handle used to open service.
745 @param[in] ServiceBindingGuid The service's Guid.
746 @param[in, out] ChildHandle The handle to receive the created child.
748 @retval EFI_SUCCESS The child was successfully created.
749 @retval Others Failed to create the child.
754 NetLibCreateServiceChild (
755 IN EFI_HANDLE Controller
,
757 IN EFI_GUID
*ServiceBindingGuid
,
758 IN OUT EFI_HANDLE
*ChildHandle
762 Destroy a child of the service that is identified by ServiceBindingGuid.
764 Get the ServiceBinding Protocol first, then use it to destroy a child.
766 If ServiceBindingGuid is NULL, then ASSERT().
768 @param[in] Controller The controller which has the service installed.
769 @param[in] Image The image handle used to open service.
770 @param[in] ServiceBindingGuid The service's Guid.
771 @param[in] ChildHandle The child to destroy.
773 @retval EFI_SUCCESS The child is successfully destroyed.
774 @retval Others Failed to destroy the child.
779 NetLibDestroyServiceChild (
780 IN EFI_HANDLE Controller
,
782 IN EFI_GUID
*ServiceBindingGuid
,
783 IN EFI_HANDLE ChildHandle
787 Convert the mac address of the simple network protocol installed on
788 SnpHandle to a unicode string. Callers are responsible for freeing the
791 Get the mac address of the Simple Network protocol from the SnpHandle. Then convert
792 the mac address into a unicode string. It takes 2 unicode characters to represent
793 a 1 byte binary buffer, plus one unicode character for the null terminator.
796 @param[in] SnpHandle The handle on which the simple network protocol is
798 @param[in] ImageHandle The image handle to act as the agent handle to
799 get the simple network protocol.
800 @param[out] MacString The pointer to store the address of the string
801 representation of the mac address.
803 @retval EFI_SUCCESS Converted the mac address a unicode string successfully.
804 @retval EFI_OUT_OF_RESOURCES There are not enough memory resources.
805 @retval Others Failed to open the simple network protocol.
811 IN EFI_HANDLE SnpHandle
,
812 IN EFI_HANDLE ImageHandle
,
813 OUT CHAR16
**MacString
817 Create an IPv4 device path node.
819 The header type of IPv4 device path node is MESSAGING_DEVICE_PATH.
820 The header subtype of IPv4 device path node is MSG_IPv4_DP.
821 The length of the IPv4 device path node in bytes is 19.
822 Get other info from parameters to make up the whole IPv4 device path node.
824 @param[in, out] Node Pointer to the IPv4 device path node.
825 @param[in] Controller The handle where the NIC IP4 config protocol resides.
826 @param[in] LocalIp The local IPv4 address.
827 @param[in] LocalPort The local port.
828 @param[in] RemoteIp The remote IPv4 address.
829 @param[in] RemotePort The remote port.
830 @param[in] Protocol The protocol type in the IP header.
831 @param[in] UseDefaultAddress Whether this instance is using default address or not.
836 NetLibCreateIPv4DPathNode (
837 IN OUT IPv4_DEVICE_PATH
*Node
,
838 IN EFI_HANDLE Controller
,
841 IN IP4_ADDR RemoteIp
,
842 IN UINT16 RemotePort
,
844 IN BOOLEAN UseDefaultAddress
848 Find the UNDI/SNP handle from controller and protocol GUID.
850 For example, IP will open an MNP child to transmit/receive
851 packets. When MNP is stopped, IP should also be stopped. IP
852 needs to find its own private data which is related the IP's
853 service binding instance that is install on UNDI/SNP handle.
854 Now, the controller is either a MNP or ARP child handle. But
855 IP opens these handle BY_DRIVER, use that info, we can get the
858 @param[in] Controller Then protocol handle to check.
859 @param[in] ProtocolGuid The protocol that is related with the handle.
861 @return The UNDI/SNP handle or NULL for errors.
867 IN EFI_HANDLE Controller
,
868 IN EFI_GUID
*ProtocolGuid
872 This is the default unload handle for all the network drivers.
874 Disconnect the driver specified by ImageHandle from all the devices in the handle database.
875 Uninstall all the protocols installed in the driver entry point.
877 @param[in] ImageHandle The drivers' driver image.
879 @retval EFI_SUCCESS The image is unloaded.
880 @retval Others Failed to unload the image.
885 NetLibDefaultUnload (
886 IN EFI_HANDLE ImageHandle
893 NET_BUF_SIGNATURE
= SIGNATURE_32 ('n', 'b', 'u', 'f'),
894 NET_VECTOR_SIGNATURE
= SIGNATURE_32 ('n', 'v', 'e', 'c'),
895 NET_QUE_SIGNATURE
= SIGNATURE_32 ('n', 'b', 'q', 'u'),
898 NET_PROTO_DATA
= 64, // Opaque buffer for protocols
899 NET_BUF_HEAD
= 1, // Trim or allocate space from head
900 NET_BUF_TAIL
= 0, // Trim or allocate space from tail
901 NET_VECTOR_OWN_FIRST
= 0x01 // We allocated the 1st block in the vector
902 } NET_SIGNATURE_TYPE
;
904 #define NET_CHECK_SIGNATURE(PData, SIGNATURE) \
905 ASSERT (((PData) != NULL) && ((PData)->Signature == (SIGNATURE)))
907 #define NET_SWAP_SHORT(Value) \
908 ((((Value) & 0xff) << 8) | (((Value) >> 8) & 0xff))
911 // Single memory block in the vector.
914 UINT32 Len
; // The block's length
915 UINT8
*Bulk
; // The block's Data
918 typedef VOID (*NET_VECTOR_EXT_FREE
) (VOID
*Arg
);
921 //NET_VECTOR contains several blocks to hold all packet's
922 //fragments and other house-keeping stuff for sharing. It
923 //doesn't specify the where actual packet fragment begins.
927 INTN RefCnt
; // Reference count to share NET_VECTOR.
928 NET_VECTOR_EXT_FREE Free
; // external function to free NET_VECTOR
929 VOID
*Arg
; // opeque argument to Free
930 UINT32 Flag
; // Flags, NET_VECTOR_OWN_FIRST
931 UINT32 Len
; // Total length of the assocated BLOCKs
938 //NET_BLOCK_OP operates on the NET_BLOCK. It specifies
939 //where the actual fragment begins and ends
942 UINT8
*BlockHead
; // Block's head, or the smallest valid Head
943 UINT8
*BlockTail
; // Block's tail. BlockTail-BlockHead=block length
944 UINT8
*Head
; // 1st byte of the data in the block
945 UINT8
*Tail
; // Tail of the data in the block, Tail-Head=Size
946 UINT32 Size
; // The size of the data
951 //NET_BUF is the buffer manage structure used by the
952 //network stack. Every network packet may be fragmented. The Vector points to
953 //memory blocks used by each fragment, and BlockOp
954 //specifies where each fragment begins and ends.
956 //It also contains an opaque area for the protocol to store
957 //per-packet information. Protocol must be careful not
958 //to overwrite the members after that.
963 LIST_ENTRY List
; // The List this NET_BUF is on
965 IP4_HEAD
*Ip
; // Network layer header, for fast access
966 TCP_HEAD
*Tcp
; // Transport layer header, for fast access
967 UINT8 ProtoData
[NET_PROTO_DATA
]; //Protocol specific data
969 NET_VECTOR
*Vector
; // The vector containing the packet
971 UINT32 BlockOpNum
; // Total number of BlockOp in the buffer
972 UINT32 TotalSize
; // Total size of the actual packet
973 NET_BLOCK_OP BlockOp
[1]; // Specify the position of actual packet
978 //A queue of NET_BUFs. It is a thin extension of
984 LIST_ENTRY List
; // The List this buffer queue is on
986 LIST_ENTRY BufList
; // list of queued buffers
987 UINT32 BufSize
; // total length of DATA in the buffers
988 UINT32 BufNum
; // total number of buffers on the chain
992 // Pseudo header for TCP and UDP checksum
1005 // The fragment entry table used in network interfaces. This is
1006 // the same as NET_BLOCK now. Use two different to distinguish
1007 // the two in case that NET_BLOCK be enhanced later.
1014 #define NET_GET_REF(PData) ((PData)->RefCnt++)
1015 #define NET_PUT_REF(PData) ((PData)->RefCnt--)
1016 #define NETBUF_FROM_PROTODATA(Info) BASE_CR((Info), NET_BUF, ProtoData)
1018 #define NET_BUF_SHARED(Buf) \
1019 (((Buf)->RefCnt > 1) || ((Buf)->Vector->RefCnt > 1))
1021 #define NET_VECTOR_SIZE(BlockNum) \
1022 (sizeof (NET_VECTOR) + ((BlockNum) - 1) * sizeof (NET_BLOCK))
1024 #define NET_BUF_SIZE(BlockOpNum) \
1025 (sizeof (NET_BUF) + ((BlockOpNum) - 1) * sizeof (NET_BLOCK_OP))
1027 #define NET_HEADSPACE(BlockOp) \
1028 (UINTN)((BlockOp)->Head - (BlockOp)->BlockHead)
1030 #define NET_TAILSPACE(BlockOp) \
1031 (UINTN)((BlockOp)->BlockTail - (BlockOp)->Tail)
1034 Allocate a single block NET_BUF. Upon allocation, all the
1035 free space is in the tail room.
1037 @param[in] Len The length of the block.
1039 @return Pointer to the allocated NET_BUF, or NULL if the
1040 allocation failed due to resource limit.
1050 Free the net buffer and its associated NET_VECTOR.
1052 Decrease the reference count of the net buffer by one. Free the associated net
1053 vector and itself if the reference count of the net buffer is decreased to 0.
1054 The net vector free operation decreases the reference count of the net
1055 vector by one, and performs the resource free operation when the reference count
1056 of the net vector is 0.
1058 @param[in] Nbuf Pointer to the NET_BUF to be freed.
1068 Get the index of NET_BLOCK_OP that contains the byte at Offset in the net
1071 For example, this function can be used to retrieve the IP header in the packet. It
1072 also can be used to get the fragment that contains the byte used
1073 mainly by the library implementation itself.
1075 @param[in] Nbuf Pointer to the net buffer.
1076 @param[in] Offset The offset of the byte.
1077 @param[out] Index Index of the NET_BLOCK_OP that contains the byte at
1080 @return Pointer to the Offset'th byte of data in the net buffer, or NULL
1081 if there is no such data in the net buffer.
1089 OUT UINT32
*Index OPTIONAL
1093 Create a copy of the net buffer that shares the associated net vector.
1095 The reference count of the newly created net buffer is set to 1. The reference
1096 count of the associated net vector is increased by one.
1098 @param[in] Nbuf Pointer to the net buffer to be cloned.
1100 @return Pointer to the cloned net buffer, or NULL if the
1101 allocation failed due to resource limit.
1111 Create a duplicated copy of the net buffer with data copied and HeadSpace
1112 bytes of head space reserved.
1114 The duplicated net buffer will allocate its own memory to hold the data of the
1117 @param[in] Nbuf Pointer to the net buffer to be duplicated from.
1118 @param[in, out] Duplicate Pointer to the net buffer to duplicate to, if
1119 NULL a new net buffer is allocated.
1120 @param[in] HeadSpace Length of the head space to reserve.
1122 @return Pointer to the duplicated net buffer, or NULL if
1123 the allocation failed due to resource limit.
1130 IN OUT NET_BUF
*Duplicate OPTIONAL
,
1135 Create a NET_BUF structure which contains Len byte data of Nbuf starting from
1138 A new NET_BUF structure will be created but the associated data in NET_VECTOR
1139 is shared. This function exists to do IP packet fragmentation.
1141 @param[in] Nbuf Pointer to the net buffer to be extracted.
1142 @param[in] Offset Starting point of the data to be included in the new
1144 @param[in] Len Bytes of data to be included in the new net buffer.
1145 @param[in] HeadSpace Bytes of head space to reserve for protocol header.
1147 @return Pointer to the cloned net buffer, or NULL if the
1148 allocation failed due to resource limit.
1161 Reserve some space in the header room of the net buffer.
1163 Upon allocation, all the space is in the tail room of the buffer. Call this
1164 function to move some space to the header room. This function is quite limited
1165 in that it can only reserve space from the first block of an empty NET_BUF not
1166 built from the external. But it should be enough for the network stack.
1168 @param[in, out] Nbuf Pointer to the net buffer.
1169 @param[in] Len The length of buffer to be reserved from the header.
1175 IN OUT NET_BUF
*Nbuf
,
1180 Allocate Len bytes of space from the header or tail of the buffer.
1182 @param[in, out] Nbuf Pointer to the net buffer.
1183 @param[in] Len The length of the buffer to be allocated.
1184 @param[in] FromHead The flag to indicate whether reserve the data
1185 from head (TRUE) or tail (FALSE).
1187 @return Pointer to the first byte of the allocated buffer,
1188 or NULL if there is no sufficient space.
1194 IN OUT NET_BUF
*Nbuf
,
1200 Trim Len bytes from the header or tail of the net buffer.
1202 @param[in, out] Nbuf Pointer to the net buffer.
1203 @param[in] Len The length of the data to be trimmed.
1204 @param[in] FromHead The flag to indicate whether trim data from head
1205 (TRUE) or tail (FALSE).
1207 @return Length of the actually trimmed data, which may be less
1208 than Len if the TotalSize of Nbuf is less than Len.
1214 IN OUT NET_BUF
*Nbuf
,
1220 Copy Len bytes of data from the specific offset of the net buffer to the
1223 The Len bytes of data may cross several fragments of the net buffer.
1225 @param[in] Nbuf Pointer to the net buffer.
1226 @param[in] Offset The sequence number of the first byte to copy.
1227 @param[in] Len Length of the data to copy.
1228 @param[in] Dest The destination of the data to copy to.
1230 @return The length of the actual copied data, or 0 if the offset
1231 specified exceeds the total size of net buffer.
1244 Build a NET_BUF from external blocks.
1246 A new NET_BUF structure will be created from external blocks. An additional block
1247 of memory will be allocated to hold reserved HeadSpace bytes of header room
1248 and existing HeadLen bytes of header, but the external blocks are shared by the
1249 net buffer to avoid data copying.
1251 @param[in] ExtFragment Pointer to the data block.
1252 @param[in] ExtNum The number of the data blocks.
1253 @param[in] HeadSpace The head space to be reserved.
1254 @param[in] HeadLen The length of the protocol header. The function
1255 pulls this amount of data into a linear block.
1256 @param[in] ExtFree Pointer to the caller-provided free function.
1257 @param[in] Arg The argument passed to ExtFree when ExtFree is
1260 @return Pointer to the net buffer built from the data blocks,
1261 or NULL if the allocation failed due to resource
1268 IN NET_FRAGMENT
*ExtFragment
,
1270 IN UINT32 HeadSpace
,
1272 IN NET_VECTOR_EXT_FREE ExtFree
,
1273 IN VOID
*Arg OPTIONAL
1277 Build a fragment table to contain the fragments in the net buffer. This is the
1278 opposite operation of the NetbufFromExt.
1280 @param[in] Nbuf Point to the net buffer.
1281 @param[in, out] ExtFragment Pointer to the data block.
1282 @param[in, out] ExtNum The number of the data blocks.
1284 @retval EFI_BUFFER_TOO_SMALL The number of non-empty blocks is bigger than
1286 @retval EFI_SUCCESS Fragment table is built successfully.
1293 IN OUT NET_FRAGMENT
*ExtFragment
,
1294 IN OUT UINT32
*ExtNum
1298 Build a net buffer from a list of net buffers.
1300 All the fragments will be collected from the list of NEW_BUF and then a new
1301 net buffer will be created through NetbufFromExt.
1303 @param[in] BufList A List of the net buffer.
1304 @param[in] HeadSpace The head space to be reserved.
1305 @param[in] HeaderLen The length of the protocol header. The function
1306 pulls this amount of data into a linear block.
1307 @param[in] ExtFree Pointer to the caller provided free function.
1308 @param[in] Arg The argument passed to ExtFree when ExtFree is called.
1310 @return Pointer to the net buffer built from the list of net
1317 IN LIST_ENTRY
*BufList
,
1318 IN UINT32 HeadSpace
,
1319 IN UINT32 HeaderLen
,
1320 IN NET_VECTOR_EXT_FREE ExtFree
,
1321 IN VOID
*Arg OPTIONAL
1325 Free a list of net buffers.
1327 @param[in, out] Head Pointer to the head of linked net buffers.
1333 IN OUT LIST_ENTRY
*Head
1337 Initiate the net buffer queue.
1339 @param[in, out] NbufQue Pointer to the net buffer queue to be initialized.
1345 IN OUT NET_BUF_QUEUE
*NbufQue
1349 Allocate and initialize a net buffer queue.
1351 @return Pointer to the allocated net buffer queue, or NULL if the
1352 allocation failed due to resource limit.
1362 Free a net buffer queue.
1364 Decrease the reference count of the net buffer queue by one. The real resource
1365 free operation isn't performed until the reference count of the net buffer
1366 queue is decreased to 0.
1368 @param[in] NbufQue Pointer to the net buffer queue to be freed.
1374 IN NET_BUF_QUEUE
*NbufQue
1378 Remove a net buffer from the head in the specific queue and return it.
1380 @param[in, out] NbufQue Pointer to the net buffer queue.
1382 @return Pointer to the net buffer removed from the specific queue,
1383 or NULL if there is no net buffer in the specific queue.
1389 IN OUT NET_BUF_QUEUE
*NbufQue
1393 Append a net buffer to the net buffer queue.
1395 @param[in, out] NbufQue Pointer to the net buffer queue.
1396 @param[in, out] Nbuf Pointer to the net buffer to be appended.
1402 IN OUT NET_BUF_QUEUE
*NbufQue
,
1403 IN OUT NET_BUF
*Nbuf
1407 Copy Len bytes of data from the net buffer queue at the specific offset to the
1410 The copying operation is the same as NetbufCopy but applies to the net buffer
1411 queue instead of the net buffer.
1413 @param[in] NbufQue Pointer to the net buffer queue.
1414 @param[in] Offset The sequence number of the first byte to copy.
1415 @param[in] Len Length of the data to copy.
1416 @param[out] Dest The destination of the data to copy to.
1418 @return The length of the actual copied data, or 0 if the offset
1419 specified exceeds the total size of net buffer queue.
1425 IN NET_BUF_QUEUE
*NbufQue
,
1432 Trim Len bytes of data from the queue header and release any net buffer
1433 that is trimmed wholely.
1435 The trimming operation is the same as NetbufTrim but applies to the net buffer
1436 queue instead of the net buffer.
1438 @param[in, out] NbufQue Pointer to the net buffer queue.
1439 @param[in] Len Length of the data to trim.
1441 @return The actual length of the data trimmed.
1447 IN OUT NET_BUF_QUEUE
*NbufQue
,
1453 Flush the net buffer queue.
1455 @param[in, out] NbufQue Pointer to the queue to be flushed.
1461 IN OUT NET_BUF_QUEUE
*NbufQue
1465 Compute the checksum for a bulk of data.
1467 @param[in] Bulk Pointer to the data.
1468 @param[in] Len Length of the data, in bytes.
1470 @return The computed checksum.
1483 @param[in] Checksum1 The first checksum to be added.
1484 @param[in] Checksum2 The second checksum to be added.
1486 @return The new checksum.
1492 IN UINT16 Checksum1
,
1497 Compute the checksum for a NET_BUF.
1499 @param[in] Nbuf Pointer to the net buffer.
1501 @return The computed checksum.
1511 Compute the checksum for TCP/UDP pseudo header.
1513 Src and Dst are in network byte order, and Len is in host byte order.
1515 @param[in] Src The source address of the packet.
1516 @param[in] Dst The destination address of the packet.
1517 @param[in] Proto The protocol type of the packet.
1518 @param[in] Len The length of the packet.
1520 @return The computed checksum.
1525 NetPseudoHeadChecksum (