Skip to contentSkip to conversation

qapi: enable use of g_autoptr with QAPI types

PATCH Superseded Daniel P. Berrangé 3 participants 5 messages Jul 23, 2020 Crypto API

v1 of 2 Superseded Latest is v2 →

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 qapi: enable use of g_autoptr with QAPI types

Currently QAPI generates a type and function for free'ing it:

  typedef struct QCryptoBlockCreateOptions QCryptoBlockCreateOptions;
  void qapi_free_QCryptoBlockCreateOptions(QCryptoBlockCreateOptions *obj);

This is used in the traditional manner:

  QCryptoBlockCreateOptions *opts = NULL;

  opts = g_new0(QCryptoBlockCreateOptions, 1);

....do stuff with opts...

  qapi_free_QCryptoBlockCreateOptions(opts);

Since bumping the min glib to 2.48, QEMU has incrementally adopted the use of g_auto/g_autoptr. This allows the compiler to run a function to free a variable when it goes out of scope, the benefit being the compiler can guarantee it is freed in all possible code ptahs.

This benefit is applicable to QAPI types too, and given the seriously long method names for some qapi_free_XXXX() functions, is much less typing. This change thus makes the code generator emit:

G_DEFINE_AUTOPTR_CLEANUP_FUNC(QCryptoBlockCreateOptions,
qapi_free_QCryptoBlockCreateOptions)

The above code example now becomes

  g_autoptr(QCryptoBlockCreateOptions) opts = NULL;

  opts = g_new0(QCryptoBlockCreateOptions, 1);

....do stuff with opts...

Note, if the local pointer needs to live beyond the scope holding the variable, then g_steal_pointer can be used. This is useful to return the pointer to the caller in the success codepath, while letting it be freed in all error codepaths.

  return g_steal_pointer(&opts);
---
 include/crypto/block.h | 2 --
 scripts/qapi/types.py  | 1 +
 2 files changed, 1 insertion(+), 2 deletions(-)
include/crypto/block.h +0 -2
index d274819791..7a65e8e402 100644
@@ -311,7 +311,5 @@ uint64_t qcrypto_block_get_sector_size(QCryptoBlock *block);
 void qcrypto_block_free(QCryptoBlock *block);
 
 G_DEFINE_AUTOPTR_CLEANUP_FUNC(QCryptoBlock, qcrypto_block_free)
-G_DEFINE_AUTOPTR_CLEANUP_FUNC(QCryptoBlockCreateOptions,
-                              qapi_free_QCryptoBlockCreateOptions)
 
 #endif /* QCRYPTO_BLOCK_H */
scripts/qapi/types.py +1 -0
index 3ad33af4ee..3640f17cd6 100644
@@ -213,6 +213,7 @@ def gen_type_cleanup_decl(name):
     ret = mcgen('''
 
 void qapi_free_%(c_name)s(%(c_name)s *obj);
+G_DEFINE_AUTOPTR_CLEANUP_FUNC(%(c_name)s, qapi_free_%(c_name)s)
 ''',
                 c_name=c_name(name))
     return ret
Signature · 1 line
2.26.2
#1 lore raw
Quoted 12 lines · Daniel P. Berrangé

Currently QAPI generates a type and function for free'ing it:

   typedef struct QCryptoBlockCreateOptions QCryptoBlockCreateOptions;
   void qapi_free_QCryptoBlockCreateOptions(QCryptoBlockCreateOptions *obj);

The above code example now becomes

   g_autoptr(QCryptoBlockCreateOptions) opts = NULL;

   opts = g_new0(QCryptoBlockCreateOptions, 1);
Quoted 9 lines
   ....do stuff with opts...

Note, if the local pointer needs to live beyond the scope holding the variable, then g_steal_pointer can be used. This is useful to return the pointer to the caller in the success codepath, while letting it be freed in all error codepaths.

   return g_steal_pointer(&opts);

Yep, the idea makes sense!

Quoted 5 lines
---
  include/crypto/block.h | 2 --
  scripts/qapi/types.py  | 1 +
  2 files changed, 1 insertion(+), 2 deletions(-)

Missing a counterpart change to docs/devel/qapi-code-gen.txt. And it might be nice to make this a series with at least one followup patch using the new capability, or at least so 'make check' coverage. But otherwise on the right track.

Signature · 3 lines
Eric Blake, Principal Software Engineer
Red Hat, Inc.           +1-919-301-3226
Virtualization:  qemu.org | libvirt.org
#2 lore raw
Quoted 31 lines · Eric Blake
Quoted 12 lines · Daniel P. Berrangé

Currently QAPI generates a type and function for free'ing it:

   typedef struct QCryptoBlockCreateOptions QCryptoBlockCreateOptions;
   void qapi_free_QCryptoBlockCreateOptions(QCryptoBlockCreateOptions *obj);

