Add support for deserializing the binary PCI/PCIe VPD format and storing results in memory. The VPD format is specified in "I.3. VPD Definitions" in PCI specs (2.2+) and "6.28.1 VPD Format" PCIe 4.0. As section 6.28 in PCIe 4.0 notes, the PCI Local Bus and PCIe VPD formats are binary compatible and PCIe 4.0 merely started incorporating what was already present in PCI specs. Linux kernel exposes a binary blob in the VPD format via sysfs since v2.6.26 (commit 94e6108803469a37ee1e3c92dafdd1d59298602f) which requires a parser to interpret. A GTree is used as a data structure in order to maintain key ordering which will be important in XML to XML tests later. Signed-off-by: Dmitrii Shcherbakov <dmitrii.shcherbakov(a)canonical.com&gt; --- build-aux/syntax-check.mk | 4 +- po/POTFILES.in | 1 + src/libvirt_private.syms | 15 + src/util/meson.build | 1 + src/util/virpcivpd.c | 755 ++++++++++++++++++++++++++++++++++++++ src/util/virpcivpd.h | 117 ++++++ src/util/virpcivpdpriv.h | 45 +++ tests/meson.build | 1 + tests/testutils.c | 40 ++ tests/testutils.h | 4 + tests/virpcivpdtest.c | 705 +++++++++++++++++++++++++++++++++++ 11 files changed, 1686 insertions(+), 2 deletions(-) create mode 100644 src/util/virpcivpd.c create mode 100644 src/util/virpcivpd.h create mode 100644 src/util/virpcivpdpriv.h create mode 100644 tests/virpcivpdtest.c diff --git a/build-aux/syntax-check.mk b/build-aux/syntax-check.mk index cb54c8ba36..a428831380 100644 --- a/build-aux/syntax-check.mk +++ b/build-aux/syntax-check.mk @@ -775,9 +775,9 @@ sc_prohibit_windows_special_chars_in_filename: { echo '$(ME): Windows special chars in filename not allowed' 1>&2; echo exit 1; } || : sc_prohibit_mixed_case_abbreviations: - @prohibit='Pci|Usb|Scsi' \ + @prohibit='Pci|Usb|Scsi|Vpd' \ in_vc_files='\.[ch]$$' \ - halt='Use PCI, USB, SCSI, not Pci, Usb, Scsi' \ + halt='Use PCI, USB, SCSI, VPD, not Pci, Usb, Scsi, Vpd' \ $(_sc_search_regexp) # Require #include <locale.h> in all files that call setlocale() diff --git a/po/POTFILES.in b/po/POTFILES.in index c200d7452a..4be4139529 100644 --- a/po/POTFILES.in +++ b/po/POTFILES.in @@ -302,6 +302,7 @@ @SRCDIR(a)src/util/virnvme.c @SRCDIR(a)src/util/virobject.c @SRCDIR(a)src/util/virpci.c +@SRCDIR(a)src/util/virpcivpd.c @SRCDIR(a)src/util/virperf.c @SRCDIR(a)src/util/virpidfile.c @SRCDIR(a)src/util/virpolkit.c diff --git a/src/libvirt_private.syms b/src/libvirt_private.syms index 6de9d9aef1..bb9b380599 100644 --- a/src/libvirt_private.syms +++ b/src/libvirt_private.syms @@ -3571,6 +3571,21 @@ virVHBAManageVport; virVHBAPathExists; +# util/virpcivpd.h + +virPCIVPDKeywordResourceForEach; +virPCIVPDKeywordResourceNew; +virPCIVPDParse; +virPCIVPDParseVPDLargeResourceFields; +virPCIVPDParseVPDLargeResourceString; +virPCIVPDReadVPDBytes; +virPCIVPDResourceGetFieldValueFormat; +virPCIVPDResourceGetResourceType; +virPCIVPDResourceIsExpectedKeyword; +virPCIVPDResourceIsValidTextValue; +virPCIVPDStringResourceGetValue; +virPCIVPDStringResourceNew; + # util/virvsock.h virVsockAcquireGuestCid; virVsockSetGuestCid; diff --git a/src/util/meson.build b/src/util/meson.build index 05934f6841..24350a3e67 100644 --- a/src/util/meson.build +++ b/src/util/meson.build @@ -105,6 +105,7 @@ util_sources = [ 'virutil.c', 'viruuid.c', 'virvhba.c', + 'virpcivpd.c', 'virvsock.c', 'virxml.c', ] diff --git a/src/util/virpcivpd.c b/src/util/virpcivpd.c new file mode 100644 index 0000000000..849ea0570c --- /dev/null +++ b/src/util/virpcivpd.c @@ -0,0 +1,755 @@ +/* + * virpcivpd.c: helper APIs for working with the PCI/PCIe VPD capability + * + * Copyright (C) 2021 Canonical Ltd. + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library. If not, see + * <http://www.gnu.org/licenses/>;. + */ + +#include <config.h> + +#ifdef __linux__ +# include <unistd.h> +#endif + +#define LIBVIRT_VIRPCIVPDPRIV_H_ALLOW + +#include "virpcivpdpriv.h" +#include "virlog.h" +#include "virerror.h" +#include "virfile.h" + +#define VIR_FROM_THIS VIR_FROM_NONE + +VIR_LOG_INIT("util.pcivpd"); + +GType +vir_pci_vpd_resource_type_get_type(void) +{ + static GType resourceType; + + static const GEnumValue resourceTypes[] = { + {VIR_PCI_VPD_RESOURCE_TYPE_STRING, "String resource", "string"}, + {VIR_PCI_VPD_RESOURCE_TYPE_VPD_R, "Read-only resource", "vpd-r"}, + {VIR_PCI_VPD_RESOURCE_TYPE_VPD_W, "Read-write resource", "vpd-w"}, + {VIR_PCI_VPD_RESOURCE_TYPE_LAST, "last", "last"}, + {0, NULL, NULL}, + }; + + if (!resourceType) { + resourceType = g_enum_register_static("virPCIVPDResourceType", resourceTypes); + } + return resourceType; +} + +static gboolean +virPCIVPDResourceIsVendorKeyword(const gchar *keyword) +{ + return g_str_has_prefix(keyword, "V"); +} + +static gboolean +virPCIVPDResourceIsSystemKeyword(const gchar *keyword) +{ + /* Special-case the system-specific keywords since they share the "Y" prefix with "YA". */ + return g_str_has_prefix(keyword, "Y") && STRNEQ(keyword, "YA"); +} + +static gchar * +virPCIVPDResourceGetKeywordPrefix(const gchar *keyword) +{ + g_autofree gchar *key = NULL; + + /* Keywords must have a length of 2 bytes. */ + if (strlen(keyword) != 2) { + virReportError(VIR_ERR_INTERNAL_ERROR, _("The keyword length is not 2 bytes: %s"), keyword); + return NULL; + } else if (!(g_ascii_isalnum(keyword[0]) && g_ascii_isalnum(keyword[1]))) { + virReportError(VIR_ERR_INTERNAL_ERROR, "%s", + _("The keyword contains non-alphanumeric ASCII characters")); + return NULL; + } + /* Special-case the system-specific keywords since they share the "Y" prefix with "YA". */ + if (virPCIVPDResourceIsSystemKeyword(keyword) || virPCIVPDResourceIsVendorKeyword(keyword)) { + key = g_strndup(keyword, 1); + } else { + key = g_strndup(keyword, 2); + } + return g_steal_pointer(&key); +} + +/** + * virPCIVPDResourceGetFieldValueFormat: + * @keyword: A keyword for which to get a value type + * + * Returns: a virPCIVPDResourceFieldValueFormat value which specifies the field value type for + * a provided keyword based on the static information from PCI(e) specs. + */ +virPCIVPDResourceFieldValueFormat +virPCIVPDResourceGetFieldValueFormat(const gchar *keyword) +{ + static GHashTable *fieldValueFormats; + g_autofree gchar *key = NULL; + gpointer keyVal = NULL; + virPCIVPDResourceFieldValueFormat format = VIR_PCI_VPD_RESOURCE_FIELD_VALUE_FORMAT_LAST; + + /* Keywords are expected to be 2 bytes in length which is defined in the specs. */ + if (strlen(keyword) != 2) { + return VIR_PCI_VPD_RESOURCE_FIELD_VALUE_FORMAT_LAST; + } + + if (!fieldValueFormats) { + /* Initialize a hash table once with static format metadata coming from the PCI(e) specs. + * The VPD format does not embed format metadata into the resource records so it is not + * possible to do format discovery without static information. Legacy PICMIG keywords + * are not included. */ + fieldValueFormats = g_hash_table_new(g_str_hash, g_str_equal); + /* Extended capability. Contains binary data per PCI(e) specs. */ + g_hash_table_insert(fieldValueFormats, g_strdup("CP"), + GINT_TO_POINTER(VIR_PCI_VPD_RESOURCE_FIELD_VALUE_FORMAT_BINARY)); + /* Engineering Change Level of an Add-in Card. */ + g_hash_table_insert(fieldValueFormats, g_strdup("EC"), + GINT_TO_POINTER(VIR_PCI_VPD_RESOURCE_FIELD_VALUE_FORMAT_TEXT)); + /* Manufacture ID */ + g_hash_table_insert(fieldValueFormats, g_strdup("MN"), + GINT_TO_POINTER(VIR_PCI_VPD_RESOURCE_FIELD_VALUE_FORMAT_TEXT)); + /* Add-in Card Part Number */ + g_hash_table_insert(fieldValueFormats, g_strdup("PN"), + GINT_TO_POINTER(VIR_PCI_VPD_RESOURCE_FIELD_VALUE_FORMAT_TEXT)); + /* Checksum and Reserved */ + g_hash_table_insert(fieldValueFormats, g_strdup("RV"), + GINT_TO_POINTER(VIR_PCI_VPD_RESOURCE_FIELD_VALUE_FORMAT_RESVD)); + /* Remaining Read/Write Area */ + g_hash_table_insert(fieldValueFormats, g_strdup("RW"), + GINT_TO_POINTER(VIR_PCI_VPD_RESOURCE_FIELD_VALUE_FORMAT_RDWR)); + /* Serial Number */ + g_hash_table_insert(fieldValueFormats, g_strdup("SN"), + GINT_TO_POINTER(VIR_PCI_VPD_RESOURCE_FIELD_VALUE_FORMAT_TEXT)); + /* Asset Tag Identifier */ + g_hash_table_insert(fieldValueFormats, g_strdup("YA"), + GINT_TO_POINTER(VIR_PCI_VPD_RESOURCE_FIELD_VALUE_FORMAT_TEXT)); + /* This is a vendor specific item and the characters are alphanumeric. The second + * character (x) of the keyword can be 0 through Z so only the first one is stored. */ + g_hash_table_insert(fieldValueFormats, g_strdup("V"), + GINT_TO_POINTER(VIR_PCI_VPD_RESOURCE_FIELD_VALUE_FORMAT_TEXT)); + /* This is a system specific item and the characters are alphanumeric. + * The second character (x) of the keyword can be 0 through 9 and B through Z. */ + g_hash_table_insert(fieldValueFormats, g_strdup("Y"), + GINT_TO_POINTER(VIR_PCI_VPD_RESOURCE_FIELD_VALUE_FORMAT_TEXT)); + } + + /* The system and vendor-specific keywords have a variable part - lookup + * the prefix significant for determining the value format. */ + key = virPCIVPDResourceGetKeywordPrefix(keyword); + if (key) { + keyVal = g_hash_table_lookup(fieldValueFormats, key); + if (keyVal) { + format = GPOINTER_TO_INT(keyVal); + } + } + return format; +} + +/** + * virPCIVPDResourceIsExpectedKeyword: + * @keyword: A keyword to assess. + * @readOnly: A parameter indicating whether the resource is read-only or not. + * + * Returns: a boolean indicating whether this keyword is expected to be in a + * read-only or read-write keyword resource or not. The expectations are based + * on the keywords specified in relevant sections of PCI(e) specifications + * ("I.3. VPD Definitions" in PCI specs, "6.28.1 VPD Format" PCIe 4.0). + */ +gboolean +virPCIVPDResourceIsExpectedKeyword(const gchar *keyword, gboolean readOnly) +{ + g_autofree gchar *key = NULL; + + static const char *expectedReadOnlyKeys[] = { + "CP", "EC", "FG", "LC", "MN", + "PG", "PN", "RV", "SN", "V", NULL + }; + static const char *expectedReadWriteKeys[] = { "V", "Y", "YA", "RW", NULL }; + + key = virPCIVPDResourceGetKeywordPrefix(keyword); + if (!key) { + return false; + } + if (readOnly) { + return g_strv_contains(expectedReadOnlyKeys, key); + } else { + return g_strv_contains(expectedReadWriteKeys, key); + } +} + +/** + * virPCIVPDResourceIsValidTextValue: + * @value: A NULL-terminated string to assess. + * + * Returns: a boolean indicating whether this value is a valid string resource + * value or text field value. The expectations are based on the keywords specified + * in relevant sections of PCI(e) specifications + * ("I.3. VPD Definitions" in PCI specs, "6.28.1 VPD Format" PCIe 4.0). + */ +gboolean +virPCIVPDResourceIsValidTextValue(const gchar *value) +{ + /* + * The PCI(e) specs mention alphanumeric characters when talking about text fields + * and the string resource but also include spaces and dashes in the provided example. + * Dots, commas, equal signs have also been observed in values used by major device vendors. + * The specs do not specify a full set of allowed code points and for Libvirt it is important + * to keep values in the ranges allowed within XML elements (mainly excluding less-than, + * greater-than and ampersand). + */ + if (!g_regex_match_simple("^[a-zA-Z0-9\\-_\\s,.:=]*$", value, 0, 0)) { + virReportError(VIR_ERR_INTERNAL_ERROR, + _("The provided value contains invalid characters: %s"), value); + return false; + } + return true; +} + +/* virPCIVPDResource */ + +typedef enum { + PROP_RESOURCE_TYPE = 1, + N_PROPERTIES +} virPCIVPDResourceProperty; + +typedef struct _virPCIVPDResourcePrivate { + GObject parent; + virPCIVPDResourceType resource_type; +} virPCIVPDResourcePrivate; + + +static void vir_pci_vpd_resource_class_init(virPCIVPDResourceClass *klass); +static void vir_pci_vpd_resource_init(virPCIVPDResource *res); +static void virPCIVPDResourceFinalize(GObject *object); + +G_DEFINE_ABSTRACT_TYPE_WITH_PRIVATE(virPCIVPDResource, vir_pci_vpd_resource, G_TYPE_OBJECT); +static void +vir_pci_vpd_resource_init(virPCIVPDResource *self) +{ + virPCIVPDResourcePrivate *priv; + + priv = vir_pci_vpd_resource_get_instance_private(self); + priv->resource_type = VIR_PCI_VPD_RESOURCE_TYPE_LAST; +} + +static void +virPCIVPDResourceSetProperty(GObject *object, guint propertyId, + const GValue *value, GParamSpec *pspec) +{ + virPCIVPDResource *self = VIR_PCI_VPD_RESOURCE(object); + virPCIVPDResourcePrivate *priv; + + priv = vir_pci_vpd_resource_get_instance_private(self); + + switch ((virPCIVPDResourceProperty) propertyId) { + case PROP_RESOURCE_TYPE: + priv->resource_type = g_value_get_enum(value); + break; + case N_PROPERTIES: + default: + G_OBJECT_WARN_INVALID_PROPERTY_ID(object, propertyId, pspec); + break; + } +} + +static void +virPCIVPDResourceGetProperty(GObject *object, guint propertyId, + GValue *value, GParamSpec *pspec) +{ + virPCIVPDResource *self = VIR_PCI_VPD_RESOURCE(object); + virPCIVPDResourcePrivate *priv; + + priv = vir_pci_vpd_resource_get_instance_private(self); + + switch ((virPCIVPDResourceProperty) propertyId) { + case PROP_RESOURCE_TYPE: + g_value_set_enum(value, priv->resource_type); + break; + case N_PROPERTIES: + default: + G_OBJECT_WARN_INVALID_PROPERTY_ID(object, propertyId, pspec); + break; + } +} + +static void +vir_pci_vpd_resource_class_init(virPCIVPDResourceClass *klass) +{ + GObjectClass *obj_class = G_OBJECT_CLASS(klass); + + obj_class->set_property = virPCIVPDResourceSetProperty; + obj_class->get_property = virPCIVPDResourceGetProperty; + + g_object_class_install_property(obj_class, PROP_RESOURCE_TYPE, + g_param_spec_enum("resource_type", "Resource type", + "A VPD resource type per PCI(e) specifications.", + VIR_TYPE_PCI_VPD_RESOURCE_TYPE, + VIR_PCI_VPD_RESOURCE_TYPE_LAST, + G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE)); + obj_class->finalize = virPCIVPDResourceFinalize; +} + +static void +virPCIVPDResourceFinalize(GObject *object) +{ + G_OBJECT_CLASS(vir_pci_vpd_resource_parent_class)->finalize(object); +} + +GEnumValue * +virPCIVPDResourceGetResourceType(virPCIVPDResource *res) +{ + GValue gval = G_VALUE_INIT; + GEnumValue *enumVal; + GEnumClass *class; + + g_value_init(&gval, VIR_TYPE_PCI_VPD_RESOURCE_TYPE); + g_object_get_property(G_OBJECT(res), "resource_type", &gval); + + class = g_type_class_ref(VIR_TYPE_PCI_VPD_RESOURCE_TYPE); + + enumVal = g_enum_get_value(class, g_value_get_enum(&gval)); + g_type_class_unref(class); + return enumVal; +} + + +/* virPCIVPDStringResource */ + +struct _virPCIVPDStringResource { + virPCIVPDResource parent; + gchar *value; +}; + +G_DEFINE_TYPE(virPCIVPDStringResource, vir_pci_vpd_string_resource, VIR_TYPE_PCI_VPD_RESOURCE); + +static void vir_pci_vpd_string_resource_class_init(virPCIVPDStringResourceClass *klass); +static void vir_pci_vpd_string_resource_init(virPCIVPDStringResource *res); +static void virPCIVPDStringResourceFinalize(GObject *object); + +static void +vir_pci_vpd_string_resource_init(virPCIVPDStringResource *res) +{ + res->value = NULL; +} + +static void +vir_pci_vpd_string_resource_class_init(virPCIVPDStringResourceClass *klass) +{ + GObjectClass *obj = G_OBJECT_CLASS(klass); + + obj->finalize = virPCIVPDStringResourceFinalize; +} + +static void +virPCIVPDStringResourceFinalize(GObject *object) +{ + virPCIVPDStringResource *res = VIR_PCI_VPD_STRING_RESOURCE(object); + + g_free(res->value); + G_OBJECT_CLASS(vir_pci_vpd_resource_parent_class)->finalize(object); +} + +virPCIVPDStringResource * +virPCIVPDStringResourceNew(gchar *value) +{ + g_autoptr(virPCIVPDStringResource) res = NULL; + + res = VIR_PCI_VPD_STRING_RESOURCE(g_object_new(VIR_TYPE_PCI_VPD_STRING_RESOURCE, + "resource_type", + VIR_PCI_VPD_RESOURCE_TYPE_STRING, NULL)); + res->value = value; + return g_steal_pointer(&res); +} + +const gchar * +virPCIVPDStringResourceGetValue(const virPCIVPDStringResource *res) +{ + return res->value; +} + +/* virPCIVPDKeywordResource */ + +struct _virPCIVPDKeywordResource { + virPCIVPDResource parent; + GTree *resource_fields; +}; + +G_DEFINE_TYPE(virPCIVPDKeywordResource, vir_pci_vpd_keyword_resource, VIR_TYPE_PCI_VPD_RESOURCE); + +static void vir_pci_vpd_keyword_resource_class_init(virPCIVPDKeywordResourceClass *klass); +static void vir_pci_vpd_keyword_resource_init(virPCIVPDKeywordResource *res); +static void virPCIVPDKeywordResourceFinalize(GObject *object); + +static void +vir_pci_vpd_keyword_resource_class_init(virPCIVPDKeywordResourceClass *klass) +{ + GObjectClass *obj = G_OBJECT_CLASS(klass); + + obj->finalize = virPCIVPDKeywordResourceFinalize; +} + +static void +vir_pci_vpd_keyword_resource_init(virPCIVPDKeywordResource *res) +{ + res->resource_fields = NULL; +} + +static void +virPCIVPDKeywordResourceFinalize(GObject *object) +{ + virPCIVPDKeywordResource *res = VIR_PCI_VPD_KEYWORD_RESOURCE(object); + + g_tree_destroy(g_steal_pointer(&res->resource_fields)); + G_OBJECT_CLASS(vir_pci_vpd_resource_parent_class)->finalize(object); +} + +virPCIVPDKeywordResource * +virPCIVPDKeywordResourceNew(GTree *resourceFields, bool readOnly) +{ + g_autoptr(virPCIVPDKeywordResource) res = NULL; + virPCIVPDResourceType t; + + t = readOnly ? VIR_PCI_VPD_RESOURCE_TYPE_VPD_R : VIR_PCI_VPD_RESOURCE_TYPE_VPD_W; + /* + * Create an instance and set a property specifying its VPD resource type taking the + * readOnly parameter into account. + */ + res = VIR_PCI_VPD_KEYWORD_RESOURCE(g_object_new(VIR_TYPE_PCI_VPD_KEYWORD_RESOURCE, + "resource_type", t, NULL)); + res->resource_fields = g_tree_ref(resourceFields); + return g_steal_pointer(&res); +} + +void +virPCIVPDKeywordResourceForEach(virPCIVPDKeywordResource *res, GTraverseFunc func, + gpointer userData) +{ + g_tree_foreach(res->resource_fields, func, userData); +} + +#ifdef __linux__ + +/** + * virPCIVPDReadVPDBytes: + * @vpdFileFd: A file descriptor associated with a file containing PCI device VPD. + * @buf: An allocated buffer to use for storing VPD bytes read. + * @count: The number of bytes to read from the VPD file descriptor. + * @offset: The offset at which bytes need to be read. + * @csum: A pointer to a byte containing the current checksum value. Mutated by this function. + * + * Returns: the number of VPD bytes read from the specified file descriptor. The csum value is + * also modified as bytes are read. If an error occurs while reading data from the VPD file + * descriptor, it is reported and -1 is returned to the caller. If EOF is occurred, 0 is returned + * to the caller. + */ +size_t +virPCIVPDReadVPDBytes(int vpdFileFd, uint8_t *buf, size_t count, off_t offset, uint8_t *csum) +{ + ssize_t numRead = pread(vpdFileFd, buf, count, offset); + + if (numRead == -1) { + VIR_DEBUG("Unable to read %zu bytes at offset %ld from fd: %d", count, offset, vpdFileFd); + } else if (numRead) { + /* + * Update the checksum for every byte read. Per the PCI(e) specs + * the checksum is correct if the sum of all bytes in VPD from + * VPD address 0 up to and including the VPD-R RV field's first + * data byte is zero. + */ + while (count--) { + *csum += *buf; + buf++; + } + } + return numRead; +} + +/** + * virPCIVPDParseVPDLargeResourceFields: + * @vpdFileFd: A file descriptor associated with a file containing PCI device VPD. + * @resPos: A position where the resource data bytes begin in a file descriptor. + * @resDataLen: A length of the data portion of a resource. + * @readOnly: A boolean showing whether the resource type is VPD-R or VPD-W. + * @csum: A pointer to a 1-byte checksum. + * + * Returns: a pointer to a VPDResource which needs to be freed by the caller or + * NULL if getting it failed for some reason. + */ +virPCIVPDKeywordResource * +virPCIVPDParseVPDLargeResourceFields(int vpdFileFd, uint16_t resPos, uint16_t resDataLen, + bool readOnly, uint8_t *csum) +{ + g_autofree char *fieldKeyword = NULL; + g_autofree char *fieldValue = NULL; + virPCIVPDResourceFieldValueFormat fieldFormat = VIR_PCI_VPD_RESOURCE_FIELD_VALUE_FORMAT_LAST; + + /* A buffer of up to one resource record field size (plus a zero byte) is needed. */ + g_autofree uint8_t *buf = g_malloc0(PCI_VPD_MAX_FIELD_SIZE + 1); + uint16_t fieldDataLen = 0, bytesToRead = 0; + uint16_t fieldPos = resPos; + + g_autoptr(GTree) resFieldTree = g_tree_new_full((GCompareDataFunc)g_strcmp0, NULL, + g_free, g_free); + bool hasChecksum = false; + + while (fieldPos + 3 < resPos + resDataLen) { + /* Keyword resources consist of keywords (2 ASCII bytes per the spec) and 1-byte length. */ + if (virPCIVPDReadVPDBytes(vpdFileFd, buf, 3, fieldPos, csum) != 3) { + /* Invalid field encountered which means the resource itself is invalid too. Report + * That VPD has invalid format and bail. */ + virReportError(VIR_ERR_INTERNAL_ERROR, "%s", + _("Could not read a resource field header - VPD has invalid format")); + return NULL; + } + fieldDataLen = buf[2]; + /* Change the position to the field's data portion skipping the keyword and length bytes. */ + fieldPos += 3; + fieldKeyword = g_strndup((char *)buf, 2); + + if (!virPCIVPDResourceIsExpectedKeyword(fieldKeyword, readOnly)) { + virReportError(VIR_ERR_INTERNAL_ERROR, "%s", + _("Unexpected keyword encountered - VPD has invalid format")); + return NULL; + } + fieldFormat = virPCIVPDResourceGetFieldValueFormat(fieldKeyword); + + if (fieldFormat == VIR_PCI_VPD_RESOURCE_FIELD_VALUE_FORMAT_RESVD) { + if (!fieldDataLen) { + virReportError(VIR_ERR_INTERNAL_ERROR, "%s", + _("The RV field has a 0 length - VPD has invalid format.")); + return NULL; + } + /* Only need one byte to be read and accounted towards the checksum calculation. */ + bytesToRead = 1; + } else { + bytesToRead = fieldDataLen; + } + if (virPCIVPDReadVPDBytes(vpdFileFd, buf, bytesToRead, fieldPos, csum) != bytesToRead) { + virReportError(VIR_ERR_INTERNAL_ERROR, "%s", + _("Could not parse a resource field data - VPD has invalid format")); + return NULL; + } + /* Advance the position to the first byte of the next field. */ + fieldPos += fieldDataLen; + + if (fieldFormat == VIR_PCI_VPD_RESOURCE_FIELD_VALUE_FORMAT_TEXT) { + /* Trim whitespace around a retrieved value and set it to be a field's value. Cases + * where unnecessary whitespace was present around a field value have been encountered + * in the wild. + */ + fieldValue = g_strstrip(g_strndup((char *)buf, fieldDataLen)); + if (!virPCIVPDResourceIsValidTextValue(fieldValue)) { + virReportError(VIR_ERR_INTERNAL_ERROR, "%s", + _("Field value contains invalid characters")); + return NULL; + } + } else if (fieldFormat == VIR_PCI_VPD_RESOURCE_FIELD_VALUE_FORMAT_RESVD) { + if (*csum) { + /* All bytes up to and including the checksum byte should add up to 0. */ + virReportError(VIR_ERR_INTERNAL_ERROR, "%s", _("Checksum validation has failed")); + return NULL; + } + hasChecksum = true; + g_free(g_steal_pointer(&fieldKeyword)); + g_free(g_steal_pointer(&fieldValue)); + continue; + } else if (fieldFormat == VIR_PCI_VPD_RESOURCE_FIELD_VALUE_FORMAT_RDWR || + fieldFormat == VIR_PCI_VPD_RESOURCE_FIELD_VALUE_FORMAT_LAST) { + /* Skip fields which are not known in advance or the read-write space field since + * it is not being used. */ + g_free(g_steal_pointer(&fieldKeyword)); + g_free(g_steal_pointer(&fieldValue)); + continue; + } else { + fieldValue = g_malloc(fieldDataLen); + memcpy(fieldValue, buf, fieldDataLen); + } + /* At this point it is determined that the keyword is expected and field format + * is known and acceptable. */ + g_tree_insert(resFieldTree, + g_steal_pointer(&fieldKeyword), g_steal_pointer(&fieldValue)); + } + if (readOnly && !hasChecksum) { + virReportError(VIR_ERR_INTERNAL_ERROR, "%s", + _ + ("A VPD-R resource does not contain the mandatory RV field with a checksum")); + return NULL; + } + return virPCIVPDKeywordResourceNew(g_steal_pointer(&resFieldTree), readOnly); +} + +/** + * virPCIVPDParseVPDLargeResourceString: + * @vpdFileFd: A file descriptor associated with a file containing PCI device VPD. + * @resPos: A position where the resource data bytes begin in a file descriptor. + * @resDataLen: A length of the data portion of a resource. + * @csum: A pointer to a 1-byte checksum. + * + * Returns: a pointer to a VPDResource which needs to be freed by the caller or + * NULL if getting it failed for some reason. + */ +virPCIVPDStringResource * +virPCIVPDParseVPDLargeResourceString(int vpdFileFd, uint16_t resPos, + uint16_t resDataLen, uint8_t *csum) +{ + g_autofree char *resValue = NULL; + + /* The resource value is not NULL-terminated so add one more byte. */ + g_autofree char *buf = g_malloc0(resDataLen + 1); + + if (virPCIVPDReadVPDBytes(vpdFileFd, (uint8_t *) buf, resDataLen, + resPos, csum) != resDataLen) { + virReportError(VIR_ERR_INTERNAL_ERROR, "%s", + _("Could not read a part of a resource - VPD has invalid format")); + return NULL; + } + resValue = g_strdup(g_strstrip(buf)); + if (!virPCIVPDResourceIsValidTextValue(resValue)) { + virReportError(VIR_ERR_INTERNAL_ERROR, "%s", + _("The string resource has invalid characters in its value")); + return NULL; + } + return virPCIVPDStringResourceNew(g_steal_pointer(&resValue)); +} + +/** + * virPCIVPDParse: + * @vpdFileFd: a file descriptor associated with a file containing PCI device VPD. + * + * Parse a PCI device's Vital Product Data (VPD) contained in a file descriptor. + * + * Returns: a pointer to a GList of VPDResource types which needs to be freed by the caller or + * NULL if getting it failed for some reason. + */ +GList * +virPCIVPDParse(int vpdFileFd) +{ + /* A checksum which is calculated as a sum of all bytes from VPD byte 0 up to + * the checksum byte in the RV field's value. The RV field is only present in the + * VPD-R resource and the checksum byte there is the first byte of the field's value. + * The checksum byte in RV field is actually a two's complement of the sum of all bytes + * of VPD that come before it so adding the two together must produce 0 if data + * was not corrupted and VPD storage is intact. + */ + uint8_t csum = 0; + uint8_t headerBuf[2]; + + g_autolist(virPCIVPDResource) resList = NULL; + uint16_t resPos = 0, resDataLen; + uint8_t tag = 0; + bool endResReached = false, hasReadOnlyRes = false; + + g_autoptr(virPCIVPDResource) res = NULL; + + while (resPos <= PCI_VPD_ADDR_MASK) { + /* Read the resource data type tag. */ + if (virPCIVPDReadVPDBytes(vpdFileFd, &tag, 1, resPos, &csum) != 1) { + break; + } + /* 0x80 == 0b10000000 - the large resource data type flag. */ + if (tag & PCI_VPD_LARGE_RESOURCE_FLAG) { + if (resPos > PCI_VPD_ADDR_MASK + 1 - 3) { + /* Bail if the large resource starts at the position where the end tag should be. */ + break; + } + /* Read the two length bytes of the large resource record. */ + if (virPCIVPDReadVPDBytes(vpdFileFd, headerBuf, 2, resPos + 1, &csum) != 2) { + break; + } + resDataLen = headerBuf[0] + (headerBuf[1] << 8); + /* Change the position to the byte following the tag and length bytes. */ + resPos += 3; + } else { + /* Handle a small resource record. + * 0xxxxyyy & 00000111, where xxxx - resource data type bits, yyy - length bits. */ + resDataLen = tag & 7; + /* 0xxxxyyy >> 3 == 0000xxxx */ + tag >>= 3; + /* Change the position to the byte past the byte containing tag and length bits. */ + resPos += 1; + } + if (tag == PCI_VPD_RESOURCE_END_TAG) { + /* Stop VPD traversal since the end tag was encountered. */ + endResReached = true; + break; + } + if (resDataLen > PCI_VPD_ADDR_MASK + 1 - resPos) { + /* Bail if the resource is too long to fit into the VPD address space. */ + break; + } + + switch (tag) { + /* Large resource type which is also a string: 0x80 | 0x02 = 0x82 */ + case PCI_VPD_LARGE_RESOURCE_FLAG | PCI_VPD_STRING_RESOURCE_FLAG: + res = + (virPCIVPDResource *) virPCIVPDParseVPDLargeResourceString(vpdFileFd, resPos, + resDataLen, &csum); + break; + /* Large resource type which is also a VPD-R: 0x80 | 0x10 == 0x90 */ + case PCI_VPD_LARGE_RESOURCE_FLAG | PCI_VPD_READ_ONLY_LARGE_RESOURCE_FLAG: + res = + (virPCIVPDResource *) virPCIVPDParseVPDLargeResourceFields(vpdFileFd, resPos, + resDataLen, true, + &csum); + /* Encountered the VPD-R tag. The resource record parsing also validates + * the presence of the required checksum in the RV field. */ + hasReadOnlyRes = true; + break; + /* Large resource type which is also a VPD-W: 0x80 | 0x11 == 0x91 */ + case PCI_VPD_LARGE_RESOURCE_FLAG | PCI_VPD_READ_WRITE_LARGE_RESOURCE_FLAG: + res = + (virPCIVPDResource *) virPCIVPDParseVPDLargeResourceFields(vpdFileFd, resPos, + resDataLen, false, + &csum); + break; + default: + /* While we cannot parse unknown resource types, they can still be skipped + * based on the header and data length. */ + VIR_DEBUG("Encountered an unexpected VPD resource tag: %#x", tag); + resPos += resDataLen; + continue; + } + + if (!res) { + VIR_DEBUG("Encountered an invalid VPD"); + return NULL; + } + + resList = g_list_append(resList, g_steal_pointer(&res)); + /* Continue processing other resource records. */ + resPos += resDataLen; + } + + if (VIR_CLOSE(vpdFileFd) < 0) { + virReportSystemError(errno, _("Unable to close the VPD file, fd: %d"), vpdFileFd); + return NULL; + } + if (!hasReadOnlyRes) { + VIR_DEBUG("Encountered an invalid VPD: does not have a VPD-R record"); + return NULL; + } else if (!(endResReached && g_list_length(resList) > 0)) { + /* Does not have an end tag or there are not any other resources. */ + VIR_DEBUG("Encountered an invalid VPD"); + return NULL; + } + return g_steal_pointer(&resList); +} + +#endif /* __linux__ */ diff --git a/src/util/virpcivpd.h b/src/util/virpcivpd.h new file mode 100644 index 0000000000..7327806df3 --- /dev/null +++ b/src/util/virpcivpd.h @@ -0,0 +1,117 @@ +/* + * virpcivpd.h: helper APIs for working with the PCI/PCIe VPD capability + * + * Copyright (C) 2021 Canonical Ltd. + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library. If not, see + * <http://www.gnu.org/licenses/>;. + */ + +#pragma once + +#include "internal.h" + +/* + * PCI Local bus (2.2+, Appendix I) and PCIe 4.0+ (7.9.19 VPD Capability) define + * the VPD capability structure (8 bytes in total) and VPD registers that can be used to access + * VPD data including: + * bit 31 of the first 32-bit DWORD: data transfer completion flag (between the VPD data register + * and the VPD data storage hardware); + * bits 30:16 of the first 32-bit DWORD: VPD address of the first VPD data byte to be accessed; + * bits 31:0 of the second 32-bit DWORD: VPD data bytes with LSB being pointed to by the VPD address. + * + * Given that only 15 bits (30:16) are allocated for VPD address its mask is 0x7fff. +*/ +#define PCI_VPD_ADDR_MASK 0x7FFF + +/* + * VPD data consists of small and large resource data types. Information within a resource type + * consists of a 2-byte keyword, 1-byte length and data bytes (up to 255). +*/ +#define PCI_VPD_MAX_FIELD_SIZE 255 +#define PCI_VPD_LARGE_RESOURCE_FLAG 0x80 +#define PCI_VPD_STRING_RESOURCE_FLAG 0x02 +#define PCI_VPD_READ_ONLY_LARGE_RESOURCE_FLAG 0x10 +#define PCI_VPD_READ_WRITE_LARGE_RESOURCE_FLAG 0x11 +#define PCI_VPD_RESOURCE_END_TAG 0x0F +#define PCI_VPD_RESOURCE_END_VAL PCI_VPD_RESOURCE_END_TAG << 3 +#define VIR_TYPE_PCI_VPD_RESOURCE_TYPE vir_pci_vpd_resource_type_get_type() + +G_BEGIN_DECLS; + +typedef enum { + VIR_PCI_VPD_RESOURCE_FIELD_VALUE_FORMAT_TEXT = 1, + VIR_PCI_VPD_RESOURCE_FIELD_VALUE_FORMAT_BINARY, + VIR_PCI_VPD_RESOURCE_FIELD_VALUE_FORMAT_RESVD, + VIR_PCI_VPD_RESOURCE_FIELD_VALUE_FORMAT_RDWR, + VIR_PCI_VPD_RESOURCE_FIELD_VALUE_FORMAT_LAST +} virPCIVPDResourceFieldValueFormat; + +typedef enum { + VIR_PCI_VPD_RESOURCE_TYPE_STRING = 1, + VIR_PCI_VPD_RESOURCE_TYPE_VPD_R, + VIR_PCI_VPD_RESOURCE_TYPE_VPD_W, + VIR_PCI_VPD_RESOURCE_TYPE_LAST +} virPCIVPDResourceType; + +GType vir_pci_vpd_resource_type_get_type(void); + +virPCIVPDResourceFieldValueFormat virPCIVPDResourceGetFieldValueFormat(const gchar *value); + +#define VIR_TYPE_PCI_VPD_RESOURCE vir_pci_vpd_resource_get_type() +G_DECLARE_DERIVABLE_TYPE(virPCIVPDResource, vir_pci_vpd_resource, VIR, PCI_VPD_RESOURCE, GObject); +struct _virPCIVPDResourceClass { + GObjectClass parent_class; +}; + +/* Glib 2.59 adds proper support for g_autolist for derivable types + * see 86c073dba9d82ef3f1bc3d3116b058b9b5c3b1eb. At the time of writing + * 2.56 is the minimum version used by Libvirt. Without the below code + * compilation errors will occur. + */ +#if !GLIB_CHECK_VERSION(2, 59, 0) +typedef GList *virPCIVPDResource_listautoptr; +static inline void +glib_listautoptr_cleanup_virPCIVPDResource(GList **_l) +{ + g_list_free_full(*_l, (GDestroyNotify)g_object_unref); +} +#endif + +GEnumValue *virPCIVPDResourceGetResourceType(virPCIVPDResource *res); + +#define VIR_TYPE_PCI_VPD_STRING_RESOURCE vir_pci_vpd_string_resource_get_type() +G_DECLARE_FINAL_TYPE(virPCIVPDStringResource, vir_pci_vpd_string_resource, VIR, + PCI_VPD_STRING_RESOURCE, virPCIVPDResource); + +struct _virPCIVPDStringResourceClass { + virPCIVPDResourceClass parent_class; +}; + +virPCIVPDStringResource *virPCIVPDStringResourceNew(gchar *value); + +const gchar *virPCIVPDStringResourceGetValue(const virPCIVPDStringResource *res); + +#define VIR_TYPE_PCI_VPD_KEYWORD_RESOURCE vir_pci_vpd_keyword_resource_get_type() +G_DECLARE_FINAL_TYPE(virPCIVPDKeywordResource, vir_pci_vpd_keyword_resource, VIR, + PCI_VPD_KEYWORD_RESOURCE, virPCIVPDResource); +virPCIVPDKeywordResource *virPCIVPDKeywordResourceNew(GTree *resourceFields, bool readOnly); + +void virPCIVPDKeywordResourceForEach(virPCIVPDKeywordResource *res, GTraverseFunc func, + gpointer userData); + + +GList *virPCIVPDParse(int vpdFileFd); + +G_END_DECLS diff --git a/src/util/virpcivpdpriv.h b/src/util/virpcivpdpriv.h new file mode 100644 index 0000000000..9a3cc075c1 --- /dev/null +++ b/src/util/virpcivpdpriv.h @@ -0,0 +1,45 @@ +/* + * virpcivpdpriv.h: helper APIs for working with the PCI/PCIe VPD capability + * + * Copyright (C) 2021 Canonical Ltd. + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; If not, see + * <http://www.gnu.org/licenses/>;. + */ + +#ifndef LIBVIRT_VIRPCIVPDPRIV_H_ALLOW +# error "virpcivpdpriv.h may only be included by virpcivpd.c or test suites" +#endif /* LIBVIRT_VIRPCIVPDPRIV_H_ALLOW */ + +#pragma once + +#include "virpcivpd.h" + +#ifdef __linux__ + +size_t +virPCIVPDReadVPDBytes(int vpdFileFd, uint8_t *buf, size_t count, off_t offset, uint8_t *csum); + +virPCIVPDKeywordResource *virPCIVPDParseVPDLargeResourceFields(int vpdFileFd, uint16_t resPos, + uint16_t resDataLen, + bool readOnly, uint8_t *csum); + +virPCIVPDStringResource *virPCIVPDParseVPDLargeResourceString(int vpdFileFd, uint16_t resPos, + uint16_t resDataLen, + uint8_t *csum); + +#endif /* __linux__ */ + +gboolean virPCIVPDResourceIsExpectedKeyword(const gchar *keyword, gboolean readOnly); +gboolean virPCIVPDResourceIsValidTextValue(const gchar *value); diff --git a/tests/meson.build b/tests/meson.build index dfbc2c01e2..1948c07ae3 100644 --- a/tests/meson.build +++ b/tests/meson.build @@ -336,6 +336,7 @@ tests += [ { 'name': 'virtimetest' }, { 'name': 'virtypedparamtest' }, { 'name': 'viruritest' }, + { 'name': 'virpcivpdtest' }, { 'name': 'vshtabletest', 'link_with': [ libvirt_shell_lib ] }, { 'name': 'virmigtest' }, ] diff --git a/tests/testutils.c b/tests/testutils.c index d071abd6d7..35d9d0645d 100644 --- a/tests/testutils.c +++ b/tests/testutils.c @@ -1143,3 +1143,43 @@ virTestStablePath(const char *path) return g_strdup(path); } + +#ifdef __linux__ +/** + * virCreateAnonymousFile: + * @data: a pointer to data to be written into a new file. + * @len: the length of data to be written (in bytes). + * + * Create a fake fd, write initial data to it. + * + */ +int +virCreateAnonymousFile(const uint8_t *data, size_t len) +{ + int fd = -1; + char path[] = abs_builddir "testutils-memfd-XXXXXX"; + /* A temp file is used since not all supported distributions support memfd. */ + if ((fd = g_mkstemp_full(path, O_RDWR | O_CLOEXEC, S_IRUSR | S_IWUSR)) < 0) { + return fd; + } + g_unlink(path); + + if (ftruncate(fd, len) != 0) { + VIR_TEST_DEBUG("%s: %s", "failed to ftruncate an anonymous file", + g_strerror(errno)); + goto cleanup; + } + if (safewrite(fd, data, len) != len) { + VIR_TEST_DEBUG("%s: %s", "failed to write to an anonymous file", + g_strerror(errno)); + goto cleanup; + } + return fd; + cleanup: + if (VIR_CLOSE(fd) < 0) { + VIR_TEST_DEBUG("%s: %s", "failed to close an anonymous file", + g_strerror(errno)); + } + return -1; +} +#endif diff --git a/tests/testutils.h b/tests/testutils.h index 27d135fc02..13a154a5af 100644 --- a/tests/testutils.h +++ b/tests/testutils.h @@ -173,3 +173,7 @@ int testCompareDomXML2XMLFiles(virCaps *caps, char * virTestStablePath(const char *path); + +#ifdef __linux__ +int virCreateAnonymousFile(const uint8_t *data, size_t len); +#endif diff --git a/tests/virpcivpdtest.c b/tests/virpcivpdtest.c new file mode 100644 index 0000000000..09cba4b1a3 --- /dev/null +++ b/tests/virpcivpdtest.c @@ -0,0 +1,705 @@ +/* + * Copyright (C) 2021 Canonical Ltd. + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; If not, see + * <http://www.gnu.org/licenses/>;. + */ + +#include <config.h> + +#include "internal.h" +#include "testutils.h" +#include "virpcivpd.h" + +#define LIBVIRT_VIRPCIVPDPRIV_H_ALLOW + +#include "virpcivpdpriv.h" +#include "virlog.h" + +#define VIR_FROM_THIS VIR_FROM_NONE + +#ifdef __linux__ + +VIR_LOG_INIT("tests.vpdtest"); + + +static int +testPCIVPDStringResourceBasic(const void *data G_GNUC_UNUSED) +{ + g_autoptr(virPCIVPDStringResource) strRes = NULL; + g_autofree char *val = g_strdup("testval"); + GEnumValue *resType = NULL; + + strRes = virPCIVPDStringResourceNew(g_steal_pointer(&val)); + + resType = virPCIVPDResourceGetResourceType((virPCIVPDResource *)strRes); + + if (resType->value != VIR_PCI_VPD_RESOURCE_TYPE_STRING) { + VIR_DEBUG("Expected '%d' got '%d'", VIR_PCI_VPD_RESOURCE_TYPE_STRING, resType->value); + return -1; + } + if (!STREQ_NULLABLE(virPCIVPDStringResourceGetValue(strRes), "testval")) { + return -1; + } + + return 0; +} + +typedef struct _TestPCIVPDKeyValue { + const char *keyword; + const char *value; +} TestPCIVPDKeyValue; + +static gboolean +testPCIVPDGetOneField(gpointer *key, gpointer *val, gpointer userData) +{ + TestPCIVPDKeyValue *res = userData; + + res->keyword = (const char *)key; + res->value = (const char *)val; + + return true; +} + +static int +testPCIVPDKeywordResourceBasic(const void *data G_GNUC_UNUSED) +{ + g_autoptr(virPCIVPDKeywordResource) kwRes = NULL; + g_autoptr(GTree) resFieldTree = g_tree_new_full((GCompareDataFunc)g_strcmp0, NULL, + g_free, g_free); + GEnumValue *resType = NULL; + TestPCIVPDKeyValue testKeyVal; + + g_tree_insert(resFieldTree, g_strdup("SN"), g_strdup("DEADBEEFCAFE")); + + kwRes = virPCIVPDKeywordResourceNew(g_steal_pointer(&resFieldTree), true); + resType = virPCIVPDResourceGetResourceType((virPCIVPDResource *)kwRes); + + if (resType->value != VIR_PCI_VPD_RESOURCE_TYPE_VPD_R) { + return -1; + } + + virPCIVPDKeywordResourceForEach(kwRes, (GTraverseFunc) testPCIVPDGetOneField, &testKeyVal); + if (STRNEQ_NULLABLE(testKeyVal.keyword, "SN") || + STRNEQ_NULLABLE(testKeyVal.value, "DEADBEEFCAFE")) { + VIR_DEBUG("Unexpected keyword resource field encountered: %s: %s; expected: %s: %s", + testKeyVal.keyword, testKeyVal.value, "SN", "DEADBEEFCAFE"); + return -1; + } + + g_object_unref(g_steal_pointer(&kwRes)); + + resFieldTree = g_tree_new_full((GCompareDataFunc)g_strcmp0, NULL, g_free, g_free); + g_tree_insert(resFieldTree, g_strdup("SN"), g_strdup("CAFEDEADBEEF")); + + kwRes = virPCIVPDKeywordResourceNew(g_steal_pointer(&resFieldTree), false); + resType = virPCIVPDResourceGetResourceType((virPCIVPDResource *)kwRes); + + if (resType->value != VIR_PCI_VPD_RESOURCE_TYPE_VPD_W) { + return -1; + } + + virPCIVPDKeywordResourceForEach(kwRes, (GTraverseFunc) testPCIVPDGetOneField, &testKeyVal); + if (STRNEQ_NULLABLE(testKeyVal.keyword, "SN") || + STRNEQ_NULLABLE(testKeyVal.value, "CAFEDEADBEEF")) { + VIR_DEBUG("Unexpected keyword resource field encountered: %s: %s; expected: %s: %s", + testKeyVal.keyword, testKeyVal.value, "SN", "DEADBEEFCAFE"); + return -1; + } + + return 0; +} + +typedef struct _TestPCIVPDExpectedString { + const char *keyword; + gboolean expected; +} TestPCIVPDExpectedString; + +/* + * testPCIVPDIsExpectedKeywordReadOnly: + * + * Test expected keyword validation. Static metadata about expected + * keywords is taken from the PCI(e) standards should be respected + * and only keywords known to have a given type need to be returned. + * */ +static int +testPCIVPDIsExpectedKeywordReadOnly(const void *data G_GNUC_UNUSED) +{ + size_t i = 0; + + const TestPCIVPDExpectedString readOnlyCases[] = { + {"CP", true}, + {"EC", true}, + {"FG", true}, + {"LC", true}, + {"MN", true}, + {"PG", true}, + {"PN", true}, + {"RV", true}, + {"SN", true}, + {"V0", true}, + {"VG", true}, + {"IV", false}, + {"YA", false}, + {"YB", false}, + {"RW", false}, + /* Empty: */ + {"", false}, + /* 1-byte: */ + {"Y", false}, + /* 3-byte: */ + {"FOO", false}, + /* Not present in the spec: */ + {"42", false}, + {"4A", false}, + }; + for (i = 0; i < sizeof(readOnlyCases) / sizeof(readOnlyCases[0]); ++i) { + if (virPCIVPDResourceIsExpectedKeyword(readOnlyCases[i].keyword, true) != + readOnlyCases[i].expected) { + return -1; + } + } + return 0; +} + +/* + * testPCIVPDIsExpectedKeywordReadWrite: + * + * Test expected keyword validation. Static metadata about expected + * keywords is taken from the PCI(e) standards should be respected + * and only keywords known to have a given type need to be returned. + * */ +static int +testPCIVPDIsExpectedKeywordReadWrite(const void *data G_GNUC_UNUSED) +{ + size_t i = 0; + + const TestPCIVPDExpectedString readWriteCases[] = { + {"CP", false}, + {"EC", false}, + {"FG", false}, + {"LC", false}, + {"MN", false}, + {"PG", false}, + {"PN", false}, + {"RV", false}, + {"SN", false}, + {"V0", true}, + {"VG", true}, + {"IV", false}, + {"YA", true}, + {"YB", true}, + {"RW", true}, + /* Empty: */ + {"", false}, + /* 1-byte: */ + {"Y", false}, + /* 3-byte: */ + {"FOO", false}, + /* Not present in the spec: */ + {"42", false}, + {"4A", false}, + }; + for (i = 0; i < sizeof(readWriteCases) / sizeof(readWriteCases[0]); ++i) { + if (virPCIVPDResourceIsExpectedKeyword(readWriteCases[i].keyword, false) != + readWriteCases[i].expected) { + return -1; + } + } + return 0; +} + + + +/* + * testPCIVPDIsValidTextValue: + * + * Test expected text value validation. Static metadata about possible values is taken + * from the PCI(e) standards and based on some real-world hardware examples. + * */ +static int +testPCIVPDIsValidTextValue(const void *data G_GNUC_UNUSED) +{ + size_t i = 0; + + const TestPCIVPDExpectedString textValueCases[] = { + /* Numbers */ + {"42", true}, + /* Alphanumeric */ + {"DCM1001008FC52101008FC53201008FC54301008FC5", true}, + /* Dots */ + {"DSV1028VPDR.VER1.0", true}, + /* Whitespace presence */ + {"NMVIntel Corp", true}, + /* Comma and spaces */ + {"BlueField-2 DPU 25GbE Dual-Port SFP56, Tall Bracket", true}, + /* Equal signs and colons. */ + {"MLX:MN=MLNX:CSKU=V2:UUID=V3:PCI=V0:MODL=BF2H332A", true}, + /* Dashes */ + {"MBF2H332A-AEEOT", true}, + {"under_score_example", true}, + {"", true}, + {";", false}, + {"\\42", false}, + {"/42", false}, + }; + for (i = 0; i < sizeof(textValueCases) / sizeof(textValueCases[0]); ++i) { + if (virPCIVPDResourceIsValidTextValue(textValueCases[i].keyword) != + textValueCases[i].expected) { + return -1; + } + } + return 0; +} + +/* + * testPCIVPDGetFieldValueFormat: + * + * A simple test to assess the functionality of the + * virPCIVPDResourceGetFieldValueFormat function. + * */ +static int +testPCIVPDGetFieldValueFormat(const void *data G_GNUC_UNUSED) +{ + typedef struct _TestPCIVPDExpectedFieldValueFormat { + const char *keyword; + virPCIVPDResourceFieldValueFormat expected; + } TestPCIVPDExpectedFieldValueFormat; + + size_t i = 0; + + const TestPCIVPDExpectedFieldValueFormat valueFormatCases[] = { + {"SN", VIR_PCI_VPD_RESOURCE_FIELD_VALUE_FORMAT_TEXT}, + {"RV", VIR_PCI_VPD_RESOURCE_FIELD_VALUE_FORMAT_RESVD}, + {"RW", VIR_PCI_VPD_RESOURCE_FIELD_VALUE_FORMAT_RDWR}, + {"VA", VIR_PCI_VPD_RESOURCE_FIELD_VALUE_FORMAT_TEXT}, + {"YA", VIR_PCI_VPD_RESOURCE_FIELD_VALUE_FORMAT_TEXT}, + {"YZ", VIR_PCI_VPD_RESOURCE_FIELD_VALUE_FORMAT_TEXT}, + {"CP", VIR_PCI_VPD_RESOURCE_FIELD_VALUE_FORMAT_BINARY}, + /* Invalid keywords. */ + {"", VIR_PCI_VPD_RESOURCE_FIELD_VALUE_FORMAT_LAST}, + {"4", VIR_PCI_VPD_RESOURCE_FIELD_VALUE_FORMAT_LAST}, + {"Y", VIR_PCI_VPD_RESOURCE_FIELD_VALUE_FORMAT_LAST}, + {"V", VIR_PCI_VPD_RESOURCE_FIELD_VALUE_FORMAT_LAST}, + /* 2 bytes but not present in the spec. */ + {"EX", VIR_PCI_VPD_RESOURCE_FIELD_VALUE_FORMAT_LAST}, + /* Many numeric bytes. */ + {"4242", VIR_PCI_VPD_RESOURCE_FIELD_VALUE_FORMAT_LAST}, + /* Many letters. */ + {"EXAMPLE", VIR_PCI_VPD_RESOURCE_FIELD_VALUE_FORMAT_LAST}, + }; + for (i = 0; i < sizeof(valueFormatCases) / sizeof(valueFormatCases[0]); ++i) { + if (virPCIVPDResourceGetFieldValueFormat(valueFormatCases[i].keyword) != + valueFormatCases[i].expected) { + return -1; + } + } + return 0; +} + +# define VPD_STRING_RESOURCE_EXAMPLE_HEADER \ + PCI_VPD_LARGE_RESOURCE_FLAG | PCI_VPD_STRING_RESOURCE_FLAG, 0x08, 0x00 + +# define VPD_STRING_RESOURCE_EXAMPLE_DATA \ + 't', 'e', 's', 't', 'n', 'a', 'm', 'e' + +# define VPD_R_FIELDS_EXAMPLE_HEADER \ + PCI_VPD_LARGE_RESOURCE_FLAG | PCI_VPD_READ_ONLY_LARGE_RESOURCE_FLAG, 0x16, 0x00 + +# define VPD_R_EXAMPLE_VALID_RV_FIELD \ + 'R', 'V', 0x02, 0x31, 0x00 + +# define VPD_R_EXAMPLE_INVALID_RV_FIELD \ + 'R', 'V', 0x02, 0xFF, 0x00 + +# define VPD_R_EXAMPLE_FIELDS \ + 'P', 'N', 0x02, '4', '2', \ + 'E', 'C', 0x04, '4', '2', '4', '2', \ + 'V', 'A', 0x02, 'E', 'X' + +# define VPD_R_FIELDS_EXAMPLE_DATA \ + VPD_R_EXAMPLE_FIELDS, \ + VPD_R_EXAMPLE_VALID_RV_FIELD + +# define VPD_W_FIELDS_EXAMPLE_HEADER \ + PCI_VPD_LARGE_RESOURCE_FLAG | PCI_VPD_READ_WRITE_LARGE_RESOURCE_FLAG, 0x19, 0x00 + +# define VPD_W_EXAMPLE_FIELDS \ + 'V', 'Z', 0x02, '4', '2', \ + 'Y', 'A', 0x04, 'I', 'D', '4', '2', \ + 'Y', 'F', 0x02, 'E', 'X', \ + 'Y', 'E', 0x00, \ + 'R', 'W', 0x02, 0x00, 0x00 + +static int +testVirPCIVPDReadVPDBytes(const void *opaque G_GNUC_UNUSED) +{ + int fd = -1; + g_autofree uint8_t *buf = NULL; + uint8_t csum = 0; + size_t readBytes = 0; + size_t dataLen = 0; + + /* An example of a valid VPD record with one VPD-R resource and 2 fields. */ + uint8_t fullVPDExample[] = { + VPD_STRING_RESOURCE_EXAMPLE_HEADER, VPD_STRING_RESOURCE_EXAMPLE_DATA, + VPD_R_FIELDS_EXAMPLE_HEADER, VPD_R_FIELDS_EXAMPLE_DATA, + PCI_VPD_RESOURCE_END_VAL + }; + dataLen = sizeof(fullVPDExample) / sizeof(uint8_t) - 2; + buf = g_malloc0(dataLen); + + fd = virCreateAnonymousFile(fullVPDExample, dataLen); + + readBytes = virPCIVPDReadVPDBytes(fd, buf, dataLen, 0, &csum); + + if (readBytes != dataLen) { + virReportError(VIR_ERR_INTERNAL_ERROR, + "The number of bytes read %zu is lower than expected %zu ", + readBytes, dataLen); + return -1; + } + + if (csum) { + virReportError(VIR_ERR_INTERNAL_ERROR, + "The sum of all VPD bytes up to and including the checksum byte" + "is equal to zero: 0x%02x", csum); + return -1; + } + return 0; +} + +static int +testVirPCIVPDParseVPDStringResource(const void *opaque G_GNUC_UNUSED) +{ + int fd = -1; + uint8_t csum = 0; + size_t dataLen = 0; + + g_autoptr(virPCIVPDStringResource) strRes = NULL; + const gchar *expectedValue = "testname", *actualValue = NULL; + + const uint8_t stringResExample[] = { + VPD_STRING_RESOURCE_EXAMPLE_DATA + }; + + dataLen = sizeof(stringResExample) / sizeof(uint8_t); + fd = virCreateAnonymousFile(stringResExample, dataLen); + strRes = virPCIVPDParseVPDLargeResourceString(fd, 0, dataLen, &csum); + VIR_FORCE_CLOSE(fd); + + actualValue = virPCIVPDStringResourceGetValue(strRes); + if (STRNEQ(expectedValue, actualValue)) { + virReportError(VIR_ERR_INTERNAL_ERROR, + "Unexpected string resource value: %s, expected: %s", + actualValue, expectedValue); + return -1; + } + return 0; +} + + +typedef struct _TestPCIVPDExpectedFieldsData { + GHashTable *expectedFields; + size_t field_count; +} TestPCIVPDExpectedFieldsData; + +static gboolean +testPCIVPDValidateField(gpointer *key, gpointer *val, gpointer userData) +{ + TestPCIVPDExpectedFieldsData *expectedData = userData; + const char *actualKey = (const char *)key; + const char *expectedValue = NULL, *actualValue = (const char *)val; + + expectedValue = g_hash_table_lookup(expectedData->expectedFields, (char *)key); + if (!expectedValue) { + virReportError(VIR_ERR_INTERNAL_ERROR, "Unexpected key encountered: %s", actualKey); + return true; + } else if (STRNEQ(expectedValue, actualValue)) { + virReportError(VIR_ERR_INTERNAL_ERROR, + "Unexpected value for key %s encountered: %s expected %s", actualKey, + actualValue, expectedValue); + return true; + } + expectedData->field_count++; + return false; +} + +static gboolean +testVirPCIVPDValidateKeywordResource(virPCIVPDKeywordResource *kwRes, + GHashTable *expectedFields) +{ + size_t expectedCount = g_hash_table_size(expectedFields); + TestPCIVPDExpectedFieldsData expectedFieldsData; + + expectedFieldsData.expectedFields = expectedFields; + expectedFieldsData.field_count = 0; + + virPCIVPDKeywordResourceForEach(kwRes, (GTraverseFunc)testPCIVPDValidateField, + &expectedFieldsData); + /* + * Check that the number of actual fields observed equals the expected number + * which also validates that the "RV" field is not present after parsing. + */ + if (expectedFieldsData.field_count != expectedCount) { + virReportError(VIR_ERR_INTERNAL_ERROR, "Unexpected number of fields observed: %zu vs %zu", + expectedFieldsData.field_count, expectedCount); + return false; + } + return true; +} + + +static int +testVirPCIVPDParseFullVPD(const void *opaque G_GNUC_UNUSED) +{ + int fd = -1; + const int EXPECTED_RES_LIST_LENGTH = 3; + size_t dataLen = 0; + + g_autolist(virPCIVPDResource) resList = NULL; + GList *listIter = NULL; + virPCIVPDResource *res = NULL; + + const uint8_t fullVPDExample[] = { + VPD_STRING_RESOURCE_EXAMPLE_HEADER, VPD_STRING_RESOURCE_EXAMPLE_DATA, + VPD_R_FIELDS_EXAMPLE_HEADER, VPD_R_FIELDS_EXAMPLE_DATA, + VPD_W_FIELDS_EXAMPLE_HEADER, VPD_W_EXAMPLE_FIELDS, + PCI_VPD_RESOURCE_END_VAL + }; + const gchar *expectedValue = "testname", *actualValue = NULL; + + g_autoptr(GHashTable) expectedReadOnlyKw = NULL, expectedReadWriteKw = NULL; + + expectedReadOnlyKw = g_hash_table_new_full(g_str_hash, g_str_equal, g_free, g_free); + g_hash_table_insert(expectedReadOnlyKw, g_strdup("PN"), g_strdup("42")); + g_hash_table_insert(expectedReadOnlyKw, g_strdup("EC"), g_strdup("4242")); + g_hash_table_insert(expectedReadOnlyKw, g_strdup("VA"), g_strdup("EX")); + + expectedReadWriteKw = g_hash_table_new_full(g_str_hash, g_str_equal, g_free, g_free); + g_hash_table_insert(expectedReadWriteKw, g_strdup("VZ"), g_strdup("42")); + g_hash_table_insert(expectedReadWriteKw, g_strdup("YA"), g_strdup("ID42")); + g_hash_table_insert(expectedReadWriteKw, g_strdup("YF"), g_strdup("EX")); + g_hash_table_insert(expectedReadWriteKw, g_strdup("YE"), g_strdup("")); + + dataLen = sizeof(fullVPDExample) / sizeof(uint8_t); + fd = virCreateAnonymousFile(fullVPDExample, dataLen); + resList = virPCIVPDParse(fd); + VIR_FORCE_CLOSE(fd); + + if (!resList) { + virReportError(VIR_ERR_INTERNAL_ERROR, "%s", + "The resource list is empty after parsing which is unexpected"); + return -1; + } else if (g_list_length(resList) != EXPECTED_RES_LIST_LENGTH) { + virReportError(VIR_ERR_INTERNAL_ERROR, + "The resource list length is not equal to: %d", EXPECTED_RES_LIST_LENGTH); + return -1; + } + + for (listIter = resList; listIter; listIter = g_list_next(listIter)) { + res = listIter->data; + switch (virPCIVPDResourceGetResourceType(res)->value) { + case VIR_PCI_VPD_RESOURCE_TYPE_STRING: + actualValue = virPCIVPDStringResourceGetValue((virPCIVPDStringResource *)res); + if (STRNEQ(expectedValue, actualValue)) { + virReportError(VIR_ERR_INTERNAL_ERROR, + "Unexpected string resource value: %s, expected: %s", + actualValue, expectedValue); + return -1; + } + break; + case VIR_PCI_VPD_RESOURCE_TYPE_VPD_R: + if (!testVirPCIVPDValidateKeywordResource((virPCIVPDKeywordResource *)res, + expectedReadOnlyKw)) { + virReportError(VIR_ERR_INTERNAL_ERROR, "%s", + "Keyword resource fields do not match the expected ones"); + return -1; + } + break; + case VIR_PCI_VPD_RESOURCE_TYPE_VPD_W: + if (!testVirPCIVPDValidateKeywordResource((virPCIVPDKeywordResource *)res, + expectedReadWriteKw)) { + virReportError(VIR_ERR_INTERNAL_ERROR, "%s", + "Keyword resource fields do not match the expected ones"); + return -1; + } + break; + default: + virReportError(VIR_ERR_INTERNAL_ERROR, + "%s", "unexpected resource type encountered"); + return -1; + } + } + return 0; +} + +static int +testVirPCIVPDParseFullVPDInvalid(const void *opaque G_GNUC_UNUSED) +{ + int fd = -1; + size_t dataLen = 0; + +# define VPD_INVALID_ZERO_BYTE \ + 0x00 + +# define VPD_INVALID_STRING_HEADER_DATA_LONG \ + PCI_VPD_LARGE_RESOURCE_FLAG | PCI_VPD_STRING_RESOURCE_FLAG, 0x04, 0x00, \ + VPD_STRING_RESOURCE_EXAMPLE_DATA, \ + PCI_VPD_LARGE_RESOURCE_FLAG | PCI_VPD_READ_ONLY_LARGE_RESOURCE_FLAG, 0x05, 0x00, \ + 'R', 'V', 0x02, 0xDA, 0x00, \ + PCI_VPD_RESOURCE_END_VAL + +# define VPD_INVALID_STRING_HEADER_DATA_SHORT \ + PCI_VPD_LARGE_RESOURCE_FLAG | PCI_VPD_STRING_RESOURCE_FLAG, 0x0A, 0x00, \ + VPD_STRING_RESOURCE_EXAMPLE_DATA, \ + PCI_VPD_LARGE_RESOURCE_FLAG | PCI_VPD_READ_ONLY_LARGE_RESOURCE_FLAG, 0x05, 0x00, \ + 'R', 'V', 0x02, 0xD4, 0x00, \ + PCI_VPD_RESOURCE_END_VAL + +# define VPD_NO_VPD_R \ + VPD_STRING_RESOURCE_EXAMPLE_HEADER, \ + VPD_STRING_RESOURCE_EXAMPLE_DATA, \ + PCI_VPD_RESOURCE_END_VAL + +# define VPD_R_NO_RV \ + VPD_STRING_RESOURCE_EXAMPLE_HEADER, \ + VPD_STRING_RESOURCE_EXAMPLE_DATA, \ + VPD_R_FIELDS_EXAMPLE_HEADER, \ + VPD_R_EXAMPLE_FIELDS, \ + PCI_VPD_RESOURCE_END_VAL + +# define VPD_R_INVALID_RV \ + VPD_STRING_RESOURCE_EXAMPLE_HEADER, \ + VPD_STRING_RESOURCE_EXAMPLE_DATA, \ + VPD_R_FIELDS_EXAMPLE_HEADER, \ + VPD_R_EXAMPLE_FIELDS, \ + VPD_R_EXAMPLE_INVALID_RV_FIELD, \ + PCI_VPD_RESOURCE_END_VAL + +# define VPD_R_INVALID_RV_ZERO_LENGTH \ + VPD_STRING_RESOURCE_EXAMPLE_HEADER, \ + VPD_STRING_RESOURCE_EXAMPLE_DATA, \ + PCI_VPD_LARGE_RESOURCE_FLAG | PCI_VPD_READ_ONLY_LARGE_RESOURCE_FLAG, 0x14, 0x00, \ + VPD_R_EXAMPLE_FIELDS, \ + 'R', 'V', 0x00, \ + PCI_VPD_RESOURCE_END_VAL + +/* The RW key is not expected in a VPD-R record. */ +# define VPD_R_UNEXPECTED_KEY \ + VPD_STRING_RESOURCE_EXAMPLE_HEADER, \ + VPD_STRING_RESOURCE_EXAMPLE_DATA, \ + PCI_VPD_LARGE_RESOURCE_FLAG | PCI_VPD_READ_ONLY_LARGE_RESOURCE_FLAG, 0x1B, 0x00, \ + VPD_R_EXAMPLE_FIELDS, \ + 'R', 'W', 0x02, 0x00, 0x00, \ + 'R', 'V', 0x02, 0x8F, 0x00, \ + PCI_VPD_RESOURCE_END_VAL + +# define VPD_R_INVALID_KEY_FIRST_BYTE \ + VPD_STRING_RESOURCE_EXAMPLE_HEADER, \ + VPD_STRING_RESOURCE_EXAMPLE_DATA, \ + PCI_VPD_LARGE_RESOURCE_FLAG | PCI_VPD_READ_ONLY_LARGE_RESOURCE_FLAG, 0x1B, 0x00, \ + VPD_R_EXAMPLE_FIELDS, \ + 0x07, 'A', 0x02, 0x00, 0x00, \ + 'R', 'V', 0x02, 0xE2, 0x00, \ + PCI_VPD_RESOURCE_END_VAL + +# define VPD_R_INVALID_KEY_SECOND_BYTE \ + VPD_STRING_RESOURCE_EXAMPLE_HEADER, \ + VPD_STRING_RESOURCE_EXAMPLE_DATA, \ + PCI_VPD_LARGE_RESOURCE_FLAG | PCI_VPD_READ_ONLY_LARGE_RESOURCE_FLAG, 0x1B, 0x00, \ + VPD_R_EXAMPLE_FIELDS, \ + 'V', 0x07, 0x02, 0x00, 0x00, \ + 'R', 'V', 0x02, 0xCD, 0x00, \ + PCI_VPD_RESOURCE_END_VAL + +# define VPD_R_INVALID_FIELD_VALUE \ + VPD_STRING_RESOURCE_EXAMPLE_HEADER, \ + VPD_STRING_RESOURCE_EXAMPLE_DATA, \ + PCI_VPD_LARGE_RESOURCE_FLAG | PCI_VPD_READ_ONLY_LARGE_RESOURCE_FLAG, 0x0A, 0x00, \ + 'S', 'N', 0x02, 0x04, 0x02, \ + 'R', 'V', 0x02, 0x28, 0x00, \ + PCI_VPD_RESOURCE_END_VAL + +# define VPD_INVALID_STRING_RESOURCE_VALUE \ + VPD_STRING_RESOURCE_EXAMPLE_HEADER, \ + 't', 0x03, 's', 't', 'n', 'a', 'm', 'e', \ + PCI_VPD_LARGE_RESOURCE_FLAG | PCI_VPD_READ_ONLY_LARGE_RESOURCE_FLAG, 0x0A, 0x00, \ + 'S', 'N', 0x02, 0x04, 0x02, \ + 'R', 'V', 0x02, 0x8A, 0x00, \ + PCI_VPD_RESOURCE_END_VAL + +# define TEST_INVALID_VPD(invalidVPD) \ + do { \ + const uint8_t testCase[] = { invalidVPD }; \ + dataLen = sizeof(testCase) / sizeof(uint8_t); \ + fd = virCreateAnonymousFile(testCase, dataLen); \ + if (virPCIVPDParse(fd)) { \ + virReportError(VIR_ERR_INTERNAL_ERROR, "%s", \ + "Successfully parsed an invalid VPD - this is not expected"); \ + return -1; \ + } \ + VIR_FORCE_CLOSE(fd); \ + } while (0); + + TEST_INVALID_VPD(VPD_INVALID_ZERO_BYTE); + TEST_INVALID_VPD(VPD_INVALID_STRING_HEADER_DATA_SHORT); + TEST_INVALID_VPD(VPD_INVALID_STRING_HEADER_DATA_LONG); + TEST_INVALID_VPD(VPD_NO_VPD_R); + TEST_INVALID_VPD(VPD_R_NO_RV); + TEST_INVALID_VPD(VPD_R_INVALID_RV); + TEST_INVALID_VPD(VPD_R_INVALID_RV_ZERO_LENGTH); + TEST_INVALID_VPD(VPD_R_UNEXPECTED_KEY); + TEST_INVALID_VPD(VPD_R_INVALID_KEY_FIRST_BYTE); + TEST_INVALID_VPD(VPD_R_INVALID_KEY_SECOND_BYTE); + TEST_INVALID_VPD(VPD_R_INVALID_FIELD_VALUE); + TEST_INVALID_VPD(VPD_INVALID_STRING_RESOURCE_VALUE); + + return 0; +} + +static int +mymain(void) +{ + int ret = 0; + + if (virTestRun("String resource (basic test) ", testPCIVPDStringResourceBasic, NULL) < 0) + ret = -1; + if (virTestRun("Keyword resource (basic test) ", testPCIVPDKeywordResourceBasic, NULL) < 0) + ret = -1; + if (virTestRun("Expected read-only resource keywords ", testPCIVPDIsExpectedKeywordReadOnly, + NULL) < 0) + ret = -1; + if (virTestRun("Expected read-write resource keywords ", testPCIVPDIsExpectedKeywordReadWrite, + NULL) < 0) + ret = -1; + if (virTestRun("Valid text values ", testPCIVPDIsValidTextValue, NULL) < 0) + ret = -1; + if (virTestRun("Determining a field value format by a key ", + testPCIVPDGetFieldValueFormat, NULL) < 0) + ret = -1; + if (virTestRun("Reading VPD bytes ", testVirPCIVPDReadVPDBytes, NULL) < 0) + ret = -1; + if (virTestRun("Parsing VPD string resources ", testVirPCIVPDParseVPDStringResource, NULL) < 0) + ret = -1; + if (virTestRun("Parsing VPD resources from a full VPD ", testVirPCIVPDParseFullVPD, NULL) < 0) + ret = -1; + if (virTestRun("Parsing invalid VPD records ", testVirPCIVPDParseFullVPDInvalid, NULL) < 0) + ret = -1; + + return ret == 0 ? EXIT_SUCCESS : EXIT_FAILURE; +} + +VIR_TEST_MAIN(mymain) +#endif -- 2.30.2

