Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Defining a new API for debug options that doesn't rely on static glob…
…al cl::opts. Summary: This is based on the discussions from the LLVMDev thread: http://lists.cs.uiuc.edu/pipermail/llvmdev/2014-August/075886.html Reviewers: chandlerc Reviewed By: chandlerc Subscribers: llvm-commits Differential Revision: http://reviews.llvm.org/D5389 llvm-svn: 219854
- Loading branch information
Chris Bieneman
committed
Oct 15, 2014
1 parent
de4de39
commit 732e0aa
Showing
7 changed files
with
193 additions
and
12 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,115 @@ | ||
//===- llvm/Support/Options.h - Debug options support -----------*- C++ -*-===// | ||
// | ||
// The LLVM Compiler Infrastructure | ||
// | ||
// This file is distributed under the University of Illinois Open Source | ||
// License. See LICENSE.TXT for details. | ||
// | ||
//===----------------------------------------------------------------------===// | ||
/// \file | ||
/// This file declares helper objects for defining debug options that can be | ||
/// configured via the command line. The new API currently builds on the cl::opt | ||
/// API, but does not require the use of static globals. | ||
/// | ||
/// With this API options are registered during initialization. For passes, this | ||
/// happens during pass initialization. Passes with options will call a static | ||
/// registerOptions method during initialization that registers options with the | ||
/// OptionRegistry. An example implementation of registerOptions is: | ||
/// | ||
/// static void registerOptions() { | ||
/// OptionRegistry::registerOption<bool, Scalarizer, | ||
/// &Scalarizer::ScalarizeLoadStore>( | ||
/// "scalarize-load-store", | ||
/// "Allow the scalarizer pass to scalarize loads and store", false); | ||
/// } | ||
/// | ||
/// When reading data for options the interface is via the LLVMContext. Option | ||
/// data for passes should be read from the context during doInitialization. An | ||
/// example of reading the above option would be: | ||
/// | ||
/// ScalarizeLoadStore = | ||
/// M.getContext().template getOption<bool, | ||
/// Scalarizer, | ||
/// &Scalarizer::ScalarizeLoadStore>(); | ||
/// | ||
//===----------------------------------------------------------------------===// | ||
|
||
#include "llvm/ADT/DenseMap.h" | ||
#include "llvm/Support/CommandLine.h" | ||
|
||
namespace llvm { | ||
|
||
namespace detail { | ||
|
||
// Options are keyed of the unique address of a static character synthesized | ||
// based on template arguments. | ||
template <typename ValT, typename Base, ValT(Base::*Mem)> class OptionKey { | ||
public: | ||
static char ID; | ||
}; | ||
|
||
template <typename ValT, typename Base, ValT(Base::*Mem)> | ||
char OptionKey<ValT, Base, Mem>::ID = 0; | ||
|
||
} // namespace detail | ||
|
||
/// \brief Singleton class used to register debug options. | ||
/// | ||
/// The OptionRegistry is responsible for managing lifetimes of the options and | ||
/// provides interfaces for option registration and reading values from options. | ||
/// This object is a singleton, only one instance should ever exist so that all | ||
/// options are registered in teh same place. | ||
class OptionRegistry { | ||
private: | ||
DenseMap<void *, cl::Option *> Options; | ||
|
||
/// \brief Adds a cl::Option to the registry. | ||
/// | ||
/// \param Key unique key for option | ||
/// \param O option to map to \p Key | ||
/// | ||
/// Allocated cl::Options are owened by the OptionRegistry and are deallocated | ||
/// on destruction or removal | ||
void addOption(void *Key, cl::Option *O); | ||
|
||
public: | ||
~OptionRegistry(); | ||
OptionRegistry() {} | ||
|
||
/// \brief Returns a reference to the singleton instance. | ||
static OptionRegistry &instance(); | ||
|
||
/// \brief Registers an option with the OptionRegistry singleton. | ||
/// | ||
/// \param ValT type of the option's data | ||
/// \param Base class used to key the option | ||
/// \param Mem member of \p Base used for keying the option | ||
/// | ||
/// Options are keyed off the template parameters to generate unique static | ||
/// characters. The template parameters are (1) the type of the data the | ||
/// option stores (\p ValT), the class that will read the option (\p Base), | ||
/// and the memeber that the class will store the data into (\p Mem). | ||
template <typename ValT, typename Base, ValT(Base::*Mem)> | ||
static void registerOption(const char *ArgStr, const char *Desc, | ||
const ValT &InitValue) { | ||
cl::opt<ValT> *Option = new cl::opt<ValT>(ArgStr, cl::desc(Desc), | ||
cl::Hidden, cl::init(InitValue)); | ||
instance().addOption(&detail::OptionKey<ValT, Base, Mem>::ID, Option); | ||
} | ||
|
||
/// \brief Returns the value of the option. | ||
/// | ||
/// \param ValT type of the option's data | ||
/// \param Base class used to key the option | ||
/// \param Mem member of \p Base used for keying the option | ||
/// | ||
/// Reads option values based on the key generated by the template parameters. | ||
/// Keying for get() is the same as keying for registerOption. | ||
template <typename ValT, typename Base, ValT(Base::*Mem)> ValT get() const { | ||
auto It = Options.find(&detail::OptionKey<ValT, Base, Mem>::ID); | ||
assert(It != Options.end() && "Option not in OptionRegistry"); | ||
return *(cl::opt<ValT> *)It->second; | ||
} | ||
}; | ||
|
||
} // namespace llvm |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
//===- llvm/Support/Options.cpp - Debug options support ---------*- C++ -*-===// | ||
// | ||
// The LLVM Compiler Infrastructure | ||
// | ||
// This file is distributed under the University of Illinois Open Source | ||
// License. See LICENSE.TXT for details. | ||
// | ||
//===----------------------------------------------------------------------===// | ||
// | ||
// This file implements the helper objects for defining debug options using the | ||
// new API built on cl::opt, but not requiring the use of static globals. | ||
// | ||
//===----------------------------------------------------------------------===// | ||
|
||
#include "llvm/Support/Options.h" | ||
#include "llvm/Support/ManagedStatic.h" | ||
|
||
using namespace llvm; | ||
|
||
OptionRegistry::~OptionRegistry() { | ||
for (auto IT = Options.begin(); IT != Options.end(); ++IT) | ||
delete IT->second; | ||
} | ||
|
||
void OptionRegistry::addOption(void *Key, cl::Option *O) { | ||
assert(Options.find(Key) == Options.end() && | ||
"Argument with this key already registerd"); | ||
Options.insert(std::make_pair(Key, O)); | ||
} | ||
|
||
static ManagedStatic<OptionRegistry> OR; | ||
|
||
OptionRegistry &OptionRegistry::instance() { return *OR; } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters