selftests/x86/lam: fix memory leak and resource leak in lam.c
PATCH 1/1 selftests/x86/lam: fix memory leak and resource leak in lam.c
Static Analyis for bench_htab_mem.c with cppcheck:error tools/testing/selftests/x86/lam.c:585:3:
error: Resource leak: file_fd [resourceLeak] tools/testing/selftests/x86/lam.c:593:3:
error: Resource leak: file_fd [resourceLeak] tools/testing/selftests/x86/lam.c:600:3:
error: Memory leak: fi [memleak] tools/testing/selftests/x86/lam.c:1066:2:
error: Resource leak: fd [resourceLeak]
fix the issue by closing the file descriptors and
releasing the allocated memory.
--- tools/testing/selftests/x86/lam.c | 20 +++++++++++++------- 1 file changed, 13 insertions(+), 7 deletions(-)
tools/testing/selftests/x86/lam.c +13 -7
@@ -581,24 +581,28 @@ int do_uring(unsigned long lam)if (file_fd <0 )return 1 ; -if (fstat (file_fd, &st) <0 ) +if (fstat (file_fd, &st) <0 ) { +close (file_fd);return 1 ; - + }off_t file_sz = st.st_size;int blocks = (int )(file_sz +URING_BLOCK_SZ -1 ) /URING_BLOCK_SZ ; fi =malloc (sizeof (*fi) +sizeof (struct iovec ) * blocks); -if (!fi) +if (!fi) { +close (file_fd);return 1 ; - + } fi->file_sz = file_sz; fi->file_fd = file_fd; ring =malloc (sizeof (*ring)); -if (!ring) +if (!ring) { +close (file_fd); +free (fi);return 1 ; - + }memset (ring,0 ,sizeof (struct io_ring ));if (setup_io_uring (ring))
@@ -1060,8 +1064,10 @@ void *allocate_dsa_pasid(void) wq =mmap (NULL ,0x1000 ,PROT_WRITE ,MAP_SHARED |MAP_POPULATE , fd,0 ); -if (wq ==MAP_FAILED ) +if (wq ==MAP_FAILED ) { +close (fd);perror ("mmap" ); + }return wq; }
Signature · 1 line
2.43.0
Quoted 10 lines · Malaya Kumar Rout
Static Analyis for
bench_htab_mem.cwith cppcheck:errortools/testing/selftests/x86/lam.c:585:3:
error: Resource leak:file_fd[resourceLeak]tools/testing/selftests/x86/lam.c:593:3:
error: Resource leak:file_fd[resourceLeak]tools/testing/selftests/x86/lam.c:600:3:
error: Memory leak: fi [memleak]tools/testing/selftests/x86/lam.c:1066:2:
error: Resource leak: fd [resourceLeak]
Quoted 3 lines
fix the issue by closing the file descriptors and
releasing the allocated memory.
But but but, doesn't the program just exit on any of those 'errors' anyway?
That is, iirc this is a single shot program.
Quoted 11 lines · Peter Zijlstra
Quoted 10 lines · Malaya Kumar Rout
Static Analyis for
bench_htab_mem.cwith cppcheck:errortools/testing/selftests/x86/lam.c:585:3:
error: Resource leak:file_fd[resourceLeak]tools/testing/selftests/x86/lam.c:593:3:
error: Resource leak:file_fd[resourceLeak]tools/testing/selftests/x86/lam.c:600:3:
error: Memory leak: fi [memleak]tools/testing/selftests/x86/lam.c:1066:2:
error: Resource leak: fd [resourceLeak]
Quoted 8 lines
Quoted 3 lines
fix the issue by closing the file descriptors and
releasing the allocated memory.But but but, doesn't the program just exit on any of those 'errors' anyway?
That is, iirc this is a single shot program.
While that's true, still proper cleanup of resources is a good practice
- and in more complicated tools it's useful to fix even these semi-false-positives, to make sure other warnings don't get missed.
Having said that, the error/cleanup control flow here doesn't look overly clean here to begin with, so I'd suggest fixing that (with goto labels or such) - which would fix the file_fd 'leak' as a happy side effect.
Thanks,
Ingo
I appreciate all the feedback and recommendations provided. We will incorporate the same.
Thanks & Regards,
Malaya Kumar Rout
Quoted 36 lines · Ingo Molnar
Quoted 11 lines · Peter Zijlstra
Quoted 10 lines · Malaya Kumar Rout
Static Analyis for
bench_htab_mem.cwith cppcheck:errortools/testing/selftests/x86/lam.c:585:3:
error: Resource leak:file_fd[resourceLeak]tools/testing/selftests/x86/lam.c:593:3:
error: Resource leak:file_fd[resourceLeak]tools/testing/selftests/x86/lam.c:600:3:
error: Memory leak: fi [memleak]tools/testing/selftests/x86/lam.c:1066:2:
error: Resource leak: fd [resourceLeak]Quoted 8 lines
Quoted 3 lines
fix the issue by closing the file descriptors and
releasing the allocated memory.But but but, doesn't the program just exit on any of those 'errors' anyway?
That is, iirc this is a single shot program.
While that's true, still proper cleanup of resources is a good practice
- and in more complicated tools it's useful to fix even these semi-false-positives, to make sure other warnings don't get missed.Having said that, the error/cleanup control flow here doesn't look overly clean here to begin with, so I'd suggest fixing that (with goto labels or such) - which would fix the
file_fd'leak' as a happy side effect.Thanks,
Ingo
From 92c5ac2ffa37f6e4fe0cfa49a20857432bc67718 Mon Sep 17 00:00:00 2001
From: Malaya Kumar Rout <[email protected]>
Date: Tue, 25 Mar 2025 18:42:33 +0530
Subject: [PATCH v2] selftests/x86/lam: fix resource leak in do_uring() and allocate_dsa_pasid()
Exception branch returns without closing
the file descriptors 'file_fd' and 'fd'
--- tools/testing/selftests/x86/lam.c | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-)
tools/testing/selftests/x86/lam.c +9 -4
@@ -682,7 +682,7 @@ int do_uring(unsigned long lam)return 1 ;if (fstat (file_fd, &st) <0 ) -return 1 ; + goto cleanup;off_t file_sz = st.st_size;
@@ -690,7 +690,7 @@ int do_uring(unsigned long lam) fi =malloc (sizeof (*fi) +sizeof (struct iovec ) * blocks);if (!fi) -return 1 ; + goto cleanup; fi->file_sz = file_sz; fi->file_fd = file_fd;
@@ -698,7 +698,7 @@ int do_uring(unsigned long lam) ring =malloc (sizeof (*ring));if (!ring) {free (fi); -return 1 ; + goto cleanup; }memset (ring,0 ,sizeof (struct io_ring ));
@@ -730,6 +730,9 @@ int do_uring(unsigned long lam)free (fi); +cleanup: +close (file_fd); +return ret; }
@@ -1189,8 +1192,10 @@ void *allocate_dsa_pasid(void) wq =mmap (NULL ,0x1000 ,PROT_WRITE ,MAP_SHARED |MAP_POPULATE , fd,0 ); -if (wq ==MAP_FAILED ) +if (wq ==MAP_FAILED ) { +close (fd);perror ("mmap" ); + }return wq; }
Signature · 1 line
2.43.0
PATCH v2 1/1 selftests/x86/lam: fix resource leak in do_uring() and allocate_dsa_pasid()
In reply to malaya kumar routException branch returns without closing
the file descriptors 'file_fd' and 'fd'
:wq
--- tools/testing/selftests/x86/lam.c | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-)
tools/testing/selftests/x86/lam.c +8 -5
@@ -682,7 +682,7 @@ int do_uring(unsigned long lam)return 1 ;if (fstat (file_fd, &st) <0 ) -return 1 ; + goto cleanup;off_t file_sz = st.st_size;
@@ -690,7 +690,7 @@ int do_uring(unsigned long lam) fi =malloc (sizeof (*fi) +sizeof (struct iovec ) * blocks);if (!fi) -return 1 ; + goto cleanup; fi->file_sz = file_sz; fi->file_fd = file_fd;
@@ -698,7 +698,7 @@ int do_uring(unsigned long lam) ring =malloc (sizeof (*ring));if (!ring) {free (fi); -return 1 ; + goto cleanup; }memset (ring,0 ,sizeof (struct io_ring ));
@@ -729,6 +729,8 @@ int do_uring(unsigned long lam) }free (fi); +cleanup: +close (file_fd);return ret; }
@@ -1189,9 +1191,10 @@ void *allocate_dsa_pasid(void) wq =mmap (NULL ,0x1000 ,PROT_WRITE ,MAP_SHARED |MAP_POPULATE , fd,0 ); -if (wq ==MAP_FAILED ) +if (wq ==MAP_FAILED ){ +close (fd);perror ("mmap" ); - + }return wq; }
Signature · 1 line
2.43.0
Re: [PATCH v2] selftests/x86/lam: fix resource leak in do_uring() and allocate_dsa_pasid()
tools/testing/selftests/x86/lam.c void *allocate_dsa_pasid(void) · line 1196
Quoted 8 lines · Malaya Kumar Rout
tools/testing/selftests/x86/lam.c +2
-1@@ -1189,9 +1191,10 @@ void *allocate_dsa_pasid(void) wq =mmap (NULL ,0x1000 ,PROT_WRITE ,MAP_SHARED |MAP_POPULATE , fd,0 ); -if (wq ==MAP_FAILED ) +if (wq ==MAP_FAILED ){ +close (fd);perror ("mmap" );
We should unconditionally close 'fd' after the mmap() call, not just in the perror() branch.
Thanks,
Ingo
PATCH v3 1/1 selftests/x86/lam: fix resource leak in do_uring() and allocate_dsa_pasid()
Exception branch returns without closing
the file descriptors 'file_fd' and 'fd'
--- tools/testing/selftests/x86/lam.c | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-)
tools/testing/selftests/x86/lam.c +6 -3
@@ -682,7 +682,7 @@ int do_uring(unsigned long lam)return 1 ;if (fstat (file_fd, &st) <0 ) -return 1 ; + goto cleanup;off_t file_sz = st.st_size;
@@ -690,7 +690,7 @@ int do_uring(unsigned long lam) fi =malloc (sizeof (*fi) +sizeof (struct iovec ) * blocks);if (!fi) -return 1 ; + goto cleanup; fi->file_sz = file_sz; fi->file_fd = file_fd;
@@ -698,7 +698,7 @@ int do_uring(unsigned long lam) ring =malloc (sizeof (*ring));if (!ring) {free (fi); -return 1 ; + goto cleanup; }memset (ring,0 ,sizeof (struct io_ring ));
@@ -729,6 +729,8 @@ int do_uring(unsigned long lam) }free (fi); +cleanup: +close (file_fd);return ret; }
@@ -1192,6 +1194,7 @@ void *allocate_dsa_pasid(void)if (wq ==MAP_FAILED )perror ("mmap" ); +close (fd);return wq; }
Signature · 1 line
2.43.0
Re: [PATCH v3] selftests/x86/lam: fix resource leak in do_uring() and allocate_dsa_pasid()
Quoted 49 lines · Malaya Kumar Rout
Exception branch returns without closing
the file descriptors 'file_fd' and 'fd'Signed-off-by Malaya Kumar Rout <[email protected]>--- tools/testing/selftests/x86/lam.c | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-)tools/testing/selftests/x86/lam.c +5
-3@@ -682,7 +682,7 @@ int do_uring(unsigned long lam)return 1 ;if (fstat (file_fd, &st) <0 ) -return 1 ; + goto cleanup;off_t file_sz = st.st_size;@@ -690,7 +690,7 @@ int do_uring(unsigned long lam) fi =malloc (sizeof (*fi) +sizeof (struct iovec ) * blocks);if (!fi) -return 1 ; + goto cleanup; fi->file_sz = file_sz; fi->file_fd = file_fd;@@ -698,7 +698,7 @@ int do_uring(unsigned long lam) ring =malloc (sizeof (*ring));if (!ring) {free (fi); -return 1 ; + goto cleanup; }memset (ring,0 ,sizeof (struct io_ring ));@@ -729,6 +729,8 @@ int do_uring(unsigned long lam) }free (fi); +cleanup: +close (file_fd);return ret; }
tools/testing/selftests/x86/lam.c void *allocate_dsa_pasid(void) · line 1198
Quoted 5 lines
tools/testing/selftests/x86/lam.c +1
-0@@ -1192,6 +1194,7 @@ void *allocate_dsa_pasid(void)if (wq ==MAP_FAILED )perror ("mmap" ); +close (fd);return wq;
So in your previous patch you closed the file before the perror(), presumably so that file-leak detection in Valgrind or whatever tool you are using doesn't trigger.
But here it's done after the perror() call, why? It's perfectly fine to close the mapping fd straight after an mmap() call.
Finally, it would be nice to quote the before/after output of the leak detection tool you are using.
Thanks,
Ingo
RE:[PATCH RESEND x86-next v4] selftests/x86/lam: fix resource leak in do_uring() and allocate_dsa_pasid()
Exception branch returns without closing
the file descriptors 'file_fd' and 'fd'
--- tools/testing/selftests/x86/lam.c | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-)
tools/testing/selftests/x86/lam.c +6 -3
@@ -682,7 +682,7 @@ int do_uring(unsigned long lam)return 1 ;if (fstat (file_fd, &st) <0 ) -return 1 ; + goto cleanup;off_t file_sz = st.st_size;
@@ -690,7 +690,7 @@ int do_uring(unsigned long lam) fi =malloc (sizeof (*fi) +sizeof (struct iovec ) * blocks);if (!fi) -return 1 ; + goto cleanup; fi->file_sz = file_sz; fi->file_fd = file_fd;
@@ -698,7 +698,7 @@ int do_uring(unsigned long lam) ring =malloc (sizeof (*ring));if (!ring) {free (fi); -return 1 ; + goto cleanup; }memset (ring,0 ,sizeof (struct io_ring ));
@@ -729,6 +729,8 @@ int do_uring(unsigned long lam) }free (fi); +cleanup: +close (file_fd);return ret; }
@@ -1189,6 +1191,7 @@ void *allocate_dsa_pasid(void) wq =mmap (NULL ,0x1000 ,PROT_WRITE ,MAP_SHARED |MAP_POPULATE , fd,0 ); +close (fd);if (wq ==MAP_FAILED )perror ("mmap" );
Signature · 1 line
2.43.0
Re: [PATCH RESEND x86-next v4] selftests/x86/lam: fix resource leak in do_uring() and allocate_dsa_pasid()
Quoted 7 lines · Malaya Kumar Rout
Exception branch returns without closing
the file descriptors 'file_fd' and 'fd'Signed-off-by Malaya Kumar Rout <[email protected]>--- tools/testing/selftests/x86/lam.c | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-)
Why have you ignored this request I made:
Quoted 2 lines
Quoted 2 lines
Finally, it would be nice to quote the before/after output of the leak detection tool you are using.
?
Thanks,
Ingo
PATCH v4 1/1 selftests/x86/lam: fix resource leak in do_uring() and allocate_dsa_pasid()
This patch resolves resource leaks reported by cppcheck in lam.c. Specifically, the 'file_fd' and 'fd' were not closed in do_uring() and allocate_dsa_pasid() functions, respectively.
cppcheck output before this patch:tools/testing/selftests/x86/lam.c:685:3: error: Resource leak: file_fd [resourceLeak] tools/testing/selftests/x86/lam.c:693:3: error: Resource leak: file_fd [resourceLeak] tools/testing/selftests/x86/lam.c:1195:2: error: Resource leak: fd [resourceLeak]
cppcheck output after this patch:
No resource leaks found
--- tools/testing/selftests/x86/lam.c | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-)
tools/testing/selftests/x86/lam.c +6 -3
@@ -682,7 +682,7 @@ int do_uring(unsigned long lam)return 1 ;if (fstat (file_fd, &st) <0 ) -return 1 ; + goto cleanup;off_t file_sz = st.st_size;
@@ -690,7 +690,7 @@ int do_uring(unsigned long lam) fi =malloc (sizeof (*fi) +sizeof (struct iovec ) * blocks);if (!fi) -return 1 ; + goto cleanup; fi->file_sz = file_sz; fi->file_fd = file_fd;
@@ -698,7 +698,7 @@ int do_uring(unsigned long lam) ring =malloc (sizeof (*ring));if (!ring) {free (fi); -return 1 ; + goto cleanup; }memset (ring,0 ,sizeof (struct io_ring ));
@@ -729,6 +729,8 @@ int do_uring(unsigned long lam) }free (fi); +cleanup: +close (file_fd);return ret; }
@@ -1189,6 +1191,7 @@ void *allocate_dsa_pasid(void) wq =mmap (NULL ,0x1000 ,PROT_WRITE ,MAP_SHARED |MAP_POPULATE , fd,0 ); +close (fd);if (wq ==MAP_FAILED )perror ("mmap" );
Signature · 1 line
2.43.0
[tip: x86/mm] selftests/x86/lam: Fix clean up fds in do_uring() and allocate_dsa_pasid()
The following commit has been merged into the x86/mm branch of tip:
The following commit has been merged into the x86/mm branch of tip:
Commit-ID: 60567e93c05d7064c93830cf4bf0d2c58f11b2f2 Gitweb: https://git.kernel.org/tip/60567e93c05d7064c93830cf4bf0d2c58f11b2f2 Author: Malaya Kumar Rout <[email protected]> AuthorDate: Wed, 09 Apr 2025 19:23:37 +05:30 Committer: Ingo Molnar <[email protected]> CommitterDate: Wed, 09 Apr 2025 21:30:37 +02:00
selftests/x86/lam: Fix clean up fds in do_uring() and allocate_dsa_pasid()
Resolve minor fd leaks reported by cppcheck in lam.c.
Specifically, the 'file_fd' and 'fd' were not closed in do_uring() and allocate_dsa_pasid() functions, respectively.
cppcheck output before this patch:
tools/testing/selftests/x86/lam.c:685:3: error: Resource leak: file_fd [resourceLeak] tools/testing/selftests/x86/lam.c:693:3: error: Resource leak: file_fd [resourceLeak] tools/testing/selftests/x86/lam.c:1195:2: error: Resource leak: fd [resourceLeak]
cppcheck output after this patch:
No resource leaks found
While this is a standalone test tool that doesn't really leak anything in practice, as exit() cleans it up all, clean up resources nevertheless.
[ mingo: Updated the changelog. ]
--- tools/testing/selftests/x86/lam.c | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-)
tools/testing/selftests/x86/lam.c +6 -3
@@ -682,7 +682,7 @@ int do_uring(unsigned long lam)return 1 ;if (fstat (file_fd, &st) <0 ) -return 1 ; + goto cleanup;off_t file_sz = st.st_size;
@@ -690,7 +690,7 @@ int do_uring(unsigned long lam) fi =malloc (sizeof (*fi) +sizeof (struct iovec ) * blocks);if (!fi) -return 1 ; + goto cleanup; fi->file_sz = file_sz; fi->file_fd = file_fd;
@@ -698,7 +698,7 @@ int do_uring(unsigned long lam) ring =malloc (sizeof (*ring));if (!ring) {free (fi); -return 1 ; + goto cleanup; }memset (ring,0 ,sizeof (struct io_ring ));
@@ -729,6 +729,8 @@ out: }free (fi); +cleanup: +close (file_fd);return ret; }
@@ -1189,6 +1191,7 @@ void *allocate_dsa_pasid(void) wq =mmap (NULL ,0x1000 ,PROT_WRITE ,MAP_SHARED |MAP_POPULATE , fd,0 ); +close (fd);if (wq ==MAP_FAILED )perror ("mmap" );