1
0
mirror of https://github.com/pgbackrest/pgbackrest.git synced 2025-07-03 00:26:59 +02:00

Rename FUNCTION_DEBUG_* and consolidate ASSERT_* macros for consistency.

Rename FUNCTION_DEBUG_* macros to FUNCTION_LOG_* to more accurately reflect what they do.  Further rename FUNCTION_DEBUG_RESULT* macros to FUNCTION_LOG_RETURN* to make it clearer that they return from the function as well as logging.  Leave FUNCTION_TEST_* macros as they are.

Consolidate the various ASSERT* macros into a single ASSERT macro that is always compiled out of production builds.  It was difficult to figure out when an assert would be checked with all the different types in play.  When ASSERTs are compiled in they will always be checked regardless of the log level -- tying these two concepts together was not a good idea.
This commit is contained in:
David Steele
2019-01-21 17:41:59 +02:00
parent d245f8eb42
commit db08656537
170 changed files with 3568 additions and 3658 deletions

View File

@ -64,7 +64,6 @@ minimize register spilling. For less sophisticated compilers it might be benefic
***********************************************************************************************************************************/
#include <string.h>
#include "common/assert.h"
#include "common/debug.h"
#include "common/error.h"
#include "common/log.h"
@ -140,10 +139,10 @@ pageChecksumBlock(const unsigned char *page, unsigned int pageSize)
FUNCTION_TEST_BEGIN();
FUNCTION_TEST_PARAM(UCHARP, page);
FUNCTION_TEST_PARAM(UINT, pageSize);
FUNCTION_TEST_ASSERT(page != NULL);
FUNCTION_TEST_END();
ASSERT(page != NULL);
uint32_t sums[N_SUMS];
uint32_t (*dataArray)[N_SUMS] = (uint32_t (*)[N_SUMS])page;
uint32_t result = 0;
@ -166,7 +165,7 @@ pageChecksumBlock(const unsigned char *page, unsigned int pageSize)
for (i = 0; i < N_SUMS; i++)
result ^= sums[i];
FUNCTION_TEST_RESULT(UINT32, result);
FUNCTION_TEST_RETURN(UINT32, result);
}
/***********************************************************************************************************************************
@ -182,10 +181,10 @@ pageChecksum(const unsigned char *page, unsigned int blockNo, unsigned int pageS
FUNCTION_TEST_PARAM(UCHARP, page);
FUNCTION_TEST_PARAM(UINT, blockNo);
FUNCTION_TEST_PARAM(UINT, pageSize);
FUNCTION_TEST_ASSERT(page != NULL);
FUNCTION_TEST_END();
ASSERT(page != NULL);
// Save pd_checksum and temporarily set it to zero, so that the checksum calculation isn't affected by the old checksum stored
// on the page. Restore it after, because actually updating the checksum is NOT part of the API of this function.
PageHeader pageHeader = (PageHeader)page;
@ -199,7 +198,7 @@ pageChecksum(const unsigned char *page, unsigned int blockNo, unsigned int pageS
checksum ^= blockNo;
// Reduce to a uint16 with an offset of one. That avoids checksums of zero, which seems like a good idea.
FUNCTION_TEST_RESULT(UINT16, (uint16_t)(checksum % 65535 + 1));
FUNCTION_TEST_RETURN(UINT16, (uint16_t)(checksum % 65535 + 1));
}
/***********************************************************************************************************************************
@ -215,11 +214,11 @@ pageChecksumTest(
FUNCTION_TEST_PARAM(UINT, pageSize);
FUNCTION_TEST_PARAM(UINT32, ignoreWalId);
FUNCTION_TEST_PARAM(UINT32, ignoreWalOffset);
FUNCTION_TEST_ASSERT(page != NULL);
FUNCTION_TEST_END();
FUNCTION_TEST_RESULT(
ASSERT(page != NULL);
FUNCTION_TEST_RETURN(
BOOL,
// This is a new page so don't test checksum
((PageHeader)page)->pd_upper == 0 ||
@ -237,18 +236,18 @@ pageChecksumBufferTest(
const unsigned char *pageBuffer, unsigned int pageBufferSize, unsigned int blockNoBegin, unsigned int pageSize,
uint32_t ignoreWalId, uint32_t ignoreWalOffset)
{
FUNCTION_DEBUG_BEGIN(logLevelTrace);
FUNCTION_DEBUG_PARAM(UCHARP, pageBuffer);
FUNCTION_DEBUG_PARAM(UINT, pageBufferSize);
FUNCTION_DEBUG_PARAM(UINT, blockNoBegin);
FUNCTION_DEBUG_PARAM(UINT, pageSize);
FUNCTION_DEBUG_PARAM(UINT32, ignoreWalId);
FUNCTION_DEBUG_PARAM(UINT32, ignoreWalOffset);
FUNCTION_LOG_BEGIN(logLevelTrace);
FUNCTION_LOG_PARAM(UCHARP, pageBuffer);
FUNCTION_LOG_PARAM(UINT, pageBufferSize);
FUNCTION_LOG_PARAM(UINT, blockNoBegin);
FUNCTION_LOG_PARAM(UINT, pageSize);
FUNCTION_LOG_PARAM(UINT32, ignoreWalId);
FUNCTION_LOG_PARAM(UINT32, ignoreWalOffset);
FUNCTION_LOG_END();
FUNCTION_TEST_ASSERT(pageBuffer != NULL);
FUNCTION_DEBUG_ASSERT(pageBufferSize > 0);
FUNCTION_DEBUG_ASSERT(pageBufferSize % pageSize == 0);
FUNCTION_DEBUG_END();
ASSERT(pageBuffer != NULL);
ASSERT(pageBufferSize > 0);
ASSERT(pageBufferSize % pageSize == 0);
bool result = true;
@ -265,5 +264,5 @@ pageChecksumBufferTest(
}
}
FUNCTION_DEBUG_RESULT(BOOL, result);
FUNCTION_LOG_RETURN(BOOL, result);
}