Skip to contentSkip to conversation

Search for specific config files using UUID, MAC and IP

PATCH Superseded Javier Martinez Canillas 3 participants 11 messages Oct 22, 2019 – Oct 23, 2019

v3 of 6 Superseded Latest is v6 →

lore
Share & tools
lore
#0 lore raw

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

Hello,

This is a v3 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 v3:
- Add patch to cleanup bootp/dhcp options enum.
- 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 hexadecimal numbers for 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          |  42 +++++++++++++++
 grub-core/kern/misc.c   |   7 ++-
 grub-core/net/bootp.c   |  48 ++++++++++++++---
 grub-core/net/net.c     | 117 ++++++++++++++++++++++++++++++++++++++++
 grub-core/normal/main.c |  17 ++++--
 include/grub/net.h      |  19 ++++---
 6 files changed, 229 insertions(+), 21 deletions(-)
Signature · 1 line
2.21.0
#1 lore raw

PATCH v3 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 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(-)
grub-core/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 v3 2/5 net/dhcp: Consistently use hexadecimal numbers for options enum

In reply to Javier Martinez Canillas

The bootp/dhcp options enum values are a mixture of hexadecimal and decimal numbers. Change this to consistently use hexadecimal numbers for all values.

---

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

Changes in v2: None

 include/grub/net.h | 14 +++++++-------
 1 file changed, 7 insertions(+), 7 deletions(-)
include/grub/net.h +7 -7
index 4a9069a1474..a6982990ab0 100644
@@ -462,13 +462,13 @@ enum
     GRUB_NET_BOOTP_DOMAIN = 0x0f,
     GRUB_NET_BOOTP_ROOT_PATH = 0x11,
     GRUB_NET_BOOTP_EXTENSIONS_PATH = 0x12,
-    GRUB_NET_DHCP_REQUESTED_IP_ADDRESS = 50,
-    GRUB_NET_DHCP_OVERLOAD = 52,
-    GRUB_NET_DHCP_MESSAGE_TYPE = 53,
-    GRUB_NET_DHCP_SERVER_IDENTIFIER = 54,
-    GRUB_NET_DHCP_PARAMETER_REQUEST_LIST = 55,
-    GRUB_NET_DHCP_TFTP_SERVER_NAME = 66,
-    GRUB_NET_DHCP_BOOTFILE_NAME = 67,
+    GRUB_NET_DHCP_REQUESTED_IP_ADDRESS = 0x32,
+    GRUB_NET_DHCP_OVERLOAD = 0x34,
+    GRUB_NET_DHCP_MESSAGE_TYPE = 0x35,
+    GRUB_NET_DHCP_SERVER_IDENTIFIER = 0x36,
+    GRUB_NET_DHCP_PARAMETER_REQUEST_LIST = 0x37,
+    GRUB_NET_DHCP_TFTP_SERVER_NAME = 0x42,
+    GRUB_NET_DHCP_BOOTFILE_NAME = 0x43,
     GRUB_NET_BOOTP_END = 0xff
   };
 
Signature · 1 line
2.21.0
#3 lore raw

Re: [PATCH v3 2/5] net/dhcp: Consistently use hexadecimal numbers for options enum

Quoted 28 lines · Javier Martinez Canillas

The bootp/dhcp options enum values are a mixture of hexadecimal and decimal numbers. Change this to consistently use hexadecimal numbers for all values.

---

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

Changes in v2: None

 include/grub/net.h | 14 +++++++-------
 1 file changed, 7 insertions(+), 7 deletions(-)
include/grub/net.h +0 -4
index 4a9069a1474..a6982990ab0 100644
@@ -462,13 +462,13 @@ enum
     GRUB_NET_BOOTP_DOMAIN = 0x0f,
     GRUB_NET_BOOTP_ROOT_PATH = 0x11,
     GRUB_NET_BOOTP_EXTENSIONS_PATH = 0x12,
-    GRUB_NET_DHCP_REQUESTED_IP_ADDRESS = 50,
-    GRUB_NET_DHCP_OVERLOAD = 52,
-    GRUB_NET_DHCP_MESSAGE_TYPE = 53,
-    GRUB_NET_DHCP_SERVER_IDENTIFIER = 54,

