Skip to contentSkip to conversation

Search for specific config files using UUID, MAC and IP

PATCH Superseded Javier Martinez Canillas 4 participants 13 messages Oct 29, 2019 – Dec 13, 2019 Networking

v5 of 6 Superseded Latest is v6 →

lore
Share & tools
lore
#0 lore raw

v5 cover Search for specific config files using UUID, MAC and IP

Hello,

This is a v5 of a series that have been carried in Fedora (and other distros) for a long time. It allows to fetch GRUB configurations that are customized to each machine by using the client UUID, MAC and IP as grub.cfg suffixes.

The procedure is similar to what is used by pxelinux and yaboot, i.e:
http://www.syslinux.org/wiki/index.php/PXELINUX#config

Patch #1 adds a %X format specifier to make the grub_printf() function more similar to printf() and not require to use %x plus grub_toupper().

Patch #2 is just a cleanup of the bootp/dhcp options enum to consistently use hexadecimal numbers for all the values.

Patch #3 sets net_<interface>_client{id,uuid} environment variables by using the DHCP client ID and UUID options if these are found.

Patch #4 adds the support to fetch the config files using the UUID, MAC and IP as suffixes. If these aren't found, the default GRUB config filename is used as a fallback.

Patch #5 adds documentation that specifies the order netboot clients use to select a grub configuration file.

Best regards,
Javier

Changes in v5:
- Add Reviewed-by from Daniel Kiper to patch #2.
- Don't mix variable declaration and code.
- Don't initialize variable without need.
- Check for memory allocation failure.
- Add missing grub_free().
- Don't mix varible declarations and code.
- Don't use variable length arrays.
- Fix coding style issues.
- Fix function prototype.
- Include missing <grub/net.h> header.
- Add Reviewed-by tag from Daniel Kiper to patch #5.

Changes in v4:
- Use decimal instead of hexadecimal numbers to be consistent with RFC 2132.
- Mention that the UUID is unique to the machine and not the NIC and also refer to the RFC 4578 where the client UUID DHCP option is specified.

Changes in v3:
- Add patch to cleanup bootp/dhcp options enum.
- Use decimal numbers for the newly added DHCP client ID and UUID options.
- Add Reviewed-by tag from Daniel Kiper.
- Add a patch documenting the grub.cfg netboot selection order.

Changes in v2:
- Put patch that adds the %X format specifier first in the series.
- Use the existing grub_env_set_net_property() and remove duplicated code.

Javier Martinez Canillas (1):
net/dhcp: Consistently use decimal numbers for DHCP/BOOTP options enum

Paulo Flabiano Smorigo (3):
Add %X option to printf functions
net/dhcp: Set net_<interface>_client{id,uuid} variables from DHCP
options
normal/main: Search for specific config files for netboot

Robert Marshall (1):
docs: Update info with grub.cfg netboot selection order

 docs/grub.texi          |  46 ++++++++++++++
 grub-core/kern/misc.c   |   7 ++-
 grub-core/net/bootp.c   |  52 +++++++++++++---
 grub-core/net/net.c     | 131 ++++++++++++++++++++++++++++++++++++++++
 grub-core/normal/main.c |  19 ++++--
 include/grub/net.h      |  22 ++++---
 6 files changed, 254 insertions(+), 23 deletions(-)
Signature · 1 line
2.21.0
#1 lore raw

PATCH v5 1/5 Add %X option to printf functions

From: Paulo Flabiano Smorigo <[email protected]>

The printf(3) function has support for the %X format specifier, to output an unsigned hexadecimal integer in uppercase.

This can be achived in GRUB using the %x format specifier in grub_printf() and calling grub_toupper(), but it is more convenient if there is support for %X in grub_printf().

---

Changes in v5: None
Changes in v4: None
Changes in v3: None
Changes in v2:
- Put patch that adds the %X format specifier first in the series.

 grub-core/kern/misc.c | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)
