qemu-devel.nongnu.org archive mirror
 help / color / mirror / Atom feed
* [PATCH v6 0/2] tpm: add mssim backend
@ 2023-01-09 16:15 James Bottomley
  2023-01-09 16:15 ` [PATCH v6 1/2] tpm: convert tpmdev options processing to new visitor format James Bottomley
  2023-01-09 16:15 ` [PATCH v6 2/2] tpm: add backend for mssim James Bottomley
  0 siblings, 2 replies; 12+ messages in thread
From: James Bottomley @ 2023-01-09 16:15 UTC (permalink / raw)
  To: qemu-devel; +Cc: Daniel P . Berrangé, Markus Armbruster, Stefan Berger

From: James Bottomley <James.Bottomley@HansenPartnership.com>

The requested feedback was to convert the tpmdev handler to being json
based, which requires rethreading all the backends.  The good news is
this reduced quite a bit of code (especially as I converted it to
error_fatal handling as well, which removes the return status
threading).  The bad news is I can't test any of the conversions.
swtpm still isn't building on opensuse and, apparently, passthrough
doesn't like my native TPM because it doesn't allow cancellation.

v3 pulls out more unneeded code in the visitor conversion, makes
migration work on external state preservation of the simulator and
adds documentation

v4 puts back the wrapper options (but doesn't add any for mssim since
it post dates the necessity)

v5 rebases to the latest master branch and adjusts for removed use_FOO ptrs

v5 updates help to exit zero; does some checkpatch tidying

James

---

James Bottomley (2):
  tpm: convert tpmdev options processing to new visitor format
  tpm: add backend for mssim

 MAINTAINERS                    |   6 +
 backends/tpm/Kconfig           |   5 +
 backends/tpm/meson.build       |   1 +
 backends/tpm/tpm_emulator.c    |  24 +--
 backends/tpm/tpm_mssim.c       | 290 +++++++++++++++++++++++++++++++++
 backends/tpm/tpm_mssim.h       |  44 +++++
 backends/tpm/tpm_passthrough.c |  22 +--
 docs/specs/tpm.rst             |  35 ++++
 include/sysemu/tpm.h           |   4 +-
 include/sysemu/tpm_backend.h   |   2 +-
 monitor/hmp-cmds.c             |   9 +
 qapi/tpm.json                  |  45 ++++-
 softmmu/tpm.c                  |  90 ++++------
 softmmu/vl.c                   |  19 +--
 14 files changed, 488 insertions(+), 108 deletions(-)
 create mode 100644 backends/tpm/tpm_mssim.c
 create mode 100644 backends/tpm/tpm_mssim.h

-- 
2.35.3



^ permalink raw reply	[flat|nested] 12+ messages in thread

* [PATCH v6 1/2] tpm: convert tpmdev options processing to new visitor format
  2023-01-09 16:15 [PATCH v6 0/2] tpm: add mssim backend James Bottomley
@ 2023-01-09 16:15 ` James Bottomley
  2023-09-26 15:20   ` Stefan Berger
  2023-01-09 16:15 ` [PATCH v6 2/2] tpm: add backend for mssim James Bottomley
  1 sibling, 1 reply; 12+ messages in thread
From: James Bottomley @ 2023-01-09 16:15 UTC (permalink / raw)
  To: qemu-devel; +Cc: Daniel P . Berrangé, Markus Armbruster, Stefan Berger

From: James Bottomley <James.Bottomley@HansenPartnership.com>

Instead of processing the tpmdev options using the old qemu options,
convert to the new visitor format which also allows the passing of
json on the command line.

Signed-off-by: James Bottomley <jejb@linux.ibm.com>

---
v4: add TpmConfiOptions
v5: exit(0) for help
---
 backends/tpm/tpm_emulator.c    | 24 ++++-----
 backends/tpm/tpm_passthrough.c | 22 +++------
 include/sysemu/tpm.h           |  4 +-
 include/sysemu/tpm_backend.h   |  2 +-
 qapi/tpm.json                  | 19 +++++++
 softmmu/tpm.c                  | 90 ++++++++++++++--------------------
 softmmu/vl.c                   | 19 +------
 7 files changed, 75 insertions(+), 105 deletions(-)

diff --git a/backends/tpm/tpm_emulator.c b/backends/tpm/tpm_emulator.c
index 49cc3d749d..cb6bf9d7c2 100644
--- a/backends/tpm/tpm_emulator.c
+++ b/backends/tpm/tpm_emulator.c
@@ -584,33 +584,28 @@ err_exit:
     return -1;
 }
 
-static int tpm_emulator_handle_device_opts(TPMEmulator *tpm_emu, QemuOpts *opts)
+static int tpm_emulator_handle_device_opts(TPMEmulator *tpm_emu, TpmCreateOptions *opts)
 {
-    const char *value;
     Error *err = NULL;
     Chardev *dev;
 
-    value = qemu_opt_get(opts, "chardev");
-    if (!value) {
-        error_report("tpm-emulator: parameter 'chardev' is missing");
-        goto err;
-    }
+    tpm_emu->options = QAPI_CLONE(TPMEmulatorOptions, &opts->u.emulator);
+    tpm_emu->data_ioc = NULL;
 
-    dev = qemu_chr_find(value);
+    dev = qemu_chr_find(opts->u.emulator.chardev);
     if (!dev) {
-        error_report("tpm-emulator: tpm chardev '%s' not found", value);
+        error_report("tpm-emulator: tpm chardev '%s' not found",
+                opts->u.emulator.chardev);
         goto err;
     }
 
     if (!qemu_chr_fe_init(&tpm_emu->ctrl_chr, dev, &err)) {
         error_prepend(&err, "tpm-emulator: No valid chardev found at '%s':",
-                      value);
+                      opts->u.emulator.chardev);
         error_report_err(err);
         goto err;
     }
 
-    tpm_emu->options->chardev = g_strdup(value);
-
     if (tpm_emulator_prepare_data_fd(tpm_emu) < 0) {
         goto err;
     }
@@ -649,7 +644,7 @@ err:
     return -1;
 }
 
-static TPMBackend *tpm_emulator_create(QemuOpts *opts)
+static TPMBackend *tpm_emulator_create(TpmCreateOptions *opts)
 {
     TPMBackend *tb = TPM_BACKEND(object_new(TYPE_TPM_EMULATOR));
 
@@ -972,7 +967,6 @@ static void tpm_emulator_inst_init(Object *obj)
 
     trace_tpm_emulator_inst_init();
 
-    tpm_emu->options = g_new0(TPMEmulatorOptions, 1);
     tpm_emu->cur_locty_number = ~0;
     qemu_mutex_init(&tpm_emu->mutex);
     tpm_emu->vmstate =
@@ -990,7 +984,7 @@ static void tpm_emulator_shutdown(TPMEmulator *tpm_emu)
 {
     ptm_res res;
 
-    if (!tpm_emu->options->chardev) {
+    if (!tpm_emu->data_ioc) {
         /* was never properly initialized */
         return;
     }
diff --git a/backends/tpm/tpm_passthrough.c b/backends/tpm/tpm_passthrough.c
index 179697a3a9..3da467ef01 100644
--- a/backends/tpm/tpm_passthrough.c
+++ b/backends/tpm/tpm_passthrough.c
@@ -252,21 +252,12 @@ static int tpm_passthrough_open_sysfs_cancel(TPMPassthruState *tpm_pt)
 }
 
 static int
-tpm_passthrough_handle_device_opts(TPMPassthruState *tpm_pt, QemuOpts *opts)
+tpm_passthrough_handle_device_opts(TPMPassthruState *tpm_pt, TpmCreateOptions *opts)
 {
-    const char *value;
+    tpm_pt->options = QAPI_CLONE(TPMPassthroughOptions, &opts->u.passthrough);
 
-    value = qemu_opt_get(opts, "cancel-path");
-    if (value) {
-        tpm_pt->options->cancel_path = g_strdup(value);
-    }
-
-    value = qemu_opt_get(opts, "path");
-    if (value) {
-        tpm_pt->options->path = g_strdup(value);
-    }
-
-    tpm_pt->tpm_dev = value ? value : TPM_PASSTHROUGH_DEFAULT_DEVICE;
+    tpm_pt->tpm_dev = opts->u.passthrough.path ? opts->u.passthrough.path :
+            TPM_PASSTHROUGH_DEFAULT_DEVICE;
     tpm_pt->tpm_fd = qemu_open_old(tpm_pt->tpm_dev, O_RDWR);
     if (tpm_pt->tpm_fd < 0) {
         error_report("Cannot access TPM device using '%s': %s",
@@ -288,11 +279,11 @@ tpm_passthrough_handle_device_opts(TPMPassthruState *tpm_pt, QemuOpts *opts)
     return 0;
 }
 
-static TPMBackend *tpm_passthrough_create(QemuOpts *opts)
+static TPMBackend *tpm_passthrough_create(TpmCreateOptions *tco)
 {
     Object *obj = object_new(TYPE_TPM_PASSTHROUGH);
 
-    if (tpm_passthrough_handle_device_opts(TPM_PASSTHROUGH(obj), opts)) {
+    if (tpm_passthrough_handle_device_opts(TPM_PASSTHROUGH(obj), tco)) {
         object_unref(obj);
         return NULL;
     }
@@ -344,7 +335,6 @@ static void tpm_passthrough_inst_init(Object *obj)
 {
     TPMPassthruState *tpm_pt = TPM_PASSTHROUGH(obj);
 
-    tpm_pt->options = g_new0(TPMPassthroughOptions, 1);
     tpm_pt->tpm_fd = -1;
     tpm_pt->cancel_fd = -1;
 }
diff --git a/include/sysemu/tpm.h b/include/sysemu/tpm.h
index fb40e30ff6..d00a833a21 100644
--- a/include/sysemu/tpm.h
+++ b/include/sysemu/tpm.h
@@ -17,8 +17,8 @@
 
 #ifdef CONFIG_TPM
 
-int tpm_config_parse(QemuOptsList *opts_list, const char *optarg);
-int tpm_init(void);
+void tpm_config_parse(const char *optarg);
+void tpm_init(void);
 void tpm_cleanup(void);
 
 typedef enum TPMVersion {
diff --git a/include/sysemu/tpm_backend.h b/include/sysemu/tpm_backend.h
index 8fd3269c11..846a9e39fa 100644
--- a/include/sysemu/tpm_backend.h
+++ b/include/sysemu/tpm_backend.h
@@ -57,7 +57,7 @@ struct TPMBackendClass {
     /* get a descriptive text of the backend to display to the user */
     const char *desc;
 
-    TPMBackend *(*create)(QemuOpts *opts);
+    TPMBackend *(*create)(TpmCreateOptions *tco);
 
     /* start up the TPM on the backend - optional */
     int (*startup_tpm)(TPMBackend *t, size_t buffersize);
diff --git a/qapi/tpm.json b/qapi/tpm.json
index 4e2ea9756a..2b491c28b4 100644
--- a/qapi/tpm.json
+++ b/qapi/tpm.json
@@ -134,6 +134,25 @@
             'emulator': 'TPMEmulatorOptionsWrapper' },
   'if': 'CONFIG_TPM' }
 
+##
+# @TpmCreateOptions:
+#
+# A union referencing different TPM backend types' configuration options
+#   without the wrapper to be usable by visitors.
+#
+# @type: - 'passthrough' The configuration options for the TPM passthrough type
+#        - 'emulator' The configuration options for TPM emulator backend type
+#
+# Since: 7.2
+##
+{ 'union': 'TpmCreateOptions',
+  'base': { 'type': 'TpmType',
+            'id' : 'str' },
+  'discriminator': 'type',
+  'data': { 'passthrough' : 'TPMPassthroughOptions',
+            'emulator': 'TPMEmulatorOptions' },
+  'if': 'CONFIG_TPM' }
+
 ##
 # @TPMInfo:
 #
diff --git a/softmmu/tpm.c b/softmmu/tpm.c
index 578563f05a..fa84a53b96 100644
--- a/softmmu/tpm.c
+++ b/softmmu/tpm.c
@@ -17,14 +17,26 @@
 #include "qapi/error.h"
 #include "qapi/qapi-commands-tpm.h"
 #include "qapi/qmp/qerror.h"
+#include "qapi/qobject-input-visitor.h"
+#include "qapi/qapi-visit-tpm.h"
 #include "sysemu/tpm_backend.h"
 #include "sysemu/tpm.h"
 #include "qemu/config-file.h"
 #include "qemu/error-report.h"
+#include "qemu/help_option.h"
 
 static QLIST_HEAD(, TPMBackend) tpm_backends =
     QLIST_HEAD_INITIALIZER(tpm_backends);
 
+typedef struct TpmCreateOptionsQueueEntry {
+        TpmCreateOptions *tco;
+        QSIMPLEQ_ENTRY(TpmCreateOptionsQueueEntry) entry;
+} TpmCreateOptionsQueueEntry;
+
+typedef QSIMPLEQ_HEAD(, TpmCreateOptionsQueueEntry) TpmCreateOptionsQueue;
+
+static TpmCreateOptionsQueue tco_queue = QSIMPLEQ_HEAD_INITIALIZER(tco_queue);
+
 static const TPMBackendClass *
 tpm_be_find_by_type(enum TpmType type)
 {
@@ -84,63 +96,31 @@ TPMBackend *qemu_find_tpm_be(const char *id)
     return NULL;
 }
 
-static int tpm_init_tpmdev(void *dummy, QemuOpts *opts, Error **errp)
+static void tpm_init_tpmdev(TpmCreateOptions *tco)
 {
-    /*
-     * Use of error_report() in a function with an Error ** parameter
-     * is suspicious.  It is okay here.  The parameter only exists to
-     * make the function usable with qemu_opts_foreach().  It is not
-     * actually used.
-     */
-    const char *value;
-    const char *id;
     const TPMBackendClass *be;
     TPMBackend *drv;
-    Error *local_err = NULL;
-    int i;
 
     if (!QLIST_EMPTY(&tpm_backends)) {
         error_report("Only one TPM is allowed.");
-        return 1;
+        exit(1);
     }
 
-    id = qemu_opts_id(opts);
-    if (id == NULL) {
-        error_report(QERR_MISSING_PARAMETER, "id");
-        return 1;
-    }
-
-    value = qemu_opt_get(opts, "type");
-    if (!value) {
-        error_report(QERR_MISSING_PARAMETER, "type");
-        tpm_display_backend_drivers();
-        return 1;
-    }
-
-    i = qapi_enum_parse(&TpmType_lookup, value, -1, NULL);
-    be = i >= 0 ? tpm_be_find_by_type(i) : NULL;
+    be = tco->type >= 0 ? tpm_be_find_by_type(tco->type) : NULL;
     if (be == NULL) {
         error_report(QERR_INVALID_PARAMETER_VALUE,
                      "type", "a TPM backend type");
         tpm_display_backend_drivers();
-        return 1;
-    }
-
-    /* validate backend specific opts */
-    if (!qemu_opts_validate(opts, be->opts, &local_err)) {
-        error_report_err(local_err);
-        return 1;
+        exit(1);
     }
 
-    drv = be->create(opts);
+    drv = be->create(tco);
     if (!drv) {
-        return 1;
+        exit(1);
     }
 
-    drv->id = g_strdup(id);
+    drv->id = g_strdup(tco->id);
     QLIST_INSERT_HEAD(&tpm_backends, drv, list);
-
-    return 0;
 }
 
 /*
@@ -161,33 +141,35 @@ void tpm_cleanup(void)
  * Initialize the TPM. Process the tpmdev command line options describing the
  * TPM backend.
  */
-int tpm_init(void)
+void tpm_init(void)
 {
-    if (qemu_opts_foreach(qemu_find_opts("tpmdev"),
-                          tpm_init_tpmdev, NULL, NULL)) {
-        return -1;
-    }
+    while (!QSIMPLEQ_EMPTY(&tco_queue)) {
+        TpmCreateOptionsQueueEntry *tcoqe = QSIMPLEQ_FIRST(&tco_queue);
 
-    return 0;
+        QSIMPLEQ_REMOVE_HEAD(&tco_queue, entry);
+        tpm_init_tpmdev(tcoqe->tco);
+        g_free(tcoqe);
+    }
 }
 
 /*
  * Parse the TPM configuration options.
  * To display all available TPM backends the user may use '-tpmdev help'
  */
-int tpm_config_parse(QemuOptsList *opts_list, const char *optarg)
+void tpm_config_parse(const char *optarg)
 {
-    QemuOpts *opts;
+    Visitor *v;
+    TpmCreateOptionsQueueEntry *tcqe;
 
-    if (!strcmp(optarg, "help")) {
+    if (is_help_option(optarg)) {
         tpm_display_backend_drivers();
-        return -1;
-    }
-    opts = qemu_opts_parse_noisily(opts_list, optarg, true);
-    if (!opts) {
-        return -1;
+        exit(0);
     }
-    return 0;
+    v = qobject_input_visitor_new_str(optarg, "type", &error_fatal);
+    tcqe = g_new(TpmCreateOptionsQueueEntry, 1);
+    visit_type_TpmCreateOptions(v, NULL, &tcqe->tco, &error_fatal);
+    visit_free(v);
+    QSIMPLEQ_INSERT_TAIL(&tco_queue, tcqe, entry);
 }
 
 /*
diff --git a/softmmu/vl.c b/softmmu/vl.c
index 798e1dc933..8c2655dbc2 100644
--- a/softmmu/vl.c
+++ b/softmmu/vl.c
@@ -328,16 +328,6 @@ static QemuOptsList qemu_object_opts = {
     },
 };
 
-static QemuOptsList qemu_tpmdev_opts = {
-    .name = "tpmdev",
-    .implied_opt_name = "type",
-    .head = QTAILQ_HEAD_INITIALIZER(qemu_tpmdev_opts.head),
-    .desc = {
-        /* options are defined in the TPM backends */
-        { /* end of list */ }
-    },
-};
-
 static QemuOptsList qemu_overcommit_opts = {
     .name = "overcommit",
     .head = QTAILQ_HEAD_INITIALIZER(qemu_overcommit_opts.head),
@@ -1934,9 +1924,7 @@ static void qemu_create_late_backends(void)
 
     object_option_foreach_add(object_create_late);
 
-    if (tpm_init() < 0) {
-        exit(1);
-    }
+    tpm_init();
 
     qemu_opts_foreach(qemu_find_opts("mon"),
                       mon_init_func, NULL, &error_fatal);
@@ -2658,7 +2646,6 @@ void qemu_init(int argc, char **argv)
     qemu_add_opts(&qemu_boot_opts);
     qemu_add_opts(&qemu_add_fd_opts);
     qemu_add_opts(&qemu_object_opts);
-    qemu_add_opts(&qemu_tpmdev_opts);
     qemu_add_opts(&qemu_overcommit_opts);
     qemu_add_opts(&qemu_msg_opts);
     qemu_add_opts(&qemu_name_opts);
@@ -2906,9 +2893,7 @@ void qemu_init(int argc, char **argv)
                 break;
 #ifdef CONFIG_TPM
             case QEMU_OPTION_tpmdev:
-                if (tpm_config_parse(qemu_find_opts("tpmdev"), optarg) < 0) {
-                    exit(1);
-                }
+                tpm_config_parse(optarg);
                 break;
 #endif
             case QEMU_OPTION_mempath:
-- 
2.35.3



^ permalink raw reply related	[flat|nested] 12+ messages in thread

* [PATCH v6 2/2] tpm: add backend for mssim
  2023-01-09 16:15 [PATCH v6 0/2] tpm: add mssim backend James Bottomley
  2023-01-09 16:15 ` [PATCH v6 1/2] tpm: convert tpmdev options processing to new visitor format James Bottomley
