[lldb/Interpreter] Add setting to set session transcript save directory

[mib]

Summary

This patch introduces a new interpreter setting
interpreter.save-session-directory so the user can specify a directory
where the session transcripts will be saved.

If not set, the session transcript are saved on a temporary file.

rdar://72902842

Signed-off-by: Med Ismail Bennani <[e-mail]>

[JDevlieghere]

lldb/source/Interpreter/InterpreterProperties.td

18

Given that session save already takes a file, I think it would make sense to call out here that this is particularly useful in combination with save-session-on-quit.

[mib]

lldb/source/Interpreter/InterpreterProperties.td

18

Just to clarify, session save can be used with no arguments, in which case, the transcript will either be saved to a temporary folder or at the location set in this property.

But I can definitely mention that it is very useful with save-session-on-quit.

[mib]

Address @JDevlieghere comment

[JDevlieghere]

LGTM

lldb/source/Interpreter/InterpreterProperties.td

18

Sure, I just want to make it explicit that we're not just adding a second way to do the same thing (but that it's actually covering a use case we can't support today).

18

[vsk]

I love the save-session feature. Just checking, has it already been release-noted on llvm.org (and for that matter Xcode)?

[mib]

Rephrase setting description

[mib]

In D105030#2844708, @vsk wrote:

I love the save-session feature. Just checking, has it already been release-noted on llvm.org (and for that matter Xcode)?

Glad you like it @vsk ! I don't think it was on the release note (at lease for Xcode) ... may be it would be good to mention it 😊

lldb/include/lldb/Interpreter/CommandInterpreter.h

 //===-- CommandInterpreter.h ------------------------------------*- C++ -*-===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.
 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 //
 //===----------------------------------------------------------------------===//
 
 #ifndef LLDB_INTERPRETER_COMMANDINTERPRETER_H
 #define LLDB_INTERPRETER_COMMANDINTERPRETER_H
 
 #include "lldb/Core/Debugger.h"
 #include "lldb/Core/IOHandler.h"
 #include "lldb/Interpreter/CommandAlias.h"
 #include "lldb/Interpreter/CommandHistory.h"
 #include "lldb/Interpreter/CommandObject.h"
 #include "lldb/Interpreter/ScriptInterpreter.h"
 #include "lldb/Utility/Args.h"
 #include "lldb/Utility/Broadcaster.h"
 #include "lldb/Utility/CompletionRequest.h"
public:
   bool GetExpandRegexAliases() const;
 
   bool GetPromptOnQuit() const;
   void SetPromptOnQuit(bool enable);
 
   bool GetSaveSessionOnQuit() const;
   void SetSaveSessionOnQuit(bool enable);
 
+  FileSpec GetSaveSessionDirectory() const;
+  void SetSaveSessionDirectory(llvm::StringRef path);
+
   bool GetEchoCommands() const;
   void SetEchoCommands(bool enable);
 
   bool GetEchoCommentCommands() const;
   void SetEchoCommentCommands(bool enable);
 
   bool GetRepeatPreviousCommand() const;
 

lldb/source/Interpreter/CommandInterpreter.cpp

 //===-- CommandInterpreter.cpp --------------------------------------------===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.
 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 //
 //===----------------------------------------------------------------------===//
 
 #include <cstdlib>
 #include <limits>
 #include <memory>
 #include <string>
 #include <vector>
 
 #include "Commands/CommandObjectApropos.h"
 #include "Commands/CommandObjectBreakpoint.h"
 #include "Commands/CommandObjectCommands.h"
 #include "Commands/CommandObjectDisassemble.h"
 #include "Commands/CommandObjectExpression.h"
 #include "Commands/CommandObjectFrame.h"
 #include "Commands/CommandObjectGUI.h"
 #include "Commands/CommandObjectHelp.h"
 #include "Commands/CommandObjectLanguage.h"
return m_collection_sp->GetPropertyAtIndexAsBoolean(
       nullptr, idx, g_interpreter_properties[idx].default_uint_value != 0);
 }
 
 void CommandInterpreter::SetSaveSessionOnQuit(bool enable) {
   const uint32_t idx = ePropertySaveSessionOnQuit;
   m_collection_sp->SetPropertyAtIndexAsBoolean(nullptr, idx, enable);
 }
 
