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
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
|
/* The rsconf object. It models a complete rsyslog configuration.
*
* Copyright 2011 Rainer Gerhards and Adiscon GmbH.
*
* This file is part of the rsyslog runtime library.
*
* The rsyslog runtime library is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* The rsyslog runtime library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with the rsyslog runtime library. If not, see <http://www.gnu.org/licenses/>.
*
* A copy of the GPL can be found in the file "COPYING" in this distribution.
* A copy of the LGPL can be found in the file "COPYING.LESSER" in this distribution.
*/
#ifndef INCLUDED_RSCONF_H
#define INCLUDED_RSCONF_H
#include "linkedlist.h"
#include "queue.h"
/* --- configuration objects (the plan is to have ALL upper layers in this file) --- */
/* queue config parameters. TODO: move to queue.c? */
struct queuecnf_s {
int iMainMsgQueueSize; /* size of the main message queue above */
int iMainMsgQHighWtrMark; /* high water mark for disk-assisted queues */
int iMainMsgQLowWtrMark; /* low water mark for disk-assisted queues */
int iMainMsgQDiscardMark; /* begin to discard messages */
int iMainMsgQDiscardSeverity; /* by default, discard nothing to prevent unintentional loss */
int iMainMsgQueueNumWorkers; /* number of worker threads for the mm queue above */
queueType_t MainMsgQueType; /* type of the main message queue above */
uchar *pszMainMsgQFName; /* prefix for the main message queue file */
int64 iMainMsgQueMaxFileSize;
int iMainMsgQPersistUpdCnt; /* persist queue info every n updates */
int bMainMsgQSyncQeueFiles; /* sync queue files on every write? */
int iMainMsgQtoQShutdown; /* queue shutdown (ms) */
int iMainMsgQtoActShutdown; /* action shutdown (in phase 2) */
int iMainMsgQtoEnq; /* timeout for queue enque */
int iMainMsgQtoWrkShutdown; /* timeout for worker thread shutdown */
int iMainMsgQWrkMinMsgs; /* minimum messages per worker needed to start a new one */
int iMainMsgQDeqSlowdown; /* dequeue slowdown (simple rate limiting) */
int64 iMainMsgQueMaxDiskSpace; /* max disk space allocated 0 ==> unlimited */
int64 iMainMsgQueDeqBatchSize; /* dequeue batch size */
int bMainMsgQSaveOnShutdown; /* save queue on shutdown (when DA enabled)? */
int iMainMsgQueueDeqtWinFromHr; /* hour begin of time frame when queue is to be dequeued */
int iMainMsgQueueDeqtWinToHr; /* hour begin of time frame when queue is to be dequeued */
};
/* globals are data items that are really global, and can be set only
* once (at least in theory, because the legacy system permits them to
* be re-set as often as the user likes).
*/
struct globals_s {
int bDebugPrintTemplateList;
int bDebugPrintModuleList;
int bDebugPrintCfSysLineHandlerList;
int bLogStatusMsgs; /* log rsyslog start/stop/HUP messages? */
int bErrMsgToStderr; /* print error messages to stderr
(in addition to everything else)? */
int bAbortOnUncleanConfig; /* abort run (rather than starting with partial
config) if there was any issue in conf */
int uidDropPriv; /* user-id to which priveleges should be dropped to */
int gidDropPriv; /* group-id to which priveleges should be dropped to */
int umask; /* umask to use */
uchar *pszConfDAGFile; /* name of config DAG file, non-NULL means generate one */
// TODO are the following ones defaults?
int bReduceRepeatMsgs; /* reduce repeated message - 0 - no, 1 - yes */
//TODO: other representation for main queue? Or just load it differently?
queuecnf_t mainQ; /* main queue paramters */
};
/* (global) defaults are global in the sense that they are accessible
* to all code, but they can change value and other objects (like
* actions) actually copy the value a global had at the time the action
* was defined. In that sense, a global default is just that, a default,
* wich can (and will) be changed in the course of config file
* processing. Once the config file has been processed, defaults
* can be dropped. The current code does not do this for simplicity.
* That is not a problem, because the defaults do not take up much memory.
* At a later stage, we may think about dropping them. -- rgerhards, 2011-04-19
*/
struct defaults_s {
};
/* list of modules loaded in this configuration (config specific module list) */
struct cfgmodules_etry_s {
cfgmodules_etry_t *next;
modInfo_t *pMod;
void *modCnf; /* pointer to the input module conf */
/* the following data is input module specific */
sbool canActivate; /* OK to activate this config? */
sbool canRun; /* OK to run this config? */
};
struct cfgmodules_s {
cfgmodules_etry_t *root;
};
/* outchannel-specific data */
struct outchannels_s {
struct outchannel *ochRoot; /* the root of the outchannel list */
struct outchannel *ochLast; /* points to the last element of the outchannel list */
};
struct templates_s {
struct template *root; /* the root of the template list */
struct template *last; /* points to the last element of the template list */
struct template *lastStatic; /* last static element of the template list */
};
struct actions_s {
unsigned nbrActions; /* number of actions */
};
struct rulesets_s {
linkedList_t llRulesets; /* this is NOT a pointer - no typo here ;) */
/* support for legacy rsyslog.conf format */
ruleset_t *pCurr; /* currently "active" ruleset */
ruleset_t *pDflt; /* current default ruleset, e.g. for binding to actions which have no other */
};
/* --- end configuration objects --- */
/* the rsconf object */
struct rsconf_s {
BEGINobjInstance; /* Data to implement generic object - MUST be the first data element! */
cfgmodules_t modules;
globals_t globals;
defaults_t defaults;
templates_t templates;
outchannels_t och;
actions_t actions;
rulesets_t rulesets;
/* note: rulesets include the complete output part:
* - rules
* - filter (as part of the action)
* - actions
* Of course, we need to debate if we shall change that some time...
*/
};
/* interfaces */
BEGINinterface(rsconf) /* name must also be changed in ENDinterface macro! */
INTERFACEObjDebugPrint(rsconf);
rsRetVal (*Construct)(rsconf_t **ppThis);
rsRetVal (*ConstructFinalize)(rsconf_t __attribute__((unused)) *pThis);
rsRetVal (*Destruct)(rsconf_t **ppThis);
rsRetVal (*Load)(rsconf_t **ppThis, uchar *confFile);
rsRetVal (*Activate)(rsconf_t *ppThis);
ENDinterface(rsconf)
// TODO: switch version to 1 for first "complete" version!!!! 2011-04-20
#define rsconfCURR_IF_VERSION 0 /* increment whenever you change the interface above! */
/* prototypes */
PROTOTYPEObj(rsconf);
/* globally-visible external data */
extern rsconf_t *runConf;/* the currently running config */
extern rsconf_t *loadConf;/* the config currently being loaded (no concurrent config load supported!) */
/* some defaults (to be removed?) */
#define DFLT_bLogStatusMsgs 1
#endif /* #ifndef INCLUDED_RSCONF_H */
|
