15a207
From 0000000000000000000000000000000000000000 Mon Sep 17 00:00:00 2001
15a207
From: Michael Chang <mchang@suse.com>
15a207
Date: Thu, 14 Jul 2016 17:48:45 +0800
15a207
Subject: [PATCH] efinet: Setting DNS server from UEFI protocol
15a207
15a207
In the URI device path node, any name rahter than address can be used for
15a207
looking up the resources so that DNS service become needed to get answer of the
15a207
name's address. Unfortunately the DNS is not defined in any of the device path
15a207
nodes so that we use the EFI_IP4_CONFIG2_PROTOCOL and EFI_IP6_CONFIG_PROTOCOL
15a207
to obtain it.
15a207
15a207
These two protcols are defined the sections of UEFI specification.
15a207
15a207
 27.5 EFI IPv4 Configuration II Protocol
15a207
 27.7 EFI IPv6 Configuration Protocol
15a207
15a207
include/grub/efi/api.h:
15a207
Add new structure and protocol UUID of EFI_IP4_CONFIG2_PROTOCOL and
15a207
EFI_IP6_CONFIG_PROTOCOL.
15a207
15a207
grub-core/net/drivers/efi/efinet.c:
15a207
Use the EFI_IP4_CONFIG2_PROTOCOL and EFI_IP6_CONFIG_PROTOCOL to obtain the list
15a207
of DNS server address for IPv4 and IPv6 respectively. The address of DNS
15a207
servers is structured into DHCPACK packet and feed into the same DHCP packet
15a207
processing functions to ensure the network interface is setting up the same way
15a207
it used to be.
15a207
15a207
Signed-off-by: Michael Chang <mchang@suse.com>
15a207
Signed-off-by: Ken Lin <ken.lin@hpe.com>
15a207
---
15a207
 grub-core/net/drivers/efi/efinet.c | 163 +++++++++++++++++++++++++++++++++++++
15a207
 include/grub/efi/api.h             |  76 +++++++++++++++++
15a207
 2 files changed, 239 insertions(+)
15a207
15a207
diff --git a/grub-core/net/drivers/efi/efinet.c b/grub-core/net/drivers/efi/efinet.c
15a207
index 431b72916b6..c25a68161b8 100644
15a207
--- a/grub-core/net/drivers/efi/efinet.c
15a207
+++ b/grub-core/net/drivers/efi/efinet.c
15a207
@@ -34,6 +34,8 @@ GRUB_MOD_LICENSE ("GPLv3+");
15a207
 /* GUID.  */
15a207
 static grub_efi_guid_t net_io_guid = GRUB_EFI_SIMPLE_NETWORK_GUID;
15a207
 static grub_efi_guid_t pxe_io_guid = GRUB_EFI_PXE_GUID;
15a207
+static grub_efi_guid_t ip4_config_guid = GRUB_EFI_IP4_CONFIG2_PROTOCOL_GUID;
15a207
+static grub_efi_guid_t ip6_config_guid = GRUB_EFI_IP6_CONFIG_PROTOCOL_GUID;
15a207
 
15a207
 static grub_err_t
15a207
 send_card_buffer (struct grub_net_card *dev,
15a207
@@ -413,6 +415,125 @@ grub_efinet_findcards (void)
15a207
     }
15a207
 }
15a207
 
