mirror of
https://github.com/ClickHouse/ClickHouse.git
synced 2024-11-29 11:02:08 +00:00
6b2b3c1eb3
This commit moves the catboost model evaluation out of the server
process into the library-bridge binary. This serves two goals: On the
one hand, crashes / memory corruptions of the catboost library no longer
affect the server. On the other hand, we can forbid loading dynamic
libraries in the server (catboost was the last consumer of this
functionality), thus improving security.
SQL syntax:
SELECT
catboostEvaluate('/path/to/model.bin', FEAT_1, ..., FEAT_N) > 0 AS prediction,
ACTION AS target
FROM amazon_train
LIMIT 10
Required configuration:
<catboost_lib_path>/path/to/libcatboostmodel.so</catboost_lib_path>
*** Implementation Details ***
The internal protocol between the server and the library-bridge is
simple:
- HTTP GET on path "/extdict_ping":
A ping, used during the handshake to check if the library-bridge runs.
- HTTP POST on path "extdict_request"
(1) Send a "catboost_GetTreeCount" request from the server to the
bridge, containing a library path (e.g /home/user/libcatboost.so) and
a model path (e.g. /home/user/model.bin). Rirst, this unloads the
catboost library handler associated to the model path (if it was
loaded), then loads the catboost library handler associated to the
model path, then executes GetTreeCount() on the library handler and
finally sends the result back to the server. Step (1) is called once
by the server from FunctionCatBoostEvaluate::getReturnTypeImpl(). The
library path handler is unloaded in the beginning because it contains
state which may no longer be valid if the user runs
catboost("/path/to/model.bin", ...) more than once and if "model.bin"
was updated in between.
(2) Send "catboost_Evaluate" from the server to the bridge, containing
the model path and the features to run the interference on. Step (2)
is called multiple times (once per chunk) by the server from function
FunctionCatBoostEvaluate::executeImpl(). The library handler for the
given model path is expected to be already loaded by Step (1).
Fixes #27870
56 lines
1.4 KiB
C++
56 lines
1.4 KiB
C++
#pragma once
|
|
|
|
#include <Common/SharedLibrary.h>
|
|
#include <Common/logger_useful.h>
|
|
#include "ExternalDictionaryLibraryUtils.h"
|
|
|
|
|
|
namespace DB
|
|
{
|
|
|
|
/// A class that manages all operations with library dictionary.
|
|
/// Every library dictionary source has its own object of this class, accessed by UUID.
|
|
class ExternalDictionaryLibraryHandler
|
|
{
|
|
|
|
public:
|
|
ExternalDictionaryLibraryHandler(
|
|
const std::string & library_path_,
|
|
const std::vector<std::string> & library_settings,
|
|
const Block & sample_block_,
|
|
const std::vector<std::string> & attributes_names_);
|
|
|
|
ExternalDictionaryLibraryHandler(const ExternalDictionaryLibraryHandler & other);
|
|
|
|
ExternalDictionaryLibraryHandler & operator=(const ExternalDictionaryLibraryHandler & other) = delete;
|
|
|
|
~ExternalDictionaryLibraryHandler();
|
|
|
|
Block loadAll();
|
|
|
|
Block loadIds(const std::vector<uint64_t> & ids);
|
|
|
|
Block loadKeys(const Columns & key_columns);
|
|
|
|
bool isModified();
|
|
|
|
bool supportsSelectiveLoad();
|
|
|
|
const Block & getSampleBlock() { return sample_block; }
|
|
|
|
private:
|
|
Block dataToBlock(ExternalDictionaryLibraryAPI::RawClickHouseLibraryTable data);
|
|
|
|
std::string library_path;
|
|
const Block sample_block;
|
|
std::vector<std::string> attributes_names;
|
|
|
|
SharedLibraryPtr library;
|
|
std::shared_ptr<CStringsHolder> settings_holder;
|
|
void * lib_data;
|
|
};
|
|
|
|
using ExternalDictionaryLibraryHandlerPtr = std::shared_ptr<ExternalDictionaryLibraryHandler>;
|
|
|
|
}
|