Skip to content

Commit

Permalink
smbios: support setting OEM strings table
Browse files Browse the repository at this point in the history
The cloud-init program currently allows fetching of its data by repurposing of
the 'system' type 'serial' field. This is a clear abuse of the serial field that
would clash with other valid usage a virt management app might have for that
field.

Fortunately the SMBIOS defines an "OEM Strings" table whose puporse is to allow
exposing of arbitrary vendor specific strings to the operating system. This is
perfect for use with cloud-init, or as a way to pass arguments to OS installers
such as anaconda.

This patch makes it easier to support this with QEMU. e.g.

  $QEMU -smbios type=11,value=Hello,value=World,value=Tricky,,value=test

Which results in the guest seeing dmidecode data

  Handle 0x0E00, DMI type 11, 5 bytes
  OEM Strings
          String 1: Hello
          String 2: World
          String 3: Tricky,value=test

It is suggested that any app wanting to make use of this OEM strings capability
for accepting data from the host mgmt layer should use its name as a string
prefix. e.g. to expose OEM strings targetting both cloud init and anaconda in
parallel the mgmt app could set

  $QEMU -smbios type=11,value=cloud-init:ds=nocloud-net;s=http://10.10.0.1:8000/,\
        value=anaconda:method=http://dl.fedoraproject.org/pub/fedora/linux/releases/25/x86_64/os

which would appear as

  Handle 0x0E00, DMI type 11, 5 bytes
  OEM Strings
          String 1: cloud-init:ds=nocloud-net;s=http://10.10.0.1:8000/
          String 2: anaconda:method=http://dl.fedoraproject.org/pub/fedora/linux/releases/25/x86_64/os

Use of such string prefixes means the app won't have to care which string slot
its data appears in.

Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
Reviewed-by: Michael S. Tsirkin <mst@redhat.com>
Signed-off-by: Michael S. Tsirkin <mst@redhat.com>
  • Loading branch information
berrange authored and mstsirkin committed Dec 5, 2017
1 parent 2babfe0 commit 2d6dcbf
Show file tree
Hide file tree
Showing 3 changed files with 90 additions and 0 deletions.
72 changes: 72 additions & 0 deletions hw/smbios/smbios.c
Expand Up @@ -95,6 +95,11 @@ static struct {
const char *sock_pfx, *manufacturer, *version, *serial, *asset, *part;
} type4;

static struct {
size_t nvalues;
const char **values;
} type11;

static struct {
const char *loc_pfx, *bank, *manufacturer, *serial, *asset, *part;
uint16_t speed;
Expand Down Expand Up @@ -282,6 +287,14 @@ static const QemuOptDesc qemu_smbios_type4_opts[] = {
{ /* end of list */ }
};

static const QemuOptDesc qemu_smbios_type11_opts[] = {
{
.name = "value",
.type = QEMU_OPT_STRING,
.help = "OEM string data",
},
};

static const QemuOptDesc qemu_smbios_type17_opts[] = {
{
.name = "type",
Expand Down Expand Up @@ -590,6 +603,27 @@ static void smbios_build_type_4_table(unsigned instance)
smbios_type4_count++;
}

static void smbios_build_type_11_table(void)
{
char count_str[128];
size_t i;

if (type11.nvalues == 0) {
return;
}

SMBIOS_BUILD_TABLE_PRE(11, 0xe00, true); /* required */

snprintf(count_str, sizeof(count_str), "%zu", type11.nvalues);
t->count = type11.nvalues;

for (i = 0; i < type11.nvalues; i++) {
SMBIOS_TABLE_SET_STR_LIST(11, type11.values[i]);
}

SMBIOS_BUILD_TABLE_POST;
}

#define ONE_KB ((ram_addr_t)1 << 10)
#define ONE_MB ((ram_addr_t)1 << 20)
#define ONE_GB ((ram_addr_t)1 << 30)
Expand Down Expand Up @@ -832,6 +866,8 @@ void smbios_get_tables(const struct smbios_phys_mem_area *mem_array,
smbios_build_type_4_table(i);
}

smbios_build_type_11_table();

#define MAX_DIMM_SZ (16ll * ONE_GB)
#define GET_DIMM_SZ ((i < dimm_cnt - 1) ? MAX_DIMM_SZ \
: ((ram_size - 1) % MAX_DIMM_SZ) + 1)
Expand Down Expand Up @@ -882,6 +918,38 @@ static void save_opt(const char **dest, QemuOpts *opts, const char *name)
}
}


struct opt_list {
const char *name;
size_t *ndest;
const char ***dest;
};

static int save_opt_one(void *opaque,
const char *name, const char *value,
Error **errp)
{
struct opt_list *opt = opaque;

if (!g_str_equal(name, opt->name)) {
return 0;
}

*opt->dest = g_renew(const char *, *opt->dest, (*opt->ndest) + 1);
(*opt->dest)[*opt->ndest] = value;
(*opt->ndest)++;
return 0;
}

static void save_opt_list(size_t *ndest, const char ***dest,
QemuOpts *opts, const char *name)
{
struct opt_list opt = {
name, ndest, dest,
};
qemu_opt_foreach(opts, save_opt_one, &opt, NULL);
}

void smbios_entry_add(QemuOpts *opts, Error **errp)
{
const char *val;
Expand Down Expand Up @@ -1035,6 +1103,10 @@ void smbios_entry_add(QemuOpts *opts, Error **errp)
save_opt(&type4.asset, opts, "asset");
save_opt(&type4.part, opts, "part");
return;
case 11:
qemu_opts_validate(opts, qemu_smbios_type11_opts, &error_fatal);
save_opt_list(&type11.nvalues, &type11.values, opts, "value");
return;
case 17:
qemu_opts_validate(opts, qemu_smbios_type17_opts, &error_fatal);
save_opt(&type17.loc_pfx, opts, "loc_pfx");
Expand Down
12 changes: 12 additions & 0 deletions hw/smbios/smbios_build.h
Expand Up @@ -63,6 +63,18 @@ extern unsigned smbios_table_cnt;
} \
} while (0)

#define SMBIOS_TABLE_SET_STR_LIST(tbl_type, value) \
do { \
int len = (value != NULL) ? strlen(value) + 1 : 0; \
if (len > 1) { \
smbios_tables = g_realloc(smbios_tables, \
smbios_tables_len + len); \
memcpy(smbios_tables + smbios_tables_len, value, len); \
smbios_tables_len += len; \
++str_index; \
} \
} while (0)

#define SMBIOS_BUILD_TABLE_POST \
do { \
size_t term_cnt, t_size; \
Expand Down
6 changes: 6 additions & 0 deletions include/hw/smbios/smbios.h
Expand Up @@ -195,6 +195,12 @@ struct smbios_type_4 {
uint16_t processor_family2;
} QEMU_PACKED;

/* SMBIOS type 11 - OEM strings */
struct smbios_type_11 {
struct smbios_structure_header header;
uint8_t count;
} QEMU_PACKED;

/* SMBIOS type 16 - Physical Memory Array (v2.7) */
struct smbios_type_16 {
struct smbios_structure_header header;
Expand Down

0 comments on commit 2d6dcbf

Please sign in to comment.