Signed-off-by: Dmitrii Shcherbakov <dmitrii.shcherbakov(a)canonical.com&gt; --- NEWS.rst | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/NEWS.rst b/NEWS.rst index fd20e50d18..a4178e505c 100644 --- a/NEWS.rst +++ b/NEWS.rst @@ -29,6 +29,14 @@ v7.8.0 (unreleased) active. This information can also be retrieved with the new virsh command ``nodedev-info``. + * virpcivpd: Add a PCI VPD parser + + A parser for the standard PCI/PCIe VPD ("I.3. VPD Definitions" in PCI 2.2+ + and an equivalent definition in "6.28.1 VPD Format" PCIe 4.0) was added + along with relevant types to represent PCI VPD in memory. This + functionality got added for Linux only at this point (kernels above + v2.6.26 have support for exposing VPD via sysfs). + * **Improvements** * **Bug fixes** -- 2.30.2

Add helper functions to virpci to provide means of checking for a VPD file presence and for VPD resource retrieval using the PCI VPD parser. The added test assesses the basic functionality of VPD retrieval while the full parser is tested by virpcivpdtest. Signed-off-by: Dmitrii Shcherbakov <dmitrii.shcherbakov(a)canonical.com&gt; --- src/libvirt_private.syms | 2 ++ src/util/virpci.c | 62 ++++++++++++++++++++++++++++++++++++++ src/util/virpci.h | 3 ++ tests/virpcimock.c | 30 +++++++++++++++++++ tests/virpcitest.c | 64 ++++++++++++++++++++++++++++++++++++++++ 5 files changed, 161 insertions(+) diff --git a/src/libvirt_private.syms b/src/libvirt_private.syms index bb9b380599..ebee46ce9b 100644 --- a/src/libvirt_private.syms +++ b/src/libvirt_private.syms @@ -2988,7 +2988,9 @@ virPCIDeviceGetReprobe; virPCIDeviceGetStubDriver; virPCIDeviceGetUnbindFromStub; virPCIDeviceGetUsedBy; +virPCIDeviceGetVPDResources; virPCIDeviceHasPCIExpressLink; +virPCIDeviceHasVPD; virPCIDeviceIsAssignable; virPCIDeviceIsPCIExpress; virPCIDeviceListAdd; diff --git a/src/util/virpci.c b/src/util/virpci.c index f307580a53..480d91c17f 100644 --- a/src/util/virpci.c +++ b/src/util/virpci.c @@ -37,6 +37,7 @@ #include "virkmod.h" #include "virstring.h" #include "viralloc.h" +#include "virpcivpd.h" VIR_LOG_INIT("util.pci"); @@ -2640,6 +2641,53 @@ virPCIGetVirtualFunctionInfo(const char *vf_sysfs_device_path, return 0; } + +gboolean +virPCIDeviceHasVPD(virPCIDevice *dev) +{ + g_autofree char *vpdPath = NULL; + vpdPath = virPCIFile(dev->name, "vpd"); + if (!virFileExists(vpdPath)) { + VIR_INFO("Device VPD file does not exist %s", vpdPath); + return false; + } else if (!virFileIsRegular(vpdPath)) { + VIR_WARN("VPD path does not point to a regular file %s", vpdPath); + return false; + } + return true; +} + +/** + * virPCIDeviceGetVPDResources: + * @dev: a PCI device to get a list of VPD resources for. + * + * Obtain resources stored in the PCI device's Vital Product Data (VPD). + * VPD is optional in both PCI Local Bus and PCIe specifications so there is + * no guarantee it will be there for a particular device. + * + * Returns: a pointer to a list of VPDResource types which needs to be freed by the caller or + * NULL if getting it failed for some reason. + */ +GList * +virPCIDeviceGetVPDResources(virPCIDevice *dev) +{ + g_autofree char *vpdPath = NULL; + int fd; + + vpdPath = virPCIFile(dev->name, "vpd"); + if (!virPCIDeviceHasVPD(dev)) { + virReportError(VIR_ERR_INTERNAL_ERROR, _("Device %s does not have a VPD"), + virPCIDeviceGetName(dev)); + return NULL; + } + if ((fd = open(vpdPath, O_RDONLY)) < 0) { + virReportSystemError(-fd, + _("Failed to open a VPD file '%s'"), vpdPath); + return NULL; + } + return virPCIVPDParse(fd); +} + #else static const char *unsupported = N_("not supported on non-linux platforms"); @@ -2713,6 +2761,20 @@ virPCIGetVirtualFunctionInfo(const char *vf_sysfs_device_path G_GNUC_UNUSED, virReportError(VIR_ERR_INTERNAL_ERROR, "%s", _(unsupported)); return -1; } + +gboolean +virPCIDeviceHasVPD(virPCIDevice *dev) +{ + virReportError(VIR_ERR_INTERNAL_ERROR, "%s", _(unsupported)); + return NULL; +} + +GList * +virPCIDeviceGetVPDResources(virPCIDevice *dev) +{ + virReportError(VIR_ERR_INTERNAL_ERROR, "%s", _(unsupported)); + return NULL; +} #endif /* __linux__ */ int diff --git a/src/util/virpci.h b/src/util/virpci.h index 9a3db6c6d8..a89561496b 100644 --- a/src/util/virpci.h +++ b/src/util/virpci.h @@ -269,6 +269,9 @@ int virPCIGetVirtualFunctionInfo(const char *vf_sysfs_device_path, char **pfname, int *vf_index); +gboolean virPCIDeviceHasVPD(virPCIDevice *dev); +GList * virPCIDeviceGetVPDResources(virPCIDevice *dev); + int virPCIDeviceUnbind(virPCIDevice *dev); int virPCIDeviceRebind(virPCIDevice *dev); int virPCIDeviceGetDriverPathAndName(virPCIDevice *dev, diff --git a/tests/virpcimock.c b/tests/virpcimock.c index d4d43aac51..e10ebce76f 100644 --- a/tests/virpcimock.c +++ b/tests/virpcimock.c @@ -18,6 +18,8 @@ #include <config.h> +#include "virpcivpd.h" + #if defined(__linux__) || defined(__FreeBSD__) || defined(__APPLE__) # define VIR_MOCK_LOOKUP_MAIN # include "virmock.h" @@ -123,6 +125,13 @@ struct pciDeviceAddress { }; # define ADDR_STR_FMT "%04x:%02x:%02x.%u" +struct pciVPD { + /* PCI VPD contents (binary, may contain NULLs), NULL if not present. */ + const char *data; + /* VPD length in bytes. */ + size_t vpd_len; +}; + struct pciDevice { struct pciDeviceAddress addr; int vendor; @@ -131,6 +140,7 @@ struct pciDevice { int iommuGroup; const char *physfn; struct pciDriver *driver; /* Driver attached. NULL if attached to no driver */ + struct pciVPD vpd; }; struct fdCallback { @@ -537,6 +547,10 @@ pci_device_new_from_stub(const struct pciDevice *data) make_symlink(devpath, "physfn", tmp); } + if (dev->vpd.data && dev->vpd.vpd_len) { + make_file(devpath, "vpd", dev->vpd.data, dev->vpd.vpd_len); + } + if (pci_device_autobind(dev) < 0) ABORT("Unable to bind: %s", devid); @@ -942,6 +956,20 @@ static void init_env(void) { g_autofree char *tmp = NULL; + const char fullVPDExampleData[] = { + PCI_VPD_LARGE_RESOURCE_FLAG | PCI_VPD_STRING_RESOURCE_FLAG, 0x08, 0x00, + 't', 'e', 's', 't', 'n', 'a', 'm', 'e', + PCI_VPD_LARGE_RESOURCE_FLAG | PCI_VPD_READ_ONLY_LARGE_RESOURCE_FLAG, 0x16, 0x00, + 'P', 'N', 0x02, '4', '2', + 'E', 'C', 0x04, '4', '2', '4', '2', + 'V', 'A', 0x02, 'E', 'X', + 'R', 'V', 0x02, 0x31, 0x00, + PCI_VPD_RESOURCE_END_VAL + }; + struct pciVPD exampleVPD = { + .data = fullVPDExampleData, + .vpd_len = sizeof(fullVPDExampleData) / sizeof(fullVPDExampleData[0]), + }; if (!(fakerootdir = getenv("LIBVIRT_FAKE_ROOT_DIR"))) ABORT("Missing LIBVIRT_FAKE_ROOT_DIR env variable\n"); @@ -1008,6 +1036,8 @@ init_env(void) MAKE_PCI_DEVICE("0000:01:00.0", 0x1cc1, 0x8201, 14, .klass = 0x010802); MAKE_PCI_DEVICE("0000:02:00.0", 0x1cc1, 0x8201, 15, .klass = 0x010802); + + MAKE_PCI_DEVICE("0000:03:00.0", 0x15b3, 0xa2d6, 16, .vpd = exampleVPD); } diff --git a/tests/virpcitest.c b/tests/virpcitest.c index 6fe9b7d13a..c6bf12ba0b 100644 --- a/tests/virpcitest.c +++ b/tests/virpcitest.c @@ -17,6 +17,7 @@ */ #include <config.h> +#include "internal.h" #include "testutils.h" @@ -26,6 +27,7 @@ # include <sys/stat.h> # include <fcntl.h> # include <virpci.h> +# include <virpcivpd.h> # define VIR_FROM_THIS VIR_FROM_NONE @@ -328,6 +330,66 @@ testVirPCIDeviceUnbind(const void *opaque) return ret; } + +static gboolean +testVirPCIGetOneResourceField(gpointer *key, gpointer *val, gpointer userData) +{ + const char **fieldValue = (const char **)userData; + if (STREQ((const char*)key, "PN")) { + *fieldValue = (const char*)val; + return true; + } + return false; +} + +static int +testVirPCIDeviceGetVPDResources(const void *opaque) +{ + const struct testPCIDevData *data = opaque; + int ret = -1; + g_autofree virPCIDevice *dev = NULL; + virPCIDeviceAddress devAddr = {.domain = data->domain, .bus = data->bus, + .slot = data->slot, .function = data->function}; + g_autofree GList *resources = NULL; + const char* resValue = NULL; + const char* fieldValue = NULL; + virPCIVPDStringResource *strRes; + virPCIVPDKeywordResource *kwRes; + + dev = virPCIDeviceNew(&devAddr); + if (!dev) { + return ret; + } + + resources = virPCIDeviceGetVPDResources(dev); + + /* Here we simply check that 2 resources are present and their basic use. + * Full parser validation is done elsewhere. + */ + if (g_list_length(resources) != 2) { + return ret; + } + + strRes = g_list_nth_data(resources, 0); + resValue = virPCIVPDStringResourceGetValue(strRes); + if (STRNEQ(resValue, "testname")) { + VIR_TEST_DEBUG("Unexpected string resource value: %s", resValue); + return ret; + } + kwRes = g_list_nth_data(resources, 1); + virPCIVPDKeywordResourceForEach(kwRes, + (GTraverseFunc)testVirPCIGetOneResourceField, &fieldValue); + + if (!fieldValue || STRNEQ(fieldValue, "42")) { + VIR_TEST_DEBUG("Could not retrieve an expected value from the Keyword resource: %s", + resValue); + return ret; + } + + ret = 0; + return ret; +} + # define FAKEROOTDIRTEMPLATE abs_builddir "/fakerootdir-XXXXXX" static int @@ -409,6 +471,8 @@ mymain(void) DO_TEST_PCI(testVirPCIDeviceReattachSingle, 0, 0x0a, 3, 0); DO_TEST_PCI_DRIVER(0, 0x0a, 3, 0, NULL); + DO_TEST_PCI(testVirPCIDeviceGetVPDResources, 0, 0x03, 0, 0); + if (getenv("LIBVIRT_SKIP_CLEANUP") == NULL) virFileDeleteTree(fakerootdir); -- 2.30.2