@ 2023-01-09 16:15 ` James Bottomley
  2023-09-22  6:00   ` Markus Armbruster
  1 sibling, 1 reply; 12+ messages in thread
From: James Bottomley @ 2023-01-09 16:15 UTC (permalink / raw)
  To: qemu-devel; +Cc: Daniel P . Berrangé, Markus Armbruster, Stefan Berger

From: James Bottomley <James.Bottomley@HansenPartnership.com>

The Microsoft Simulator (mssim) is the reference emulation platform
for the TCG TPM 2.0 specification.

https://github.com/Microsoft/ms-tpm-20-ref.git

It exports a fairly simple network socket based protocol on two
sockets, one for command (default 2321) and one for control (default
2322).  This patch adds a simple backend that can speak the mssim
protocol over the network.  It also allows the two sockets to be
specified on the command line.  The benefits are twofold: firstly it
gives us a backend that actually speaks a standard TPM emulation
protocol instead of the linux specific TPM driver format of the
current emulated TPM backend and secondly, using the microsoft
protocol, the end point of the emulator can be anywhere on the
network, facilitating the cloud use case where a central TPM service
can be used over a control network.

The implementation does basic control commands like power off/on, but
doesn't implement cancellation or startup.  The former because
cancellation is pretty much useless on a fast operating TPM emulator
and the latter because this emulator is designed to be used with OVMF
which itself does TPM startup and I wanted to validate that.

To run this, simply download an emulator based on the MS specification
(package ibmswtpm2 on openSUSE) and run it, then add these two lines
to the qemu command and it will use the emulator.

    -tpmdev mssim,id=tpm0 \
    -device tpm-crb,tpmdev=tpm0 \

to use a remote emulator replace the first line with

    -tpmdev "{'type':'mssim','id':'tpm0','command':{'type':inet,'host':'remote','port':'2321'}}"

tpm-tis also works as the backend.

Signed-off-by: James Bottomley <jejb@linux.ibm.com>

---

v2: convert to SocketAddr json and use qio_channel_socket_connect_sync()
v3: gate control power off by migration state keep control socket disconnected
    to test outside influence and add docs.
---
 MAINTAINERS              |   6 +
 backends/tpm/Kconfig     |   5 +
 backends/tpm/meson.build |   1 +
 backends/tpm/tpm_mssim.c | 290 +++++++++++++++++++++++++++++++++++++++
 backends/tpm/tpm_mssim.h |  44 ++++++
 docs/specs/tpm.rst       |  35 +++++
 monitor/hmp-cmds.c       |   9 ++
 qapi/tpm.json            |  28 +++-
 8 files changed, 414 insertions(+), 4 deletions(-)
 create mode 100644 backends/tpm/tpm_mssim.c
 create mode 100644 backends/tpm/tpm_mssim.h

diff --git a/MAINTAINERS b/MAINTAINERS
index 7a40d4d865..666ca1eb1c 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -3063,10 +3063,16 @@ F: include/hw/acpi/tpm.h
 F: include/sysemu/tpm*
 F: qapi/tpm.json
 F: backends/tpm/
