Skip to contentSkip to conversation

vhost-user-blk-test and vdagent Coverity fixes

PATCH In review Stefan Hajnoczi 3 participants 7 messages Jun 1, 2021 – Jun 2, 2021

lore
Share & tools
lore
#0 lore raw

v2 cover vhost-user-blk-test and vdagent Coverity fixes

v2:
* Drop Patch 2 since the mkstemp(3) umask warning is archaic and hasn't applied for a long time [Peter]
* Fix inconsistent g_assert_cmpint()/assert(3) usage in Patch 1 [Peter]

This patch series addresses recent Coverity reports. Please see the individual patches for details.

Stefan Hajnoczi (2):
vhost-user-blk-test: fix Coverity open(2) false positives ui/vdagent: fix clipboard info memory leak in error path

 tests/qtest/vhost-user-blk-test.c | 8 ++++++--
 ui/vdagent.c                      | 2 +-
 2 files changed, 7 insertions(+), 3 deletions(-)
Signature · 1 line
2.31.1
#1 lore raw

PATCH v2 1/2 vhost-user-blk-test: fix Coverity open(2) false positives

Coverity checks that the file descriptor return value of open(2) is checked and used. Normally this is helpful in identifying real bugs but vhost-user-blk-test opens /dev/null as stdin and stdout after fork.

In this case we don't need to look at the return value because these open(2) calls cannot fail in any reasonable environment. We already know their return values ahead of time since we closed stdin and stdout previously. open(2) is guaranteed to pick the lowest available fd number.

Silence Coverity by introducing code that checks what we already know to be true.

** CID 1453270: Resource leaks (RESOURCE_LEAK) /qemu/tests/qtest/vhost-user-blk-test.c: 920 in start_vhost_user_blk()

________________________________________________________________________________________________________
*** CID 1453270: Resource leaks (RESOURCE_LEAK) /qemu/tests/qtest/vhost-user-blk-test.c: 920 in start_vhost_user_blk()

914              * Close standard file descriptors so tap-driver.pl pipe detects when
915              * our parent terminates.
916              */
917             close(0);
918             close(1);
919             open("/dev/null", O_RDONLY);
Quoted 2 lines
Quoted 2 lines
Quoted 2 lines

CID 1453270: Resource leaks (RESOURCE_LEAK) Ignoring handle opened by "open("/dev/null", 1)" leaks it.

920 open("/dev/null", O_WRONLY);
921
922 execlp("/bin/sh", "sh", "-c", storage_daemon_command->str, NULL);
923 exit(1);
924 }
925 g_string_free(storage_daemon_command, true);

** CID 1453269: Error handling issues (NEGATIVE_RETURNS) /qemu/tests/qtest/vhost-user-blk-test.c: 829 in create_listen_socket()

________________________________________________________________________________________________________
*** CID 1453269: Error handling issues (NEGATIVE_RETURNS) /qemu/tests/qtest/vhost-user-blk-test.c: 829 in create_listen_socket()
823 char *path;
824

825         /* No race because our pid makes the path unique */
826         path = g_strdup_printf("/tmp/qtest-%d-sock.XXXXXX", getpid());
827         tmp_fd = mkstemp(path);
828         g_assert_cmpint(tmp_fd, >=, 0);
Quoted 2 lines
Quoted 2 lines
Quoted 2 lines

CID 1453269: Error handling issues (NEGATIVE_RETURNS) "tmp_fd" is passed to a parameter that cannot be negative.

829 close(tmp_fd);
830 unlink(path);
831

832         *fd = qtest_socket_server(path);
833         g_test_queue_destroy(destroy_file, path);
834         return path;

** CID 1453268: (CHECKED_RETURN)
/qemu/tests/qtest/vhost-user-blk-test.c: 920 in start_vhost_user_blk() /qemu/tests/qtest/vhost-user-blk-test.c: 919 in start_vhost_user_blk()

________________________________________________________________________________________________________
*** CID 1453268: (CHECKED_RETURN)
/qemu/tests/qtest/vhost-user-blk-test.c: 920 in start_vhost_user_blk()

