thread/storage: prefix API with SC

In preparation for Rust bindings.
This commit is contained in:
Jason Ish 2026-04-02 14:47:27 -06:00 committed by Victor Julien
parent 137f59f542
commit 67bd09ba2c
5 changed files with 57 additions and 57 deletions

View file

@ -33,7 +33,7 @@
#include "ndpi_api.h"
static ThreadStorageId thread_storage_id = { .id = -1 };
static SCThreadStorageId thread_storage_id = { .id = -1 };
static SCFlowStorageId flow_storage_id = { .id = -1 };
static int ndpi_protocol_keyword_id = -1;
static int ndpi_risk_keyword_id = -1;
@ -66,7 +66,7 @@ static inline struct NdpiThreadContext *NdpiGetThreadContext(ThreadVars *tv)
{
if (unlikely(tv == NULL || thread_storage_id.id < 0))
return NULL;
return ThreadGetStorageById(tv, thread_storage_id);
return SCThreadGetStorageById(tv, thread_storage_id);
}
/**
@ -217,7 +217,7 @@ static void OnThreadInit(ThreadVars *tv, void *_data)
NDPI_BITMASK_SET_ALL(protos);
ndpi_set_protocol_detection_bitmask2(context->ndpi, &protos);
ndpi_finalize_initialization(context->ndpi);
ThreadSetStorageById(tv, thread_storage_id, context);
SCThreadSetStorageById(tv, thread_storage_id, context);
}
static int DetectnDPIProtocolPacketMatch(
@ -573,7 +573,7 @@ static void NdpiInit(void)
SCLogDebug("Initializing nDPI plugin");
/* Register thread storage. */
thread_storage_id = ThreadStorageRegister("ndpi", ThreadStorageFree);
thread_storage_id = SCThreadStorageRegister("ndpi", ThreadStorageFree);
if (thread_storage_id.id < 0) {
FatalError("Failed to register nDPI thread storage");
}

View file