+X: backends/tpm/tpm_mssim.*
 F: tests/qtest/*tpm*
 F: docs/specs/tpm.rst
 T: git https://github.com/stefanberger/qemu-tpm.git tpm-next
 
+MSSIM TPM Backend
+M: James Bottomley <jejb@linux.ibm.com>
+S: Maintained
+F: backends/tpm/tpm_mssim.*
+
 Checkpatch
 S: Odd Fixes
 F: scripts/checkpatch.pl
diff --git a/backends/tpm/Kconfig b/backends/tpm/Kconfig
index 5d91eb89c2..d6d6fa53e9 100644
--- a/backends/tpm/Kconfig
+++ b/backends/tpm/Kconfig
@@ -12,3 +12,8 @@ config TPM_EMULATOR
     bool
     default y
     depends on TPM_BACKEND
+
+config TPM_MSSIM
+    bool
+    default y
+    depends on TPM_BACKEND
diff --git a/backends/tpm/meson.build b/backends/tpm/meson.build
index 7f2503f84e..c7c3c79125 100644
--- a/backends/tpm/meson.build
+++ b/backends/tpm/meson.build
@@ -3,4 +3,5 @@ if have_tpm
   softmmu_ss.add(files('tpm_util.c'))
   softmmu_ss.add(when: 'CONFIG_TPM_PASSTHROUGH', if_true: files('tpm_passthrough.c'))
   softmmu_ss.add(when: 'CONFIG_TPM_EMULATOR', if_true: files('tpm_emulator.c'))
+  softmmu_ss.add(when: 'CONFIG_TPM_MSSIM', if_true: files('tpm_mssim.c'))
 endif
diff --git a/backends/tpm/tpm_mssim.c b/backends/tpm/tpm_mssim.c
new file mode 100644
index 0000000000..ed1c4cfd35
--- /dev/null
+++ b/backends/tpm/tpm_mssim.c
@@ -0,0 +1,290 @@
+/*
+ * Emulator TPM driver which connects over the mssim protocol
+ * SPDX-License-Identifier: GPL-2.0-or-later
+ *
+ * Copyright (c) 2022
+ * Author: James Bottomley <jejb@linux.ibm.com>
+ */
+
+#include "qemu/osdep.h"
+#include "qemu/error-report.h"
+#include "qemu/sockets.h"
+
+#include "qapi/clone-visitor.h"
+#include "qapi/qapi-visit-tpm.h"
+
+#include "io/channel-socket.h"
+
+#include "sysemu/runstate.h"
+#include "sysemu/tpm_backend.h"
+#include "sysemu/tpm_util.h"
+
+#include "qom/object.h"
+
+#include "tpm_int.h"
+#include "tpm_mssim.h"
+
+#define ERROR_PREFIX "TPM mssim Emulator: "
+
+#define TYPE_TPM_MSSIM "tpm-mssim"
+OBJECT_DECLARE_SIMPLE_TYPE(TPMmssim, TPM_MSSIM)
+
+struct TPMmssim {
+    TPMBackend parent;
+
+    TPMmssimOptions opts;
+
+    QIOChannelSocket *cmd_qc, *ctrl_qc;
+};
+
+static int tpm_send_ctrl(TPMmssim *t, uint32_t cmd, Error **errp)
+{
+    int ret;
+
+    qio_channel_socket_connect_sync(t->ctrl_qc, t->opts.control, errp);
+    cmd = htonl(cmd);
+    ret = qio_channel_write_all(QIO_CHANNEL(t->ctrl_qc),
+                                (char *)&cmd, sizeof(cmd), errp);
+    if (ret != 0) {
+        goto out;
+    }
+
+    ret = qio_channel_read_all(QIO_CHANNEL(t->ctrl_qc),
+                               (char *)&cmd, sizeof(cmd), errp);
+    if (ret != 0) {
+        goto out;
+    }
+    if (cmd != 0) {
+        error_setg(errp, ERROR_PREFIX
+                   "Incorrect ACK recieved on control channel 0x%x", cmd);
+        ret = -1;
+    }
+ out:
+    qio_channel_close(QIO_CHANNEL(t->ctrl_qc), errp);
+    return ret;
+}
+
+static void tpm_mssim_instance_init(Object *obj)
+{
+}
+
+static void tpm_mssim_instance_finalize(Object *obj)
+{
+    TPMmssim *t = TPM_MSSIM(obj);
+
+    if (t->cmd_qc && !runstate_check(RUN_STATE_POSTMIGRATE)) {
+        tpm_send_ctrl(t, TPM_SIGNAL_POWER_OFF, NULL);
+    }
+
+    object_unref(OBJECT(t->ctrl_qc));
+    object_unref(OBJECT(t->cmd_qc));
+}
+
+static void tpm_mssim_cancel_cmd(TPMBackend *tb)
+{
+        return;
+}
+
+static TPMVersion tpm_mssim_get_version(TPMBackend *tb)
+{
+    return TPM_VERSION_2_0;
+}
+
+static size_t tpm_mssim_get_buffer_size(TPMBackend *tb)
+{
+    /* TCG standard profile max buffer size */
+    return 4096;
+}
+
+static TpmTypeOptions *tpm_mssim_get_opts(TPMBackend *tb)
+{
+    TPMmssim *t = TPM_MSSIM(tb);
+    TpmTypeOptions *opts = g_new0(TpmTypeOptions, 1);
+
+    opts->type = TPM_TYPE_MSSIM;
+    opts->u.mssim = t->opts;
+
+    return opts;
+}
+
+static void tpm_mssim_handle_request(TPMBackend *tb, TPMBackendCmd *cmd,
+                                     Error **errp)
+{
+    TPMmssim *t = TPM_MSSIM(tb);
+    uint32_t header, len;
+    uint8_t locality = cmd->locty;
+    struct iovec iov[4];
+    int ret;
+
+    header = htonl(TPM_SEND_COMMAND);
+    len = htonl(cmd->in_len);
+
+    iov[0].iov_base = &header;
+    iov[0].iov_len = sizeof(header);
+    iov[1].iov_base = &locality;
+    iov[1].iov_len = sizeof(locality);
+    iov[2].iov_base = &len;
+    iov[2].iov_len = sizeof(len);
+    iov[3].iov_base = (void *)cmd->in;
+    iov[3].iov_len = cmd->in_len;
+
+    ret = qio_channel_writev_all(QIO_CHANNEL(t->cmd_qc), iov, 4, errp);
+    if (ret != 0) {
+        goto fail;
+    }
+
+    ret = qio_channel_read_all(QIO_CHANNEL(t->cmd_qc),
+                               (char *)&len, sizeof(len), errp);
+    if (ret != 0) {
+        goto fail;
+    }
+
+    len = ntohl(len);
+    if (len > cmd->out_len) {
+        error_setg(errp, "receive size is too large");
+        goto fail;
+    }
+    ret = qio_channel_read_all(QIO_CHANNEL(t->cmd_qc),
+                               (char *)cmd->out, len, errp);
+    if (ret != 0) {
+        goto fail;
+    }
+
+    /* ACK packet */
+    ret = qio_channel_read_all(QIO_CHANNEL(t->cmd_qc),
+                               (char *)&header, sizeof(header), errp);
+    if (ret != 0) {
+        goto fail;
+    }
+    if (header != 0) {
+        error_setg(errp, "incorrect ACK received on command channel 0x%x", len);
+        goto fail;
+    }
+
+    return;
+
+ fail:
+    error_prepend(errp, ERROR_PREFIX);
+    tpm_util_write_fatal_error_response(cmd->out, cmd->out_len);
+}
+
+static TPMBackend *tpm_mssim_create(TpmCreateOptions *opts)
+{
+    TPMBackend *be = TPM_BACKEND(object_new(TYPE_TPM_MSSIM));
+    TPMmssim *t = TPM_MSSIM(be);
+    int sock;
+    Error *errp = NULL;
+    TPMmssimOptions *mo = &opts->u.mssim;
+
+    if (!mo->command) {
+            mo->command = g_new0(SocketAddress, 1);
+            mo->command->type = SOCKET_ADDRESS_TYPE_INET;
+            mo->command->u.inet.host = g_strdup("localhost");
+            mo->command->u.inet.port = g_strdup("2321");
+    }
+    if (!mo->control) {
+            int port;
+
+            mo->control = g_new0(SocketAddress, 1);
+            mo->control->type = SOCKET_ADDRESS_TYPE_INET;
+            mo->control->u.inet.host = g_strdup(mo->command->u.inet.host);
+            /*
+             * in the reference implementation, the control port is
+             * always one above the command port
+             */
+            port = atoi(mo->command->u.inet.port) + 1;
+            mo->control->u.inet.port = g_strdup_printf("%d", port);
+    }
+
+    t->opts = opts->u.mssim;
+    t->cmd_qc = qio_channel_socket_new();
+    t->ctrl_qc = qio_channel_socket_new();
+
+    if (qio_channel_socket_connect_sync(t->cmd_qc, mo->command, &errp) < 0) {
+        goto fail;
+    }
+
+    if (qio_channel_socket_connect_sync(t->ctrl_qc, mo->control, &errp) < 0) {
+        goto fail;
+    }
+    qio_channel_close(QIO_CHANNEL(t->ctrl_qc), &errp);
+
+    if (!runstate_check(RUN_STATE_INMIGRATE)) {
+        /*
+         * reset the TPM using a power cycle sequence, in case someone
+         * has previously powered it up
+         */
+        sock = tpm_send_ctrl(t, TPM_SIGNAL_POWER_OFF, &errp);
+        if (sock != 0) {
+            goto fail;
+        }
+
+        sock = tpm_send_ctrl(t, TPM_SIGNAL_POWER_ON, &errp);
+        if (sock != 0) {
+            goto fail;
+        }
+
+        sock = tpm_send_ctrl(t, TPM_SIGNAL_NV_ON, &errp);
+        if (sock != 0) {
+            goto fail;
+        }
+    }
+
+    return be;
+
+ fail:
+    object_unref(OBJECT(t->ctrl_qc));
+    object_unref(OBJECT(t->cmd_qc));
+    t->ctrl_qc = NULL;
+    t->cmd_qc = NULL;
+    error_prepend(&errp, ERROR_PREFIX);
+    error_report_err(errp);
+    object_unref(OBJECT(be));
+
+    return NULL;
+}
+
+static const QemuOptDesc tpm_mssim_cmdline_opts[] = {
+    TPM_STANDARD_CMDLINE_OPTS,
+    {
+        .name = "command",
+        .type = QEMU_OPT_STRING,
+        .help = "Command socket (default localhost:2321)",
+    },
+    {
+        .name = "control",
+        .type = QEMU_OPT_STRING,
+        .help = "control socket (default localhost:2322)",
+    },
+};
+
+static void tpm_mssim_class_init(ObjectClass *klass, void *data)
+{
+    TPMBackendClass *cl = TPM_BACKEND_CLASS(klass);
+
+    cl->type = TPM_TYPE_MSSIM;
+    cl->opts = tpm_mssim_cmdline_opts;
+    cl->desc = "TPM mssim emulator backend driver";
+    cl->create = tpm_mssim_create;
+    cl->cancel_cmd = tpm_mssim_cancel_cmd;
+    cl->get_tpm_version = tpm_mssim_get_version;
+    cl->get_buffer_size = tpm_mssim_get_buffer_size;
+    cl->get_tpm_options = tpm_mssim_get_opts;
+    cl->handle_request = tpm_mssim_handle_request;
+}
+
+static const TypeInfo tpm_mssim_info = {
+    .name = TYPE_TPM_MSSIM,
+    .parent = TYPE_TPM_BACKEND,
+    .instance_size = sizeof(TPMmssim),
+    .class_init = tpm_mssim_class_init,
+    .instance_init = tpm_mssim_instance_init,
+    .instance_finalize = tpm_mssim_instance_finalize,
+};
+
+static void tpm_mssim_register(void)
+{
+    type_register_static(&tpm_mssim_info);
+}
+
+type_init(tpm_mssim_register)
diff --git a/backends/tpm/tpm_mssim.h b/backends/tpm/tpm_mssim.h
new file mode 100644
index 0000000000..397474e4f6
--- /dev/null
+++ b/backends/tpm/tpm_mssim.h
@@ -0,0 +1,44 @@
+/*
+ * SPDX-License-Identifier: BSD-2-Clause
+ *
+ * The code below is copied from the Microsoft/TCG Reference implementation
+ *
+ *  https://github.com/Microsoft/ms-tpm-20-ref.git
+ *
+ * In file TPMCmd/Simulator/include/TpmTcpProtocol.h
+ */
+
+#define TPM_SIGNAL_POWER_ON         1
+#define TPM_SIGNAL_POWER_OFF        2
+#define TPM_SIGNAL_PHYS_PRES_ON     3
+#define TPM_SIGNAL_PHYS_PRES_OFF    4
+#define TPM_SIGNAL_HASH_START       5
+#define TPM_SIGNAL_HASH_DATA        6
+/* {uint32_t BufferSize, uint8_t[BufferSize] Buffer} */
+#define TPM_SIGNAL_HASH_END         7
+#define TPM_SEND_COMMAND            8
+/*
+ * {uint8_t Locality, uint32_t InBufferSize, uint8_t[InBufferSize] InBuffer} ->
+ *   {uint32_t OutBufferSize, uint8_t[OutBufferSize] OutBuffer}
+ */
+#define TPM_SIGNAL_CANCEL_ON        9
+#define TPM_SIGNAL_CANCEL_OFF       10
+#define TPM_SIGNAL_NV_ON            11
+#define TPM_SIGNAL_NV_OFF           12
+#define TPM_SIGNAL_KEY_CACHE_ON     13
+#define TPM_SIGNAL_KEY_CACHE_OFF    14
+
+#define TPM_REMOTE_HANDSHAKE        15
+#define TPM_SET_ALTERNATIVE_RESULT  16
+
+#define TPM_SIGNAL_RESET            17
+#define TPM_SIGNAL_RESTART          18
+
+#define TPM_SESSION_END             20
+#define TPM_STOP                    21
+
+#define TPM_GET_COMMAND_RESPONSE_SIZES  25
+
+#define TPM_ACT_GET_SIGNALED        26
+
+#define TPM_TEST_FAILURE_MODE       30
diff --git a/docs/specs/tpm.rst b/docs/specs/tpm.rst
index 535912a92b..1398735956 100644
--- a/docs/specs/tpm.rst
+++ b/docs/specs/tpm.rst
@@ -270,6 +270,38 @@ available as a module (assuming a TPM 2 is passed through):
   /sys/devices/LNXSYSTEM:00/LNXSYBUS:00/MSFT0101:00/tpm/tpm0/pcr-sha256/9
   ...
 
+The QEMU TPM Microsoft Simulator Device
+---------------------------------------
+
+The TCG provides a reference implementation for TPM 2.0 written by
+Microsoft (See `ms-tpm-20-ref`_ on github).  The reference implementation
+starts a network server and listens for TPM commands on port 2321 and
+TPM Platform control commands on port 2322, although these can be
+altered.  The QEMU mssim TPM backend talks to this implementation.  By
+default it connects to the default ports on localhost:
+
+.. code-block:: console
+
+  qemu-system-x86_64 <qemu-options> \
+    -tpmdev mssim,id=tpm0 \
+    -device tpm-crb,tpmdev=tpm0
+
+
+Although it can also communicate with a remote host, which must be
+specified as a SocketAddress via json on the command line for each of
+the command and control ports:
+
+.. code-block:: console
+
+  qemu-system-x86_64 <qemu-options> \
+    -tpmdev "{'type':'mssim','id':'tpm0','command':{'type':'inet','host':'remote','port':'2321'},'control':{'type':'inet','host':'remote','port':'2322'}}" \
+    -device tpm-crb,tpmdev=tpm0
+
+
+The mssim backend supports snapshotting and migration, but the state
+of the Microsoft Simulator server must be preserved (or the server
+kept running) outside of QEMU for restore to be successful.
+
 The QEMU TPM emulator device
 ----------------------------
 
@@ -526,3 +558,6 @@ the following:
 
 .. _SWTPM protocol:
    https://github.com/stefanberger/swtpm/blob/master/man/man3/swtpm_ioctls.pod
+
+.. _ms-tpm-20-ref:
+   https://github.com/microsoft/ms-tpm-20-ref
diff --git a/monitor/hmp-cmds.c b/monitor/hmp-cmds.c
index ed78a87ddd..12482368d0 100644
--- a/monitor/hmp-cmds.c
+++ b/monitor/hmp-cmds.c
@@ -731,6 +731,7 @@ void hmp_info_tpm(Monitor *mon, const QDict *qdict)
     unsigned int c = 0;
     TPMPassthroughOptions *tpo;
     TPMEmulatorOptions *teo;
+    TPMmssimOptions *tmo;
 
     info_list = qmp_query_tpm(&err);
     if (err) {
@@ -764,6 +765,14 @@ void hmp_info_tpm(Monitor *mon, const QDict *qdict)
             teo = ti->options->u.emulator.data;
             monitor_printf(mon, ",chardev=%s", teo->chardev);
             break;
+        case TPM_TYPE_MSSIM:
+            tmo = &ti->options->u.mssim;
+            monitor_printf(mon, ",command=%s:%s,control=%s:%s",
+                           tmo->command->u.inet.host,
+                           tmo->command->u.inet.port,
+                           tmo->control->u.inet.host,
+                           tmo->control->u.inet.port);
+            break;
         case TPM_TYPE__MAX:
             break;
         }