kern/misc.c +5 -2
index 3b633d51f4c..76e7fb22872 100644
@@ -588,7 +588,7 @@ grub_divmod64 (grub_uint64_t n, grub_uint64_t d, grub_uint64_t *r)
 static inline char *
 grub_lltoa (char *str, int c, unsigned long long n)
 {
-  unsigned base = (c == 'x') ? 16 : 10;
+  unsigned base = ((c == 'x') || (c == 'X')) ? 16 : 10;
   char *p;
 
   if ((long long) n < 0 && c == 'd')
@@ -603,7 +603,7 @@ grub_lltoa (char *str, int c, unsigned long long n)
     do
       {
 	unsigned d = (unsigned) (n & 0xf);
-	*p++ = (d > 9) ? d + 'a' - 10 : d + '0';
+	*p++ = (d > 9) ? d + ((c == 'x') ? 'a' : 'A') - 10 : d + '0';
       }
     while (n >>= 4);
   else
@@ -676,6 +676,7 @@ parse_printf_args (const char *fmt0, struct printf_args *args,
 	{
 	case 'p':
 	case 'x':
+	case 'X':
 	case 'u':
 	case 'd':
 	case 'c':
@@ -762,6 +763,7 @@ parse_printf_args (const char *fmt0, struct printf_args *args,
       switch (c)
 	{
 	case 'x':
+	case 'X':
 	case 'u':
 	  args->ptr[curn].type = UNSIGNED_INT + longfmt;
 	  break;
@@ -900,6 +902,7 @@ grub_vsnprintf_real (char *str, grub_size_t max_len, const char *fmt0,
 	  c = 'x';
 	  /* Fall through. */
 	case 'x':
+	case 'X':
 	case 'u':
 	case 'd':
 	  {
Signature · 1 line
2.21.0
#2 lore raw

PATCH v5 2/5 net/dhcp: Consistently use decimal numbers for DHCP/BOOTP options enum

In reply to Javier Martinez Canillas

The DHCP Options and BOOTP Vendor Extensions enum values are a mixture of decimal and hexadecimal numbers. Change this to consistently use decimal numbers for all since that is how these values are defined by RFC 2132.

---

Changes in v5:
- Add Reviewed-by from Daniel Kiper to patch #2.

Changes in v4:
- Use decimal instead of hexadecimal numbers to be consistent with RFC 2132.

Changes in v3:
- Add patch to cleanup bootp/dhcp options enum.

Changes in v2: None

 include/grub/net.h | 18 +++++++++---------
 1 file changed, 9 insertions(+), 9 deletions(-)
grub/net.h +9 -9
index 4a9069a1474..b5fedb28b9c 100644
@@ -454,14 +454,14 @@ struct grub_net_bootp_packet
 
 enum
   {
-    GRUB_NET_BOOTP_PAD = 0x00,
-    GRUB_NET_BOOTP_NETMASK = 0x01,
-    GRUB_NET_BOOTP_ROUTER = 0x03,
-    GRUB_NET_BOOTP_DNS = 0x06,
-    GRUB_NET_BOOTP_HOSTNAME = 0x0c,
-    GRUB_NET_BOOTP_DOMAIN = 0x0f,
-    GRUB_NET_BOOTP_ROOT_PATH = 0x11,
-    GRUB_NET_BOOTP_EXTENSIONS_PATH = 0x12,
+    GRUB_NET_BOOTP_PAD = 0,
+    GRUB_NET_BOOTP_NETMASK = 1,
+    GRUB_NET_BOOTP_ROUTER = 3,
+    GRUB_NET_BOOTP_DNS = 6,
+    GRUB_NET_BOOTP_HOSTNAME = 12,
+    GRUB_NET_BOOTP_DOMAIN = 15,
+    GRUB_NET_BOOTP_ROOT_PATH = 17,
+    GRUB_NET_BOOTP_EXTENSIONS_PATH = 18,
     GRUB_NET_DHCP_REQUESTED_IP_ADDRESS = 50,
     GRUB_NET_DHCP_OVERLOAD = 52,
     GRUB_NET_DHCP_MESSAGE_TYPE = 53,
@@ -469,7 +469,7 @@ enum
     GRUB_NET_DHCP_PARAMETER_REQUEST_LIST = 55,
     GRUB_NET_DHCP_TFTP_SERVER_NAME = 66,
     GRUB_NET_DHCP_BOOTFILE_NAME = 67,
-    GRUB_NET_BOOTP_END = 0xff
+    GRUB_NET_BOOTP_END = 255
   };
 
 struct grub_net_network_level_interface *
Signature · 1 line
2.21.0
#3 lore raw

PATCH v5 3/5 net/dhcp: Set net_<interface>_client{id, uuid} variables from DHCP options

In reply to Javier Martinez Canillas

From: Paulo Flabiano Smorigo <[email protected]>

This patch sets a net_<interface>_clientid and net_<interface>_clientuuid GRUB environment variables, using the DHCP client ID and UUID options if these are found.

In the same way than net_<interface>_<option> variables are set for other options such domain name, boot file, next server, etc.

---

Changes in v5:
- Don't mix variable declaration and code.
- Don't initialize variable without need.
- Check for memory allocation failure.
- Add missing grub_free().

Changes in v4: None
Changes in v3:
- Use decimal numbers for the newly added DHCP client ID and UUID options.

Changes in v2:
- Use the existing grub_env_set_net_property() and remove duplicated code.

 grub-core/net/bootp.c | 52 ++++++++++++++++++++++++++++++++++++-------
 include/grub/net.h    |  2 ++
 2 files changed, 46 insertions(+), 8 deletions(-)
net/bootp.c +44 -8
index 04cfbb04504..351ec2b4565 100644
@@ -95,6 +95,14 @@ enum
 /* Max timeout when waiting for BOOTP/DHCP reply */
 #define GRUB_DHCP_MAX_PACKET_TIMEOUT 32
 
+static char
+hexdigit (grub_uint8_t val)
+{
+  if (val < 10)
+    return val + '0';
+  return val + 'a' - 10;
+}
+
 static const void *
 find_dhcp_option (const struct grub_net_bootp_packet *bp, grub_size_t size,
 		  grub_uint8_t opt_code, grub_uint8_t *opt_len)
@@ -152,6 +160,9 @@ again:
       if (i + taglength >= size)
 	return NULL;
 
+      grub_dprintf("net", "DHCP option %u (0x%02x) found with length %u.\n",
+                   tagtype, tagtype, taglength);
+
       /* FIXME RFC 3396 options concatentation */
       if (tagtype == opt_code)
 	{
@@ -406,6 +417,39 @@ grub_net_configure_by_dhcp_ack (const char *name,
   if (opt && opt_len)
     grub_env_set_net_property (name, "extensionspath", (const char *) opt, opt_len);
   
+  opt = find_dhcp_option (bp, size, GRUB_NET_BOOTP_CLIENT_ID, &opt_len);
+  if (opt && opt_len)
+    grub_env_set_net_property (name, "clientid", (const char *) opt, opt_len);
+
+  opt = find_dhcp_option (bp, size, GRUB_NET_BOOTP_CLIENT_UUID, &opt_len);
+  if (opt && opt_len == 17)
+    {
+      /* The format is 9cfe245e-d0c8-bd45-a79f-54ea5fbd3d97 */
+      char *val;
+      int i, j = 0;
+
+      opt += 1;
+      opt_len -= 1;
+
+      val = grub_malloc (2 * opt_len + 4 + 1);
+      if (!val)
+          return inter;
+
+      for (i = 0; i < opt_len; i++)
+        {
+          val[2 * i + j] = hexdigit (opt[i] >> 4);
+          val[2 * i + 1 + j] = hexdigit (opt[i] & 0xf);
+
+          if ((i == 3) || (i == 5) || (i == 7) || (i == 9))
+            {
+              j++;
+              val[2 * i + 1+ j] = '-';
+            }
+        }
+      grub_env_set_net_property (name, "clientuuid", (char *) val, 2 * opt_len + 4);
+      grub_free (val);
+    }
+
   inter->dhcp_ack = grub_malloc (size);
   if (inter->dhcp_ack)
     {
@@ -631,14 +675,6 @@ grub_net_process_dhcp (struct grub_net_buff *nb,
     }
 }
 
-static char
-hexdigit (grub_uint8_t val)
-{
-  if (val < 10)
-    return val + '0';
-  return val + 'a' - 10;
-}
-
 static grub_err_t
 grub_cmd_dhcpopt (struct grub_command *cmd __attribute__ ((unused)),
 		  int argc, char **args)
grub/net.h +2 -0
index b5fedb28b9c..c00b0ab117c 100644
@@ -467,8 +467,10 @@ enum
     GRUB_NET_DHCP_MESSAGE_TYPE = 53,
     GRUB_NET_DHCP_SERVER_IDENTIFIER = 54,
     GRUB_NET_DHCP_PARAMETER_REQUEST_LIST = 55,
+    GRUB_NET_BOOTP_CLIENT_ID = 61,
     GRUB_NET_DHCP_TFTP_SERVER_NAME = 66,
     GRUB_NET_DHCP_BOOTFILE_NAME = 67,
+    GRUB_NET_BOOTP_CLIENT_UUID = 97,
     GRUB_NET_BOOTP_END = 255
   };
 
Signature · 1 line
2.21.0
#4 lore raw

PATCH v5 4/5 normal/main: Search for specific config files for netboot

In reply to Javier Martinez Canillas

From: Paulo Flabiano Smorigo <[email protected]>

This patch implements a search for a specific configuration when the config file is on a remoteserver. It uses the following order:
1) DHCP client UUID option.
2) MAC address (in lower case hexadecimal with dash separators);
3) IP (in upper case hexadecimal) or IPv6;
4) The original grub.cfg file.

This procedure is similar to what is used by pxelinux and yaboot:
http://www.syslinux.org/wiki/index.php/PXELINUX#config

---

Changes in v5:
- Don't mix varible declarations and code.
- Don't use variable length arrays.
- Fix coding style issues.
- Fix function prototype.
- Include missing <grub/net.h> header.

Changes in v4: None
Changes in v3:
- Add Reviewed-by tag from Daniel Kiper.

Changes in v2: None

 grub-core/net/net.c     | 131 ++++++++++++++++++++++++++++++++++++++++
 grub-core/normal/main.c |  19 ++++--
 include/grub/net.h      |   2 +
 3 files changed, 148 insertions(+), 4 deletions(-)
net/net.c +131 -0
index d5d726a315e..f82ac15b4ec 100644
@@ -1735,6 +1735,137 @@ grub_net_restore_hw (void)
   return GRUB_ERR_NONE;
 }
 
+grub_err_t
+grub_net_search_config_file (char *config)
+{
+  grub_size_t config_len;
+  char *suffix;
+
+  auto int search_through (grub_size_t num_tries, grub_size_t slice_size);
+  int search_through (grub_size_t num_tries, grub_size_t slice_size)
+  {
+    while (num_tries-- > 0)
+      {
+        grub_file_t file;
+
+        grub_dprintf ("net", "attempt to fetch config %s\n", config);
+
+        file = grub_file_open (config, GRUB_FILE_TYPE_CONFIG);
+
+        if (file)
+          {
+            grub_file_close (file);
+            return 0;
+          }
+        else
+          {
+            if (grub_errno == GRUB_ERR_IO)
+              grub_errno = GRUB_ERR_NONE;
+          }
+
+        if (grub_strlen (suffix) < slice_size)
+          break;
+
+        config[grub_strlen (config) - slice_size] = '\0';
+      }
+
+    return 1;
+  }
+
+  config_len = grub_strlen (config);
+  config[config_len] = '-';
+  suffix = config + config_len + 1;
+
+  struct grub_net_network_level_interface *inf;
+  FOR_NET_NETWORK_LEVEL_INTERFACES (inf)
+    {
+      /* By the Client UUID. */
+      char *ptr;
+      int client_uuid_len;
+      char *client_uuid_var;
+      const char *client_uuid;
+
+      client_uuid_len = sizeof ("net_") + grub_strlen (inf->name) +
+                        sizeof ("_clientuuid") + 1;
+
+      client_uuid_var = grub_zalloc (client_uuid_len);
+      if (!client_uuid_var)
+        return grub_errno;
+
+      grub_snprintf (client_uuid_var, client_uuid_len,
+                     "net_%s_clientuuid", inf->name);
+
+      client_uuid = grub_env_get (client_uuid_var);
+      grub_free (client_uuid_var);
+
+      if (client_uuid)
+        {
+          grub_strcpy (suffix, client_uuid);
+          if (search_through (1, 0) == 0)
+            return GRUB_ERR_NONE;
+        }
+
+      /* By the MAC address. */
+
+      /* Add ethernet type */
+      grub_strcpy (suffix, "01-");
+
+      grub_net_hwaddr_to_str (&inf->hwaddress, suffix + 3);
+
+      for (ptr = suffix; *ptr; ptr++)
+        if (*ptr == ':')
+          *ptr = '-';
+
+      if (search_through (1, 0) == 0)
+        return GRUB_ERR_NONE;
+
+      /* By IP address */
+
+      switch ((&inf->address)->type)
+        {
+        case GRUB_NET_NETWORK_LEVEL_PROTOCOL_IPV4:
+          {
+            grub_uint32_t n = grub_be_to_cpu32 ((&inf->address)->ipv4);
+
+            grub_snprintf (suffix, GRUB_NET_MAX_STR_ADDR_LEN, "%02X%02X%02X%02X", \
+                           ((n >> 24) & 0xff), ((n >> 16) & 0xff),      \
+                           ((n >> 8) & 0xff), ((n >> 0) & 0xff));
+
+            if (search_through (8, 1) == 0)
+              return GRUB_ERR_NONE;
+            break;
+          }
+        case GRUB_NET_NETWORK_LEVEL_PROTOCOL_IPV6:
+          {
+            char buf[GRUB_NET_MAX_STR_ADDR_LEN];
+            struct grub_net_network_level_address base;
+            base.type = GRUB_NET_NETWORK_LEVEL_PROTOCOL_IPV6;
+            grub_memcpy (&base.ipv6, ((&inf->address)->ipv6), 16);
+            grub_net_addr_to_str (&base, buf);
+
+            for (ptr = buf; *ptr; ptr++)
+              if (*ptr == ':')
+                *ptr = '-';
+
+            grub_snprintf (suffix, GRUB_NET_MAX_STR_ADDR_LEN, "%s", buf);
+            if (search_through (1, 0) == 0)
+              return GRUB_ERR_NONE;
+            break;
+          }
+        case GRUB_NET_NETWORK_LEVEL_PROTOCOL_DHCP_RECV:
+          return grub_error (GRUB_ERR_BUG, "shouldn't reach here");
+        default:
+          return grub_error (GRUB_ERR_BUG,
+                             "unsupported address type %d", (&inf->address)->type);
+        }
+    }
+
+  /* Remove the remaining minus sign at the end. */
+  config[config_len] = '\0';
+
+  return GRUB_ERR_NONE;
+}
+
 static struct grub_preboot *fini_hnd;
 
 static grub_command_t cmd_addaddr, cmd_deladdr, cmd_addroute, cmd_delroute;
normal/main.c +15 -4
index 1b03dfd57b9..ba579e75072 100644
@@ -18,6 +18,7 @@
  */
 
 #include <grub/kernel.h>
+#include <grub/net.h>
 #include <grub/normal.h>
 #include <grub/dl.h>
 #include <grub/misc.h>
@@ -323,10 +324,20 @@ grub_cmd_normal (struct grub_command *cmd __attribute__ ((unused)),
 
       prefix = grub_env_get ("prefix");
       if (prefix)
-	{
-	  config = grub_xasprintf ("%s/grub.cfg", prefix);
-	  if (! config)
-	    goto quit;
+        {
+          grub_size_t config_len;
+
+          config_len = grub_strlen (prefix) +
+                       sizeof ("/grub.cfg-XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX");
+          config = grub_malloc (config_len);
+
+          if (!config)
+            goto quit;
+
+          grub_snprintf (config, config_len, "%s/grub.cfg", prefix);
+
+          if (grub_strncmp (prefix + 1, "tftp", sizeof ("tftp") - 1) == 0)
+            grub_net_search_config_file (config);
 
 	  grub_enter_normal_mode (config);
 	  grub_free (config);
grub/net.h +2 -0
index c00b0ab117c..7ae4b6bd805 100644
@@ -569,6 +569,8 @@ grub_net_add_dns_server (const struct grub_net_network_level_address *s);
 void
 grub_net_remove_dns_server (const struct grub_net_network_level_address *s);
 
+grub_err_t
+grub_net_search_config_file (char *config);
 
 extern char *grub_net_default_server;
 
Signature · 1 line
2.21.0
#5 lore raw

Re: [PATCH v5 4/5] normal/main: Search for specific config files for netboot

What is the problem with main grub.cfg just including the files based on environment variables?

Quoted 241 lines · On Tue, 29 Oct 2019, 15:16 Javier Martinez Canillas, <[email protected]> wrote:

From: Paulo Flabiano Smorigo <[email protected]>

This patch implements a search for a specific configuration when the config file is on a remoteserver. It uses the following order:
1) DHCP client UUID option.
2) MAC address (in lower case hexadecimal with dash separators);
3) IP (in upper case hexadecimal) or IPv6;
4) The original grub.cfg file.

This procedure is similar to what is used by pxelinux and yaboot:
http://www.syslinux.org/wiki/index.php/PXELINUX#config

---

Changes in v5:
- Don't mix varible declarations and code.
- Don't use variable length arrays.
- Fix coding style issues.
- Fix function prototype.
- Include missing <grub/net.h> header.

Changes in v4: None
Changes in v3:
- Add Reviewed-by tag from Daniel Kiper.

Changes in v2: None

 grub-core/net/net.c     | 131 ++++++++++++++++++++++++++++++++++++++++
 grub-core/normal/main.c |  19 ++++--
 include/grub/net.h      |   2 +
 3 files changed, 148 insertions(+), 4 deletions(-)
net/net.c +131 -0
index d5d726a315e..f82ac15b4ec 100644
@@ -1735,6 +1735,137 @@ grub_net_restore_hw (void)
   return GRUB_ERR_NONE;
 }
 
+grub_err_t
+grub_net_search_config_file (char *config)
+{
+  grub_size_t config_len;
+  char *suffix;
+
+  auto int search_through (grub_size_t num_tries, grub_size_t slice_size);
+  int search_through (grub_size_t num_tries, grub_size_t slice_size)
+  {
+    while (num_tries-- > 0)
+      {
+        grub_file_t file;
+
+        grub_dprintf ("net", "attempt to fetch config %s\n", config);
+
+        file = grub_file_open (config, GRUB_FILE_TYPE_CONFIG);
+
+        if (file)
+          {
+            grub_file_close (file);
+            return 0;
+          }
+        else
+          {
+            if (grub_errno == GRUB_ERR_IO)
+              grub_errno = GRUB_ERR_NONE;
+          }
+
+        if (grub_strlen (suffix) < slice_size)
+          break;
+
+        config[grub_strlen (config) - slice_size] = '\0';
+      }
+
+    return 1;
+  }
+
+  config_len = grub_strlen (config);
+  config[config_len] = '-';
+  suffix = config + config_len + 1;
+
+  struct grub_net_network_level_interface *inf;
+  FOR_NET_NETWORK_LEVEL_INTERFACES (inf)
+    {
+      /* By the Client UUID. */
+      char *ptr;
+      int client_uuid_len;
+      char *client_uuid_var;
+      const char *client_uuid;
+
+      client_uuid_len = sizeof ("net_") + grub_strlen (inf->name) +
+                        sizeof ("_clientuuid") + 1;
+
+      client_uuid_var = grub_zalloc (client_uuid_len);
+      if (!client_uuid_var)
+        return grub_errno;
+
+      grub_snprintf (client_uuid_var, client_uuid_len,
+                     "net_%s_clientuuid", inf->name);
+
+      client_uuid = grub_env_get (client_uuid_var);
+      grub_free (client_uuid_var);
+
+      if (client_uuid)
+        {
+          grub_strcpy (suffix, client_uuid);
+          if (search_through (1, 0) == 0)
+            return GRUB_ERR_NONE;
+        }
+
+      /* By the MAC address. */
+
+      /* Add ethernet type */
+      grub_strcpy (suffix, "01-");
+
+      grub_net_hwaddr_to_str (&inf->hwaddress, suffix + 3);
+
+      for (ptr = suffix; *ptr; ptr++)
+        if (*ptr == ':')
+          *ptr = '-';
+
+      if (search_through (1, 0) == 0)
+        return GRUB_ERR_NONE;
+
+      /* By IP address */
+
+      switch ((&inf->address)->type)
+        {
+        case GRUB_NET_NETWORK_LEVEL_PROTOCOL_IPV4:
+          {
+            grub_uint32_t n = grub_be_to_cpu32 ((&inf->address)->ipv4);
+
+            grub_snprintf (suffix, GRUB_NET_MAX_STR_ADDR_LEN,
 "%02X%02X%02X%02X", \
+                           ((n >> 24) & 0xff), ((n >> 16) & 0xff),      \
+                           ((n >> 8) & 0xff), ((n >> 0) & 0xff));
+
+            if (search_through (8, 1) == 0)
+              return GRUB_ERR_NONE;
+            break;
+          }
+        case GRUB_NET_NETWORK_LEVEL_PROTOCOL_IPV6:
+          {
+            char buf[GRUB_NET_MAX_STR_ADDR_LEN];
+            struct grub_net_network_level_address base;
+            base.type = GRUB_NET_NETWORK_LEVEL_PROTOCOL_IPV6;
+            grub_memcpy (&base.ipv6, ((&inf->address)->ipv6), 16);
+            grub_net_addr_to_str (&base, buf);
+
+            for (ptr = buf; *ptr; ptr++)
+              if (*ptr == ':')
+                *ptr = '-';
+
+            grub_snprintf (suffix, GRUB_NET_MAX_STR_ADDR_LEN, "%s", buf);
+            if (search_through (1, 0) == 0)
+              return GRUB_ERR_NONE;
+            break;
+          }
+        case GRUB_NET_NETWORK_LEVEL_PROTOCOL_DHCP_RECV:
+          return grub_error (GRUB_ERR_BUG, "shouldn't reach here");
+        default:
+          return grub_error (GRUB_ERR_BUG,
+                             "unsupported address type %d",
 (&inf->address)->type);
+        }
+    }
+
+  /* Remove the remaining minus sign at the end. */
+  config[config_len] = '\0';
+
+  return GRUB_ERR_NONE;
+}
+
 static struct grub_preboot *fini_hnd;

static grub_command_t cmd_addaddr, cmd_deladdr, cmd_addroute,
cmd_delroute;

normal/main.c +15 -4
index 1b03dfd57b9..ba579e75072 100644
@@ -18,6 +18,7 @@
  */
 
 #include <grub/kernel.h>
+#include <grub/net.h>
 #include <grub/normal.h>
 #include <grub/dl.h>
 #include <grub/misc.h>
@@ -323,10 +324,20 @@ grub_cmd_normal (struct grub_command *cmd
 __attribute__ ((unused)),
 
       prefix = grub_env_get ("prefix");
       if (prefix)
-       {
-         config = grub_xasprintf ("%s/grub.cfg", prefix);
-         if (! config)
-           goto quit;
+        {
+          grub_size_t config_len;
+
+          config_len = grub_strlen (prefix) +
+                       sizeof
 ("/grub.cfg-XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX");
+          config = grub_malloc (config_len);
+
+          if (!config)
+            goto quit;
+
+          grub_snprintf (config, config_len, "%s/grub.cfg", prefix);
+
+          if (grub_strncmp (prefix + 1, "tftp", sizeof ("tftp") - 1) == 0)
+            grub_net_search_config_file (config);
 
          grub_enter_normal_mode (config);
          grub_free (config);
grub/net.h +2 -0
index c00b0ab117c..7ae4b6bd805 100644
@@ -569,6 +569,8 @@ grub_net_add_dns_server (const struct
 grub_net_network_level_address *s);
 void
 grub_net_remove_dns_server (const struct grub_net_network_level_address
 *s);
 
+grub_err_t
+grub_net_search_config_file (char *config);
 

extern char *grub_net_default_server;

--
2.21.0

#6 lore raw

Re: [PATCH v5 4/5] normal/main: Search for specific config files for netboot

Hello Vladimir,

Quoted 3 lines · Vladimir 'phcoder' Serbinenko

What is the problem with main grub.cfg just including the files based on environment variables?

Do you mean having a grub.cfg that fetches the machine specific grub.cfg? i.e:

configfile (tftp,$net_default_server)/EFI/BOOT/grub.cfg.$net_default_ip

While is true that this could be done, is not ideal since then all the logic to determine which config file to fetch will have to be encoded into this first stage grub.cfg that will be downloaded by all the machines.

This policy will have to be written as a GRUB config script instead of being in the installation server backend, that could just provide the machine specific config files using the suffixes convention introduced by this patch-set.

And when managing a big fleet of machines the monolithic approach of having all this policy in a single grub.cfg file could be hard to maintain and error prone.

As mentioned in the commit message, others bootloaders already support this. For example pxelinux and yaboot. So users migrating from pxelinux and yaboot to GRUB for PXE booting asked for this since they already have built infrastructure that rely on this feature.

We have been carrying these patches since 2012 and our users expect this feature to be available for their network installation environments. I also think that's useful and gives GRUB feature parity with other bootloaders for network booting.

Best regards,

Signature · 3 lines
Javier Martinez Canillas
Software Engineer - Desktop Hardware Enablement
Red Hat
#7 lore raw

Re: [PATCH v5 4/5] normal/main: Search for specific config files for netboot

We had a discussion with Daniel and agreed on following:
1) we accept the feature
2) we want to have an option to specify grub config file. And if this option is present, the scanning would be disabled
3) to avoid multiple round-trips can we request all the possible files in parallel?

Quoted 51 lines · On Wed, 30 Oct 2019, 11:40 Javier Martinez Canillas, <[email protected]> wrote:

Hello Vladimir,

Quoted 3 lines · Vladimir 'phcoder' Serbinenko

What is the problem with main grub.cfg just including the files based on environment variables?

Do you mean having a grub.cfg that fetches the machine specific grub.cfg? i.e:

configfile (tftp,$net_default_server)/EFI/BOOT/grub.cfg.$net_default_ip

While is true that this could be done, is not ideal since then all the logic
to determine which config file to fetch will have to be encoded into this first
stage grub.cfg that will be downloaded by all the machines.

This policy will have to be written as a GRUB config script instead of being in
the installation server backend, that could just provide the machine specific
config files using the suffixes convention introduced by this patch-set.

And when managing a big fleet of machines the monolithic approach of having all
this policy in a single grub.cfg file could be hard to maintain and error prone.

As mentioned in the commit message, others bootloaders already support this. For
example pxelinux and yaboot. So users migrating from pxelinux and yaboot to GRUB
for PXE booting asked for this since they already have built infrastructure that
rely on this feature.

We have been carrying these patches since 2012 and our users expect this feature
to be available for their network installation environments. I also think that's
useful and gives GRUB feature parity with other bootloaders for network booting.

Best regards,
--
Javier Martinez Canillas
Software Engineer - Desktop Hardware Enablement
Red Hat

#8 lore raw

Re: [PATCH v5 4/5] normal/main: Search for specific config files for netboot

Quoted 2 lines · Vladimir 'phcoder' Serbinenko

We had a discussion with Daniel and agreed on following:
1) we accept the feature