Signed-off-by: Dmitrii Shcherbakov <dmitrii.shcherbakov(a)canonical.com&gt; --- NEWS.rst | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/NEWS.rst b/NEWS.rst index a4178e505c..4617198f82 100644 --- a/NEWS.rst +++ b/NEWS.rst @@ -37,6 +37,13 @@ v7.8.0 (unreleased) functionality got added for Linux only at this point (kernels above v2.6.26 have support for exposing VPD via sysfs). + * virpci: Add PCI VPD-related helper functions to virpci + + In order to utilize the PCI VPD parser, a couple of helper functions got + introduced to check for the presence of a VPD file in the sysfs tree and + to invoke the PCI VPD parser to get a list of resources representing PCI + VPD contents in memory. + * **Improvements** * **Bug fixes** -- 2.30.2

On Mon, Sep 27, 2021 at 10:30:51PM +0300, Dmitrii Shcherbakov wrote: I've got a general comment about what do any of these 2-letter keywords actually mean. I presume they are explaned in the PCI spec, but AFAICT the spec is not publically available for free. So at the very least we need to document each one's meaning in libvirt docs IMHO. If I had insight into what they meant, then I might also suggest giving them meaningful names in libvirt. These two level codes are presumably chosen for reasons of space efficiency at the low level. This is not a constraint we especially care about in libvirt, where ease of understanding is usually more important. Regards, Daniel -- |: https://berrange.com -o- https://www.flickr.com/photos/dberrange :| |: https://libvirt.org -o- https://fstop138.berrange.com :| |: https://entangle-photo.org -o- https://www.instagram.com/dberrange :|

