xref: /llvm-project/lldb/source/API/SBFile.cpp (revision b798f4bd50bbf0f5eb46804afad10629797c73aa)
180814287SRaphael Isemann //===-- SBFile.cpp --------------------------------------------------------===//
257504530SLawrence D'Anna //
357504530SLawrence D'Anna // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
457504530SLawrence D'Anna // See https://llvm.org/LICENSE.txt for license information.
557504530SLawrence D'Anna // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
657504530SLawrence D'Anna //
757504530SLawrence D'Anna //===----------------------------------------------------------------------===//
857504530SLawrence D'Anna 
957504530SLawrence D'Anna #include "lldb/API/SBFile.h"
1057504530SLawrence D'Anna #include "lldb/API/SBError.h"
1157504530SLawrence D'Anna #include "lldb/Host/File.h"
121755f5b1SJonas Devlieghere #include "lldb/Utility/Instrumentation.h"
1357504530SLawrence D'Anna 
1457504530SLawrence D'Anna using namespace lldb;
1557504530SLawrence D'Anna using namespace lldb_private;
1657504530SLawrence D'Anna 
17866b7a65SJonas Devlieghere SBFile::~SBFile() = default;
1857504530SLawrence D'Anna 
1921b8a8aeSLawrence D'Anna SBFile::SBFile(FileSP file_sp) : m_opaque_sp(file_sp) {
202757f93aSJonas Devlieghere   // We have no way to capture the incoming FileSP as the class isn't
212757f93aSJonas Devlieghere   // instrumented, so pretend that it's always null.
221755f5b1SJonas Devlieghere   LLDB_INSTRUMENT_VA(this, file_sp);
232757f93aSJonas Devlieghere }
242757f93aSJonas Devlieghere 
252757f93aSJonas Devlieghere SBFile::SBFile(const SBFile &rhs) : m_opaque_sp(rhs.m_opaque_sp) {
261755f5b1SJonas Devlieghere   LLDB_INSTRUMENT_VA(this, rhs);
272757f93aSJonas Devlieghere }
282757f93aSJonas Devlieghere 
292757f93aSJonas Devlieghere SBFile &SBFile ::operator=(const SBFile &rhs) {
301755f5b1SJonas Devlieghere   LLDB_INSTRUMENT_VA(this, rhs);
312757f93aSJonas Devlieghere 
322757f93aSJonas Devlieghere   if (this != &rhs)
332757f93aSJonas Devlieghere     m_opaque_sp = rhs.m_opaque_sp;
34d232abc3SJonas Devlieghere   return *this;
3521b8a8aeSLawrence D'Anna }
3696898eb6SLawrence D'Anna 
371755f5b1SJonas Devlieghere SBFile::SBFile() { LLDB_INSTRUMENT_VA(this); }
3857504530SLawrence D'Anna 
3957504530SLawrence D'Anna SBFile::SBFile(FILE *file, bool transfer_ownership) {
401755f5b1SJonas Devlieghere   LLDB_INSTRUMENT_VA(this, file, transfer_ownership);
412757f93aSJonas Devlieghere 
42f913fd6eSLawrence D'Anna   m_opaque_sp = std::make_shared<NativeFile>(file, transfer_ownership);
4357504530SLawrence D'Anna }
4457504530SLawrence D'Anna 
4557504530SLawrence D'Anna SBFile::SBFile(int fd, const char *mode, bool transfer_owndership) {
461755f5b1SJonas Devlieghere   LLDB_INSTRUMENT_VA(this, fd, mode, transfer_owndership);
472757f93aSJonas Devlieghere 
4857504530SLawrence D'Anna   auto options = File::GetOptionsFromMode(mode);
4962c9fe42SLawrence D'Anna   if (!options) {
5062c9fe42SLawrence D'Anna     llvm::consumeError(options.takeError());
5162c9fe42SLawrence D'Anna     return;
5262c9fe42SLawrence D'Anna   }
5362c9fe42SLawrence D'Anna   m_opaque_sp =
5462c9fe42SLawrence D'Anna       std::make_shared<NativeFile>(fd, options.get(), transfer_owndership);
5557504530SLawrence D'Anna }
5657504530SLawrence D'Anna 
5757504530SLawrence D'Anna SBError SBFile::Read(uint8_t *buf, size_t num_bytes, size_t *bytes_read) {
581755f5b1SJonas Devlieghere   LLDB_INSTRUMENT_VA(this, buf, num_bytes, bytes_read);
592757f93aSJonas Devlieghere 
6057504530SLawrence D'Anna   SBError error;
6157504530SLawrence D'Anna   if (!m_opaque_sp) {
620642cd76SAdrian Prantl     error = Status::FromErrorString("invalid SBFile");
6357504530SLawrence D'Anna     *bytes_read = 0;
6457504530SLawrence D'Anna   } else {
65*b798f4bdSAdrian Prantl     error.SetError(m_opaque_sp->Read(buf, num_bytes));
6657504530SLawrence D'Anna     *bytes_read = num_bytes;
6757504530SLawrence D'Anna   }
68d232abc3SJonas Devlieghere   return error;
6957504530SLawrence D'Anna }
7057504530SLawrence D'Anna 
7157504530SLawrence D'Anna SBError SBFile::Write(const uint8_t *buf, size_t num_bytes,
7257504530SLawrence D'Anna                       size_t *bytes_written) {
731755f5b1SJonas Devlieghere   LLDB_INSTRUMENT_VA(this, buf, num_bytes, bytes_written);
742757f93aSJonas Devlieghere 
7557504530SLawrence D'Anna   SBError error;
7657504530SLawrence D'Anna   if (!m_opaque_sp) {
770642cd76SAdrian Prantl     error = Status::FromErrorString("invalid SBFile");
7857504530SLawrence D'Anna     *bytes_written = 0;
7957504530SLawrence D'Anna   } else {
80*b798f4bdSAdrian Prantl     error.SetError(m_opaque_sp->Write(buf, num_bytes));
8157504530SLawrence D'Anna     *bytes_written = num_bytes;
8257504530SLawrence D'Anna   }
83d232abc3SJonas Devlieghere   return error;
8457504530SLawrence D'Anna }
8557504530SLawrence D'Anna 
8657504530SLawrence D'Anna SBError SBFile::Flush() {
871755f5b1SJonas Devlieghere   LLDB_INSTRUMENT_VA(this);
882757f93aSJonas Devlieghere 
8957504530SLawrence D'Anna   SBError error;
9057504530SLawrence D'Anna   if (!m_opaque_sp) {
910642cd76SAdrian Prantl     error = Status::FromErrorString("invalid SBFile");
9257504530SLawrence D'Anna   } else {
93*b798f4bdSAdrian Prantl     error.SetError(m_opaque_sp->Flush());
9457504530SLawrence D'Anna   }
95d232abc3SJonas Devlieghere   return error;
9657504530SLawrence D'Anna }
9757504530SLawrence D'Anna 
9857504530SLawrence D'Anna bool SBFile::IsValid() const {
991755f5b1SJonas Devlieghere   LLDB_INSTRUMENT_VA(this);
10057504530SLawrence D'Anna   return m_opaque_sp && m_opaque_sp->IsValid();
10157504530SLawrence D'Anna }
10257504530SLawrence D'Anna 
10357504530SLawrence D'Anna SBError SBFile::Close() {
1041755f5b1SJonas Devlieghere   LLDB_INSTRUMENT_VA(this);
10557504530SLawrence D'Anna   SBError error;
106*b798f4bdSAdrian Prantl   if (m_opaque_sp)
107*b798f4bdSAdrian Prantl     error.SetError(m_opaque_sp->Close());
108d232abc3SJonas Devlieghere   return error;
10957504530SLawrence D'Anna }
11057504530SLawrence D'Anna 
11157504530SLawrence D'Anna SBFile::operator bool() const {
1121755f5b1SJonas Devlieghere   LLDB_INSTRUMENT_VA(this);
1136ee96ddeSJonas Devlieghere   return IsValid();
11457504530SLawrence D'Anna }
11557504530SLawrence D'Anna 
11657504530SLawrence D'Anna bool SBFile::operator!() const {
1171755f5b1SJonas Devlieghere   LLDB_INSTRUMENT_VA(this);
1186ee96ddeSJonas Devlieghere   return !IsValid();
11957504530SLawrence D'Anna }
12057504530SLawrence D'Anna 
121d9b553ecSLawrence D'Anna FileSP SBFile::GetFile() const {
1221755f5b1SJonas Devlieghere   LLDB_INSTRUMENT_VA(this);
123d232abc3SJonas Devlieghere   return m_opaque_sp;
124d9b553ecSLawrence D'Anna }
125