Great, thanks.

Quoted 2 lines

2) we want to have an option to specify grub config file. And if this option is present, the scanning would be disabled

Sure, you mentioned that this should be a DHCP option. Which option were you thinking that could be used for this?

Quoted 3 lines

3) to avoid multiple round-trips can we request all the possible files in parallel?

It this even possible with GRUB? I thought that didn't have multi-tasking support so we couldn't parallelize the requests to the TFTP server.

Best regards,

Signature · 3 lines
Javier Martinez Canillas
Software Engineer - Desktop Hardware Enablement
Red Hat
#9 lore raw

Re: [PATCH v5 4/5] normal/main: Search for specific config files for netboot

Quoted 11 lines · Javier Martinez Canillas
Quoted 2 lines · Vladimir 'phcoder' Serbinenko

We had a discussion with Daniel and agreed on following:
1) we accept the feature

Great, thanks.

Quoted 2 lines

2) we want to have an option to specify grub config file. And if this option is present, the scanning would be disabled

Sure, you mentioned that this should be a DHCP option. Which option were you thinking that could be used for this?

We took closer look at DHCP RFC and it seems to us that it is more complicated than we expected. So, let's do this differently. Please add a variable which can be used to disable this feature. However, it should be noted in the GRUB doc that this variable has to be set in early config file.