914              * Close standard file descriptors so tap-driver.pl pipe detects when
915              * our parent terminates.
916              */
917             close(0);
918             close(1);
919             open("/dev/null", O_RDONLY);
Quoted 2 lines
Quoted 2 lines
Quoted 2 lines

CID 1453268: (CHECKED_RETURN)
Calling "open("/dev/null", 1)" without checking return value. This library function may fail and return an error code. [Note: The source code implementation of the function has been overridden by a builtin model.]

920 open("/dev/null", O_WRONLY);
921
922 execlp("/bin/sh", "sh", "-c", storage_daemon_command->str, NULL);
923 exit(1);
924 }
925 g_string_free(storage_daemon_command, true);
/qemu/tests/qtest/vhost-user-blk-test.c: 919 in start_vhost_user_blk()
913 /*

914              * Close standard file descriptors so tap-driver.pl pipe detects when
915              * our parent terminates.
916              */

917 close(0);
918 close(1);

Quoted 2 lines
Quoted 2 lines
Quoted 2 lines

CID 1453268: (CHECKED_RETURN)
Calling "open("/dev/null", 0)" without checking return value. This library function may fail and return an error code. [Note: The source code implementation of the function has been overridden by a builtin model.]

919 open("/dev/null", O_RDONLY);
920 open("/dev/null", O_WRONLY);
921
922 execlp("/bin/sh", "sh", "-c", storage_daemon_command->str, NULL);
923 exit(1);
924 }

---
 tests/qtest/vhost-user-blk-test.c | 8 ++++++--
 1 file changed, 6 insertions(+), 2 deletions(-)
tests/qtest/vhost-user-blk-test.c +6 -2
index 8796c74ca4..c5c4667759 100644
@@ -910,14 +910,18 @@ static void start_vhost_user_blk(GString *cmd_line, int vus_instances,
                    storage_daemon_command->str);
     pid_t pid = fork();
     if (pid == 0) {
+        int fd;
+
         /*
          * Close standard file descriptors so tap-driver.pl pipe detects when
          * our parent terminates.
          */
         close(0);
+        fd = open("/dev/null", O_RDONLY);
+        g_assert_cmpint(fd, ==, 0);
         close(1);
-        open("/dev/null", O_RDONLY);
-        open("/dev/null", O_WRONLY);
+        fd = open("/dev/null", O_WRONLY);
+        g_assert_cmpint(fd, ==, 1);
 
         execlp("/bin/sh", "sh", "-c", storage_daemon_command->str, NULL);
         exit(1);
Signature · 1 line
2.31.1
Reviewed-by on v2 1/2
#2 lore raw

Re: [PATCH v2 1/2] vhost-user-blk-test: fix Coverity open(2) false positives

Quoted 92 lines · Stefan Hajnoczi

Coverity checks that the file descriptor return value of open(2) is checked and used. Normally this is helpful in identifying real bugs but vhost-user-blk-test opens /dev/null as stdin and stdout after fork.

In this case we don't need to look at the return value because these open(2) calls cannot fail in any reasonable environment. We already know their return values ahead of time since we closed stdin and stdout previously. open(2) is guaranteed to pick the lowest available fd number.

Silence Coverity by introducing code that checks what we already know to be true.

** CID 1453270: Resource leaks (RESOURCE_LEAK) /qemu/tests/qtest/vhost-user-blk-test.c: 920 in start_vhost_user_blk()

________________________________________________________________________________________________________
*** CID 1453270: Resource leaks (RESOURCE_LEAK) /qemu/tests/qtest/vhost-user-blk-test.c: 920 in start_vhost_user_blk()

914              * Close standard file descriptors so tap-driver.pl pipe detects when
915              * our parent terminates.
916              */
917             close(0);
918             close(1);
919             open("/dev/null", O_RDONLY);
Quoted 2 lines
Quoted 2 lines
Quoted 2 lines

CID 1453270: Resource leaks (RESOURCE_LEAK) Ignoring handle opened by "open("/dev/null", 1)" leaks it.

920 open("/dev/null", O_WRONLY);
921
922 execlp("/bin/sh", "sh", "-c", storage_daemon_command->str, NULL);
923 exit(1);
924 }
925 g_string_free(storage_daemon_command, true);

