mirror of
https://github.com/rsyslog/rsyslog.git
synced 2025-12-18 07:30:42 +01:00
7225999b77
This commit performs a broad modernization of widely used rsyslog macros to align with modern C practices and support automated formatting tools like clang-format. The changes focus on improving syntactic regularity, readability, and tooling compatibility — without altering behavior. Macros refactored in this commit now follow a consistent, statement-like form with explicit trailing semicolons. Where applicable, macro blocks that define module interfaces (`queryEtryPt`) have been updated to use simple `if` statements instead of `else if` chains. While this slightly increases evaluation time, the affected functions are only called once per module during load time to register supported interfaces — making the performance cost irrelevant in practice. These improvements serve multiple purposes: - Enable reliable clang-format usage without mangling macro logic - Simplify reasoning about macro-expanded code for human readers - Reduce style drift and merge conflicts - Facilitate development for contributors using assistive tools - Support future formatting pipelines using: 1. `clang-format` 2. a post-fixup normalization script Refactored macros: - MODULE_TYPE_NOKEEP - MODULE_TYPE_KEEP - MODULE_TYPE_INPUT - MODULE_TYPE_OUTPUT - MODULE_TYPE_FUNCTION - MODULE_TYPE_PARSER - MODULE_TYPE_LIB - DEF_IMOD_STATIC_DATA - DEF_OMOD_STATIC_DATA - DEF_PMOD_STATIC_DATA - DEF_FMOD_STATIC_DATA - DEFobjStaticHelpers - SIMP_PROP(...) And all `queryEtryPt()` dispatch macros: - CODEqueryEtryPt_STD_MOD_QUERIES - CODEqueryEtryPt_STD_OMOD_QUERIES - CODEqueryEtryPt_STD_OMODTX_QUERIES - CODEqueryEtryPt_STD_OMOD8_QUERIES - CODEqueryEtryPt_TXIF_OMOD_QUERIES - CODEqueryEtryPt_IsCompatibleWithFeature_IF_OMOD_QUERIES - CODEqueryEtryPt_STD_IMOD_QUERIES - CODEqueryEtryPt_STD_CONF2_QUERIES - CODEqueryEtryPt_STD_CONF2_setModCnf_QUERIES - CODEqueryEtryPt_STD_CONF2_OMOD_QUERIES - CODEqueryEtryPt_STD_CONF2_IMOD_QUERIES - CODEqueryEtryPt_STD_CONF2_PREPRIVDROP_QUERIES - CODEqueryEtryPt_STD_CONF2_CNFNAME_QUERIES - CODEqueryEtryPt_STD_PMOD_QUERIES - CODEqueryEtryPt_STD_PMOD2_QUERIES - CODEqueryEtryPt_STD_FMOD_QUERIES - CODEqueryEtryPt_STD_SMOD_QUERIES - CODEqueryEtryPt_doHUPWrkr - CODEqueryEtryPt_doHUP This general modernization reduces macro misuse, improves DX, and lays the foundation for a robust, automated style normalization system. See also: https://github.com/rsyslog/rsyslog/issues/5747
146 lines
3.9 KiB
C
146 lines
3.9 KiB
C
/* smfwd.c
|
|
* This is a strgen module for the traditional (network) forwarding format.
|
|
*
|
|
* Format generated:
|
|
* "<%PRI%>%TIMESTAMP:::date-rfc3339% %HOSTNAME% %syslogtag:1:32%%msg:::sp-if-no-1st-sp%%msg%"
|
|
*
|
|
* NOTE: read comments in module-template.h to understand how this file
|
|
* works!
|
|
*
|
|
* File begun on 2010-06-01 by RGerhards
|
|
*
|
|
* Copyright 2010-2016 Rainer Gerhards and Adiscon GmbH.
|
|
*
|
|
* This file is part of rsyslog.
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
* -or-
|
|
* see COPYING.ASL20 in the source distribution
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
#include "config.h"
|
|
#include "rsyslog.h"
|
|
#include <stdlib.h>
|
|
#include <string.h>
|
|
#include <assert.h>
|
|
#include <errno.h>
|
|
#include "syslogd.h"
|
|
#include "conf.h"
|
|
#include "syslogd-types.h"
|
|
#include "template.h"
|
|
#include "msg.h"
|
|
#include "module-template.h"
|
|
#include "unicode-helper.h"
|
|
|
|
MODULE_TYPE_STRGEN
|
|
MODULE_TYPE_NOKEEP;
|
|
STRGEN_NAME("RSYSLOG_ForwardFormat")
|
|
|
|
/* internal structures
|
|
*/
|
|
DEF_SMOD_STATIC_DATA;
|
|
|
|
|
|
/* config data */
|
|
|
|
|
|
/* This strgen tries to minimize the amount of reallocs be first obtaining pointers to all strings
|
|
* needed (including their length) and then calculating the actual space required. So when we
|
|
* finally copy, we know exactly what we need. So we do at most one alloc.
|
|
*/
|
|
BEGINstrgen
|
|
register int iBuf;
|
|
const char *pPRI;
|
|
size_t lenPRI;
|
|
uchar *pTimeStamp;
|
|
size_t lenTimeStamp;
|
|
uchar *pHOSTNAME;
|
|
size_t lenHOSTNAME;
|
|
uchar *pTAG;
|
|
int lenTAG;
|
|
uchar *pMSG;
|
|
size_t lenMSG;
|
|
size_t lenTotal;
|
|
CODESTARTstrgen;
|
|
/* first obtain all strings and their length (if not fixed) */
|
|
pPRI = getPRI(pMsg);
|
|
lenPRI = strlen(pPRI);
|
|
pTimeStamp = (uchar*) getTimeReported(pMsg, tplFmtRFC3339Date);
|
|
lenTimeStamp = ustrlen(pTimeStamp);
|
|
pHOSTNAME = (uchar*) getHOSTNAME(pMsg);
|
|
lenHOSTNAME = getHOSTNAMELen(pMsg);
|
|
getTAG(pMsg, &pTAG, &lenTAG, LOCK_MUTEX);
|
|
if(lenTAG > 32)
|
|
lenTAG = 32; /* for forwarding, a max of 32 chars is permitted (RFC!) */
|
|
pMSG = getMSG(pMsg);
|
|
lenMSG = getMSGLen(pMsg);
|
|
|
|
/* calculate len, constants for spaces and similar fixed strings */
|
|
lenTotal = 1 + lenPRI + 1 + lenTimeStamp + 1 + lenHOSTNAME + 1 + lenTAG + lenMSG + 1;
|
|
if(pMSG[0] != ' ')
|
|
++lenTotal; /* then we need to introduce one additional space */
|
|
|
|
/* now make sure buffer is large enough */
|
|
if(lenTotal >= iparam->lenBuf)
|
|
CHKiRet(ExtendBuf(iparam, lenTotal));
|
|
|
|
/* and concatenate the resulting string */
|
|
iparam->param[0] = '<';
|
|
memcpy(iparam->param + 1, pPRI, lenPRI);
|
|
iBuf = lenPRI + 1;
|
|
iparam->param[iBuf++] = '>';
|
|
|
|
memcpy(iparam->param + iBuf, pTimeStamp, lenTimeStamp);
|
|
iBuf += lenTimeStamp;
|
|
iparam->param[iBuf++] = ' ';
|
|
|
|
memcpy(iparam->param + iBuf, pHOSTNAME, lenHOSTNAME);
|
|
iBuf += lenHOSTNAME;
|
|
iparam->param[iBuf++] = ' ';
|
|
|
|
memcpy(iparam->param + iBuf, pTAG, lenTAG);
|
|
iBuf += lenTAG;
|
|
|
|
if(pMSG[0] != ' ')
|
|
iparam->param[iBuf++] = ' ';
|
|
memcpy(iparam->param + iBuf, pMSG, lenMSG);
|
|
iBuf += lenMSG;
|
|
|
|
/* string terminator */
|
|
iparam->param[iBuf] = '\0';
|
|
|
|
iparam->lenStr = lenTotal - 1; /* do not count \0! */
|
|
|
|
finalize_it:
|
|
ENDstrgen
|
|
|
|
|
|
BEGINmodExit
|
|
CODESTARTmodExit;
|
|
ENDmodExit
|
|
|
|
|
|
BEGINqueryEtryPt
|
|
CODESTARTqueryEtryPt;
|
|
CODEqueryEtryPt_STD_SMOD_QUERIES;
|
|
ENDqueryEtryPt
|
|
|
|
|
|
BEGINmodInit(smfwd)
|
|
CODESTARTmodInit;
|
|
*ipIFVersProvided = CURR_MOD_IF_VERSION; /* we only support the current interface specification */
|
|
CODEmodInit_QueryRegCFSLineHdlr
|
|
|
|
dbgprintf("rsyslog standard (network) forward format strgen init called, compiled with version"
|
|
" %s\n", VERSION);
|
|
ENDmodInit
|