Daniel

#10 lore raw

Re: [PATCH v5 4/5] normal/main: Search for specific config files for netboot

Quoted 7 lines · Daniel Kiper
Quoted 6 lines · Javier Martinez Canillas
Quoted 2 lines · Vladimir 'phcoder' Serbinenko

We had a discussion with Daniel and agreed on following:
1) we accept the feature

Great, thanks.

Quoted 8 lines
Quoted 5 lines
Quoted 2 lines

2) we want to have an option to specify grub config file. And if this option is present, the scanning would be disabled

Sure, you mentioned that this should be a DHCP option. Which option were you thinking that could be used for this?

We took closer look at DHCP RFC and it seems to us that it is more complicated than we expected. So, let's do this differently. Please add

Yes, I also took a closer look at the RFC and didn't see how what you proposed could be done.

Quoted 4 lines

a variable which can be used to disable this feature. However, it should be noted in the GRUB doc that this variable has to be set in early config file.

I don't know if that could work, since this logic is to fetch the config file where this variable could be set (or a load_env command invoked to load these from an env file).

Another option is to have this feature under a configure flag that will be disabled by default. Then distros that want the feature can enable it.

Quoted 2 lines

Daniel

Best regards,

Signature · 3 lines
Javier Martinez Canillas
Software Engineer - Desktop Hardware Enablement
Red Hat
#11 lore raw

