tutorial_eltwiseadd_benchmark_seal.cpp

Go to the documentation of this file.

 
// Copyright (C) 2021 Intel Corporation
// SPDX-License-Identifier: Apache-2.0
 
 
#include <algorithm>
#include <array>
#include <cassert>
#include <cstring>
#include <memory>
#include <sstream>
#include <utility>
#include <vector>
 
#include "tutorial_eltwiseadd_benchmark_seal.h"
#include "tutorial_engine_seal.h"
#include "tutorial_error_seal.h"
 
//----------------------------------------------
// class TutorialEltwiseAddBenchmarkDescription
//----------------------------------------------
 
TutorialEltwiseAddBenchmarkDescription::TutorialEltwiseAddBenchmarkDescription()
{
    // initialize the descriptor for this benchmark
    std::memset(&m_descriptor, 0, sizeof(hebench::APIBridge::BenchmarkDescriptor));
 
    m_descriptor.workload = hebench::APIBridge::Workload::EltwiseAdd;
 
    m_descriptor.data_type = hebench::APIBridge::DataType::Int64;
 
    m_descriptor.category = hebench::APIBridge::Category::Offline;
 
    m_descriptor.cat_params.offline.data_count[0] = 2; // 2 data samples for op parameter 0
    m_descriptor.cat_params.offline.data_count[1] = 5; // 5 data samples for op parameter 1
 
    m_descriptor.cipher_param_mask = 1 << 1;
 
    //
    m_descriptor.scheme = HEBENCH_HE_SCHEME_BFV;
 
    m_descriptor.security = TUTORIAL_HE_SECURITY_128;
 
    m_descriptor.other = 0; // no extras needed for our purpose:
        // Other backends can use this field to differentiate between
        // benchmarks for which internal parameters, not specified by
        // other fields of this structure, differ.
 
    // specify default arguments for this workload flexible parameters:
    hebench::cpp::WorkloadParams::EltwiseAdd default_workload_params;
    default_workload_params.n() = 400;
    this->addDefaultParameters(default_workload_params);
}
 
TutorialEltwiseAddBenchmarkDescription::~TutorialEltwiseAddBenchmarkDescription()
{
    // nothing needed in this example
}
 
std::string TutorialEltwiseAddBenchmarkDescription::getBenchmarkDescription(const hebench::APIBridge::WorkloadParams *p_w_params) const
{
    std::stringstream ss;
    ss << BenchmarkDescription::getBenchmarkDescription(p_w_params);
    ss << ", Encryption parameters" << std::endl
       << ", , HE Library, Microsoft SEAL 3.6" << std::endl
       << ", , Poly modulus degree, " << PolyModulusDegree << std::endl
       << ", , Coefficient Moduli, 60, 60";
    if (p_w_params)
    {
        hebench::cpp::WorkloadParams::EltwiseAdd w_params(*p_w_params);
        ss << std::endl
           << ", Workload parameters" << std::endl
           << ", , n, " << w_params.n();
    } // end if
    return ss.str();
}
 
hebench::cpp::BaseBenchmark *TutorialEltwiseAddBenchmarkDescription::createBenchmark(hebench::cpp::BaseEngine &engine,
                                                                                     const hebench::APIBridge::WorkloadParams *p_params)
{
    if (!p_params)
        throw hebench::cpp::HEBenchError(HEBERROR_MSG_CLASS("Invalid empty workload parameters. This workload requires flexible parameters."),
                                         HEBENCH_ECODE_CRITICAL_ERROR);
 
    TutorialEngine &ex_engine = dynamic_cast<TutorialEngine &>(engine);
    return new TutorialEltwiseAddBenchmark(ex_engine, m_descriptor, *p_params);
}
 
void TutorialEltwiseAddBenchmarkDescription::destroyBenchmark(hebench::cpp::BaseBenchmark *p_bench)
{
    if (p_bench)
        delete p_bench;
}
 
//---------------------------------------------
// class TutorialEltwiseAddBenchmark::Workload
//---------------------------------------------
 
