forked from ClickHouse/arrow
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add Intel®-IAA/QPL-based Parquet RLE Decode, qpl is thirdparty tool c…
…hain
- Loading branch information
Showing
14 changed files
with
821 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,120 @@ | ||
// Licensed to the Apache Software Foundation (ASF) under one | ||
// or more contributor license agreements. See the NOTICE file | ||
// distributed with this work for additional information | ||
// regarding copyright ownership. The ASF licenses this file | ||
// to you under the Apache License, Version 2.0 (the | ||
// "License"); you may not use this file except in compliance | ||
// with the License. You may obtain a copy of the License at | ||
// | ||
// http://www.apache.org/licenses/LICENSE-2.0 | ||
// | ||
// Unless required by applicable law or agreed to in writing, | ||
// software distributed under the License is distributed on an | ||
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
// KIND, either express or implied. See the License for the | ||
// specific language governing permissions and limitations | ||
// under the License. | ||
|
||
#include <arrow/status.h> | ||
|
||
#ifdef ENABLE_QPL_ANALYSIS | ||
#include "arrow/util/qpl_job_pool.h" | ||
|
||
namespace arrow { | ||
namespace internal { | ||
namespace detail { | ||
|
||
std::array<qpl_job *, QplJobHWPool::MAX_JOB_NUMBER> QplJobHWPool::hw_job_ptr_pool; | ||
std::array<std::atomic_bool, QplJobHWPool::MAX_JOB_NUMBER> QplJobHWPool::job_ptr_locks; | ||
bool QplJobHWPool::job_pool_ready = false; | ||
std::unique_ptr<uint8_t[]> QplJobHWPool::hw_jobs_buffer; | ||
|
||
QplJobHWPool & QplJobHWPool::instance() { | ||
static QplJobHWPool pool; | ||
return pool; | ||
} | ||
|
||
QplJobHWPool::QplJobHWPool() | ||
: random_engine(std::random_device()()) | ||
, distribution(0, MAX_JOB_NUMBER - 1) { | ||
(void)initQPLJob(); | ||
} | ||
|
||
QplJobHWPool::~QplJobHWPool() { | ||
for (uint32_t i = 0; i < MAX_JOB_NUMBER; ++i) { | ||
if (hw_job_ptr_pool[i]) { | ||
qpl_fini_job(hw_job_ptr_pool[i]); | ||
hw_job_ptr_pool[i] = nullptr; | ||
} | ||
} | ||
job_pool_ready = false; | ||
} | ||
|
||
arrow::Status QplJobHWPool::initQPLJob() { | ||
uint32_t job_size = 0; | ||
|
||
/// Get size required for saving a single qpl job object | ||
qpl_get_job_size(qpl_path_hardware, &job_size); | ||
/// Allocate entire buffer for storing all job objects | ||
hw_jobs_buffer = std::make_unique<uint8_t[]>(job_size * MAX_JOB_NUMBER); | ||
/// Initialize pool for storing all job object pointers | ||
/// Reallocate buffer by shifting address offset for each job object. | ||
for (uint32_t index = 0; index < MAX_JOB_NUMBER; ++index) { | ||
qpl_job * qpl_job_ptr = reinterpret_cast<qpl_job *>(hw_jobs_buffer.get() + index * job_size); | ||
if (qpl_init_job(qpl_path_hardware, qpl_job_ptr) != QPL_STS_OK) { | ||
job_pool_ready = false; | ||
return arrow::Status::Invalid("Initialization of hardware IAA failed. Please check if Intel In-Memory Analytics Accelerator (IAA) is properly set up!"); | ||
} | ||
hw_job_ptr_pool[index] = qpl_job_ptr; | ||
unLockJob(index); | ||
} | ||
|
||
job_pool_ready = true; | ||
return arrow::Status::OK(); | ||
} | ||
|
||
qpl_job * QplJobHWPool::acquireJob(uint32_t & job_id) { | ||
if (!isJobPoolReady() && !initQPLJob().ok()) { | ||
return nullptr; | ||
} | ||
|
||
uint32_t retry = 0; | ||
auto index = distribution(random_engine); | ||
while (!tryLockJob(index)) { | ||
index = distribution(random_engine); | ||
retry++; | ||
if (retry > MAX_JOB_NUMBER) { | ||
return nullptr; | ||
} | ||
} | ||
job_id = MAX_JOB_NUMBER - index; | ||
if (index >= MAX_JOB_NUMBER) { | ||
return nullptr; | ||
} | ||
return hw_job_ptr_pool[index]; | ||
} | ||
|
||
void QplJobHWPool::releaseJob(uint32_t job_id) { | ||
if (isJobPoolReady()) { | ||
unLockJob(MAX_JOB_NUMBER - job_id); | ||
} | ||
} | ||
|
||
bool QplJobHWPool::tryLockJob(uint32_t index) { | ||
bool expected = false; | ||
if (index >= MAX_JOB_NUMBER) { | ||
return false; | ||
} | ||
return job_ptr_locks[index].compare_exchange_strong(expected, true); | ||
} | ||
|
||
void QplJobHWPool::unLockJob(uint32_t index) { | ||
if (index >= MAX_JOB_NUMBER) { | ||
return; | ||
} | ||
job_ptr_locks[index].store(false); | ||
} | ||
} // namespace detail | ||
} // namespace internal | ||
} // namespace arrow | ||
#endif |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,70 @@ | ||
// Licensed to the Apache Software Foundation (ASF) under one | ||
// or more contributor license agreements. See the NOTICE file | ||
// distributed with this work for additional information | ||
// regarding copyright ownership. The ASF licenses this file | ||
// to you under the Apache License, Version 2.0 (the | ||
// "License"); you may not use this file except in compliance | ||
// with the License. You may obtain a copy of the License at | ||
// | ||
// http://www.apache.org/licenses/LICENSE-2.0 | ||
// | ||
// Unless required by applicable law or agreed to in writing, | ||
// software distributed under the License is distributed on an | ||
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
// KIND, either express or implied. See the License for the | ||
// specific language governing permissions and limitations | ||
// under the License. | ||
|
||
#pragma once | ||
|
||
#include <cstdint> | ||
#include <memory> | ||
#include <utility> | ||
#include <vector> | ||
#include <random> | ||
#include <arrow/status.h> | ||
|
||
#ifdef ENABLE_QPL_ANALYSIS | ||
#include <qpl/qpl.hpp> | ||
#include <qpl/qpl.h> | ||
|
||
|
||
namespace arrow { | ||
namespace internal { | ||
namespace detail { | ||
|
||
/// QplJobHWPool is resource pool to provide the job objects. | ||
/// Job object is used for storing context information during | ||
// offloading compression job to HW Accelerator. | ||
class QplJobHWPool { | ||
public: | ||
QplJobHWPool(); | ||
~QplJobHWPool(); | ||
|
||
static QplJobHWPool & instance(); | ||
|
||
qpl_job * acquireJob(uint32_t & job_id); | ||
static void releaseJob(uint32_t job_id); | ||
static const bool & isJobPoolReady() { return job_pool_ready; } | ||
|
||
private: | ||
static bool tryLockJob(uint32_t index); | ||
static void unLockJob(uint32_t index); | ||
static arrow::Status initQPLJob(); | ||
|
||
/// Maximum jobs running in parallel supported by IAA hardware | ||
static constexpr auto MAX_JOB_NUMBER = 512; | ||
/// Entire buffer for storing all job objects | ||
static std::unique_ptr<uint8_t[]> hw_jobs_buffer; | ||
/// Job pool for storing all job object pointers | ||
static std::array<qpl_job *, MAX_JOB_NUMBER> hw_job_ptr_pool; | ||
/// Locks for accessing each job object pointers | ||
static std::array<std::atomic_bool, MAX_JOB_NUMBER> job_ptr_locks; | ||
static bool job_pool_ready; | ||
std::mt19937 random_engine; | ||
std::uniform_int_distribution<int> distribution; | ||
}; | ||
} // namespace detail | ||
} // namespace internal | ||
} // namespace arrow | ||
#endif |
Oops, something went wrong.