HEBench
api.h File Reference
#include "types.h"
Include dependency graph for api.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Namespaces

 hebench
 
 hebench::APIBridge
 

Functions

ErrorCode hebench::APIBridge::destroyHandle (Handle h)
 Releases resources held by the specified handle. More...
 
ErrorCode hebench::APIBridge::initEngine (Handle *h_engine, const int8_t *p_buffer, uint64_t size)
 Initializes the backend engine. More...
 
ErrorCode hebench::APIBridge::subscribeBenchmarksCount (Handle h_engine, std::uint64_t *p_count)
 Retrieves the number of benchmarks for which the backend is registering to perform. More...
 
ErrorCode hebench::APIBridge::subscribeBenchmarks (Handle h_engine, Handle *p_h_bench_descs, std::uint64_t count)
 Retrieves handles to the benchmark descriptions for which the backend is registering to perform. More...
 
ErrorCode hebench::APIBridge::getWorkloadParamsDetails (Handle h_engine, Handle h_bench_desc, std::uint64_t *p_param_count, std::uint64_t *p_default_count)
 Retrieves details about the flexible parameters supported by this workload. More...
 
ErrorCode hebench::APIBridge::describeBenchmark (Handle h_engine, Handle h_bench_desc, BenchmarkDescriptor *p_bench_desc, WorkloadParams *p_default_params, std::uint64_t default_count)
 Retrieves the concrete description for a benchmark registered by backend. More...
 
ErrorCode hebench::APIBridge::createBenchmark (Handle h_engine, Handle h_bench_desc, const WorkloadParams *p_params, Handle *h_benchmark)
 Instantiates a benchmark on the backend. More...
 
ErrorCode hebench::APIBridge::initBenchmark (Handle h_benchmark, const BenchmarkDescriptor *p_concrete_desc)
 Allows the benchmark to perform initialization steps based on the finalized, concrete description. More...
 
ErrorCode hebench::APIBridge::encode (Handle h_benchmark, const DataPackCollection *p_parameters, Handle *h_plaintext)
 Given a pack of parameters in raw, native data format, encodes them into plain text suitable for backend encryption or operation. More...
 
ErrorCode hebench::APIBridge::decode (Handle h_benchmark, Handle h_plaintext, DataPackCollection *p_native)
 Decodes plaintext data into the appropriate raw, native format. More...
 
ErrorCode hebench::APIBridge::encrypt (Handle h_benchmark, Handle h_plaintext, Handle *h_ciphertext)
 Encrypts a plain text into a cipher text. More...
 
ErrorCode hebench::APIBridge::decrypt (Handle h_benchmark, Handle h_ciphertext, Handle *h_plaintext)
 Decrypts a cipher text into corresponding plain text. More...
 
ErrorCode hebench::APIBridge::load (Handle h_benchmark, const Handle *h_local_packed_params, std::uint64_t local_count, Handle *h_remote)
 Loads the specified data from the local host into the remote backend to use as parameter during a call to operate(). More...
 
ErrorCode hebench::APIBridge::store (Handle h_benchmark, Handle h_remote, Handle *h_local_packed_params, std::uint64_t local_count)
 Retrieves the specified data from the backend. More...
 
ErrorCode hebench::APIBridge::operate (Handle h_benchmark, Handle h_remote_packed_params, const ParameterIndexer *p_param_indexers, uint64_t indexers_count, Handle *h_remote_output)
 Performs the workload operation of the benchmark. More...
 
std::uint64_t hebench::APIBridge::getSchemeName (Handle h_engine, Scheme s, char *p_name, std::uint64_t size)
 Retrieves the name of a specified scheme ID from the backend. More...
 
std::uint64_t hebench::APIBridge::getSchemeSecurityName (Handle h_engine, Scheme s, Security sec, char *p_name, std::uint64_t size)
 Retrieves the name of the specified security for the scheme ID from the backend. More...
 
std::uint64_t hebench::APIBridge::getBenchmarkDescriptionEx (Handle h_engine, Handle h_bench_desc, const hebench::APIBridge::WorkloadParams *p_w_params, char *p_description, std::uint64_t size)
 Retrieves backend specific text description for a benchmark descriptor. More...
 
std::uint64_t hebench::APIBridge::getErrorDescription (Handle h_engine, ErrorCode code, char *p_description, std::uint64_t size)
 Retrieves the general error description of an error code. More...
 
std::uint64_t hebench::APIBridge::getLastErrorDescription (Handle h_engine, char *p_description, std::uint64_t size)
 Retrieves the detailed description of the last error that occurred during an operation on the engine. More...