TutorialEltwiseAddBenchmark::Workload::SealBFVContext::SealBFVContext(int poly_modulus_degree)
{
    assert(TutorialEltwiseAddBenchmarkDescription::NumCoefficientModuli == 1);
 
    seal::EncryptionParameters parms{ seal::scheme_type::bfv };
    parms.set_poly_modulus_degree(poly_modulus_degree);
    parms.set_coeff_modulus(seal::CoeffModulus::Create(poly_modulus_degree, { 60, 60 }));
    parms.set_plain_modulus(seal::PlainModulus::Batching(poly_modulus_degree, 20));
    m_p_seal_context.reset(new seal::SEALContext(parms, true, seal::sec_level_type::tc128));
    m_p_keygen = std::make_unique<seal::KeyGenerator>(context());
 
    m_p_keygen->create_public_key(m_public_key);
    m_secret_key = m_p_keygen->secret_key();
 
    m_p_encryptor     = std::make_unique<seal::Encryptor>(context(), m_public_key);
    m_p_evaluator     = std::make_unique<seal::Evaluator>(context());
    m_p_decryptor     = std::make_unique<seal::Decryptor>(context(), m_secret_key);
    m_p_batch_encoder = std::make_unique<seal::BatchEncoder>(context());
}
 
TutorialEltwiseAddBenchmark::Workload::Workload(std::size_t vector_size)
{
    if (vector_size <= 0)
        throw std::invalid_argument("vector_size");
    m_vector_size = vector_size;
    m_p_context   = std::make_shared<SealBFVContext>(TutorialEltwiseAddBenchmarkDescription::PolyModulusDegree);
}
 
std::vector<seal::Plaintext> TutorialEltwiseAddBenchmark::Workload::encodeVector(const std::vector<std::vector<std::int64_t>> &vec)
{
    std::vector<gsl::span<const std::int64_t>> vec_span(vec.begin(), vec.end());
    return encodeVector(vec_span);
}
 
std::vector<seal::Plaintext> TutorialEltwiseAddBenchmark::Workload::encodeVector(const std::vector<gsl::span<const std::int64_t>> &vec)
{
    std::vector<seal::Plaintext> retval(vec.size());
 
    for (std::size_t i = 0; i < vec.size(); ++i)
    {
        assert(vec[i].size() <= context().encoder().slot_count());
        context().encoder().encode(vec[i], retval[i]);
    }
    return retval;
}
 
std::vector<seal::Ciphertext> TutorialEltwiseAddBenchmark::Workload::encryptVector(const std::vector<seal::Plaintext> &encoded_vec)
{
    std::vector<seal::Ciphertext> retval(encoded_vec.size());
    for (std::size_t i = 0; i < encoded_vec.size(); i++)
        context().encryptor().encrypt(encoded_vec[i], retval[i]);
    return retval;
}
 
std::vector<seal::Ciphertext> TutorialEltwiseAddBenchmark::Workload::eltwiseadd(const std::vector<seal::Plaintext> &A,
                                                                                const std::vector<seal::Ciphertext> &B)
{
    std::vector<seal::Ciphertext> retval(A.size() * B.size());
    for (std::size_t A_i = 0; A_i < A.size(); ++A_i)
        for (std::size_t B_i = 0; B_i < B.size(); ++B_i)
        {
            seal::Ciphertext &retval_item = retval[A_i * B.size() + B_i];
            context().evaluator().add_plain(B[B_i], A[A_i], retval_item);
        }
 
    return retval;
}
 
std::vector<seal::Plaintext> TutorialEltwiseAddBenchmark::Workload::decryptResult(const std::vector<seal::Ciphertext> &encrypted_result)
{
    std::vector<seal::Plaintext> retval(encrypted_result.size());
    for (std::size_t i = 0; i < encrypted_result.size(); i++)
        context().decryptor().decrypt(encrypted_result[i], retval[i]);
    return retval;
}
 
std::vector<std::vector<int64_t>> TutorialEltwiseAddBenchmark::Workload::decodeResult(const std::vector<seal::Plaintext> &encoded_result)
{
    std::vector<std::vector<int64_t>> retval(encoded_result.size());
    for (std::size_t i = 0; i < encoded_result.size(); ++i)
    {
        context().encoder().decode(encoded_result[i], retval[i]);
        retval[i].resize(m_vector_size);
    }
    return retval;
}
 
//-----------------------------------
// class TutorialEltwiseAddBenchmark
//-----------------------------------
 
