Skip to contentSkip to conversation

Add vlan information to net_ls_addr output

PATCH In review Chad Kimes 2 participants 5 messages Mar 5, 2022 – Mar 21, 2022

lore
Share & tools
lore

Chad Kimes

author
#0 lore raw

PATCH 1/2 Add vlan information to net_ls_addr output

Example output:
grub> net_ls_addr
efinet1 00:11:22:33:44:55 192.168.0.100 vlan100

---
 grub-core/net/net.c | 18 +++++++++++++++++-
 include/grub/net.h  |  8 ++++++++
 2 files changed, 25 insertions(+), 1 deletion(-)
grub-core/net/net.c +17 -1
index 4d3eb5c1a..33e35d5b5 100644
@@ -781,6 +781,20 @@ grub_net_hwaddr_to_str (const grub_net_link_level_address_t *addr, char *str)
   grub_printf (_("Unsupported hw address type %d\n"), addr->type);
 }
 
+void
+grub_net_vlan_to_str (grub_uint16_t vlantag, char *str)
+{
+  str[0] = 0;
+
+  /* 12 bits are used to identify the vlan in 802.1Q */
+  vlantag = vlantag & 0xFFF;
+
+  if (vlantag == 0)
+    return;
+
+  grub_snprintf (str, GRUB_NET_MAX_STR_VLAN_LEN, "vlan%u", vlantag);
+}
+
 int
 grub_net_hwaddr_cmp (const grub_net_link_level_address_t *a,
 		     const grub_net_link_level_address_t *b)
@@ -1250,9 +1264,11 @@ grub_cmd_listaddrs (struct grub_command *cmd __attribute__ ((unused)),
   {
     char bufh[GRUB_NET_MAX_STR_HWADDR_LEN];
     char bufn[GRUB_NET_MAX_STR_ADDR_LEN];
+    char bufv[GRUB_NET_MAX_STR_VLAN_LEN];
     grub_net_hwaddr_to_str (&inf->hwaddress, bufh);
     grub_net_addr_to_str (&inf->address, bufn);
-    grub_printf ("%s %s %s\n", inf->name, bufh, bufn);
+    grub_net_vlan_to_str (inf->vlantag, bufv);
+    grub_printf ("%s %s %s %s\n", inf->name, bufh, bufn, bufv);
   }
   return GRUB_ERR_NONE;
 }
include/grub/net.h +8 -0
index 7ae4b6bd8..7fccad8ec 100644
@@ -512,12 +512,20 @@ grub_net_addr_cmp (const grub_net_network_level_address_t *a,
 
 #define GRUB_NET_MAX_STR_HWADDR_LEN (sizeof ("XX:XX:XX:XX:XX:XX"))
 
+/*
+  Max VLAN id = 4094
+ */
+#define GRUB_NET_MAX_STR_VLAN_LEN (sizeof ("vlanXXXX"))
+
 void
 grub_net_addr_to_str (const grub_net_network_level_address_t *target,
 		      char *buf);
 void
 grub_net_hwaddr_to_str (const grub_net_link_level_address_t *addr, char *str);
 
+void
+grub_net_vlan_to_str (grub_uint16_t vlantag, char *str);
+
 grub_err_t
 grub_env_set_net_property (const char *intername, const char *suffix,
                            const char *value, grub_size_t len);
Signature · 1 line
2.25.1
author
#1 lore raw

PATCH 2/2 Add net_set_vlan command

Previously there was no way to set the 802.1Q VLAN identifier, despite support for vlantag in the net module. The only location vlantag was being populated was from PXE boot and only for Open Firmware hardware. This commit allows users to manually configure VLAN information for any interface.

Example usage:
grub> net_ls_addr
efinet1 00:11:22:33:44:55 192.168.0.100
grub> net_set_vlan efinet1 100
grub> net_ls_addr
efinet1 00:11:22:33:44:55 192.168.0.100 vlan100
grub> net_set_vlan efinet1 0
efinet1 00:11:22:33:44:55 192.168.0.100

---
 docs/grub.texi      |  9 +++++++++
 grub-core/net/net.c | 34 +++++++++++++++++++++++++++++++++-
 2 files changed, 42 insertions(+), 1 deletion(-)
docs/grub.texi +9 -0
index caba8befb..5758ec285 100644
@@ -5553,6 +5553,7 @@ This command is only available on AArch64 systems.
 * net_ls_cards::                List network cards
 * net_ls_dns::                  List DNS servers
 * net_ls_routes::               List routing entries
+* net_set_vlan::                Set vlan id on an interface
 * net_nslookup::                Perform a DNS lookup
 @end menu
 
@@ -5721,6 +5722,14 @@ List routing entries.
 @end deffn
 
 
+@node net_set_vlan
+@subsection net_set_vlan
+
+@deffn Command net_set_vlan @var{interface} @var{vlanid}
+Set the 802.1Q VLAN identifier on @var{interface} to @var{vlanid}.
+@end deffn
+
+
 @node net_nslookup
 @subsection net_nslookup
 
grub-core/net/net.c +33 -1
index 33e35d5b5..f2acd2ecf 100644
@@ -1176,6 +1176,35 @@ grub_cmd_addroute (struct grub_command *cmd __attribute__ ((unused)),
     }
 }
 
