1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
|
/* Definition of globally-accessible data items.
*
* This module provides access methods to items of global scope. Most often,
* these globals serve as defaults to initialize local settings. Currently,
* many of them are either constants or global variable references. However,
* this module provides the necessary hooks to change that at any time.
*
* Please note that there currently is no glbl.c file as we do not yet
* have any implementations.
*
* Copyright 2008-2022 Rainer Gerhards and Adiscon GmbH.
*
* This file is part of the rsyslog runtime library.
*
* 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.
*/
#ifndef GLBL_H_INCLUDED
#define GLBL_H_INCLUDED
#include <sys/types.h>
#ifdef ENABLE_LIBLOGGING_STDLOG
#include <liblogging/stdlog.h>
#endif
#include "rainerscript.h"
#include "prop.h"
#define glblGetIOBufSize() 4096 /* size of the IO buffer, e.g. for strm class */
#define glblOversizeMsgInputMode_Truncate 0
#define glblOversizeMsgInputMode_Split 1
#define glblOversizeMsgInputMode_Accept 2
extern pid_t glbl_ourpid;
/* interfaces */
BEGINinterface(glbl) /* name must also be changed in ENDinterface macro! */
uchar* (*GetWorkDir)(rsconf_t *cnf);
int (*GetMaxLine)(rsconf_t *cnf);
#define SIMP_PROP(name, dataType) \
dataType (*Get##name)(void); \
rsRetVal (*Set##name)(dataType);
SIMP_PROP(OptimizeUniProc, int)
SIMP_PROP(PreserveFQDN, int)
SIMP_PROP(LocalFQDNName, uchar*)
SIMP_PROP(mainqCnfObj, struct cnfobj*)
SIMP_PROP(LocalHostName, uchar*)
SIMP_PROP(LocalDomain, uchar*)
/* added v3, 2009-06-30 */
rsRetVal (*GenerateLocalHostNameProperty)(void);
prop_t* (*GetLocalHostNameProp)(void);
/* added v4, 2009-07-20 */
int (*GetGlobalInputTermState)(void);
void (*SetGlobalInputTermination)(void);
/* added v5, 2009-11-03 */
/* note: v4, v5 are already used by more recent versions, so we need to skip them! */
/* added v6, 2009-11-16 as part of varmojfekoj's "unlimited select()" patch
* Note that it must be always present, otherwise the interface would have different
* versions depending on compile settings, what is not acceptable.
* Use this property with care, it is only truly available if UNLIMITED_SELECT is enabled
* (I did not yet further investigate the details, because that code hopefully can be removed
* at some later stage).
*/
SIMP_PROP(FdSetSize, int)
/* v7: was neeeded to mean v5+v6 - do NOT add anything else for that version! */
/* next change is v9! */
/* v8 - 2012-03-21 */
prop_t* (*GetLocalHostIP)(void);
uchar* (*GetSourceIPofLocalClient)(void); /* [ar] */
rsRetVal (*SetSourceIPofLocalClient)(uchar*); /* [ar] */
/* v9 - 2015-01-12 SetMaxLine method removed */
/* v10 - global variables should be moved to the rsconf_t data structure, so
* dynamic configuration reload can be introduced. This is why each getter needs additional
* parameter specifying a configuration it belongs to(either loadConf or runConf)
*/
#undef SIMP_PROP
#define SIMP_PROP(name, dataType) \
dataType (*Get##name)(rsconf_t *cnf); \
rsRetVal (*Set##name)(dataType);
SIMP_PROP(DropMalPTRMsgs, int)
SIMP_PROP(DfltNetstrmDrvrCAF, uchar*)
SIMP_PROP(DfltNetstrmDrvrCRLF, uchar*)
SIMP_PROP(DfltNetstrmDrvrCertFile, uchar*)
SIMP_PROP(DfltNetstrmDrvrKeyFile, uchar*)
SIMP_PROP(DfltNetstrmDrvr, uchar*)
SIMP_PROP(DefPFFamily, int)
SIMP_PROP(DisableDNS, int)
SIMP_PROP(NetstrmDrvrCAExtraFiles, uchar*)
SIMP_PROP(ParserControlCharacterEscapePrefix, uchar)
SIMP_PROP(ParserDropTrailingLFOnReception, int)
SIMP_PROP(ParserEscapeControlCharactersOnReceive, int)
SIMP_PROP(ParserSpaceLFOnReceive, int)
SIMP_PROP(ParserEscape8BitCharactersOnReceive, int)
SIMP_PROP(ParserEscapeControlCharacterTab, int)
SIMP_PROP(ParserEscapeControlCharactersCStyle, int)
SIMP_PROP(ParseHOSTNAMEandTAG, int)
SIMP_PROP(OptionDisallowWarning, int)
#undef SIMP_PROP
ENDinterface(glbl)
#define glblCURR_IF_VERSION 10 /* increment whenever you change the interface structure! */
/* version 2 had PreserveFQDN added - rgerhards, 2008-12-08 */
/* the remaining prototypes */
PROTOTYPEObj(glbl);
extern int glblUnloadModules;
extern short janitorInterval;
extern char** glblDbgFiles;
extern size_t glblDbgFilesNum;
extern int glblDbgWhitelist;
extern int glblPermitCtlC;
extern int bTerminateInputs;
#ifndef HAVE_ATOMIC_BUILTINS
extern DEF_ATOMIC_HELPER_MUT(mutTerminateInputs);
#endif
/* Developer options enable some strange things for developer-only testing.
* These should never be enabled in a user build, except if explicitly told
* by a developer. The options are acutally flags, so they should be powers
* of two. Flag assignment may change between versions, **backward
* compatibility is NOT necessary**.
* rgerhards, 2018-04-28
*/
#define DEV_OPTION_KEEP_RUNNING_ON_HARD_CONF_ERROR 1
#define DEV_OPTION_8_1905_HANG_TEST 2 // TODO: remove - temporary for bughunt
#define glblGetOurPid() glbl_ourpid
#define glblSetOurPid(pid) { glbl_ourpid = (pid); }
void glblPrepCnf(void);
void glblProcessCnf(struct cnfobj *o);
void glblProcessMainQCnf(struct cnfobj *o);
void glblDestructMainqCnfObj(void);
rsRetVal glblDoneLoadCnf(void);
const uchar * glblGetWorkDirRaw(rsconf_t *cnf);
int GetGnuTLSLoglevel(rsconf_t *cnf);
int glblGetMaxLine(rsconf_t *cnf);
int bs_arrcmp_glblDbgFiles(const void *s1, const void *s2);
uchar* glblGetOversizeMsgErrorFile(rsconf_t *cnf);
const uchar* glblGetOperatingStateFile(rsconf_t *cnf);
int glblGetOversizeMsgInputMode(rsconf_t *cnf);
int glblReportOversizeMessage(rsconf_t *cnf);
void glblReportChildProcessExit(rsconf_t *cnf, const uchar *name, pid_t pid, int status);
uchar *glblGetLocalHostName(void);
#endif /* #ifndef GLBL_H_INCLUDED */
|
