0
0
Fork 0
mirror of https://github.com/matrix-construct/construct synced 2024-06-28 14:58:20 +02:00

ircd::mods: Split up; clean up; reorg.

This commit is contained in:
Jason Volk 2018-03-23 21:40:20 -07:00
parent fe6f09d218
commit d745e65ee1
11 changed files with 900 additions and 770 deletions

View file

@ -1,302 +0,0 @@
// Matrix Construct
//
// Copyright (C) Matrix Construct Developers, Authors & Contributors
// Copyright (C) 2016-2018 Jason Volk <jason@zemos.net>
//
// Permission to use, copy, modify, and/or distribute this software for any
// purpose with or without fee is hereby granted, provided that the above
// copyright notice and this permission notice is present in all copies. The
// full license for this software is available in the LICENSE file.
#pragma once
#define HAVE_IRCD_MODS_H
/// Modules system
namespace ircd::mods
{
IRCD_EXCEPTION(ircd::error, error)
IRCD_EXCEPTION(error, filesystem_error)
IRCD_EXCEPTION(error, invalid_export)
IRCD_EXCEPTION(error, expired_symbol)
IRCD_EXCEPTION(error, undefined_symbol)
struct mod;
struct module;
struct sym_ptr;
template<class T> struct import;
template<class T> struct import_shared;
struct paths extern paths;
// Platform (.so|.dll) postfixing
std::string postfixed(const std::string &name);
std::string unpostfixed(const std::string &name);
// Section & Symbol utilites
std::vector<std::string> sections(const std::string &fullpath);
std::vector<std::string> symbols(const std::string &fullpath, const std::string &section);
std::vector<std::string> symbols(const std::string &fullpath);
std::unordered_map<std::string, std::string> mangles(const std::vector<std::string> &);
std::unordered_map<std::string, std::string> mangles(const std::string &fullpath, const std::string &section);
std::unordered_map<std::string, std::string> mangles(const std::string &fullpath);
// Find module names where symbol resides
bool has_symbol(const std::string &name, const std::string &symbol);
std::vector<std::string> find_symbol(const std::string &symbol);
// returns dir/name of first dir containing 'name' (and this will be a loadable module)
// Unlike libltdl, the reason each individual candidate failed is presented in a vector.
std::string search(const std::string &name, std::vector<std::string> &why);
std::string search(const std::string &name);
// Potential modules available to load
std::forward_list<std::string> available();
bool available(const std::string &name);
bool loaded(const std::string &name);
string_view name(const mod &);
string_view path(const mod &);
}
// Bring struct module into main ircd::
namespace ircd
{
using mods::module;
using mods::import;
using mods::import_shared;
}
struct ircd::mods::paths
:std::vector<std::string>
{
bool added(const std::string &dir) const;
bool del(const std::string &dir);
bool add(const std::string &dir, std::nothrow_t);
bool add(const std::string &dir);
paths();
};
struct ircd::mods::module
:std::shared_ptr<mod>
{
const std::string &name() const;
const std::string &path() const;
const std::string &mangle(const std::string &) const;
bool has(const std::string &name) const;
template<class T = uint8_t> const T *ptr(const std::string &name) const;
template<class T = uint8_t> T *ptr(const std::string &name);
template<class T> const T &get(const std::string &name) const;
template<class T> T &get(const std::string &name);
module(std::shared_ptr<mod> ptr = {})
:std::shared_ptr<mod>{std::move(ptr)}
{}
module(const std::string &name);
~module() noexcept;
};
namespace ircd::mods
{
template<> const uint8_t *module::ptr<const uint8_t>(const std::string &name) const;
template<> uint8_t *module::ptr<uint8_t>(const std::string &name);
}
template<class T>
T &
ircd::mods::module::get(const std::string &name)
{
return *ptr<T>(name);
}
template<class T>
const T &
ircd::mods::module::get(const std::string &name)
const
{
return *ptr<T>(name);
}
template<class T>
T *
ircd::mods::module::ptr(const std::string &name)
{
return reinterpret_cast<T *>(ptr<uint8_t>(name));
}
template<class T>
const T *
ircd::mods::module::ptr(const std::string &name)
const
{
return reinterpret_cast<const T *>(ptr<const uint8_t>(name));
}
/// Representation of a symbol in a loaded library (non-template; low level).
///
class ircd::mods::sym_ptr
:std::weak_ptr<mod>
{
void *ptr {nullptr};
public:
bool operator!() const;
operator bool() const;
template<class T> const T *get() const;
template<class T> const T *operator->() const;
template<class T> const T &operator*() const;
template<class T, class... args> auto operator()(args&&... a) const;
template<class T> T *get();
template<class T> T *operator->();
template<class T> T &operator*();
sym_ptr() = default;
sym_ptr(module, const std::string &symname);
sym_ptr(const std::string &modname, const std::string &symname);
~sym_ptr() noexcept;
};
template<class T>
T &
ircd::mods::sym_ptr::operator*()
{
if(unlikely(expired()))
throw expired_symbol("The reference to a symbol in another module is no longer valid");
return *get<T>();
}
template<class T>
T *
ircd::mods::sym_ptr::operator->()
{
return get<T>();
}
template<class T>
T *
ircd::mods::sym_ptr::get()
{
return reinterpret_cast<T *>(ptr);
}
template<class T,
class... args>
auto
ircd::mods::sym_ptr::operator()(args&&... a)
const
{
return (*get<T>())(std::forward<args>(a)...);
}
template<class T>
const T &
ircd::mods::sym_ptr::operator*()
const
{
if(unlikely(expired()))
throw expired_symbol("The const reference to a symbol in another module is no longer valid");
return *get<T>();
}
template<class T>
const T *
ircd::mods::sym_ptr::operator->()
const
{
return get<T>();
}
template<class T>
const T *
ircd::mods::sym_ptr::get()
const
{
return reinterpret_cast<const T *>(ptr);
}
inline ircd::mods::sym_ptr::operator
bool()
const
{
return !bool(*this);
}
inline bool
ircd::mods::sym_ptr::operator!()
const
{
return !ptr || expired();
}
/// Representation of a symbol in a loaded shared library
///
template<class T>
struct ircd::mods::import
:sym_ptr
{
template<class... args>
auto operator()(args&&... a) const
{
return sym_ptr::operator()<T>(std::forward<args>(a)...);
}
const T *operator->() const { return sym_ptr::operator-><T>(); }
const T &operator*() const { return sym_ptr::operator*<T>(); }
operator const T &() const { return sym_ptr::operator*<T>(); }
T *operator->() { return sym_ptr::operator-><T>(); }
T &operator*() { return sym_ptr::operator*<T>(); }
operator T &() { return sym_ptr::operator*<T>(); }
using sym_ptr::sym_ptr;
};
/// Convenience for importing an std::shared_ptr<T> from a loaded lib
///
template<class T>
struct ircd::mods::import_shared
:import<std::shared_ptr<T>>
,std::shared_ptr<T>
{
using std::shared_ptr<T>::get;
using std::shared_ptr<T>::operator bool;
using std::shared_ptr<T>::operator->;
using std::shared_ptr<T>::operator*;
operator const T &() const { return std::shared_ptr<T>::operator*(); }
operator T &() { return std::shared_ptr<T>::operator*(); }
import_shared() = default;
import_shared(module, const std::string &symname);
import_shared(const std::string &modname, const std::string &symname);
};
template<class T>
ircd::mods::import_shared<T>::import_shared(const std::string &modname,
const std::string &symname)
:import_shared
{
module(modname), symname
}
{}
template<class T>
ircd::mods::import_shared<T>::import_shared(module module,
const std::string &symname)
:import<std::shared_ptr<T>>
{
module, symname
}
,std::shared_ptr<T>
{
import<std::shared_ptr<T>>::operator*()
}{}

