Skip to content

Avoid calling new and delete explicitly in QATJob #43

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
asonje merged 2 commits into from
Nov 11, 2025
Merged

Avoid calling new and delete explicitly in QATJob #43

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ac5c795
Avoid calling new and delete explicitly.
mulugetam Oct 27, 2025
f395223
Merge branch 'main' into qat_avoid_raw_pointers
asonje Nov 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
106 changes: 46 additions & 60 deletions qat.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,33 +10,54 @@
using namespace config;

#ifdef USE_QAT
#include <iostream>

void QATJob::QzSessionDeleter::operator()(QzSession_T *qzSession) const {
if (!qzSession) {
return;
}

int rc = qzTeardownSession(qzSession);
if (rc != QZ_OK) {
Log(LogLevel::LOG_ERROR,
"qzTeardownSession() Line %d session %p returned %d\n", __LINE__,
qzSession, rc);
}

// Attempt to close the session
rc = qzClose(qzSession);
if (rc != QZ_OK) {
Log(LogLevel::LOG_ERROR, "qzClose() Line %d session %p returned %d\n",
__LINE__, qzSession, rc);
}

delete qzSession;
}

QzSession_T *QATJob::GetQATSession(int window_bits, bool gzip_ext) {
CompressedFormat format = GetCompressedFormat(window_bits);
switch (format) {
case CompressedFormat::DEFLATE_RAW:
if (qzSession_deflate_raw == nullptr) {
Init(&qzSession_deflate_raw, format);
Init(qzSession_deflate_raw, format);
}
return qzSession_deflate_raw;
return qzSession_deflate_raw.get();
case CompressedFormat::ZLIB:
if (qzSession_zlib == nullptr) {
Init(&qzSession_zlib,
Init(qzSession_zlib,
format); // we do not have zlib format in public enum of qatzip
}
return qzSession_zlib;
return qzSession_zlib.get();
case CompressedFormat::GZIP:
if (gzip_ext) {
if (qzSession_gzip_ext == nullptr) {
Init(&qzSession_gzip_ext, format, true);
Init(qzSession_gzip_ext, format, true);
}
return qzSession_gzip_ext;
return qzSession_gzip_ext.get();
} else {
if (qzSession_gzip == nullptr) {
Init(&qzSession_gzip, format);
Init(qzSession_gzip, format);
}
return qzSession_gzip;
return qzSession_gzip.get();
}
case CompressedFormat::INVALID:
return nullptr;
Expand All @@ -48,47 +69,42 @@ void QATJob::CloseQATSession(int window_bits, bool gzip_ext) {
CompressedFormat format = GetCompressedFormat(window_bits);
switch (format) {
case CompressedFormat::DEFLATE_RAW:
Close(qzSession_deflate_raw);
qzSession_deflate_raw = nullptr;
qzSession_deflate_raw.reset();
break;
case CompressedFormat::ZLIB:
Close(qzSession_zlib);
qzSession_zlib = nullptr;
qzSession_zlib.reset();
break;
case CompressedFormat::GZIP:
if (gzip_ext) {
Close(qzSession_gzip_ext);
qzSession_gzip_ext = nullptr;
qzSession_gzip_ext.reset();
} else {
Close(qzSession_gzip);
qzSession_gzip = nullptr;
qzSession_gzip.reset();
}
break;
default:
break;
}
}

void QATJob::Init(QzSession_T **qzSession, CompressedFormat format,
void QATJob::Init(QzSessionPtr &qzSession, CompressedFormat format,
bool gzip_ext) {
QzSessionPtr session = nullptr;
try {
*qzSession = new QzSession_T;
memset(*qzSession, 0, sizeof(QzSession_T));
session = QzSessionPtr(new QzSession_T());
memset(session.get(), 0, sizeof(QzSession_T));
} catch (std::bad_alloc &e) {
*qzSession = nullptr;
return;
}

// Initialize QAT hardware
int status = qzInit(*qzSession, 0);
int status = qzInit(session.get(), 0);
if (status != QZ_OK && status != QZ_DUPLICATE) {
Log(LogLevel::LOG_ERROR, "qzInit() failure Line ", __LINE__, " session ",
static_cast<void *>(*qzSession), " returned ", status, "\n");
delete *qzSession;
*qzSession = nullptr;
static_cast<void *>(session.get()), " returned ", status, "\n");
return;
} else {
Log(LogLevel::LOG_INFO, "qzInit() success Line ", __LINE__, " session ",
static_cast<void *>(*qzSession), " returned ", status, "\n");
static_cast<void *>(session.get()), " returned ", status, "\n");
}

QzSessionParamsDeflateExt_T deflateExt = {{}, 0, 0};
Expand Down Expand Up @@ -134,46 +150,16 @@ void QATJob::Init(QzSession_T **qzSession, CompressedFormat format,
deflateExt.deflate_params.data_fmt = QZ_FMT_NUM;
break;
}
status = qzSetupSessionDeflateExt(*qzSession, &deflateExt);
status = qzSetupSessionDeflateExt(session.get(), &deflateExt);
if (status != QZ_OK) {
Log(LogLevel::LOG_ERROR, "qzSetupSessionDeflateExt() Line ", __LINE__,
" session ", static_cast<void *>(*qzSession), " returned ", status,
" session ", static_cast<void *>(session.get()), " returned ", status,
"\n");
Close();
return;
}
}

void QATJob::Close() {
Close(qzSession_deflate_raw);
qzSession_deflate_raw = nullptr;
Close(qzSession_zlib);
qzSession_zlib = nullptr;
Close(qzSession_gzip);
qzSession_gzip = nullptr;
Close(qzSession_gzip_ext);
qzSession_gzip_ext = nullptr;
}

void QATJob::Close(QzSession_T *qzSession) {
if (!qzSession) {
return;
}

int rc = qzTeardownSession(qzSession);
if (rc != QZ_OK) {
Log(LogLevel::LOG_ERROR, "qzTeardownSession() Line ", __LINE__, " session ",
static_cast<void *>(qzSession), " returned ", rc, "\n");
}

// Attempt to close the session
rc = qzClose(qzSession);
if (rc != QZ_OK) {
Log(LogLevel::LOG_ERROR, "qzClose() Line ", __LINE__, " session ",
static_cast<void *>(qzSession), " returned ", rc, "\n");
}

delete qzSession;
// Transfer ownership to qzSession
qzSession = std::move(session);
}

static thread_local QATJob qat_job_;
Expand Down
23 changes: 13 additions & 10 deletions qat.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,29 +8,32 @@

#include <qatzip.h>

#include <cstdio>
#include <memory>

#include "utils.h"

#define QAT_HW_BUFF_SZ QZ_HW_BUFF_MAX_SZ
inline constexpr unsigned int QAT_HW_BUFF_SZ = QZ_HW_BUFF_MAX_SZ;

class QATJob {
public:
QATJob() {}
~QATJob() { Close(); }
QzSession_T* GetQATSession(int window_bits, bool gzip_ext);
void CloseQATSession(int window_bits, bool gzip_ext);

private:
void Init(QzSession_T** qzSession, CompressedFormat format,
struct QzSessionDeleter {
void operator()(QzSession_T* session) const;
};

using QzSessionPtr = std::unique_ptr<QzSession_T, QzSessionDeleter>;

void Init(QzSessionPtr& qzSession, CompressedFormat format,
bool gzip_ext = false);
void Close();
void Close(QzSession_T* qzSession);

QzSession_T* qzSession_deflate_raw = nullptr;
QzSession_T* qzSession_gzip = nullptr;
QzSession_T* qzSession_gzip_ext = nullptr;
QzSession_T* qzSession_zlib = nullptr;
QzSessionPtr qzSession_deflate_raw;
QzSessionPtr qzSession_gzip;
QzSessionPtr qzSession_gzip_ext;
QzSessionPtr qzSession_zlib;
};

int CompressQAT(uint8_t* input, uint32_t* input_length, uint8_t* output,
Expand Down