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
239
240
241
242
|
/* ompipe.c
* This is the implementation of the build-in pipe output module.
* Note that this module stems back to the "old" (4.4.2 and below)
* omfile. There were some issues with the new omfile code and pipes
* (namely in regard to xconsole), so we took out the pipe code and moved
* that to a separate module. That a) immediately solves the issue for a
* less common use case and probably makes it much easier to enhance
* file and pipe support (now independently) in the future (we always
* needed to think about pipes in omfile so far, what we now no longer
* need to, hopefully resulting in reduction of complexity).
*
* NOTE: read comments in module-template.h to understand how this pipe
* works!
*
* Copyright 2007-2010 Rainer Gerhards and Adiscon GmbH.
*
* This file is part of rsyslog.
*
* Rsyslog 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 3 of the License, or
* (at your option) any later version.
*
* Rsyslog 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 Rsyslog. If not, see <http://www.gnu.org/licenses/>.
*
* 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 <unistd.h>
#include <string.h>
#include <assert.h>
#include <errno.h>
#include <fcntl.h>
#include <unistd.h>
#include <sys/file.h>
#include "syslogd.h"
#include "syslogd-types.h"
#include "srUtils.h"
#include "template.h"
#include "ompipe.h"
#include "omfile.h" /* for dirty trick: access to $ActionFileDefaultTemplate value */
#include "cfsysline.h"
#include "module-template.h"
#include "conf.h"
#include "errmsg.h"
MODULE_TYPE_OUTPUT
/* internal structures
*/
DEF_OMOD_STATIC_DATA
DEFobjCurrIf(errmsg)
/* globals for default values */
/* end globals for default values */
typedef struct _instanceData {
uchar f_fname[MAXFNAME];/* pipe or template name (display only) */
short fd; /* pipe descriptor for (current) pipe */
} instanceData;
BEGINisCompatibleWithFeature
CODESTARTisCompatibleWithFeature
if(eFeat == sFEATURERepeatedMsgReduction)
iRet = RS_RET_OK;
ENDisCompatibleWithFeature
BEGINdbgPrintInstInfo
CODESTARTdbgPrintInstInfo
dbgprintf("pipe %s", pData->f_fname);
if (pData->fd == -1)
dbgprintf(" (unused)");
ENDdbgPrintInstInfo
/* This is now shared code for all types of files. It simply prepares
* pipe access, which, among others, means the the pipe wil be opened
* and any directories in between will be created (based on config, of
* course). -- rgerhards, 2008-10-22
* changed to iRet interface - 2009-03-19
*/
static inline rsRetVal
preparePipe(instanceData *pData)
{
DEFiRet;
pData->fd = open((char*) pData->f_fname, O_RDWR|O_NONBLOCK|O_CLOEXEC);
RETiRet;
}
/* rgerhards 2004-11-11: write to a pipe output. This
* will be called for all outputs using pipe semantics,
* for example also for pipes.
*/
static rsRetVal writePipe(uchar **ppString, instanceData *pData)
{
int iLenWritten;
DEFiRet;
ASSERT(pData != NULL);
if(pData->fd == -1) {
rsRetVal iRetLocal;
iRetLocal = preparePipe(pData);
if((iRetLocal != RS_RET_OK) || (pData->fd == -1))
ABORT_FINALIZE(RS_RET_SUSPENDED); /* whatever the failure was, we need to retry */
}
/* create the message based on format specified */
iLenWritten = write(pData->fd, ppString[0], strlen((char*)ppString[0]));
if(iLenWritten < 0) {
int e = errno;
char errStr[1024];
rs_strerror_r(errno, errStr, sizeof(errStr));
DBGPRINTF("pipe (%d) write error %d: %s\n", pData->fd, e, errStr);
/* If a named pipe is full, we suspend this action for a while */
if(e == EAGAIN)
ABORT_FINALIZE(RS_RET_SUSPENDED);
close(pData->fd);
pData->fd = -1; /* tell that fd is no longer open! */
iRet = RS_RET_SUSPENDED;
errno = e;
errmsg.LogError(0, NO_ERRCODE, "%s", pData->f_fname);
}
finalize_it:
RETiRet;
}
BEGINcreateInstance
CODESTARTcreateInstance
pData->fd = -1;
ENDcreateInstance
BEGINfreeInstance
CODESTARTfreeInstance
if(pData->fd != -1)
close(pData->fd);
ENDfreeInstance
BEGINtryResume
CODESTARTtryResume
ENDtryResume
BEGINdoAction
CODESTARTdoAction
DBGPRINTF(" (%s)\n", pData->f_fname);
iRet = writePipe(ppString, pData);
ENDdoAction
BEGINparseSelectorAct
CODESTARTparseSelectorAct
/* yes, the if below is redundant, but I need it now. Will go away as
* the code further changes. -- rgerhards, 2007-07-25
*/
if(*p == '|') {
if((iRet = createInstance(&pData)) != RS_RET_OK) {
ENDfunc
return iRet; /* this can not use RET_iRet! */
}
} else {
/* this is not clean, but we need it for the time being
* TODO: remove when cleaning up modularization
*/
ENDfunc
return RS_RET_CONFLINE_UNPROCESSED;
}
CODE_STD_STRING_REQUESTparseSelectorAct(1)
++p;
/* rgerhards 2004-11-17: from now, we need to have different
* processing, because after the first comma, the template name
* to use is specified. So we need to scan for the first coma first
* and then look at the rest of the line.
*/
CHKiRet(cflineParseFileName(p, (uchar*) pData->f_fname, *ppOMSR, 0, OMSR_NO_RQD_TPL_OPTS,
(pszFileDfltTplName == NULL) ? (uchar*)"RSYSLOG_FileFormat" : pszFileDfltTplName));
/* at this stage, we ignore the return value of preparePipe, this is taken
* care of in later steps. -- rgerhards, 2009-03-19
*/
preparePipe(pData);
if(pData->fd < 0 ) {
pData->fd = -1;
DBGPRINTF("Error opening log pipe: %s\n", pData->f_fname);
errmsg.LogError(0, RS_RET_NO_FILE_ACCESS, "Could not open output pipe '%s'", pData->f_fname);
}
CODE_STD_FINALIZERparseSelectorAct
ENDparseSelectorAct
BEGINdoHUP
CODESTARTdoHUP
if(pData->fd != -1) {
close(pData->fd);
pData->fd = -1;
}
ENDdoHUP
BEGINmodExit
CODESTARTmodExit
ENDmodExit
BEGINqueryEtryPt
CODESTARTqueryEtryPt
CODEqueryEtryPt_STD_OMOD_QUERIES
CODEqueryEtryPt_doHUP
ENDqueryEtryPt
BEGINmodInit(Pipe)
CODESTARTmodInit
*ipIFVersProvided = CURR_MOD_IF_VERSION; /* we only support the current interface specification */
CODEmodInit_QueryRegCFSLineHdlr
CHKiRet(objUse(errmsg, CORE_COMPONENT));
ENDmodInit
/* vi:set ai:
*/
|