diff --git a/qapi/tpm.json b/qapi/tpm.json
index 2b491c28b4..f9dde35377 100644
--- a/qapi/tpm.json
+++ b/qapi/tpm.json
@@ -5,6 +5,7 @@
 ##
 # = TPM (trusted platform module) devices
 ##
+{ 'include': 'sockets.json' }
 
 ##
 # @TpmModel:
@@ -49,7 +50,7 @@
 #
 # Since: 1.5
 ##
-{ 'enum': 'TpmType', 'data': [ 'passthrough', 'emulator' ],
+{ 'enum': 'TpmType', 'data': [ 'passthrough', 'emulator', 'mssim' ],
   'if': 'CONFIG_TPM' }
 
 ##
@@ -64,7 +65,7 @@
 # Example:
 #
 # -> { "execute": "query-tpm-types" }
-# <- { "return": [ "passthrough", "emulator" ] }
+# <- { "return": [ "passthrough", "emulator", "mssim" ] }
 #
 ##
 { 'command': 'query-tpm-types', 'returns': ['TpmType'],
@@ -117,6 +118,22 @@
   'data': { 'data': 'TPMEmulatorOptions' },
   'if': 'CONFIG_TPM' }
 
+##
+# @TPMmssimOptions:
+#
+# Information for the mssim emulator connection
+#
+# @command: command socket for the TPM emulator
+# @control: control socket for the TPM emulator
+#
+# Since: 7.2.0
+##
+{ 'struct': 'TPMmssimOptions',
+  'data': {
+      '*command': 'SocketAddress',
+      '*control': 'SocketAddress' },
+  'if': 'CONFIG_TPM' }
+
 ##
 # @TpmTypeOptions:
 #
@@ -124,6 +141,7 @@
 #
 # @type: - 'passthrough' The configuration options for the TPM passthrough type
 #        - 'emulator' The configuration options for TPM emulator backend type
+#        - 'mssim' The configuration options for TPM emulator mssim type
 #
 # Since: 1.5
 ##
@@ -131,7 +149,8 @@
   'base': { 'type': 'TpmType' },
   'discriminator': 'type',
   'data': { 'passthrough' : 'TPMPassthroughOptionsWrapper',
-            'emulator': 'TPMEmulatorOptionsWrapper' },
+            'emulator': 'TPMEmulatorOptionsWrapper',
+            'mssim' : 'TPMmssimOptions' },
   'if': 'CONFIG_TPM' }
 
 ##
@@ -150,7 +169,8 @@
             'id' : 'str' },
   'discriminator': 'type',
   'data': { 'passthrough' : 'TPMPassthroughOptions',
-            'emulator': 'TPMEmulatorOptions' },
+            'emulator': 'TPMEmulatorOptions',
+            'mssim': 'TPMmssimOptions' },
   'if': 'CONFIG_TPM' }
 
 ##
-- 
2.35.3



^ permalink raw reply related	[flat|nested] 12+ messages in thread

* Re: [PATCH v6 2/2] tpm: add backend for mssim
  2023-01-09 16:15 ` [PATCH v6 2/2] tpm: add backend for mssim James Bottomley
@ 2023-09-22  6:00   ` Markus Armbruster
  2023-09-22 12:41     ` Stefan Berger
  2023-09-25 12:15     ` James Bottomley
  0 siblings, 2 replies; 12+ messages in thread
From: Markus Armbruster @ 2023-09-22  6:00 UTC (permalink / raw)
  To: James Bottomley; +Cc: qemu-devel, Daniel P . Berrangé, Stefan Berger

Found this cleaning out old mail, sorry for missing it until now!

I think we owe James a quick decision wether we're willing to take the
feature.  Stefan, thoughts?

James Bottomley <jejb@linux.ibm.com> writes:

> From: James Bottomley <James.Bottomley@HansenPartnership.com>
>
> The Microsoft Simulator (mssim) is the reference emulation platform
> for the TCG TPM 2.0 specification.
>
> https://github.com/Microsoft/ms-tpm-20-ref.git
>
> It exports a fairly simple network socket based protocol on two
> sockets, one for command (default 2321) and one for control (default
> 2322).  This patch adds a simple backend that can speak the mssim
> protocol over the network.  It also allows the two sockets to be
> specified on the command line.  The benefits are twofold: firstly it
> gives us a backend that actually speaks a standard TPM emulation
> protocol instead of the linux specific TPM driver format of the
> current emulated TPM backend and secondly, using the microsoft
> protocol, the end point of the emulator can be anywhere on the
> network, facilitating the cloud use case where a central TPM service
> can be used over a control network.
>
> The implementation does basic control commands like power off/on, but
> doesn't implement cancellation or startup.  The former because
> cancellation is pretty much useless on a fast operating TPM emulator
> and the latter because this emulator is designed to be used with OVMF
> which itself does TPM startup and I wanted to validate that.
>
> To run this, simply download an emulator based on the MS specification
> (package ibmswtpm2 on openSUSE) and run it, then add these two lines
> to the qemu command and it will use the emulator.
>
>     -tpmdev mssim,id=tpm0 \
>     -device tpm-crb,tpmdev=tpm0 \
>
> to use a remote emulator replace the first line with
>
>     -tpmdev "{'type':'mssim','id':'tpm0','command':{'type':inet,'host':'remote','port':'2321'}}"
>
> tpm-tis also works as the backend.
>
> Signed-off-by: James Bottomley <jejb@linux.ibm.com>

[...]

> diff --git a/docs/specs/tpm.rst b/docs/specs/tpm.rst
> index 535912a92b..1398735956 100644
> --- a/docs/specs/tpm.rst
> +++ b/docs/specs/tpm.rst
> @@ -270,6 +270,38 @@ available as a module (assuming a TPM 2 is passed through):
>    /sys/devices/LNXSYSTEM:00/LNXSYBUS:00/MSFT0101:00/tpm/tpm0/pcr-sha256/9
>    ...
>  
> +The QEMU TPM Microsoft Simulator Device
> +---------------------------------------
> +
> +The TCG provides a reference implementation for TPM 2.0 written by


Suggest to copy the cover letter's nice introductory paragraph here:

  The Microsoft Simulator (mssim) is the reference emulation platform
  for the TCG TPM 2.0 specification.

  It provides a reference implementation for TPM 2.0 written by

> +Microsoft (See `ms-tpm-20-ref`_ on github).  The reference implementation
> +starts a network server and listens for TPM commands on port 2321 and
> +TPM Platform control commands on port 2322, although these can be
> +altered.  The QEMU mssim TPM backend talks to this implementation.  By
> +default it connects to the default ports on localhost:
> +
> +.. code-block:: console
> +
> +  qemu-system-x86_64 <qemu-options> \
> +    -tpmdev mssim,id=tpm0 \
> +    -device tpm-crb,tpmdev=tpm0
> +
> +
> +Although it can also communicate with a remote host, which must be
> +specified as a SocketAddress via json on the command line for each of

Is the "via JSON" part in "must be specified ... on the command line"
correct?  I'd expect to be able to use dotted keys as well, like

    -tpmdev type=mssim,id=tpm0,command.type=inet,command.host=remote,command.port=2321',control.type=inet,control.host=remote,control.port=2322

Aside: I do recommend management applications stick to JSON.

> +the command and control ports:
> +
> +.. code-block:: console
> +
> +  qemu-system-x86_64 <qemu-options> \
> +    -tpmdev "{'type':'mssim','id':'tpm0','command':{'type':'inet','host':'remote','port':'2321'},'control':{'type':'inet','host':'remote','port':'2322'}}" \
> +    -device tpm-crb,tpmdev=tpm0
> +
> +
> +The mssim backend supports snapshotting and migration, but the state
> +of the Microsoft Simulator server must be preserved (or the server
> +kept running) outside of QEMU for restore to be successful.
> +
>  The QEMU TPM emulator device
>  ----------------------------
>  
> @@ -526,3 +558,6 @@ the following:
>  
>  .. _SWTPM protocol:
>     https://github.com/stefanberger/swtpm/blob/master/man/man3/swtpm_ioctls.pod
> +
> +.. _ms-tpm-20-ref:
> +   https://github.com/microsoft/ms-tpm-20-ref
> diff --git a/monitor/hmp-cmds.c b/monitor/hmp-cmds.c
> index ed78a87ddd..12482368d0 100644
> --- a/monitor/hmp-cmds.c
> +++ b/monitor/hmp-cmds.c
> @@ -731,6 +731,7 @@ void hmp_info_tpm(Monitor *mon, const QDict *qdict)
>      unsigned int c = 0;
>      TPMPassthroughOptions *tpo;
>      TPMEmulatorOptions *teo;
> +    TPMmssimOptions *tmo;
>  
>      info_list = qmp_query_tpm(&err);
>      if (err) {
> @@ -764,6 +765,14 @@ void hmp_info_tpm(Monitor *mon, const QDict *qdict)
>              teo = ti->options->u.emulator.data;
>              monitor_printf(mon, ",chardev=%s", teo->chardev);
>              break;
> +        case TPM_TYPE_MSSIM:
> +            tmo = &ti->options->u.mssim;
> +            monitor_printf(mon, ",command=%s:%s,control=%s:%s",
> +                           tmo->command->u.inet.host,
> +                           tmo->command->u.inet.port,
> +                           tmo->control->u.inet.host,
> +                           tmo->control->u.inet.port);
> +            break;
>          case TPM_TYPE__MAX:
>              break;
>          }
> diff --git a/qapi/tpm.json b/qapi/tpm.json
> index 2b491c28b4..f9dde35377 100644
> --- a/qapi/tpm.json
> +++ b/qapi/tpm.json
> @@ -5,6 +5,7 @@
>  ##
>  # = TPM (trusted platform module) devices
>  ##

Blank line, please.

> +{ 'include': 'sockets.json' }
>  
>  ##
>  # @TpmModel:
> @@ -49,7 +50,7 @@
   #
   # @passthrough: TPM passthrough type
   #
   # @emulator: Software Emulator TPM type (since 2.11)
>  #

Missing member documentation:

   # @mssim: <brief description here> (since 8.2)

>  # Since: 1.5
>  ##
> -{ 'enum': 'TpmType', 'data': [ 'passthrough', 'emulator' ],
> +{ 'enum': 'TpmType', 'data': [ 'passthrough', 'emulator', 'mssim' ],
>    'if': 'CONFIG_TPM' }
>  
>  ##
> @@ -64,7 +65,7 @@
>  # Example:
>  #
>  # -> { "execute": "query-tpm-types" }
> -# <- { "return": [ "passthrough", "emulator" ] }
> +# <- { "return": [ "passthrough", "emulator", "mssim" ] }

Thanks for updating the example.

>  #
>  ##
>  { 'command': 'query-tpm-types', 'returns': ['TpmType'],
> @@ -117,6 +118,22 @@
>    'data': { 'data': 'TPMEmulatorOptions' },
>    'if': 'CONFIG_TPM' }
>  
> +##
> +# @TPMmssimOptions:

Please capitalize similar to TPMPassthroughOptions and
TPMEmulatorOptions: TPMMssimOptions.

> +#
> +# Information for the mssim emulator connection
> +#
> +# @command: command socket for the TPM emulator

Blank line, please.

> +# @control: control socket for the TPM emulator
> +#
> +# Since: 7.2.0

Since 8.2

> +##
> +{ 'struct': 'TPMmssimOptions',
> +  'data': {
> +      '*command': 'SocketAddress',
> +      '*control': 'SocketAddress' },

Locally consistent indentation is

     'data': { '*command': 'SocketAddress',
               '*control': 'SocketAddress' },

> +  'if': 'CONFIG_TPM' }
> +
>  ##
>  # @TpmTypeOptions:
>  #
> @@ -124,6 +141,7 @@
>  #
>  # @type: - 'passthrough' The configuration options for the TPM passthrough type
>  #        - 'emulator' The configuration options for TPM emulator backend type
> +#        - 'mssim' The configuration options for TPM emulator mssim type
>  #
>  # Since: 1.5
>  ##
> @@ -131,7 +149,8 @@
>    'base': { 'type': 'TpmType' },
>    'discriminator': 'type',
>    'data': { 'passthrough' : 'TPMPassthroughOptionsWrapper',
> -            'emulator': 'TPMEmulatorOptionsWrapper' },
> +            'emulator': 'TPMEmulatorOptionsWrapper',
> +            'mssim' : 'TPMmssimOptions' },
>    'if': 'CONFIG_TPM' }
>  
>  ##
> @@ -150,7 +169,8 @@
>              'id' : 'str' },
>    'discriminator': 'type',
>    'data': { 'passthrough' : 'TPMPassthroughOptions',
> -            'emulator': 'TPMEmulatorOptions' },
> +            'emulator': 'TPMEmulatorOptions',
> +            'mssim': 'TPMmssimOptions' },
>    'if': 'CONFIG_TPM' }
>  
>  ##

Address my nitpicking, and you may add

Acked-by: Markus Armbruster <armbru@redhat.com>



^ permalink raw reply	[flat|nested] 12+ messages in thread

* Re: [PATCH v6 2/2] tpm: add backend for mssim
  2023-09-22  6:00   ` Markus Armbruster
@ 2023-09-22 12:41     ` Stefan Berger
  2023-09-22 13:02       ` Daniel P. Berrangé
  2023-09-25 12:15     ` James Bottomley
  1 sibling, 1 reply; 12+ messages in thread
