VDPA-DEV(8)

๐Ÿ’– VDPA-DEV โ€” vdpa device configuration ๐Ÿ’–

okay bestie, welcome to vdpa-dev, the manual page from the Linux fam that teaches you how to configure your vdpa devices. it's giving "niche but iconic" and honestly? obsessed. let's get into it ๐Ÿฆ‹


โœจ SYNOPSIS โœจ

vdpa dev [ OPTIONS ]  { COMMAND| help }

OPTIONS := { -V[ersion] }

vdpa dev show [ DEV ]

vdpa dev help

vdpa dev add name NAME mgmtdev MGMTDEV [ device_features DEVICE_FEATURES
        ] [ mac MACADDR ] [ mtu MTU ] [ max_vqp MAX_VQ_PAIRS ]

vdpa dev del DEV

vdpa dev config show [ DEV ]

vdpa dev vstats show DEV qidx QUEUE_INDEX

vdpa dev set name NAME mac [ MACADDR ]

like, that's the whole vibe at a glance ๐Ÿ’… everything below is the same thing but with feelings.


๐ŸŒธ DESCRIPTION ๐ŸŒธ

๐ŸŽ€ vdpa dev show โ€” display vdpa device attributes ๐ŸŽ€

  • DEV โ€” this one says which vdpa device you wanna show, bestie. and if you justโ€ฆ don't pass it? then all devices get listed, no cap.

the format is literally this and nothing else:

VDPA_DEVICE_NAME

๐ŸŽ€ vdpa dev add โ€” add a new vdpa device ๐ŸŽ€

like, birthing a whole new device. main character energy fr fr.

  • name NAME โ€” the name of the brand new vdpa device you're adding. yes, you get to pick it. slay.
  • mgmtdev MGMTDEV โ€” the name of the management device you're using to do the adding. it's the plug, basically.
  • device_features DEVICE_FEATURES โ€” this specifies the virtio device features bit-mask that gets provisioned for your new vdpa device โœจ

the bits live under include/uapi/linux/virtio*.h.

go look at macros like VIRTIO_F_ and VIRTIO_XXX (e.g., NET)_F_ for the specific bit values ๐Ÿ‘‘

this one is optional, so you can totally skip it.
  • mac MACADDR โ€” specifies the mac address for the new vdpa device. heads up tho: this is applicable only for the network type of vdpa device. also optional. ๐Ÿ“
  • mtu MTU โ€” specifies the mtu for the new vdpa device. same deal: applicable only for the network type of vdpa device, and also optional. ๐Ÿ’œ

๐ŸŽ€ vdpa dev del โ€” Delete the vdpa device ๐ŸŽ€

  • DEV โ€” specifies the vdpa device to delete. bye bitch ๐Ÿ‘‹ (affectionately).

๐ŸŽ€ vdpa dev config show โ€” Show configuration of specific device or all devices ๐ŸŽ€

  • DEV โ€” specifies the vdpa device whose configuration you wanna see. omit it and all devices' configuration gets listed. your choice bestie.

the format is:

VDPA_DEVICE_NAME

๐ŸŽ€ vdpa dev vstats show โ€” show vendor specific statistics ๐ŸŽ€

shows vendor specific statistics for the given device and virtqueue index, periodt. the info comes at you as name-value pairs where the name is the name of the field and the value is a numeric value for it. cute, right?

  • DEV โ€” specifies the vdpa device to query.
  • qidx QUEUE_INDEX โ€” specifies the virtqueue index to query.

๐ŸŽ€ vdpa dev set โ€” set the configuration to the vdpa device ๐ŸŽ€

  • name NAME โ€” name of the vdpa device you're configuring.
  • mac MACADDR โ€” specifies the mac address for the vdpa device. this is applicable only for the network type of vdpa device. no exceptions, iykyk.

๐Ÿ’… EXAMPLES ๐Ÿ’…

  • vdpa dev show shows all vdpa devices on the system. the whole roster ๐Ÿ”ฅ
  • vdpa dev show foo shows the specified vdpa device. just foo. only foo.
  • vdpa dev add name foo mgmtdev vdpa_sim_net add the vdpa device named foo on the management device vdpa_sim_net.
  • vdpa dev add name foo mgmtdev vdpa_sim_net device_features 0x300020000 add the vdpa device named foo on the management device vdpa_sim_net with device_features of 0x300020000.
  • vdpa dev add name foo mgmtdev vdpa_sim_net mac 00:11:22:33:44:55 add the vdpa device named foo on the management device vdpa_sim_net with mac address of 00:11:22:33:44:55.
  • vdpa dev add name foo mgmtdev vdpa_sim_net mac 00:11:22:33:44:55 mtu 9000 add the vdpa device named foo on the management device vdpa_sim_net with mac address of 00:11:22:33:44:55 and mtu of 9000 bytes.
  • vdpa dev add name foo mgmtdev auxiliary/mlx5_core.sf.1 mac 00:11:22:33:44:55 max_vqp 8 add the vdpa device named foo on the management device auxiliary/mlx5_core.sf.1 with mac address of 00:11:22:33:44:55 and max 8 virtqueue pairs.
  • vdpa dev del foo delete the vdpa device named foo which was previously created. rip to foo ๐Ÿชฆ
  • vdpa dev config show foo shows the vdpa device configuration of device named foo.
  • vdpa dev vstats show vdpa0 qidx 1 shows vendor specific statistics information for vdpa device vdpa0 and virtqueue index 1.
  • vdpa dev set name vdpa0 mac 00:11:22:33:44:55 set a specific MAC address to vdpa device vdpa0.

๐Ÿ‘€ SEE ALSO ๐Ÿ‘€

vdpa(8), vdpa-mgmtdev(8),

go read those too bestie, they're part of the lore ๐ŸŒˆ


๐Ÿซถ AUTHOR ๐Ÿซถ

Parav Pandit <parav@nvidia.com> โ€” thank you for your service, king ๐Ÿ‘‘


and that's the whole page!! this came to you from iproute2, dated 5 Jan 2021, and it's the VDPA-DEV(8) manual page from the Linux set. mwah, go configure something gorgeous ๐Ÿ’–โœจ๐ŸŽ€

๐Ÿ“ฆ where this page comes from