View file

@ -0,0 +1,40 @@
// Matrix Construct
//
// Copyright (C) Matrix Construct Developers, Authors & Contributors
// Copyright (C) 2016-2018 Jason Volk <jason@zemos.net>
//
// Permission to use, copy, modify, and/or distribute this software for any
// purpose with or without fee is hereby granted, provided that the above
// copyright notice and this permission notice is present in all copies. The
// full license for this software is available in the LICENSE file.
#pragma once
#define HAVE_IRCD_MODS_IMPORT_H
namespace ircd::mods
{
template<class T> struct import;
}
/// Representation of a symbol in a loaded shared library
///
template<class T>
struct ircd::mods::import
:sym_ptr
{
template<class... args>
auto operator()(args&&... a) const
{
return sym_ptr::operator()<T>(std::forward<args>(a)...);
}
const T *operator->() const { return sym_ptr::operator-><T>(); }
const T &operator*() const { return sym_ptr::operator*<T>(); }
operator const T &() const { return sym_ptr::operator*<T>(); }
T *operator->() { return sym_ptr::operator-><T>(); }
T &operator*() { return sym_ptr::operator*<T>(); }
operator T &() { return sym_ptr::operator*<T>(); }
using sym_ptr::sym_ptr;
};

View file

@ -0,0 +1,58 @@
// Matrix Construct
//
// Copyright (C) Matrix Construct Developers, Authors & Contributors
// Copyright (C) 2016-2018 Jason Volk <jason@zemos.net>
//
// Permission to use, copy, modify, and/or distribute this software for any
// purpose with or without fee is hereby granted, provided that the above
// copyright notice and this permission notice is present in all copies. The
// full license for this software is available in the LICENSE file.
#pragma once
#define HAVE_IRCD_MODS_IMPORT_SHARED_H
namespace ircd::mods
{
template<class T> struct import_shared;
}
/// Convenience for importing an std::shared_ptr<T> from a loaded lib
///
template<class T>
struct ircd::mods::import_shared
:import<std::shared_ptr<T>>
,std::shared_ptr<T>
{
using std::shared_ptr<T>::get;
using std::shared_ptr<T>::operator bool;
using std::shared_ptr<T>::operator->;
using std::shared_ptr<T>::operator*;
operator const T &() const { return std::shared_ptr<T>::operator*(); }
operator T &() { return std::shared_ptr<T>::operator*(); }
import_shared() = default;
import_shared(module, const std::string &symname);
import_shared(const std::string &modname, const std::string &symname);
};
template<class T>
ircd::mods::import_shared<T>::import_shared(const std::string &modname,
const std::string &symname)
:import_shared
{
module(modname), symname
}
{}
template<class T>
ircd::mods::import_shared<T>::import_shared(module module,
const std::string &symname)
:import<std::shared_ptr<T>>
{
module, symname
}
,std::shared_ptr<T>
{
import<std::shared_ptr<T>>::operator*()
}{}

