[lldb] fix fd leak during lldb testsuite

[dlav-sc]

During lldb testing dotest.py opens files to dump testcase results, but doesn't close them.

This patch makes neccessary changes to fix the file descriptors leak.

[llvmbot]

@llvm/pr-subscribers-lldb

Author: None (dlav-sc)

Changes

During lldb testing dotest.py opens files to dump testcase results, but doesn't close them.

This patch makes neccessary changes to fix the file descriptors leak.

---

Full diff: https://github.com/llvm/llvm-project/pull/118093.diff

1 Files Affected:

• (modified) lldb/packages/Python/lldbsuite/test/lldbtest.py (+10-9)

diff --git a/lldb/packages/Python/lldbsuite/test/lldbtest.py b/lldb/packages/Python/lldbsuite/test/lldbtest.py
index 8884ef5933ada8..1338d16a9171e2 100644
--- a/lldb/packages/Python/lldbsuite/test/lldbtest.py
+++ b/lldb/packages/Python/lldbsuite/test/lldbtest.py
@@ -865,13 +865,9 @@ def setUp(self):
         session_file = self.getLogBasenameForCurrentTest() + ".log"
         self.log_files.append(session_file)
 
-        # Python 3 doesn't support unbuffered I/O in text mode.  Open buffered.
-        self.session = encoded_file.open(session_file, "utf-8", mode="w")
-
         # Optimistically set __errored__, __failed__, __expected__ to False
         # initially.  If the test errored/failed, the session info
-        # (self.session) is then dumped into a session specific file for
-        # diagnosis.
+        # is then dumped into a session specific file for diagnosis.
         self.__cleanup_errored__ = False
         self.__errored__ = False
         self.__failed__ = False
@@ -1235,20 +1231,25 @@ def dumpSessionInfo(self):
         else:
             prefix = "Success"
 
+        session_file = self.getLogBasenameForCurrentTest() + ".log"
+
+        # Python 3 doesn't support unbuffered I/O in text mode.  Open buffered.
+        session = encoded_file.open(session_file, "utf-8", mode="w")
+
         if not self.__unexpected__ and not self.__skipped__:
             for test, traceback in pairs:
                 if test is self:
-                    print(traceback, file=self.session)
+                    print(traceback, file=session)
 
         import datetime
 
         print(
             "Session info generated @",
             datetime.datetime.now().ctime(),
-            file=self.session,
+            file=session,
         )
-        self.session.close()
-        del self.session
+        session.close()
+        del session
 
         # process the log files
         if prefix != "Success" or lldbtest_config.log_success:

[DavidSpickett]

It leaks the fds if dumpSessionInfo is never called, do I understand correctly? If so please add that information to the PR description.

[dlav-sc]

It leaks the fds if dumpSessionInfo is never called

Yeah, dumpSessionInfo closes the session log file, but looks like dumpSessionInfo isn't called anywhere. Honestly, I don't understand the necessity of the function in that case, maybe we can remove it.

[DavidSpickett]

Happy for it to be fixed here and removed in another PR if it's unused.

Saves us resurrecting a broken function if we do want it back in future.

[JDevlieghere]

I'm fine either way. I probably wouldn't bother fixing it before removing it, but since you already have the PR, you might as well merge it to cover the situation David is describing.