diff --git a/lldb/include/lldb/API/LLDB.h b/lldb/include/lldb/API/LLDB.h --- a/lldb/include/lldb/API/LLDB.h +++ b/lldb/include/lldb/API/LLDB.h @@ -13,8 +13,8 @@ #include "lldb/API/SBAttachInfo.h" #include "lldb/API/SBBlock.h" #include "lldb/API/SBBreakpoint.h" -#include "lldb/API/SBBreakpointName.h" #include "lldb/API/SBBreakpointLocation.h" +#include "lldb/API/SBBreakpointName.h" #include "lldb/API/SBBroadcaster.h" #include "lldb/API/SBCommandInterpreter.h" #include "lldb/API/SBCommandReturnObject.h" @@ -28,6 +28,7 @@ #include "lldb/API/SBEvent.h" #include "lldb/API/SBExecutionContext.h" #include "lldb/API/SBExpressionOptions.h" +#include "lldb/API/SBFile.h" #include "lldb/API/SBFileSpec.h" #include "lldb/API/SBFileSpecList.h" #include "lldb/API/SBFrame.h" diff --git a/lldb/include/lldb/API/SBDefines.h b/lldb/include/lldb/API/SBDefines.h --- a/lldb/include/lldb/API/SBDefines.h +++ b/lldb/include/lldb/API/SBDefines.h @@ -92,6 +92,7 @@ class LLDB_API SBVariablesOptions; class LLDB_API SBWatchpoint; class LLDB_API SBUnixSignals; +class LLDB_API SBFile; typedef bool (*SBBreakpointHitCallback)(void *baton, SBProcess &process, SBThread &thread, diff --git a/lldb/include/lldb/API/SBError.h b/lldb/include/lldb/API/SBError.h --- a/lldb/include/lldb/API/SBError.h +++ b/lldb/include/lldb/API/SBError.h @@ -70,6 +70,7 @@ friend class SBTrace; friend class SBValue; friend class SBWatchpoint; + friend class SBFile; lldb_private::Status *get(); diff --git a/lldb/include/lldb/API/SBFile.h b/lldb/include/lldb/API/SBFile.h new file mode 100644 --- /dev/null +++ b/lldb/include/lldb/API/SBFile.h @@ -0,0 +1,38 @@ +//===-- SBFile.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_SBFile_h_ +#define LLDB_SBFile_h_ + +#include "lldb/API/SBDefines.h" + +namespace lldb { + +class LLDB_API SBFile { +public: + SBFile(); + SBFile(FILE *file, bool transfer_ownership); + SBFile(int fd, const char *mode, bool transfer_ownership); + ~SBFile(); + + SBError Read(uint8_t *buf, size_t num_bytes, size_t *bytes_read); + SBError Write(const uint8_t *buf, size_t num_bytes, size_t *bytes_written); + SBError Flush(); + bool IsValid() const; + SBError Close(); + + operator bool() const { return IsValid(); } + bool operator!() const { return !IsValid(); } + +private: + FileSP m_opaque_sp; +}; + +} // namespace lldb + +#endif // LLDB_SBFile_h_ diff --git a/lldb/include/lldb/Host/File.h b/lldb/include/lldb/Host/File.h --- a/lldb/include/lldb/Host/File.h +++ b/lldb/include/lldb/Host/File.h @@ -124,6 +124,8 @@ int GetDescriptor() const; + static uint32_t GetOptionsFromMode(llvm::StringRef mode); + WaitableHandle GetWaitableHandle() override; FILE *GetStream(); diff --git a/lldb/packages/Python/lldbsuite/test/python_api/file_handle/TestFileHandle.py b/lldb/packages/Python/lldbsuite/test/python_api/file_handle/TestFileHandle.py --- a/lldb/packages/Python/lldbsuite/test/python_api/file_handle/TestFileHandle.py +++ b/lldb/packages/Python/lldbsuite/test/python_api/file_handle/TestFileHandle.py @@ -0,0 +1,132 @@ +""" +Test lldb Python API for file handles. +""" + +from __future__ import print_function + +import contextlib +import os +import io +import re +import sys + +import lldb +from lldbsuite.test.decorators import * +from lldbsuite.test.lldbtest import * +from lldbsuite.test import lldbutil + + +def readStrippedLines(f): + def i(): + for line in f: + line = line.strip() + if line: + yield line + return list(i()) + +def handle_command(debugger, cmd, raise_on_fail=True, collect_result=True): + + ret = lldb.SBCommandReturnObject() + + if collect_result: + interpreter = debugger.GetCommandInterpreter() + interpreter.HandleCommand(cmd, ret) + else: + debugger.HandleCommand(cmd) + + if collect_result and raise_on_fail and not ret.Succeeded(): + raise Exception + + return ret.GetOutput() + + +class FileHandleTestCase(TestBase): + + mydir = TestBase.compute_mydir(__file__) + + @add_test_categories(['pyapi']) + @no_debug_info_test + def test_legacy_file_out(self): + debugger = lldb.SBDebugger.Create() + try: + with open('output', 'w') as f: + debugger.SetOutputFileHandle(f, False) + handle_command(debugger, 'script 1+1') + debugger.GetOutputFileHandle().write('FOO\n') + with open('output', 'r') as f: + self.assertEqual(readStrippedLines(f), ['2', 'FOO']) + finally: + self.RemoveTempFile('output') + lldb.SBDebugger.Destroy(debugger) + + + @add_test_categories(['pyapi']) + @no_debug_info_test + def test_legacy_file_err(self): + debugger = lldb.SBDebugger.Create() + try: + with open('output', 'w') as f: + debugger.SetErrorFileHandle(f, False) + handle_command(debugger, 'lol', raise_on_fail=False, collect_result=False) + lldb.SBDebugger.Destroy(debugger) + with open('output', 'r') as f: + self.assertTrue(re.search("is not a valid command", f.read())) + finally: + self.RemoveTempFile('output') + lldb.SBDebugger.Destroy(debugger) + + + @add_test_categories(['pyapi']) + @no_debug_info_test + def test_sbfile_invalid(self): + sbf = lldb.SBFile() + self.assertFalse(sbf.IsValid()) + e, n = sbf.Write(b'foo') + self.assertTrue(e.Fail()) + self.assertEqual(n, 0) + buffer = bytearray(100) + e, n = sbf.Read(buffer) + self.assertEqual(n, 0) + self.assertTrue(e.Fail()) + + + @add_test_categories(['pyapi']) + @no_debug_info_test + def test_sbfile_write(self): + try: + with open('output', 'w') as f: + sbf = lldb.SBFile(f.fileno(), "w", False) + self.assertTrue(sbf.IsValid()) + e, n = sbf.Write(b'FOO\nBAR') + self.assertTrue(e.Success()) + self.assertEqual(n, 7) + sbf.Close() + self.assertFalse(sbf.IsValid()) + + with open('output', 'r') as f: + self.assertEqual(readStrippedLines(f), ['FOO', 'BAR']) + finally: + self.RemoveTempFile('output') + + + @add_test_categories(['pyapi']) + @no_debug_info_test + def test_sbfile_read(self): + try: + with open('output', 'w') as f: + f.write('FOO') + with open('output', 'r') as f: + sbf = lldb.SBFile(f.fileno(), "r", False) + self.assertTrue(sbf.IsValid()) + buffer = bytearray(100) + e, n = sbf.Read(buffer) + self.assertTrue(e.Success()) + self.assertEqual(buffer[:n], b'FOO') + finally: + self.RemoveTempFile('output') + + + + + + diff --git a/lldb/scripts/interface/SBFile.i b/lldb/scripts/interface/SBFile.i new file mode 100644 --- /dev/null +++ b/lldb/scripts/interface/SBFile.i @@ -0,0 +1,41 @@ +//===-- SWIG Interface for SBFile -----------------------------------------===// +// +// 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 + +%pybuffer_binary(const uint8_t *buf, size_t num_bytes); +%pybuffer_mutable_binary(uint8_t *buf, size_t num_bytes); + +namespace lldb { + +%feature("docstring", +"Represents a file." +) SBFile; + +class SBFile +{ +public: + SBFile(); + SBFile(int fd, const char *mode, bool transfer_ownership); + + ~SBFile (); + + %feature("autodoc", "Read(buffer) -> SBError, bytes_read") Read; + SBError Read(uint8_t *buf, size_t num_bytes, size_t *OUTPUT); + + %feature("autodoc", "Write(buffer) -> SBError, written_read") Write; + SBError Write(const uint8_t *buf, size_t num_bytes, size_t *OUTPUT); + + void Flush(); + + bool IsValid() const; + + SBError Close(); +}; + +} // namespace lldb diff --git a/lldb/scripts/lldb.swig b/lldb/scripts/lldb.swig --- a/lldb/scripts/lldb.swig +++ b/lldb/scripts/lldb.swig @@ -123,6 +123,7 @@ #include "lldb/API/SBExecutionContext.h" #include "lldb/API/SBExpressionOptions.h" #include "lldb/API/SBFileSpec.h" +#include "lldb/API/SBFile.h" #include "lldb/API/SBFileSpecList.h" #include "lldb/API/SBFrame.h" #include "lldb/API/SBFunction.h" @@ -210,6 +211,7 @@ %include "./interface/SBExecutionContext.i" %include "./interface/SBExpressionOptions.i" %include "./interface/SBFileSpec.i" +%include "./interface/SBFile.i" %include "./interface/SBFileSpecList.i" %include "./interface/SBFrame.i" %include "./interface/SBFunction.i" diff --git a/lldb/source/API/CMakeLists.txt b/lldb/source/API/CMakeLists.txt --- a/lldb/source/API/CMakeLists.txt +++ b/lldb/source/API/CMakeLists.txt @@ -34,6 +34,7 @@ SBExecutionContext.cpp SBExpressionOptions.cpp SBFileSpec.cpp + SBFile.cpp SBFileSpecList.cpp SBFrame.cpp SBFunction.cpp diff --git a/lldb/source/API/SBFile.cpp b/lldb/source/API/SBFile.cpp new file mode 100644 --- /dev/null +++ b/lldb/source/API/SBFile.cpp @@ -0,0 +1,76 @@ +//===-- SBFile.cpp ------------------------------------------*- 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 +// +//===----------------------------------------------------------------------===// + +#include "lldb/API/SBFile.h" +#include "lldb/API/SBError.h" +#include "lldb/Host/File.h" + +using namespace lldb; +using namespace lldb_private; + +SBFile::~SBFile() {} + +SBFile::SBFile() {} + +SBFile::SBFile(FILE *file, bool transfer_ownership) { + m_opaque_sp = std::make_shared(file, transfer_ownership); +} + +SBFile::SBFile(int fd, const char *mode, bool transfer_owndership) { + auto options = File::GetOptionsFromMode(mode); + m_opaque_sp = std::make_shared(fd, options, transfer_owndership); +} + +SBError SBFile::Read(uint8_t *buf, size_t num_bytes, size_t *bytes_read) { + SBError error; + if (!m_opaque_sp) { + error.SetErrorString("invalid SBFile"); + *bytes_read = 0; + } else { + Status status = m_opaque_sp->Read(buf, num_bytes); + error.SetError(status); + *bytes_read = num_bytes; + } + return error; +} + +SBError SBFile::Write(const uint8_t *buf, size_t num_bytes, + size_t *bytes_written) { + SBError error; + if (!m_opaque_sp) { + error.SetErrorString("invalid SBFile"); + *bytes_written = 0; + } else { + Status status = m_opaque_sp->Write(buf, num_bytes); + error.SetError(status); + *bytes_written = num_bytes; + } + return error; +} + +SBError SBFile::Flush() { + SBError error; + if (!m_opaque_sp) { + error.SetErrorString("invalid SBFile"); + } else { + Status status = m_opaque_sp->Flush(); + error.SetError(status); + } + return error; +} + +bool SBFile::IsValid() const { return m_opaque_sp && m_opaque_sp->IsValid(); } + +SBError SBFile::Close() { + SBError error; + if (m_opaque_sp) { + Status status = m_opaque_sp->Close(); + error.SetError(status); + } + return error; +} diff --git a/lldb/source/Host/common/File.cpp b/lldb/source/Host/common/File.cpp --- a/lldb/source/Host/common/File.cpp +++ b/lldb/source/Host/common/File.cpp @@ -68,6 +68,22 @@ return nullptr; } +uint32_t File::GetOptionsFromMode(llvm::StringRef mode) { + if (mode.empty()) + return 0; + return llvm::StringSwitch(mode.str()) + .Case("r", File::eOpenOptionRead) + .Case("w", File::eOpenOptionWrite) + .Case("a", File::eOpenOptionWrite | File::eOpenOptionAppend | + File::eOpenOptionCanCreate) + .Case("r+", File::eOpenOptionRead | File::eOpenOptionWrite) + .Case("w+", File::eOpenOptionRead | File::eOpenOptionWrite | + File::eOpenOptionCanCreate | File::eOpenOptionTruncate) + .Case("a+", File::eOpenOptionRead | File::eOpenOptionWrite | + File::eOpenOptionAppend | File::eOpenOptionCanCreate) + .Default(0); +} + int File::kInvalidDescriptor = -1; FILE *File::kInvalidStream = nullptr; @@ -143,9 +159,14 @@ Status File::Close() { Status error; - if (StreamIsValid() && m_own_stream) { - if (::fclose(m_stream) == EOF) - error.SetErrorToErrno(); + if (StreamIsValid()) { + if (m_own_stream) { + if (::fclose(m_stream) == EOF) + error.SetErrorToErrno(); + } else { + if (::fflush(m_stream) == EOF) + error.SetErrorToErrno(); + } } if (DescriptorIsValid() && m_own_descriptor) { diff --git a/lldb/source/Plugins/ScriptInterpreter/Python/PythonDataObjects.h b/lldb/source/Plugins/ScriptInterpreter/Python/PythonDataObjects.h --- a/lldb/source/Plugins/ScriptInterpreter/Python/PythonDataObjects.h +++ b/lldb/source/Plugins/ScriptInterpreter/Python/PythonDataObjects.h @@ -466,8 +466,6 @@ void Reset(PyRefType type, PyObject *py_obj) override; void Reset(File &file, const char *mode); - static uint32_t GetOptionsFromMode(llvm::StringRef mode); - lldb::FileUP GetUnderlyingFile() const; }; diff --git a/lldb/source/Plugins/ScriptInterpreter/Python/PythonDataObjects.cpp b/lldb/source/Plugins/ScriptInterpreter/Python/PythonDataObjects.cpp --- a/lldb/source/Plugins/ScriptInterpreter/Python/PythonDataObjects.cpp +++ b/lldb/source/Plugins/ScriptInterpreter/Python/PythonDataObjects.cpp @@ -949,7 +949,6 @@ PythonFile::PythonFile(File &file, const char *mode) { Reset(file, mode); } - PythonFile::PythonFile(PyRefType type, PyObject *o) { Reset(type, o); } PythonFile::~PythonFile() {} @@ -1014,22 +1013,6 @@ #endif } -uint32_t PythonFile::GetOptionsFromMode(llvm::StringRef mode) { - if (mode.empty()) - return 0; - - return llvm::StringSwitch(mode.str()) - .Case("r", File::eOpenOptionRead) - .Case("w", File::eOpenOptionWrite) - .Case("a", File::eOpenOptionWrite | File::eOpenOptionAppend | - File::eOpenOptionCanCreate) - .Case("r+", File::eOpenOptionRead | File::eOpenOptionWrite) - .Case("w+", File::eOpenOptionRead | File::eOpenOptionWrite | - File::eOpenOptionCanCreate | File::eOpenOptionTruncate) - .Case("a+", File::eOpenOptionRead | File::eOpenOptionWrite | - File::eOpenOptionAppend | File::eOpenOptionCanCreate) - .Default(0); -} FileUP PythonFile::GetUnderlyingFile() const { if (!IsValid()) @@ -1038,7 +1021,7 @@ // We don't own the file descriptor returned by this function, make sure the // File object knows about that. PythonString py_mode = GetAttributeValue("mode").AsType(); - auto options = PythonFile::GetOptionsFromMode(py_mode.GetString()); + auto options = File::GetOptionsFromMode(py_mode.GetString()); auto file = std::make_unique(PyObject_AsFileDescriptor(m_py_obj), options, false); if (!file->IsValid())