Re: [PATCH v5 4/5] normal/main: Search for specific config files for netboot

Quoted 11 lines · Javier Martinez Canillas
Quoted 10 lines · Daniel Kiper
Quoted 9 lines · Javier Martinez Canillas
Quoted 2 lines · Vladimir 'phcoder' Serbinenko

We had a discussion with Daniel and agreed on following:
1) we accept the feature

Great, thanks.

Quoted 2 lines

2) we want to have an option to specify grub config file. And if this option is present, the scanning would be disabled

Quoted 8 lines
Quoted 5 lines
Quoted 2 lines

Sure, you mentioned that this should be a DHCP option. Which option were you thinking that could be used for this?

We took closer look at DHCP RFC and it seems to us that it is more complicated than we expected. So, let's do this differently. Please add

Yes, I also took a closer look at the RFC and didn't see how what you proposed could be done.

It can be done using Vendor Class Identifier (60) and Vendor Specific Information (43) options. Though it will complicate the GRUB code needlessly at this point. So, it can be done if there are real users for it and they are able properly define exchange between the DHCP server and client.

Quoted 8 lines
Quoted 4 lines

a variable which can be used to disable this feature. However, it should be noted in the GRUB doc that this variable has to be set in early config file.

I don't know if that could work, since this logic is to fetch the config file where this variable could be set (or a load_env command invoked to load these from an env file).