15a207
+static grub_efi_handle_t
15a207
+grub_efi_locate_device_path (grub_efi_guid_t *protocol, grub_efi_device_path_t *device_path,
15a207
+			    grub_efi_device_path_t **r_device_path)
15a207
+{
15a207
+  grub_efi_handle_t handle;
15a207
+  grub_efi_status_t status;
15a207
+
15a207
+  status = efi_call_3 (grub_efi_system_table->boot_services->locate_device_path,
15a207
+		      protocol, &device_path, &handle);
15a207
+
15a207
+  if (status != GRUB_EFI_SUCCESS)
15a207
+    return 0;
15a207
+
15a207
+  if (r_device_path)
15a207
+    *r_device_path = device_path;
15a207
+
15a207
+  return handle;
15a207
+}
15a207
+
15a207
+static grub_efi_ipv4_address_t *
15a207
+grub_dns_server_ip4_address (grub_efi_device_path_t *dp, grub_efi_uintn_t *num_dns)
15a207
+{
15a207
+  grub_efi_handle_t hnd;
15a207
+  grub_efi_status_t status;
15a207
+  grub_efi_ip4_config2_protocol_t *conf;
15a207
+  grub_efi_ipv4_address_t *addrs;
15a207
+  grub_efi_uintn_t data_size = 1 * sizeof (grub_efi_ipv4_address_t);
15a207
+
15a207
+  hnd = grub_efi_locate_device_path (&ip4_config_guid, dp, NULL);
15a207
+
15a207
+  if (!hnd)
15a207
+    return 0;
15a207
+
15a207
+  conf = grub_efi_open_protocol (hnd, &ip4_config_guid,
15a207
+				GRUB_EFI_OPEN_PROTOCOL_GET_PROTOCOL);
15a207
+
15a207
+  if (!conf)
15a207
+    return 0;
15a207
+
15a207
+  addrs  = grub_malloc (data_size);
15a207
+  if (!addrs)
15a207
+    return 0;
15a207
+
15a207
+  status = efi_call_4 (conf->get_data, conf,
15a207
+		      GRUB_EFI_IP4_CONFIG2_DATA_TYPE_DNSSERVER,
15a207
+		      &data_size, addrs);
15a207
+
15a207
+  if (status == GRUB_EFI_BUFFER_TOO_SMALL)
15a207
+    {
15a207
+      grub_free (addrs);
15a207
+      addrs  = grub_malloc (data_size);
15a207
+      if (!addrs)
15a207
+	return 0;
15a207
+
15a207
+      status = efi_call_4 (conf->get_data,  conf,
15a207
+			  GRUB_EFI_IP4_CONFIG2_DATA_TYPE_DNSSERVER,
15a207
+			  &data_size, addrs);
15a207
+    }
15a207
+
15a207
+  if (status != GRUB_EFI_SUCCESS)
15a207
+    {
15a207
+      grub_free (addrs);
15a207
+      return 0;
15a207
+    }
15a207
+
15a207
+  *num_dns = data_size / sizeof (grub_efi_ipv4_address_t);
15a207
+  return addrs;
15a207
+}
15a207
+
15a207
+static grub_efi_ipv6_address_t *
15a207
+grub_dns_server_ip6_address (grub_efi_device_path_t *dp, grub_efi_uintn_t *num_dns)
15a207
+{
15a207
+  grub_efi_handle_t hnd;
15a207
+  grub_efi_status_t status;
15a207
+  grub_efi_ip6_config_protocol_t *conf;
15a207
+  grub_efi_ipv6_address_t *addrs;
15a207
+  grub_efi_uintn_t data_size = 1 * sizeof (grub_efi_ipv6_address_t);
15a207
+
15a207
+  hnd = grub_efi_locate_device_path (&ip6_config_guid, dp, NULL);
15a207
+
15a207
+  if (!hnd)
15a207
+    return 0;
15a207
+
15a207
+  conf = grub_efi_open_protocol (hnd, &ip6_config_guid,
15a207
+				GRUB_EFI_OPEN_PROTOCOL_GET_PROTOCOL);
15a207
+
15a207
+  if (!conf)
15a207
+    return 0;
15a207
+
15a207
+  addrs  = grub_malloc (data_size);
15a207
+  if (!addrs)
15a207
+    return 0;
15a207
+
15a207
+  status = efi_call_4 (conf->get_data, conf,
15a207
+		      GRUB_EFI_IP6_CONFIG_DATA_TYPE_DNSSERVER,
15a207
+		      &data_size, addrs);
15a207
+
15a207
+  if (status == GRUB_EFI_BUFFER_TOO_SMALL)
15a207
+    {
15a207
+      grub_free (addrs);
15a207
+      addrs  = grub_malloc (data_size);
15a207
+      if (!addrs)
15a207
+	return 0;
15a207
+
15a207
+      status = efi_call_4 (conf->get_data,  conf,
15a207
+			  GRUB_EFI_IP6_CONFIG_DATA_TYPE_DNSSERVER,
15a207
+			  &data_size, addrs);
15a207
+    }
15a207
+
15a207
+  if (status != GRUB_EFI_SUCCESS)
15a207
+    {
15a207
+      grub_free (addrs);
15a207
+      return 0;
15a207
+    }
15a207
+
15a207
+  *num_dns = data_size / sizeof (grub_efi_ipv6_address_t);
15a207
+  return addrs;
15a207
+}
15a207
+
15a207
 static struct grub_net_buff *
