hw/nvme: Add NVMe NGUID property
This patch adds a way to specify an NGUID for a given NVMe Namespace using a string of hexadecimal digits with an optional '-' separator to group bytes. For instance: -device nvme-ns,nguid="e9accd3b83904e13167cf0593437f57d" If provided, the NGUID will be part of the Namespace Identification Descriptor list and the Identify Namespace data. Signed-off-by: Roque Arcudia Hernandez <roqueh@google.com> Signed-off-by: Nabih Estefan <nabihestefan@google.com> Reviewed-by: Klaus Jensen <k.jensen@samsung.com> Signed-off-by: Klaus Jensen <k.jensen@samsung.com>
This commit is contained in:
Roque Arcudia Hernandez
Klaus Jensen
parent
00d7dffe87
commit
bdc31646c5
@ -81,6 +81,13 @@ There are a number of parameters available:
|
||||
Set the UUID of the namespace. This will be reported as a "Namespace UUID"
|
||||
descriptor in the Namespace Identification Descriptor List.
|
||||
|
||||
``nguid``
|
||||
Set the NGUID of the namespace. This will be reported as a "Namespace Globally
|
||||
Unique Identifier" descriptor in the Namespace Identification Descriptor List.
|
||||
It is specified as a string of hexadecimal digits containing exactly 16 bytes
|
||||
or "auto" for a random value. An optional '-' separator could be used to group
|
||||
bytes. If not specified the NGUID will remain all zeros.
|
||||
|
||||
``eui64``
|
||||
Set the EUI-64 of the namespace. This will be reported as a "IEEE Extended
|
||||
Unique Identifier" descriptor in the Namespace Identification Descriptor List.
|
||||
|
||||
@ -5640,6 +5640,10 @@ static uint16_t nvme_identify_ns_descr_list(NvmeCtrl *n, NvmeRequest *req)
|
||||
NvmeIdNsDescr hdr;
|
||||
uint8_t v[NVME_NIDL_UUID];
|
||||
} QEMU_PACKED uuid = {};
|
||||
struct {
|
||||
NvmeIdNsDescr hdr;
|
||||
uint8_t v[NVME_NIDL_NGUID];
|
||||
} QEMU_PACKED nguid = {};
|
||||
struct {
|
||||
NvmeIdNsDescr hdr;
|
||||
uint64_t v;
|
||||
@ -5668,6 +5672,14 @@ static uint16_t nvme_identify_ns_descr_list(NvmeCtrl *n, NvmeRequest *req)
|
||||
pos += sizeof(uuid);
|
||||
}
|
||||
|
||||
if (!nvme_nguid_is_null(&ns->params.nguid)) {
|
||||
nguid.hdr.nidt = NVME_NIDT_NGUID;
|
||||
nguid.hdr.nidl = NVME_NIDL_NGUID;
|
||||
memcpy(nguid.v, ns->params.nguid.data, NVME_NIDL_NGUID);
|
||||
memcpy(pos, &nguid, sizeof(nguid));
|
||||
pos += sizeof(nguid);
|
||||
}
|
||||
|
||||
if (ns->params.eui64) {
|
||||
eui64.hdr.nidt = NVME_NIDT_EUI64;
|
||||
eui64.hdr.nidl = NVME_NIDL_EUI64;
|
||||
|
||||
@ -1 +1 @@
|
||||
system_ss.add(when: 'CONFIG_NVME_PCI', if_true: files('ctrl.c', 'dif.c', 'ns.c', 'subsys.c'))
|
||||
system_ss.add(when: 'CONFIG_NVME_PCI', if_true: files('ctrl.c', 'dif.c', 'ns.c', 'subsys.c', 'nguid.c'))
|
||||
187
hw/nvme/nguid.c
Normal file
187
hw/nvme/nguid.c
Normal file
@ -0,0 +1,187 @@
|
||||
/*
|
||||
* QEMU NVMe NGUID functions
|
||||
*
|
||||
* Copyright 2024 Google LLC
|
||||
*
|
||||
* This program is free software; you can redistribute it and/or modify it
|
||||
* under the terms of the GNU General Public License as published by the
|
||||
* Free Software Foundation; either version 2 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* This program 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 General Public License
|
||||
* for more details.
|
||||
*/
|
||||
|
||||
#include "qemu/osdep.h"
|
||||
#include "qapi/visitor.h"
|
||||
#include "qemu/ctype.h"
|
||||
#include "nvme.h"
|
||||
|
||||
#define NGUID_SEPARATOR '-'
|
||||
|
||||
#define NGUID_VALUE_AUTO "auto"
|
||||
|
||||
#define NGUID_FMT \
|
||||
"%02hhx%02hhx%02hhx%02hhx" \
|
||||
"%02hhx%02hhx%02hhx%02hhx" \
|
||||
"%02hhx%02hhx%02hhx%02hhx" \
|
||||
"%02hhx%02hhx%02hhx%02hhx"
|
||||
|
||||
#define NGUID_STR_LEN (2 * NGUID_LEN + 1)
|
||||
|
||||
bool nvme_nguid_is_null(const NvmeNGUID *nguid)
|
||||
{
|
||||
static NvmeNGUID null_nguid;
|
||||
return memcmp(nguid, &null_nguid, sizeof(NvmeNGUID)) == 0;
|
||||
}
|
||||
|
||||
static void nvme_nguid_generate(NvmeNGUID *out)
|
||||
{
|
||||
int i;
|
||||
uint32_t x;
|
||||
|
||||
QEMU_BUILD_BUG_ON((NGUID_LEN % sizeof(x)) != 0);
|
||||
|
||||
for (i = 0; i < NGUID_LEN; i += sizeof(x)) {
|
||||
x = g_random_int();
|
||||
memcpy(&out->data[i], &x, sizeof(x));
|
||||
}
|
||||
}
|
||||
|
||||
/*
|
||||
* The Linux Kernel typically prints the NGUID of an NVMe namespace using the
|
||||
* same format as the UUID. For instance:
|
||||
*
|
||||
* $ cat /sys/class/block/nvme0n1/nguid
|
||||
* e9accd3b-8390-4e13-167c-f0593437f57d
|
||||
*
|
||||
* When there is no UUID but there is NGUID the Kernel will print the NGUID as
|
||||
* wwid and it won't use the UUID format:
|
||||
*
|
||||
* $ cat /sys/class/block/nvme0n1/wwid
|
||||
* eui.e9accd3b83904e13167cf0593437f57d
|
||||
*
|
||||
* The NGUID has different fields compared to the UUID, so the grouping used in
|
||||
* the UUID format has no relation with the 3 fields of the NGUID.
|
||||
*
|
||||
* This implementation won't expect a strict format as the UUID one and instead
|
||||
* it will admit any string of hexadecimal digits. Byte groups could be created
|
||||
* using the '-' separator. The number of bytes needs to be exactly 16 and the
|
||||
* separator '-' has to be exactly in a byte boundary. The following are
|
||||
* examples of accepted formats for the NGUID string:
|
||||
*
|
||||
* nguid="e9accd3b-8390-4e13-167c-f0593437f57d"
|
||||
* nguid="e9accd3b83904e13167cf0593437f57d"
|
||||
* nguid="FEDCBA9876543210-ABCDEF-0123456789"
|
||||
*/
|
||||
static bool nvme_nguid_is_valid(const char *str)
|
||||
{
|
||||
int i;
|
||||
int digit_count = 0;
|
||||
|
||||
for (i = 0; i < strlen(str); i++) {
|
||||
const char c = str[i];
|
||||
if (qemu_isxdigit(c)) {
|
||||
digit_count++;
|
||||
continue;
|
||||
}
|
||||
if (c == NGUID_SEPARATOR) {
|
||||
/*
|
||||
* We need to make sure the separator is in a byte boundary, the
|
||||
* string does not start with the separator and they are not back to
|
||||
* back "--".
|
||||
*/
|
||||
if ((i > 0) && (str[i - 1] != NGUID_SEPARATOR) &&
|
||||
(digit_count % 2) == 0) {
|
||||
continue;
|
||||
}
|
||||
}
|
||||
return false;
|
||||
}
|
||||
/*
|
||||
* The string should have the correct byte length and not finish with the
|
||||
* separator
|
||||
*/
|
||||
return (digit_count == (2 * NGUID_LEN)) && (str[i - 1] != NGUID_SEPARATOR);
|
||||
}
|
||||
|
||||
static int nvme_nguid_parse(const char *str, NvmeNGUID *nguid)
|
||||
{
|
||||
uint8_t *id = &nguid->data[0];
|
||||
int ret = 0;
|
||||
int i;
|
||||
const char *ptr = str;
|
||||
|
||||
if (!nvme_nguid_is_valid(str)) {
|
||||
return -1;
|
||||
}
|
||||
|
||||
for (i = 0; i < NGUID_LEN; i++) {
|
||||
ret = sscanf(ptr, "%02hhx", &id[i]);
|
||||
if (ret != 1) {
|
||||
return -1;
|
||||
}
|
||||
ptr += 2;
|
||||
if (*ptr == NGUID_SEPARATOR) {
|
||||
ptr++;
|
||||
}
|
||||
}
|
||||
|
||||
return 0;
|
||||
}
|
||||
|
||||
/*
|
||||
* When converted back to string this implementation will use a raw hex number
|
||||
* with no separators, for instance:
|
||||
*
|
||||
* "e9accd3b83904e13167cf0593437f57d"
|
||||
*/
|
||||
static void nvme_nguid_stringify(const NvmeNGUID *nguid, char *out)
|
||||
{
|
||||
const uint8_t *id = &nguid->data[0];
|
||||
snprintf(out, NGUID_STR_LEN, NGUID_FMT,
|
||||
id[0], id[1], id[2], id[3], id[4], id[5], id[6], id[7],
|
||||
id[8], id[9], id[10], id[11], id[12], id[13], id[14], id[15]);
|
||||
}
|
||||
|
||||
static void get_nguid(Object *obj, Visitor *v, const char *name, void *opaque,
|
||||
Error **errp)
|
||||
{
|
||||
Property *prop = opaque;
|
||||
NvmeNGUID *nguid = object_field_prop_ptr(obj, prop);
|
||||
char buffer[NGUID_STR_LEN];
|
||||
char *p = buffer;
|
||||
|
||||
nvme_nguid_stringify(nguid, buffer);
|
||||
|
||||
visit_type_str(v, name, &p, errp);
|
||||
}
|
||||
|
||||
static void set_nguid(Object *obj, Visitor *v, const char *name, void *opaque,
|
||||
Error **errp)
|
||||
{
|
||||
Property *prop = opaque;
|
||||
NvmeNGUID *nguid = object_field_prop_ptr(obj, prop);
|
||||
char *str;
|
||||
|
||||
if (!visit_type_str(v, name, &str, errp)) {
|
||||
return;
|
||||
}
|
||||
|
||||
if (!strcmp(str, NGUID_VALUE_AUTO)) {
|
||||
nvme_nguid_generate(nguid);
|
||||
} else if (nvme_nguid_parse(str, nguid) < 0) {
|
||||
error_set_from_qdev_prop_error(errp, EINVAL, obj, name, str);
|
||||
}
|
||||
g_free(str);
|
||||
}
|
||||
|
||||
const PropertyInfo qdev_prop_nguid = {
|
||||
.name = "str",
|
||||
.description =
|
||||
"NGUID or \"" NGUID_VALUE_AUTO "\" for random value",
|
||||
.get = get_nguid,
|
||||
.set = set_nguid,
|
||||
};
|
||||
@ -89,6 +89,7 @@ static int nvme_ns_init(NvmeNamespace *ns, Error **errp)
|
||||
id_ns->mcl = cpu_to_le32(ns->params.mcl);
|
||||
id_ns->msrc = ns->params.msrc;
|
||||
id_ns->eui64 = cpu_to_be64(ns->params.eui64);
|
||||
memcpy(&id_ns->nguid, &ns->params.nguid.data, sizeof(id_ns->nguid));
|
||||
|
||||
ds = 31 - clz32(ns->blkconf.logical_block_size);
|
||||
ms = ns->params.ms;
|
||||
@ -797,6 +798,7 @@ static Property nvme_ns_props[] = {
|
||||
DEFINE_PROP_BOOL("shared", NvmeNamespace, params.shared, true),
|
||||
DEFINE_PROP_UINT32("nsid", NvmeNamespace, params.nsid, 0),
|
||||
DEFINE_PROP_UUID_NODEFAULT("uuid", NvmeNamespace, params.uuid),
|
||||
DEFINE_PROP_NGUID_NODEFAULT("nguid", NvmeNamespace, params.nguid),
|
||||
DEFINE_PROP_UINT64("eui64", NvmeNamespace, params.eui64, 0),
|
||||
DEFINE_PROP_UINT16("ms", NvmeNamespace, params.ms, 0),
|
||||
DEFINE_PROP_UINT8("mset", NvmeNamespace, params.mset, 0),
|
||||
|
||||
@ -171,13 +171,27 @@ static const uint8_t nvme_fdp_evf_shifts[FDP_EVT_MAX] = {
|
||||
[FDP_EVT_RUH_IMPLICIT_RU_CHANGE] = 33,
|
||||
};
|
||||
|
||||
#define NGUID_LEN 16
|
||||
|
||||
typedef struct {
|
||||
uint8_t data[NGUID_LEN];
|
||||
} NvmeNGUID;
|
||||
|
||||
bool nvme_nguid_is_null(const NvmeNGUID *nguid);
|
||||
|
||||
extern const PropertyInfo qdev_prop_nguid;
|
||||
|
||||
#define DEFINE_PROP_NGUID_NODEFAULT(_name, _state, _field) \
|
||||
DEFINE_PROP(_name, _state, _field, qdev_prop_nguid, NvmeNGUID)
|
||||
|
||||
typedef struct NvmeNamespaceParams {
|
||||
bool detached;
|
||||
bool shared;
|
||||
uint32_t nsid;
|
||||
QemuUUID uuid;
|
||||
uint64_t eui64;
|
||||
bool eui64_default;
|
||||
bool detached;
|
||||
bool shared;
|
||||
uint32_t nsid;
|
||||
QemuUUID uuid;
|
||||
NvmeNGUID nguid;
|
||||
uint64_t eui64;
|
||||
bool eui64_default;
|
||||
|
||||
uint16_t ms;
|
||||
uint8_t mset;
|
||||
|
||||
Loading…
Reference in New Issue
Block a user