@ -22,36 +22,36 @@
const StorageEnum storage_type = STORAGE_THREAD;
unsigned int ThreadStorageSize(void)
unsigned int SCThreadStorageSize(void)
{
return StorageGetSize(storage_type);
}
void *ThreadGetStorageById(const ThreadVars *tv, ThreadStorageId id)
void *SCThreadGetStorageById(const ThreadVars *tv, SCThreadStorageId id)
{
return StorageGetById(tv->storage, storage_type, id.id);
}
int ThreadSetStorageById(ThreadVars *tv, ThreadStorageId id, void *ptr)
int SCThreadSetStorageById(ThreadVars *tv, SCThreadStorageId id, void *ptr)
{
return StorageSetById(tv->storage, storage_type, id.id, ptr);
}
void ThreadFreeStorageById(ThreadVars *tv, ThreadStorageId id)
void SCThreadFreeStorageById(ThreadVars *tv, SCThreadStorageId id)
{
StorageFreeById(tv->storage, storage_type, id.id);
}
void ThreadFreeStorage(ThreadVars *tv)
void SCThreadFreeStorage(ThreadVars *tv)
{
if (ThreadStorageSize() > 0)
if (SCThreadStorageSize() > 0)
StorageFreeAll(tv->storage, storage_type);
}
ThreadStorageId ThreadStorageRegister(const char *name, void (*Free)(void *))
SCThreadStorageId SCThreadStorageRegister(const char *name, void (*Free)(void *))
{
int id = StorageRegister(storage_type, name, Free);
ThreadStorageId tsi = { .id = id };
SCThreadStorageId tsi = { .id = id };
return tsi;
}
@ -67,51 +67,51 @@ static int ThreadStorageTest01(void)
StorageCleanup();
StorageInit();
ThreadStorageId id1 = ThreadStorageRegister("test", StorageTestFree);
SCThreadStorageId id1 = SCThreadStorageRegister("test", StorageTestFree);
FAIL_IF(id1.id < 0);
ThreadStorageId id2 = ThreadStorageRegister("variable", StorageTestFree);
SCThreadStorageId id2 = SCThreadStorageRegister("variable", StorageTestFree);
FAIL_IF(id2.id < 0);
ThreadStorageId id3 = ThreadStorageRegister("store", StorageTestFree);
SCThreadStorageId id3 = SCThreadStorageRegister("store", StorageTestFree);
FAIL_IF(id3.id < 0);
FAIL_IF(StorageFinalize() < 0);
ThreadVars *tv = SCCalloc(1, sizeof(ThreadVars) + ThreadStorageSize());
ThreadVars *tv = SCCalloc(1, sizeof(ThreadVars) + SCThreadStorageSize());
FAIL_IF_NULL(tv);
void *ptr = ThreadGetStorageById(tv, id1);
void *ptr = SCThreadGetStorageById(tv, id1);
FAIL_IF_NOT_NULL(ptr);
ptr = ThreadGetStorageById(tv, id2);
ptr = SCThreadGetStorageById(tv, id2);
FAIL_IF_NOT_NULL(ptr);
ptr = ThreadGetStorageById(tv, id3);
ptr = SCThreadGetStorageById(tv, id3);
FAIL_IF_NOT_NULL(ptr);
void *ptr1a = SCMalloc(8);
FAIL_IF_NULL(ptr1a);
FAIL_IF(ThreadSetStorageById(tv, id1, ptr1a) != 0);
FAIL_IF(SCThreadSetStorageById(tv, id1, ptr1a) != 0);
void *ptr2a = SCMalloc(24);
FAIL_IF_NULL(ptr2a);
FAIL_IF(ThreadSetStorageById(tv, id2, ptr2a) != 0);
FAIL_IF(SCThreadSetStorageById(tv, id2, ptr2a) != 0);
void *ptr3a = SCMalloc(16);
FAIL_IF_NULL(ptr3a);
FAIL_IF(ThreadSetStorageById(tv, id3, ptr3a) != 0);
FAIL_IF(SCThreadSetStorageById(tv, id3, ptr3a) != 0);
void *ptr1b = ThreadGetStorageById(tv, id1);
void *ptr1b = SCThreadGetStorageById(tv, id1);
FAIL_IF(ptr1a != ptr1b);
void *ptr2b = ThreadGetStorageById(tv, id2);
void *ptr2b = SCThreadGetStorageById(tv, id2);
FAIL_IF(ptr2a != ptr2b);
void *ptr3b = ThreadGetStorageById(tv, id3);
void *ptr3b = SCThreadGetStorageById(tv, id3);
FAIL_IF(ptr3a != ptr3b);
ThreadFreeStorage(tv);
SCThreadFreeStorage(tv);
StorageCleanup();
SCFree(tv);
PASS;
@ -122,26 +122,26 @@ static int ThreadStorageTest02(void)
StorageCleanup();
StorageInit();
ThreadStorageId id1 = ThreadStorageRegister("test", StorageTestFree);
SCThreadStorageId id1 = SCThreadStorageRegister("test", StorageTestFree);
FAIL_IF(id1.id < 0);
FAIL_IF(StorageFinalize() < 0);
ThreadVars *tv = SCCalloc(1, sizeof(ThreadVars) + ThreadStorageSize());
ThreadVars *tv = SCCalloc(1, sizeof(ThreadVars) + SCThreadStorageSize());
FAIL_IF_NULL(tv);
void *ptr = ThreadGetStorageById(tv, id1);
void *ptr = SCThreadGetStorageById(tv, id1);
FAIL_IF_NOT_NULL(ptr);
void *ptr1a = SCMalloc(128);
FAIL_IF_NULL(ptr1a);
ThreadSetStorageById(tv, id1, ptr1a);
SCThreadSetStorageById(tv, id1, ptr1a);
void *ptr1b = ThreadGetStorageById(tv, id1);
void *ptr1b = SCThreadGetStorageById(tv, id1);
FAIL_IF(ptr1a != ptr1b);
ThreadFreeStorage(tv);
SCThreadFreeStorage(tv);
StorageCleanup();
SCFree(tv);
PASS;
@ -152,54 +152,54 @@ static int ThreadStorageTest03(void)
StorageCleanup();
StorageInit();
ThreadStorageId id1 = ThreadStorageRegister("test1", StorageTestFree);
SCThreadStorageId id1 = SCThreadStorageRegister("test1", StorageTestFree);
FAIL_IF(id1.id < 0);
ThreadStorageId id2 = ThreadStorageRegister("test2", StorageTestFree);
SCThreadStorageId id2 = SCThreadStorageRegister("test2", StorageTestFree);
FAIL_IF(id2.id < 0);
ThreadStorageId id3 = ThreadStorageRegister("test3", StorageTestFree);
SCThreadStorageId id3 = SCThreadStorageRegister("test3", StorageTestFree);
FAIL_IF(id3.id < 0);
FAIL_IF(StorageFinalize() < 0);
ThreadVars *tv = SCCalloc(1, sizeof(ThreadVars) + ThreadStorageSize());
ThreadVars *tv = SCCalloc(1, sizeof(ThreadVars) + SCThreadStorageSize());
FAIL_IF_NULL(tv);
void *ptr = ThreadGetStorageById(tv, id1);
void *ptr = SCThreadGetStorageById(tv, id1);
FAIL_IF_NOT_NULL(ptr);
void *ptr1a = SCMalloc(128);
FAIL_IF_NULL(ptr1a);
ThreadSetStorageById(tv, id1, ptr1a);
SCThreadSetStorageById(tv, id1, ptr1a);
void *ptr2a = SCMalloc(256);
FAIL_IF_NULL(ptr2a);
ThreadSetStorageById(tv, id2, ptr2a);
SCThreadSetStorageById(tv, id2, ptr2a);
void *ptr3a = SCMalloc(32);
FAIL_IF_NULL(ptr3a);
ThreadSetStorageById(tv, id3, ptr3a);
SCThreadSetStorageById(tv, id3, ptr3a);
void *ptr1b = ThreadGetStorageById(tv, id1);
void *ptr1b = SCThreadGetStorageById(tv, id1);
FAIL_IF(ptr1a != ptr1b);
void *ptr2b = ThreadGetStorageById(tv, id2);
void *ptr2b = SCThreadGetStorageById(tv, id2);
FAIL_IF(ptr2a != ptr2b);
void *ptr3b = ThreadGetStorageById(tv, id3);
void *ptr3b = SCThreadGetStorageById(tv, id3);
FAIL_IF(ptr3a != ptr3b);
ThreadFreeStorage(tv);
SCThreadFreeStorage(tv);
StorageCleanup();
SCFree(tv);
PASS;
}
#endif
void RegisterThreadStorageTests(void)
void SCRegisterThreadStorageTests(void)
{
#ifdef UNITTESTS
UtRegisterTest("ThreadStorageTest01", ThreadStorageTest01);

View file

@ -24,20 +24,20 @@
#include "threadvars.h"
typedef struct ThreadStorageId {
typedef struct SCThreadStorageId {
int id;
} ThreadStorageId;
} SCThreadStorageId;
unsigned int ThreadStorageSize(void);
unsigned int SCThreadStorageSize(void);
void *ThreadGetStorageById(const ThreadVars *tv, ThreadStorageId id);
int ThreadSetStorageById(ThreadVars *tv, ThreadStorageId id, void *ptr);
void *SCThreadGetStorageById(const ThreadVars *tv, SCThreadStorageId id);
int SCThreadSetStorageById(ThreadVars *tv, SCThreadStorageId id, void *ptr);
void ThreadFreeStorageById(ThreadVars *tv, ThreadStorageId id);
void ThreadFreeStorage(ThreadVars *tv);
void SCThreadFreeStorageById(ThreadVars *tv, SCThreadStorageId id);
void SCThreadFreeStorage(ThreadVars *tv);
void RegisterThreadStorageTests(void);
void SCRegisterThreadStorageTests(void);
ThreadStorageId ThreadStorageRegister(const char *name, void (*Free)(void *));
SCThreadStorageId SCThreadStorageRegister(const char *name, void (*Free)(void *));
#endif /* SURICATA_THREAD_STORAGE_H */

View file

@ -147,6 +147,6 @@ void ThreadMacrosRegisterTests(void)
UtRegisterTest("ThreadMacrosTest03RWLocks", ThreadMacrosTest03RWLocks);
UtRegisterTest("ThreadMacrosTest04RWLocks", ThreadMacrosTest04RWLocks);
// UtRegisterTest("ThreadMacrosTest05RWLocks", ThreadMacrosTest05RWLocks);
RegisterThreadStorageTests();
SCRegisterThreadStorageTests();
#endif /* UNIT TESTS */
}

View file

@ -948,7 +948,7 @@ ThreadVars *TmThreadCreate(const char *name, const char *inq_name, const char *i
SCLogDebug("creating thread \"%s\"...", name);
/* XXX create separate function for this: allocate a thread container */
tv = SCCalloc(1, sizeof(ThreadVars) + ThreadStorageSize());
tv = SCCalloc(1, sizeof(ThreadVars) + SCThreadStorageSize());
if (unlikely(tv == NULL))
goto error;
@ -1642,7 +1642,7 @@ static void TmThreadFree(ThreadVars *tv)
SCLogDebug("Freeing thread '%s'.", tv->name);
ThreadFreeStorage(tv);
SCThreadFreeStorage(tv);
if (tv->flow_queue) {
BUG_ON(tv->flow_queue->qlen != 0);