Re: [PATCH v4 11/12] cryptodev: Support query-stats QMP command

[Daniel P . Berrangé]

On Tue, Feb 28, 2023 at 07:56:14AM -0500, Michael S. Tsirkin wrote:
> On Sun, Jan 29, 2023 at 10:57:46AM +0800, zhenwei pi wrote:
> > Now we can use "query-stats" QMP command to query statistics of
> > crypto devices. (Originally this was designed to show statistics
> > by '{"execute": "query-cryptodev"}'. Daniel Berrangé suggested that
> > querying configuration info by "query-cryptodev", and querying
> > runtime performance info by "query-stats". This makes sense!)
> > 
> > Example:
> > ~# virsh qemu-monitor-command vm '{"execute": "query-stats", \
> >    "arguments": {"target": "cryptodev"} }' | jq
> > {
> >   "return": [
> >     {
> >       "provider": "cryptodev",
> >       "stats": [
> >         {
> >           "name": "asym-verify-bytes",
> >           "value": 7680
> >         },
> >         ...
> >         {
> >           "name": "asym-decrypt-ops",
> >           "value": 32
> >         },
> >         {
> >           "name": "asym-encrypt-ops",
> >           "value": 48
> >         }
> >       ],
> >       "qom-path": "/objects/cryptodev0" # support asym only
> >     },
> >     {
> >       "provider": "cryptodev",
> >       "stats": [
> >         {
> >           "name": "asym-verify-bytes",
> >           "value": 0
> >         },
> >         ...
> >         {
> >           "name": "sym-decrypt-bytes",
> >           "value": 5376
> >         },
> >         ...
> >       ],
> >       "qom-path": "/objects/cryptodev1" # support asym/sym
> >     }
> >   ],
> >   "id": "libvirt-422"
> > }
> > 
> > Suggested-by: Daniel P. Berrangé <berrange@redhat.com>
> > Signed-off-by: zhenwei pi <pizhenwei@bytedance.com>
> 
> I assume since this has been out a long time and no
> comments by maintainers it's ok from QAPI POV.

I'm not the QAPI maintainer, but I think this worked out
pretty nicely compared to the previous versions of the
series which didn't use query-stats.. just a minor point
below.

