X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=blobdiff_plain;f=MdeModulePkg%2FInclude%2FLibrary%2FNetLib.h;h=b9df46c50f63f73671654e246bdb37d8caf8d603;hp=4bb1f766a10937e515e3c9244a367370ca7b7a97;hb=29788f178e48fa5ffe7d3262d73c9548e9285d2d;hpb=57b301b569ec392b7bcad5f19a44fe93e0502a7f
diff --git a/MdeModulePkg/Include/Library/NetLib.h b/MdeModulePkg/Include/Library/NetLib.h
index 4bb1f766a1..b9df46c50f 100644
--- a/MdeModulePkg/Include/Library/NetLib.h
+++ b/MdeModulePkg/Include/Library/NetLib.h
@@ -2,7 +2,7 @@
This library is only intended to be used by UEFI network stack modules.
It provides basic functions for the UEFI network stack.
-Copyright (c) 2005 - 2011, Intel Corporation. All rights reserved.
+Copyright (c) 2005 - 2017, Intel Corporation. All rights reserved.
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
@@ -37,19 +37,24 @@ typedef UINT16 TCP_PORTNO;
#define EFI_IP_PROTO_ICMP 0x01
#define IP4_PROTO_IGMP 0x02
#define IP6_ICMP 58
+#define DNS_MAX_NAME_SIZE 255
+#define DNS_MAX_MESSAGE_SIZE 512
//
// The address classification
//
-#define IP4_ADDR_CLASSA 1
-#define IP4_ADDR_CLASSB 2
-#define IP4_ADDR_CLASSC 3
+#define IP4_ADDR_CLASSA 1 // Deprecated
+#define IP4_ADDR_CLASSB 2 // Deprecated
+#define IP4_ADDR_CLASSC 3 // Deprecated
#define IP4_ADDR_CLASSD 4
#define IP4_ADDR_CLASSE 5
#define IP4_MASK_NUM 33
#define IP6_PREFIX_NUM 129
+#define IP4_MASK_MAX 32
+#define IP6_PREFIX_MAX 128
+
#define IP6_HOP_BY_HOP 0
#define IP6_DESTINATION 60
#define IP6_ROUTING 43
@@ -61,6 +66,35 @@ typedef UINT16 TCP_PORTNO;
#define IP_VERSION_4 4
#define IP_VERSION_6 6
+#define IP6_PREFIX_LENGTH 64
+
+//
+// DNS QTYPE values
+//
+#define DNS_TYPE_A 1
+#define DNS_TYPE_NS 2
+#define DNS_TYPE_CNAME 5
+#define DNS_TYPE_SOA 6
+#define DNS_TYPE_WKS 11
+#define DNS_TYPE_PTR 12
+#define DNS_TYPE_HINFO 13
+#define DNS_TYPE_MINFO 14
+#define DNS_TYPE_MX 15
+#define DNS_TYPE_TXT 16
+#define DNS_TYPE_AAAA 28
+#define DNS_TYPE_SRV_RR 33
+#define DNS_TYPE_AXFR 252
+#define DNS_TYPE_MAILB 253
+#define DNS_TYPE_ANY 255
+
+//
+// DNS QCLASS values
+//
+#define DNS_CLASS_INET 1
+#define DNS_CLASS_CH 3
+#define DNS_CLASS_HS 4
+#define DNS_CLASS_ANY 255
+
#pragma pack(1)
//
@@ -197,9 +231,10 @@ typedef struct {
// Test the IP's attribute, All the IPs are in host byte order.
//
#define IP4_IS_MULTICAST(Ip) (((Ip) & 0xF0000000) == 0xE0000000)
+#define IP4_IS_UNSPECIFIED(Ip) ((Ip) == 0)
#define IP4_IS_LOCAL_BROADCAST(Ip) ((Ip) == 0xFFFFFFFF)
#define IP4_NET_EQUAL(Ip1, Ip2, NetMask) (((Ip1) & (NetMask)) == ((Ip2) & (NetMask)))
-#define IP4_IS_VALID_NETMASK(Ip) (NetGetMaskLength (Ip) != IP4_MASK_NUM)
+#define IP4_IS_VALID_NETMASK(Ip) (NetGetMaskLength (Ip) != (IP4_MASK_MAX + 1))
#define IP6_IS_MULTICAST(Ip6) (((Ip6)->Addr[0]) == 0xFF)
@@ -212,12 +247,13 @@ typedef struct {
#define EFI_IP6_EQUAL(Ip1, Ip2) (CompareMem ((Ip1), (Ip2), sizeof (EFI_IPv6_ADDRESS)) == 0)
+#define IP4_COPY_ADDRESS(Dest, Src) (CopyMem ((Dest), (Src), sizeof (EFI_IPv4_ADDRESS)))
#define IP6_COPY_ADDRESS(Dest, Src) (CopyMem ((Dest), (Src), sizeof (EFI_IPv6_ADDRESS)))
#define IP6_COPY_LINK_ADDRESS(Mac1, Mac2) (CopyMem ((Mac1), (Mac2), sizeof (EFI_MAC_ADDRESS)))
//
// The debug level definition. This value is also used as the
-// syslog's servity level. Don't change it.
+// syslog's severity level. Don't change it.
//
#define NETDEBUG_LEVEL_TRACE 5
#define NETDEBUG_LEVEL_WARNING 4
@@ -300,8 +336,8 @@ NetDebugASPrint (
This function will locate a instance of SNP then send the message through it.
Because it isn't open the SNP BY_DRIVER, apply caution when using it.
- @param Level The servity level of the message.
- @param Module The Moudle that generates the log.
+ @param Level The severity level of the message.
+ @param Module The Module that generates the log.
@param File The file that contains the log.
@param Line The exact line that contains the log.
@param Message The user message to log.
@@ -344,6 +380,11 @@ NetGetMaskLength (
Return the class of the IP address, such as class A, B, C.
Addr is in host byte order.
+ [ATTENTION]
+ Classful addressing (IP class A/B/C) has been deprecated according to RFC4632.
+ Caller of this function could only check the returned value against
+ IP4_ADDR_CLASSD (multicast) or IP4_ADDR_CLASSE (reserved) now.
+
The address of class A starts with 0.
If the address belong to class A, return IP4_ADDR_CLASSA.
The address of class B starts with 10.
@@ -369,17 +410,18 @@ NetGetIpClass (
/**
Check whether the IP is a valid unicast address according to
- the netmask. If NetMask is zero, use the IP address's class to get the default mask.
-
- If Ip is 0, IP is not a valid unicast address.
- Class D address is used for multicasting and class E address is reserved for future. If Ip
- belongs to class D or class E, Ip is not a valid unicast address.
- If all bits of the host address of Ip are 0 or 1, Ip is not a valid unicast address.
-
+ the netmask.
+
+ ASSERT if NetMask is zero.
+
+ If all bits of the host address of IP are 0 or 1, IP is also not a valid unicast address,
+ except when the originator is one of the endpoints of a point-to-point link with a 31-bit
+ mask (RFC3021).
+
@param[in] Ip The IP to check against.
@param[in] NetMask The mask of the IP.
- @return TRUE if Ip is a valid unicast address on the network, otherwise FALSE.
+ @return TRUE if IP is a valid unicast address on the network, otherwise FALSE.
**/
BOOLEAN
@@ -483,6 +525,7 @@ extern IP4_ADDR gIp4AllMasks[IP4_MASK_NUM];
extern EFI_IPv4_ADDRESS mZeroIp4Addr;
#define NET_IS_DIGIT(Ch) (('0' <= (Ch)) && ((Ch) <= '9'))
+#define NET_IS_HEX(Ch) ((('0' <= (Ch)) && ((Ch) <= '9')) || (('A' <= (Ch)) && ((Ch) <= 'F')) || (('a' <= (Ch)) && ((Ch) <= 'f')))
#define NET_ROUNDUP(size, unit) (((size) + (unit) - 1) & (~((unit) - 1)))
#define NET_IS_LOWER_CASE_CHAR(Ch) (('a' <= (Ch)) && ((Ch) <= 'z'))
#define NET_IS_UPPER_CASE_CHAR(Ch) (('A' <= (Ch)) && ((Ch) <= 'Z'))
@@ -527,13 +570,13 @@ NetPutUint32 (
);
/**
- Initialize a random seed using current time.
+ Initialize a random seed using current time and monotonic count.
- Get current time first. Then initialize a random seed based on some basic
- mathematical operations on the hour, day, minute, second, nanosecond and year
- of the current time.
+ Get current time and monotonic count first. Then initialize a random seed
+ based on some basic mathematics operation on the hour, day, minute, second,
+ nanosecond and year of the current time and the monotonic count value.
- @return The random seed, initialized with current time.
+ @return The random seed initialized with current time.
**/
UINT32
@@ -659,6 +702,73 @@ NetListInsertBefore (
IN OUT LIST_ENTRY *NewEntry
);
+/**
+ Callback function which provided by user to remove one node in NetDestroyLinkList process.
+
+ @param[in] Entry The entry to be removed.
+ @param[in] Context Pointer to the callback context corresponds to the Context in NetDestroyLinkList.
+
+ @retval EFI_SUCCESS The entry has been removed successfully.
+ @retval Others Fail to remove the entry.
+
+**/
+typedef
+EFI_STATUS
+(EFIAPI *NET_DESTROY_LINK_LIST_CALLBACK) (
+ IN LIST_ENTRY *Entry,
+ IN VOID *Context OPTIONAL
+ );
+
+/**
+ Safe destroy nodes in a linked list, and return the length of the list after all possible operations finished.
+
+ Destroy network children list by list traversals is not safe due to graph dependencies between nodes.
+ This function performs a safe traversal to destroy these nodes by checking to see if the node being destroyed
+ has been removed from the list or not.
+ If it has been removed, then restart the traversal from the head.
+ If it hasn't been removed, then continue with the next node directly.
+ This function will end the iterate and return the CallBack's last return value if error happens,
+ or retrun EFI_SUCCESS if 2 complete passes are made with no changes in the number of children in the list.
+
+ @param[in] List The head of the list.
+ @param[in] CallBack Pointer to the callback function to destroy one node in the list.
+ @param[in] Context Pointer to the callback function's context: corresponds to the
+ parameter Context in NET_DESTROY_LINK_LIST_CALLBACK.
+ @param[out] ListLength The length of the link list if the function returns successfully.
+
+ @retval EFI_SUCCESS Two complete passes are made with no changes in the number of children.
+ @retval EFI_INVALID_PARAMETER The input parameter is invalid.
+ @retval Others Return the CallBack's last return value.
+
+**/
+EFI_STATUS
+EFIAPI
+NetDestroyLinkList (
+ IN LIST_ENTRY *List,
+ IN NET_DESTROY_LINK_LIST_CALLBACK CallBack,
+ IN VOID *Context, OPTIONAL
+ OUT UINTN *ListLength OPTIONAL
+ );
+
+/**
+ This function checks the input Handle to see if it's one of these handles in ChildHandleBuffer.
+
+ @param[in] Handle Handle to be checked.
+ @param[in] NumberOfChildren Number of Handles in ChildHandleBuffer.
+ @param[in] ChildHandleBuffer An array of child handles to be freed. May be NULL
+ if NumberOfChildren is 0.
+
+ @retval TRUE Found the input Handle in ChildHandleBuffer.
+ @retval FALSE Can't find the input Handle in ChildHandleBuffer.
+
+**/
+BOOLEAN
+EFIAPI
+NetIsInHandleBuffer (
+ IN EFI_HANDLE Handle,
+ IN UINTN NumberOfChildren,
+ IN EFI_HANDLE *ChildHandleBuffer OPTIONAL
+ );
//
// Object container: EFI network stack spec defines various kinds of
@@ -906,7 +1016,7 @@ EFI_STATUS
/**
Iterate through the netmap and call CallBack for each item.
- It will contiue the traverse if CallBack returns EFI_SUCCESS, otherwise, break
+ It will continue the traverse if CallBack returns EFI_SUCCESS, otherwise, break
from the loop. It returns the CallBack's last return value. This function is
delete safe for the current item.
@@ -1084,7 +1194,8 @@ NetLibGetMacAddress (
@param[in] ServiceHandle The handle where network service binding protocol is
installed.
@param[in] ImageHandle The image handle used to act as the agent handle to
- get the simple network protocol.
+ get the simple network protocol. This parameter is
+ optional and may be NULL.
@param[out] MacString The pointer to store the address of the string
representation of the mac address.
@@ -1097,7 +1208,7 @@ EFI_STATUS
EFIAPI
NetLibGetMacString (
IN EFI_HANDLE ServiceHandle,
- IN EFI_HANDLE ImageHandle,
+ IN EFI_HANDLE ImageHandle, OPTIONAL
OUT CHAR16 **MacString
);
@@ -1205,7 +1316,7 @@ NetLibCreateIPv6DPathNode (
needs to find its own private data that is related the IP's
service binding instance that is installed on the UNDI/SNP handle.
The controller is then either an MNP or an ARP child handle. Note that
- IP opens these handles using BY_DRIVER. Use that infomation to get the
+ IP opens these handles using BY_DRIVER. Use that information to get the
UNDI/SNP handle.
@param[in] Controller The protocol handle to check.
@@ -1246,7 +1357,7 @@ NetLibDefaultUnload (
@param[out] Ip4Address The pointer to the converted IPv4 address.
@retval EFI_SUCCESS Converted to an IPv4 address successfully.
- @retval EFI_INVALID_PARAMETER The string is malformated, or Ip4Address is NULL.
+ @retval EFI_INVALID_PARAMETER The string is malformatted, or Ip4Address is NULL.
**/
EFI_STATUS
@@ -1258,13 +1369,13 @@ NetLibAsciiStrToIp4 (
/**
Convert one Null-terminated ASCII string to EFI_IPv6_ADDRESS. The format of the
- string is defined in RFC 4291 - Text Pepresentation of Addresses.
+ string is defined in RFC 4291 - Text Representation of Addresses.
@param[in] String The pointer to the Ascii string.
@param[out] Ip6Address The pointer to the converted IPv6 address.
@retval EFI_SUCCESS Converted to an IPv6 address successfully.
- @retval EFI_INVALID_PARAMETER The string is malformated, or Ip6Address is NULL.
+ @retval EFI_INVALID_PARAMETER The string is malformatted, or Ip6Address is NULL.
**/
EFI_STATUS
@@ -1281,8 +1392,7 @@ NetLibAsciiStrToIp6 (
@param[out] Ip4Address The pointer to the converted IPv4 address.
@retval EFI_SUCCESS Converted to an IPv4 address successfully.
- @retval EFI_INVALID_PARAMETER The string is mal-formated or Ip4Address is NULL.
- @retval EFI_OUT_OF_RESOURCES Failed to perform the operation due to lack of resources.
+ @retval EFI_INVALID_PARAMETER The string is mal-formatted or Ip4Address is NULL.
**/
EFI_STATUS
@@ -1294,14 +1404,13 @@ NetLibStrToIp4 (
/**
Convert one Null-terminated Unicode string to EFI_IPv6_ADDRESS. The format of
- the string is defined in RFC 4291 - Text Pepresentation of Addresses.
+ the string is defined in RFC 4291 - Text Representation of Addresses.
@param[in] String The pointer to the Ascii string.
@param[out] Ip6Address The pointer to the converted IPv6 address.
@retval EFI_SUCCESS Converted to an IPv6 address successfully.
- @retval EFI_INVALID_PARAMETER The string is malformated or Ip6Address is NULL.
- @retval EFI_OUT_OF_RESOURCES Failed to perform the operation due to a lack of resources.
+ @retval EFI_INVALID_PARAMETER The string is malformatted or Ip6Address is NULL.
**/
EFI_STATUS
@@ -1313,7 +1422,7 @@ NetLibStrToIp6 (
/**
Convert one Null-terminated Unicode string to EFI_IPv6_ADDRESS and prefix length.
- The format of the string is defined in RFC 4291 - Text Pepresentation of Addresses
+ The format of the string is defined in RFC 4291 - Text Representation of Addresses
Prefixes: ipv6-address/prefix-length.
@param[in] String The pointer to the Ascii string.
@@ -1321,8 +1430,7 @@ NetLibStrToIp6 (
@param[out] PrefixLength The pointer to the converted prefix length.
@retval EFI_SUCCESS Converted to an IPv6 address successfully.
- @retval EFI_INVALID_PARAMETER The string is malformated, or Ip6Address is NULL.
- @retval EFI_OUT_OF_RESOURCES Failed to perform the operation due to a lack of resources.
+ @retval EFI_INVALID_PARAMETER The string is malformatted, or Ip6Address is NULL.
**/
EFI_STATUS
@@ -1333,6 +1441,28 @@ NetLibStrToIp6andPrefix (
OUT UINT8 *PrefixLength
);
+/**
+
+ Convert one EFI_IPv6_ADDRESS to Null-terminated Unicode string.
+ The text representation of address is defined in RFC 4291.
+
+ @param[in] Ip6Address The pointer to the IPv6 address.
+ @param[out] String The buffer to return the converted string.
+ @param[in] StringSize The length in bytes of the input String.
+
+ @retval EFI_SUCCESS Convert to string successfully.
+ @retval EFI_INVALID_PARAMETER The input parameter is invalid.
+ @retval EFI_BUFFER_TOO_SMALL The BufferSize is too small for the result. BufferSize has been
+ updated with the size needed to complete the request.
+**/
+EFI_STATUS
+EFIAPI
+NetLibIp6ToStr (
+ IN EFI_IPv6_ADDRESS *Ip6Address,
+ OUT CHAR16 *String,
+ IN UINTN StringSize
+ );
+
//
// Various signatures
//
@@ -1368,9 +1498,9 @@ typedef struct {
UINT32 Signature;
INTN RefCnt; // Reference count to share NET_VECTOR.
NET_VECTOR_EXT_FREE Free; // external function to free NET_VECTOR
- VOID *Arg; // opeque argument to Free
+ VOID *Arg; // opaque argument to Free
UINT32 Flag; // Flags, NET_VECTOR_OWN_FIRST
- UINT32 Len; // Total length of the assocated BLOCKs
+ UINT32 Len; // Total length of the associated BLOCKs
UINT32 BlockNum;
NET_BLOCK Block[1];
@@ -1479,10 +1609,10 @@ typedef struct {
(sizeof (NET_BUF) + ((BlockOpNum) - 1) * sizeof (NET_BLOCK_OP))
#define NET_HEADSPACE(BlockOp) \
- (UINTN)((BlockOp)->Head - (BlockOp)->BlockHead)
+ ((UINTN)((BlockOp)->Head) - (UINTN)((BlockOp)->BlockHead))
#define NET_TAILSPACE(BlockOp) \
- (UINTN)((BlockOp)->BlockTail - (BlockOp)->Tail)
+ ((UINTN)((BlockOp)->BlockTail) - (UINTN)((BlockOp)->Tail))
/**
Allocate a single block NET_BUF. Upon allocation, all the
@@ -2036,4 +2166,24 @@ NetLibGetSystemGuid (
OUT EFI_GUID *SystemGuid
);
+/**
+ Create Dns QName according the queried domain name.
+ QName is a domain name represented as a sequence of labels,
+ where each label consists of a length octet followed by that
+ number of octets. The QName terminates with the zero
+ length octet for the null label of the root. Caller should
+ take responsibility to free the buffer in returned pointer.
+
+ @param DomainName The pointer to the queried domain name string.
+
+ @retval NULL Failed to fill QName.
+ @return QName filled successfully.
+
+**/
+CHAR8 *
+EFIAPI
+NetLibCreateDnsQName (
+ IN CHAR16 *DomainName
+ );
+
#endif