Simplify object creation with OBJ_NEW_BEGIN() macro.

Eliminate the boilerplate of declaring this and assigning memory to it, which is the same for the vast majority of object creations. Keep the old version of the macro as OBJ_NEW_BASE_BEGIN() for a few exceptions in the core code and (mostly) in the tests.
pgbackrest · Mar 28, 2023 · b111599 · b111599
1 parent 91f9301
commit b111599
Show file tree

Hide file tree

Showing 103 changed files with 77 additions and 506 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -132,12 +132,8 @@ myObjNew(unsigned int myData, const String *secretName)
 
     ASSERT(secretName != NULL || myData > 0);       // Development-only assertions (will be compiled out of production code)
 
-    MyObj *this = NULL;                 // Declare the object in the parent memory context: it will live only as long as the parent
-
     OBJ_NEW_BEGIN(MyObj)                // Create a long lasting memory context with the name of the object
     {
-        this = OBJ_NEW_ALLOC();         // Allocate the memory required by the object
-
         *this = (MyObj)                 // Initialize the object
         {
             .pub =

diff --git a/doc/xml/contributing.xml b/doc/xml/contributing.xml
@@ -238,12 +238,8 @@ myObjNew(unsigned int myData, const String *secretName)
 
     ASSERT(secretName != NULL || myData > 0);       // Development-only assertions (will be compiled out of production code)
 
-    MyObj *this = NULL;                 // Declare the object in the parent memory context: it will live only as long as the parent
-
     OBJ_NEW_BEGIN(MyObj)                // Create a long lasting memory context with the name of the object
     {
-        this = OBJ_NEW_ALLOC();         // Allocate the memory required by the object
-
         *this = (MyObj)                 // Initialize the object
         {
             .pub =

diff --git a/src/build/common/yaml.c b/src/build/common/yaml.c
@@ -47,12 +47,8 @@ yamlNew(const Buffer *const buffer)
         FUNCTION_TEST_PARAM(BUFFER, buffer);
     FUNCTION_TEST_END();
 
-    Yaml *this = NULL;
-
     OBJ_NEW_BEGIN(Yaml, .childQty = MEM_CONTEXT_QTY_MAX, .callbackQty = 1)
     {
-        // Create object
-        this = OBJ_NEW_ALLOC();
         *this = (Yaml){{0}};                                        // Extra braces are required for older gcc versions
 
         // Initialize parser context

diff --git a/src/command/backup/blockIncr.c b/src/command/backup/blockIncr.c
@@ -388,12 +388,8 @@ blockIncrNew(
         FUNCTION_LOG_PARAM(IO_FILTER, encrypt);
     FUNCTION_LOG_END();
 
-    BlockIncr *this = NULL;
-
     OBJ_NEW_BEGIN(BlockIncr, .childQty = MEM_CONTEXT_QTY_MAX)
     {
-        this = OBJ_NEW_ALLOC();
-
         *this = (BlockIncr)
         {
             .superBlockSize = (superBlockSize / blockSize + (superBlockSize % blockSize == 0 ? 0 : 1)) * blockSize,

diff --git a/src/command/backup/pageChecksum.c b/src/command/backup/pageChecksum.c
@@ -231,12 +231,8 @@ pageChecksumNew(const unsigned int segmentNo, const unsigned int segmentPageTota
         FUNCTION_LOG_PARAM(STRING, fileName);
     FUNCTION_LOG_END();
 
-    PageChecksum *this;
-
     OBJ_NEW_BEGIN(PageChecksum, .childQty = MEM_CONTEXT_QTY_MAX, .allocQty = MEM_CONTEXT_QTY_MAX)
     {
-        this = OBJ_NEW_ALLOC();
-
         *this = (PageChecksum)
         {
             .segmentPageTotal = segmentPageTotal,

diff --git a/src/command/restore/blockChecksum.c b/src/command/restore/blockChecksum.c
@@ -137,12 +137,8 @@ blockChecksumNew(const size_t blockSize, const size_t checksumSize)
     ASSERT(checksumSize != 0);
 
     // Allocate memory to hold process state
-    BlockChecksum *this;
-
     OBJ_NEW_BEGIN(BlockChecksum, .childQty = MEM_CONTEXT_QTY_MAX)
     {
-        this = OBJ_NEW_ALLOC();
-
         *this = (BlockChecksum)
         {
             .blockSize = blockSize,

diff --git a/src/command/restore/blockDelta.c b/src/command/restore/blockDelta.c
@@ -73,13 +73,8 @@ blockDeltaNew(
     ASSERT(blockSize > 0);
     ASSERT(cipherType == cipherTypeNone || cipherPass != NULL);
 
-    BlockDelta *this = NULL;
-
     OBJ_NEW_BEGIN(BlockDelta, .childQty = MEM_CONTEXT_QTY_MAX)
     {
-        // Create object
-        this = OBJ_NEW_ALLOC();
-
         *this = (BlockDelta)
         {
             .pub =

diff --git a/src/common/compress/bz2/compress.c b/src/common/compress/bz2/compress.c
@@ -166,12 +166,8 @@ bz2CompressNew(const int level, const bool raw)
 
     ASSERT(level >= BZ2_COMPRESS_LEVEL_MIN && level <= BZ2_COMPRESS_LEVEL_MAX);
 
-    Bz2Compress *this;
-
     OBJ_NEW_BEGIN(Bz2Compress, .childQty = MEM_CONTEXT_QTY_MAX, .callbackQty = 1)
     {
-        this = OBJ_NEW_ALLOC();
-
         *this = (Bz2Compress)
         {
             .stream = {.bzalloc = NULL},

diff --git a/src/common/compress/bz2/decompress.c b/src/common/compress/bz2/decompress.c
@@ -150,12 +150,8 @@ bz2DecompressNew(const bool raw)
         (void)raw;                                                  // Raw unsupported
     FUNCTION_LOG_END();
 
-    Bz2Decompress *this;
-
     OBJ_NEW_BEGIN(Bz2Decompress, .childQty = MEM_CONTEXT_QTY_MAX, .callbackQty = 1)
     {
-        this = OBJ_NEW_ALLOC();
-
         *this = (Bz2Decompress)
         {
             .stream = {.bzalloc = NULL},

diff --git a/src/common/compress/gz/compress.c b/src/common/compress/gz/compress.c
@@ -173,12 +173,8 @@ gzCompressNew(const int level, const bool raw)
 
     ASSERT(level >= GZ_COMPRESS_LEVEL_MIN && level <= GZ_COMPRESS_LEVEL_MAX);
 
-    GzCompress *this;
-
     OBJ_NEW_BEGIN(GzCompress, .childQty = MEM_CONTEXT_QTY_MAX, .callbackQty = 1)
     {
-        this = OBJ_NEW_ALLOC();
-
         *this = (GzCompress)
         {
             .stream = {.zalloc = NULL},

diff --git a/src/common/compress/gz/decompress.c b/src/common/compress/gz/decompress.c
@@ -152,12 +152,8 @@ gzDecompressNew(const bool raw)
         FUNCTION_LOG_PARAM(BOOL, raw);
     FUNCTION_LOG_END();
 
-    GzDecompress *this;
-
     OBJ_NEW_BEGIN(GzDecompress, .childQty = MEM_CONTEXT_QTY_MAX, .callbackQty = 1)
     {
-        this = OBJ_NEW_ALLOC();
-
         *this = (GzDecompress)
         {
             .stream = {.zalloc = NULL},

diff --git a/src/common/compress/lz4/compress.c b/src/common/compress/lz4/compress.c
@@ -252,12 +252,8 @@ lz4CompressNew(const int level, const bool raw)
 
     ASSERT(level >= LZ4_COMPRESS_LEVEL_MIN && level <= LZ4_COMPRESS_LEVEL_MAX);
 
-    Lz4Compress *this;
-
     OBJ_NEW_BEGIN(Lz4Compress, .childQty = MEM_CONTEXT_QTY_MAX, .callbackQty = 1)
     {
-        this = OBJ_NEW_ALLOC();
-
         *this = (Lz4Compress)
         {
             .prefs =

diff --git a/src/common/compress/lz4/decompress.c b/src/common/compress/lz4/decompress.c
@@ -163,11 +163,8 @@ lz4DecompressNew(const bool raw)
         (void)raw;                                                  // Not required for decompress
     FUNCTION_LOG_END();
 
-    Lz4Decompress *this;
-
     OBJ_NEW_BEGIN(Lz4Decompress, .childQty = MEM_CONTEXT_QTY_MAX, .callbackQty = 1)
     {
-        this = OBJ_NEW_ALLOC();
         *this = (Lz4Decompress){0};
 
         // Create lz4 context

diff --git a/src/common/compress/zst/compress.c b/src/common/compress/zst/compress.c
@@ -173,12 +173,8 @@ zstCompressNew(const int level, const bool raw)
 
     ASSERT(level >= ZST_COMPRESS_LEVEL_MIN && level <= ZST_COMPRESS_LEVEL_MAX);
 
-    ZstCompress *this;
-
     OBJ_NEW_BEGIN(ZstCompress, .childQty = MEM_CONTEXT_QTY_MAX, .allocQty = MEM_CONTEXT_QTY_MAX, .callbackQty = 1)
     {
-        this = OBJ_NEW_ALLOC();
-
         *this = (ZstCompress)
         {
             .context = ZSTD_createCStream(),

diff --git a/src/common/compress/zst/decompress.c b/src/common/compress/zst/decompress.c
@@ -162,12 +162,8 @@ zstDecompressNew(const bool raw)
         (void)raw;                                                  // Raw unsupported
     FUNCTION_LOG_END();
 
-    ZstDecompress *this;
-
     OBJ_NEW_BEGIN(ZstDecompress, .childQty = MEM_CONTEXT_QTY_MAX, .callbackQty = 1)
     {
-        this = OBJ_NEW_ALLOC();
-
         *this = (ZstDecompress)
         {
             .context = ZSTD_createDStream(),

diff --git a/src/common/crypto/cipherBlock.c b/src/common/crypto/cipherBlock.c
@@ -423,13 +423,8 @@ cipherBlockNew(const CipherMode mode, const CipherType cipherType, const Buffer
     if (!digest)
         THROW_FMT(AssertError, "unable to load digest '%s'", strZ(param.digest));
 
-    // Allocate memory to hold process state
-    CipherBlock *this;
-
     OBJ_NEW_BEGIN(CipherBlock, .childQty = MEM_CONTEXT_QTY_MAX, .allocQty = MEM_CONTEXT_QTY_MAX, .callbackQty = 1)
     {
-        this = OBJ_NEW_ALLOC();
-
         *this = (CipherBlock)
         {
             .mode = mode,

diff --git a/src/common/crypto/hash.c b/src/common/crypto/hash.c
@@ -179,12 +179,8 @@ cryptoHashNew(const HashType type)
     // Init crypto subsystem
     cryptoInit();
 
-    // Allocate memory to hold process state
-    CryptoHash *this;
-
     OBJ_NEW_BEGIN(CryptoHash, .childQty = MEM_CONTEXT_QTY_MAX, .allocQty = MEM_CONTEXT_QTY_MAX, .callbackQty = 1)
     {
-        this = OBJ_NEW_ALLOC();
         *this = (CryptoHash){0};
 
         // Use local MD5 implementation since FIPS-enabled systems do not allow MD5. This is a bit misguided since there are valid

diff --git a/src/common/crypto/xxhash.c b/src/common/crypto/xxhash.c
@@ -116,12 +116,8 @@ xxHashNew(const size_t size)
 
     ASSERT(size >= 1 && size <= XX_HASH_SIZE_MAX);
 
-    // Allocate memory to hold process state
-    XxHash *this;
-
     OBJ_NEW_BEGIN(XxHash, .callbackQty = 1)
     {
-        this = OBJ_NEW_ALLOC();
         *this = (XxHash){.size = size};
 
         this->state = XXH3_createState();

diff --git a/src/common/exec.c b/src/common/exec.c
@@ -125,12 +125,8 @@ execNew(const String *command, const StringList *param, const String *name, Time
     ASSERT(name != NULL);
     ASSERT(timeout > 0);
 
-    Exec *this = NULL;
-
     OBJ_NEW_BEGIN(Exec, .childQty = MEM_CONTEXT_QTY_MAX, .callbackQty = 1)
     {
-        this = OBJ_NEW_ALLOC();
-
         *this = (Exec)
         {
             .command = strDup(command),

diff --git a/src/common/ini.c b/src/common/ini.c
@@ -35,12 +35,8 @@ iniNew(IoRead *const read, const IniNewParam param)
         FUNCTION_LOG_PARAM(BOOL, param.store);
     FUNCTION_LOG_END();
 
-    Ini *this = NULL;
-
     OBJ_NEW_BEGIN(Ini, .childQty = MEM_CONTEXT_QTY_MAX)
     {
-        this = OBJ_NEW_ALLOC();
-
         *this = (Ini)
         {
             .read = read,

diff --git a/src/common/io/bufferRead.c b/src/common/io/bufferRead.c
@@ -92,12 +92,8 @@ ioBufferReadNew(const Buffer *const buffer)
 
     ASSERT(buffer != NULL);
 
-    IoBufferRead *this;
-
     OBJ_NEW_BEGIN(IoBufferRead, .childQty = MEM_CONTEXT_QTY_MAX)
     {
-        this = OBJ_NEW_ALLOC();
-
         *this = (IoBufferRead)
         {
             .read = buffer,

diff --git a/src/common/io/bufferWrite.c b/src/common/io/bufferWrite.c
@@ -56,12 +56,8 @@ ioBufferWriteNew(Buffer *const buffer)
 
     ASSERT(buffer != NULL);
 
-    IoBufferWrite *this;
-
     OBJ_NEW_BEGIN(IoBufferWrite, .childQty = MEM_CONTEXT_QTY_MAX)
     {
-        this = OBJ_NEW_ALLOC();
-
         *this = (IoBufferWrite)
         {
             .write = buffer,

diff --git a/src/common/io/chunkedRead.c b/src/common/io/chunkedRead.c
@@ -154,12 +154,8 @@ ioChunkedReadNew(IoRead *const read)
 
     ASSERT(read != NULL);
 
-    IoChunkedRead *this;
-
     OBJ_NEW_BEGIN(IoChunkedRead, .childQty = MEM_CONTEXT_QTY_MAX)
     {
-        this = OBJ_NEW_ALLOC();
-
         *this = (IoChunkedRead)
         {
             .read = read,

diff --git a/src/common/io/client.c b/src/common/io/client.c
@@ -31,12 +31,8 @@ ioClientNew(void *const driver, const IoClientInterface *const interface)
     ASSERT(interface->open != NULL);
     ASSERT(interface->toLog != NULL);
 
-    IoClient *this;
-
     OBJ_NEW_BEGIN(IoClient, .childQty = MEM_CONTEXT_QTY_MAX)
     {
-        this = OBJ_NEW_ALLOC();
-
         *this = (IoClient)
         {
             .pub =

diff --git a/src/common/io/fdRead.c b/src/common/io/fdRead.c
@@ -154,12 +154,8 @@ ioFdReadNew(const String *const name, const int fd, const TimeMSec timeout)
 
     ASSERT(fd != -1);
 
-    IoFdRead *this;
-
     OBJ_NEW_BEGIN(IoFdRead, .childQty = MEM_CONTEXT_QTY_MAX)
     {
-        this = OBJ_NEW_ALLOC();
-
         *this = (IoFdRead)
         {
             .name = strDup(name),

diff --git a/src/common/io/fdWrite.c b/src/common/io/fdWrite.c
@@ -110,12 +110,8 @@ ioFdWriteNew(const String *const name, const int fd, const TimeMSec timeout)
         FUNCTION_LOG_PARAM(TIME_MSEC, timeout);
     FUNCTION_LOG_END();
 
-    IoFdWrite *this;
-
     OBJ_NEW_BEGIN(IoFdWrite, .childQty = MEM_CONTEXT_QTY_MAX)
     {
-        this = OBJ_NEW_ALLOC();
-
         *this = (IoFdWrite)
         {
             .name = strDup(name),

diff --git a/src/common/io/filter/buffer.c b/src/common/io/filter/buffer.c
@@ -108,11 +108,8 @@ ioBufferNew(void)
 {
     FUNCTION_LOG_VOID(logLevelTrace);
 
-    IoBuffer *this;
-
     OBJ_NEW_BEGIN(IoBuffer)
     {
-        this = OBJ_NEW_ALLOC();
         *this = (IoBuffer){0};
     }
     OBJ_NEW_END();

diff --git a/src/common/io/filter/chunk.c b/src/common/io/filter/chunk.c
@@ -149,11 +149,8 @@ ioChunkNew(void)
 {
     FUNCTION_LOG_VOID(logLevelTrace);
 
-    IoChunk *this;
-
     OBJ_NEW_BEGIN(IoChunk)
     {
-        this = OBJ_NEW_ALLOC();
         *this = (IoChunk){0};
     }
     OBJ_NEW_END();

diff --git a/src/common/io/filter/filter.c b/src/common/io/filter/filter.c
@@ -39,12 +39,8 @@ ioFilterNew(const StringId type, void *const driver, Pack *const paramList, cons
     // If the filter does not produce output then it should produce a result
     ASSERT(interface.in == NULL || (interface.result != NULL && interface.done == NULL && interface.inputSame == NULL));
 
-    IoFilter *this;
-
     OBJ_NEW_BEGIN(IoFilter, .childQty = MEM_CONTEXT_QTY_MAX)
     {
-        this = OBJ_NEW_ALLOC();
-
         *this = (IoFilter)
         {
             .pub =

diff --git a/src/common/io/filter/group.c b/src/common/io/filter/group.c
@@ -61,12 +61,8 @@ ioFilterGroupNew(void)
 {
     FUNCTION_LOG_VOID(logLevelTrace);
 
-    IoFilterGroup *this = NULL;
-
     OBJ_NEW_BEGIN(IoFilterGroup, .childQty = MEM_CONTEXT_QTY_MAX)
     {
-        this = OBJ_NEW_ALLOC();
-
         *this = (IoFilterGroup)
         {
             .pub =