+static grub_err_t
+grub_cmd_setvlan (struct grub_command *cmd __attribute__ ((unused)),
+		  int argc, char **args)
+{
+  if (argc < 2)
+    return grub_error (GRUB_ERR_BAD_ARGUMENT, N_("two arguments expected"));
+
+  const char *vlanptr = args[1];
+  unsigned long vlantag;
+  vlantag = grub_strtoul (vlanptr, &vlanptr, 10);
+
+  if (vlantag > 4094)
+    return grub_error (GRUB_ERR_BAD_ARGUMENT, N_("invalid vlan id"));
+
+  struct grub_net_network_level_interface *inter;
+
+  FOR_NET_NETWORK_LEVEL_INTERFACES (inter)
+    {
+      if (grub_strcmp (inter->name, args[0]) != 0)
+	continue;
+
+      inter->vlantag = vlantag;
+      return GRUB_ERR_NONE;
+    }
+
+  return grub_error (GRUB_ERR_BAD_ARGUMENT,
+                     N_("network interface not found"));
+}
+
 static void
 print_net_address (const grub_net_network_level_netaddress_t *target)
 {
@@ -1892,7 +1921,7 @@ static struct grub_preboot *fini_hnd;
 
 static grub_command_t cmd_addaddr, cmd_deladdr, cmd_addroute, cmd_delroute;
 static grub_command_t cmd_lsroutes, cmd_lscards;
-static grub_command_t cmd_lsaddr, cmd_slaac;
+static grub_command_t cmd_lsaddr, cmd_slaac, cmd_setvlan;
 
 GRUB_MOD_INIT(net)
 {
@@ -1935,6 +1964,9 @@ GRUB_MOD_INIT(net)
 				       "", N_("list network cards"));
   cmd_lsaddr = grub_register_command ("net_ls_addr", grub_cmd_listaddrs,
 				       "", N_("list network addresses"));
+  cmd_setvlan = grub_register_command ("net_set_vlan", grub_cmd_setvlan,
+				       N_("SHORTNAME VLANID"),
+				       N_("Set an interace's vlan id."));
   grub_bootp_init ();
   grub_dns_init ();
 
Signature · 1 line
2.25.1
#4 lore raw
In reply to Chad Kimes

Hey,

First of all, if you send multiple patches please add cover letter to the patch series. Her is a good example [1].

Quoted 3 lines · Chad Kimes via Grub-devel

Example output:
grub> net_ls_addr
efinet1 00:11:22:33:44:55 192.168.0.100 vlan100

If you give examples please use addresses from example IP network, 192.0.2.0/24 [2].

Quoted 32 lines
---
 grub-core/net/net.c | 18 +++++++++++++++++-
 include/grub/net.h  |  8 ++++++++
 2 files changed, 25 insertions(+), 1 deletion(-)
grub-core/net/net.c +14 -0
index 4d3eb5c1a..33e35d5b5 100644
@@ -781,6 +781,20 @@ grub_net_hwaddr_to_str (const grub_net_link_level_address_t *addr, char *str)
   grub_printf (_("Unsupported hw address type %d\n"), addr->type);
 }
 
+void
+grub_net_vlan_to_str (grub_uint16_t vlantag, char *str)
+{
+  str[0] = 0;
+
+  /* 12 bits are used to identify the vlan in 802.1Q */
+  vlantag = vlantag & 0xFFF;
+
+  if (vlantag == 0)
+    return;
+
+  grub_snprintf (str, GRUB_NET_MAX_STR_VLAN_LEN, "vlan%u", vlantag);
+}
+
 int
 grub_net_hwaddr_cmp (const grub_net_link_level_address_t *a,
 		     const grub_net_link_level_address_t *b)

grub-core/net/net.c grub_cmd_listaddrs (struct grub_command *cmd __attribute__ ((unused)), · line 1267

Quoted 4 lines
grub-core/net/net.c +1 -0
@@ -1250,9 +1264,11 @@ grub_cmd_listaddrs (struct grub_command *cmd __attribute__ ((unused)),
   {
     char bufh[GRUB_NET_MAX_STR_HWADDR_LEN];
     char bufn[GRUB_NET_MAX_STR_ADDR_LEN];
+    char bufv[GRUB_NET_MAX_STR_VLAN_LEN];

Please add empty line here.

Quoted 13 lines
grub-core/net/net.c +2 -1
     grub_net_hwaddr_to_str (&inf->hwaddress, bufh);
     grub_net_addr_to_str (&inf->address, bufn);
-    grub_printf ("%s %s %s\n", inf->name, bufh, bufn);
+    grub_net_vlan_to_str (inf->vlantag, bufv);
+    grub_printf ("%s %s %s %s\n", inf->name, bufh, bufn, bufv);
   }
   return GRUB_ERR_NONE;
 }
include/grub/net.h +0 -0
index 7ae4b6bd8..7fccad8ec 100644

include/grub/net.h grub_net_addr_cmp (const grub_net_network_level_address_t *a, · line 517

Quoted 6 lines
include/grub/net.h +3 -0
@@ -512,12 +512,20 @@ grub_net_addr_cmp (const grub_net_network_level_address_t *a,
 
 #define GRUB_NET_MAX_STR_HWADDR_LEN (sizeof ("XX:XX:XX:XX:XX:XX"))
 
+/*
+  Max VLAN id = 4094
+ */

Please fix this comment [3].

include/grub/net.h grub_net_addr_cmp (const grub_net_network_level_address_t *a, · line 518

Quoted 1 line
include/grub/net.h +1 -0
+#define GRUB_NET_MAX_STR_VLAN_LEN (sizeof ("vlanXXXX"))

Daniel

[1] https://lists.gnu.org/archive/html/grub-devel/2022-03/msg00081.html
[2] https://datatracker.ietf.org/doc/html/rfc5737
[3] https://www.gnu.org/software/grub/manual/grub-dev/grub-dev.html#Comments

#2 lore raw

Re: [PATCH 2/2] Add net_set_vlan command

In reply to Chad Kimes
Quoted 6 lines · Chad Kimes via Grub-devel

Previously there was no way to set the 802.1Q VLAN identifier, despite support for vlantag in the net module. The only location vlantag was being populated was from PXE boot and only for Open Firmware hardware. This commit allows users to manually configure VLAN information for any interface.

Quoted 8 lines

Example usage:
grub> net_ls_addr
efinet1 00:11:22:33:44:55 192.168.0.100
grub> net_set_vlan efinet1 100
grub> net_ls_addr
efinet1 00:11:22:33:44:55 192.168.0.100 vlan100
grub> net_set_vlan efinet1 0
efinet1 00:11:22:33:44:55 192.168.0.100

The same comment as for the patch #1.

Quoted 19 lines
---
 docs/grub.texi      |  9 +++++++++
 grub-core/net/net.c | 34 +++++++++++++++++++++++++++++++++-
 2 files changed, 42 insertions(+), 1 deletion(-)
docs/grub.texi +1 -0
index caba8befb..5758ec285 100644
@@ -5553,6 +5553,7 @@ This command is only available on AArch64 systems.
 * net_ls_cards::                List network cards
 * net_ls_dns::                  List DNS servers
 * net_ls_routes::               List routing entries
+* net_set_vlan::                Set vlan id on an interface
 * net_nslookup::                Perform a DNS lookup
 @end menu
 

docs/grub.texi List routing entries. · line 5730

Quoted 9 lines
docs/grub.texi +6 -0
@@ -5721,6 +5722,14 @@ List routing entries.
 @end deffn
 
 
+@node net_set_vlan
+@subsection net_set_vlan
+
+@deffn Command net_set_vlan @var{interface} @var{vlanid}
+Set the 802.1Q VLAN identifier on @var{interface} to @var{vlanid}.
+@end deffn

May I ask you to add an example here?

Quoted 9 lines
docs/grub.texi +0 -0
 @node net_nslookup
 @subsection net_nslookup
 
grub-core/net/net.c +0 -0
index 33e35d5b5..f2acd2ecf 100644
@@ -1176,6 +1176,35 @@ grub_cmd_addroute (struct grub_command *cmd __attribute__ ((unused)),
     }

grub-core/net/net.c grub_cmd_addroute (struct grub_command *cmd __attribute__ ((unused)), · line 1186

Quoted 10 lines
grub-core/net/net.c +8 -0
 }
 
+static grub_err_t
+grub_cmd_setvlan (struct grub_command *cmd __attribute__ ((unused)),
+		  int argc, char **args)
+{
+  if (argc < 2)
+    return grub_error (GRUB_ERR_BAD_ARGUMENT, N_("two arguments expected"));
+
+  const char *vlanptr = args[1];

Please declare all variables at the beginning of the function.

grub-core/net/net.c grub_cmd_addroute (struct grub_command *cmd __attribute__ ((unused)), · line 1191

Quoted 5 lines
grub-core/net/net.c +5 -0
+  unsigned long vlantag;
+  vlantag = grub_strtoul (vlanptr, &vlanptr, 10);
+
+  if (vlantag > 4094)
+    return grub_error (GRUB_ERR_BAD_ARGUMENT, N_("invalid vlan id"));

This check is bogus. Please take a look at commit ac8a37dda (net/http:
Allow use of non-standard TCP/IP ports) how it should be done properly.

grub-core/net/net.c grub_cmd_addroute (struct grub_command *cmd __attribute__ ((unused)), · line 1193

Quoted 1 line
grub-core/net/net.c +1 -0
+  struct grub_net_network_level_interface *inter;

Please move this to the beginning of the function.

Quoted 26 lines
grub-core/net/net.c +14 -1
+  FOR_NET_NETWORK_LEVEL_INTERFACES (inter)
+    {
+      if (grub_strcmp (inter->name, args[0]) != 0)
+	continue;
+
+      inter->vlantag = vlantag;
+      return GRUB_ERR_NONE;
+    }
+
+  return grub_error (GRUB_ERR_BAD_ARGUMENT,
+                     N_("network interface not found"));
+}
+
 static void
 print_net_address (const grub_net_network_level_netaddress_t *target)
 {
@@ -1892,7 +1921,7 @@ static struct grub_preboot *fini_hnd;
 
 static grub_command_t cmd_addaddr, cmd_deladdr, cmd_addroute, cmd_delroute;
 static grub_command_t cmd_lsroutes, cmd_lscards;
-static grub_command_t cmd_lsaddr, cmd_slaac;
+static grub_command_t cmd_lsaddr, cmd_slaac, cmd_setvlan;
 
 GRUB_MOD_INIT(net)
 {

grub-core/net/net.c GRUB_MOD_INIT(net) · line 1968

Quoted 5 lines
grub-core/net/net.c +2 -0
@@ -1935,6 +1964,9 @@ GRUB_MOD_INIT(net)
 				       "", N_("list network cards"));
   cmd_lsaddr = grub_register_command ("net_ls_addr", grub_cmd_listaddrs,
 				       "", N_("list network addresses"));
+  cmd_setvlan = grub_register_command ("net_set_vlan", grub_cmd_setvlan,
+				       N_("SHORTNAME VLANID"),

Why do we need that if other commands have empty string here?

grub-core/net/net.c GRUB_MOD_INIT(net) · line 1969

Quoted 1 line
grub-core/net/net.c +1 -0
+				       N_("Set an interace's vlan id."));

Please be consistent with earlier grub_register_command() calls and start sentence with lower case and drop full stop at the end of it.

Daniel

author
#3 lore raw

Re: [PATCH 2/2] Add net_set_vlan command

Thanks for the review! I'll re-submit this and the other patch series shortly.

Quoted 108 lines · Daniel Kiper
Quoted 6 lines · Chad Kimes via Grub-devel

Previously there was no way to set the 802.1Q VLAN identifier, despite support for vlantag in the net module. The only location vlantag was being populated was from PXE boot and only for Open Firmware hardware. This commit allows users to manually configure VLAN information for any interface.

Quoted 8 lines

Example usage:
grub> net_ls_addr
efinet1 00:11:22:33:44:55 192.168.0.100
grub> net_set_vlan efinet1 100
grub> net_ls_addr
efinet1 00:11:22:33:44:55 192.168.0.100 vlan100
grub> net_set_vlan efinet1 0
efinet1 00:11:22:33:44:55 192.168.0.100

The same comment as for the patch #1.

Quoted 19 lines
---
 docs/grub.texi      |  9 +++++++++
 grub-core/net/net.c | 34 +++++++++++++++++++++++++++++++++-
 2 files changed, 42 insertions(+), 1 deletion(-)
docs/grub.texi +1 -0
index caba8befb..5758ec285 100644
@@ -5553,6 +5553,7 @@ This command is only available on AArch64 systems.
 * net_ls_cards::                List network cards
 * net_ls_dns::                  List DNS servers
 * net_ls_routes::               List routing entries
+* net_set_vlan::                Set vlan id on an interface
 * net_nslookup::                Perform a DNS lookup
 @end menu
 

docs/grub.texi List routing entries. · line 5730

Quoted 9 lines
docs/grub.texi +6 -0
@@ -5721,6 +5722,14 @@ List routing entries.
 @end deffn
 
 
+@node net_set_vlan
+@subsection net_set_vlan
+
+@deffn Command net_set_vlan @var{interface} @var{vlanid}
+Set the 802.1Q VLAN identifier on @var{interface} to @var{vlanid}.
+@end deffn

May I ask you to add an example here?

Quoted 9 lines
docs/grub.texi +0 -0
 @node net_nslookup
 @subsection net_nslookup
 
grub-core/net/net.c +0 -0
index 33e35d5b5..f2acd2ecf 100644
@@ -1176,6 +1176,35 @@ grub_cmd_addroute (struct grub_command *cmd __attribute__ ((unused)),
     }

grub-core/net/net.c grub_cmd_addroute (struct grub_command *cmd __attribute__ ((unused)), · line 1186

Quoted 10 lines
grub-core/net/net.c +8 -0
 }
 
+static grub_err_t
+grub_cmd_setvlan (struct grub_command *cmd __attribute__ ((unused)),
+               int argc, char **args)
+{
+  if (argc < 2)
+    return grub_error (GRUB_ERR_BAD_ARGUMENT, N_("two arguments expected"));
+
+  const char *vlanptr = args[1];

Please declare all variables at the beginning of the function.

grub-core/net/net.c grub_cmd_addroute (struct grub_command *cmd __attribute__ ((unused)), · line 1191

Quoted 5 lines
grub-core/net/net.c +5 -0
+  unsigned long vlantag;
+  vlantag = grub_strtoul (vlanptr, &vlanptr, 10);
+
+  if (vlantag > 4094)
+    return grub_error (GRUB_ERR_BAD_ARGUMENT, N_("invalid vlan id"));

This check is bogus. Please take a look at commit ac8a37dda (net/http:
Allow use of non-standard TCP/IP ports) how it should be done properly.

grub-core/net/net.c grub_cmd_addroute (struct grub_command *cmd __attribute__ ((unused)), · line 1193

Quoted 1 line
grub-core/net/net.c +1 -0
+  struct grub_net_network_level_interface *inter;

Please move this to the beginning of the function.

Quoted 23 lines
grub-core/net/net.c +14 -1
+  FOR_NET_NETWORK_LEVEL_INTERFACES (inter)
+    {
+      if (grub_strcmp (inter->name, args[0]) != 0)
+     continue;
+
+      inter->vlantag = vlantag;
+      return GRUB_ERR_NONE;
+    }
+
+  return grub_error (GRUB_ERR_BAD_ARGUMENT,
+                     N_("network interface not found"));
+}
+
 static void
 print_net_address (const grub_net_network_level_netaddress_t *target)
 {
@@ -1892,7 +1921,7 @@ static struct grub_preboot *fini_hnd;
 
 static grub_command_t cmd_addaddr, cmd_deladdr, cmd_addroute, cmd_delroute;
 static grub_command_t cmd_lsroutes, cmd_lscards;
-static grub_command_t cmd_lsaddr, cmd_slaac;
+static grub_command_t cmd_lsaddr, cmd_slaac, cmd_setvlan;
 
Quoted 10 lines

grub-core/net/net.c GRUB_MOD_INIT(net) · line 1968

Quoted 8 lines
grub-core/net/net.c +2 -0
 GRUB_MOD_INIT(net)
 {
@@ -1935,6 +1964,9 @@ GRUB_MOD_INIT(net)
                                     "", N_("list network cards"));
   cmd_lsaddr = grub_register_command ("net_ls_addr", grub_cmd_listaddrs,
                                     "", N_("list network addresses"));
+  cmd_setvlan = grub_register_command ("net_set_vlan", grub_cmd_setvlan,
+                                    N_("SHORTNAME VLANID"),

Why do we need that if other commands have empty string here?

The format is following the other net commands above this that modify data instead of just list data. For example:

cmd_addroute = grub_register_command ("net_add_route", grub_cmd_addroute,
/* TRANSLATORS: "gw" is a keyword. */ N_("SHORTNAME NET [INTERFACE|
gw GATEWAY]"),

                                        N_("Add a network route."));
  cmd_delroute = grub_register_command ("net_del_route", grub_cmd_delroute,
                                        N_("SHORTNAME"),
                                        N_("Delete a network route."));

I'll move the new command after these lines and before the ls commands so that it's more clear.

Quoted 5 lines

grub-core/net/net.c GRUB_MOD_INIT(net) · line 1969

Quoted 2 lines
grub-core/net/net.c +1 -0
+                                    N_("Set an interace's vlan id."));

Please be consistent with earlier grub_register_command() calls and start sentence with lower case and drop full stop at the end of it.

Same as above.

Quoted 2 lines

Daniel