61
include/ircd/mods/mods.h Normal file
View file

@ -0,0 +1,61 @@
// Matrix Construct
//
// Copyright (C) Matrix Construct Developers, Authors & Contributors
// Copyright (C) 2016-2018 Jason Volk <jason@zemos.net>
//
// Permission to use, copy, modify, and/or distribute this software for any
// purpose with or without fee is hereby granted, provided that the above
// copyright notice and this permission notice is present in all copies. The
// full license for this software is available in the LICENSE file.
#pragma once
#define HAVE_IRCD_MODS_MODS_H
/// Modules system
namespace ircd::mods
{
struct mod;
IRCD_EXCEPTION(ircd::error, error)
IRCD_EXCEPTION(error, filesystem_error)
IRCD_EXCEPTION(error, invalid_export)
IRCD_EXCEPTION(error, expired_symbol)
IRCD_EXCEPTION(error, undefined_symbol)
string_view name(const mod &);
string_view path(const mod &);
}
#include "paths.h"
#include "symbols.h"
#include "module.h"
#include "sym_ptr.h"
#include "import.h"
#include "import_shared.h"
// misc util
namespace ircd::mods
{
bool loaded(const std::string &name);
bool available(const std::string &name);
bool is_module(const std::string &fullpath);
bool is_module(const std::string &fullpath, std::nothrow_t);
bool is_module(const std::string &fullpath, std::string &why);
// returns dir/name of first dir containing 'name' (and this will be
// a loadable module). Unlike libltdl, the reason each individual
// candidate failed is presented in a vector.
std::string search(const std::string &name, std::vector<std::string> &why);
std::string search(const std::string &name);
// Potential modules available to load
std::forward_list<std::string> available();
}
// Exports down into ircd::
namespace ircd
{
using mods::module;
using mods::import;
using mods::import_shared;
}