The above code example now becomes

   g_autoptr(QCryptoBlockCreateOptions) opts = NULL;

   opts = g_new0(QCryptoBlockCreateOptions, 1);
Quoted 9 lines
   ....do stuff with opts...

Note, if the local pointer needs to live beyond the scope holding the variable, then g_steal_pointer can be used. This is useful to return the pointer to the caller in the success codepath, while letting it be freed in all error codepaths.

   return g_steal_pointer(&opts);

Yep, the idea makes sense!

Quoted 5 lines
---
  include/crypto/block.h | 2 --
  scripts/qapi/types.py  | 1 +
  2 files changed, 1 insertion(+), 2 deletions(-)
Quoted 4 lines

Missing a counterpart change to docs/devel/qapi-code-gen.txt. And it might be nice to make this a series with at least one followup patch using the new capability, or at least so 'make check' coverage. But otherwise on the right track.

The crypto/block.c already makes use of this capability, which is why I had to remove the line from block.h to avoid declaring the same thing twice !

Regards,
Daniel

Signature · 3 lines
|: 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 :|
Reviewed-by
#3 lore raw
Quoted 21 lines · Daniel P. Berrangé
Quoted 20 lines · Eric Blake
Quoted 19 lines · Daniel P. Berrangé

Currently QAPI generates a type and function for free'ing it:

   typedef struct QCryptoBlockCreateOptions QCryptoBlockCreateOptions;
   void qapi_free_QCryptoBlockCreateOptions(QCryptoBlockCreateOptions *obj);

The above code example now becomes

   g_autoptr(QCryptoBlockCreateOptions) opts = NULL;

   opts = g_new0(QCryptoBlockCreateOptions, 1);
   ....do stuff with opts...

Note, if the local pointer needs to live beyond the scope holding the variable, then g_steal_pointer can be used. This is useful to return the pointer to the caller in the success codepath, while letting it be freed in all error codepaths.

Quoted 4 lines
Quoted 4 lines
Quoted 2 lines
   return g_steal_pointer(&opts);

Yep, the idea makes sense!

Agree.

Quoted 7 lines
Quoted 7 lines
Quoted 5 lines
---
  include/crypto/block.h | 2 --
  scripts/qapi/types.py  | 1 +
  2 files changed, 1 insertion(+), 2 deletions(-)

Missing a counterpart change to docs/devel/qapi-code-gen.txt.

Yes. Can do that in my tree.

Quoted 8 lines
Quoted 4 lines

And it might
be nice to make this a series with at least one followup patch using the new capability, or at least so 'make check' coverage. But otherwise on the right track.

The crypto/block.c already makes use of this capability, which is why I had to remove the line from block.h to avoid declaring the same thing twice !

Could be mentioned in the commit message.

Still, using it somewhere in tests would be nice. test-qobject-input-visitor.c's test_visitor_in_struct_nested() looks trivial to convert. Feel free to pick something else.

In case you prefer not to, with a qapi-code-gen.txt update:

#4 lore raw
Quoted 49 lines · Markus Armbruster
Quoted 21 lines · Daniel P. Berrangé
Quoted 20 lines · Eric Blake
Quoted 19 lines · Daniel P. Berrangé

Currently QAPI generates a type and function for free'ing it:

   typedef struct QCryptoBlockCreateOptions QCryptoBlockCreateOptions;
   void qapi_free_QCryptoBlockCreateOptions(QCryptoBlockCreateOptions *obj);

The above code example now becomes

   g_autoptr(QCryptoBlockCreateOptions) opts = NULL;

   opts = g_new0(QCryptoBlockCreateOptions, 1);
   ....do stuff with opts...

Note, if the local pointer needs to live beyond the scope holding the variable, then g_steal_pointer can be used. This is useful to return the pointer to the caller in the success codepath, while letting it be freed in all error codepaths.

Quoted 4 lines
Quoted 4 lines
Quoted 2 lines
   return g_steal_pointer(&opts);

Yep, the idea makes sense!

Agree.

Quoted 7 lines
Quoted 7 lines
Quoted 5 lines
---
  include/crypto/block.h | 2 --
  scripts/qapi/types.py  | 1 +
  2 files changed, 1 insertion(+), 2 deletions(-)

Missing a counterpart change to docs/devel/qapi-code-gen.txt.

Yes. Can do that in my tree.

Quoted 8 lines
Quoted 4 lines

And it might
be nice to make this a series with at least one followup patch using the new capability, or at least so 'make check' coverage. But otherwise on the right track.

The crypto/block.c already makes use of this capability, which is why I had to remove the line from block.h to avoid declaring the same thing twice !

Quoted 5 lines

Could be mentioned in the commit message.

Still, using it somewhere in tests would be nice. test-qobject-input-visitor.c's test_visitor_in_struct_nested() looks trivial to convert. Feel free to pick something else.

Ok, I'll convert some.

Regards,
Daniel

Signature · 3 lines
|: 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 :|