> 
> > ---
> >  backends/cryptodev.c | 141 +++++++++++++++++++++++++++++++++++++++++++
> >  monitor/hmp-cmds.c   |   5 ++
> >  monitor/qmp-cmds.c   |   2 +
> >  qapi/stats.json      |  10 ++-
> >  4 files changed, 156 insertions(+), 2 deletions(-)
> > 
> > diff --git a/backends/cryptodev.c b/backends/cryptodev.c
> > index 09ffdd345f..9d52220772 100644
> > --- a/backends/cryptodev.c
> > +++ b/backends/cryptodev.c
> > @@ -22,9 +22,11 @@
> >   */
> >  
> >  #include "qemu/osdep.h"
> > +#include "monitor/stats.h"
> >  #include "sysemu/cryptodev.h"
> >  #include "qapi/error.h"
> >  #include "qapi/qapi-commands-cryptodev.h"
> > +#include "qapi/qapi-types-stats.h"
> >  #include "qapi/visitor.h"
> >  #include "qemu/config-file.h"
> >  #include "qemu/error-report.h"
> > @@ -32,6 +34,14 @@
> >  #include "qom/object_interfaces.h"
> >  #include "hw/virtio/virtio-crypto.h"
> >  
> > +typedef struct StatsArgs {
> > +    union StatsResultsType {
> > +        StatsResultList **stats;
> > +        StatsSchemaList **schema;
> > +    } result;
> > +    strList *names;
> > +    Error **errp;
> > +} StatsArgs;
> >  
> >  static QTAILQ_HEAD(, CryptoDevBackendClient) crypto_clients;
> >  
> > @@ -435,6 +445,134 @@ static void cryptodev_backend_finalize(Object *obj)
> >      }
> >  }
> >  
> > +static StatsList *cryptodev_backend_stats_add(const char *name, int64_t 
> > *val,
> > +                                              StatsList *stats_list)
> > +{
> > +    Stats *stats = g_new0(Stats, 1);
> > +
> > +    stats->name = g_strdup(name);
> > +    stats->value = g_new0(StatsValue, 1);
> > +    stats->value->type = QTYPE_QNUM;
> > +    stats->value->u.scalar = *val;
> > +
> > +    QAPI_LIST_PREPEND(stats_list, stats);
> > +    return stats_list;
> > +}
> > +
> > +static int cryptodev_backend_stats_query(Object *obj, void *data)
> > +{
> > +    StatsArgs *stats_args = data;
> > +    StatsResultList **stats_results = stats_args->result.stats;
> > +    StatsList *stats_list = NULL;
> > +    StatsResult *entry;
> > +    CryptoDevBackend *backend;
> > +    QCryptodevBackendSymStat *sym_stat;
> > +    QCryptodevBackendAsymStat *asym_stat;
> > +
> > +    if (!object_dynamic_cast(obj, TYPE_CRYPTODEV_BACKEND)) {
> > +        return 0;
> > +    }
> > +
> > +    backend = CRYPTODEV_BACKEND(obj);
> > +    sym_stat = backend->sym_stat;
> > +    if (sym_stat) {
> > +        stats_list = cryptodev_backend_stats_add("sym-encrypt-ops",
> > +                         &sym_stat->encrypt_ops, stats_list);
> > +        stats_list = cryptodev_backend_stats_add("sym-decrypt-ops",
> > +                         &sym_stat->decrypt_ops, stats_list);
> > +        stats_list = cryptodev_backend_stats_add("sym-encrypt-bytes",
> > +                         &sym_stat->encrypt_bytes, stats_list);
> > +        stats_list = cryptodev_backend_stats_add("sym-decrypt-bytes",
> > +                         &sym_stat->decrypt_bytes, stats_list);
> > +    }
> > +
> > +    asym_stat = backend->asym_stat;
> > +    if (asym_stat) {
> > +        stats_list = cryptodev_backend_stats_add("asym-encrypt-ops",
> > +                         &asym_stat->encrypt_ops, stats_list);
> > +        stats_list = cryptodev_backend_stats_add("asym-decrypt-ops",
> > +                         &asym_stat->decrypt_ops, stats_list);
> > +        stats_list = cryptodev_backend_stats_add("asym-sign-ops",
> > +                         &asym_stat->sign_ops, stats_list);
> > +        stats_list = cryptodev_backend_stats_add("asym-verify-ops",
> > +                         &asym_stat->verify_ops, stats_list);
> > +        stats_list = cryptodev_backend_stats_add("asym-encrypt-bytes",
> > +                         &asym_stat->encrypt_bytes, stats_list);
> > +        stats_list = cryptodev_backend_stats_add("asym-decrypt-bytes",
> > +                         &asym_stat->decrypt_bytes, stats_list);
> > +        stats_list = cryptodev_backend_stats_add("asym-sign-bytes",
> > +                         &asym_stat->sign_bytes, stats_list);
> > +        stats_list = cryptodev_backend_stats_add("asym-verify-bytes",
> > +                         &asym_stat->verify_bytes, stats_list);

Perhaps there's benefit in having constants defined for these strings,
since they become part of our API, and the same strings are repeated
again further down.....

> > +    }
> > +
> > +    entry = g_new0(StatsResult, 1);
> > +    entry->provider = STATS_PROVIDER_CRYPTODEV;
> > +    entry->qom_path = g_strdup(object_get_canonical_path(obj));
> > +    entry->stats = stats_list;
> > +    QAPI_LIST_PREPEND(*stats_results, entry);
> > +
> > +    return 0;
> > +}

...snip...

> > +
> > +static void cryptodev_backend_schemas_cb(StatsSchemaList **result,
> > +                                         Error **errp)
> > +{
> > +    StatsSchemaValueList *stats_list = NULL;
> > +    const char *sym_stats[] = {"sym-encrypt-ops", "sym-decrypt-ops",
> > +                               "sym-encrypt-bytes", "sym-decrypt-bytes"};
> > +    const char *asym_stats[] = {"asym-encrypt-ops", "asym-decrypt-ops",
> > +                                "asym-sign-ops", "asym-verify-ops",
> > +                                "asym-encrypt-bytes", "asym-decrypt-bytes",
> > +                                "asym-sign-bytes", "asym-verify-bytes"};

... here's the repeated use of the constant strings from earlier

> > +
> > +    for (int i = 0; i < ARRAY_SIZE(sym_stats); i++) {
> > +        stats_list = cryptodev_backend_schemas_add(sym_stats[i], 
> > stats_list);
> > +    }
> > +
> > +    for (int i = 0; i < ARRAY_SIZE(asym_stats); i++) {
> > +        stats_list = cryptodev_backend_schemas_add(asym_stats[i], 
> > stats_list);
> > +    }
> > +
> > +    add_stats_schema(result, STATS_PROVIDER_CRYPTODEV, 
> > STATS_TARGET_CRYPTODEV,
> > +                     stats_list);
> > +}

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