include/grub/net.h enum · line 471

Quoted 10 lines
include/grub/net.h +7 -3
-    GRUB_NET_DHCP_PARAMETER_REQUEST_LIST = 55,
-    GRUB_NET_DHCP_TFTP_SERVER_NAME = 66,
-    GRUB_NET_DHCP_BOOTFILE_NAME = 67,
+    GRUB_NET_DHCP_REQUESTED_IP_ADDRESS = 0x32,
+    GRUB_NET_DHCP_OVERLOAD = 0x34,
+    GRUB_NET_DHCP_MESSAGE_TYPE = 0x35,
+    GRUB_NET_DHCP_SERVER_IDENTIFIER = 0x36,
+    GRUB_NET_DHCP_PARAMETER_REQUEST_LIST = 0x37,
+    GRUB_NET_DHCP_TFTP_SERVER_NAME = 0x42,
+    GRUB_NET_DHCP_BOOTFILE_NAME = 0x43,

Ugh... Checked RFC 2132. And it uses decimals instead of hexes. So, could you convert all of them to decimals? If you do that feel free to add my RB here. Sorry for the confusion. I should consult the RFC earlier.

Daniel

#4 lore raw

Re: [PATCH v3 2/5] net/dhcp: Consistently use hexadecimal numbers for options enum

Quoted 36 lines · Daniel Kiper
Quoted 35 lines · Javier Martinez Canillas

The bootp/dhcp options enum values are a mixture of hexadecimal and decimal numbers. Change this to consistently use hexadecimal numbers for all values.

---

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

Changes in v2: None

 include/grub/net.h | 14 +++++++-------
 1 file changed, 7 insertions(+), 7 deletions(-)
include/grub/net.h +4 -7
index 4a9069a1474..a6982990ab0 100644
@@ -462,13 +462,13 @@ enum
     GRUB_NET_BOOTP_DOMAIN = 0x0f,
     GRUB_NET_BOOTP_ROOT_PATH = 0x11,
     GRUB_NET_BOOTP_EXTENSIONS_PATH = 0x12,
-    GRUB_NET_DHCP_REQUESTED_IP_ADDRESS = 50,
-    GRUB_NET_DHCP_OVERLOAD = 52,
-    GRUB_NET_DHCP_MESSAGE_TYPE = 53,
-    GRUB_NET_DHCP_SERVER_IDENTIFIER = 54,
-    GRUB_NET_DHCP_PARAMETER_REQUEST_LIST = 55,
-    GRUB_NET_DHCP_TFTP_SERVER_NAME = 66,
-    GRUB_NET_DHCP_BOOTFILE_NAME = 67,
+    GRUB_NET_DHCP_REQUESTED_IP_ADDRESS = 0x32,
+    GRUB_NET_DHCP_OVERLOAD = 0x34,
+    GRUB_NET_DHCP_MESSAGE_TYPE = 0x35,
+    GRUB_NET_DHCP_SERVER_IDENTIFIER = 0x36,
Quoted 9 lines

include/grub/net.h enum · line 471

Quoted 3 lines
include/grub/net.h +3 -0
+    GRUB_NET_DHCP_PARAMETER_REQUEST_LIST = 0x37,
+    GRUB_NET_DHCP_TFTP_SERVER_NAME = 0x42,
+    GRUB_NET_DHCP_BOOTFILE_NAME = 0x43,

Ugh... Checked RFC 2132. And it uses decimals instead of hexes. So, could you convert all of them to decimals? If you do that feel free to add my RB here. Sorry for the confusion. I should consult the RFC earlier.

Right, I should had done the same. I'll fix in v4 and also mention that RFC in the commit message. Thanks a lot for pointing it out.

Quoted 2 lines

Daniel

Best regards,

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

PATCH v3 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 v3: None
Changes in v2:
- Use the existing grub_env_set_net_property() and remove duplicated code.

 grub-core/net/bootp.c | 48 +++++++++++++++++++++++++++++++++++--------
 include/grub/net.h    |  2 ++
 2 files changed, 42 insertions(+), 8 deletions(-)