From: Stefan Berger @ 2023-09-22 12:41 UTC (permalink / raw)
  To: Markus Armbruster, James Bottomley; +Cc: qemu-devel, Daniel P . Berrangé


On 9/22/23 02:00, Markus Armbruster wrote:
> Found this cleaning out old mail, sorry for missing it until now!
>
> I think we owe James a quick decision wether we're willing to take the
> feature.  Stefan, thoughts?

I thought we discusses it back then. Does it handle snapshotting and 
migration correctly?

   Stefan

>
> James Bottomley <jejb@linux.ibm.com> writes:
>
>> From: James Bottomley <James.Bottomley@HansenPartnership.com>
>>
>> The Microsoft Simulator (mssim) is the reference emulation platform
>> for the TCG TPM 2.0 specification.
>>
>> https://github.com/Microsoft/ms-tpm-20-ref.git
>>
>> It exports a fairly simple network socket based protocol on two
>> sockets, one for command (default 2321) and one for control (default
>> 2322).  This patch adds a simple backend that can speak the mssim
>> protocol over the network.  It also allows the two sockets to be
>> specified on the command line.  The benefits are twofold: firstly it
>> gives us a backend that actually speaks a standard TPM emulation
>> protocol instead of the linux specific TPM driver format of the
>> current emulated TPM backend and secondly, using the microsoft
>> protocol, the end point of the emulator can be anywhere on the
>> network, facilitating the cloud use case where a central TPM service
>> can be used over a control network.
>>
>> The implementation does basic control commands like power off/on, but
>> doesn't implement cancellation or startup.  The former because
>> cancellation is pretty much useless on a fast operating TPM emulator
>> and the latter because this emulator is designed to be used with OVMF
>> which itself does TPM startup and I wanted to validate that.
>>
>> To run this, simply download an emulator based on the MS specification
>> (package ibmswtpm2 on openSUSE) and run it, then add these two lines
>> to the qemu command and it will use the emulator.
>>
>>      -tpmdev mssim,id=tpm0 \
>>      -device tpm-crb,tpmdev=tpm0 \
>>
>> to use a remote emulator replace the first line with
>>
>>      -tpmdev "{'type':'mssim','id':'tpm0','command':{'type':inet,'host':'remote','port':'2321'}}"
>>
>> tpm-tis also works as the backend.
>>
>> Signed-off-by: James Bottomley <jejb@linux.ibm.com>
> [...]
>
>> diff --git a/docs/specs/tpm.rst b/docs/specs/tpm.rst
>> index 535912a92b..1398735956 100644
>> --- a/docs/specs/tpm.rst
>> +++ b/docs/specs/tpm.rst
>> @@ -270,6 +270,38 @@ available as a module (assuming a TPM 2 is passed through):
>>     /sys/devices/LNXSYSTEM:00/LNXSYBUS:00/MSFT0101:00/tpm/tpm0/pcr-sha256/9
>>     ...
>>   
>> +The QEMU TPM Microsoft Simulator Device
>> +---------------------------------------
>> +
>> +The TCG provides a reference implementation for TPM 2.0 written by
>
> Suggest to copy the cover letter's nice introductory paragraph here:
>
>    The Microsoft Simulator (mssim) is the reference emulation platform
>    for the TCG TPM 2.0 specification.
>
>    It provides a reference implementation for TPM 2.0 written by
>
>> +Microsoft (See `ms-tpm-20-ref`_ on github).  The reference implementation
>> +starts a network server and listens for TPM commands on port 2321 and
>> +TPM Platform control commands on port 2322, although these can be
>> +altered.  The QEMU mssim TPM backend talks to this implementation.  By
>> +default it connects to the default ports on localhost:
>> +
>> +.. code-block:: console
>> +
>> +  qemu-system-x86_64 <qemu-options> \
>> +    -tpmdev mssim,id=tpm0 \
>> +    -device tpm-crb,tpmdev=tpm0
>> +
>> +
>> +Although it can also communicate with a remote host, which must be
>> +specified as a SocketAddress via json on the command line for each of
> Is the "via JSON" part in "must be specified ... on the command line"
> correct?  I'd expect to be able to use dotted keys as well, like
>
>      -tpmdev type=mssim,id=tpm0,command.type=inet,command.host=remote,command.port=2321',control.type=inet,control.host=remote,control.port=2322
>
> Aside: I do recommend management applications stick to JSON.
>
>> +the command and control ports:
>> +
>> +.. code-block:: console
>> +
>> +  qemu-system-x86_64 <qemu-options> \
>> +    -tpmdev "{'type':'mssim','id':'tpm0','command':{'type':'inet','host':'remote','port':'2321'},'control':{'type':'inet','host':'remote','port':'2322'}}" \
>> +    -device tpm-crb,tpmdev=tpm0
>> +
>> +
>> +The mssim backend supports snapshotting and migration, but the state
>> +of the Microsoft Simulator server must be preserved (or the server
>> +kept running) outside of QEMU for restore to be successful.
>> +
>>   The QEMU TPM emulator device
>>   ----------------------------
>>   
>> @@ -526,3 +558,6 @@ the following:
>>   
>>   .. _SWTPM protocol:
>>      https://github.com/stefanberger/swtpm/blob/master/man/man3/swtpm_ioctls.pod
>> +
>> +.. _ms-tpm-20-ref:
>> +   https://github.com/microsoft/ms-tpm-20-ref
>> diff --git a/monitor/hmp-cmds.c b/monitor/hmp-cmds.c
>> index ed78a87ddd..12482368d0 100644
>> --- a/monitor/hmp-cmds.c
>> +++ b/monitor/hmp-cmds.c
>> @@ -731,6 +731,7 @@ void hmp_info_tpm(Monitor *mon, const QDict *qdict)
>>       unsigned int c = 0;
>>       TPMPassthroughOptions *tpo;
>>       TPMEmulatorOptions *teo;
>> +    TPMmssimOptions *tmo;
>>   
>>       info_list = qmp_query_tpm(&err);
>>       if (err) {
>> @@ -764,6 +765,14 @@ void hmp_info_tpm(Monitor *mon, const QDict *qdict)
>>               teo = ti->options->u.emulator.data;
>>               monitor_printf(mon, ",chardev=%s", teo->chardev);
>>               break;
>> +        case TPM_TYPE_MSSIM:
>> +            tmo = &ti->options->u.mssim;
>> +            monitor_printf(mon, ",command=%s:%s,control=%s:%s",
>> +                           tmo->command->u.inet.host,
>> +                           tmo->command->u.inet.port,
>> +                           tmo->control->u.inet.host,
>> +                           tmo->control->u.inet.port);
>> +            break;
>>           case TPM_TYPE__MAX:
>>               break;
>>           }
>> diff --git a/qapi/tpm.json b/qapi/tpm.json
>> index 2b491c28b4..f9dde35377 100644
>> --- a/qapi/tpm.json
>> +++ b/qapi/tpm.json
>> @@ -5,6 +5,7 @@
>>   ##
>>   # = TPM (trusted platform module) devices
>>   ##
> Blank line, please.
>
>> +{ 'include': 'sockets.json' }
>>   
>>   ##
>>   # @TpmModel:
>> @@ -49,7 +50,7 @@
>     #
>     # @passthrough: TPM passthrough type
>     #
>     # @emulator: Software Emulator TPM type (since 2.11)
>>   #
> Missing member documentation:
>
>     # @mssim: <brief description here> (since 8.2)
>
>>   # Since: 1.5
>>   ##
>> -{ 'enum': 'TpmType', 'data': [ 'passthrough', 'emulator' ],
>> +{ 'enum': 'TpmType', 'data': [ 'passthrough', 'emulator', 'mssim' ],
>>     'if': 'CONFIG_TPM' }
>>   
>>   ##
>> @@ -64,7 +65,7 @@
>>   # Example:
>>   #
>>   # -> { "execute": "query-tpm-types" }
>> -# <- { "return": [ "passthrough", "emulator" ] }
>> +# <- { "return": [ "passthrough", "emulator", "mssim" ] }
> Thanks for updating the example.
>
>>   #
>>   ##
>>   { 'command': 'query-tpm-types', 'returns': ['TpmType'],
>> @@ -117,6 +118,22 @@
>>     'data': { 'data': 'TPMEmulatorOptions' },
>>     'if': 'CONFIG_TPM' }
>>   
>> +##
>> +# @TPMmssimOptions:
> Please capitalize similar to TPMPassthroughOptions and
> TPMEmulatorOptions: TPMMssimOptions.
>
>> +#
>> +# Information for the mssim emulator connection
>> +#
>> +# @command: command socket for the TPM emulator
> Blank line, please.
>
>> +# @control: control socket for the TPM emulator
>> +#
>> +# Since: 7.2.0
> Since 8.2
>
>> +##
>> +{ 'struct': 'TPMmssimOptions',
>> +  'data': {
>> +      '*command': 'SocketAddress',
>> +      '*control': 'SocketAddress' },
> Locally consistent indentation is
>
>       'data': { '*command': 'SocketAddress',
>                 '*control': 'SocketAddress' },
>
>> +  'if': 'CONFIG_TPM' }
>> +
>>   ##
>>   # @TpmTypeOptions:
>>   #
>> @@ -124,6 +141,7 @@
>>   #
>>   # @type: - 'passthrough' The configuration options for the TPM passthrough type
>>   #        - 'emulator' The configuration options for TPM emulator backend type
>> +#        - 'mssim' The configuration options for TPM emulator mssim type
>>   #
>>   # Since: 1.5
>>   ##
>> @@ -131,7 +149,8 @@
>>     'base': { 'type': 'TpmType' },
>>     'discriminator': 'type',
>>     'data': { 'passthrough' : 'TPMPassthroughOptionsWrapper',
>> -            'emulator': 'TPMEmulatorOptionsWrapper' },
>> +            'emulator': 'TPMEmulatorOptionsWrapper',
>> +            'mssim' : 'TPMmssimOptions' },
>>     'if': 'CONFIG_TPM' }
>>   
>>   ##
>> @@ -150,7 +169,8 @@
>>               'id' : 'str' },
>>     'discriminator': 'type',
>>     'data': { 'passthrough' : 'TPMPassthroughOptions',
>> -            'emulator': 'TPMEmulatorOptions' },
>> +            'emulator': 'TPMEmulatorOptions',
>> +            'mssim': 'TPMmssimOptions' },
>>     'if': 'CONFIG_TPM' }
>>   
>>   ##
> Address my nitpicking, and you may add
>
> Acked-by: Markus Armbruster <armbru@redhat.com>
>


^ permalink raw reply	[flat|nested] 12+ messages in thread

* Re: [PATCH v6 2/2] tpm: add backend for mssim
  2023-09-22 12:41     ` Stefan Berger
@ 2023-09-22 13:02       ` Daniel P. Berrangé
  2023-09-22 13:27         ` Stefan Berger
  0 siblings, 1 reply; 12+ messages in thread
From: Daniel P. Berrangé @ 2023-09-22 13:02 UTC (permalink / raw)
  To: Stefan Berger; +Cc: Markus Armbruster, James Bottomley, qemu-devel

On Fri, Sep 22, 2023 at 08:41:19AM -0400, Stefan Berger wrote:
> 
> On 9/22/23 02:00, Markus Armbruster wrote:
> > Found this cleaning out old mail, sorry for missing it until now!
> > 
> > I think we owe James a quick decision wether we're willing to take the
> > feature.  Stefan, thoughts?
> 
> I thought we discusses it back then. Does it handle snapshotting and
> migration correctly?

To quote the patch itself:

  +The mssim backend supports snapshotting and migration, but the state
  +of the Microsoft Simulator server must be preserved (or the server
  +kept running) outside of QEMU for restore to be successful.


With 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 :|



^ permalink raw reply	[flat|nested] 12+ messages in thread

* Re: [PATCH v6 2/2] tpm: add backend for mssim
  2023-09-22 13:02       ` Daniel P. Berrangé
@ 2023-09-22 13:27         ` Stefan Berger
  2023-09-25 12:12           ` James Bottomley
  0 siblings, 1 reply; 12+ messages in thread
From: Stefan Berger @ 2023-09-22 13:27 UTC (permalink / raw)
  To: Daniel P. Berrangé; +Cc: Markus Armbruster, James Bottomley, qemu-devel


On 9/22/23 09:02, Daniel P. Berrangé wrote:
> On Fri, Sep 22, 2023 at 08:41:19AM -0400, Stefan Berger wrote:
>> On 9/22/23 02:00, Markus Armbruster wrote:
>>> Found this cleaning out old mail, sorry for missing it until now!
>>>
>>> I think we owe James a quick decision wether we're willing to take the
>>> feature.  Stefan, thoughts?
>> I thought we discusses it back then. Does it handle snapshotting and
>> migration correctly?
> To quote the patch itself:
>
>    +The mssim backend supports snapshotting and migration, but the state
>    +of the Microsoft Simulator server must be preserved (or the server
>    +kept running) outside of QEMU for restore to be successful.

How does 'it' support snapshotting where the state of the TPM can be 
completely different depending on the snapshot?  I know what it took to 
support this feature with swtpm/libtpms but I don't see the equivalent 
here in this backend driver nor in the TCG reference code that the 
underlying TPM 2 simulator is based upon.

I do not want to stand in the way of it being merged but please 
understand that I will also neither maintain nor fix bugs related to it 
nor its related underlying simulator -- with James being the maintainer 
of it, this should be clear. I have reason why I am saying this and they 
come from dealing with the upstream TPM 2 reference code.