TutorialEltwiseAddBenchmark::TutorialEltwiseAddBenchmark(hebench::cpp::BaseEngine &engine,
                                                         const hebench::APIBridge::BenchmarkDescriptor &bench_desc,
                                                         const hebench::APIBridge::WorkloadParams &bench_params) :
    hebench::cpp::BaseBenchmark(engine, bench_desc, bench_params)
{
    // validate workload parameters
 
    // number of workload parameters (1 for eltwise add: n)
    if (bench_params.count < TutorialEltwiseAddBenchmarkDescription::NumWorkloadParams)
        throw hebench::cpp::HEBenchError(HEBERROR_MSG_CLASS("Invalid workload parameters. This workload requires "
                                                            + std::to_string(TutorialEltwiseAddBenchmarkDescription::NumWorkloadParams)
                                                            + "parameters."),
                                         HEBENCH_ECODE_INVALID_ARGS);
 
    // check values of the workload parameters and make sure they are supported by benchmark:
    hebench::cpp::WorkloadParams::EltwiseAdd w_params(bench_params);
    if (w_params.n() <= 0
        || w_params.n() - 1 > TutorialEltwiseAddBenchmarkDescription::PolyModulusDegree / 2)
        throw hebench::cpp::HEBenchError(HEBERROR_MSG_CLASS("Invalid workload parameters. This workload only supports vectors of size up to "
                                                            + std::to_string(TutorialEltwiseAddBenchmarkDescription::PolyModulusDegree / 2)),
                                         HEBENCH_ECODE_INVALID_ARGS);
 
    // Do any extra workload-parameter-based initialization here, if needed.
 
    // initialize original Workload (this initializes SEAL BFV context)
    m_p_workload = std::make_shared<Workload>(w_params.n());
}
 
TutorialEltwiseAddBenchmark::~TutorialEltwiseAddBenchmark()
{
    m_p_workload.reset(); // added for clarity
}
 
hebench::APIBridge::Handle TutorialEltwiseAddBenchmark::encode(const hebench::APIBridge::DataPackCollection *p_parameters)
{
    assert(p_parameters && p_parameters->pack_count > 0 && p_parameters->p_data_packs);
 
    assert(p_parameters->pack_count == 1);
 
    const hebench::APIBridge::DataPack &param_pack = p_parameters->p_data_packs[0];
 
    if (param_pack.buffer_count != this->getDescriptor().cat_params.offline.data_count[param_pack.param_position])
    {
        std::stringstream ss;
        ss << "Unexpected number of input samples for operation parameter " << param_pack.param_position
           << ". Expected " << this->getDescriptor().cat_params.offline.data_count[param_pack.param_position]
           << ", but " << std::to_string(param_pack.buffer_count) << " received.";
        throw hebench::cpp::HEBenchError(HEBERROR_MSG_CLASS(ss.str()));
    }
 
    hebench::cpp::WorkloadParams::EltwiseAdd w_params(this->getWorkloadParameters());
    std::vector<gsl::span<const std::int64_t>> clear_param(param_pack.buffer_count);
    for (std::size_t sample_i = 0; sample_i < clear_param.size(); ++sample_i)
    {
        const hebench::APIBridge::NativeDataBuffer &native_sample = param_pack.p_buffers[sample_i];
        clear_param[sample_i] =
            gsl::span<const std::int64_t>(reinterpret_cast<const std::int64_t *>(native_sample.p),
                                          native_sample.size / sizeof(std::int64_t));
        assert(clear_param[sample_i].size() == w_params.n());
    }
 
    std::vector<seal::Plaintext> encoded = m_p_workload->encodeVector(clear_param);
    InternalParam<seal::Plaintext> retval;
    retval.samples        = std::move(encoded);
    retval.param_position = param_pack.param_position;
    retval.tag            = InternalParamInfo::tagPlaintext;
 
    return this->getEngine().createHandle<decltype(retval)>(
        sizeof(seal::Plaintext) * retval.samples.size(), // size (arbitrary for our usage if we need to)
        retval.tag, // extra tags
        std::move(retval)); // constructor parameters
}
 