Describes the format of the newly added VPD capability and gives and example for a real-world device. Signed-off-by: Dmitrii Shcherbakov <dmitrii.shcherbakov(a)canonical.com&gt; --- docs/drvnodedev.html.in | 46 +++++++++++++++++++++++++++++++++++++++++ docs/formatnode.html.in | 24 ++++++++++++++++++++- 2 files changed, 69 insertions(+), 1 deletion(-) diff --git a/docs/drvnodedev.html.in b/docs/drvnodedev.html.in index 70f7e6717d..438d20f2dd 100644 --- a/docs/drvnodedev.html.in +++ b/docs/drvnodedev.html.in @@ -185,6 +185,52 @@ &lt;/capability&gt; &lt;/device&gt;</pre> + <h3><a id="VPDCap">VPD capability</a></h3> + <p> + A device that exposes a PCI/PCIe VPD capability will include a nested + capability <code>vpd</code> which presents all resources (string, read-only + and read-write keyword resources) that may be contained in a valid VPD + entry. The XML format follows the binary format described in + "I.3. VPD Definitions" in PCI Local Bus (2.2+) and the identical format + in PCIe 4.0+. At the time of writing, the support for exposing this capability + is only present on Linux-based systems (kernel version v2.6.26 is the first one + to expose VPD via sysfs which Libvirt relies on). Reading the VPD contents requires + root privileges, therefore, <code>virsh nodedev-dumpxml</code> must be executed + accordingly. + A description of the XML format for the <code>vpd</code> capability can + be found <a href="formatnode.html#VPDCap">here</a>. + </p> + <p> + The following example shows a VPD representation for a device that exposes the + VPD capability with a string resource and a VPD-R resource. Among other things, + the VPD of this particular device includes a unique board serial number in the + "SN" field. + </p> +<pre> +&lt;device&gt; + &lt;!-- ... --&gt; + &lt;driver&gt; + &lt;name&gt;mlx5_core&lt;/name&gt; + &lt;/driver&gt; + &lt;capability type=&apos;pci&apos;&gt; + &lt;!-- ... --&gt; + &lt;capability type=&apos;vpd&apos;&gt; + &lt;resource type=&apos;string&apos;&gt;BlueField-2 DPU 25GbE Dual-Port SFP56, 16GB on-board DDR, 1GbE OOB management, Tall Bracket&lt;/resource&gt; + &lt;resource type=&apos;vpd-r&apos;&gt; + &lt;field keyword=&apos;SN&apos;&gt;MT2113X00000&lt;/field&gt; + &lt;field keyword=&apos;V3&apos;&gt;d644e35a61d0eb11e000e8cef671bf3e&lt;/field&gt; + &lt;field keyword=&apos;VA&apos;&gt;MLX:MN=MLNX:CSKU=V2:UUID=V3:PCI=V0:MODL=BF2H332A&lt;/field&gt; + &lt;field keyword=&apos;PN&apos;&gt;MBF2H332A-AEEOT&lt;/field&gt; + &lt;field keyword=&apos;V2&apos;&gt;MBF2H332A-AEEOT&lt;/field&gt; + &lt;field keyword=&apos;EC&apos;&gt;B1&lt;/field&gt; + &lt;field keyword=&apos;V0&apos;&gt;PCIeGen4 x8&lt;/field&gt; + &lt;/resource&gt; + &lt;/capability&gt; + &lt;!-- ... --&gt; + &lt;/capability&gt; +&lt;/device&gt; +</pre> + <h2><a id="MDEV">Mediated devices (MDEVs)</a></h2> <p> Mediated devices (<span class="since">Since 3.2.0</span>) are software diff --git a/docs/formatnode.html.in b/docs/formatnode.html.in index 3b3c3105d4..3e8c771398 100644 --- a/docs/formatnode.html.in +++ b/docs/formatnode.html.in @@ -162,7 +162,13 @@ This device is capable of creating mediated devices. The sub-elements are summarized in <a href="#MDEVTypesCap">mdev_types capability</a>. - </dd> + </dd> + <dt><code><a id="VPDCapPCI">vpd</a></code></dt> + <dd> + This device exposes a VPD PCI/PCIe capability. + The sub-elements are summarized in + <a href="#VPDCap">vpd capability</a>. + </dd> </dl> </dd> @@ -592,5 +598,21 @@ &lt;/device&gt; </pre> + <h3><a id="VPDCap">vpd capability</a></h3> + + <p> + <a href="#VPDCapPCI">PCI</a> devices can expose a VPD capability which + is optional per PCI Local Bus 2.2+ and PCIe 4.0+ specifications. If + the VPD capability is present, then the parent <code>capability</code> + element with the <code>vpd</code> type will contain a list of + <code>resource</code> elements with contents applicable to a + particular resource type (string or keyword resources). The + <code>resource</code> element will either contain a string + resource value or a list of <code>field</code> elements in + the case of keyword resources. <code>field</code> elements + contain a <code>keyword</code> attribute corresponding to the + 2-byte VPD keyword and text as element data representing the + field value. + </p> </body> </html> -- 2.30.2