Thanks,

   Stefan


>
> With regards,
> Daniel


^ permalink raw reply	[flat|nested] 12+ messages in thread

* Re: [PATCH v6 2/2] tpm: add backend for mssim
  2023-09-22 13:27         ` Stefan Berger
@ 2023-09-25 12:12           ` James Bottomley
  0 siblings, 0 replies; 12+ messages in thread
From: James Bottomley @ 2023-09-25 12:12 UTC (permalink / raw)
  To: Stefan Berger, Daniel P. Berrangé; +Cc: Markus Armbruster, qemu-devel

On Fri, 2023-09-22 at 09:27 -0400, Stefan Berger wrote:
> 
> On 9/22/23 09:02, Daniel P. Berrangé wrote:
> > On Fri, Sep 22, 2023 at 08:41:19AM -0400, Stefan Berger wrote:
> > > On 9/22/23 02:00, Markus Armbruster wrote:
> > > > Found this cleaning out old mail, sorry for missing it until
> > > > now!
> > > > 
> > > > I think we owe James a quick decision wether we're willing to
> > > > take the feature.  Stefan, thoughts?
> > > I thought we discusses it back then. Does it handle snapshotting
> > > and migration correctly?
> > To quote the patch itself:
> > 
> >    +The mssim backend supports snapshotting and migration, but the
> > state
> >    +of the Microsoft Simulator server must be preserved (or the
> > server
> >    +kept running) outside of QEMU for restore to be successful.
> 
> How does 'it' support snapshotting where the state of the TPM can be 
> completely different depending on the snapshot?

In the same way we support things like external disk devices across
snapshot and migration: it's up to the owner of the device to preserve
the state for the next resume. If you muck with the state (or connect
the wrong device) all bets are off.

>   I know what it took to support this feature with swtpm/libtpms but
> I don't see the equivalent here in this backend driver nor in the TCG
> reference code that the underlying TPM 2 simulator is based upon.
> 
> I do not want to stand in the way of it being merged but please 
> understand that I will also neither maintain nor fix bugs related to
> it nor its related underlying simulator -- with James being the
> maintainer of it, this should be clear. I have reason why I am saying
> this and they come from dealing with the upstream TPM 2 reference
> code.

I already said I'll support this, and added a Maintainers entry and a
specific exclusion from your TPM maintainer entry. I'm not sure what
additional assurances I can give?

James






^ permalink raw reply	[flat|nested] 12+ messages in thread

* Re: [PATCH v6 2/2] tpm: add backend for mssim
  2023-09-22  6:00   ` Markus Armbruster
  2023-09-22 12:41     ` Stefan Berger
@ 2023-09-25 12:15     ` James Bottomley
  2023-09-25 12:25       ` Markus Armbruster
  1 sibling, 1 reply; 12+ messages in thread
From: James Bottomley @ 2023-09-25 12:15 UTC (permalink / raw)
  To: Markus Armbruster; +Cc: qemu-devel, Daniel P . Berrangé, Stefan Berger

On Fri, 2023-09-22 at 08:00 +0200, Markus Armbruster wrote:
> Found this cleaning out old mail, sorry for missing it until now!
> 
> I think we owe James a quick decision wether we're willing to take
> the
> feature.  Stefan, thoughts?
> 
> James Bottomley <jejb@linux.ibm.com> writes:
> 
> > From: James Bottomley <James.Bottomley@HansenPartnership.com>
> > 
> > The Microsoft Simulator (mssim) is the reference emulation platform
> > for the TCG TPM 2.0 specification.
> > 
> > https://github.com/Microsoft/ms-tpm-20-ref.git
> > 
> > It exports a fairly simple network socket based protocol on two
> > sockets, one for command (default 2321) and one for control
> > (default
> > 2322).  This patch adds a simple backend that can speak the mssim
> > protocol over the network.  It also allows the two sockets to be
> > specified on the command line.  The benefits are twofold: firstly
> > it
> > gives us a backend that actually speaks a standard TPM emulation
> > protocol instead of the linux specific TPM driver format of the
> > current emulated TPM backend and secondly, using the microsoft
> > protocol, the end point of the emulator can be anywhere on the
> > network, facilitating the cloud use case where a central TPM
> > service
> > can be used over a control network.
> > 
> > The implementation does basic control commands like power off/on,
> > but
> > doesn't implement cancellation or startup.  The former because
> > cancellation is pretty much useless on a fast operating TPM
> > emulator
> > and the latter because this emulator is designed to be used with
> > OVMF
> > which itself does TPM startup and I wanted to validate that.
> > 
> > To run this, simply download an emulator based on the MS
> > specification
> > (package ibmswtpm2 on openSUSE) and run it, then add these two
> > lines
> > to the qemu command and it will use the emulator.
> > 
> >     -tpmdev mssim,id=tpm0 \
> >     -device tpm-crb,tpmdev=tpm0 \
> > 
> > to use a remote emulator replace the first line with
> > 
> >     -tpmdev
> > "{'type':'mssim','id':'tpm0','command':{'type':inet,'host':'remote'
> > ,'port':'2321'}}"
> > 
> > tpm-tis also works as the backend.
> > 
> > Signed-off-by: James Bottomley <jejb@linux.ibm.com>
> 
> [...]
> 
> > diff --git a/docs/specs/tpm.rst b/docs/specs/tpm.rst
> > index 535912a92b..1398735956 100644
> > --- a/docs/specs/tpm.rst
> > +++ b/docs/specs/tpm.rst
> > @@ -270,6 +270,38 @@ available as a module (assuming a TPM 2 is
> > passed through):
> >    /sys/devices/LNXSYSTEM:00/LNXSYBUS:00/MSFT0101:00/tpm/tpm0/pcr-
> > sha256/9
> >    ...
> >  
> > +The QEMU TPM Microsoft Simulator Device
> > +---------------------------------------
> > +
> > +The TCG provides a reference implementation for TPM 2.0 written by
> 
> 
> Suggest to copy the cover letter's nice introductory paragraph here:
> 
>   The Microsoft Simulator (mssim) is the reference emulation platform
>   for the TCG TPM 2.0 specification.
> 
>   It provides a reference implementation for TPM 2.0 written by

Sure, that's easy.

> > +Microsoft (See `ms-tpm-20-ref`_ on github).  The reference
> > implementation
> > +starts a network server and listens for TPM commands on port 2321
> > and
> > +TPM Platform control commands on port 2322, although these can be
> > +altered.  The QEMU mssim TPM backend talks to this
> > implementation.  By
> > +default it connects to the default ports on localhost:
> > +
> > +.. code-block:: console
> > +
> > +  qemu-system-x86_64 <qemu-options> \
> > +    -tpmdev mssim,id=tpm0 \
> > +    -device tpm-crb,tpmdev=tpm0
> > +
> > +
> > +Although it can also communicate with a remote host, which must be
> > +specified as a SocketAddress via json on the command line for each
> > of
> 
> Is the "via JSON" part in "must be specified ... on the command line"
> correct?  I'd expect to be able to use dotted keys as well, like
> 
>     -tpmdev
> type=mssim,id=tpm0,command.type=inet,command.host=remote,command.port
> =2321',control.type=inet,control.host=remote,control.port=2322

Yes, I've verified that the dot notation works as well.  However, I
thought QEMU was calling all stuff like this JSON notation?  If not,
what do you usually call it? "json or dot notation"?

> 
> Aside: I do recommend management applications stick to JSON.
> 
> > +the command and control ports:
> > +
> > +.. code-block:: console
> > +
> > +  qemu-system-x86_64 <qemu-options> \
> > +    -tpmdev
> > "{'type':'mssim','id':'tpm0','command':{'type':'inet','host':'remot
> > e','port':'2321'},'control':{'type':'inet','host':'remote','port':'
> > 2322'}}" \
> > +    -device tpm-crb,tpmdev=tpm0
> > +
> > +
> > +The mssim backend supports snapshotting and migration, but the
> > state
> > +of the Microsoft Simulator server must be preserved (or the server
> > +kept running) outside of QEMU for restore to be successful.
> > +
> >  The QEMU TPM emulator device
> >  ----------------------------
> >  
> > @@ -526,3 +558,6 @@ the following:
> >  
> >  .. _SWTPM protocol:
> >    
> > https://github.com/stefanberger/swtpm/blob/master/man/man3/swtpm_ioctls.pod
> > +
> > +.. _ms-tpm-20-ref:
> > +   https://github.com/microsoft/ms-tpm-20-ref
> > diff --git a/monitor/hmp-cmds.c b/monitor/hmp-cmds.c
> > index ed78a87ddd..12482368d0 100644
> > --- a/monitor/hmp-cmds.c
> > +++ b/monitor/hmp-cmds.c
> > @@ -731,6 +731,7 @@ void hmp_info_tpm(Monitor *mon, const QDict
> > *qdict)
> >      unsigned int c = 0;
> >      TPMPassthroughOptions *tpo;
> >      TPMEmulatorOptions *teo;
> > +    TPMmssimOptions *tmo;
> >  
> >      info_list = qmp_query_tpm(&err);
> >      if (err) {
> > @@ -764,6 +765,14 @@ void hmp_info_tpm(Monitor *mon, const QDict
> > *qdict)
> >              teo = ti->options->u.emulator.data;
> >              monitor_printf(mon, ",chardev=%s", teo->chardev);
> >              break;
> > +        case TPM_TYPE_MSSIM:
> > +            tmo = &ti->options->u.mssim;
> > +            monitor_printf(mon, ",command=%s:%s,control=%s:%s",
> > +                           tmo->command->u.inet.host,
> > +                           tmo->command->u.inet.port,
> > +                           tmo->control->u.inet.host,
> > +                           tmo->control->u.inet.port);
> > +            break;
> >          case TPM_TYPE__MAX:
> >              break;
> >          }
> > diff --git a/qapi/tpm.json b/qapi/tpm.json
> > index 2b491c28b4..f9dde35377 100644
> > --- a/qapi/tpm.json
> > +++ b/qapi/tpm.json
> > @@ -5,6 +5,7 @@
> >  ##
> >  # = TPM (trusted platform module) devices
> >  ##
> 
> Blank line, please.
> 
> > +{ 'include': 'sockets.json' }
> >  
> >  ##
> >  # @TpmModel:
> > @@ -49,7 +50,7 @@
>    #
>    # @passthrough: TPM passthrough type
>    #
>    # @emulator: Software Emulator TPM type (since 2.11)
> >  #
> 
> Missing member documentation:
> 
>    # @mssim: <brief description here> (since 8.2)
> 
> >  # Since: 1.5
> >  ##
> > -{ 'enum': 'TpmType', 'data': [ 'passthrough', 'emulator' ],
> > +{ 'enum': 'TpmType', 'data': [ 'passthrough', 'emulator', 'mssim'
> > ],
> >    'if': 'CONFIG_TPM' }
> >  
> >  ##
> > @@ -64,7 +65,7 @@
> >  # Example:
> >  #
> >  # -> { "execute": "query-tpm-types" }
> > -# <- { "return": [ "passthrough", "emulator" ] }
> > +# <- { "return": [ "passthrough", "emulator", "mssim" ] }
> 
> Thanks for updating the example.
> 
> >  #
> >  ##
> >  { 'command': 'query-tpm-types', 'returns': ['TpmType'],
> > @@ -117,6 +118,22 @@
> >    'data': { 'data': 'TPMEmulatorOptions' },
> >    'if': 'CONFIG_TPM' }
> >  
> > +##
> > +# @TPMmssimOptions:
> 
> Please capitalize similar to TPMPassthroughOptions and
> TPMEmulatorOptions: TPMMssimOptions.

OK

> 
> > +#
> > +# Information for the mssim emulator connection
> > +#
> > +# @command: command socket for the TPM emulator
> 
> Blank line, please.

OK

> 
> > +# @control: control socket for the TPM emulator
> > +#
> > +# Since: 7.2.0
> 
> Since 8.2

Heh, yes, that keeps creeping with every release ..

> 
> > +##
> > +{ 'struct': 'TPMmssimOptions',
> > +  'data': {
> > +      '*command': 'SocketAddress',
> > +      '*control': 'SocketAddress' },
> 
> Locally consistent indentation is
> 
>      'data': { '*command': 'SocketAddress',
>                '*control': 'SocketAddress' },
> 
> > +  'if': 'CONFIG_TPM' }
> > +
> >  ##
> >  # @TpmTypeOptions:
> >  #
> > @@ -124,6 +141,7 @@
> >  #
> >  # @type: - 'passthrough' The configuration options for the TPM
> > passthrough type
> >  #        - 'emulator' The configuration options for TPM emulator
> > backend type
> > +#        - 'mssim' The configuration options for TPM emulator
> > mssim type
> >  #
> >  # Since: 1.5
> >  ##
> > @@ -131,7 +149,8 @@
> >    'base': { 'type': 'TpmType' },
> >    'discriminator': 'type',
> >    'data': { 'passthrough' : 'TPMPassthroughOptionsWrapper',
> > -            'emulator': 'TPMEmulatorOptionsWrapper' },
> > +            'emulator': 'TPMEmulatorOptionsWrapper',
> > +            'mssim' : 'TPMmssimOptions' },
> >    'if': 'CONFIG_TPM' }
> >  
> >  ##
> > @@ -150,7 +169,8 @@
> >              'id' : 'str' },
> >    'discriminator': 'type',
> >    'data': { 'passthrough' : 'TPMPassthroughOptions',
> > -            'emulator': 'TPMEmulatorOptions' },
> > +            'emulator': 'TPMEmulatorOptions',
> > +            'mssim': 'TPMmssimOptions' },
> >    'if': 'CONFIG_TPM' }
> >  
> >  ##
> 
> Address my nitpicking, and you may add
> 
> Acked-by: Markus Armbruster <armbru@redhat.com>