void TutorialEltwiseAddBenchmark::decode(hebench::APIBridge::Handle h_encoded_data,
                                         hebench::APIBridge::DataPackCollection *p_native)
{
    assert(p_native && p_native->p_data_packs && p_native->pack_count > 0);
 
    const InternalParam<seal::Plaintext> &encoded_data =
        this->getEngine().retrieveFromHandle<InternalParam<seal::Plaintext>>(h_encoded_data, InternalParamInfo::tagPlaintext);
 
    std::vector<std::vector<std::int64_t>> clear_result = m_p_workload->decodeResult(encoded_data.samples);
 
    hebench::APIBridge::DataPack &native_datapack = this->findDataPack(*p_native, encoded_data.param_position);
 
    std::uint64_t min_sample_count = std::min(native_datapack.buffer_count, clear_result.size());
    for (std::uint64_t sample_i = 0; sample_i < min_sample_count; ++sample_i)
    {
        // alias the samples
        hebench::APIBridge::NativeDataBuffer &native_sample = native_datapack.p_buffers[sample_i];
        // copy as much as possible
        const std::vector<std::int64_t> &decoded = clear_result[sample_i];
        std::uint64_t min_size                   = std::min(decoded.size(), native_sample.size / sizeof(std::int64_t));
        std::copy_n(decoded.begin(), min_size,
                    reinterpret_cast<std::int64_t *>(native_sample.p));
    }
}
 
hebench::APIBridge::Handle TutorialEltwiseAddBenchmark::encrypt(hebench::APIBridge::Handle h_encoded_parameters)
{
    const InternalParam<seal::Plaintext> &encoded_parameter =
        this->getEngine().retrieveFromHandle<InternalParam<seal::Plaintext>>(h_encoded_parameters,
                                                                             InternalParamInfo::tagPlaintext);
 
    std::vector<seal::Ciphertext> encrypted = m_p_workload->encryptVector(encoded_parameter.samples);
 
    InternalParam<seal::Ciphertext> retval;
    retval.samples        = std::move(encrypted);
    retval.param_position = encoded_parameter.param_position;
    retval.tag            = InternalParamInfo::tagCiphertext;
 
    return this->getEngine().createHandle<decltype(retval)>(
        sizeof(seal::Ciphertext) * retval.samples.size(), // size (arbitrary for our usage if we need to)
        retval.tag, // extra tags
        std::move(retval)); // constructor parameters
}
 
hebench::APIBridge::Handle TutorialEltwiseAddBenchmark::decrypt(hebench::APIBridge::Handle h_encrypted_data)
{
    const InternalParam<seal::Ciphertext> &encrypted_data =
        this->getEngine().retrieveFromHandle<InternalParam<seal::Ciphertext>>(h_encrypted_data, InternalParamInfo::tagCiphertext);
 
    assert(encrypted_data.param_position == 0);
 
    std::vector<seal::Plaintext> encoded_data_samples = m_p_workload->decryptResult(encrypted_data.samples);
 
    InternalParam<seal::Plaintext> retval;
    retval.samples        = std::move(encoded_data_samples);
    retval.param_position = encrypted_data.param_position;
    retval.tag            = InternalParamInfo::tagPlaintext;
 
    return this->getEngine().createHandle<decltype(retval)>(
        sizeof(seal::Plaintext) * retval.samples.size(), // size (arbitrary for our usage if we need to)
        retval.tag, // extra tags
        std::move(retval)); // move to avoid copy
}
 
hebench::APIBridge::Handle TutorialEltwiseAddBenchmark::load(const hebench::APIBridge::Handle *p_local_data, uint64_t count)
{
    assert(count == TutorialEltwiseAddBenchmarkDescription::ParametersCount);
 
    std::pair<std::vector<seal::Plaintext>, std::vector<seal::Ciphertext>> params;
 
    // We query for the parameter position, and, once found, we create a copy of the data.
    for (std::size_t handle_i = 0; handle_i < count; ++handle_i)
    {
        // both our InternalParam<Plaintext> and InternalParam<Ciphertext> inherit from InternalParamInfo
        const InternalParamInfo &param_info =
            this->getEngine().retrieveFromHandle<InternalParamInfo>(p_local_data[handle_i]);
        assert(param_info.param_position < TutorialEltwiseAddBenchmarkDescription::ParametersCount);
 
        switch (param_info.param_position)
        {
        case 0:
        {
            if (!params.first.empty())
                throw hebench::cpp::HEBenchError(HEBERROR_MSG_CLASS("Duplicated operation parameter detected in input handle."),
                                                 HEBENCH_ECODE_INVALID_ARGS);
            // specialize to the correct InternalParam<?>
            const InternalParam<seal::Plaintext> &internal_param =
                this->getEngine().retrieveFromHandle<InternalParam<seal::Plaintext>>(p_local_data[handle_i],
                                                                                     InternalParamInfo::tagPlaintext);
            // create a deep copy of input
            params.first = internal_param.samples;
            break;
        }
        case 1:
        {
            if (!params.second.empty())
                throw hebench::cpp::HEBenchError(HEBERROR_MSG_CLASS("Duplicated operation parameter detected in input handle."),
                                                 HEBENCH_ECODE_INVALID_ARGS);
            // specialize to the correct InternalParam<?>
            const InternalParam<seal::Ciphertext> &internal_param =
                this->getEngine().retrieveFromHandle<InternalParam<seal::Ciphertext>>(p_local_data[handle_i],
                                                                                      InternalParamInfo::tagCiphertext);
            // create a deep copy of input
            params.second = internal_param.samples;
            break;
        }
        } // end switch
    } // end for
 
    return this->getEngine().createHandle<decltype(params)>(
        sizeof(params), // size (arbitrary for our usage if we need to)
        InternalParamInfo::tagPlaintext | InternalParamInfo::tagCiphertext, // extra tags
        std::move(params)); // move to avoid extra copy
}
 
