336 lines
11 KiB
C++
336 lines
11 KiB
C++
//===-- llvm-lipo.cpp - a tool for manipulating universal binaries --------===//
|
|
//
|
|
// 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
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
//
|
|
// A utility for creating / splitting / inspecting universal binaries.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#include "llvm/ADT/Triple.h"
|
|
#include "llvm/Object/Binary.h"
|
|
#include "llvm/Object/MachO.h"
|
|
#include "llvm/Object/MachOUniversal.h"
|
|
#include "llvm/Object/ObjectFile.h"
|
|
#include "llvm/Option/Arg.h"
|
|
#include "llvm/Option/ArgList.h"
|
|
#include "llvm/Support/CommandLine.h"
|
|
#include "llvm/Support/Error.h"
|
|
#include "llvm/Support/FileOutputBuffer.h"
|
|
#include "llvm/Support/InitLLVM.h"
|
|
#include "llvm/Support/WithColor.h"
|
|
|
|
using namespace llvm;
|
|
using namespace llvm::object;
|
|
|
|
static const StringRef ToolName = "llvm-lipo";
|
|
|
|
LLVM_ATTRIBUTE_NORETURN static void reportError(Twine Message) {
|
|
WithColor::error(errs(), ToolName) << Message << "\n";
|
|
errs().flush();
|
|
exit(EXIT_FAILURE);
|
|
}
|
|
|
|
LLVM_ATTRIBUTE_NORETURN static void reportError(StringRef File, Error E) {
|
|
assert(E);
|
|
std::string Buf;
|
|
raw_string_ostream OS(Buf);
|
|
logAllUnhandledErrors(std::move(E), OS);
|
|
OS.flush();
|
|
WithColor::error(errs(), ToolName) << "'" << File << "': " << Buf;
|
|
exit(EXIT_FAILURE);
|
|
}
|
|
|
|
namespace {
|
|
enum LipoID {
|
|
LIPO_INVALID = 0, // This is not an option ID.
|
|
#define OPTION(PREFIX, NAME, ID, KIND, GROUP, ALIAS, ALIASARGS, FLAGS, PARAM, \
|
|
HELPTEXT, METAVAR, VALUES) \
|
|
LIPO_##ID,
|
|
#include "LipoOpts.inc"
|
|
#undef OPTION
|
|
};
|
|
|
|
// LipoInfoTable below references LIPO_##PREFIX. OptionGroup has prefix nullptr.
|
|
const char *const *LIPO_nullptr = nullptr;
|
|
#define PREFIX(NAME, VALUE) const char *const LIPO_##NAME[] = VALUE;
|
|
#include "LipoOpts.inc"
|
|
#undef PREFIX
|
|
|
|
static const opt::OptTable::Info LipoInfoTable[] = {
|
|
#define OPTION(PREFIX, NAME, ID, KIND, GROUP, ALIAS, ALIASARGS, FLAGS, PARAM, \
|
|
HELPTEXT, METAVAR, VALUES) \
|
|
{LIPO_##PREFIX, NAME, HELPTEXT, \
|
|
METAVAR, LIPO_##ID, opt::Option::KIND##Class, \
|
|
PARAM, FLAGS, LIPO_##GROUP, \
|
|
LIPO_##ALIAS, ALIASARGS, VALUES},
|
|
#include "LipoOpts.inc"
|
|
#undef OPTION
|
|
};
|
|
|
|
class LipoOptTable : public opt::OptTable {
|
|
public:
|
|
LipoOptTable() : OptTable(LipoInfoTable) {}
|
|
};
|
|
|
|
enum class LipoAction {
|
|
PrintArchs,
|
|
VerifyArch,
|
|
ThinArch,
|
|
};
|
|
|
|
struct Config {
|
|
SmallVector<std::string, 1> InputFiles;
|
|
SmallVector<std::string, 1> VerifyArchList;
|
|
std::string ThinArchType;
|
|
std::string OutputFile;
|
|
LipoAction ActionToPerform;
|
|
};
|
|
|
|
} // end namespace
|
|
|
|
static void validateArchitectureName(StringRef ArchitectureName) {
|
|
if (!MachOObjectFile::isValidArch(ArchitectureName)) {
|
|
std::string Buf;
|
|
raw_string_ostream OS(Buf);
|
|
OS << "Invalid architecture: " << ArchitectureName
|
|
<< "\nValid architecture names are:";
|
|
for (auto arch : MachOObjectFile::getValidArchs())
|
|
OS << " " << arch;
|
|
reportError(OS.str());
|
|
}
|
|
}
|
|
|
|
static Config parseLipoOptions(ArrayRef<const char *> ArgsArr) {
|
|
Config C;
|
|
LipoOptTable T;
|
|
unsigned MissingArgumentIndex, MissingArgumentCount;
|
|
llvm::opt::InputArgList InputArgs =
|
|
T.ParseArgs(ArgsArr, MissingArgumentIndex, MissingArgumentCount);
|
|
|
|
if (MissingArgumentCount)
|
|
reportError("missing argument to " +
|
|
StringRef(InputArgs.getArgString(MissingArgumentIndex)) +
|
|
" option");
|
|
|
|
if (InputArgs.size() == 0) {
|
|
// PrintHelp does not accept Twine.
|
|
T.PrintHelp(errs(), "llvm-lipo input[s] option[s]", "llvm-lipo");
|
|
exit(EXIT_FAILURE);
|
|
}
|
|
|
|
if (InputArgs.hasArg(LIPO_help)) {
|
|
// PrintHelp does not accept Twine.
|
|
T.PrintHelp(outs(), "llvm-lipo input[s] option[s]", "llvm-lipo");
|
|
exit(EXIT_SUCCESS);
|
|
}
|
|
|
|
if (InputArgs.hasArg(LIPO_version)) {
|
|
outs() << ToolName + "\n";
|
|
cl::PrintVersionMessage();
|
|
exit(EXIT_SUCCESS);
|
|
}
|
|
|
|
for (auto Arg : InputArgs.filtered(LIPO_UNKNOWN))
|
|
reportError("unknown argument '" + Arg->getAsString(InputArgs) + "'");
|
|
|
|
for (auto Arg : InputArgs.filtered(LIPO_INPUT))
|
|
C.InputFiles.push_back(Arg->getValue());
|
|
if (C.InputFiles.empty())
|
|
reportError("at least one input file should be specified");
|
|
|
|
if (InputArgs.hasArg(LIPO_output))
|
|
C.OutputFile = InputArgs.getLastArgValue(LIPO_output);
|
|
|
|
SmallVector<opt::Arg *, 1> ActionArgs(InputArgs.filtered(LIPO_action_group));
|
|
if (ActionArgs.empty())
|
|
reportError("at least one action should be specified");
|
|
if (ActionArgs.size() > 1) {
|
|
std::string Buf;
|
|
raw_string_ostream OS(Buf);
|
|
OS << "only one of the following actions can be specified:";
|
|
for (auto Arg : ActionArgs)
|
|
OS << " " << Arg->getSpelling();
|
|
reportError(OS.str());
|
|
}
|
|
|
|
switch (ActionArgs[0]->getOption().getID()) {
|
|
case LIPO_verify_arch:
|
|
for (auto A : InputArgs.getAllArgValues(LIPO_verify_arch))
|
|
C.VerifyArchList.push_back(A);
|
|
if (C.VerifyArchList.empty())
|
|
reportError(
|
|
"verify_arch requires at least one architecture to be specified");
|
|
if (C.InputFiles.size() > 1)
|
|
reportError("verify_arch expects a single input file");
|
|
C.ActionToPerform = LipoAction::VerifyArch;
|
|
return C;
|
|
|
|
case LIPO_archs:
|
|
if (C.InputFiles.size() > 1)
|
|
reportError("archs expects a single input file");
|
|
C.ActionToPerform = LipoAction::PrintArchs;
|
|
return C;
|
|
|
|
case LIPO_thin:
|
|
if (C.InputFiles.size() > 1)
|
|
reportError("thin expects a single input file");
|
|
C.ThinArchType = ActionArgs[0]->getValue();
|
|
validateArchitectureName(C.ThinArchType);
|
|
if (C.OutputFile.empty())
|
|
reportError("thin expects a single output file");
|
|
|
|
C.ActionToPerform = LipoAction::ThinArch;
|
|
return C;
|
|
|
|
default:
|
|
reportError("llvm-lipo action unspecified");
|
|
}
|
|
}
|
|
|
|
static SmallVector<OwningBinary<Binary>, 1>
|
|
readInputBinaries(ArrayRef<std::string> InputFiles) {
|
|
SmallVector<OwningBinary<Binary>, 1> InputBinaries;
|
|
for (StringRef InputFile : InputFiles) {
|
|
Expected<OwningBinary<llvm::object::Binary>> BinaryOrErr =
|
|
createBinary(InputFile);
|
|
if (!BinaryOrErr)
|
|
reportError(InputFile, BinaryOrErr.takeError());
|
|
// TODO: Add compatibility for archive files
|
|
if (BinaryOrErr->getBinary()->isArchive())
|
|
reportError("File " + InputFile +
|
|
" is an archive file and is not yet supported.");
|
|
if (!BinaryOrErr->getBinary()->isMachO() &&
|
|
!BinaryOrErr->getBinary()->isMachOUniversalBinary())
|
|
reportError("File " + InputFile + " has unsupported binary format");
|
|
InputBinaries.push_back(std::move(*BinaryOrErr));
|
|
}
|
|
return InputBinaries;
|
|
}
|
|
|
|
LLVM_ATTRIBUTE_NORETURN
|
|
static void verifyArch(ArrayRef<OwningBinary<Binary>> InputBinaries,
|
|
ArrayRef<std::string> VerifyArchList) {
|
|
assert(!VerifyArchList.empty() &&
|
|
"The list of architectures should be non-empty");
|
|
assert(InputBinaries.size() == 1 && "Incorrect number of input binaries");
|
|
|
|
for (StringRef Arch : VerifyArchList)
|
|
validateArchitectureName(Arch);
|
|
|
|
if (auto UO =
|
|
dyn_cast<MachOUniversalBinary>(InputBinaries.front().getBinary())) {
|
|
for (StringRef Arch : VerifyArchList) {
|
|
Expected<std::unique_ptr<MachOObjectFile>> Obj =
|
|
UO->getObjectForArch(Arch);
|
|
if (!Obj)
|
|
exit(EXIT_FAILURE);
|
|
}
|
|
} else if (auto O =
|
|
dyn_cast<MachOObjectFile>(InputBinaries.front().getBinary())) {
|
|
const Triple::ArchType ObjectArch = O->getArch();
|
|
for (StringRef Arch : VerifyArchList)
|
|
if (ObjectArch != Triple(Arch).getArch())
|
|
exit(EXIT_FAILURE);
|
|
} else {
|
|
llvm_unreachable("Unexpected binary format");
|
|
}
|
|
exit(EXIT_SUCCESS);
|
|
}
|
|
|
|
static void printArchOrUnknown(const MachOObjectFile *ObjectFile) {
|
|
// Prints trailing space and unknown in this format for compatibility with
|
|
// cctools lipo.
|
|
const std::string ObjectArch = ObjectFile->getArchTriple().getArchName();
|
|
if (ObjectArch.empty())
|
|
outs() << "unknown(" << ObjectFile->getHeader().cputype << ","
|
|
<< ObjectFile->getHeader().cpusubtype << ") ";
|
|
else
|
|
outs() << ObjectArch + " ";
|
|
}
|
|
|
|
LLVM_ATTRIBUTE_NORETURN
|
|
static void printArchs(ArrayRef<OwningBinary<Binary>> InputBinaries) {
|
|
assert(InputBinaries.size() == 1 && "Incorrect number of input binaries");
|
|
const Binary *InputBinary = InputBinaries.front().getBinary();
|
|
if (auto UO = dyn_cast<MachOUniversalBinary>(InputBinary)) {
|
|
for (MachOUniversalBinary::object_iterator I = UO->begin_objects(),
|
|
E = UO->end_objects();
|
|
I != E; ++I) {
|
|
Expected<std::unique_ptr<MachOObjectFile>> BinaryOrError =
|
|
I->getAsObjectFile();
|
|
if (!BinaryOrError)
|
|
reportError(InputBinary->getFileName(), BinaryOrError.takeError());
|
|
printArchOrUnknown(BinaryOrError.get().get());
|
|
}
|
|
} else if (auto O = dyn_cast<MachOObjectFile>(InputBinary)) {
|
|
printArchOrUnknown(O);
|
|
} else {
|
|
llvm_unreachable("Unexpected binary format");
|
|
}
|
|
|
|
outs() << "\n";
|
|
exit(EXIT_SUCCESS);
|
|
}
|
|
|
|
LLVM_ATTRIBUTE_NORETURN
|
|
static void extractSlice(ArrayRef<OwningBinary<Binary>> InputBinaries,
|
|
StringRef ThinArchType, StringRef OutputFileName) {
|
|
assert(!ThinArchType.empty() && "The architecture type should be non-empty");
|
|
assert(InputBinaries.size() == 1 && "Incorrect number of input binaries");
|
|
assert(!OutputFileName.empty() && "Thin expects a single output file");
|
|
|
|
if (InputBinaries.front().getBinary()->isMachO()) {
|
|
reportError("input file " +
|
|
InputBinaries.front().getBinary()->getFileName() +
|
|
" must be a fat file when the -thin option is specified");
|
|
exit(EXIT_FAILURE);
|
|
}
|
|
|
|
auto *UO = cast<MachOUniversalBinary>(InputBinaries.front().getBinary());
|
|
Expected<std::unique_ptr<MachOObjectFile>> Obj =
|
|
UO->getObjectForArch(ThinArchType);
|
|
if (!Obj)
|
|
reportError("fat input file " + UO->getFileName() +
|
|
" does not contain the specified architecture " + ThinArchType +
|
|
" to thin it to");
|
|
|
|
Expected<std::unique_ptr<FileOutputBuffer>> OutFileOrError =
|
|
FileOutputBuffer::create(OutputFileName,
|
|
Obj.get()->getMemoryBufferRef().getBufferSize(),
|
|
sys::fs::can_execute(UO->getFileName())
|
|
? FileOutputBuffer::F_executable
|
|
: 0);
|
|
if (!OutFileOrError)
|
|
reportError(OutputFileName, OutFileOrError.takeError());
|
|
std::copy(Obj.get()->getMemoryBufferRef().getBufferStart(),
|
|
Obj.get()->getMemoryBufferRef().getBufferEnd(),
|
|
OutFileOrError.get()->getBufferStart());
|
|
if (Error E = OutFileOrError.get()->commit())
|
|
reportError(OutputFileName, std::move(E));
|
|
exit(EXIT_SUCCESS);
|
|
}
|
|
|
|
int main(int argc, char **argv) {
|
|
InitLLVM X(argc, argv);
|
|
Config C = parseLipoOptions(makeArrayRef(argv + 1, argc));
|
|
SmallVector<OwningBinary<Binary>, 1> InputBinaries =
|
|
readInputBinaries(C.InputFiles);
|
|
|
|
switch (C.ActionToPerform) {
|
|
case LipoAction::VerifyArch:
|
|
verifyArch(InputBinaries, C.VerifyArchList);
|
|
break;
|
|
case LipoAction::PrintArchs:
|
|
printArchs(InputBinaries);
|
|
break;
|
|
case LipoAction::ThinArch:
|
|
extractSlice(InputBinaries, C.ThinArchType, C.OutputFile);
|
|
break;
|
|
}
|
|
return EXIT_SUCCESS;
|
|
}
|