James



^ permalink raw reply	[flat|nested] 12+ messages in thread

* Re: [PATCH v6 2/2] tpm: add backend for mssim
  2023-09-25 12:15     ` James Bottomley
@ 2023-09-25 12:25       ` Markus Armbruster
  0 siblings, 0 replies; 12+ messages in thread
From: Markus Armbruster @ 2023-09-25 12:25 UTC (permalink / raw)
  To: James Bottomley; +Cc: qemu-devel, Daniel P . Berrangé, Stefan Berger

James Bottomley <jejb@linux.ibm.com> writes:

> On Fri, 2023-09-22 at 08:00 +0200, Markus Armbruster wrote:
>> Found this cleaning out old mail, sorry for missing it until now!
>> 
>> I think we owe James a quick decision wether we're willing to take
>> the
>> feature.  Stefan, thoughts?
>> 
>> James Bottomley <jejb@linux.ibm.com> writes:
>> 
>> > From: James Bottomley <James.Bottomley@HansenPartnership.com>
>> > 
>> > The Microsoft Simulator (mssim) is the reference emulation platform
>> > for the TCG TPM 2.0 specification.
>> > 
>> > https://github.com/Microsoft/ms-tpm-20-ref.git
>> > 
>> > It exports a fairly simple network socket based protocol on two
>> > sockets, one for command (default 2321) and one for control
>> > (default
>> > 2322).  This patch adds a simple backend that can speak the mssim
>> > protocol over the network.  It also allows the two sockets to be
>> > specified on the command line.  The benefits are twofold: firstly
>> > it
>> > gives us a backend that actually speaks a standard TPM emulation
>> > protocol instead of the linux specific TPM driver format of the
>> > current emulated TPM backend and secondly, using the microsoft
>> > protocol, the end point of the emulator can be anywhere on the
>> > network, facilitating the cloud use case where a central TPM
>> > service
>> > can be used over a control network.
>> > 
>> > The implementation does basic control commands like power off/on,
>> > but
>> > doesn't implement cancellation or startup.  The former because
>> > cancellation is pretty much useless on a fast operating TPM
>> > emulator
>> > and the latter because this emulator is designed to be used with
>> > OVMF
>> > which itself does TPM startup and I wanted to validate that.
>> > 
>> > To run this, simply download an emulator based on the MS
>> > specification
>> > (package ibmswtpm2 on openSUSE) and run it, then add these two
>> > lines
>> > to the qemu command and it will use the emulator.
>> > 
>> >     -tpmdev mssim,id=tpm0 \
>> >     -device tpm-crb,tpmdev=tpm0 \
>> > 
>> > to use a remote emulator replace the first line with
>> > 
>> >     -tpmdev
>> > "{'type':'mssim','id':'tpm0','command':{'type':inet,'host':'remote'
>> > ,'port':'2321'}}"
>> > 
>> > tpm-tis also works as the backend.
>> > 
>> > Signed-off-by: James Bottomley <jejb@linux.ibm.com>
>> 
>> [...]
>> 
>> > diff --git a/docs/specs/tpm.rst b/docs/specs/tpm.rst
>> > index 535912a92b..1398735956 100644
>> > --- a/docs/specs/tpm.rst
>> > +++ b/docs/specs/tpm.rst
>> > @@ -270,6 +270,38 @@ available as a module (assuming a TPM 2 is
>> > passed through):
>> >    /sys/devices/LNXSYSTEM:00/LNXSYBUS:00/MSFT0101:00/tpm/tpm0/pcr-
>> > sha256/9
>> >    ...
>> >  
>> > +The QEMU TPM Microsoft Simulator Device
>> > +---------------------------------------
>> > +
>> > +The TCG provides a reference implementation for TPM 2.0 written by
>> 
>> 
>> Suggest to copy the cover letter's nice introductory paragraph here:
>> 
>>   The Microsoft Simulator (mssim) is the reference emulation platform
>>   for the TCG TPM 2.0 specification.
>> 
>>   It provides a reference implementation for TPM 2.0 written by
>
> Sure, that's easy.
>
>> > +Microsoft (See `ms-tpm-20-ref`_ on github).  The reference
>> > implementation
>> > +starts a network server and listens for TPM commands on port 2321
>> > and
>> > +TPM Platform control commands on port 2322, although these can be
>> > +altered.  The QEMU mssim TPM backend talks to this
>> > implementation.  By
>> > +default it connects to the default ports on localhost:
>> > +
>> > +.. code-block:: console
>> > +
>> > +  qemu-system-x86_64 <qemu-options> \
>> > +    -tpmdev mssim,id=tpm0 \
>> > +    -device tpm-crb,tpmdev=tpm0
>> > +
>> > +
>> > +Although it can also communicate with a remote host, which must be
>> > +specified as a SocketAddress via json on the command line for each
>> > of
>> 
>> Is the "via JSON" part in "must be specified ... on the command line"
>> correct?  I'd expect to be able to use dotted keys as well, like
>> 
>>     -tpmdev
>> type=mssim,id=tpm0,command.type=inet,command.host=remote,command.port
>> =2321',control.type=inet,control.host=remote,control.port=2322
>
> Yes, I've verified that the dot notation works as well.  However, I
> thought QEMU was calling all stuff like this JSON notation?  If not,
> what do you usually call it? "json or dot notation"?