** CID 1453269: Error handling issues (NEGATIVE_RETURNS) /qemu/tests/qtest/vhost-user-blk-test.c: 829 in create_listen_socket()

________________________________________________________________________________________________________
*** CID 1453269: Error handling issues (NEGATIVE_RETURNS) /qemu/tests/qtest/vhost-user-blk-test.c: 829 in create_listen_socket()
823 char *path;
824

825         /* No race because our pid makes the path unique */
826         path = g_strdup_printf("/tmp/qtest-%d-sock.XXXXXX", getpid());
827         tmp_fd = mkstemp(path);
828         g_assert_cmpint(tmp_fd, >=, 0);
Quoted 2 lines
Quoted 2 lines
Quoted 2 lines

CID 1453269: Error handling issues (NEGATIVE_RETURNS) "tmp_fd" is passed to a parameter that cannot be negative.

829 close(tmp_fd);
830 unlink(path);
831

832         *fd = qtest_socket_server(path);
833         g_test_queue_destroy(destroy_file, path);
834         return path;

** CID 1453268: (CHECKED_RETURN)
/qemu/tests/qtest/vhost-user-blk-test.c: 920 in start_vhost_user_blk() /qemu/tests/qtest/vhost-user-blk-test.c: 919 in start_vhost_user_blk()

________________________________________________________________________________________________________
*** CID 1453268: (CHECKED_RETURN)
/qemu/tests/qtest/vhost-user-blk-test.c: 920 in start_vhost_user_blk()

914              * Close standard file descriptors so tap-driver.pl pipe detects when
915              * our parent terminates.
916              */
917             close(0);
918             close(1);
919             open("/dev/null", O_RDONLY);
Quoted 2 lines
Quoted 2 lines
Quoted 2 lines

CID 1453268: (CHECKED_RETURN)
Calling "open("/dev/null", 1)" without checking return value. This library function may fail and return an error code. [Note: The source code implementation of the function has been overridden by a builtin model.]

920 open("/dev/null", O_WRONLY);
921
922 execlp("/bin/sh", "sh", "-c", storage_daemon_command->str, NULL);
923 exit(1);
924 }
925 g_string_free(storage_daemon_command, true);
/qemu/tests/qtest/vhost-user-blk-test.c: 919 in start_vhost_user_blk()
913 /*

914              * Close standard file descriptors so tap-driver.pl pipe detects when
915              * our parent terminates.
916              */

917 close(0);
918 close(1);

Quoted 2 lines
Quoted 2 lines
Quoted 2 lines

CID 1453268: (CHECKED_RETURN)
Calling "open("/dev/null", 0)" without checking return value. This library function may fail and return an error code. [Note: The source code implementation of the function has been overridden by a builtin model.]

919 open("/dev/null", O_RDONLY);
920 open("/dev/null", O_WRONLY);
921
922 execlp("/bin/sh", "sh", "-c", storage_daemon_command->str, NULL);
923 exit(1);
924 }

Quoted 4 lines
---
 tests/qtest/vhost-user-blk-test.c | 8 ++++++--
 1 file changed, 6 insertions(+), 2 deletions(-)
Reviewed-by on v2 1/2
#3 lore raw

Re: [PATCH v2 1/2] vhost-user-blk-test: fix Coverity open(2) false positives

In reply to Stefan Hajnoczi
Quoted 113 lines · Stefan Hajnoczi

Coverity checks that the file descriptor return value of open(2) is checked and used. Normally this is helpful in identifying real bugs but vhost-user-blk-test opens /dev/null as stdin and stdout after fork.

In this case we don't need to look at the return value because these open(2) calls cannot fail in any reasonable environment. We already know their return values ahead of time since we closed stdin and stdout previously. open(2) is guaranteed to pick the lowest available fd number.

Silence Coverity by introducing code that checks what we already know to be true.

** CID 1453270: Resource leaks (RESOURCE_LEAK) /qemu/tests/qtest/vhost-user-blk-test.c: 920 in start_vhost_user_blk()

________________________________________________________________________________________________________
*** CID 1453270: Resource leaks (RESOURCE_LEAK) /qemu/tests/qtest/vhost-user-blk-test.c: 920 in start_vhost_user_blk()

914              * Close standard file descriptors so tap-driver.pl pipe detects when
915              * our parent terminates.
916              */
917             close(0);
918             close(1);
919             open("/dev/null", O_RDONLY);
Quoted 2 lines
Quoted 2 lines
Quoted 2 lines

CID 1453270: Resource leaks (RESOURCE_LEAK) Ignoring handle opened by "open("/dev/null", 1)" leaks it.

920 open("/dev/null", O_WRONLY);
921
922 execlp("/bin/sh", "sh", "-c", storage_daemon_command->str, NULL);
923 exit(1);
924 }
925 g_string_free(storage_daemon_command, true);

** CID 1453269: Error handling issues (NEGATIVE_RETURNS) /qemu/tests/qtest/vhost-user-blk-test.c: 829 in create_listen_socket()

________________________________________________________________________________________________________
*** CID 1453269: Error handling issues (NEGATIVE_RETURNS) /qemu/tests/qtest/vhost-user-blk-test.c: 829 in create_listen_socket()
823 char *path;
824

825         /* No race because our pid makes the path unique */
826         path = g_strdup_printf("/tmp/qtest-%d-sock.XXXXXX", getpid());
827         tmp_fd = mkstemp(path);
828         g_assert_cmpint(tmp_fd, >=, 0);
Quoted 2 lines
Quoted 2 lines
Quoted 2 lines

CID 1453269: Error handling issues (NEGATIVE_RETURNS) "tmp_fd" is passed to a parameter that cannot be negative.

829 close(tmp_fd);
830 unlink(path);
831

832         *fd = qtest_socket_server(path);
833         g_test_queue_destroy(destroy_file, path);
834         return path;

** CID 1453268: (CHECKED_RETURN)
/qemu/tests/qtest/vhost-user-blk-test.c: 920 in start_vhost_user_blk() /qemu/tests/qtest/vhost-user-blk-test.c: 919 in start_vhost_user_blk()

________________________________________________________________________________________________________
*** CID 1453268: (CHECKED_RETURN)
/qemu/tests/qtest/vhost-user-blk-test.c: 920 in start_vhost_user_blk()

914              * Close standard file descriptors so tap-driver.pl pipe detects when
915              * our parent terminates.
916              */
917             close(0);
918             close(1);
919             open("/dev/null", O_RDONLY);
Quoted 2 lines
Quoted 2 lines
Quoted 2 lines

CID 1453268: (CHECKED_RETURN)
Calling "open("/dev/null", 1)" without checking return value. This library function may fail and return an error code. [Note: The source code implementation of the function has been overridden by a builtin model.]

920 open("/dev/null", O_WRONLY);
921
922 execlp("/bin/sh", "sh", "-c", storage_daemon_command->str, NULL);
923 exit(1);
924 }
925 g_string_free(storage_daemon_command, true);
/qemu/tests/qtest/vhost-user-blk-test.c: 919 in start_vhost_user_blk()
913 /*

914              * Close standard file descriptors so tap-driver.pl pipe detects when
915              * our parent terminates.
916              */

917 close(0);
918 close(1);

Quoted 2 lines
Quoted 2 lines
Quoted 2 lines

CID 1453268: (CHECKED_RETURN)
Calling "open("/dev/null", 0)" without checking return value. This library function may fail and return an error code. [Note: The source code implementation of the function has been overridden by a builtin model.]

919 open("/dev/null", O_RDONLY);
920 open("/dev/null", O_WRONLY);
921
922 execlp("/bin/sh", "sh", "-c", storage_daemon_command->str, NULL);
923 exit(1);
924 }