"man grub-mkimage" and look for "early config"...

Quoted 2 lines

Another option is to have this feature under a configure flag that will be disabled by default. Then distros that want the feature can enable it.

If we want to go that way I prefer runtime option for grub-mkimage/grub-mkstandalone instead of build time configure option.

Daniel

#12 lore raw

PATCH v5 5/5 docs: Update info with grub.cfg netboot selection order

In reply to Javier Martinez Canillas

From: Robert Marshall <[email protected]>

Add documentation to the grub info page that specifies the order netboot clients use to select a grub configuration file.

---

Changes in v5:
- Add Reviewed-by tag from Daniel Kiper to patch #5.

Changes in v4:
- Mention that the UUID is unique to the machine and not the NIC and also refer to the RFC 4578 where the client UUID DHCP option is specified.

Changes in v3:
- Add a patch documenting the grub.cfg netboot selection order.

Changes in v2: None

 docs/grub.texi | 46 ++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 46 insertions(+)
grub.texi +46 -0
index 5ac61c09d1b..2f69c47175e 100644
@@ -2486,6 +2486,52 @@ grub-mknetdir --net-directory=/srv/tftp --subdir=/boot/grub -d /usr/lib/grub/i38
 Then follow instructions printed out by grub-mknetdir on configuring your DHCP
 server.
 
