[Lldb-commits] [lldb] r219711 - Fixed stdio redirection within LLDB to "do the right thing" in all cases.
Greg Clayton
gclayton at apple.com
Tue Oct 14 13:18:06 PDT 2014
Author: gclayton
Date: Tue Oct 14 15:18:05 2014
New Revision: 219711
URL: http://llvm.org/viewvc/llvm-project?rev=219711&view=rev
Log:
Fixed stdio redirection within LLDB to "do the right thing" in all cases.
The main issue was if you didn't specify all three (stdin/out/err), you would get file actions added to the launch that would always use the pseudo terminal. This is now fixed.
Also fixed the test suite test that handles IO to test redirecting things individually and all together and in other combinations to make sure we don't regress.
<rdar://problem/18638226>
Modified:
lldb/trunk/source/Target/ProcessLaunchInfo.cpp
lldb/trunk/test/python_api/process/io/TestProcessIO.py
lldb/trunk/test/python_api/process/io/main.c
Modified: lldb/trunk/source/Target/ProcessLaunchInfo.cpp
URL: http://llvm.org/viewvc/llvm-project/lldb/trunk/source/Target/ProcessLaunchInfo.cpp?rev=219711&r1=219710&r2=219711&view=diff
==============================================================================
--- lldb/trunk/source/Target/ProcessLaunchInfo.cpp (original)
+++ lldb/trunk/source/Target/ProcessLaunchInfo.cpp Tue Oct 14 15:18:05 2014
@@ -267,7 +267,8 @@ ProcessLaunchInfo::FinalizeFileActions (
// If nothing for stdin or stdout or stderr was specified, then check the process for any default
// settings that were set with "settings set"
- if (GetFileActionForFD(STDIN_FILENO) == NULL || GetFileActionForFD(STDOUT_FILENO) == NULL ||
+ if (GetFileActionForFD(STDIN_FILENO) == NULL ||
+ GetFileActionForFD(STDOUT_FILENO) == NULL ||
GetFileActionForFD(STDERR_FILENO) == NULL)
{
if (log)
@@ -294,9 +295,14 @@ ProcessLaunchInfo::FinalizeFileActions (
FileSpec err_path;
if (target)
{
- in_path = target->GetStandardInputPath();
- out_path = target->GetStandardOutputPath();
- err_path = target->GetStandardErrorPath();
+ // Only override with the target settings if we don't already have
+ // an action for in, out or error
+ if (GetFileActionForFD(STDIN_FILENO) == NULL)
+ in_path = target->GetStandardInputPath();
+ if (GetFileActionForFD(STDOUT_FILENO) == NULL)
+ out_path = target->GetStandardOutputPath();
+ if (GetFileActionForFD(STDERR_FILENO) == NULL)
+ err_path = target->GetStandardErrorPath();
}
if (log)
@@ -344,17 +350,23 @@ ProcessLaunchInfo::FinalizeFileActions (
{
const char *slave_path = m_pty->GetSlaveName(NULL, 0);
- if (!in_path)
+ // Only use the slave tty if we don't have anything specified for
+ // input and don't have an action for stdin
+ if (!in_path && GetFileActionForFD(STDIN_FILENO) == NULL)
{
AppendOpenFileAction(STDIN_FILENO, slave_path, true, false);
}
- if (!out_path)
+ // Only use the slave tty if we don't have anything specified for
+ // output and don't have an action for stdout
+ if (!out_path && GetFileActionForFD(STDOUT_FILENO) == NULL)
{
AppendOpenFileAction(STDOUT_FILENO, slave_path, false, true);
}
- if (!err_path)
+ // Only use the slave tty if we don't have anything specified for
+ // error and don't have an action for stderr
+ if (!err_path && GetFileActionForFD(STDERR_FILENO) == NULL)
{
AppendOpenFileAction(STDERR_FILENO, slave_path, false, true);
}
Modified: lldb/trunk/test/python_api/process/io/TestProcessIO.py
URL: http://llvm.org/viewvc/llvm-project/lldb/trunk/test/python_api/process/io/TestProcessIO.py?rev=219711&r1=219710&r2=219711&view=diff
==============================================================================
--- lldb/trunk/test/python_api/process/io/TestProcessIO.py (original)
+++ lldb/trunk/test/python_api/process/io/TestProcessIO.py Tue Oct 14 15:18:05 2014
@@ -4,6 +4,7 @@ import os, sys, time
import unittest2
import lldb
from lldbtest import *
+import lldbutil
class ProcessIOTestCase(TestBase):
@@ -12,56 +13,246 @@ class ProcessIOTestCase(TestBase):
@unittest2.skipUnless(sys.platform.startswith("darwin"), "requires Darwin")
@python_api_test
@dsym_test
- def test_put_stdin_with_dsym(self):
+ def test_stdin_by_api_with_dsym(self):
"""Exercise SBProcess.PutSTDIN()."""
self.buildDsym()
- self.put_stdin()
+ self.do_stdin_by_api()
@python_api_test
@dwarf_test
- def test_put_stdin_with_dwarf(self):
+ def test_stdin_by_api_with_dwarf(self):
"""Exercise SBProcess.PutSTDIN()."""
self.buildDwarf()
- self.put_stdin()
+ self.do_stdin_by_api()
+
+ @unittest2.skipUnless(sys.platform.startswith("darwin"), "requires Darwin")
+ @python_api_test
+ @dsym_test
+ def test_stdin_redirection_with_dsym(self):
+ """Exercise SBLaunchInfo::AddOpenFileAction() for STDIN without specifying STDOUT or STDERR."""
+ self.buildDsym()
+ self.do_stdin_redirection()
+
+ @python_api_test
+ @dwarf_test
+ def test_stdin_redirection_with_dwarf(self):
+ """Exercise SBLaunchInfo::AddOpenFileAction() for STDIN without specifying STDOUT or STDERR."""
+ self.buildDwarf()
+ self.do_stdin_redirection()
+
+ @unittest2.skipUnless(sys.platform.startswith("darwin"), "requires Darwin")
+ @python_api_test
+ @dsym_test
+ def test_stdout_redirection_with_dsym(self):
+ """Exercise SBLaunchInfo::AddOpenFileAction() for STDOUT without specifying STDIN or STDERR."""
+ self.buildDsym()
+ self.do_stdout_redirection()
+
+ @python_api_test
+ @dwarf_test
+ def test_stdout_redirection_with_dwarf(self):
+ """Exercise SBLaunchInfo::AddOpenFileAction() for STDOUT without specifying STDIN or STDERR."""
+ self.buildDwarf()
+ self.do_stdout_redirection()
+
+ @unittest2.skipUnless(sys.platform.startswith("darwin"), "requires Darwin")
+ @python_api_test
+ @dsym_test
+ def test_stderr_redirection_with_dsym(self):
+ """Exercise SBLaunchInfo::AddOpenFileAction() for STDERR without specifying STDIN or STDOUT."""
+ self.buildDsym()
+ self.do_stderr_redirection()
+
+ @python_api_test
+ @dwarf_test
+ def test_stderr_redirection_with_dwarf(self):
+ """Exercise SBLaunchInfo::AddOpenFileAction() for STDERR without specifying STDIN or STDOUT."""
+ self.buildDwarf()
+ self.do_stderr_redirection()
+
+ @unittest2.skipUnless(sys.platform.startswith("darwin"), "requires Darwin")
+ @python_api_test
+ @dsym_test
+ def test_stdout_stderr_redirection_with_dsym(self):
+ """Exercise SBLaunchInfo::AddOpenFileAction() for STDOUT and STDERR without redirecting STDIN."""
+ self.buildDsym()
+ self.do_stdout_stderr_redirection()
+
+ @python_api_test
+ @dwarf_test
+ def test_stdout_stderr_redirection_with_dwarf(self):
+ """Exercise SBLaunchInfo::AddOpenFileAction() for STDOUT and STDERR without redirecting STDIN."""
+ self.buildDwarf()
+ self.do_stdout_stderr_redirection()
def setUp(self):
# Call super's setUp().
TestBase.setUp(self)
# Get the full path to our executable to be debugged.
self.exe = os.path.join(os.getcwd(), "process_io")
-
- def put_stdin(self):
+ self.input_file = os.path.join(os.getcwd(), "input.txt")
+ self.output_file = os.path.join(os.getcwd(), "output.txt")
+ self.error_file = os.path.join(os.getcwd(), "error.txt")
+ self.lines = ["Line 1", "Line 2", "Line 3"]
+
+ def read_output_file_and_delete (self):
+ self.assertTrue(os.path.exists(self.output_file), "Make sure output.txt file exists")
+ f = open(self.output_file, 'r')
+ contents = f.read()
+ f.close()
+ os.unlink(self.output_file)
+ return contents
+
+ def read_error_file_and_delete(self):
+ self.assertTrue(os.path.exists(self.error_file), "Make sure error.txt file exists")
+ f = open(self.error_file, 'r')
+ contents = f.read()
+ f.close()
+ os.unlink(self.error_file)
+ return contents
+
+ def create_target(self):
+ '''Create the target and launch info that will be used by all tests'''
+ self.target = self.dbg.CreateTarget(self.exe)
+ self.launch_info = lldb.SBLaunchInfo([self.exe])
+ self.launch_info.SetWorkingDirectory(self.get_process_working_directory())
+
+ def redirect_stdin(self):
+ '''Redirect STDIN (file descriptor 0) to use our input.txt file
+
+ Make the input.txt file to use when redirecting STDIN, setup a cleanup action
+ to delete the input.txt at the end of the test in case exceptions are thrown,
+ and redirect STDIN in the launch info.'''
+ f = open(self.input_file, 'w')
+ for line in self.lines:
+ f.write(line + "\n")
+ f.close()
+ # This is the function to remove the custom formats in order to have a
+ # clean slate for the next test case.
+ def cleanup():
+ os.unlink(self.input_file)
+
+ # Execute the cleanup function during test case tear down.
+ self.addTearDownHook(cleanup)
+ self.launch_info.AddOpenFileAction(0, self.input_file, True, False);
+
+ def redirect_stdout(self):
+ '''Redirect STDOUT (file descriptor 1) to use our output.txt file'''
+ self.launch_info.AddOpenFileAction(1, self.output_file, False, True);
+
+ def redirect_stderr(self):
+ '''Redirect STDERR (file descriptor 2) to use our error.txt file'''
+ self.launch_info.AddOpenFileAction(2, self.error_file, False, True);
+
+ def do_stdin_redirection(self):
+ """Exercise SBLaunchInfo::AddOpenFileAction() for STDIN without specifying STDOUT or STDERR."""
+ self.create_target()
+ self.redirect_stdin()
+ self.run_process(False)
+ output = self.process.GetSTDOUT(1000)
+ self.check_process_output(output, output)
+
+ def do_stdout_redirection(self):
+ """Exercise SBLaunchInfo::AddOpenFileAction() for STDOUT without specifying STDIN or STDERR."""
+ self.create_target()
+ self.redirect_stdout()
+ self.run_process(True)
+ output = self.read_output_file_and_delete()
+ error = self.process.GetSTDOUT(1000)
+ self.check_process_output(output, error)
+
+ def do_stderr_redirection(self):
+ """Exercise SBLaunchInfo::AddOpenFileAction() for STDERR without specifying STDIN or STDOUT."""
+ self.create_target()
+ self.redirect_stderr()
+ self.run_process(True)
+ output = self.process.GetSTDOUT(1000)
+ error = self.read_error_file_and_delete()
+ self.check_process_output(output, error)
+
+ def do_stdout_stderr_redirection(self):
+ """Exercise SBLaunchInfo::AddOpenFileAction() for STDOUT and STDERR without redirecting STDIN."""
+ self.create_target()
+ self.redirect_stdout()
+ self.redirect_stderr()
+ self.run_process(True)
+ output = self.read_output_file_and_delete()
+ error = self.read_error_file_and_delete()
+ self.check_process_output(output, error)
+
+ def do_stdin_stdout_stderr_redirection(self):
+ """Exercise SBLaunchInfo::AddOpenFileAction() for STDIN, STDOUT and STDERR."""
+ # Make the input.txt file to use
+ self.create_target()
+ self.redirect_stdin()
+ self.redirect_stdout()
+ self.redirect_stderr()
+ self.run_process(True)
+ output = self.read_output_file_and_delete()
+ error = self.read_error_file_and_delete()
+ self.check_process_output(output, error)
+
+ def do_stdin_by_api(self):
"""Launch a process and use SBProcess.PutSTDIN() to write data to it."""
+ self.create_target()
+ self.run_process(True)
+ output = self.process.GetSTDOUT(1000)
+ self.check_process_output(output, output)
+
+ def run_process(self, put_stdin):
+ '''Run the process to completion and optionally put lines to STDIN via the API if "put_stdin" is True'''
+ # Set the breakpoints
+ self.breakpoint = self.target.BreakpointCreateBySourceRegex('Set breakpoint here', lldb.SBFileSpec("main.c"))
+ self.assertTrue(self.breakpoint.GetNumLocations() > 0, VALID_BREAKPOINT)
+
+ # Launch the process, and do not stop at the entry point.
+ error = lldb.SBError()
+ # This should launch the process and it should exit by the time we get back
+ # because we have synchronous mode enabled
+ self.process = self.target.Launch (self.launch_info, error)
- target = self.dbg.CreateTarget(self.exe)
+ self.assertTrue(error.Success(), "Make sure process launched successfully")
+ self.assertTrue(self.process, PROCESS_IS_VALID)
- # Perform synchronous interaction with the debugger.
- self.setAsync(True)
-
- process = target.LaunchSimple (None, None, self.get_process_working_directory())
if self.TraceOn():
print "process launched."
- self.assertTrue(process, PROCESS_IS_VALID)
+ # Frame #0 should be at our breakpoint.
+ threads = lldbutil.get_threads_stopped_at_breakpoint (self.process, self.breakpoint)
+
+ self.assertTrue(len(threads) == 1)
+ self.thread = threads[0]
+ self.frame = self.thread.frames[0]
+ self.assertTrue(self.frame, "Frame 0 is valid.")
+
+ if self.TraceOn():
+ print "process stopped at breakpoint, sending STDIN via LLDB API."
- process.PutSTDIN("Line 1 Entered.\n")
- process.PutSTDIN("Line 2 Entered.\n")
- process.PutSTDIN("Line 3 Entered.\n")
-
- for i in range(5):
- output = process.GetSTDOUT(500)
- error = process.GetSTDERR(500)
- if self.TraceOn():
- print "output->|%s|" % output
+ # Write data to stdin via the public API if we were asked to
+ if put_stdin:
+ for line in self.lines:
+ self.process.PutSTDIN(line + "\n")
+
+ # Let process continue so it will exit
+ self.process.Continue()
+ state = self.process.GetState()
+ self.assertTrue(state == lldb.eStateExited, PROCESS_IS_VALID)
+
+ def check_process_output (self, output, error):
# Since we launched the process without specifying stdin/out/err,
# a pseudo terminal is used for stdout/err, and we are satisfied
# once "input line=>1" appears in stdout.
# See also main.c.
- if "input line=>1" in output:
- return
- time.sleep(5)
-
- self.fail("Expected output form launched process did not appear?")
+ if self.TraceOn():
+ print "output = '%s'" % output
+ print "error = '%s'" % error
+
+ for line in self.lines:
+ check_line = 'input line to stdout: %s' % (line)
+ self.assertTrue(check_line in output, "verify stdout line shows up in STDOUT")
+ for line in self.lines:
+ check_line = 'input line to stderr: %s' % (line)
+ self.assertTrue(check_line in error, "verify stderr line shows up in STDERR")
if __name__ == '__main__':
import atexit
Modified: lldb/trunk/test/python_api/process/io/main.c
URL: http://llvm.org/viewvc/llvm-project/lldb/trunk/test/python_api/process/io/main.c?rev=219711&r1=219710&r2=219711&view=diff
==============================================================================
--- lldb/trunk/test/python_api/process/io/main.c (original)
+++ lldb/trunk/test/python_api/process/io/main.c Tue Oct 14 15:18:05 2014
@@ -1,14 +1,19 @@
#include <stdio.h>
int main(int argc, char const *argv[]) {
- printf("Hello world.\n");
+ printf("Hello world.\n"); // Set breakpoint here
char line[100];
- int count = 1;
- while (fgets(line, sizeof(line), stdin)) { // Reading from stdin...
- fprintf(stderr, "input line=>%d\n", count++);
- if (count > 3)
- break;
+ if (fgets(line, sizeof(line), stdin)) {
+ fprintf(stdout, "input line to stdout: %s", line);
+ fprintf(stderr, "input line to stderr: %s", line);
+ }
+ if (fgets(line, sizeof(line), stdin)) {
+ fprintf(stdout, "input line to stdout: %s", line);
+ fprintf(stderr, "input line to stderr: %s", line);
+ }
+ if (fgets(line, sizeof(line), stdin)) {
+ fprintf(stdout, "input line to stdout: %s", line);
+ fprintf(stderr, "input line to stderr: %s", line);
}
-
printf("Exiting now\n");
}
More information about the lldb-commits
mailing list