View file

@ -0,0 +1,76 @@
// Matrix Construct
//
// Copyright (C) Matrix Construct Developers, Authors & Contributors
// Copyright (C) 2016-2018 Jason Volk <jason@zemos.net>
//
// Permission to use, copy, modify, and/or distribute this software for any
// purpose with or without fee is hereby granted, provided that the above
// copyright notice and this permission notice is present in all copies. The
// full license for this software is available in the LICENSE file.
#pragma once
#define HAVE_IRCD_MODS_MODULE_H
namespace ircd::mods
{
struct module;
}
struct ircd::mods::module
:std::shared_ptr<mod>
{
const std::string &name() const;
const std::string &path() const;
const std::string &mangle(const std::string &) const;
bool has(const std::string &name) const;
template<class T = uint8_t> const T *ptr(const std::string &name) const;
template<class T = uint8_t> T *ptr(const std::string &name);
template<class T> const T &get(const std::string &name) const;
template<class T> T &get(const std::string &name);
module(std::shared_ptr<mod> ptr = {})
:std::shared_ptr<mod>{std::move(ptr)}
{}
module(const std::string &name);
~module() noexcept;
};
namespace ircd::mods
{
template<> const uint8_t *module::ptr<const uint8_t>(const std::string &name) const;
template<> uint8_t *module::ptr<uint8_t>(const std::string &name);
}
template<class T>
T &
ircd::mods::module::get(const std::string &name)
{
return *ptr<T>(name);
}
template<class T>
const T &
ircd::mods::module::get(const std::string &name)
const
{
return *ptr<T>(name);
}
template<class T>
T *
ircd::mods::module::ptr(const std::string &name)
{
return reinterpret_cast<T *>(ptr<uint8_t>(name));
}
template<class T>
const T *
ircd::mods::module::ptr(const std::string &name)
const
{
return reinterpret_cast<const T *>(ptr<const uint8_t>(name));
}

33
include/ircd/mods/paths.h Normal file
View file

@ -0,0 +1,33 @@
// Matrix Construct
//
// Copyright (C) Matrix Construct Developers, Authors & Contributors
// Copyright (C) 2016-2018 Jason Volk <jason@zemos.net>
//
// Permission to use, copy, modify, and/or distribute this software for any
// purpose with or without fee is hereby granted, provided that the above
// copyright notice and this permission notice is present in all copies. The
// full license for this software is available in the LICENSE file.
#pragma once
#define HAVE_IRCD_MODS_PATHS_H
namespace ircd::mods
{
struct paths extern paths;
// Platform (.so|.dll) postfixing
std::string postfixed(const std::string &name);
std::string unpostfixed(const std::string &name);
}
struct ircd::mods::paths
:std::vector<std::string>
{
bool added(const std::string &dir) const;
bool del(const std::string &dir);
bool add(const std::string &dir, std::nothrow_t);
bool add(const std::string &dir);
paths();
};

117
include/ircd/mods/sym_ptr.h Normal file
View file