grub-core/net/bootp.c +40 -8
index 04cfbb04504..377006da938 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,35 @@ 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 */
+
+      opt += 1;
+      opt_len -= 1;
+
+      char *val = grub_malloc (2 * opt_len + 4 + 1);
+      int i = 0;
+      int j = 0;
+      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);
+    }
+
   inter->dhcp_ack = grub_malloc (size);
   if (inter->dhcp_ack)
     {
@@ -631,14 +671,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)
include/grub/net.h +2 -0
index a6982990ab0..3b9fb74453c 100644
@@ -467,8 +467,10 @@ enum
     GRUB_NET_DHCP_MESSAGE_TYPE = 0x35,
     GRUB_NET_DHCP_SERVER_IDENTIFIER = 0x36,
     GRUB_NET_DHCP_PARAMETER_REQUEST_LIST = 0x37,
+    GRUB_NET_BOOTP_CLIENT_ID = 0x3d,
     GRUB_NET_DHCP_TFTP_SERVER_NAME = 0x42,
     GRUB_NET_DHCP_BOOTFILE_NAME = 0x43,
+    GRUB_NET_BOOTP_CLIENT_UUID = 0x61,
     GRUB_NET_BOOTP_END = 0xff
   };
 
Signature · 1 line
2.21.0
#6 lore raw

PATCH v3 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 v3:
- Add Reviewed-by tag from Daniel Kiper.

Changes in v2: None

 grub-core/net/net.c     | 117 ++++++++++++++++++++++++++++++++++++++++
 grub-core/normal/main.c |  17 ++++--
 include/grub/net.h      |   3 ++
 3 files changed, 133 insertions(+), 4 deletions(-)
grub-core/net/net.c +117 -0
index d5d726a315e..f066b02ebad 100644
@@ -1735,6 +1735,123 @@ 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_dprintf ("net", "attempt to fetch config %s\n", config);
+
+        grub_file_t file;
+        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 client_uuid_var[sizeof ("net_") + grub_strlen (inf->name) +
+                           sizeof ("_clientuuid") + 1];
+      grub_snprintf (client_uuid_var, sizeof (client_uuid_var),
+                     "net_%s_clientuuid", inf->name);
+
+      const char *client_uuid;
+      client_uuid = grub_env_get (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);
+
+      char *ptr;
+      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;
grub-core/normal/main.c +13 -4
index 1b03dfd57b9..cdeb58f1a1e 100644
@@ -323,10 +323,19 @@ 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);
include/grub/net.h +3 -0
index 3b9fb74453c..b37155bce34 100644
@@ -578,4 +578,7 @@ extern char *grub_net_default_server;
 
 #define VLANTAG_IDENTIFIER 0x8100
 
+grub_err_t
+grub_net_search_configfile (char *config);
+
 #endif /* ! GRUB_NET_HEADER */
Signature · 1 line
2.21.0
#7 lore raw

PATCH v3 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 v3:
- Add a patch documenting the grub.cfg netboot selection order.

Changes in v2: None

 docs/grub.texi | 42 ++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 42 insertions(+)
docs/grub.texi +42 -0
index 5ac61c09d1b..e7c5b1968b3 100644
@@ -2486,6 +2486,48 @@ 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 NIC)}
+@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 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
#8 lore raw

Re: [PATCH v3 5/5] docs: Update info with grub.cfg netboot selection order

Quoted 7 lines · 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.

Wow! We have a doc! Nice!

Quoted 17 lines

---

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

Changes in v2: None

 docs/grub.texi | 42 ++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 42 insertions(+)
docs/grub.texi +0 -0
index 5ac61c09d1b..e7c5b1968b3 100644
@@ -2486,6 +2486,48 @@ 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

docs/grub.texi grub-mknetdir --net-directory=/srv/tftp --subdir=/boot/grub -d /usr/lib/grub/i38 · line 2496

Quoted 10 lines
docs/grub.texi +8 -0
 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 NIC)}

Hmmm... May each NIC have different UUID? I thought that UUID is assigned to the machine not to the NIC. However, there is a chance that I am missing something...

Quoted 24 lines
docs/grub.texi +24 -0
+@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 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