+FileSpec CommandInterpreter::GetSaveSessionDirectory() const {
+  const uint32_t idx = ePropertySaveSessionDirectory;
+  return m_collection_sp->GetPropertyAtIndexAsFileSpec(nullptr, idx);
+}
+
+void CommandInterpreter::SetSaveSessionDirectory(llvm::StringRef path) {
+  const uint32_t idx = ePropertySaveSessionDirectory;
+  m_collection_sp->SetPropertyAtIndexAsString(nullptr, idx, path);
+}
+
 bool CommandInterpreter::GetEchoCommands() const {
   const uint32_t idx = ePropertyEchoCommands;
   return m_collection_sp->GetPropertyAtIndexAsBoolean(
       nullptr, idx, g_interpreter_properties[idx].default_uint_value != 0);
 }
 
 void CommandInterpreter::SetEchoCommands(bool enable) {
   const uint32_t idx = ePropertyEchoCommands;

 }
 
 bool CommandInterpreter::SaveTranscript(
     CommandReturnObject &result, llvm::Optional<std::string> output_file) {
   if (output_file == llvm::None || output_file->empty()) {
     std::string now = llvm::to_string(std::chrono::system_clock::now());
     std::replace(now.begin(), now.end(), ' ', '_');
     const std::string file_name = "lldb_session_" + now + ".log";
-    FileSpec tmp = HostInfo::GetGlobalTempDir();
-    tmp.AppendPathComponent(file_name);
-    output_file = tmp.GetPath();
+
+    FileSpec save_location = GetSaveSessionDirectory();
+
+    if (!save_location)
+      save_location = HostInfo::GetGlobalTempDir();
+
+    FileSystem::Instance().Resolve(save_location);
+    save_location.AppendPathComponent(file_name);
+    output_file = save_location.GetPath();
   }
 
   auto error_out = [&](llvm::StringRef error_message, std::string description) {
     LLDB_LOG(GetLogIfAllCategoriesSet(LIBLLDB_LOG_COMMANDS), "{0} ({1}:{2})",
              error_message, output_file, description);
     result.AppendErrorWithFormatv(
         "Failed to save session's transcripts to {0}!", *output_file);
     return false;

lldb/source/Interpreter/InterpreterProperties.td

 include "../../include/lldb/Core/PropertiesBase.td"
 
 let Definition = "interpreter" in {
   def ExpandRegexAliases: Property<"expand-regex-aliases", "Boolean">,
     Global,
     DefaultFalse,
     Desc<"If true, regular expression alias commands will show the expanded command that will be executed. This can be used to debug new regular expression alias commands.">;
   def PromptOnQuit: Property<"prompt-on-quit", "Boolean">,
     Global,
     DefaultTrue,
     Desc<"If true, LLDB will prompt you before quitting if there are any live processes being debugged. If false, LLDB will quit without asking in any case.">;
   def SaveSessionOnQuit: Property<"save-session-on-quit", "Boolean">,
     Global,
     DefaultFalse,
     Desc<"If true, LLDB will save the session's transcripts before quitting.">;
+  def SaveSessionDirectory: Property<"save-session-directory", "FileSpec">,
+    DefaultStringValue<"">,
+    Desc<"A path where LLDB will save the session's transcripts.">;
   def StopCmdSourceOnError: Property<"stop-command-source-on-error", "Boolean">,
     Global,
     DefaultTrue,
     Desc<"If true, LLDB will stop running a 'command source' script upon encountering an error.">;
   def SpaceReplPrompts: Property<"space-repl-prompts", "Boolean">,
     Global,
     DefaultFalse,
     Desc<"If true, blank lines will be printed between between REPL submissions.">;

lldb/test/API/commands/session/save/TestSessionSave.py

 """
 Test the session save feature
 """
-
+import os
 import lldb
 from lldbsuite.test.decorators import *
 from lldbsuite.test.lldbtest import *
 from lldbsuite.test import lldbutil
 
 
 class SessionSaveTestCase(TestBase):
 
def test_session_save(self):
         raw += self.raw_transcript_builder(cmd, res)
 
         with open(output_file, "r") as file:
           content = file.read()
           # Exclude last line, since session won't record it's own output
           lines = raw.splitlines()[:-1]
           for line in lines:
             self.assertIn(line, content)
+
+        td = tempfile.TemporaryDirectory()
+        res = lldb.SBCommandReturnObject()
+        interpreter.HandleCommand('settings set interpreter.save-session-directory ' + td.name, res)
+        self.assertTrue(res.Succeeded())
+
+        res = lldb.SBCommandReturnObject()
+        interpreter.HandleCommand('session save', res)
+        self.assertTrue(res.Succeeded())
+        raw += self.raw_transcript_builder(cmd, res)
+
+        with open(os.path.join(td.name, os.listdir(td.name)[0]), "r") as file:
+          content = file.read()
+          # Exclude last line, since session won't record it's own output
+          lines = raw.splitlines()[:-1]
+          for line in lines:
+            self.assertIn(line, content)