void TutorialEltwiseAddBenchmark::store(hebench::APIBridge::Handle h_remote_data,
                                        hebench::APIBridge::Handle *p_local_data, std::uint64_t count)
{
    if (count > 0)
    {
        std::memset(p_local_data, 0, sizeof(hebench::APIBridge::Handle) * count);
 
        p_local_data[0] = this->getEngine().duplicateHandle(h_remote_data,
                                                            InternalParamInfo::tagCiphertext); // validate that we are operating on the correct handle
    }
}
 
hebench::APIBridge::Handle TutorialEltwiseAddBenchmark::operate(hebench::APIBridge::Handle h_remote_packed,
                                                                const hebench::APIBridge::ParameterIndexer *p_param_indexers)
{
    const std::pair<std::vector<seal::Plaintext>, std::vector<seal::Ciphertext>> &params =
        this->getEngine().retrieveFromHandle<std::pair<std::vector<seal::Plaintext>, std::vector<seal::Ciphertext>>>(
            h_remote_packed, InternalParamInfo::tagCiphertext | InternalParamInfo::tagPlaintext);
 
    // Looks familiar?
    const std::vector<seal::Plaintext> &A  = params.first;
    const std::vector<seal::Ciphertext> &B = params.second;
 
    std::array<std::size_t, TutorialEltwiseAddBenchmarkDescription::ParametersCount> param_size;
    param_size[0]               = A.size();
    param_size[1]               = B.size();
    std::uint64_t results_count = 1;
    for (std::size_t param_i = 0; param_i < TutorialEltwiseAddBenchmarkDescription::ParametersCount; ++param_i)
    {
        if (p_param_indexers[param_i].value_index >= param_size[param_i])
        {
            std::stringstream ss;
            ss << "Invalid parameter indexer for operation parameter " << param_i << ". Expected index in range [0, "
               << param_size[param_i] << "), but " << p_param_indexers[param_i].value_index << " received.";
            throw hebench::cpp::HEBenchError(HEBERROR_MSG_CLASS(ss.str()),
                                             HEBENCH_ECODE_INVALID_ARGS);
        }
        else if (p_param_indexers[param_i].value_index + p_param_indexers[param_i].batch_size > param_size[param_i])
        {
            std::stringstream ss;
            ss << "Invalid parameter indexer for operation parameter " << param_i << ". Expected batch size in range [1, "
               << param_size[param_i] - p_param_indexers[param_i].value_index << "], but " << p_param_indexers[param_i].batch_size << " received.";
            throw hebench::cpp::HEBenchError(HEBERROR_MSG_CLASS(ss.str()),
                                             HEBENCH_ECODE_INVALID_ARGS);
        }
        results_count *= p_param_indexers[param_i].batch_size; // count the number of results expected
    }
 
    std::vector<seal::Ciphertext> result = m_p_workload->eltwiseadd(A, B);
    assert(result.size() == results_count);
 
    // Finally, we wrap the result in our internal representation.
    InternalParam<seal::Ciphertext> retval;
    retval.samples        = std::move(result);
    retval.param_position = 0; // position of this result component inside the result tuple.
    retval.tag            = InternalParamInfo::tagCiphertext;
 
    // Hide our representation inside an opaque handle to cross the boundary of the API Bridge.
    // This handle will be passed to method `store()` in the default pipeline.
    return this->getEngine().createHandle<decltype(retval)>(
        sizeof(seal::Ciphertext) * retval.samples.size(), // size (arbitrary for our usage if we need to)
        retval.tag, // extra tags
        std::move(retval)); // move to avoid extra copies
}