@ -0,0 +1,117 @@
// Matrix Construct
//
// Copyright (C) Matrix Construct Developers, Authors & Contributors
// Copyright (C) 2016-2018 Jason Volk <jason@zemos.net>
//
// Permission to use, copy, modify, and/or distribute this software for any
// purpose with or without fee is hereby granted, provided that the above
// copyright notice and this permission notice is present in all copies. The
// full license for this software is available in the LICENSE file.
#pragma once
#define HAVE_IRCD_MODS_SYM_PTR_H
namespace ircd::mods
{
struct sym_ptr;
}
/// Representation of a symbol in a loaded library (non-template; low level).
///
class ircd::mods::sym_ptr
:std::weak_ptr<mod>
{
void *ptr {nullptr};
public:
bool operator!() const;
operator bool() const;
template<class T> const T *get() const;
template<class T> const T *operator->() const;
template<class T> const T &operator*() const;
template<class T, class... args> auto operator()(args&&... a) const;
template<class T> T *get();
template<class T> T *operator->();
template<class T> T &operator*();
sym_ptr() = default;
sym_ptr(module, const std::string &symname);
sym_ptr(const std::string &modname, const std::string &symname);
~sym_ptr() noexcept;
};
template<class T>
T &
ircd::mods::sym_ptr::operator*()
{
if(unlikely(expired()))
throw expired_symbol("The reference to a symbol in another module is no longer valid");
return *get<T>();
}
template<class T>
T *
ircd::mods::sym_ptr::operator->()
{
return get<T>();
}
template<class T>
T *
ircd::mods::sym_ptr::get()
{
return reinterpret_cast<T *>(ptr);
}
template<class T,
class... args>
auto
ircd::mods::sym_ptr::operator()(args&&... a)
const
{
return (*get<T>())(std::forward<args>(a)...);
}
template<class T>
const T &
ircd::mods::sym_ptr::operator*()
const
{
if(unlikely(expired()))
throw expired_symbol("The const reference to a symbol in another module is no longer valid");
return *get<T>();
}
template<class T>
const T *
ircd::mods::sym_ptr::operator->()
const
{
return get<T>();
}
template<class T>
const T *
ircd::mods::sym_ptr::get()
const
{
return reinterpret_cast<const T *>(ptr);
}
inline ircd::mods::sym_ptr::operator
bool()
const
{
return !bool(*this);
}
inline bool
ircd::mods::sym_ptr::operator!()
const
{
return !ptr || expired();
}

View file

@ -0,0 +1,29 @@
// Matrix Construct
//
// Copyright (C) Matrix Construct Developers, Authors & Contributors
// Copyright (C) 2016-2018 Jason Volk <jason@zemos.net>
//
// Permission to use, copy, modify, and/or distribute this software for any
// purpose with or without fee is hereby granted, provided that the above
// copyright notice and this permission notice is present in all copies. The
// full license for this software is available in the LICENSE file.
#pragma once
#define HAVE_IRCD_MODS_SYMBOLS_H
namespace ircd::mods
{
// Section & Symbol utilites
std::vector<std::string> sections(const std::string &fullpath);
std::vector<std::string> symbols(const std::string &fullpath, const std::string &section);
std::vector<std::string> symbols(const std::string &fullpath);
std::unordered_map<std::string, std::string> mangles(const std::vector<std::string> &);
std::unordered_map<std::string, std::string> mangles(const std::string &fullpath, const std::string &section);
std::unordered_map<std::string, std::string> mangles(const std::string &fullpath);
// Find module names where symbol resides
bool has_symbol(const std::string &name, const std::string &symbol);
std::vector<std::string> find_symbol(const std::string &symbol);
}

View file

@ -223,7 +223,7 @@ namespace ircd
#include "ctx/ctx.h"
#include "db/db.h"
#include "js.h"
#include "mods.h"
#include "mods/mods.h"
#include "rfc3986.h"
#include "rfc1035.h"
#include "net/net.h"

File diff suppressed because it is too large Load diff

View file

@ -18,8 +18,6 @@ namespace ircd::mods
filesystem::path prefix_if_relative(const filesystem::path &path);
filesystem::path postfixed(const filesystem::path &path);
filesystem::path unpostfixed(const filesystem::path &path);
std::string postfixed(const std::string &name);
std::string unpostfixed(const std::string &name);
template<class R, class F> R info(const filesystem::path &, F&& closure);
std::vector<std::string> sections(const filesystem::path &path);
@ -36,9 +34,6 @@ namespace ircd::mods
bool is_module(const filesystem::path &);
bool is_module(const filesystem::path &, std::string &why);
bool is_module(const filesystem::path &, std::nothrow_t);
bool is_module(const std::string &fullpath, std::string &why);
bool is_module(const std::string &fullpath, std::nothrow_t);
bool is_module(const std::string &fullpath);
}
/// Internal module representation