diff --git a/lldb/packages/Python/lldbsuite/test/tools/lldb-vscode/lldbvscode_testcase.py b/lldb/packages/Python/lldbsuite/test/tools/lldb-vscode/lldbvscode_testcase.py --- a/lldb/packages/Python/lldbsuite/test/tools/lldb-vscode/lldbvscode_testcase.py +++ b/lldb/packages/Python/lldbsuite/test/tools/lldb-vscode/lldbvscode_testcase.py @@ -267,7 +267,7 @@ disableSTDIO=False, shellExpandArguments=False, trace=False, initCommands=None, preRunCommands=None, stopCommands=None, exitCommands=None,sourcePath= None, - debuggerRoot=None, launchCommands=None): + debuggerRoot=None, launchCommands=None, inheritEnvironment=False): '''Sending launch request to vscode ''' @@ -298,7 +298,8 @@ exitCommands=exitCommands, sourcePath=sourcePath, debuggerRoot=debuggerRoot, - launchCommands=launchCommands) + launchCommands=launchCommands, + inheritEnvironment=inheritEnvironment) if not (response and response['success']): self.assertTrue(response['success'], 'launch failed (%s)' % (response['message'])) @@ -308,7 +309,7 @@ disableSTDIO=False, shellExpandArguments=False, trace=False, initCommands=None, preRunCommands=None, stopCommands=None, exitCommands=None, - sourcePath=None, debuggerRoot=None): + sourcePath=None, debuggerRoot=None, inheritEnvironment=False): '''Build the default Makefile target, create the VSCode debug adaptor, and launch the process. ''' @@ -318,4 +319,4 @@ self.launch(program, args, cwd, env, stopOnEntry, disableASLR, disableSTDIO, shellExpandArguments, trace, initCommands, preRunCommands, stopCommands, exitCommands, - sourcePath, debuggerRoot) + sourcePath, debuggerRoot, inheritEnvironment=inheritEnvironment) diff --git a/lldb/packages/Python/lldbsuite/test/tools/lldb-vscode/vscode.py b/lldb/packages/Python/lldbsuite/test/tools/lldb-vscode/vscode.py --- a/lldb/packages/Python/lldbsuite/test/tools/lldb-vscode/vscode.py +++ b/lldb/packages/Python/lldbsuite/test/tools/lldb-vscode/vscode.py @@ -570,7 +570,7 @@ disableSTDIO=False, shellExpandArguments=False, trace=False, initCommands=None, preRunCommands=None, stopCommands=None, exitCommands=None, sourcePath=None, - debuggerRoot=None, launchCommands=None): + debuggerRoot=None, launchCommands=None, inheritEnvironment=False): args_dict = { 'program': program } @@ -605,6 +605,8 @@ args_dict['debuggerRoot'] = debuggerRoot if launchCommands: args_dict['launchCommands'] = launchCommands + if inheritEnvironment: + args_dict['inheritEnvironment'] = inheritEnvironment command_dict = { 'command': 'launch', 'type': 'request', @@ -912,7 +914,8 @@ initCommands=options.initCmds, preRunCommands=options.preRunCmds, stopCommands=options.stopCmds, - exitCommands=options.exitCmds) + exitCommands=options.exitCmds, + inheritEnvironment=options.inheritEnvironment) if response['success']: if options.sourceBreakpoints: diff --git a/lldb/test/API/tools/lldb-vscode/completions/main.cpp b/lldb/test/API/tools/lldb-vscode/completions/main.cpp --- a/lldb/test/API/tools/lldb-vscode/completions/main.cpp +++ b/lldb/test/API/tools/lldb-vscode/completions/main.cpp @@ -27,4 +27,4 @@ bar* bar2 = &bar1; foo foo1 = {3,&bar1, bar1, NULL}; return 0; // breakpoint 2 -} +} \ No newline at end of file diff --git a/lldb/test/API/tools/lldb-vscode/environmentVariables/Makefile b/lldb/test/API/tools/lldb-vscode/environmentVariables/Makefile new file mode 100644 --- /dev/null +++ b/lldb/test/API/tools/lldb-vscode/environmentVariables/Makefile @@ -0,0 +1,3 @@ +CXX_SOURCES := main.cpp + +include Makefile.rules diff --git a/lldb/test/API/tools/lldb-vscode/environmentVariables/TestVSCode_environmentVariables.py b/lldb/test/API/tools/lldb-vscode/environmentVariables/TestVSCode_environmentVariables.py new file mode 100644 --- /dev/null +++ b/lldb/test/API/tools/lldb-vscode/environmentVariables/TestVSCode_environmentVariables.py @@ -0,0 +1,51 @@ +""" +Test lldb-vscode environment variables +""" + + +import lldbvscode_testcase +import unittest2 +import vscode +from lldbsuite.test import lldbutil +from lldbsuite.test.decorators import * +from lldbsuite.test.lldbtest import * + +class TestVSCode_variables(lldbvscode_testcase.VSCodeTestCaseBase): + + mydir = TestBase.compute_mydir(__file__) + + def checkIfPathIsSame(self,lines, path_env_variable): + for line in lines: + if line.startswith('PATH='): + self.assertTrue(path_env_variable == line, "PATH environment variable not the same") + return + + @skipIfWindows + #@skipIfDarwin # Skip this test for now until we can figure out why things aren't working on build bots + def test_environment_variable(self): + """ + Tests the environment variables + """ + program = self.getBuildArtifact("a.out") + path_env_variable = 'PATH='+os.environ['PATH'] + self.build_and_launch(program, inheritEnvironment=True) + self.continue_to_exit() + output = self.get_stdout().encode('utf-8') + lines = output.splitlines() + self.checkIfPathIsSame(lines, path_env_variable) + + @skipIfWindows + #@skipIfDarwin + def test_environment_variable_priority(self): + """ + Tests the environment variables priority + """ + program = self.getBuildArtifact("a.out") + path_env_variable = 'PATH=./' + self.build_and_launch(program, inheritEnvironment=True, env=[path_env_variable]) + self.continue_to_exit() + output = self.get_stdout().encode('utf-8') + lines = output.splitlines() + self.checkIfPathIsSame(lines, path_env_variable) + + diff --git a/lldb/test/API/tools/lldb-vscode/environmentVariables/main.cpp b/lldb/test/API/tools/lldb-vscode/environmentVariables/main.cpp new file mode 100644 --- /dev/null +++ b/lldb/test/API/tools/lldb-vscode/environmentVariables/main.cpp @@ -0,0 +1,14 @@ +#include +#include +#include +#include + +extern char **environ; + +int main(int argc, char const *argv[], char const *envp[]) { + char** env_var_pointer = environ; + for (char* env_variable = *env_var_pointer; env_variable; env_variable=*++env_var_pointer) { + printf("%s\n", env_variable); + } + return 0; +} diff --git a/lldb/tools/lldb-vscode/lldb-vscode.cpp b/lldb/tools/lldb-vscode/lldb-vscode.cpp --- a/lldb/tools/lldb-vscode/lldb-vscode.cpp +++ b/lldb/tools/lldb-vscode/lldb-vscode.cpp @@ -49,6 +49,12 @@ #include "LLDBUtils.h" #include "VSCode.h" +# if defined(_WIN32) +extern __declspec(dllimport) char** environ; +# else +extern char** environ; +# endif + #if defined(_WIN32) #ifndef PATH_MAX #define PATH_MAX MAX_PATH @@ -1327,6 +1333,8 @@ auto launchCommands = GetStrings(arguments, "launchCommands"); g_vsc.stop_at_entry = GetBoolean(arguments, "stopOnEntry", false); const auto debuggerRoot = GetString(arguments, "debuggerRoot"); + bool launchWithDebuggerEnvironment = GetBoolean(arguments, "inheritEnvironment", false); + // This is a hack for loading DWARF in .o files on Mac where the .o files // in the debug map of the main executable have relative paths which require @@ -1369,6 +1377,22 @@ // Pass any environment variables along that the user specified. auto envs = GetStrings(arguments, "env"); + if (launchWithDebuggerEnvironment) { + const char *platform_name = g_vsc.target.GetPlatform().GetName(); + if (platform_name && strcmp(platform_name, "host") != 0) { + response["success"] = llvm::json::Value(false); + EmplaceSafeString(response, "message", + "Can't use inheritEnvironment on a remote process"); + g_vsc.SendJSON(llvm::json::Value(std::move(response))); + return; + } + std::vector vscode_env_variables; + for (int i = 0; environ[i]; ++i) { + vscode_env_variables.push_back(environ[i]); + } + envs.insert(std::end(envs), std::begin(vscode_env_variables), + std::end(vscode_env_variables)); + } if (!envs.empty()) g_vsc.launch_info.SetEnvironmentEntries(MakeArgv(envs).data(), true); diff --git a/lldb/tools/lldb-vscode/package.json b/lldb/tools/lldb-vscode/package.json --- a/lldb/tools/lldb-vscode/package.json +++ b/lldb/tools/lldb-vscode/package.json @@ -84,6 +84,11 @@ "description": "Additional environment variables.", "default": [] }, + "inheritEnvironment": { + "type": "boolean", + "description": "Inherit the debugger environment when launching a process. Only works for binaries launched directly by LLDB.", + "default": false + }, "stopOnEntry": { "type": "boolean", "description": "Automatically stop after launch.",