docs/grub.texi grub-mknetdir --net-directory=/srv/tftp --subdir=/boot/grub -d /usr/lib/grub/i38 · line 2530

Quoted 10 lines
docs/grub.texi +10 -0
+@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
+

Is it possible to assign both IPv6 and IPv4 addresses at once to the NIC? What will happen if both are assigned? And first of all: does GRUB at this point support IPv6?

Daniel

#9 lore raw

Re: [PATCH v3 5/5] docs: Update info with grub.cfg netboot selection order

Quoted 10 lines · Daniel Kiper
Quoted 7 lines · 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.

Wow! We have a doc! Nice!

That reminds me: Google has actually a project like GSoC these days, just for documentation. It's called "Google Season of Docs" [1].

It seems an interesting option for paying technical writers to work on documentation which is often lacking in many open source projects.

Adrian

Quoted 1 line

[1] https://developers.google.com/season-of-docs

Signature · 4 lines
 .''`.  John Paul Adrian Glaubitz
: :' :  Debian Developer - [email protected]
`. `'   Freie Universitaet Berlin - [email protected]
  `-    GPG: 62FF 8A75 84E0 2956 9546  0006 7426 3B37 F5B5 F913
#10 lore raw

Re: [PATCH v3 5/5] docs: Update info with grub.cfg netboot selection order

In reply to Daniel Kiper
Quoted 11 lines · Daniel Kiper
Quoted 7 lines · 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.

Wow! We have a doc! Nice!

Yes, sorry for missing we had this and not including in the previous versions.

[snip]

Quoted 9 lines
Quoted 4 lines

+
+@example
+@group
+@samp{(FWPATH)}/grub.cfg-@samp{(UUID OF NIC)}

Hmmm... May each NIC have different UUID? I thought that UUID is assigned to the machine not to the NIC. However, there is a chance that I am missing something...

I think you are correct. The Client machine UUID option (97) isn't documented in RFC 2132, but in RFC 4578 and it just says the following about the UUID:

2.3. Client Machine Identifier Option Definition

The format of the option is:

                Code  Len  Type  Machine Identifier
               +----+-----+----+-----+ . . . +-----+
               | 97 |  n  |  t |     | . . . |     |
               +----+-----+----+-----+ . . . +-----+

Octet "t" describes the type of the machine identifier in the remaining octets in this option. 0 (zero) is the only value defined for this octet at the present time, and it describes the remaining octets as a 16-octet Globally Unique Identifier (GUID). Octet "n" is 17 for type 0. (One definition of GUID can be found in Appendix A of the EFI specification [4].)

This option MUST be present in all DHCP and PXE packets sent by PXE- compliant clients and servers.

Is the Client machine ID option (61) from RFC 2132 that says that a client ID MAY consistent of a hardware type and address. But it says that a hardware hardware type of 0 could also be used when the value field contains and ID that is not a hardware address. And that is up to the the vendors and system administrators to choose an ID that meets the requirement for uniqueness.

In other words, it MUST be unique and MAY contain a hardware address but that may not necessarily be the case. I'm not the author of this patch but I guess that's the source of the confusion.

I'll just change to mention that is the UUID of the machine and point to the RFC 4578.

[snip]

Quoted 17 lines
Quoted 8 lines

+@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

Quoted 8 lines

+@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
+

Quoted 1 line

Is it possible to assign both IPv6 and IPv4 addresses at once to the NIC?

By looking at the networking code I believe that it's possible, although I have only tested this patch-set with IPv4.

Quoted 1 line

What will happen if both are assigned? And first of all: does GRUB at

The grub_net_search_config_file() function iterates over all the interfaces using the FOR_NET_NETWORK_LEVEL_INTERFACES() macro. So it will try to lookup a grub.cfg with the suffix for the IPv4 or IPv6 address depending on the order in which the interfaces were registered.

Quoted 2 lines

this point support IPv6?

My understanding is that GRUB does support IPv6. But for example DHCPv6 isn't supported. I've posted the patches we have to add DHCPv6 to bootp and efinet.

Quoted 2 lines

Daniel

Best regards,

Signature · 3 lines
Javier Martinez Canillas
Software Engineer - Desktop Hardware Enablement
Red Hat