hayodea
09caf314f1
We decided to get rid of the C FFI for libs. It was becoming too intricate and complicated. It was becoming a technical burden and expanding into too much extra code. It's unfortunate, but we'll have to give up on getting out-of-tree hot-loadable libraries the easy way. It's possible to still do it with cross compilation or by keeping track of the libstdc++ version that the running harikoff binary was compiled against. Then we can ensure that our loadable lib code is linked against that same libstdc++ code and this should ensure ABI stability.
84 lines
2.2 KiB
C++
84 lines
2.2 KiB
C++
#ifndef SENSE_API_PROVIDER_DESC_H
|
|
#define SENSE_API_PROVIDER_DESC_H
|
|
|
|
#include <string>
|
|
#include <memory>
|
|
#include <vector>
|
|
#include <dlfcn.h>
|
|
#include <functional>
|
|
#include <user/senseApiDesc.h>
|
|
|
|
namespace hk {
|
|
namespace sense_api {
|
|
|
|
class SenseApiLib
|
|
{
|
|
private:
|
|
friend class SenseApiManager;
|
|
struct DlCloser
|
|
{
|
|
void operator()(void* handle) const
|
|
{
|
|
if (handle) {
|
|
dlclose(handle);
|
|
}
|
|
}
|
|
};
|
|
|
|
public:
|
|
SenseApiLib(
|
|
const std::string& path, void *_dlopen_handle, getSenseApiDescFn *descFn)
|
|
: libraryPath(path),
|
|
dlopen_handle(_dlopen_handle, DlCloser()),
|
|
HK_GET_SENSE_API_DESC_FN_NAME(descFn)
|
|
{}
|
|
|
|
void setSenseApiDesc(const SenseApiDesc &desc)
|
|
{
|
|
if (!SenseApiDesc::sanityCheck(desc))
|
|
{
|
|
throw std::runtime_error(
|
|
std::string(__func__) + ": Sanity check failed for sense API "
|
|
"descriptor in library '" + libraryPath + "'");
|
|
}
|
|
|
|
senseApiDesc = desc;
|
|
}
|
|
|
|
public:
|
|
std::string libraryPath;
|
|
std::unique_ptr<void, DlCloser> dlopen_handle;
|
|
/* UNIMPLEMENTED: API-specific cmdline options. These affect this specific
|
|
* sense api lib's behaviour globally.
|
|
*/
|
|
std::vector<std::string> options;
|
|
|
|
/**
|
|
* @brief Every sense API lib is required to provide a function that returns
|
|
* a SenseApiDesc struct. This struct states which API the lib uses to
|
|
* connect Harikoff to the sense provider it supports.
|
|
*
|
|
* This getter function should be visible to dlsym() so that Harikoff can
|
|
* find it in the lib after loading it, and call it.
|
|
*/
|
|
std::function<getSenseApiDescFn> HK_GET_SENSE_API_DESC_FN_NAME;
|
|
|
|
/**
|
|
* @brief Harikoff will call the `HK_GET_SENSE_API_DESC_FN_NAME` getter
|
|
* function and use the data it provides in order to fill out this
|
|
* descriptor.
|
|
*/
|
|
SenseApiDesc senseApiDesc;
|
|
|
|
std::string stringify() const {
|
|
std::string result = "Library Path: " + libraryPath + "\n";
|
|
result += "Sense API Descriptor: " + senseApiDesc.stringify() + "\n";
|
|
return result;
|
|
}
|
|
};
|
|
|
|
} // namespace sense_api
|
|
} // namespace hk
|
|
|
|
#endif // SENSE_API_PROVIDER_DESC_H
|