llvm-project/lldb/source/Core/StreamFile.cpp

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

54 lines
1.7 KiB
C++
Raw Normal View History

//===-- StreamFile.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 "lldb/Core/StreamFile.h"
#include "lldb/Host/FileSystem.h"
#include "lldb/Utility/Log.h"
#include <stdio.h>
using namespace lldb;
using namespace lldb_private;
StreamFile::StreamFile(uint32_t flags, uint32_t addr_size, ByteOrder byte_order)
: Stream(flags, addr_size, byte_order) {
m_file_sp = std::make_shared<File>();
}
StreamFile::StreamFile(int fd, bool transfer_ownership) : Stream() {
m_file_sp =
std::make_shared<NativeFile>(fd, File::eOpenOptionWrite, transfer_ownership);
}
StreamFile::StreamFile(FILE *fh, bool transfer_ownership) : Stream() {
m_file_sp = std::make_shared<NativeFile>(fh, transfer_ownership);
}
StreamFile::StreamFile(const char *path, File::OpenOptions options,
uint32_t permissions)
: Stream() {
auto file = FileSystem::Instance().Open(FileSpec(path), options, permissions);
if (file)
m_file_sp = std::move(file.get());
else {
// TODO refactor this so the error gets popagated up instead of logged here.
LLDB_LOG_ERROR(GetLogIfAllCategoriesSet(LIBLLDB_LOG_HOST), file.takeError(),
"Cannot open {1}: {0}", path);
m_file_sp = std::make_shared<File>();
}
}
StreamFile::~StreamFile() {}
void StreamFile::Flush() { m_file_sp->Flush(); }
Add byte counting mechanism to LLDB's Stream class. Summary: This patch allows LLDB's Stream class to count the bytes it has written to so far. There are two major motivations for this patch: The first one is that this will allow us to get rid of all the handwritten byte counting code we have in LLDB so far. Examples for this are pretty much all functions in LLDB that take a Stream to write to and return a size_t, which usually represents the bytes written. By moving to this centralized byte counting mechanism, we hopefully can avoid some tricky errors that happen when some code forgets to count the written bytes while writing something to a stream. The second motivation is that this is needed for the migration away from LLDB's `Stream` and towards LLVM's `raw_ostream`. My current plan is to start offering a fake raw_ostream class that just forwards to a LLDB Stream. However, for this raw_ostream wrapper we need to fulfill the raw_ostream interface with LLDB's Stream, which currently lacks the ability to count the bytes written so far (which raw_ostream exposes by it's `tell()` method). By adding this functionality it is trivial to start rolling out our raw_ostream wrapper (and then eventually completely move to raw_ostream). Also, once this fake raw_ostream is available, we can start replacing our own code writing to LLDB's Stream by LLVM code writing to raw_ostream. The best example for this is the LEB128 encoding we currently ship, which can be replaced with by LLVM's version which accepts an raw_ostream. From the point of view of the pure source changes this test does, we essentially just renamed the Write implementation in Stream to `WriteImpl` while the `Write` method everyone is using to write its raw bytes is now just forwarding and counting the written bytes. Reviewers: labath, davide Reviewed By: labath Subscribers: JDevlieghere, lldb-commits Differential Revision: https://reviews.llvm.org/D50159 llvm-svn: 338733
2018-08-03 00:38:34 +08:00
size_t StreamFile::WriteImpl(const void *s, size_t length) {
m_file_sp->Write(s, length);
return length;
}