llvm-mirror/tools/dsymutil/Reproducer.h
Jonas Devlieghere b03521b98d [dsymutil] Add reproducers to dsymutil
Add support for generating a dsymutil reproducer. The result is a folder
containing all the object files for linking.

When --gen-reproducer is passed, dsymutil uses a FileCollectorFileSystem
which keeps track of all the files used by dsymutil. These files are
copied into a temporary directory when dsymutil exists.

When this path is passed to --use-reproducer, dsymutil uses a
RedirectingFileSystem that will use the files from the reproducer
directory instead of the actual paths. This means you don't need to mess
with the OSO path prefix.

Differential revision: https://reviews.llvm.org/D79398
2020-05-21 10:59:49 -07:00

78 lines
2.2 KiB
C++

//===- tools/dsymutil/Reproducer.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 LLVM_TOOLS_DSYMUTIL_REPRODUCER_H
#define LLVM_TOOLS_DSYMUTIL_REPRODUCER_H
#include "llvm/Support/Error.h"
#include "llvm/Support/FileCollector.h"
#include "llvm/Support/VirtualFileSystem.h"
namespace llvm {
namespace dsymutil {
/// The reproducer mode.
enum class ReproducerMode {
Generate,
Use,
Off,
};
/// The reproducer class manages the sate related to reproducers in dsymutil.
/// Instances should be created with Reproducer::createReproducer. An instance
/// of this class is returned when reproducers are off. The VFS returned by
/// this instance is the real file system.
class Reproducer {
public:
Reproducer();
virtual ~Reproducer();
IntrusiveRefCntPtr<vfs::FileSystem> getVFS() const { return VFS; }
/// Create a Reproducer instance based on the given mode.
static llvm::Expected<std::unique_ptr<Reproducer>>
createReproducer(ReproducerMode Mode, StringRef Root);
protected:
IntrusiveRefCntPtr<vfs::FileSystem> VFS;
};
/// Reproducer instance used to generate a new reproducer. The VFS returned by
/// this instance is a FileCollectorFileSystem that tracks every file used by
/// dsymutil.
class ReproducerGenerate : public Reproducer {
public:
ReproducerGenerate(std::error_code &EC);
~ReproducerGenerate() override;
private:
/// The path to the reproducer.
std::string Root;
/// The FileCollector used by the FileCollectorFileSystem.
std::shared_ptr<FileCollector> FC;
};
/// Reproducer instance used to use an existing reproducer. The VFS returned by
/// this instance is a RedirectingFileSystem that remaps paths to their
/// counterpart in the reproducer.
class ReproducerUse : public Reproducer {
public:
ReproducerUse(StringRef Root, std::error_code &EC);
~ReproducerUse() override;
private:
/// The path to the reproducer.
std::string Root;
};
} // end namespace dsymutil
} // end namespace llvm
#endif // LLVM_TOOLS_DSYMUTIL_REPRODUCER_H