15a207
 grub_efinet_create_dhcp_ack_from_device_path (grub_efi_device_path_t *dp, int *use_ipv6)
15a207
 {
15a207
@@ -471,6 +592,8 @@ grub_efinet_create_dhcp_ack_from_device_path (grub_efi_device_path_t *dp, int *u
15a207
       grub_efi_ipv4_device_path_t *ipv4 = (grub_efi_ipv4_device_path_t *) ldp;
15a207
       struct grub_net_bootp_packet *bp;
15a207
       grub_uint8_t *ptr;
15a207
+      grub_efi_ipv4_address_t *dns;
15a207
+      grub_efi_uintn_t num_dns;
15a207
 
15a207
       bp = (struct grub_net_bootp_packet *) nb->tail;
15a207
       err = grub_netbuff_put (nb, sizeof (*bp) + 4);
15a207
@@ -532,6 +655,25 @@ grub_efinet_create_dhcp_ack_from_device_path (grub_efi_device_path_t *dp, int *u
15a207
       *ptr++ = sizeof ("HTTPClient") - 1;
15a207
       grub_memcpy (ptr, "HTTPClient", sizeof ("HTTPClient") - 1);
15a207
 
15a207
+      dns = grub_dns_server_ip4_address (dp, &num_dns);
15a207
+      if (dns)
15a207
+	{
15a207
+	  grub_efi_uintn_t size_dns = sizeof (*dns) * num_dns;
15a207
+
15a207
+	  ptr = nb->tail;
15a207
+	  err = grub_netbuff_put (nb, size_dns + 2);
15a207
+	  if (err)
15a207
+	    {
15a207
+	      grub_free (ddp);
15a207
+	      grub_netbuff_free (nb);
15a207
+	      return NULL;
15a207
+	    }
15a207
+	  *ptr++ = GRUB_NET_BOOTP_DNS;
15a207
+	  *ptr++ = size_dns;
15a207
+	  grub_memcpy (ptr, dns, size_dns);
15a207
+	  grub_free (dns);
15a207
+	}
15a207
+
15a207
       ptr = nb->tail;
15a207
       err = grub_netbuff_put (nb, 1);
15a207
       if (err)
15a207
@@ -564,6 +706,8 @@ grub_efinet_create_dhcp_ack_from_device_path (grub_efi_device_path_t *dp, int *u
15a207
       struct grub_net_dhcp6_option *opt;
15a207
       struct grub_net_dhcp6_option_iana *iana;
15a207
       struct grub_net_dhcp6_option_iaaddr *iaaddr;
15a207
+      grub_efi_ipv6_address_t *dns;
15a207
+      grub_efi_uintn_t num_dns;
15a207
 
15a207
       d6p = (struct grub_net_dhcp6_packet *)nb->tail;
15a207
       err = grub_netbuff_put (nb, sizeof(*d6p));
15a207
@@ -627,6 +771,25 @@ grub_efinet_create_dhcp_ack_from_device_path (grub_efi_device_path_t *dp, int *u
15a207
       opt->len = grub_cpu_to_be16 (uri_len);
15a207
       grub_memcpy (opt->data, uri_dp->uri, uri_len);
15a207
 
15a207
+      dns = grub_dns_server_ip6_address (dp, &num_dns);
15a207
+      if (dns)
15a207
+	{
15a207
+	  grub_efi_uintn_t size_dns = sizeof (*dns) * num_dns;
15a207
+
15a207
+	  opt = (struct grub_net_dhcp6_option *)nb->tail;
15a207
+	  err = grub_netbuff_put (nb, sizeof(*opt) + size_dns);
15a207
+	  if (err)
15a207
+	  {
15a207
+	    grub_free (ddp);
15a207
+	    grub_netbuff_free (nb);
15a207
+	    return NULL;
15a207
+	  }
15a207
+	  opt->code = grub_cpu_to_be16_compile_time (GRUB_NET_DHCP6_OPTION_DNS_SERVERS);
15a207
+	  opt->len = grub_cpu_to_be16 (size_dns);
15a207
+	  grub_memcpy (opt->data, dns, size_dns);
15a207
+	  grub_free (dns);
15a207
+	}
15a207
+
15a207
       *use_ipv6 = 1;
15a207
     }
15a207
 
15a207
diff --git a/include/grub/efi/api.h b/include/grub/efi/api.h
15a207
index 0b61f791850..80f6d79cfaf 100644
15a207
--- a/include/grub/efi/api.h
15a207
+++ b/include/grub/efi/api.h
15a207
@@ -334,6 +334,16 @@
15a207
       { 0x8B, 0x8C, 0xE2, 0x1B, 0x01, 0xAE, 0xF2, 0xB7 } \
15a207
   }
15a207
 
15a207
+#define GRUB_EFI_IP4_CONFIG2_PROTOCOL_GUID \
15a207
+  { 0x5b446ed1, 0xe30b, 0x4faa, \
15a207
+      { 0x87, 0x1a, 0x36, 0x54, 0xec, 0xa3, 0x60, 0x80 } \
15a207
+  }
15a207
+
15a207
+#define GRUB_EFI_IP6_CONFIG_PROTOCOL_GUID \
15a207
+  { 0x937fe521, 0x95ae, 0x4d1a, \
15a207
+      { 0x89, 0x29, 0x48, 0xbc, 0xd9, 0x0a, 0xd3, 0x1a } \
15a207
+  }
15a207
+
15a207
 struct grub_efi_sal_system_table
15a207
 {
15a207
   grub_uint32_t signature;
15a207
@@ -1842,6 +1852,72 @@ struct grub_efi_block_io
15a207
 };
15a207
 typedef struct grub_efi_block_io grub_efi_block_io_t;
15a207
 
15a207
+enum grub_efi_ip4_config2_data_type {
15a207
+  GRUB_EFI_IP4_CONFIG2_DATA_TYPE_INTERFACEINFO,
15a207
+  GRUB_EFI_IP4_CONFIG2_DATA_TYPE_POLICY,
15a207
+  GRUB_EFI_IP4_CONFIG2_DATA_TYPE_MANUAL_ADDRESS,
15a207
+  GRUB_EFI_IP4_CONFIG2_DATA_TYPE_GATEWAY,
15a207
+  GRUB_EFI_IP4_CONFIG2_DATA_TYPE_DNSSERVER,
15a207
+  GRUB_EFI_IP4_CONFIG2_DATA_TYPE_MAXIMUM
15a207
+};
15a207
+typedef enum grub_efi_ip4_config2_data_type grub_efi_ip4_config2_data_type_t;
15a207
+
15a207
+struct grub_efi_ip4_config2_protocol
15a207
+{
15a207
+  grub_efi_status_t (*set_data) (struct grub_efi_ip4_config2_protocol *this,
15a207
+				 grub_efi_ip4_config2_data_type_t data_type,
15a207
+				 grub_efi_uintn_t data_size,
15a207
+				 void *data);
15a207
+
15a207
+  grub_efi_status_t (*get_data) (struct grub_efi_ip4_config2_protocol *this,
15a207
+				 grub_efi_ip4_config2_data_type_t data_type,
15a207
+				 grub_efi_uintn_t *data_size,
15a207
+				 void *data);
15a207
+
15a207
+  grub_efi_status_t (*register_data_notify) (struct grub_efi_ip4_config2_protocol *this,
15a207
+					     grub_efi_ip4_config2_data_type_t data_type,
15a207
+					     grub_efi_event_t event);
15a207
+
15a207
+  grub_efi_status_t (*unregister_datanotify) (struct grub_efi_ip4_config2_protocol *this,
15a207
+					     grub_efi_ip4_config2_data_type_t data_type,
15a207
+					     grub_efi_event_t event);
15a207
+};
15a207
+typedef struct grub_efi_ip4_config2_protocol grub_efi_ip4_config2_protocol_t;
15a207
+
15a207
+enum grub_efi_ip6_config_data_type {
15a207
+  GRUB_EFI_IP6_CONFIG_DATA_TYPE_INTERFACEINFO,
15a207
+  GRUB_EFI_IP6_CONFIG_DATA_TYPE_ALT_INTERFACEID,
15a207
+  GRUB_EFI_IP6_CONFIG_DATA_TYPE_POLICY,
15a207
+  GRUB_EFI_IP6_CONFIG_DATA_TYPE_DUP_ADDR_DETECT_TRANSMITS,
15a207
+  GRUB_EFI_IP6_CONFIG_DATA_TYPE_MANUAL_ADDRESS,
15a207
+  GRUB_EFI_IP6_CONFIG_DATA_TYPE_GATEWAY,
15a207
+  GRUB_EFI_IP6_CONFIG_DATA_TYPE_DNSSERVER,
15a207
+  GRUB_EFI_IP6_CONFIG_DATA_TYPE_MAXIMUM
15a207
+};
15a207
+typedef enum grub_efi_ip6_config_data_type grub_efi_ip6_config_data_type_t;
15a207
+
15a207
+struct grub_efi_ip6_config_protocol
15a207
+{
15a207
+  grub_efi_status_t (*set_data) (struct grub_efi_ip6_config_protocol *this,
15a207
+				 grub_efi_ip6_config_data_type_t data_type,
15a207
+				 grub_efi_uintn_t data_size,
15a207
+				 void *data);
15a207
+
15a207
+  grub_efi_status_t (*get_data) (struct grub_efi_ip6_config_protocol *this,
15a207
+				 grub_efi_ip6_config_data_type_t data_type,
15a207
+				 grub_efi_uintn_t *data_size,
15a207
+				 void *data);
15a207
+
15a207
+  grub_efi_status_t (*register_data_notify) (struct grub_efi_ip6_config_protocol *this,
15a207
+					     grub_efi_ip6_config_data_type_t data_type,
15a207
+					     grub_efi_event_t event);
15a207
+
15a207
+  grub_efi_status_t (*unregister_datanotify) (struct grub_efi_ip6_config_protocol *this,
15a207
+					     grub_efi_ip6_config_data_type_t data_type,
15a207
+					     grub_efi_event_t event);
15a207
+};
15a207
+typedef struct grub_efi_ip6_config_protocol grub_efi_ip6_config_protocol_t;
15a207
+
15a207
 #if (GRUB_TARGET_SIZEOF_VOID_P == 4) || defined (__ia64__) \
15a207
   || defined (__aarch64__) || defined (__MINGW64__) || defined (__CYGWIN__)
15a207