saq::bartleby::Bartleby Class Reference

Bartleby handle. More...

#include <Bartleby.h>

Classes
class	ArchiveWriter
	Archive builder that implements our multi format config. More...

Public Types
using	SymbolMap = llvm::StringMap< Symbol >
	Symbol map type.

Public Member Functions
	Bartleby () noexcept
	Constructs an empty Bartleby handle.
	Bartleby (const Bartleby &) noexcept=delete
	Bartleby (Bartleby &&) noexcept=default
Bartleby &	operator= (const Bartleby &) noexcept=delete
Bartleby &	operator= (Bartleby &&) noexcept=default
llvm::Error	addBinary (llvm::object::OwningBinary< llvm::object::Binary > Binary) noexcept
	Adds a new binary to Bartleby.
const SymbolMap &	getSymbols () const noexcept
	Gets a const reference to the map of symbols.
size_t	prefixGlobalAndDefinedSymbols (llvm::StringRef Prefix) noexcept
	Applies a prefix to all global and defined symbols.

Static Public Member Functions
static llvm::Error	buildFinalArchive (Bartleby &&B, llvm::StringRef OutFilepath) noexcept
	Builds the final archive and writes its content to a file.
static llvm::Expected< std::unique_ptr< llvm::MemoryBuffer > >	buildFinalArchive (Bartleby &&B) noexcept
	Builds the final archive and returns its content.

Detailed Description

Bartleby handle.

Member Function Documentation

addBinary()

BARTLEBY_API llvm::Error Bartleby::addBinary ( llvm::object::OwningBinary< llvm::object::Binary >  Binary )

noexcept

Adds a new binary to Bartleby.

Parameters

[in]

Binary

Binary.

Returns

An error.

                                                                    {
  auto *Binary = OwningBinary.getBinary();
  llvm::Error E = llvm::Error::success();
 
  if (auto *Obj = llvm::dyn_cast<llvm::object::ObjectFile>(Binary)) {
    const auto Triple = Obj->makeTriple();
    if (!objectFormatMatches(Triple)) {
      return llvm::make_error<Error>(Error::ObjectFormatTypeMismatchReason{
          .Constraint = std::get<ObjectFormat>(ObjFormat), .Found = {Triple}});
    }
    ObjFormat = Triple;
    ProcessObjectFile(Obj, Symbols);
    auto &Entry = Objects.emplace_back(ObjectFile{.Handle = Obj});
    (llvm::Twine(llvm::utostr(Objects.size())) + ".o")
        .toNullTerminatedStringRef(Entry.Name);
  } else if (auto *Archive = llvm::dyn_cast<llvm::object::Archive>(Binary)) {
    llvm::Error E = llvm::Error::success();
    for (const auto &Ch : Archive->children(E)) {
      auto BinOrErr = Ch.getAsBinary();
      if (!BinOrErr) {
        return BinOrErr.takeError();
      }
      if (auto *Obj =
              llvm::dyn_cast<llvm::object::ObjectFile>(BinOrErr.get().get())) {
        const auto Triple = Obj->makeTriple();
        if (!objectFormatMatches(Triple)) {
          return llvm::make_error<Error>(Error::ObjectFormatTypeMismatchReason{
              .Constraint = std::get<ObjectFormat>(ObjFormat),
              .Found = {Triple}});
        }
        ObjFormat = Triple;
 
        ProcessObjectFile(Obj, Symbols);
        auto &Entry = Objects.emplace_back(ObjectFile{
            .Owner = std::move(BinOrErr.get()),
        });
        Entry.Handle = Obj;
        if (auto NameOrErr = Ch.getName()) {
          Entry.Name = *NameOrErr;
        } else {
          (llvm::Twine(llvm::utostr(Objects.size())) + ".o")
              .toNullTerminatedStringRef(Entry.Name);
        }
      } else {
        Error::UnsupportedBinaryReason Reason;
        llvm::raw_svector_ostream OS(Reason.Msg);
        OS << "unsupported binary '" << Binary->getType()
           << "' (triple: " << Binary->getTripleObjectFormat() << ')';
        return llvm::make_error<Error>(std::move(Reason));
      }
    }
  } else if (Binary->isMachOUniversalBinary()) {
    return addMachOUniversalBinary(std::move(OwningBinary));
  } else {
    Error::UnsupportedBinaryReason Reason;
    llvm::raw_svector_ostream OS(Reason.Msg);
    OS << "unsupported binary '" << Binary->getType()
       << "' (triple: " << Binary->getTripleObjectFormat() << ')';
    return llvm::make_error<Error>(std::move(Reason));
  }
  OwnedBinaries.push_back(std::move(OwningBinary));
  return llvm::Error::success();
}

buildFinalArchive() [1/2]

BARTLEBY_API llvm::Expected< std::unique_ptr< llvm::MemoryBuffer > > Bartleby::buildFinalArchive ( Bartleby &&  B )

staticnoexcept

Builds the final archive and returns its content.

Parameters

[in]

B

Bartleby handle.

Returns

The memory buffer containing the archive, or an error.

                                                 {
  ArchiveWriter Builder(std::move(B));
  return Builder.build();
}

buildFinalArchive() [2/2]

BARTLEBY_API llvm::Error Bartleby::buildFinalArchive ( Bartleby &&  B, llvm::StringRef  OutFilepath  )

staticnoexcept

Builds the final archive and writes its content to a file.

Parameters

[in]	B	Bartleby handle.
	OutFilepath	Path to out file.

Returns

An error.

                                                                {
  ArchiveWriter Builder(std::move(B));
  return Builder.build(OutFilepath);
}

getSymbols()

const SymbolMap & saq::bartleby::Bartleby::getSymbols ( ) const

inlinenoexcept

Gets a const reference to the map of symbols.

Returns

The map of symbols.

{ return Symbols; }

prefixGlobalAndDefinedSymbols()

BARTLEBY_API size_t Bartleby::prefixGlobalAndDefinedSymbols ( llvm::StringRef  Prefix )

noexcept

Applies a prefix to all global and defined symbols.

Parameters

Prefix

Prefix.

Returns

The number of symbols that have been prefixed.

                                                                     {
  size_t N = 0;
  const auto End = Symbols.end();
  for (auto Entry = Symbols.begin(); Entry != End; ++Entry) {
    const auto &Name = Entry->first();
    auto &Sym = Entry->getValue();
    if (Sym.isGlobal() && Sym.isDefined()) {
      std::string NewName;
      if (Sym.isMachO()) {
        NewName += '_';
      }
      NewName += Prefix;
 
      if (Sym.isMachO()) {
        NewName += Name.substr(1);
      } else {
        NewName += Name;
      }
      Sym.setName(std::move(NewName));
      ++N;
    }
  }
 
  return N;
}

---

The documentation for this class was generated from the following files:

• bartleby/include/Bartleby/Bartleby.h
• bartleby/lib/Bartleby/ArchiveWriter.cpp
• bartleby/lib/Bartleby/Bartleby.cpp