---
  tests/qtest/vhost-user-blk-test.c | 8 ++++++--
  1 file changed, 6 insertions(+), 2 deletions(-)
tests/qtest/vhost-user-blk-test.c +2 -0
index 8796c74ca4..c5c4667759 100644
@@ -910,14 +910,18 @@ static void start_vhost_user_blk(GString *cmd_line, int vus_instances,
                     storage_daemon_command->str);
      pid_t pid = fork();
      if (pid == 0) {
+        int fd;
+
          /*
           * Close standard file descriptors so tap-driver.pl pipe detects when
           * our parent terminates.
           */
          close(0);

tests/qtest/vhost-user-blk-test.c static void start_vhost_user_blk(GString *cmd_line, int vus_instances, · line 927

Quoted 10 lines
tests/qtest/vhost-user-blk-test.c +4 -2
+        fd = open("/dev/null", O_RDONLY);
+        g_assert_cmpint(fd, ==, 0);
          close(1);
-        open("/dev/null", O_RDONLY);
-        open("/dev/null", O_WRONLY);
+        fd = open("/dev/null", O_WRONLY);
+        g_assert_cmpint(fd, ==, 1);
 
          execlp("/bin/sh", "sh", "-c", storage_daemon_command->str, NULL);
          exit(1);
#4 lore raw

PATCH v2 2/2 ui/vdagent: fix clipboard info memory leak in error path

In reply to Stefan Hajnoczi

If the size of a VD_AGENT_CLIPBOARD_GRAB message is invalid we leak info when returning early.

Thanks to Coverity for spotting this:

*** CID 1453266: Resource leaks (RESOURCE_LEAK) /qemu/ui/vdagent.c: 465 in vdagent_chr_recv_clipboard()
459 info = qemu_clipboard_info_new(&vd->cbpeer, s);
460 if (size > sizeof(uint32_t) * 10) {
461 /*

462                  * spice has 6 types as of 2021. Limiting to 10 entries
463                  * so we we have some wiggle room.
464                  */
Quoted 2 lines
Quoted 2 lines
Quoted 2 lines

CID 1453266: Resource leaks (RESOURCE_LEAK)
Variable "info" going out of scope leaks the storage it points to.

465 return;
466 }
467 while (size >= sizeof(uint32_t)) {

468                 trace_vdagent_cb_grab_type(GET_NAME(type_name, *(uint32_t *)data));
469                 switch (*(uint32_t *)data) {
470                 case VD_AGENT_CLIPBOARD_UTF8_TEXT:
Fixes f0349f4d8947ad32d0fa4678cbf5dbb356fcbda1 ("ui/vdagent: add clipboard support")
---
 ui/vdagent.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
ui/vdagent.c +1 -1
index a253a8fe63..8fc54d330e 100644
@@ -456,7 +456,6 @@ static void vdagent_chr_recv_clipboard(VDAgentChardev *vd, VDAgentMessage *msg)
     switch (msg->type) {
     case VD_AGENT_CLIPBOARD_GRAB:
         trace_vdagent_cb_grab_selection(GET_NAME(sel_name, s));
-        info = qemu_clipboard_info_new(&vd->cbpeer, s);
         if (size > sizeof(uint32_t) * 10) {
             /*
              * spice has 6 types as of 2021. Limiting to 10 entries
@@ -464,6 +463,7 @@ static void vdagent_chr_recv_clipboard(VDAgentChardev *vd, VDAgentMessage *msg)
              */
             return;
         }
+        info = qemu_clipboard_info_new(&vd->cbpeer, s);
         while (size >= sizeof(uint32_t)) {
             trace_vdagent_cb_grab_type(GET_NAME(type_name, *(uint32_t *)data));
             switch (*(uint32_t *)data) {
Signature · 1 line
2.31.1
Reviewed-by on v2 2/2
#5 lore raw

Re: [PATCH v2 2/2] ui/vdagent: fix clipboard info memory leak in error path

Quoted 22 lines · Stefan Hajnoczi

If the size of a VD_AGENT_CLIPBOARD_GRAB message is invalid we leak info when returning early.

Thanks to Coverity for spotting this:

*** CID 1453266: Resource leaks (RESOURCE_LEAK) /qemu/ui/vdagent.c: 465 in vdagent_chr_recv_clipboard()
459 info = qemu_clipboard_info_new(&vd->cbpeer, s);
460 if (size > sizeof(uint32_t) * 10) {
461 /*

462                  * spice has 6 types as of 2021. Limiting to 10 entries
463                  * so we we have some wiggle room.
464                  */
Quoted 2 lines
Quoted 2 lines
Quoted 2 lines

CID 1453266: Resource leaks (RESOURCE_LEAK)
Variable "info" going out of scope leaks the storage it points to.

465 return;
466 }
467 while (size >= sizeof(uint32_t)) {

468                 trace_vdagent_cb_grab_type(GET_NAME(type_name, *(uint32_t *)data));
469                 switch (*(uint32_t *)data) {
470                 case VD_AGENT_CLIPBOARD_UTF8_TEXT:
Quoted 6 lines
Fixes f0349f4d8947ad32d0fa4678cbf5dbb356fcbda1 ("ui/vdagent: add clipboard support")
---
 ui/vdagent.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Reviewed-by on v2 2/2
#6 lore raw

Re: [PATCH v2 2/2] ui/vdagent: fix clipboard info memory leak in error path

In reply to Stefan Hajnoczi
Quoted 43 lines · Stefan Hajnoczi

If the size of a VD_AGENT_CLIPBOARD_GRAB message is invalid we leak info when returning early.

Thanks to Coverity for spotting this:

*** CID 1453266: Resource leaks (RESOURCE_LEAK) /qemu/ui/vdagent.c: 465 in vdagent_chr_recv_clipboard()
459 info = qemu_clipboard_info_new(&vd->cbpeer, s);
460 if (size > sizeof(uint32_t) * 10) {
461 /*

462                  * spice has 6 types as of 2021. Limiting to 10 entries
463                  * so we we have some wiggle room.
464                  */
Quoted 2 lines
Quoted 2 lines
Quoted 2 lines

CID 1453266: Resource leaks (RESOURCE_LEAK)
Variable "info" going out of scope leaks the storage it points to.

465 return;
466 }
467 while (size >= sizeof(uint32_t)) {

468                 trace_vdagent_cb_grab_type(GET_NAME(type_name, *(uint32_t *)data));
469                 switch (*(uint32_t *)data) {
470                 case VD_AGENT_CLIPBOARD_UTF8_TEXT:
Fixes f0349f4d8947ad32d0fa4678cbf5dbb356fcbda1 ("ui/vdagent: add clipboard support")
---
  ui/vdagent.c | 2 +-
  1 file changed, 1 insertion(+), 1 deletion(-)
ui/vdagent.c +0 -1
index a253a8fe63..8fc54d330e 100644
@@ -456,7 +456,6 @@ static void vdagent_chr_recv_clipboard(VDAgentChardev *vd, VDAgentMessage *msg)
      switch (msg->type) {
      case VD_AGENT_CLIPBOARD_GRAB:
          trace_vdagent_cb_grab_selection(GET_NAME(sel_name, s));
-        info = qemu_clipboard_info_new(&vd->cbpeer, s);
          if (size > sizeof(uint32_t) * 10) {
              /*
               * spice has 6 types as of 2021. Limiting to 10 entries

ui/vdagent.c static void vdagent_chr_recv_clipboard(VDAgentChardev *vd, VDAgentMessage *msg) · line 469

Quoted 7 lines
ui/vdagent.c +1 -0
@@ -464,6 +463,7 @@ static void vdagent_chr_recv_clipboard(VDAgentChardev *vd, VDAgentMessage *msg)
               */
              return;
          }
+        info = qemu_clipboard_info_new(&vd->cbpeer, s);
          while (size >= sizeof(uint32_t)) {
              trace_vdagent_cb_grab_type(GET_NAME(type_name, *(uint32_t *)data));
              switch (*(uint32_t *)data) {