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
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
|
/* modules.c
* This is the implementation of syslogd modules object.
* This object handles plug-ins and buil-in modules of all kind.
*
* File begun on 2007-07-22 by RGerhards
*
* Copyright 2007 Rainer Gerhards and Adiscon GmbH.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*
* A copy of the GPL can be found in the file "COPYING" in this distribution.
*/
#include "config.h"
#include "rsyslog.h"
#include <stdio.h>
#include <stdarg.h>
#include <stdlib.h>
#include <string.h>
#include <time.h>
#include <assert.h>
#include <errno.h>
#include <unistd.h>
#include <sys/file.h>
#include "syslogd.h"
#include "modules.h"
static modInfo_t *pLoadedModules = NULL; /* list of currently-loaded modules */
static modInfo_t *pLoadedModulesLast = NULL; /* tail-pointer */
/* Construct a new module object
*/
static rsRetVal moduleConstruct(modInfo_t **pThis)
{
modInfo_t *pNew;
if((pNew = calloc(1, sizeof(modInfo_t))) == NULL)
return RS_RET_OUT_OF_MEMORY;
/* OK, we got the element, now initialize members that should
* not be zero-filled.
*/
*pThis = pNew;
return RS_RET_OK;
}
/* Destructs a module objects. The object must not be linked to the
* linked list of modules.
*/
static void moduleDestruct(modInfo_t *pThis)
{
free(pThis);
}
/* get the state-name of a module. The state name is its name
* together with a short description of the module state (which
* is pulled from the module itself.
* rgerhards, 2007-07-24
* TODO: the actual state name is not yet pulled
*/
uchar *modGetStateName(modInfo_t *pThis)
{
return(modGetName(pThis));
}
/* get the name of a module
*/
uchar *modGetName(modInfo_t *pThis)
{
return((pThis->pszName == NULL) ? (uchar*) "" : pThis->pszName);
}
/* Add a module to the loaded module linked list
*/
static inline void addModToList(modInfo_t *pThis)
{
assert(pThis != NULL);
if(pLoadedModules == NULL) {
pLoadedModules = pLoadedModulesLast = pThis;
} else {
/* there already exist entries */
pLoadedModulesLast->pNext = pThis;
pLoadedModulesLast = pThis;
}
}
/* Get the next module pointer - this is used to traverse the list.
* The function returns the next pointer or NULL, if there is no next one.
* The last object must be provided to the function. If NULL is provided,
* it starts at the root of the list. Even in this case, NULL may be
* returned - then, the list is empty.
* rgerhards, 2007-07-23
*/
modInfo_t *modGetNxt(modInfo_t *pThis)
{
modInfo_t *pNew;
if(pThis == NULL)
pNew = pLoadedModules;
else
pNew = pThis->pNext;
return(pNew);
}
/* this function is like modGetNxt(), but it returns pointers to
* output modules only. As we currently deal just with output modules,
* it is a dummy, to be filled with real code later.
* rgerhards, 2007-07-24
*/
modInfo_t *omodGetNxt(modInfo_t *pThis)
{
return(modGetNxt(pThis));
}
/* Add an already-loaded module to the module linked list. This function does
* anything that is needed to fully initialize the module.
*/
rsRetVal doModInit(rsRetVal (*modInit)(int, int*, rsRetVal(**)()), uchar *name)
{
modInfo_t *pNew;
rsRetVal iRet;
assert(modInit != NULL);
if((iRet = moduleConstruct(&pNew)) != RS_RET_OK)
return iRet;
if((iRet = (*modInit)(1, &pNew->iIFVers, &pNew->modQueryEtryPt)) != RS_RET_OK) {
moduleDestruct(pNew);
return iRet;
}
if(pNew->iIFVers != 1) {
moduleDestruct(pNew);
return RS_RET_MISSING_INTERFACE;
}
/* OK, we know we can successfully work with the module. So we now fill the
* rest of the data elements.
*/
if((iRet = (*pNew->modQueryEtryPt)((uchar*)"doAction", &pNew->mod.om.doAction)) != RS_RET_OK) {
moduleDestruct(pNew);
return iRet;
}
if((iRet = (*pNew->modQueryEtryPt)((uchar*)"parseSelectorAct", &pNew->mod.om.parseSelectorAct)) != RS_RET_OK) {
moduleDestruct(pNew);
return iRet;
}
if((iRet = (*pNew->modQueryEtryPt)((uchar*)"isCompatibleWithFeature",
&pNew->isCompatibleWithFeature)) != RS_RET_OK) {
moduleDestruct(pNew);
return iRet;
}
if((iRet = (*pNew->modQueryEtryPt)((uchar*)"dbgPrintInstInfo",
&pNew->dbgPrintInstInfo)) != RS_RET_OK) {
moduleDestruct(pNew);
return iRet;
}
if((iRet = (*pNew->modQueryEtryPt)((uchar*)"getWriteFDForSelect", &pNew->getWriteFDForSelect)) != RS_RET_OK) {
moduleDestruct(pNew);
return iRet;
}
if((iRet = (*pNew->modQueryEtryPt)((uchar*)"freeInstance", &pNew->freeInstance)) != RS_RET_OK) {
moduleDestruct(pNew);
return iRet;
}
pNew->pszName = (uchar*) strdup((char*)name); /* we do not care if strdup() fails, we can accept that */
pNew->eType = eMOD_OUT; /* TODO: take this from module */
/* we initialized the structure, now let's add it to the linked list of modules */
addModToList(pNew);
return RS_RET_OK;
}
/* Print loaded modules. This is more or less a
* debug or test aid, but anyhow I think it's worth it...
* This only works if the dprintf() subsystem is initialized.
*/
void modPrintList(void)
{
modInfo_t *pMod;
pMod = modGetNxt(NULL);
while(pMod != NULL) {
dprintf("Loaded Module: Name='%s', IFVersion=%d, ",
(char*) modGetName(pMod), pMod->iIFVers);
dprintf("type=");
switch(pMod->eType) {
case eMOD_OUT:
dprintf("output");
break;
case eMOD_IN:
dprintf("input");
break;
case eMOD_FILTER:
dprintf("filter");
break;
}
dprintf(" module.\n");
dprintf("Entry points:\n");
dprintf("\tqueryEtryPt: 0x%x\n", (unsigned) pMod->modQueryEtryPt);
dprintf("\tdoAction: 0x%x\n", (unsigned) pMod->mod.om.doAction);
dprintf("\tparseSelectorAct: 0x%x\n", (unsigned) pMod->mod.om.parseSelectorAct);
dprintf("\tdbgPrintInstInfo: 0x%x\n", (unsigned) pMod->dbgPrintInstInfo);
dprintf("\tfreeInstance: 0x%x\n", (unsigned) pMod->freeInstance);
dprintf("\n");
pMod = modGetNxt(pMod); /* done, go next */
}
}
/*
* vi:set ai:
*/
|
