Skip to content

Improve KeysInUse logging performance during burst of first use events #174

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

Draft
Maxwell Moyer-McKee (mamckee) wants to merge 2 commits into
base: scossl-1.10
Choose a base branch
from
+38 −33
Draft

Improve KeysInUse logging performance during burst of first use events #174

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
22a583d
Minimize window logging thread holds logging_thread_mutex
mamckee Jul 30, 2026
0df8c9c
Remove unecessary null check
mamckee Aug 6, 2026
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
71 changes: 38 additions & 33 deletions SymCryptProvider/src/p_scossl_keysinuse.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -837,7 +837,7 @@ static void p_scossl_keysinuse_log_common(int level, const char *message, va_lis
int fd;
for (int i = 0; i < 3; i++)
{
fd = open(log_path, O_WRONLY | O_APPEND | O_CREAT, 0200);
fd = open(log_path, O_WRONLY | O_APPEND | O_CREAT | O_CLOEXEC, 0200);
if (fd >= 0 || errno != EACCES)
{
break;
Expand Down Expand Up @@ -1025,48 +1025,53 @@ static void *p_scossl_keysinuse_logging_thread_start(ossl_unused void *arg)
p_scossl_keysinuse_log_error("Failed to lock keysinuse info stack,OPENSSL_%d", ERR_get_error());
}

// Log all pending usage events under lock. We need to lock in this section
// in case fork is called
if ((pthreadErr = pthread_mutex_lock(&logging_thread_mutex)) == 0)
// Log all pending usage events. logging_thread_mutex is held only around
// during the pKeysinuseInfo update to ensure the logging thread is not
// holding a lock during a fork.
while (sk_SCOSSL_PROV_KEYSINUSE_INFO_num(sk_keysinuse_info_pending) > 0)
{
while (sk_SCOSSL_PROV_KEYSINUSE_INFO_num(sk_keysinuse_info_pending) > 0)
if ((pthreadErr = pthread_mutex_lock(&logging_thread_mutex)) != 0)
{
pKeysinuseInfo = sk_SCOSSL_PROV_KEYSINUSE_INFO_pop(sk_keysinuse_info_pending);
if (CRYPTO_THREAD_write_lock(pKeysinuseInfo->lock))
{
now = time(NULL);

pKeysinuseInfo->firstLogTime = pKeysinuseInfo->lastLogTime == 0 ? now : pKeysinuseInfo->firstLogTime;
pKeysinuseInfo->lastLogTime = now;
pKeysinuseInfo->logPending = FALSE;
p_scossl_keysinuse_log_error("Logging thread failed to accquire mutex,SYS_%d", pthreadErr);
goto cleanup;
}

keysinuseInfoTmp = *pKeysinuseInfo;
pKeysinuseInfo = sk_SCOSSL_PROV_KEYSINUSE_INFO_pop(sk_keysinuse_info_pending);
if (pKeysinuseInfo != NULL &&
CRYPTO_THREAD_write_lock(pKeysinuseInfo->lock))
{
now = time(NULL);

pKeysinuseInfo->decryptCounter = 0;
pKeysinuseInfo->signCounter = 0;
pKeysinuseInfo->firstLogTime = pKeysinuseInfo->lastLogTime == 0 ? now : pKeysinuseInfo->firstLogTime;
pKeysinuseInfo->lastLogTime = now;
pKeysinuseInfo->logPending = FALSE;

CRYPTO_THREAD_unlock(pKeysinuseInfo->lock);
}
else
{
p_scossl_keysinuse_log_error("Failed to lock keysinuse info,OPENSSL_%d", ERR_get_error());
keysinuseInfoTmp.refCount = -1;
}
keysinuseInfoTmp = *pKeysinuseInfo;

p_scossl_keysinuse_info_free(pKeysinuseInfo);
pKeysinuseInfo->decryptCounter = 0;
pKeysinuseInfo->signCounter = 0;

if (keysinuseInfoTmp.refCount > 0)
{
p_scossl_keysinuse_log_notice("%s,%d,%d,%ld,%ld",
keysinuseInfoTmp.keyIdentifier,
keysinuseInfoTmp.signCounter,
keysinuseInfoTmp.decryptCounter,
keysinuseInfoTmp.firstLogTime,
keysinuseInfoTmp.lastLogTime);
}
CRYPTO_THREAD_unlock(pKeysinuseInfo->lock);
}
else
{
p_scossl_keysinuse_log_error("Failed to lock keysinuse info,OPENSSL_%d", ERR_get_error());
keysinuseInfoTmp.refCount = -1;
}

pthread_mutex_unlock(&logging_thread_mutex);

p_scossl_keysinuse_info_free(pKeysinuseInfo);

if (keysinuseInfoTmp.refCount > 0)
{
p_scossl_keysinuse_log_notice("%s,%d,%d,%ld,%ld",
keysinuseInfoTmp.keyIdentifier,
keysinuseInfoTmp.signCounter,
keysinuseInfoTmp.decryptCounter,
keysinuseInfoTmp.firstLogTime,
keysinuseInfoTmp.lastLogTime);
}
}
Comment on lines +1031 to 1075
}
while (isLoggingThreadRunning);
Expand Down