Our terminology is a bit fuzzy there.  We commonly say "dotted keys"
(although that's just the part left of the = strictly speaking) or
"key=value,...".

>> Aside: I do recommend management applications stick to JSON.

[...]



^ permalink raw reply	[flat|nested] 12+ messages in thread

* Re: [PATCH v6 1/2] tpm: convert tpmdev options processing to new visitor format
  2023-01-09 16:15 ` [PATCH v6 1/2] tpm: convert tpmdev options processing to new visitor format James Bottomley
@ 2023-09-26 15:20   ` Stefan Berger
  2023-09-26 17:43     ` Stefan Berger
  0 siblings, 1 reply; 12+ messages in thread
From: Stefan Berger @ 2023-09-26 15:20 UTC (permalink / raw)
  To: James Bottomley, qemu-devel; +Cc: Daniel P . Berrangé, Markus Armbruster


On 1/9/23 11:15, James Bottomley wrote:
> From: James Bottomley <James.Bottomley@HansenPartnership.com>
>
> Instead of processing the tpmdev options using the old qemu options,
> convert to the new visitor format which also allows the passing of
> json on the command line.
>
> Signed-off-by: James Bottomley <jejb@linux.ibm.com>

$ ./scripts/checkpatch.pl 
0001-tpm-convert-tpmdev-options-processing-to-new-visitor.patch

WARNING: line over 80 characters
#30: FILE: backends/tpm/tpm_emulator.c:586:
+static int tpm_emulator_handle_device_opts(TPMEmulator *tpm_emu, 
TpmCreateOptions *opts)

WARNING: line over 80 characters
#101: FILE: backends/tpm/tpm_passthrough.c:255:
+tpm_passthrough_handle_device_opts(TPMPassthruState *tpm_pt, 
TpmCreateOptions *opts)

total: 0 errors, 2 warnings, 340 lines checked


> ---
> v4: add TpmConfiOptions
> v5: exit(0) for help
> ---
>   backends/tpm/tpm_emulator.c    | 24 ++++-----
>   backends/tpm/tpm_passthrough.c | 22 +++------
>   include/sysemu/tpm.h           |  4 +-
>   include/sysemu/tpm_backend.h   |  2 +-
>   qapi/tpm.json                  | 19 +++++++
>   softmmu/tpm.c                  | 90 ++++++++++++++--------------------
>   softmmu/vl.c                   | 19 +------
>   7 files changed, 75 insertions(+), 105 deletions(-)
>
> diff --git a/backends/tpm/tpm_emulator.c b/backends/tpm/tpm_emulator.c
> index 49cc3d749d..cb6bf9d7c2 100644
> --- a/backends/tpm/tpm_emulator.c
> +++ b/backends/tpm/tpm_emulator.c
> @@ -584,33 +584,28 @@ err_exit:
>       return -1;
>   }
>   
> -static int tpm_emulator_handle_device_opts(TPMEmulator *tpm_emu, QemuOpts *opts)
> +static int tpm_emulator_handle_device_opts(TPMEmulator *tpm_emu, TpmCreateOptions *opts)
>   {
> -    const char *value;
>       Error *err = NULL;
>       Chardev *dev;
>   
> -    value = qemu_opt_get(opts, "chardev");
> -    if (!value) {
> -        error_report("tpm-emulator: parameter 'chardev' is missing");
> -        goto err;
> -    }
> +    tpm_emu->options = QAPI_CLONE(TPMEmulatorOptions, &opts->u.emulator);
> +    tpm_emu->data_ioc = NULL;
>   
> -    dev = qemu_chr_find(value);
> +    dev = qemu_chr_find(opts->u.emulator.chardev);
>       if (!dev) {
> -        error_report("tpm-emulator: tpm chardev '%s' not found", value);
> +        error_report("tpm-emulator: tpm chardev '%s' not found",
> +                opts->u.emulator.chardev);

indentation


>           goto err;
>       }
>   
>       if (!qemu_chr_fe_init(&tpm_emu->ctrl_chr, dev, &err)) {
>           error_prepend(&err, "tpm-emulator: No valid chardev found at '%s':",
> -                      value);
> +                      opts->u.emulator.chardev);
>           error_report_err(err);
>           goto err;
>       }
>   
> -    tpm_emu->options->chardev = g_strdup(value);
> -
>       if (tpm_emulator_prepare_data_fd(tpm_emu) < 0) {
>           goto err;
>       }
> @@ -649,7 +644,7 @@ err:
>       return -1;
>   }
>   
> -static TPMBackend *tpm_emulator_create(QemuOpts *opts)
> +static TPMBackend *tpm_emulator_create(TpmCreateOptions *opts)
>   {
>       TPMBackend *tb = TPM_BACKEND(object_new(TYPE_TPM_EMULATOR));
>   
> @@ -972,7 +967,6 @@ static void tpm_emulator_inst_init(Object *obj)
>   
>       trace_tpm_emulator_inst_init();
>   
> -    tpm_emu->options = g_new0(TPMEmulatorOptions, 1);
>       tpm_emu->cur_locty_number = ~0;
>       qemu_mutex_init(&tpm_emu->mutex);
>       tpm_emu->vmstate =
> @@ -990,7 +984,7 @@ static void tpm_emulator_shutdown(TPMEmulator *tpm_emu)
>   {
>       ptm_res res;
>   
> -    if (!tpm_emu->options->chardev) {
> +    if (!tpm_emu->data_ioc) {
>           /* was never properly initialized */
>           return;
>       }
> diff --git a/backends/tpm/tpm_passthrough.c b/backends/tpm/tpm_passthrough.c
> index 179697a3a9..3da467ef01 100644
> --- a/backends/tpm/tpm_passthrough.c
> +++ b/backends/tpm/tpm_passthrough.c
> @@ -252,21 +252,12 @@ static int tpm_passthrough_open_sysfs_cancel(TPMPassthruState *tpm_pt)
>   }
>   
>   static int
> -tpm_passthrough_handle_device_opts(TPMPassthruState *tpm_pt, QemuOpts *opts)
> +tpm_passthrough_handle_device_opts(TPMPassthruState *tpm_pt, TpmCreateOptions *opts)
>   {
> -    const char *value;
> +    tpm_pt->options = QAPI_CLONE(TPMPassthroughOptions, &opts->u.passthrough);
>   
> -    value = qemu_opt_get(opts, "cancel-path");
> -    if (value) {
> -        tpm_pt->options->cancel_path = g_strdup(value);
> -    }
> -
> -    value = qemu_opt_get(opts, "path");
> -    if (value) {
> -        tpm_pt->options->path = g_strdup(value);
> -    }
> -
> -    tpm_pt->tpm_dev = value ? value : TPM_PASSTHROUGH_DEFAULT_DEVICE;
> +    tpm_pt->tpm_dev = opts->u.passthrough.path ? opts->u.passthrough.path :
> +            TPM_PASSTHROUGH_DEFAULT_DEVICE;
>       tpm_pt->tpm_fd = qemu_open_old(tpm_pt->tpm_dev, O_RDWR);
>       if (tpm_pt->tpm_fd < 0) {
>           error_report("Cannot access TPM device using '%s': %s",
> @@ -288,11 +279,11 @@ tpm_passthrough_handle_device_opts(TPMPassthruState *tpm_pt, QemuOpts *opts)
>       return 0;
>   }
>   
> -static TPMBackend *tpm_passthrough_create(QemuOpts *opts)
> +static TPMBackend *tpm_passthrough_create(TpmCreateOptions *tco)
>   {
>       Object *obj = object_new(TYPE_TPM_PASSTHROUGH);
>   
> -    if (tpm_passthrough_handle_device_opts(TPM_PASSTHROUGH(obj), opts)) {
> +    if (tpm_passthrough_handle_device_opts(TPM_PASSTHROUGH(obj), tco)) {
>           object_unref(obj);
>           return NULL;
>       }
> @@ -344,7 +335,6 @@ static void tpm_passthrough_inst_init(Object *obj)
>   {
>       TPMPassthruState *tpm_pt = TPM_PASSTHROUGH(obj);
>   
> -    tpm_pt->options = g_new0(TPMPassthroughOptions, 1);
>       tpm_pt->tpm_fd = -1;
>       tpm_pt->cancel_fd = -1;
>   }
> diff --git a/include/sysemu/tpm.h b/include/sysemu/tpm.h
> index fb40e30ff6..d00a833a21 100644
> --- a/include/sysemu/tpm.h
> +++ b/include/sysemu/tpm.h
> @@ -17,8 +17,8 @@
>   
>   #ifdef CONFIG_TPM
>   
> -int tpm_config_parse(QemuOptsList *opts_list, const char *optarg);
> -int tpm_init(void);
> +void tpm_config_parse(const char *optarg);
> +void tpm_init(void);
>   void tpm_cleanup(void);
>   
>   typedef enum TPMVersion {
> diff --git a/include/sysemu/tpm_backend.h b/include/sysemu/tpm_backend.h
> index 8fd3269c11..846a9e39fa 100644
> --- a/include/sysemu/tpm_backend.h
> +++ b/include/sysemu/tpm_backend.h
> @@ -57,7 +57,7 @@ struct TPMBackendClass {
>       /* get a descriptive text of the backend to display to the user */
>       const char *desc;
>   
> -    TPMBackend *(*create)(QemuOpts *opts);
> +    TPMBackend *(*create)(TpmCreateOptions *tco);
>   
>       /* start up the TPM on the backend - optional */
>       int (*startup_tpm)(TPMBackend *t, size_t buffersize);
> diff --git a/qapi/tpm.json b/qapi/tpm.json
> index 4e2ea9756a..2b491c28b4 100644
> --- a/qapi/tpm.json
> +++ b/qapi/tpm.json
> @@ -134,6 +134,25 @@
>               'emulator': 'TPMEmulatorOptionsWrapper' },
>     'if': 'CONFIG_TPM' }
>   
> +##
> +# @TpmCreateOptions:
> +#
> +# A union referencing different TPM backend types' configuration options
> +#   without the wrapper to be usable by visitors.
> +#
> +# @type: - 'passthrough' The configuration options for the TPM passthrough type
> +#        - 'emulator' The configuration options for TPM emulator backend type
> +#
> +# Since: 7.2
> +##
> +{ 'union': 'TpmCreateOptions',
> +  'base': { 'type': 'TpmType',
> +            'id' : 'str' },
> +  'discriminator': 'type',
> +  'data': { 'passthrough' : 'TPMPassthroughOptions',
> +            'emulator': 'TPMEmulatorOptions' },
> +  'if': 'CONFIG_TPM' }
> +
>   ##
>   # @TPMInfo:
>   #
> diff --git a/softmmu/tpm.c b/softmmu/tpm.c
> index 578563f05a..fa84a53b96 100644
> --- a/softmmu/tpm.c
> +++ b/softmmu/tpm.c
> @@ -17,14 +17,26 @@
>   #include "qapi/error.h"
>   #include "qapi/qapi-commands-tpm.h"
>   #include "qapi/qmp/qerror.h"
> +#include "qapi/qobject-input-visitor.h"
> +#include "qapi/qapi-visit-tpm.h"
>   #include "sysemu/tpm_backend.h"
>   #include "sysemu/tpm.h"
>   #include "qemu/config-file.h"
>   #include "qemu/error-report.h"
> +#include "qemu/help_option.h"
>   
>   static QLIST_HEAD(, TPMBackend) tpm_backends =
>       QLIST_HEAD_INITIALIZER(tpm_backends);
>   
> +typedef struct TpmCreateOptionsQueueEntry {
> +        TpmCreateOptions *tco;
> +        QSIMPLEQ_ENTRY(TpmCreateOptionsQueueEntry) entry;
> +} TpmCreateOptionsQueueEntry;
> +
> +typedef QSIMPLEQ_HEAD(, TpmCreateOptionsQueueEntry) TpmCreateOptionsQueue;
> +
> +static TpmCreateOptionsQueue tco_queue = QSIMPLEQ_HEAD_INITIALIZER(tco_queue);
> +
>   static const TPMBackendClass *
>   tpm_be_find_by_type(enum TpmType type)
>   {
> @@ -84,63 +96,31 @@ TPMBackend *qemu_find_tpm_be(const char *id)
>       return NULL;
>   }
>   
> -static int tpm_init_tpmdev(void *dummy, QemuOpts *opts, Error **errp)
> +static void tpm_init_tpmdev(TpmCreateOptions *tco)
>   {
> -    /*
> -     * Use of error_report() in a function with an Error ** parameter
> -     * is suspicious.  It is okay here.  The parameter only exists to
> -     * make the function usable with qemu_opts_foreach().  It is not
> -     * actually used.
> -     */
> -    const char *value;
> -    const char *id;
>       const TPMBackendClass *be;
>       TPMBackend *drv;
> -    Error *local_err = NULL;
> -    int i;
>   
>       if (!QLIST_EMPTY(&tpm_backends)) {
>           error_report("Only one TPM is allowed.");
> -        return 1;
> +        exit(1);
>       }
>   
> -    id = qemu_opts_id(opts);
> -    if (id == NULL) {
> -        error_report(QERR_MISSING_PARAMETER, "id");
> -        return 1;
> -    }
> -
> -    value = qemu_opt_get(opts, "type");
> -    if (!value) {
> -        error_report(QERR_MISSING_PARAMETER, "type");
> -        tpm_display_backend_drivers();
> -        return 1;
> -    }
> -
> -    i = qapi_enum_parse(&TpmType_lookup, value, -1, NULL);
> -    be = i >= 0 ? tpm_be_find_by_type(i) : NULL;
> +    be = tco->type >= 0 ? tpm_be_find_by_type(tco->type) : NULL;
>       if (be == NULL) {
>           error_report(QERR_INVALID_PARAMETER_VALUE,
>                        "type", "a TPM backend type");
>           tpm_display_backend_drivers();
> -        return 1;
> -    }
> -
> -    /* validate backend specific opts */
> -    if (!qemu_opts_validate(opts, be->opts, &local_err)) {
> -        error_report_err(local_err);
> -        return 1;
> +        exit(1);
>       }
>   
> -    drv = be->create(opts);
> +    drv = be->create(tco);
>       if (!drv) {
> -        return 1;
> +        exit(1);
>       }
>   
> -    drv->id = g_strdup(id);
> +    drv->id = g_strdup(tco->id);
>       QLIST_INSERT_HEAD(&tpm_backends, drv, list);
> -
> -    return 0;
>   }
>   
>   /*
> @@ -161,33 +141,35 @@ void tpm_cleanup(void)
>    * Initialize the TPM. Process the tpmdev command line options describing the
>    * TPM backend.
>    */
> -int tpm_init(void)
> +void tpm_init(void)
>   {
> -    if (qemu_opts_foreach(qemu_find_opts("tpmdev"),
> -                          tpm_init_tpmdev, NULL, NULL)) {
> -        return -1;
> -    }
> +    while (!QSIMPLEQ_EMPTY(&tco_queue)) {
> +        TpmCreateOptionsQueueEntry *tcoqe = QSIMPLEQ_FIRST(&tco_queue);
>   
> -    return 0;
> +        QSIMPLEQ_REMOVE_HEAD(&tco_queue, entry);
> +        tpm_init_tpmdev(tcoqe->tco);

tcoqe->tco and the possible emulator or passthrough specific allocations 
should probably be also free'ed here.



> +        g_free(tcoqe);
> +    }
>   }
>   
>   /*
>    * Parse the TPM configuration options.
>    * To display all available TPM backends the user may use '-tpmdev help'
>    */
> -int tpm_config_parse(QemuOptsList *opts_list, const char *optarg)
> +void tpm_config_parse(const char *optarg)
>   {
> -    QemuOpts *opts;
> +    Visitor *v;
> +    TpmCreateOptionsQueueEntry *tcqe;
>   
> -    if (!strcmp(optarg, "help")) {
> +    if (is_help_option(optarg)) {
>           tpm_display_backend_drivers();
> -        return -1;
> -    }
> -    opts = qemu_opts_parse_noisily(opts_list, optarg, true);
> -    if (!opts) {
> -        return -1;
> +        exit(0);
>       }
> -    return 0;
> +    v = qobject_input_visitor_new_str(optarg, "type", &error_fatal);
> +    tcqe = g_new(TpmCreateOptionsQueueEntry, 1);
> +    visit_type_TpmCreateOptions(v, NULL, &tcqe->tco, &error_fatal);
> +    visit_free(v);
> +    QSIMPLEQ_INSERT_TAIL(&tco_queue, tcqe, entry);
>   }
>   
>   /*
> diff --git a/softmmu/vl.c b/softmmu/vl.c
> index 798e1dc933..8c2655dbc2 100644
> --- a/softmmu/vl.c
> +++ b/softmmu/vl.c
> @@ -328,16 +328,6 @@ static QemuOptsList qemu_object_opts = {
>       },
>   };
>   
> -static QemuOptsList qemu_tpmdev_opts = {
> -    .name = "tpmdev",
> -    .implied_opt_name = "type",
> -    .head = QTAILQ_HEAD_INITIALIZER(qemu_tpmdev_opts.head),
> -    .desc = {
> -        /* options are defined in the TPM backends */
> -        { /* end of list */ }
> -    },
> -};
> -
>   static QemuOptsList qemu_overcommit_opts = {
>       .name = "overcommit",
>       .head = QTAILQ_HEAD_INITIALIZER(qemu_overcommit_opts.head),
> @@ -1934,9 +1924,7 @@ static void qemu_create_late_backends(void)
>   
>       object_option_foreach_add(object_create_late);
>   
> -    if (tpm_init() < 0) {
> -        exit(1);
> -    }
> +    tpm_init();
>   
>       qemu_opts_foreach(qemu_find_opts("mon"),
>                         mon_init_func, NULL, &error_fatal);
> @@ -2658,7 +2646,6 @@ void qemu_init(int argc, char **argv)
>       qemu_add_opts(&qemu_boot_opts);
>       qemu_add_opts(&qemu_add_fd_opts);
>       qemu_add_opts(&qemu_object_opts);
> -    qemu_add_opts(&qemu_tpmdev_opts);
>       qemu_add_opts(&qemu_overcommit_opts);
>       qemu_add_opts(&qemu_msg_opts);
>       qemu_add_opts(&qemu_name_opts);
> @@ -2906,9 +2893,7 @@ void qemu_init(int argc, char **argv)
>                   break;
>   #ifdef CONFIG_TPM
>               case QEMU_OPTION_tpmdev:
> -                if (tpm_config_parse(qemu_find_opts("tpmdev"), optarg) < 0) {
> -                    exit(1);
> -                }
> +                tpm_config_parse(optarg);
>                   break;
>   #endif
>               case QEMU_OPTION_mempath:


^ permalink raw reply	[flat|nested] 12+ messages in thread

* Re: [PATCH v6 1/2] tpm: convert tpmdev options processing to new visitor format
  2023-09-26 15:20   ` Stefan Berger
@ 2023-09-26 17:43     ` Stefan Berger
  0 siblings, 0 replies; 12+ messages in thread
From: Stefan Berger @ 2023-09-26 17:43 UTC (permalink / raw)
  To: James Bottomley, qemu-devel; +Cc: Daniel P . Berrangé, Markus Armbruster


On 9/26/23 11:20, Stefan Berger wrote:
>
> On 1/9/23 11:15, James Bottomley wrote:
>> From: James Bottomley <James.Bottomley@HansenPartnership.com>
>>
>> Instead of processing the tpmdev options using the old qemu options,
>> convert to the new visitor format which also allows the passing of
>> json on the command line.
>>
>> Signed-off-by: James Bottomley <jejb@linux.ibm.com>
>
>> +    while (!QSIMPLEQ_EMPTY(&tco_queue)) {
>> +        TpmCreateOptionsQueueEntry *tcoqe = QSIMPLEQ_FIRST(&tco_queue);
>>   -    return 0;
>> +        QSIMPLEQ_REMOVE_HEAD(&tco_queue, entry);
>> +        tpm_init_tpmdev(tcoqe->tco);
>
> tcoqe->tco and the possible emulator or passthrough specific 
> allocations should probably be also free'ed here.


Use: qapi_free_TpmCreateOptions(tcoqe->tco);




^ permalink raw reply	[flat|nested] 12+ messages in thread

end of thread, other threads:[~2023-09-26 17:43 UTC | newest]

Thread overview: 12+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2023-01-09 16:15 [PATCH v6 0/2] tpm: add mssim backend James Bottomley
2023-01-09 16:15 ` [PATCH v6 1/2] tpm: convert tpmdev options processing to new visitor format James Bottomley
2023-09-26 15:20   ` Stefan Berger
2023-09-26 17:43     ` Stefan Berger
2023-01-09 16:15 ` [PATCH v6 2/2] tpm: add backend for mssim James Bottomley
2023-09-22  6:00   ` Markus Armbruster
2023-09-22 12:41     ` Stefan Berger
2023-09-22 13:02       ` Daniel P. Berrangé
2023-09-22 13:27         ` Stefan Berger
2023-09-25 12:12           ` James Bottomley
2023-09-25 12:15     ` James Bottomley
2023-09-25 12:25       ` Markus Armbruster

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).