Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -212,9 +212,10 @@ ignore_zlib_dictionary
- If set to 0, zlib-accel honors inflateSetDictionary and deflateSetDictionary.

log_level
- Values: 0,1,2. Default 2
- Values: 0,1,2,3. Default: 1
- This option applies only if the shim is built with DEBUG_LOG=ON.
- If 1, error and info log messages are shown. If 2, only error log messages are shown. If 0, no log messages are shown.
- Matches QATzip's verbosity convention: 0 = silent, 1 = errors only, 2 = info and errors, 3 = debug, info, and errors (most verbose).
- Migration note: the numeric meanings changed from earlier versions. Older configurations that used `log_level=2` for error-only output must now use `log_level=1`. Review existing `log_level` settings when upgrading.

log_stats_samples
- Values: 0-INT_MAX. Default 1000
Expand Down
4 changes: 2 additions & 2 deletions config/config.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ uint32_t configs[CONFIG_MAX] = {
1, /*qat_compression_level*/
0, /*qat_compression_allow_chunking*/
0, /*ignore_zlib_dictionary*/
2, /*log_level*/
1, /*log_level*/
1000 /*log_stats_samples*/
};

Expand Down Expand Up @@ -85,7 +85,7 @@ bool LoadConfigFile(std::string& file_content, const char* file_path) {
trySetConfig(QAT_COMPRESSION_LEVEL, 9, 1);
trySetConfig(QAT_COMPRESSION_ALLOW_CHUNKING, 1, 0);
trySetConfig(IGNORE_ZLIB_DICTIONARY, 1, 0);
trySetConfig(LOG_LEVEL, 2, 0);
trySetConfig(LOG_LEVEL, 3, 0);
trySetConfig(LOG_STATS_SAMPLES, UINT32_MAX, 0);

config_reader.GetValue("log_file", log_file);
Expand Down
2 changes: 1 addition & 1 deletion config/default_config
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,5 @@ qat_periodical_polling = 0
qat_compression_level = 1
qat_compression_allow_chunking = 0
ignore_zlib_dictionary = 0
log_level = 2
log_level = 1
log_file = /tmp/zlib-accel.log
16 changes: 13 additions & 3 deletions logging.h
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,14 @@

using namespace config;

enum class LogLevel { LOG_NONE = 0, LOG_INFO = 1, LOG_ERROR = 2 };
// Log verbosity levels. 0 = silent; higher values = more verbose.
// Matches QATzip's QzLogLevel_T convention.
enum class LogLevel {
LOG_NONE = 0,
LOG_ERROR = 1,
LOG_INFO = 2,
LOG_DEBUG = 3
};
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

enum class LogLevel { LOG_DEBUG = 0, LOG_INFO, LOG_ERROR, LOG_NONE}; or enum class LogLevel {LOG_NONE = 0, LOG_ERROR, LOG_INFO, LOG_DEBUG}; I think QatZip uses the later.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The levels are now in ascending order of verbosity


#if defined(DEBUG_LOG) || defined(ENABLE_STATISTICS)

Expand Down Expand Up @@ -56,7 +63,7 @@ inline void Log(LogLevel level, Args&&... args) {
return;
}

if (static_cast<uint32_t>(level) < current_level) {
if (static_cast<uint32_t>(level) > current_level) {
return;
}

Expand All @@ -69,6 +76,9 @@ inline void Log(LogLevel level, Args&&... args) {
case LogLevel::LOG_INFO:
stream << "Info: ";
break;
case LogLevel::LOG_DEBUG:
stream << "Debug: ";
break;
case LogLevel::LOG_NONE:
return;
}
Expand Down Expand Up @@ -105,7 +115,7 @@ inline void PrintDeflateBlockHeader(LogLevel level, uint8_t* data, uint32_t len,
return;
}

if (static_cast<uint32_t>(level) < current_level) {
if (static_cast<uint32_t>(level) > current_level) {
return;
}

Expand Down
32 changes: 31 additions & 1 deletion qat.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -99,8 +99,38 @@ void QATJob::Init(QzSessionPtr &qzSession, CompressedFormat format,
return;
}

// Map zlib-accel log level to QATzip log level.
// qzSetLogLevel is a QATzip global; call it once per process regardless
// of how many QAT sessions are created.
static std::once_flag qz_log_level_flag;
std::call_once(qz_log_level_flag, []() {
QzLogLevel_T qzLogLevel = LOG_NONE;
#ifdef DEBUG_LOG
LogLevel logLevel =
static_cast<LogLevel>(config::GetConfig(config::LOG_LEVEL));
switch (logLevel) {
case LogLevel::LOG_NONE:
qzLogLevel = LOG_NONE;
break;
case LogLevel::LOG_ERROR:
qzLogLevel = LOG_ERROR;
break;
case LogLevel::LOG_INFO:
qzLogLevel = LOG_INFO;
break;
case LogLevel::LOG_DEBUG:
qzLogLevel = LOG_DEBUG3;
break;
default:
// Unreachable: all LogLevel values are handled above.
qzLogLevel = LOG_NONE;
break;
}
#endif
qzSetLogLevel(qzLogLevel);
});

// Initialize QAT hardware
qzSetLogLevel(LOG_NONE);
int status = qzInit(session.get(), 0);
if (status != QZ_OK && status != QZ_DUPLICATE) {
Log(LogLevel::LOG_ERROR, "qzInit() failure Line ", __LINE__, " session ",
Expand Down
50 changes: 46 additions & 4 deletions tests/logging_test.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -152,6 +152,46 @@ TEST_F(LoggingTest, LogErrorLevel) {
EXPECT_NE(c.find("error occurred"), std::string::npos);
}

/**
* @test Verifies that DEBUG-level messages appear when LOG_LEVEL=DEBUG.
*/
TEST_F(LoggingTest, LogDebugLevel) {
CreateLogFile(test_log_file.c_str());
config::SetConfig(config::LOG_LEVEL,
static_cast<uint32_t>(LogLevel::LOG_DEBUG));

Log(LogLevel::LOG_DEBUG, "debug message");
CloseLogFile();

std::ifstream f(test_log_file);
std::string c((std::istreambuf_iterator<char>(f)),
std::istreambuf_iterator<char>());

EXPECT_NE(c.find("Debug:"), std::string::npos);
EXPECT_NE(c.find("debug message"), std::string::npos);
}

/**
* @test Verifies that DEBUG-level messages are filtered out when
* LOG_LEVEL=INFO.
*/
TEST_F(LoggingTest, LogDebugFilteredByInfo) {
CreateLogFile(test_log_file.c_str());
config::SetConfig(config::LOG_LEVEL,
static_cast<uint32_t>(LogLevel::LOG_INFO));

Log(LogLevel::LOG_DEBUG, "filtered debug"); // Should NOT appear
Log(LogLevel::LOG_INFO, "visible info"); // Should appear
CloseLogFile();

std::ifstream f(test_log_file);
std::string c((std::istreambuf_iterator<char>(f)),
std::istreambuf_iterator<char>());

EXPECT_EQ(c.find("filtered debug"), std::string::npos);
EXPECT_NE(c.find("visible info"), std::string::npos);
}

/**
* @test Verifies that LOG_NONE prevents any message from being logged.
*/
Expand Down Expand Up @@ -191,23 +231,25 @@ TEST_F(LoggingTest, LogMultipleArguments) {

/**
* @test Validates that log-level filtering works correctly:
* - INFO log should be filtered out under LOG_ERROR
* - DEBUG and INFO logs should be filtered out under LOG_ERROR
* - ERROR log should appear.
*/
TEST_F(LoggingTest, LogLevelFiltering) {
CreateLogFile(test_log_file.c_str());
config::SetConfig(config::LOG_LEVEL,
static_cast<uint32_t>(LogLevel::LOG_ERROR));

Log(LogLevel::LOG_INFO, "filtered"); // Should NOT appear
Log(LogLevel::LOG_ERROR, "visible"); // Should appear
Log(LogLevel::LOG_DEBUG, "filtered debug"); // Should NOT appear
Log(LogLevel::LOG_INFO, "filtered info"); // Should NOT appear
Log(LogLevel::LOG_ERROR, "visible"); // Should appear
CloseLogFile();

std::ifstream f(test_log_file);
std::string c((std::istreambuf_iterator<char>(f)),
std::istreambuf_iterator<char>());

EXPECT_EQ(c.find("filtered"), std::string::npos);
EXPECT_EQ(c.find("filtered debug"), std::string::npos);
EXPECT_EQ(c.find("filtered info"), std::string::npos);
EXPECT_NE(c.find("visible"), std::string::npos);
}

Expand Down
2 changes: 1 addition & 1 deletion tests/zlib_accel_test.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -1274,7 +1274,7 @@ TEST_F(ConfigLoaderTest, LoadValidConfig) {
EXPECT_EQ(GetConfig(USE_IAA_UNCOMPRESS), 0);
EXPECT_EQ(GetConfig(USE_ZLIB_COMPRESS), 1);
EXPECT_EQ(GetConfig(USE_ZLIB_UNCOMPRESS), 1);
EXPECT_EQ(GetConfig(LOG_LEVEL), 2);
EXPECT_EQ(GetConfig(LOG_LEVEL), 1);
LoadConfigFile(file_content);
}

Expand Down