+The grub.cfg file is placed in the same directory as the path output by
+grub-mknetdir hereafter referred to as FWPATH. GRUB will search for its
+configuration files in order using the following rules where the appended
+value corresponds to a value on the client machine.
+
+@example
+@group
+@samp{(FWPATH)}/grub.cfg-@samp{(UUID OF MACHINE)}
+@samp{(FWPATH)}/grub.cfg-@samp{(MAC ADDRESS OF NIC)}
+@samp{(FWPATH)}/grub.cfg-@samp{(IPv4 OR IPv6 ADDRESS)}
+@samp{(FWPATH)}/grub.cfg
+@end group
+@end example
+
+The UUID is the Client Machine Identifier Option Definition as specified in
+RFC 4578. The client will only attempt to loouk up a UUID config file if it
+was provided by the DHCP server.
+
+The client will only attempt to look up an IPv6 address config once, however,
+it will try the IPv4 multiple times. The concrete example below shows what
+would happen under the IPv4 case.
+
+@example
+@group
+UUID: 7726a678-7fc0-4853-a4f6-c85ac36a120a
+MAC:  52:54:00:ec:33:81
+IPV4: 10.0.0.130 (0A000082)
+@end group
+@end example
+
+@example
+@group
+@samp{(FWPATH)}/grub.cfg-7726a678-7fc0-4853-a4f6-c85ac36a120a
+@samp{(FWPATH)}/grub.cfg-52-54-00-ec-33-81
+@samp{(FWPATH)}/grub.cfg-0A000082
+@samp{(FWPATH)}/grub.cfg-0A00008
+@samp{(FWPATH)}/grub.cfg-0A0000
+@samp{(FWPATH)}/grub.cfg-0A000
+@samp{(FWPATH)}/grub.cfg-0A00
+@samp{(FWPATH)}/grub.cfg-0A0
+@samp{(FWPATH)}/grub.cfg-0A
+@samp{(FWPATH)}/grub.cfg-0
+@samp{(FWPATH)}/grub.cfg
+@end group
+@end example
+
 After GRUB has started, files on the TFTP server will be accessible via the
 @samp{(tftp)} device.
 
Signature · 1 line
2.21.0