Skip to contentSkip to conversation

LockGuards: replace manual lock()/unlock() calls to WITH_QEMU_LOCK_GUARD()

PATCH In review [email protected] 2 participants 2 messages Nov 5, 2022 – Nov 6, 2022

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 LockGuards: replace manual lock()/unlock() calls to WITH_QEMU_LOCK_GUARD()

From: Samker <[email protected]>

LockGuards are preferred to manual lock()/unlock() calls. Lock guards help prevent common bugs when locks are not released in error code paths. This patch
replaces calls to manual lock()/unlock() with the much preferred WITH_QEMU_LOCK_GUARD()

---
 softmmu/physmem.c | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)
softmmu/physmem.c +3 -3
index d9578ccfd4..fb00596777 100644
@@ -24,6 +24,7 @@
 #include "qemu/cutils.h"
 #include "qemu/cacheflush.h"
 #include "qemu/madvise.h"
+#include "qemu/lockable.h"
 
 #ifdef CONFIG_TCG
 #include "hw/core/tcg-cpu-ops.h"
@@ -3114,13 +3115,12 @@ void cpu_register_map_client(QEMUBH *bh)
 {
     MapClient *client = g_malloc(sizeof(*client));
 
-    qemu_mutex_lock(&map_client_list_lock);
+    WITH_QEMU_LOCK_GUARD(&map_client_list_lock);
     client->bh = bh;
     QLIST_INSERT_HEAD(&map_client_list, client, link);
     if (!qatomic_read(&bounce.in_use)) {
         cpu_notify_map_clients_locked();
     }
-    qemu_mutex_unlock(&map_client_list_lock);
 }
 
 void cpu_exec_init_all(void)
@@ -3143,7 +3143,7 @@ void cpu_unregister_map_client(QEMUBH *bh)
 {
     MapClient *client;
 
-    qemu_mutex_lock(&map_client_list_lock);
+    WITH_QEMU_LOCK_GUARD(&map_client_list_lock);
     QLIST_FOREACH(client, &map_client_list, link) {
         if (client->bh == bh) {
             cpu_unregister_map_client_do(client);
Signature · 1 line
2.25.1
#1 lore raw
Quoted 2 lines · On Fri, 4 Nov 2022 at 21:04, <[email protected]> wrote:

From: Samker <[email protected]>

...

Quoted 1 line

The author and Signed-off-by name/email are different. Do you want to use a single name/email?

Quoted 17 lines
---
 softmmu/physmem.c | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)
softmmu/physmem.c +1 -0
index d9578ccfd4..fb00596777 100644
@@ -24,6 +24,7 @@
 #include "qemu/cutils.h"
 #include "qemu/cacheflush.h"
 #include "qemu/madvise.h"
+#include "qemu/lockable.h"
 
 #ifdef CONFIG_TCG
 #include "hw/core/tcg-cpu-ops.h"

softmmu/physmem.c void cpu_register_map_client(QEMUBH *bh) · line 3118

Quoted 5 lines
softmmu/physmem.c +1 -1
@@ -3114,13 +3115,12 @@ void cpu_register_map_client(QEMUBH *bh)
 {
     MapClient *client = g_malloc(sizeof(*client));
 
-    qemu_mutex_lock(&map_client_list_lock);
+    WITH_QEMU_LOCK_GUARD(&map_client_list_lock);

There is a bug here: the lock won't be held after this line because WITH_QEMU_LOCK_GUARD() is block scoped. It requires curly braces:

  WITH_QEMU_LOCK_GUARD(&lock) {
      ...protected code...
  }
  ...unprotected code...

Use QEMU_LOCK_GUARD(&lock); when don't want block scope. It holds the lock for the remainder of the function.