mirror of
https://github.com/NixOS/nix.git
synced 2025-11-08 19:46:02 +01:00
e4f62e4608
* It is tough to contribute to a project that doesn't use a formatter, * It is extra hard to contribute to a project which has configured the formatter, but ignores it for some files * Code formatting makes it harder to hide obscure / weird bugs by accident or on purpose, Let's rip the bandaid off? Note that PRs currently in flight should be able to be merged relatively easily by applying `clang-format` to their tip prior to merge.
120 lines
4.2 KiB
C++
120 lines
4.2 KiB
C++
#ifndef _WIN32
|
|
# include <dlfcn.h>
|
|
#endif
|
|
|
|
#include <filesystem>
|
|
|
|
#include "nix/util/config-global.hh"
|
|
#include "nix/util/signals.hh"
|
|
#include "nix/util/file-system.hh"
|
|
|
|
namespace nix {
|
|
|
|
struct PluginFilesSetting : public BaseSetting<Paths>
|
|
{
|
|
bool pluginsLoaded = false;
|
|
|
|
PluginFilesSetting(
|
|
Config * options,
|
|
const Paths & def,
|
|
const std::string & name,
|
|
const std::string & description,
|
|
const StringSet & aliases = {})
|
|
: BaseSetting<Paths>(def, true, name, description, aliases)
|
|
{
|
|
options->addSetting(this);
|
|
}
|
|
|
|
Paths parse(const std::string & str) const override;
|
|
};
|
|
|
|
Paths PluginFilesSetting::parse(const std::string & str) const
|
|
{
|
|
if (pluginsLoaded)
|
|
throw UsageError(
|
|
"plugin-files set after plugins were loaded, you may need to move the flag before the subcommand");
|
|
return BaseSetting<Paths>::parse(str);
|
|
}
|
|
|
|
struct PluginSettings : Config
|
|
{
|
|
PluginFilesSetting pluginFiles{
|
|
this,
|
|
{},
|
|
"plugin-files",
|
|
R"(
|
|
A list of plugin files to be loaded by Nix. Each of these files is
|
|
dlopened by Nix. If they contain the symbol `nix_plugin_entry()`,
|
|
this symbol is called. Alternatively, they can affect execution
|
|
through static initialization. In particular, these plugins may construct
|
|
static instances of RegisterPrimOp to add new primops or constants to the
|
|
expression language, RegisterStoreImplementation to add new store
|
|
implementations, RegisterCommand to add new subcommands to the `nix`
|
|
command, and RegisterSetting to add new nix config settings. See the
|
|
constructors for those types for more details.
|
|
|
|
Warning! These APIs are inherently unstable and may change from
|
|
release to release.
|
|
|
|
Since these files are loaded into the same address space as Nix
|
|
itself, they must be DSOs compatible with the instance of Nix
|
|
running at the time (i.e. compiled against the same headers, not
|
|
linked to any incompatible libraries). They should not be linked to
|
|
any Nix libraries directly, as those are already available at load
|
|
time.
|
|
|
|
If an entry in the list is a directory, all files in the directory
|
|
are loaded as plugins (non-recursively).
|
|
)"};
|
|
};
|
|
|
|
static PluginSettings pluginSettings;
|
|
|
|
static GlobalConfig::Register rPluginSettings(&pluginSettings);
|
|
|
|
void initPlugins()
|
|
{
|
|
assert(!pluginSettings.pluginFiles.pluginsLoaded);
|
|
for (const auto & pluginFile : pluginSettings.pluginFiles.get()) {
|
|
std::vector<std::filesystem::path> pluginFiles;
|
|
try {
|
|
auto ents = DirectoryIterator{pluginFile};
|
|
for (const auto & ent : ents) {
|
|
checkInterrupt();
|
|
pluginFiles.emplace_back(ent.path());
|
|
}
|
|
} catch (SysError & e) {
|
|
if (e.errNo != ENOTDIR)
|
|
throw;
|
|
pluginFiles.emplace_back(pluginFile);
|
|
}
|
|
for (const auto & file : pluginFiles) {
|
|
checkInterrupt();
|
|
/* handle is purposefully leaked as there may be state in the
|
|
DSO needed by the action of the plugin. */
|
|
#ifndef _WIN32 // TODO implement via DLL loading on Windows
|
|
void * handle = dlopen(file.c_str(), RTLD_LAZY | RTLD_LOCAL);
|
|
if (!handle)
|
|
throw Error("could not dynamically open plugin file '%s': %s", file, dlerror());
|
|
|
|
/* Older plugins use a statically initialized object to run their code.
|
|
Newer plugins can also export nix_plugin_entry() */
|
|
void (*nix_plugin_entry)() = (void (*)()) dlsym(handle, "nix_plugin_entry");
|
|
if (nix_plugin_entry)
|
|
nix_plugin_entry();
|
|
#else
|
|
throw Error("could not dynamically open plugin file '%s'", file);
|
|
#endif
|
|
}
|
|
}
|
|
|
|
/* Since plugins can add settings, try to re-apply previously
|
|
unknown settings. */
|
|
globalConfig.reapplyUnknownSettings();
|
|
globalConfig.warnUnknownSettings();
|
|
|
|
/* Tell the user if they try to set plugin-files after we've already loaded */
|
|
pluginSettings.pluginFiles.pluginsLoaded = true;
|
|
}
|
|
|
|
} // namespace nix
|