swadm link ls filter matching

[rmustacc]

A couple of suggests for swadm link ls and similar filter tools:

• Filters should match a partial port name. e.g. specificy qsfp6 should match all qsfp6/x.
  • Ideally this would also work for just qsfp, int, rear, etc.
• Multiple filters should be allowed, e.g. swadm link ls qsfp6/0 qsfp7. When using this form:
  • If any filter doesn't match it should cause the command to exit non-zero
  • Unused filters should generate warnings

[rmustacc]

Just to make it explicit what I'd like is this (on a system with just qsfp6/7 enabled):

root@oxz_switch0:~# swadm link ls qsfp6/0 qsfp7/0
Port/Link  Media    Speed  FEC   Autoneg  Enabled  State  MAC
qsfp6/0    Optical  100G   None  false    true     Up     a8:40:25:05:22:3b
qsfp7/0    Optical  100G   None  false    true     Up     a8:40:25:05:22:3f

or

root@oxz_switch0:~# swadm link ls qsfp
Port/Link  Media    Speed  FEC   Autoneg  Enabled  State  MAC
qsfp6/0    Optical  100G   None  false    true     Up     a8:40:25:05:22:3b
qsfp7/0    Optical  100G   None  false    true     Up     a8:40:25:05:22:3f

[Nieuwejaar]

Some of this is already there:

root@oxz_switch1:~# swadm link ls rear3
Port/Link  Media   Speed  FEC  Autoneg  Enabled  State    MAC
rear3/0    Copper  100G   RS   true     true     Unknown  a8:40:25:05:1f:06
rear30/0   Copper  100G   RS   true     true     Unknown  a8:40:25:05:1f:21
rear31/0   Copper  100G   RS   true     true     Unknown  a8:40:25:05:1f:22
root@oxz_switch1:~# swadm link ls sfp
Port/Link  Media    Speed  FEC  Autoneg  Enabled  State  MAC
qsfp0/0    Optical  100G   RS   false    true     Up     a8:40:25:05:1f:23
root@oxz_switch1:~#

Adding support for multiple filters should be pretty easy.

[bnaecker]

This filtering happens on the server, by providing a query parameter to the Dropshot API handler. Dropshot does not currently support non-scalar types in query parameters, so I don't think there's a way to extend the existing filtering to support multiple filters. We'd have to do the filtering client-side to make this work, AFAICT.

[Nieuwejaar]

Right. I have this working on a branch, but the filtering is done on the client.

[ahl]

@Nieuwejaar if you want to do this server side oxidecomputer/dropshot#1553

[Nieuwejaar]

@rmustacc: could you expand on "Unused filters should generate warnings"? Do you mean we should issue a warning for each filter that doesn't match? Or do you want a warning if there are no matches? Or one warning, regardless of how many filters fail?

[rmustacc]

@rmustacc: could you expand on "Unused filters should generate warnings"? Do you mean we should issue a warning for each filter that doesn't match? Or do you want a warning if there are no matches? Or one warning, regardless of how many filters fail?

The way I have done this in other programs is for a while (i2cadm, pcieadm, nvmeadm, etc.):

1. For each filter, track if it is used or not. For each filter that is not used, warn about it at the termination of the command and exit non-zero.
2. If nothing is printed at all, then the program should exit non-zero and indicate that nothing of the specified resource was there.

[rmustacc]

Some of this is already there:

root@oxz_switch1:~# swadm link ls rear3
Port/Link  Media   Speed  FEC  Autoneg  Enabled  State    MAC
rear3/0    Copper  100G   RS   true     true     Unknown  a8:40:25:05:1f:06
rear30/0   Copper  100G   RS   true     true     Unknown  a8:40:25:05:1f:21
rear31/0   Copper  100G   RS   true     true     Unknown  a8:40:25:05:1f:22
root@oxz_switch1:~# swadm link ls sfp
Port/Link  Media    Speed  FEC  Autoneg  Enabled  State  MAC
qsfp0/0    Optical  100G   RS   false    true     Up     a8:40:25:05:1f:23
root@oxz_switch1:~#

Adding support for multiple filters should be pretty easy.

Having the match of rear3 match both rear30 and rear31 is probably not what I'd expect here, fwiw.

[Nieuwejaar]

I'll update to report each failed filter individually.

If qsfp is meant to match qsfp6/0 and qsfp22/0, then I'm not sure how to explain why rear3 wouldn't match both rear3/0 and rear31/0. How would you list all of the rear3x ports?

[rmustacc]

I'll update to report each failed filter individually.

If qsfp is meant to match qsfp6/0 and qsfp22/0, then I'm not sure how to explain why rear3 wouldn't match both rear3/0 and rear31/0. How would you list all of the rear3x ports?

So, this is just the way I think about it, which may not be the right way to think about it. I see us breaking this apart into three components: the port type, the port instance, and finally the logical link on that port. So specifically I break up rear3/0 and rear31/0 as rear as the port type, 3, 30, and 31, etc. as the port instance, and /0 as the logical link. So to me when I'm in other places if I ask for ixgbe1 I don't want ixgbe10. However if I ask for ixgbe I want to match ever ixgbe instance.

So put in a different way:

• If I use just rear, I'm matching all devices with that port type. I would not expect re to match things personally.
• If I use rear3 I would expect to match rear3/* but not rear30/*.
• If I used qsfp6/0 I would not expect to match any other logical port instance.

The main way I'm using these list options is generally to get a single answer. That is specifically I will often use this to say I want this one field of this particular single link. So if qsfp2 sometimes matches just the one item but matches multiple things when a customer configuration exists, that's going to be confusing. Maybe that means we should only ever use the explicit link as a filter, but I guess as a human and given that we don't have any other types of links on a port beyond the first, I'm signing up for that. Dunno. Does that help at all? This is again how I've been approaching this in things in illumos where I'm matching on driver / instance. But not arbitrary substrings. Maybe phrasing it as semantic matching is the best way.

[Nieuwejaar]

Maybe phrasing it as semantic matching is the best way.

OK. I see what you're going for here. This makes sense.

[Nieuwejaar]

I think I have what you're asking for now.

root@oxz_switch1:~# ./swadm link ls qsfp
Port/Link  Media    Speed  FEC  Autoneg  Enabled  State    MAC
qsfp22/0   Optical  100G   RS   false    true     Unknown  a8:40:25:05:07:7b
root@oxz_switch1:~# echo $?
0

root@oxz_switch1:~# ./swadm link ls qsfp22
Port/Link  Media    Speed  FEC  Autoneg  Enabled  State    MAC
qsfp22/0   Optical  100G   RS   false    true     Unknown  a8:40:25:05:07:7b

root@oxz_switch1:~# ./swadm link ls qsfp22/0
Port/Link  Media    Speed  FEC  Autoneg  Enabled  State    MAC
qsfp22/0   Optical  100G   RS   false    true     Unknown  a8:40:25:05:07:7b

root@oxz_switch1:~# ./swadm link ls qsfp1
Error: no links found
root@oxz_switch1:~# echo $?
1

root@oxz_switch1:~# ./swadm link ls qsfp1 int0
Port/Link  Media  Speed  FEC   Autoneg  Enabled  State  MAC
int0/0     CPU    10G    None  true     true     Up     a8:40:25:05:07:02
Error: unused filters: ["qsfp1"]
root@oxz_switch1:~# echo $?
1

root@oxz_switch1:~# ./swadm link ls re
Error: invalid filter: re