0b7bbc96fff880b2b8c2653cf735d1fa1f3cbda5
[rsyslog.git] / tools / syslogd.c
1 /**
2  * \brief This is the main file of the rsyslogd daemon.
3  *
4  * Please visit the rsyslog project at
5  *
6  * http://www.rsyslog.com
7  *
8  * to learn more about it and discuss any questions you may have.
9  *
10  * rsyslog had initially been forked from the sysklogd project.
11  * I would like to express my thanks to the developers of the sysklogd
12  * package - without it, I would have had a much harder start...
13  *
14  * Please note that while rsyslog started from the sysklogd code base,
15  * it nowadays has almost nothing left in common with it. Allmost all
16  * parts of the code have been rewritten.
17  *
18  * This Project was intiated and is maintained by
19  * Rainer Gerhards <rgerhards@hq.adiscon.com>.
20  *
21  * For further information, please see http://www.rsyslog.com
22  *
23  * rsyslog - An Enhanced syslogd Replacement.
24  * Copyright 2003-2009 Rainer Gerhards and Adiscon GmbH.
25  *
26  * This file is part of rsyslog.
27  *
28  * Rsyslog is free software: you can redistribute it and/or modify
29  * it under the terms of the GNU General Public License as published by
30  * the Free Software Foundation, either version 3 of the License, or
31  * (at your option) any later version.
32  *
33  * Rsyslog is distributed in the hope that it will be useful,
34  * but WITHOUT ANY WARRANTY; without even the implied warranty of
35  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
36  * GNU General Public License for more details.
37  *
38  * You should have received a copy of the GNU General Public License
39  * along with Rsyslog.  If not, see <http://www.gnu.org/licenses/>.
40  *
41  * A copy of the GPL can be found in the file "COPYING" in this distribution.
42  */
43 #include "config.h"
44 #include "rsyslog.h"
45
46 #define DEFUPRI         (LOG_USER|LOG_NOTICE)
47 #define TIMERINTVL      30              /* interval for checking flush, mark */
48
49 #include <unistd.h>
50 #include <stdlib.h>
51 #include <stdio.h>
52 #include <stddef.h>
53 #include <ctype.h>
54 #include <limits.h>
55 #define GNU_SOURCE
56 #include <string.h>
57 #include <stdarg.h>
58 #include <time.h>
59 #include <assert.h>
60
61 #ifdef OS_SOLARIS
62 #       include <errno.h>
63 #       include <fcntl.h>
64 #       include <stropts.h>
65 #       include <sys/termios.h>
66 #       include <sys/types.h>
67 #else
68 #       include <libgen.h>
69 #       include <sys/errno.h>
70 #endif
71
72 #include <sys/ioctl.h>
73 #include <sys/wait.h>
74 #include <sys/file.h>
75 #include <sys/resource.h>
76 #include <grp.h>
77
78 #if HAVE_SYS_TIMESPEC_H
79 # include <sys/timespec.h>
80 #endif
81
82 #if HAVE_SYS_STAT_H
83 #       include <sys/stat.h>
84 #endif
85
86 #include <signal.h>
87
88 #if HAVE_PATHS_H
89 #include <paths.h>
90 #endif
91
92 #ifdef USE_NETZIP
93 #include <zlib.h>
94 #endif
95
96 #include <netdb.h>
97
98 #include "pidfile.h"
99 #include "srUtils.h"
100 #include "stringbuf.h"
101 #include "syslogd-types.h"
102 #include "template.h"
103 #include "outchannel.h"
104 #include "syslogd.h"
105
106 #include "msg.h"
107 #include "modules.h"
108 #include "action.h"
109 #include "iminternal.h"
110 #include "cfsysline.h"
111 #include "omshell.h"
112 #include "omusrmsg.h"
113 #include "omfwd.h"
114 #include "omfile.h"
115 #include "ompipe.h"
116 #include "omdiscard.h"
117 #include "pmrfc5424.h"
118 #include "pmrfc3164.h"
119 #include "smfile.h"
120 #include "smtradfile.h"
121 #include "smfwd.h"
122 #include "smtradfwd.h"
123 #include "threads.h"
124 #include "wti.h"
125 #include "queue.h"
126 #include "stream.h"
127 #include "conf.h"
128 #include "errmsg.h"
129 #include "datetime.h"
130 #include "parser.h"
131 #include "batch.h"
132 #include "unicode-helper.h"
133 #include "ruleset.h"
134 #include "rule.h"
135 #include "net.h"
136 #include "vm.h"
137 #include "prop.h"
138 #include "sd-daemon.h"
139
140 /* definitions for objects we access */
141 DEFobjCurrIf(obj)
142 DEFobjCurrIf(glbl)
143 DEFobjCurrIf(datetime) /* TODO: make go away! */
144 DEFobjCurrIf(conf)
145 DEFobjCurrIf(expr)
146 DEFobjCurrIf(module)
147 DEFobjCurrIf(errmsg)
148 DEFobjCurrIf(rule)
149 DEFobjCurrIf(ruleset)
150 DEFobjCurrIf(prop)
151 DEFobjCurrIf(parser)
152 DEFobjCurrIf(net) /* TODO: make go away! */
153
154
155 /* forward definitions */
156 static rsRetVal GlobalClassExit(void);
157
158
159 #ifndef _PATH_LOGCONF 
160 #define _PATH_LOGCONF   "/etc/rsyslog.conf"
161 #endif
162
163 #ifndef _PATH_MODDIR
164 #       if defined(__FreeBSD__)
165 #               define _PATH_MODDIR     "/usr/local/lib/rsyslog/"
166 #       else
167 #               define _PATH_MODDIR     "/lib/rsyslog/"
168 #       endif
169 #endif
170
171 #if defined(SYSLOGD_PIDNAME)
172 #       undef _PATH_LOGPID
173 #       if defined(FSSTND)
174 #               ifdef OS_BSD
175 #                       define _PATH_VARRUN "/var/run/"
176 #               endif
177 #               if defined(__sun) || defined(__hpux)
178 #                       define _PATH_VARRUN "/var/run/"
179 #               endif
180 #               define _PATH_LOGPID _PATH_VARRUN SYSLOGD_PIDNAME
181 #       else
182 #               define _PATH_LOGPID "/etc/" SYSLOGD_PIDNAME
183 #       endif
184 #else
185 #       ifndef _PATH_LOGPID
186 #               if defined(__sun) || defined(__hpux)
187 #                       define _PATH_VARRUN "/var/run/"
188 #               endif
189 #               if defined(FSSTND)
190 #                       define _PATH_LOGPID _PATH_VARRUN "rsyslogd.pid"
191 #               else
192 #                       define _PATH_LOGPID "/etc/rsyslogd.pid"
193 #               endif
194 #       endif
195 #endif
196
197 #ifndef _PATH_TTY
198 #       define _PATH_TTY        "/dev/tty"
199 #endif
200
201 static prop_t *pInternalInputName = NULL;       /* there is only one global inputName for all internally-generated messages */
202 static prop_t *pLocalHostIP = NULL;             /* there is only one global IP for all internally-generated messages */
203 static uchar    *ConfFile = (uchar*) _PATH_LOGCONF; /* read-only after startup */
204 static char     *PidFile = _PATH_LOGPID; /* read-only after startup */
205
206 static pid_t myPid;     /* our pid for use in self-generated messages, e.g. on startup */
207 /* mypid is read-only after the initial fork() */
208 static int bHadHUP = 0; /* did we have a HUP? */
209
210 static int bFinished = 0;       /* used by termination signal handler, read-only except there
211                                  * is either 0 or the number of the signal that requested the
212                                  * termination.
213                                  */
214 static int iConfigVerify = 0;   /* is this just a config verify run? */
215
216 /* Intervals at which we flush out "message repeated" messages,
217  * in seconds after previous message is logged.  After each flush,
218  * we move to the next interval until we reach the largest.
219  * TODO: this shall go into action object! -- rgerhards, 2008-01-29
220  */
221 int     repeatinterval[2] = { 30, 60 }; /* # of secs before flush */
222
223 #define LIST_DELIMITER  ':'             /* delimiter between two hosts */
224
225 static pid_t ppid; /* This is a quick and dirty hack used for spliting main/startup thread */
226
227 typedef struct legacyOptsLL_s {
228         uchar *line;
229         struct legacyOptsLL_s *next;
230 } legacyOptsLL_t;
231 legacyOptsLL_t *pLegacyOptsLL = NULL;
232
233 /* global variables for config file state */
234 int     iCompatibilityMode = 0;         /* version we should be compatible with; 0 means sysklogd. It is
235                                            the default, so if no -c<n> option is given, we make ourselvs
236                                            as compatible to sysklogd as possible. */
237 #define DFLT_bLogStatusMsgs 1
238 static int      bLogStatusMsgs = DFLT_bLogStatusMsgs;   /* log rsyslog start/stop/HUP messages? */
239 static int      bDebugPrintTemplateList = 1;/* output template list in debug mode? */
240 static int      bDebugPrintCfSysLineHandlerList = 1;/* output cfsyslinehandler list in debug mode? */
241 static int      bDebugPrintModuleList = 1;/* output module list in debug mode? */
242 static int      bErrMsgToStderr = 1; /* print error messages to stderr (in addition to everything else)? */
243 int     bReduceRepeatMsgs; /* reduce repeated message - 0 - no, 1 - yes */
244 int     bAbortOnUncleanConfig = 0; /* abort run (rather than starting with partial config) if there was any issue in conf */
245 int     bActExecWhenPrevSusp; /* execute action only when previous one was suspended? */
246 /* end global config file state variables */
247
248 int     MarkInterval = 20 * 60; /* interval between marks in seconds - read-only after startup */
249 int      send_to_all = 0;        /* send message to all IPv4/IPv6 addresses */
250 static int      NoFork = 0;     /* don't fork - don't run in daemon mode - read-only after startup */
251 static int      bHaveMainQueue = 0;/* set to 1 if the main queue - in queueing mode - is available
252                                  * If the main queue is either not yet ready or not running in 
253                                  * queueing mode (mode DIRECT!), then this is set to 0.
254                                  */
255 static int uidDropPriv = 0;     /* user-id to which priveleges should be dropped to (AFTER init()!) */
256 static int gidDropPriv = 0;     /* group-id to which priveleges should be dropped to (AFTER init()!) */
257
258 extern  int errno;
259
260 static uchar *pszConfDAGFile = NULL;                            /* name of config DAG file, non-NULL means generate one */
261 /* main message queue and its configuration parameters */
262 qqueue_t *pMsgQueue = NULL;                             /* the main message queue */
263 static int iMainMsgQueueSize = 10000;                           /* size of the main message queue above */
264 static int iMainMsgQHighWtrMark = 8000;                         /* high water mark for disk-assisted queues */
265 static int iMainMsgQLowWtrMark = 2000;                          /* low water mark for disk-assisted queues */
266 static int iMainMsgQDiscardMark = 9800;                         /* begin to discard messages */
267 static int iMainMsgQDiscardSeverity = 8;                        /* by default, discard nothing to prevent unintentional loss */
268 static int iMainMsgQueueNumWorkers = 1;                         /* number of worker threads for the mm queue above */
269 static queueType_t MainMsgQueType = QUEUETYPE_FIXED_ARRAY;      /* type of the main message queue above */
270 static uchar *pszMainMsgQFName = NULL;                          /* prefix for the main message queue file */
271 static int64 iMainMsgQueMaxFileSize = 1024*1024;
272 static int iMainMsgQPersistUpdCnt = 0;                          /* persist queue info every n updates */
273 static int bMainMsgQSyncQeueFiles = 0;                          /* sync queue files on every write? */
274 static int iMainMsgQtoQShutdown = 1500;                         /* queue shutdown (ms) */ 
275 static int iMainMsgQtoActShutdown = 1000;                       /* action shutdown (in phase 2) */ 
276 static int iMainMsgQtoEnq = 2000;                               /* timeout for queue enque */ 
277 static int iMainMsgQtoWrkShutdown = 60000;                      /* timeout for worker thread shutdown */
278 static int iMainMsgQWrkMinMsgs = 100;                           /* minimum messages per worker needed to start a new one */
279 static int iMainMsgQDeqSlowdown = 0;                            /* dequeue slowdown (simple rate limiting) */
280 static int64 iMainMsgQueMaxDiskSpace = 0;                       /* max disk space allocated 0 ==> unlimited */
281 static int64 iMainMsgQueDeqBatchSize = 32;                      /* dequeue batch size */
282 static int bMainMsgQSaveOnShutdown = 1;                         /* save queue on shutdown (when DA enabled)? */
283 static int iMainMsgQueueDeqtWinFromHr = 0;                      /* hour begin of time frame when queue is to be dequeued */
284 static int iMainMsgQueueDeqtWinToHr = 25;                       /* hour begin of time frame when queue is to be dequeued */
285
286
287 /* Reset config variables to default values.
288  * rgerhards, 2007-07-17
289  */
290 static rsRetVal resetConfigVariables(uchar __attribute__((unused)) *pp, void __attribute__((unused)) *pVal)
291 {
292         bLogStatusMsgs = DFLT_bLogStatusMsgs;
293         bActExecWhenPrevSusp = 0;
294         bDebugPrintTemplateList = 1;
295         bDebugPrintCfSysLineHandlerList = 1;
296         bDebugPrintModuleList = 1;
297         bReduceRepeatMsgs = 0;
298         bAbortOnUncleanConfig = 0;
299         free(pszMainMsgQFName);
300         pszMainMsgQFName = NULL;
301         iMainMsgQueueSize = 10000;
302         iMainMsgQHighWtrMark = 8000;
303         iMainMsgQLowWtrMark = 2000;
304         iMainMsgQDiscardMark = 9800;
305         iMainMsgQDiscardSeverity = 8;
306         iMainMsgQueMaxFileSize = 1024 * 1024;
307         iMainMsgQueueNumWorkers = 1;
308         iMainMsgQPersistUpdCnt = 0;
309         bMainMsgQSyncQeueFiles = 0;
310         iMainMsgQtoQShutdown = 1500;
311         iMainMsgQtoActShutdown = 1000;
312         iMainMsgQtoEnq = 2000;
313         iMainMsgQtoWrkShutdown = 60000;
314         iMainMsgQWrkMinMsgs = 100;
315         iMainMsgQDeqSlowdown = 0;
316         bMainMsgQSaveOnShutdown = 1;
317         MainMsgQueType = QUEUETYPE_FIXED_ARRAY;
318         iMainMsgQueMaxDiskSpace = 0;
319         iMainMsgQueDeqBatchSize = 32;
320         glbliActionResumeRetryCount = 0;
321
322         return RS_RET_OK;
323 }
324
325
326 /* hardcoded standard templates (used for defaults) */
327 static uchar template_DebugFormat[] = "\"Debug line with all properties:\nFROMHOST: '%FROMHOST%', fromhost-ip: '%fromhost-ip%', HOSTNAME: '%HOSTNAME%', PRI: %PRI%,\nsyslogtag '%syslogtag%', programname: '%programname%', APP-NAME: '%APP-NAME%', PROCID: '%PROCID%', MSGID: '%MSGID%',\nTIMESTAMP: '%TIMESTAMP%', STRUCTURED-DATA: '%STRUCTURED-DATA%',\nmsg: '%msg%'\nescaped msg: '%msg:::drop-cc%'\ninputname: %inputname% rawmsg: '%rawmsg%'\n\n\"";
328 static uchar template_SyslogProtocol23Format[] = "\"<%PRI%>1 %TIMESTAMP:::date-rfc3339% %HOSTNAME% %APP-NAME% %PROCID% %MSGID% %STRUCTURED-DATA% %msg%\n\"";
329 static uchar template_TraditionalFileFormat[] = "=RSYSLOG_TraditionalFileFormat";
330 static uchar template_FileFormat[] = "=RSYSLOG_FileFormat";
331 static uchar template_ForwardFormat[] = "=RSYSLOG_ForwardFormat";
332 static uchar template_TraditionalForwardFormat[] = "=RSYSLOG_TraditionalForwardFormat";
333 static uchar template_WallFmt[] = "\"\r\n\7Message from syslogd@%HOSTNAME% at %timegenerated% ...\r\n %syslogtag%%msg%\n\r\"";
334 static uchar template_StdUsrMsgFmt[] = "\" %syslogtag%%msg%\n\r\"";
335 static uchar template_StdDBFmt[] = "\"insert into SystemEvents (Message, Facility, FromHost, Priority, DeviceReportedTime, ReceivedAt, InfoUnitID, SysLogTag) values ('%msg%', %syslogfacility%, '%HOSTNAME%', %syslogpriority%, '%timereported:::date-mysql%', '%timegenerated:::date-mysql%', %iut%, '%syslogtag%')\",SQL";
336 static uchar template_StdPgSQLFmt[] = "\"insert into SystemEvents (Message, Facility, FromHost, Priority, DeviceReportedTime, ReceivedAt, InfoUnitID, SysLogTag) values ('%msg%', %syslogfacility%, '%HOSTNAME%', %syslogpriority%, '%timereported:::date-pgsql%', '%timegenerated:::date-pgsql%', %iut%, '%syslogtag%')\",STDSQL";
337 static uchar template_spoofadr[] = "\"%fromhost-ip%\"";
338 /* end templates */
339
340
341 /* up to the next comment, prototypes that should be removed by reordering */
342 /* Function prototypes. */
343 static char **crunch_list(char *list);
344 static void reapchild();
345 static void debug_switch();
346 static void sighup_handler();
347
348
349 static int usage(void)
350 {
351         fprintf(stderr, "usage: rsyslogd [-c<version>] [-46AdnqQvwx] [-l<hostlist>] [-s<domainlist>]\n"
352                         "                [-f<conffile>] [-i<pidfile>] [-N<level>] [-M<module load path>]\n"
353                         "                [-u<number>]\n"
354                         "To run rsyslogd in native mode, use \"rsyslogd -c5 <other options>\"\n\n"
355                         "For further information see http://www.rsyslog.com/doc\n");
356         exit(1); /* "good" exit - done to terminate usage() */
357 }
358
359
360 /* ------------------------------ some support functions for imdiag ------------------------------ *
361  * This is a bit dirty, but the only way to do it, at least with reasonable effort.
362  * rgerhards, 2009-05-25
363  */
364
365 /* return back the approximate current number of messages in the main message queue
366  * This number includes the messages that reside in an associated DA queue (if
367  * it exists) -- rgerhards, 2009-10-14
368  */
369 rsRetVal
370 diagGetMainMsgQSize(int *piSize)
371 {
372         DEFiRet;
373         assert(piSize != NULL);
374         *piSize = (pMsgQueue->pqDA != NULL) ? pMsgQueue->pqDA->iQueueSize : 0;
375         *piSize += pMsgQueue->iQueueSize;
376         RETiRet;
377 }
378
379
380 /* ------------------------------ end support functions for imdiag  ------------------------------ */
381
382
383 /* rgerhards, 2005-10-24: crunch_list is called only during option processing. So
384  * it is never called once rsyslogd is running. This code
385  * contains some exits, but they are considered safe because they only happen
386  * during startup. Anyhow, when we review the code here, we might want to
387  * reconsider the exit()s.
388  */
389 static char **crunch_list(char *list)
390 {
391         int count, i;
392         char *p, *q;
393         char **result = NULL;
394
395         p = list;
396
397         /* strip off trailing delimiters */
398         while (p[strlen(p)-1] == LIST_DELIMITER) {
399                 count--;
400                 p[strlen(p)-1] = '\0';
401         }
402         /* cut off leading delimiters */
403         while (p[0] == LIST_DELIMITER) {
404                 count--;
405                p++;
406         }
407
408         /* count delimiters to calculate elements */
409         for (count=i=0; p[i]; i++)
410                 if (p[i] == LIST_DELIMITER) count++;
411
412         if ((result = (char **)MALLOC(sizeof(char *) * (count+2))) == NULL) {
413                 printf ("Sorry, can't get enough memory, exiting.\n");
414                 exit(0); /* safe exit, because only called during startup */
415         }
416
417         /*
418          * We now can assume that the first and last
419          * characters are different from any delimiters,
420          * so we don't have to care about this.
421          */
422         count = 0;
423         while ((q=strchr(p, LIST_DELIMITER))) {
424                 result[count] = (char *) MALLOC((q - p + 1) * sizeof(char));
425                 if (result[count] == NULL) {
426                         printf ("Sorry, can't get enough memory, exiting.\n");
427                         exit(0); /* safe exit, because only called during startup */
428                 }
429                 strncpy(result[count], p, q - p);
430                 result[count][q - p] = '\0';
431                 p = q; p++;
432                 count++;
433         }
434         if ((result[count] = \
435              (char *)MALLOC(sizeof(char) * strlen(p) + 1)) == NULL) {
436                 printf ("Sorry, can't get enough memory, exiting.\n");
437                 exit(0); /* safe exit, because only called during startup */
438         }
439         strcpy(result[count],p);
440         result[++count] = NULL;
441
442 #if 0
443         count=0;
444         while (result[count])
445                 DBGPRINTF("#%d: %s\n", count, StripDomains[count++]);
446 #endif
447         return result;
448 }
449
450
451 void untty(void)
452 #ifdef HAVE_SETSID
453 {
454         if(!Debug) {
455                 setsid();
456         }
457         return;
458 }
459 #else
460 {
461         int i;
462
463         if(!Debug) {
464                 i = open(_PATH_TTY, O_RDWR|O_CLOEXEC);
465                 if (i >= 0) {
466 #                       if !defined(__hpux)
467                                 (void) ioctl(i, (int) TIOCNOTTY, NULL);
468 #                       else
469                                 /* TODO: we need to implement something for HP UX! -- rgerhards, 2008-03-04 */
470                                 /* actually, HP UX should have setsid, so the code directly above should
471                                  * trigger. So the actual question is why it doesn't do that...
472                                  */
473 #                       endif
474                         close(i);
475                 }
476         }
477 }
478 #endif
479
480
481 /* This takes a received message that must be decoded and submits it to
482  * the main message queue. This is a legacy function which is being provided
483  * to aid older input plugins that do not support message creation via
484  * the new interfaces themselves. It is not recommended to use this
485  * function for new plugins. -- rgerhards, 2009-10-12
486  */
487 rsRetVal
488 parseAndSubmitMessage(uchar *hname, uchar *hnameIP, uchar *msg, int len, int flags, flowControl_t flowCtlType,
489         prop_t *pInputName, struct syslogTime *stTime, time_t ttGenTime)
490 {
491         prop_t *pProp = NULL;
492         msg_t *pMsg;
493         DEFiRet;
494
495         /* we now create our own message object and submit it to the queue */
496         if(stTime == NULL) {
497                 CHKiRet(msgConstruct(&pMsg));
498         } else {
499                 CHKiRet(msgConstructWithTime(&pMsg, stTime, ttGenTime));
500         }
501         if(pInputName != NULL)
502                 MsgSetInputName(pMsg, pInputName);
503         MsgSetRawMsg(pMsg, (char*)msg, len);
504         MsgSetFlowControlType(pMsg, flowCtlType);
505         pMsg->msgFlags  = flags | NEEDS_PARSING;
506
507         MsgSetRcvFromStr(pMsg, hname, ustrlen(hname), &pProp);
508         CHKiRet(prop.Destruct(&pProp));
509         CHKiRet(MsgSetRcvFromIPStr(pMsg, hnameIP, ustrlen(hnameIP), &pProp));
510         CHKiRet(prop.Destruct(&pProp));
511         CHKiRet(submitMsg(pMsg));
512
513 finalize_it:
514         RETiRet;
515 }
516
517
518 /* this is a special function used to submit an error message. This
519  * function is also passed to the runtime library as the generic error
520  * message handler. -- rgerhards, 2008-04-17
521  */
522 rsRetVal
523 submitErrMsg(int iErr, uchar *msg)
524 {
525         DEFiRet;
526         iRet = logmsgInternal(iErr, LOG_SYSLOG|LOG_ERR, msg, 0);
527         RETiRet;
528 }
529
530
531 /* rgerhards 2004-11-09: the following is a function that can be used
532  * to log a message orginating from the syslogd itself.
533  */
534 rsRetVal
535 logmsgInternal(int iErr, int pri, uchar *msg, int flags)
536 {
537         uchar pszTag[33];
538         msg_t *pMsg;
539         DEFiRet;
540
541         CHKiRet(msgConstruct(&pMsg));
542         MsgSetInputName(pMsg, pInternalInputName);
543         MsgSetRawMsgWOSize(pMsg, (char*)msg);
544         MsgSetHOSTNAME(pMsg, glbl.GetLocalHostName(), ustrlen(glbl.GetLocalHostName()));
545         MsgSetRcvFrom(pMsg, glbl.GetLocalHostNameProp());
546         MsgSetRcvFromIP(pMsg, pLocalHostIP);
547         MsgSetMSGoffs(pMsg, 0);
548         /* check if we have an error code associated and, if so,
549          * adjust the tag. -- rgerhards, 2008-06-27
550          */
551         if(iErr == NO_ERRCODE) {
552                 MsgSetTAG(pMsg, UCHAR_CONSTANT("rsyslogd:"), sizeof("rsyslogd:") - 1);
553         } else {
554                 size_t len = snprintf((char*)pszTag, sizeof(pszTag), "rsyslogd%d:", iErr);
555                 pszTag[32] = '\0'; /* just to make sure... */
556                 MsgSetTAG(pMsg, pszTag, len);
557         }
558         pMsg->iFacility = LOG_FAC(pri);
559         pMsg->iSeverity = LOG_PRI(pri);
560         flags |= INTERNAL_MSG;
561         pMsg->msgFlags  = flags;
562
563         /* we now check if we should print internal messages out to stderr. This was
564          * suggested by HKS as a way to help people troubleshoot rsyslog configuration
565          * (by running it interactively. This makes an awful lot of sense, so I add
566          * it here. -- rgerhards, 2008-07-28
567          * Note that error messages can not be disable during a config verify. This
568          * permits us to process unmodified config files which otherwise contain a
569          * supressor statement.
570          */
571         if(((Debug == DEBUG_FULL || NoFork) && bErrMsgToStderr) || iConfigVerify) {
572                 if(LOG_PRI(pri) == LOG_ERR)
573                         fprintf(stderr, "rsyslogd: %s\n", msg);
574         }
575
576         if(bHaveMainQueue == 0) { /* not yet in queued mode */
577                 iminternalAddMsg(pMsg);
578         } else {
579                /* we have the queue, so we can simply provide the
580                  * message to the queue engine.
581                  */
582                 submitMsg(pMsg);
583         }
584 finalize_it:
585         RETiRet;
586 }
587
588 /* check message against ACL set
589  * rgerhards, 2009-11-16
590  */
591 #if 0
592 static inline rsRetVal
593 chkMsgAgainstACL() {
594         /* if we reach this point, we had a good receive and can process the packet received */
595         /* check if we have a different sender than before, if so, we need to query some new values */
596         if(net.CmpHost(&frominet, frominetPrev, socklen) != 0) {
597                 CHKiRet(net.cvthname(&frominet, fromHost, fromHostFQDN, fromHostIP));
598                 memcpy(frominetPrev, &frominet, socklen); /* update cache indicator */
599                 /* Here we check if a host is permitted to send us
600                 * syslog messages. If it isn't, we do not further
601                 * process the message but log a warning (if we are
602                 * configured to do this).
603                 * rgerhards, 2005-09-26
604                 */
605                 *pbIsPermitted = net.isAllowedSender((uchar*)"UDP",
606                                                     (struct sockaddr *)&frominet, (char*)fromHostFQDN);
607
608                 if(!*pbIsPermitted) {
609                         DBGPRINTF("%s is not an allowed sender\n", (char*)fromHostFQDN);
610                         if(glbl.GetOption_DisallowWarning) {
611                                 time_t tt;
612
613                                 datetime.GetTime(&tt);
614                                 if(tt > ttLastDiscard + 60) {
615                                         ttLastDiscard = tt;
616                                         errmsg.LogError(0, NO_ERRCODE,
617                                         "UDP message from disallowed sender %s discarded",
618                                         (char*)fromHost);
619                                 }
620                         }
621                 }
622         }
623 }
624 #endif
625
626
627 /* preprocess a batch of messages, that is ready them for actual processing. This is done
628  * as a first stage and totally in parallel to any other worker active in the system. So
629  * it helps us keep up the overall concurrency level.
630  * rgerhards, 2010-06-09
631  */
632 static inline rsRetVal
633 preprocessBatch(batch_t *pBatch) {
634         uchar fromHost[NI_MAXHOST];
635         uchar fromHostIP[NI_MAXHOST];
636         uchar fromHostFQDN[NI_MAXHOST];
637         prop_t *propFromHost = NULL;
638         prop_t *propFromHostIP = NULL;
639         int bSingleRuleset;
640         ruleset_t *batchRuleset; /* the ruleset used for all message inside the batch, if there is a single one */
641         int bIsPermitted;
642         msg_t *pMsg;
643         int i;
644         rsRetVal localRet;
645         DEFiRet;
646
647         bSingleRuleset = 1;
648         batchRuleset = (pBatch->nElem > 0) ? ((msg_t*) pBatch->pElem[0].pUsrp)->pRuleset : NULL;
649         
650         for(i = 0 ; i < pBatch->nElem  && !*(pBatch->pbShutdownImmediate) ; i++) {
651                 pMsg = (msg_t*) pBatch->pElem[i].pUsrp;
652                 if((pMsg->msgFlags & NEEDS_ACLCHK_U) != 0) {
653                         DBGPRINTF("msgConsumer: UDP ACL must be checked for message (hostname-based)\n");
654                         if(net.cvthname(pMsg->rcvFrom.pfrominet, fromHost, fromHostFQDN, fromHostIP) != RS_RET_OK)
655                                 continue;
656                         bIsPermitted = net.isAllowedSender2((uchar*)"UDP",
657                             (struct sockaddr *)pMsg->rcvFrom.pfrominet, (char*)fromHostFQDN, 1);
658                         if(!bIsPermitted) {
659                                 DBGPRINTF("Message from '%s' discarded, not a permitted sender host\n",
660                                           fromHostFQDN);
661                                 pBatch->pElem[i].state = BATCH_STATE_DISC;
662                         } else {
663                                 /* save some of the info we obtained */
664                                 MsgSetRcvFromStr(pMsg, fromHost, ustrlen(fromHost), &propFromHost);
665                                 CHKiRet(MsgSetRcvFromIPStr(pMsg, fromHostIP, ustrlen(fromHostIP), &propFromHostIP));
666                                 pMsg->msgFlags &= ~NEEDS_ACLCHK_U;
667                         }
668                 }
669                 if((pMsg->msgFlags & NEEDS_PARSING) != 0) {
670                         if((localRet = parser.ParseMsg(pMsg)) != RS_RET_OK)  {
671                                 DBGPRINTF("Message discarded, parsing error %d\n", localRet);
672                                 pBatch->pElem[i].state = BATCH_STATE_DISC;
673                         }
674                 }
675                 if(pMsg->pRuleset != batchRuleset)
676                         bSingleRuleset = 0;
677         }
678
679         batchSetSingleRuleset(pBatch, bSingleRuleset);
680
681 finalize_it:
682         if(propFromHost != NULL)
683                 prop.Destruct(&propFromHost);
684         if(propFromHostIP != NULL)
685                 prop.Destruct(&propFromHostIP);
686         RETiRet;
687 }
688
689 /* The consumer of dequeued messages. This function is called by the
690  * queue engine on dequeueing of a message. It runs on a SEPARATE
691  * THREAD. It receives an array of pointers, which it must iterate
692  * over. We do not do any further batching, as this is of no benefit
693  * for the main queue.
694  */
695 static rsRetVal
696 msgConsumer(void __attribute__((unused)) *notNeeded, batch_t *pBatch, int *pbShutdownImmediate)
697 {
698         DEFiRet;
699         assert(pBatch != NULL);
700         pBatch->pbShutdownImmediate = pbShutdownImmediate; /* TODO: move this to batch creation! */
701         preprocessBatch(pBatch);
702         ruleset.ProcessBatch(pBatch);
703 //TODO: the BATCH_STATE_COMM must be set somewhere down the road, but we 
704 //do not have this yet and so we emulate -- 2010-06-10
705 int i;
706         for(i = 0 ; i < pBatch->nElem  && !*pbShutdownImmediate ; i++) {
707                 pBatch->pElem[i].state = BATCH_STATE_COMM;
708         }
709         RETiRet;
710 }
711
712
713 /* submit a message to the main message queue.   This is primarily
714  * a hook to prevent the need for callers to know about the main message queue
715  * rgerhards, 2008-02-13
716  */
717 rsRetVal
718 submitMsg(msg_t *pMsg)
719 {
720         qqueue_t *pQueue;
721         ruleset_t *pRuleset;
722         DEFiRet;
723
724         ISOBJ_TYPE_assert(pMsg, msg);
725
726         pRuleset = MsgGetRuleset(pMsg);
727
728         pQueue = (pRuleset == NULL) ? pMsgQueue : ruleset.GetRulesetQueue(pRuleset);
729         MsgPrepareEnqueue(pMsg);
730         qqueueEnqObj(pQueue, pMsg->flowCtlType, (void*) pMsg);
731
732         RETiRet;
733 }
734
735
736 /* submit multiple messages at once, very similar to submitMsg, just
737  * for multi_submit_t. All messages need to go into the SAME queue!
738  * rgerhards, 2009-06-16
739  */
740 rsRetVal
741 multiSubmitMsg(multi_submit_t *pMultiSub)
742 {
743         int i;
744         qqueue_t *pQueue;
745         ruleset_t *pRuleset;
746         DEFiRet;
747         assert(pMultiSub != NULL);
748
749         if(pMultiSub->nElem == 0)
750                 FINALIZE;
751
752         for(i = 0 ; i < pMultiSub->nElem ; ++i) {
753                 MsgPrepareEnqueue(pMultiSub->ppMsgs[i]);
754         }
755
756         pRuleset = MsgGetRuleset(pMultiSub->ppMsgs[0]);
757         pQueue = (pRuleset == NULL) ? pMsgQueue : ruleset.GetRulesetQueue(pRuleset);
758         iRet = pQueue->MultiEnq(pQueue, pMultiSub);
759         pMultiSub->nElem = 0;
760
761 finalize_it:
762         RETiRet;
763 }
764
765
766
767
768 static void
769 reapchild()
770 {
771         int saved_errno = errno;
772         struct sigaction sigAct;
773
774         memset(&sigAct, 0, sizeof (sigAct));
775         sigemptyset(&sigAct.sa_mask);
776         sigAct.sa_handler = reapchild;
777         sigaction(SIGCHLD, &sigAct, NULL);  /* reset signal handler -ASP */
778
779         while(waitpid(-1, NULL, WNOHANG) > 0);
780         errno = saved_errno;
781 }
782
783
784 /* helper to doFlushRptdMsgs() to flush the individual action links via llExecFunc
785  * rgerhards, 2007-08-02
786  */
787 DEFFUNC_llExecFunc(flushRptdMsgsActions)
788 {
789         action_t *pAction = (action_t*) pData;
790         assert(pAction != NULL);
791
792         BEGINfunc
793         LockObj(pAction);
794         /* TODO: time() performance: the call below could be moved to
795          * the beginn of the llExec(). This makes it slightly less correct, but
796          * in an acceptable way. -- rgerhards, 2008-09-16
797          */
798         if (pAction->f_prevcount && datetime.GetTime(NULL) >= REPEATTIME(pAction)) {
799                 DBGPRINTF("flush %s: repeated %d times, %d sec.\n",
800                     module.GetStateName(pAction->pMod), pAction->f_prevcount,
801                     repeatinterval[pAction->f_repeatcount]);
802                 actionWriteToAction(pAction);
803                 BACKOFF(pAction);
804         }
805         UnlockObj(pAction);
806
807         ENDfunc
808         return RS_RET_OK; /* we ignore errors, we can not do anything either way */
809 }
810
811
812 /* This method flushes repeat messages.
813  */
814 static void
815 doFlushRptdMsgs(void)
816 {
817         ruleset.IterateAllActions(flushRptdMsgsActions, NULL);
818 }
819
820
821 static void debug_switch()
822 {
823         time_t tTime;
824         struct tm tp;
825         struct sigaction sigAct;
826
827         datetime.GetTime(&tTime);
828         localtime_r(&tTime, &tp);
829         if(debugging_on == 0) {
830                 debugging_on = 1;
831                 dbgprintf("\n");
832                 dbgprintf("\n");
833                 dbgprintf("********************************************************************************\n");
834                 dbgprintf("Switching debugging_on to true at %2.2d:%2.2d:%2.2d\n",
835                           tp.tm_hour, tp.tm_min, tp.tm_sec);
836                 dbgprintf("********************************************************************************\n");
837         } else {
838                 dbgprintf("********************************************************************************\n");
839                 dbgprintf("Switching debugging_on to false at %2.2d:%2.2d:%2.2d\n",
840                           tp.tm_hour, tp.tm_min, tp.tm_sec);
841                 dbgprintf("********************************************************************************\n");
842                 dbgprintf("\n");
843                 dbgprintf("\n");
844                 debugging_on = 0;
845         }
846
847         memset(&sigAct, 0, sizeof (sigAct));
848         sigemptyset(&sigAct.sa_mask);
849         sigAct.sa_handler = debug_switch;
850         sigaction(SIGUSR1, &sigAct, NULL);
851 }
852
853
854 void legacyOptsEnq(uchar *line)
855 {
856         legacyOptsLL_t *pNew;
857
858         pNew = MALLOC(sizeof(legacyOptsLL_t));
859         if(line == NULL)
860                 pNew->line = NULL;
861         else
862                 pNew->line = (uchar *) strdup((char *) line);
863         pNew->next = NULL;
864
865         if(pLegacyOptsLL == NULL)
866                 pLegacyOptsLL = pNew;
867         else {
868                 legacyOptsLL_t *pThis = pLegacyOptsLL;
869
870                 while(pThis->next != NULL)
871                         pThis = pThis->next;
872                 pThis->next = pNew;
873         }
874 }
875
876
877 void legacyOptsFree(void)
878 {
879         legacyOptsLL_t *pThis = pLegacyOptsLL, *pNext;
880
881         while(pThis != NULL) {
882                 if(pThis->line != NULL)
883                         free(pThis->line);
884                 pNext = pThis->next;
885                 free(pThis);
886                 pThis = pNext;
887         }
888 }
889
890
891 void legacyOptsHook(void)
892 {
893         legacyOptsLL_t *pThis = pLegacyOptsLL;
894
895         while(pThis != NULL) {
896                 if(pThis->line != NULL) {
897                         errno = 0;
898                         errmsg.LogError(0, NO_ERRCODE, "Warning: backward compatibility layer added to following "
899                                         "directive to rsyslog.conf: %s", pThis->line);
900                         conf.cfsysline(pThis->line);
901                 }
902                 pThis = pThis->next;
903         }
904 }
905
906
907 void legacyOptsParseTCP(char ch, char *arg)
908 {
909         register int i;
910         register char *pArg = arg;
911         static char conflict = '\0';
912
913         if((conflict == 'g' && ch == 't') || (conflict == 't' && ch == 'g')) {
914                 fprintf(stderr, "rsyslogd: If you want to use both -g and -t, use directives instead, -%c ignored.\n", ch);
915                 return;
916         } else
917                 conflict = ch;
918
919         /* extract port */
920         i = 0;
921         while(isdigit((int) *pArg))
922                 i = i * 10 + *pArg++ - '0';
923
924         /* number of sessions */
925         if(*pArg == '\0' || *pArg == ',') {
926                 if(ch == 't')
927                         legacyOptsEnq((uchar *) "ModLoad imtcp");
928                 else if(ch == 'g')
929                         legacyOptsEnq((uchar *) "ModLoad imgssapi");
930
931                 if(i >= 0 && i <= 65535) {
932                         uchar line[30];
933
934                         if(ch == 't') {
935                                 snprintf((char *) line, sizeof(line), "InputTCPServerRun %d", i);
936                         } else if(ch == 'g') {
937                                 snprintf((char *) line, sizeof(line), "InputGSSServerRun %d", i);
938                         }
939                         legacyOptsEnq(line);
940                 } else {
941                         if(ch == 't') {
942                                 fprintf(stderr, "rsyslogd: Invalid TCP listen port %d - changed to 514.\n", i);
943                                 legacyOptsEnq((uchar *) "InputTCPServerRun 514");
944                         } else if(ch == 'g') {
945                                 fprintf(stderr, "rsyslogd: Invalid GSS listen port %d - changed to 514.\n", i);
946                                 legacyOptsEnq((uchar *) "InputGSSServerRun 514");
947                         }
948                 }
949
950                 if(*pArg == ',') {
951                         ++pArg;
952                         while(isspace((int) *pArg))
953                                 ++pArg;
954                         i = 0;
955                         while(isdigit((int) *pArg)) {
956                                 i = i * 10 + *pArg++ - '0';
957                         }
958                         if(i > 0) {
959                                 uchar line[30];
960
961                                 snprintf((char *) line, sizeof(line), "InputTCPMaxSessions %d", i);
962                                 legacyOptsEnq(line);
963                         } else {
964                                 if(ch == 't') {
965                                         fprintf(stderr, "rsyslogd: TCP session max configured "
966                                                 "to %d [-t %s] - changing to 1.\n", i, arg);
967                                         legacyOptsEnq((uchar *) "InputTCPMaxSessions 1");
968                                 } else if (ch == 'g') {
969                                         fprintf(stderr, "rsyslogd: GSS session max configured "
970                                                 "to %d [-g %s] - changing to 1.\n", i, arg);
971                                         legacyOptsEnq((uchar *) "InputTCPMaxSessions 1");
972                                 }
973                         }
974                 }
975         } else
976                 fprintf(stderr, "rsyslogd: Invalid -t %s command line option.\n", arg);
977 }
978
979
980 /* doDie() is a signal handler. If called, it sets the bFinished variable
981  * to indicate the program should terminate. However, it does not terminate
982  * it itself, because that causes issues with multi-threading. The actual
983  * termination is then done on the main thread. This solution might introduce
984  * a minimal delay, but it is much cleaner than the approach of doing everything
985  * inside the signal handler.
986  * rgerhards, 2005-10-26
987  * Note: we do not call DBGPRINTF() as this may cause us to block in case something
988  * with the threading is wrong.
989  */
990 static void doDie(int sig)
991 {
992 #       define MSG1 "DoDie called.\n"
993 #       define MSG2 "DoDie called 5 times - unconditional exit\n"
994         static int iRetries = 0; /* debug aid */
995         dbgprintf(MSG1);
996         if(Debug == DEBUG_FULL)
997                 write(1, MSG1, sizeof(MSG1) - 1);
998         if(iRetries++ == 4) {
999                 if(Debug == DEBUG_FULL)
1000                         write(1, MSG2, sizeof(MSG2) - 1);
1001                 abort();
1002         }
1003         bFinished = sig;
1004 #       undef MSG1
1005 #       undef MSG2
1006 }
1007
1008
1009 /* This function frees all dynamically allocated memory for program termination.
1010  * It must be called only immediately before exit(). It is primarily an aid
1011  * for memory debuggers, which prevents cluttered outupt.
1012  * rgerhards, 2008-03-20
1013  */
1014 static void
1015 freeAllDynMemForTermination(void)
1016 {
1017         free(pszMainMsgQFName);
1018         free(pModDir);
1019         free(pszConfDAGFile);
1020 }
1021
1022
1023 /* Finalize and destruct all actions.
1024  */
1025 static inline void
1026 destructAllActions(void)
1027 {
1028         ruleset.DestructAllActions();
1029         bHaveMainQueue = 0; // flag that internal messages need to be temporarily stored
1030 }
1031
1032
1033 /* die() is called when the program shall end. This typically only occurs
1034  * during sigterm or during the initialization.
1035  * As die() is intended to shutdown rsyslogd, it is
1036  * safe to call exit() here. Just make sure that die() itself is not called
1037  * at inapropriate places. As a general rule of thumb, it is a bad idea to add
1038  * any calls to die() in new code!
1039  * rgerhards, 2005-10-24
1040  */
1041 static void
1042 die(int sig)
1043 {
1044         char buf[256];
1045
1046         DBGPRINTF("exiting on signal %d\n", sig);
1047
1048         /* IMPORTANT: we should close the inputs first, and THEN send our termination
1049          * message. If we do it the other way around, logmsgInternal() may block on
1050          * a full queue and the inputs still fill up that queue. Depending on the
1051          * scheduling order, we may end up with logmsgInternal being held for a quite
1052          * long time. When the inputs are terminated first, that should not happen
1053          * because the queue is drained in parallel. The situation could only become
1054          * an issue with extremely long running actions in a queue full environment.
1055          * However, such actions are at least considered poorly written, if not
1056          * outright wrong. So we do not care about this very remote problem.
1057          * rgerhards, 2008-01-11
1058          */
1059
1060         /* close the inputs */
1061         DBGPRINTF("Terminating input threads...\n");
1062         glbl.SetGlobalInputTermination();
1063         thrdTerminateAll();
1064
1065         /* and THEN send the termination log message (see long comment above) */
1066         if(sig && bLogStatusMsgs) {
1067                 (void) snprintf(buf, sizeof(buf) / sizeof(char),
1068                  " [origin software=\"rsyslogd\" " "swVersion=\"" VERSION \
1069                  "\" x-pid=\"%d\" x-info=\"http://www.rsyslog.com\"]" " exiting on signal %d.",
1070                  (int) myPid, sig);
1071                 errno = 0;
1072                 logmsgInternal(NO_ERRCODE, LOG_SYSLOG|LOG_INFO, (uchar*)buf, 0);
1073         }
1074
1075         /* drain queue (if configured so) and stop main queue worker thread pool */
1076         DBGPRINTF("Terminating main queue...\n");
1077         qqueueDestruct(&pMsgQueue);
1078         pMsgQueue = NULL;
1079
1080         /* Free ressources and close connections. This includes flushing any remaining
1081          * repeated msgs.
1082          */
1083         DBGPRINTF("Terminating outputs...\n");
1084         destructAllActions();
1085
1086         DBGPRINTF("all primary multi-thread sources have been terminated - now doing aux cleanup...\n");
1087         /* rger 2005-02-22
1088          * now clean up the in-memory structures. OK, the OS
1089          * would also take care of that, but if we do it
1090          * ourselfs, this makes finding memory leaks a lot
1091          * easier.
1092          */
1093         tplDeleteAll();
1094
1095         /* de-init some modules */
1096         modExitIminternal();
1097
1098         /*dbgPrintAllDebugInfo(); / * this is the last spot where this can be done - below output modules are unloaded! */
1099
1100         /* the following line cleans up CfSysLineHandlers that were not based on loadable
1101          * modules. As such, they are not yet cleared.
1102          */
1103         unregCfSysLineHdlrs();
1104
1105         legacyOptsFree();
1106
1107         /* destruct our global properties */
1108         if(pInternalInputName != NULL)
1109                 prop.Destruct(&pInternalInputName);
1110         if(pLocalHostIP != NULL)
1111                 prop.Destruct(&pLocalHostIP);
1112
1113         /* terminate the remaining classes */
1114         GlobalClassExit();
1115
1116         module.UnloadAndDestructAll(eMOD_LINK_ALL);
1117
1118         DBGPRINTF("Clean shutdown completed, bye\n");
1119         /* dbgClassExit MUST be the last one, because it de-inits the debug system */
1120         dbgClassExit();
1121
1122         /* free all remaining memory blocks - this is not absolutely necessary, but helps
1123          * us keep memory debugger logs clean and this is in aid in developing. It doesn't
1124          * cost much time, so we do it always. -- rgerhards, 2008-03-20
1125          */
1126         freeAllDynMemForTermination();
1127         /* NO CODE HERE - feeelAllDynMemForTermination() must be the last thing before exit()! */
1128
1129         remove_pid(PidFile);
1130
1131         exit(0); /* "good" exit, this is the terminator function for rsyslog [die()] */
1132 }
1133
1134 /*
1135  * Signal handler to terminate the parent process.
1136  * rgerhards, 2005-10-24: this is only called during forking of the
1137  * detached syslogd. I consider this method to be safe.
1138  */
1139 static void doexit()
1140 {
1141         exit(0); /* "good" exit, only during child-creation */
1142 }
1143
1144
1145 /* set the maximum message size */
1146 static rsRetVal setMaxMsgSize(void __attribute__((unused)) *pVal, long iNewVal)
1147 {
1148         return glbl.SetMaxLine(iNewVal);
1149 }
1150
1151
1152 /* set the action resume interval */
1153 static rsRetVal setActionResumeInterval(void __attribute__((unused)) *pVal, int iNewVal)
1154 {
1155         return actionSetGlobalResumeInterval(iNewVal);
1156 }
1157
1158
1159 /* set the processes max number ob files (upon configuration request)
1160  * 2009-04-14 rgerhards
1161  */
1162 static rsRetVal setMaxFiles(void __attribute__((unused)) *pVal, int iFiles)
1163 {
1164         struct rlimit maxFiles;
1165         char errStr[1024];
1166         DEFiRet;
1167
1168         maxFiles.rlim_cur = iFiles;
1169         maxFiles.rlim_max = iFiles;
1170
1171         if(setrlimit(RLIMIT_NOFILE, &maxFiles) < 0) {
1172                 /* NOTE: under valgrind, we seem to be unable to extend the size! */
1173                 rs_strerror_r(errno, errStr, sizeof(errStr));
1174                 errmsg.LogError(0, RS_RET_ERR_RLIM_NOFILE, "could not set process file limit to %d: %s [kernel max %ld]",
1175                                 iFiles, errStr, (long) maxFiles.rlim_max);
1176                 ABORT_FINALIZE(RS_RET_ERR_RLIM_NOFILE);
1177         }
1178 #ifdef USE_UNLIMITED_SELECT
1179         glbl.SetFdSetSize(howmany(iFiles, __NFDBITS) * sizeof (fd_mask));
1180 #endif
1181         DBGPRINTF("Max number of files set to %d [kernel max %ld].\n", iFiles, (long) maxFiles.rlim_max);
1182
1183 finalize_it:
1184         RETiRet;
1185 }
1186
1187
1188 /* set the processes umask (upon configuration request) */
1189 static rsRetVal setUmask(void __attribute__((unused)) *pVal, int iUmask)
1190 {
1191         umask(iUmask);
1192         DBGPRINTF("umask set to 0%3.3o.\n", iUmask);
1193
1194         return RS_RET_OK;
1195 }
1196
1197
1198 /* drop to specified group
1199  * if something goes wrong, the function never returns
1200  * Note that such an abort can cause damage to on-disk structures, so we should
1201  * re-design the "interface" in the long term. -- rgerhards, 2008-11-26
1202  */
1203 static void doDropPrivGid(int iGid)
1204 {
1205         int res;
1206         uchar szBuf[1024];
1207
1208         res = setgroups(0, NULL); /* remove all supplementary group IDs */
1209         if(res) {
1210                 perror("could not remove supplemental group IDs");
1211                 exit(1);
1212         }
1213         DBGPRINTF("setgroups(0, NULL): %d\n", res);
1214         res = setgid(iGid);
1215         if(res) {
1216                 /* if we can not set the userid, this is fatal, so let's unconditionally abort */
1217                 perror("could not set requested group id");
1218                 exit(1);
1219         }
1220         DBGPRINTF("setgid(%d): %d\n", iGid, res);
1221         snprintf((char*)szBuf, sizeof(szBuf)/sizeof(uchar), "rsyslogd's groupid changed to %d", iGid);
1222         logmsgInternal(NO_ERRCODE, LOG_SYSLOG|LOG_INFO, szBuf, 0);
1223 }
1224
1225
1226 /* drop to specified user
1227  * if something goes wrong, the function never returns
1228  * Note that such an abort can cause damage to on-disk structures, so we should
1229  * re-design the "interface" in the long term. -- rgerhards, 2008-11-19
1230  */
1231 static void doDropPrivUid(int iUid)
1232 {
1233         int res;
1234         uchar szBuf[1024];
1235
1236         res = setuid(iUid);
1237         if(res) {
1238                 /* if we can not set the userid, this is fatal, so let's unconditionally abort */
1239                 perror("could not set requested userid");
1240                 exit(1);
1241         }
1242         DBGPRINTF("setuid(%d): %d\n", iUid, res);
1243         snprintf((char*)szBuf, sizeof(szBuf)/sizeof(uchar), "rsyslogd's userid changed to %d", iUid);
1244         logmsgInternal(NO_ERRCODE, LOG_SYSLOG|LOG_INFO, szBuf, 0);
1245 }
1246
1247
1248 /* helper to generateConfigDAG, to print out all actions via
1249  * the llExecFunc() facility.
1250  * rgerhards, 2007-08-02
1251  */
1252 struct dag_info {
1253         FILE *fp;       /* output file */
1254         int iActUnit;   /* current action unit number */
1255         int iAct;       /* current action in unit */
1256         int bDiscarded; /* message discarded (config error) */
1257         };
1258 DEFFUNC_llExecFunc(generateConfigDAGAction)
1259 {
1260         action_t *pAction;
1261         uchar *pszModName;
1262         uchar *pszVertexName;
1263         struct dag_info *pDagInfo;
1264         DEFiRet;
1265
1266         pDagInfo = (struct dag_info*) pParam;
1267         pAction = (action_t*) pData;
1268
1269         pszModName = module.GetStateName(pAction->pMod);
1270
1271         /* vertex */
1272         if(pAction->pszName == NULL) {
1273                 if(!strcmp((char*)pszModName, "builtin-discard"))
1274                         pszVertexName = (uchar*)"discard";
1275                 else
1276                         pszVertexName = pszModName;
1277         } else {
1278                 pszVertexName = pAction->pszName;
1279         }
1280
1281         fprintf(pDagInfo->fp, "\tact%d_%d\t\t[label=\"%s\"%s%s]\n",
1282                 pDagInfo->iActUnit, pDagInfo->iAct, pszVertexName,
1283                 pDagInfo->bDiscarded ? " style=dotted color=red" : "",
1284                 (pAction->pQueue->qType == QUEUETYPE_DIRECT) ? "" : " shape=hexagon"
1285                 );
1286
1287         /* edge */
1288         if(pDagInfo->iAct == 0) {
1289         } else {
1290                 fprintf(pDagInfo->fp, "\tact%d_%d -> act%d_%d[%s%s]\n",
1291                         pDagInfo->iActUnit, pDagInfo->iAct - 1,
1292                         pDagInfo->iActUnit, pDagInfo->iAct,
1293                         pDagInfo->bDiscarded ? " style=dotted color=red" : "",
1294                         pAction->bExecWhenPrevSusp ? " label=\"only if\\nsuspended\"" : "" );
1295         }
1296
1297         /* check for discard */
1298         if(!strcmp((char*) pszModName, "builtin-discard")) {
1299                 fprintf(pDagInfo->fp, "\tact%d_%d\t\t[shape=box]\n",
1300                         pDagInfo->iActUnit, pDagInfo->iAct);
1301                 pDagInfo->bDiscarded = 1;
1302         }
1303
1304
1305         ++pDagInfo->iAct;
1306
1307         RETiRet;
1308 }
1309
1310
1311 /* create config DAG
1312  * This functions takes a rsyslog config and produces a .dot file for use
1313  * with graphviz (http://www.graphviz.org). This is done in an effort to
1314  * document, and also potentially troubleshoot, configurations. Plus, I
1315  * consider it a nice feature to explain some concepts. Note that the
1316  * current version only produces a graph with relatively little information.
1317  * This is a foundation that may be later expanded (if it turns out to be
1318  * useful enough).
1319  * rgerhards, 2009-05-11
1320  */
1321 static rsRetVal
1322 generateConfigDAG(uchar *pszDAGFile)
1323 {
1324         //rule_t *f;
1325         FILE *fp;
1326         int iActUnit = 1;
1327         //int bHasFilter = 0;   /* filter associated with this action unit? */
1328         //int bHadFilter;
1329         //int i;
1330         struct dag_info dagInfo;
1331         //char *pszFilterName;
1332         char szConnectingNode[64];
1333         DEFiRet;
1334
1335         assert(pszDAGFile != NULL);
1336         
1337         logmsgInternal(NO_ERRCODE, LOG_SYSLOG|LOG_INFO, (uchar*)
1338                 "Configuration graph generation is unfortunately disabled "
1339                 "in the current code base.", 0);
1340         ABORT_FINALIZE(RS_RET_FILENAME_INVALID);
1341
1342         if((fp = fopen((char*) pszDAGFile, "w")) == NULL) {
1343                 logmsgInternal(NO_ERRCODE, LOG_SYSLOG|LOG_INFO, (uchar*)
1344                         "configuraton graph output file could not be opened, none generated", 0);
1345                 ABORT_FINALIZE(RS_RET_FILENAME_INVALID);
1346         }
1347
1348         dagInfo.fp = fp;
1349
1350         /* from here on, we assume writes go well. This here is a really
1351          * unimportant utility function and if something goes wrong, it has
1352          * almost no effect. So let's not overdo this...
1353          */
1354         fprintf(fp, "# graph created by rsyslog " VERSION "\n\n"
1355                     "# use the dot tool from http://www.graphviz.org to visualize!\n"
1356                     "digraph rsyslogConfig {\n"
1357                     "\tinputs [shape=tripleoctagon]\n"
1358                     "\tinputs -> act0_0\n"
1359                     "\tact0_0 [label=\"main\\nqueue\" shape=hexagon]\n"
1360                     /*"\tmainq -> act1_0\n"*/
1361                     );
1362         strcpy(szConnectingNode, "act0_0");
1363         dagInfo.bDiscarded = 0;
1364
1365 /* TODO: re-enable! */
1366 #if 0
1367         for(f = Files; f != NULL ; f = f->f_next) {
1368                 /* BSD-Style filters are currently ignored */
1369                 bHadFilter = bHasFilter;
1370                 if(f->f_filter_type == FILTER_PRI) {
1371                         bHasFilter = 0;
1372                         for (i = 0; i <= LOG_NFACILITIES; i++)
1373                                 if (f->f_filterData.f_pmask[i] != 0xff) {
1374                                         bHasFilter = 1;
1375                                         break;
1376                                 }
1377                 } else {
1378                         bHasFilter = 1;
1379                 }
1380
1381                 /* we know we have a filter, so it can be false */
1382                 switch(f->f_filter_type) {
1383                         case FILTER_PRI:
1384                                 pszFilterName = "pri filter";
1385                                 break;
1386                         case FILTER_PROP:
1387                                 pszFilterName = "property filter";
1388                                 break;
1389                         case FILTER_EXPR:
1390                                 pszFilterName = "script filter";
1391                                 break;
1392                 }
1393
1394                 /* write action unit node */
1395                 if(bHasFilter) {
1396                         fprintf(fp, "\t%s -> act%d_end\t[label=\"%s:\\nfalse\"]\n",
1397                                 szConnectingNode, iActUnit, pszFilterName);
1398                         fprintf(fp, "\t%s -> act%d_0\t[label=\"%s:\\ntrue\"]\n",
1399                                 szConnectingNode, iActUnit, pszFilterName);
1400                         fprintf(fp, "\tact%d_end\t\t\t\t[shape=point]\n", iActUnit);
1401                         snprintf(szConnectingNode, sizeof(szConnectingNode), "act%d_end", iActUnit);
1402                 } else {
1403                         fprintf(fp, "\t%s -> act%d_0\t[label=\"no filter\"]\n",
1404                                 szConnectingNode, iActUnit);
1405                         snprintf(szConnectingNode, sizeof(szConnectingNode), "act%d_0", iActUnit);
1406                 }
1407
1408                 /* draw individual nodes */
1409                 dagInfo.iActUnit = iActUnit;
1410                 dagInfo.iAct = 0;
1411                 dagInfo.bDiscarded = 0;
1412                 llExecFunc(&f->llActList, generateConfigDAGAction, &dagInfo); /* actions */
1413
1414                 /* finish up */
1415                 if(bHasFilter && !dagInfo.bDiscarded) {
1416                         fprintf(fp, "\tact%d_%d -> %s\n",
1417                                 iActUnit, dagInfo.iAct - 1, szConnectingNode);
1418                 }
1419
1420                 ++iActUnit;
1421         }
1422 #endif
1423
1424         fprintf(fp, "\t%s -> act%d_0\n", szConnectingNode, iActUnit);
1425         fprintf(fp, "\tact%d_0\t\t[label=discard shape=box]\n"
1426                     "}\n", iActUnit);
1427         fclose(fp);
1428
1429 finalize_it:
1430         RETiRet;
1431 }
1432
1433
1434 /* print debug information as part of init(). This pretty much
1435  * outputs the whole config of rsyslogd. I've moved this code
1436  * out of init() to clean it somewhat up.
1437  * rgerhards, 2007-07-31
1438  */
1439 static void dbgPrintInitInfo(void)
1440 {
1441         ruleset.DebugPrintAll();
1442         DBGPRINTF("\n");
1443         if(bDebugPrintTemplateList)
1444                 tplPrintList();
1445         if(bDebugPrintModuleList)
1446                 module.PrintList();
1447         ochPrintList();
1448
1449         if(bDebugPrintCfSysLineHandlerList)
1450                 dbgPrintCfSysLineHandlers();
1451
1452         DBGPRINTF("Messages with malicious PTR DNS Records are %sdropped.\n",
1453                   glbl.GetDropMalPTRMsgs() ? "" : "not ");
1454
1455         DBGPRINTF("Main queue size %d messages.\n", iMainMsgQueueSize);
1456         DBGPRINTF("Main queue worker threads: %d, wThread shutdown: %d, Perists every %d updates.\n",
1457                   iMainMsgQueueNumWorkers, iMainMsgQtoWrkShutdown, iMainMsgQPersistUpdCnt);
1458         DBGPRINTF("Main queue timeouts: shutdown: %d, action completion shutdown: %d, enq: %d\n",
1459                    iMainMsgQtoQShutdown, iMainMsgQtoActShutdown, iMainMsgQtoEnq);
1460         DBGPRINTF("Main queue watermarks: high: %d, low: %d, discard: %d, discard-severity: %d\n",
1461                    iMainMsgQHighWtrMark, iMainMsgQLowWtrMark, iMainMsgQDiscardMark, iMainMsgQDiscardSeverity);
1462         DBGPRINTF("Main queue save on shutdown %d, max disk space allowed %lld\n",
1463                    bMainMsgQSaveOnShutdown, iMainMsgQueMaxDiskSpace);
1464         /* TODO: add
1465         iActionRetryCount = 0;
1466         iActionRetryInterval = 30000;
1467        static int iMainMsgQtoWrkMinMsgs = 100;
1468         static int iMainMsgQbSaveOnShutdown = 1;
1469         iMainMsgQueMaxDiskSpace = 0;
1470         setQPROP(qqueueSetiMinMsgsPerWrkr, "$MainMsgQueueWorkerThreadMinimumMessages", 100);
1471         setQPROP(qqueueSetbSaveOnShutdown, "$MainMsgQueueSaveOnShutdown", 1);
1472          */
1473         DBGPRINTF("Work Directory: '%s'.\n", glbl.GetWorkDir());
1474 }
1475
1476
1477 /* Actually run the input modules.  This happens after privileges are dropped,
1478  * if that is requested.
1479  */
1480 static rsRetVal
1481 runInputModules(void)
1482 {
1483         modInfo_t *pMod;
1484         int bNeedsCancel;
1485
1486         BEGINfunc
1487         /* loop through all modules and activate them (brr...) */
1488         pMod = module.GetNxtType(NULL, eMOD_IN);
1489         while(pMod != NULL) {
1490                 if(pMod->mod.im.bCanRun) {
1491                         /* activate here */
1492                         bNeedsCancel = (pMod->isCompatibleWithFeature(sFEATURENonCancelInputTermination) == RS_RET_OK) ?
1493                                        0 : 1;
1494                         thrdCreate(pMod->mod.im.runInput, pMod->mod.im.afterRun, bNeedsCancel);
1495                 }
1496         pMod = module.GetNxtType(pMod, eMOD_IN);
1497         }
1498
1499         ENDfunc
1500         return RS_RET_OK; /* intentional: we do not care about module errors */
1501 }
1502
1503
1504 /* Start the input modules. This function will probably undergo big changes
1505  * while we implement the input module interface. For now, it does the most
1506  * important thing to get at least my poor initial input modules up and
1507  * running. Almost no config option is taken.
1508  * rgerhards, 2007-12-14
1509  */
1510 static rsRetVal
1511 startInputModules(void)
1512 {
1513         DEFiRet;
1514         modInfo_t *pMod;
1515
1516         /* loop through all modules and activate them (brr...) */
1517         pMod = module.GetNxtType(NULL, eMOD_IN);
1518         while(pMod != NULL) {
1519                 iRet = pMod->mod.im.willRun();
1520                 pMod->mod.im.bCanRun = (iRet == RS_RET_OK);
1521                 if(!pMod->mod.im.bCanRun) {
1522                         DBGPRINTF("module %lx will not run, iRet %d\n", (unsigned long) pMod, iRet);
1523                 }
1524         pMod = module.GetNxtType(pMod, eMOD_IN);
1525         }
1526
1527         ENDfunc
1528         return RS_RET_OK; /* intentional: we do not care about module errors */
1529 }
1530
1531
1532 /* create a main message queue, now also used for ruleset queues. This function
1533  * needs to be moved to some other module, but it is considered acceptable for
1534  * the time being (remember that we want to restructure config processing at large!).
1535  * rgerhards, 2009-10-27
1536  */
1537 rsRetVal createMainQueue(qqueue_t **ppQueue, uchar *pszQueueName)
1538 {
1539         DEFiRet;
1540
1541         /* switch the message object to threaded operation, if necessary */
1542         if(MainMsgQueType == QUEUETYPE_DIRECT || iMainMsgQueueNumWorkers > 1) {
1543                 MsgEnableThreadSafety();
1544         }
1545
1546         /* create message queue */
1547         CHKiRet_Hdlr(qqueueConstruct(ppQueue, MainMsgQueType, iMainMsgQueueNumWorkers, iMainMsgQueueSize, msgConsumer)) {
1548                 /* no queue is fatal, we need to give up in that case... */
1549                 errmsg.LogError(0, iRet, "could not create (ruleset) main message queue"); \
1550         }
1551         /* name our main queue object (it's not fatal if it fails...) */
1552         obj.SetName((obj_t*) (*ppQueue), pszQueueName);
1553
1554         /* ... set some properties ... */
1555 #       define setQPROP(func, directive, data) \
1556         CHKiRet_Hdlr(func(*ppQueue, data)) { \
1557                 errmsg.LogError(0, NO_ERRCODE, "Invalid " #directive ", error %d. Ignored, running with default setting", iRet); \
1558         }
1559 #       define setQPROPstr(func, directive, data) \
1560         CHKiRet_Hdlr(func(*ppQueue, data, (data == NULL)? 0 : strlen((char*) data))) { \
1561                 errmsg.LogError(0, NO_ERRCODE, "Invalid " #directive ", error %d. Ignored, running with default setting", iRet); \
1562         }
1563
1564         setQPROP(qqueueSetMaxFileSize, "$MainMsgQueueFileSize", iMainMsgQueMaxFileSize);
1565         setQPROP(qqueueSetsizeOnDiskMax, "$MainMsgQueueMaxDiskSpace", iMainMsgQueMaxDiskSpace);
1566         setQPROP(qqueueSetiDeqBatchSize, "$MainMsgQueueDequeueBatchSize", iMainMsgQueDeqBatchSize);
1567         setQPROPstr(qqueueSetFilePrefix, "$MainMsgQueueFileName", pszMainMsgQFName);
1568         setQPROP(qqueueSetiPersistUpdCnt, "$MainMsgQueueCheckpointInterval", iMainMsgQPersistUpdCnt);
1569         setQPROP(qqueueSetbSyncQueueFiles, "$MainMsgQueueSyncQueueFiles", bMainMsgQSyncQeueFiles);
1570         setQPROP(qqueueSettoQShutdown, "$MainMsgQueueTimeoutShutdown", iMainMsgQtoQShutdown );
1571         setQPROP(qqueueSettoActShutdown, "$MainMsgQueueTimeoutActionCompletion", iMainMsgQtoActShutdown);
1572         setQPROP(qqueueSettoWrkShutdown, "$MainMsgQueueWorkerTimeoutThreadShutdown", iMainMsgQtoWrkShutdown);
1573         setQPROP(qqueueSettoEnq, "$MainMsgQueueTimeoutEnqueue", iMainMsgQtoEnq);
1574         setQPROP(qqueueSetiHighWtrMrk, "$MainMsgQueueHighWaterMark", iMainMsgQHighWtrMark);
1575         setQPROP(qqueueSetiLowWtrMrk, "$MainMsgQueueLowWaterMark", iMainMsgQLowWtrMark);
1576         setQPROP(qqueueSetiDiscardMrk, "$MainMsgQueueDiscardMark", iMainMsgQDiscardMark);
1577         setQPROP(qqueueSetiDiscardSeverity, "$MainMsgQueueDiscardSeverity", iMainMsgQDiscardSeverity);
1578         setQPROP(qqueueSetiMinMsgsPerWrkr, "$MainMsgQueueWorkerThreadMinimumMessages", iMainMsgQWrkMinMsgs);
1579         setQPROP(qqueueSetbSaveOnShutdown, "$MainMsgQueueSaveOnShutdown", bMainMsgQSaveOnShutdown);
1580         setQPROP(qqueueSetiDeqSlowdown, "$MainMsgQueueDequeueSlowdown", iMainMsgQDeqSlowdown);
1581         setQPROP(qqueueSetiDeqtWinFromHr,  "$MainMsgQueueDequeueTimeBegin", iMainMsgQueueDeqtWinFromHr);
1582         setQPROP(qqueueSetiDeqtWinToHr,    "$MainMsgQueueDequeueTimeEnd", iMainMsgQueueDeqtWinToHr);
1583
1584 #       undef setQPROP
1585 #       undef setQPROPstr
1586
1587         /* ... and finally start the queue! */
1588         CHKiRet_Hdlr(qqueueStart(*ppQueue)) {
1589                 /* no queue is fatal, we need to give up in that case... */
1590                 errmsg.LogError(0, iRet, "could not start (ruleset) main message queue"); \
1591         }
1592         RETiRet;
1593 }
1594
1595
1596 /* INIT -- Initialize syslogd
1597  * Note that if iConfigVerify is set, only the config file is verified but nothing
1598  * else happens. -- rgerhards, 2008-07-28
1599  */
1600 static rsRetVal
1601 init(void)
1602 {
1603         rsRetVal localRet;
1604         int iNbrActions;
1605         int bHadConfigErr = 0;
1606         ruleset_t *pRuleset;
1607         char cbuf[BUFSIZ];
1608         char bufStartUpMsg[512];
1609         struct sigaction sigAct;
1610         DEFiRet;
1611
1612         DBGPRINTF("rsyslog %s - called init()\n", VERSION);
1613
1614         /* construct the default ruleset */
1615         ruleset.Construct(&pRuleset);
1616         ruleset.SetName(pRuleset, UCHAR_CONSTANT("RSYSLOG_DefaultRuleset"));
1617         ruleset.ConstructFinalize(pRuleset);
1618
1619         /* open the configuration file */
1620         localRet = conf.processConfFile(ConfFile);
1621         CHKiRet(conf.GetNbrActActions(&iNbrActions));
1622
1623         if(localRet != RS_RET_OK) {
1624                 errmsg.LogError(0, localRet, "CONFIG ERROR: could not interpret master config file '%s'.", ConfFile);
1625                 bHadConfigErr = 1;
1626         } else if(iNbrActions == 0) {
1627                 errmsg.LogError(0, RS_RET_NO_ACTIONS, "CONFIG ERROR: there are no active actions configured. Inputs will "
1628                          "run, but no output whatsoever is created.");
1629                 bHadConfigErr = 1;
1630         }
1631
1632         if((localRet != RS_RET_OK && localRet != RS_RET_NONFATAL_CONFIG_ERR) || iNbrActions == 0) {
1633                 /* rgerhards: this code is executed to set defaults when the
1634                  * config file could not be opened. We might think about
1635                  * abandoning the run in this case - but this, too, is not
1636                  * very clever... So we stick with what we have.
1637                  * We ignore any errors while doing this - we would be lost anyhow...
1638                  */
1639                 errmsg.LogError(0, NO_ERRCODE, "EMERGENCY CONFIGURATION ACTIVATED - fix rsyslog config file!");
1640
1641                 /* note: we previously used _POSIY_TTY_NAME_MAX+1, but this turned out to be
1642                  * too low on linux... :-S   -- rgerhards, 2008-07-28
1643                  */
1644                 char szTTYNameBuf[128];
1645                 rule_t *pRule = NULL; /* initialization to NULL is *vitally* important! */
1646                 conf.cfline(UCHAR_CONSTANT("*.ERR\t" _PATH_CONSOLE), &pRule);
1647                 conf.cfline(UCHAR_CONSTANT("syslog.*\t" _PATH_CONSOLE), &pRule);
1648                 conf.cfline(UCHAR_CONSTANT("*.PANIC\t*"), &pRule);
1649                 conf.cfline(UCHAR_CONSTANT("syslog.*\troot"), &pRule);
1650                 if(ttyname_r(0, szTTYNameBuf, sizeof(szTTYNameBuf)) == 0) {
1651                         snprintf(cbuf,sizeof(cbuf), "*.*\t%s", szTTYNameBuf);
1652                         conf.cfline((uchar*)cbuf, &pRule);
1653                 } else {
1654                         DBGPRINTF("error %d obtaining controlling terminal, not using that emergency rule\n", errno);
1655                 }
1656                 ruleset.AddRule(ruleset.GetCurrent(), &pRule);
1657         }
1658
1659         legacyOptsHook();
1660
1661         /* some checks */
1662         if(iMainMsgQueueNumWorkers < 1) {
1663                 errmsg.LogError(0, NO_ERRCODE, "$MainMsgQueueNumWorkers must be at least 1! Set to 1.\n");
1664                 iMainMsgQueueNumWorkers = 1;
1665         }
1666
1667         if(MainMsgQueType == QUEUETYPE_DISK) {
1668                 errno = 0;      /* for logerror! */
1669                 if(glbl.GetWorkDir() == NULL) {
1670                         errmsg.LogError(0, NO_ERRCODE, "No $WorkDirectory specified - can not run main message queue in 'disk' mode. "
1671                                  "Using 'FixedArray' instead.\n");
1672                         MainMsgQueType = QUEUETYPE_FIXED_ARRAY;
1673                 }
1674                 if(pszMainMsgQFName == NULL) {
1675                         errmsg.LogError(0, NO_ERRCODE, "No $MainMsgQueueFileName specified - can not run main message queue in "
1676                                  "'disk' mode. Using 'FixedArray' instead.\n");
1677                         MainMsgQueType = QUEUETYPE_FIXED_ARRAY;
1678                 }
1679         }
1680
1681         /* check if we need to generate a config DAG and, if so, do that */
1682         if(pszConfDAGFile != NULL)
1683                 generateConfigDAG(pszConfDAGFile);
1684
1685         /* we are done checking the config - now validate if we should actually run or not.
1686          * If not, terminate. -- rgerhards, 2008-07-25
1687          */
1688         if(iConfigVerify) {
1689                 if(bHadConfigErr) {
1690                         /* a bit dirty, but useful... */
1691                         exit(1);
1692                 }
1693                 ABORT_FINALIZE(RS_RET_VALIDATION_RUN);
1694         }
1695
1696         if(bAbortOnUncleanConfig && bHadConfigErr) {
1697                 fprintf(stderr, "rsyslogd: $AbortOnUncleanConfig is set, and config is not clean.\n"
1698                                 "Check error log for details, fix errors and restart. As a last\n"
1699                                 "resort, you may want to remove $AbortOnUncleanConfig to permit a\n"
1700                                 "startup with a dirty config.\n");
1701                 exit(2);
1702         }
1703
1704         /* create message queue */
1705         CHKiRet_Hdlr(createMainQueue(&pMsgQueue, UCHAR_CONSTANT("main Q"))) {
1706                 /* no queue is fatal, we need to give up in that case... */
1707                 fprintf(stderr, "fatal error %d: could not create message queue - rsyslogd can not run!\n", iRet);
1708                 exit(1);
1709         }
1710
1711         bHaveMainQueue = (MainMsgQueType == QUEUETYPE_DIRECT) ? 0 : 1;
1712         DBGPRINTF("Main processing queue is initialized and running\n");
1713
1714         /* the output part and the queue is now ready to run. So it is a good time
1715          * to initialize the inputs. Please note that the net code above should be
1716          * shuffled to down here once we have everything in input modules.
1717          * rgerhards, 2007-12-14
1718          * NOTE: as of 2009-06-29, the input modules are initialized, but not yet run.
1719          * Keep in mind. though, that the outputs already run if the queue was
1720          * persisted to disk. -- rgerhards
1721          */
1722         startInputModules();
1723
1724         if(Debug) {
1725                 dbgPrintInitInfo();
1726         }
1727
1728         memset(&sigAct, 0, sizeof (sigAct));
1729         sigemptyset(&sigAct.sa_mask);
1730         sigAct.sa_handler = sighup_handler;
1731         sigaction(SIGHUP, &sigAct, NULL);
1732
1733         DBGPRINTF(" started.\n");
1734
1735         /* we now generate the startup message. It now includes everything to
1736          * identify this instance. -- rgerhards, 2005-08-17
1737          */
1738         if(bLogStatusMsgs) {
1739                snprintf(bufStartUpMsg, sizeof(bufStartUpMsg)/sizeof(char),
1740                          " [origin software=\"rsyslogd\" " "swVersion=\"" VERSION \
1741                          "\" x-pid=\"%d\" x-info=\"http://www.rsyslog.com\"] start",
1742                          (int) myPid);
1743                 logmsgInternal(NO_ERRCODE, LOG_SYSLOG|LOG_INFO, (uchar*)bufStartUpMsg, 0);
1744         }
1745
1746 finalize_it:
1747         RETiRet;
1748 }
1749
1750
1751 /* Switch the default ruleset (that, what servcies bind to if nothing specific
1752  * is specified).
1753  * rgerhards, 2009-06-12
1754  */
1755 static rsRetVal
1756 setDefaultRuleset(void __attribute__((unused)) *pVal, uchar *pszName)
1757 {
1758         DEFiRet;
1759
1760         CHKiRet(ruleset.SetDefaultRuleset(pszName));
1761
1762 finalize_it:
1763         free(pszName); /* no longer needed */
1764         RETiRet;
1765 }
1766
1767
1768
1769 /* Put the rsyslog main thread to sleep for n seconds. This was introduced as
1770  * a quick and dirty workaround for a privilege drop race in regard to listener
1771  * startup, which itself was a result of the not-yet-done proper coding of
1772  * privilege drop code (quite some effort). It may be useful for other occasions, too.
1773  * is specified).
1774  * rgerhards, 2009-06-12
1775  */
1776 static rsRetVal
1777 putToSleep(void __attribute__((unused)) *pVal, int iNewVal)
1778 {
1779         DEFiRet;
1780         DBGPRINTF("rsyslog main thread put to sleep via $sleep %d directive...\n", iNewVal);
1781         srSleep(iNewVal, 0);
1782         DBGPRINTF("rsyslog main thread continues after $sleep %d\n", iNewVal);
1783         RETiRet;
1784 }
1785
1786
1787 /* Switch to either an already existing rule set or start a new one. The
1788  * named rule set becomes the new "current" rule set (what means that new
1789  * actions are added to it).
1790  * rgerhards, 2009-06-12
1791  */
1792 static rsRetVal
1793 setCurrRuleset(void __attribute__((unused)) *pVal, uchar *pszName)
1794 {
1795         ruleset_t *pRuleset;
1796         rsRetVal localRet;
1797         DEFiRet;
1798
1799         localRet = ruleset.SetCurrRuleset(pszName);
1800
1801         if(localRet == RS_RET_NOT_FOUND) {
1802                 DBGPRINTF("begin new current rule set '%s'\n", pszName);
1803                 CHKiRet(ruleset.Construct(&pRuleset));
1804                 CHKiRet(ruleset.SetName(pRuleset, pszName));
1805                 CHKiRet(ruleset.ConstructFinalize(pRuleset));
1806         } else {
1807                 ABORT_FINALIZE(localRet);
1808         }
1809
1810 finalize_it:
1811         free(pszName); /* no longer needed */
1812         RETiRet;
1813 }
1814
1815
1816 /* set the main message queue mode
1817  * rgerhards, 2008-01-03
1818  */
1819 static rsRetVal setMainMsgQueType(void __attribute__((unused)) *pVal, uchar *pszType)
1820 {
1821         DEFiRet;
1822
1823         if (!strcasecmp((char *) pszType, "fixedarray")) {
1824                 MainMsgQueType = QUEUETYPE_FIXED_ARRAY;
1825                 DBGPRINTF("main message queue type set to FIXED_ARRAY\n");
1826         } else if (!strcasecmp((char *) pszType, "linkedlist")) {
1827                 MainMsgQueType = QUEUETYPE_LINKEDLIST;
1828                 DBGPRINTF("main message queue type set to LINKEDLIST\n");
1829         } else if (!strcasecmp((char *) pszType, "disk")) {
1830                 MainMsgQueType = QUEUETYPE_DISK;
1831                 DBGPRINTF("main message queue type set to DISK\n");
1832         } else if (!strcasecmp((char *) pszType, "direct")) {
1833                 MainMsgQueType = QUEUETYPE_DIRECT;
1834                 DBGPRINTF("main message queue type set to DIRECT (no queueing at all)\n");
1835         } else {
1836                 errmsg.LogError(0, RS_RET_INVALID_PARAMS, "unknown mainmessagequeuetype parameter: %s", (char *) pszType);
1837                 iRet = RS_RET_INVALID_PARAMS;
1838         }
1839         free(pszType); /* no longer needed */
1840
1841         RETiRet;
1842 }
1843
1844
1845 /*
1846  * The following function is resposible for handling a SIGHUP signal.  Since
1847  * we are now doing mallocs/free as part of init we had better not being
1848  * doing this during a signal handler.  Instead this function simply sets
1849  * a flag variable which will tells the main loop to do "the right thing".
1850  */
1851 void sighup_handler()
1852 {
1853         struct sigaction sigAct;
1854
1855         bHadHUP = 1;
1856
1857         memset(&sigAct, 0, sizeof (sigAct));
1858         sigemptyset(&sigAct.sa_mask);
1859         sigAct.sa_handler = sighup_handler;
1860         sigaction(SIGHUP, &sigAct, NULL);
1861 }
1862
1863 void sigttin_handler()
1864 {
1865 }
1866
1867 /* this function pulls all internal messages from the buffer
1868  * and puts them into the processing engine.
1869  * We can only do limited error handling, as this would not
1870  * really help us. TODO: add error messages?
1871  * rgerhards, 2007-08-03
1872  */
1873 static inline void processImInternal(void)
1874 {
1875         msg_t *pMsg;
1876
1877         while(iminternalRemoveMsg(&pMsg) == RS_RET_OK) {
1878                 submitMsg(pMsg);
1879         }
1880 }
1881
1882
1883 /* helper to doHUP(), this "HUPs" each action. The necessary locking
1884  * is done inside the action class and nothing we need to take care of.
1885  * rgerhards, 2008-10-22
1886  */
1887 DEFFUNC_llExecFunc(doHUPActions)
1888 {
1889         BEGINfunc
1890         actionCallHUPHdlr((action_t*) pData);
1891         ENDfunc
1892         return RS_RET_OK; /* we ignore errors, we can not do anything either way */
1893 }
1894
1895
1896 /* This function processes a HUP after one has been detected. Note that this
1897  * is *NOT* the sighup handler. The signal is recorded by the handler, that record
1898  * detected inside the mainloop and then this function is called to do the
1899  * real work. -- rgerhards, 2008-10-22
1900  */
1901 static inline void
1902 doHUP(void)
1903 {
1904         char buf[512];
1905
1906         if(bLogStatusMsgs) {
1907                 snprintf(buf, sizeof(buf) / sizeof(char),
1908                          " [origin software=\"rsyslogd\" " "swVersion=\"" VERSION
1909                          "\" x-pid=\"%d\" x-info=\"http://www.rsyslog.com\"] rsyslogd was HUPed",
1910                          (int) myPid);
1911                         errno = 0;
1912                 logmsgInternal(NO_ERRCODE, LOG_SYSLOG|LOG_INFO, (uchar*)buf, 0);
1913         }
1914
1915         ruleset.IterateAllActions(doHUPActions, NULL);
1916 }
1917
1918
1919 /* This is the main processing loop. It is called after successful initialization.
1920  * When it returns, the syslogd terminates.
1921  * Its sole function is to provide some housekeeping things. The real work is done
1922  * by the other threads spawned.
1923  */
1924 static void
1925 mainloop(void)
1926 {
1927         struct timeval tvSelectTimeout;
1928
1929         BEGINfunc
1930         /* first check if we have any internal messages queued and spit them out. We used
1931          * to do that on any loop iteration, but that is no longer necessry. The reason
1932          * is that once we reach this point here, we always run on multiple threads and
1933          * thus the main queue is properly initialized. -- rgerhards, 2008-06-09
1934          */
1935         processImInternal();
1936
1937         while(!bFinished){
1938                 /* this is now just a wait - please note that we do use a near-"eternal"
1939                  * timeout of 1 day if we do not have repeated message reduction turned on
1940                  * (which it is not by default). This enables us to help safe the environment
1941                  * by not unnecessarily awaking rsyslog on a regular tick (just think
1942                  * powertop, for example). In that case, we primarily wait for a signal,
1943                  * but a once-a-day wakeup should be quite acceptable. -- rgerhards, 2008-06-09
1944                  */
1945                 tvSelectTimeout.tv_sec = (bReduceRepeatMsgs == 1) ? TIMERINTVL : 86400 /*1 day*/;
1946                 //tvSelectTimeout.tv_sec = TIMERINTVL; /* TODO: change this back to the above code when we have a better solution for apc */
1947                 tvSelectTimeout.tv_usec = 0;
1948                 select(1, NULL, NULL, NULL, &tvSelectTimeout);
1949                 if(bFinished)
1950                         break;  /* exit as quickly as possible - see long comment below */
1951
1952                 /* If we received a HUP signal, we call doFlushRptdMsgs() a bit early. This
1953                  * doesn't matter, because doFlushRptdMsgs() checks timestamps. What may happen,
1954                  * however, is that the too-early call may lead to a bit too-late output
1955                  * of "last message repeated n times" messages. But that is quite acceptable.
1956                  * rgerhards, 2007-12-21
1957                  * ... and just to explain, we flush here because that is exactly what the mainloop
1958                  * shall do - provide a periodic interval in which not-yet-flushed messages will
1959                  * be flushed. Be careful, there is a potential race condition: doFlushRptdMsgs()
1960                  * needs to aquire a lock on the action objects. If, however, long-running consumers
1961                  * cause the main queue worker threads to lock them for a long time, we may receive
1962                  * a starvation condition, resulting in the mainloop being held on lock for an extended
1963                  * period of time. That, in turn, could lead to unresponsiveness to termination
1964                  * requests. It is especially important that the bFinished flag is checked before
1965                  * doFlushRptdMsgs() is called (I know because I ran into that situation). I am
1966                  * not yet sure if the remaining probability window of a termination-related
1967                  * problem is large enough to justify changing the code - I would consider it
1968                  * extremely unlikely that the problem ever occurs in practice. Fixing it would
1969                  * require not only a lot of effort but would cost considerable performance. So
1970                  * for the time being, I think the remaining risk can be accepted.
1971                  * rgerhards, 2008-01-10
1972                  */
1973                 if(bReduceRepeatMsgs == 1)
1974                         doFlushRptdMsgs();
1975
1976                 if(bHadHUP) {
1977                         doHUP();
1978                         bHadHUP = 0;
1979                         continue;
1980                 }
1981                 // TODO: remove execScheduled(); /* handle Apc calls (if any) */
1982         }
1983         ENDfunc
1984 }
1985
1986
1987 /* load build-in modules
1988  * very first version begun on 2007-07-23 by rgerhards
1989  */
1990 static rsRetVal loadBuildInModules(void)
1991 {
1992         DEFiRet;
1993
1994         if((iRet = module.doModInit(modInitFile, UCHAR_CONSTANT("builtin-file"), NULL)) != RS_RET_OK) {
1995                 RETiRet;
1996         }
1997         if((iRet = module.doModInit(modInitPipe, UCHAR_CONSTANT("builtin-pipe"), NULL)) != RS_RET_OK) {
1998                 RETiRet;
1999         }
2000 #ifdef SYSLOG_INET
2001         if((iRet = module.doModInit(modInitFwd, UCHAR_CONSTANT("builtin-fwd"), NULL)) != RS_RET_OK) {
2002                 RETiRet;
2003         }
2004 #endif
2005         if((iRet = module.doModInit(modInitShell, UCHAR_CONSTANT("builtin-shell"), NULL)) != RS_RET_OK) {
2006                 RETiRet;
2007         }
2008         if((iRet = module.doModInit(modInitDiscard, UCHAR_CONSTANT("builtin-discard"), NULL)) != RS_RET_OK) {
2009                 RETiRet;
2010         }
2011
2012         /* dirty, but this must be for the time being: the usrmsg module must always be
2013          * loaded as last module. This is because it processes any type of action selector.
2014          * If we load it before other modules, these others will never have a chance of
2015          * working with the config file. We may change that implementation so that a user name
2016          * must start with an alnum, that would definitely help (but would it break backwards
2017          * compatibility?). * rgerhards, 2007-07-23
2018          * User names now must begin with:
2019          *   [a-zA-Z0-9_.]
2020          */
2021         CHKiRet(module.doModInit(modInitUsrMsg, (uchar*) "builtin-usrmsg", NULL));
2022
2023         /* load build-in parser modules */
2024         CHKiRet(module.doModInit(modInitpmrfc5424, UCHAR_CONSTANT("builtin-pmrfc5424"), NULL));
2025         CHKiRet(module.doModInit(modInitpmrfc3164, UCHAR_CONSTANT("builtin-pmrfc3164"), NULL));
2026
2027         /* and set default parser modules (order is *very* important, legacy (3164) parse needs to go last! */
2028         CHKiRet(parser.AddDfltParser(UCHAR_CONSTANT("rsyslog.rfc5424")));
2029         CHKiRet(parser.AddDfltParser(UCHAR_CONSTANT("rsyslog.rfc3164")));
2030
2031         /* load build-in strgen modules */
2032         CHKiRet(module.doModInit(modInitsmfile, UCHAR_CONSTANT("builtin-smfile"), NULL));
2033         CHKiRet(module.doModInit(modInitsmtradfile, UCHAR_CONSTANT("builtin-smtradfile"), NULL));
2034         CHKiRet(module.doModInit(modInitsmfwd, UCHAR_CONSTANT("builtin-smfwd"), NULL));
2035         CHKiRet(module.doModInit(modInitsmtradfwd, UCHAR_CONSTANT("builtin-smtradfwd"), NULL));
2036
2037         /* ok, initialization of the command handler probably does not 100% belong right in
2038          * this space here. However, with the current design, this is actually quite a good
2039          * place to put it. We might decide to shuffle it around later, but for the time
2040          * being, the code has found its home here. A not-just-sideeffect of this decision
2041          * is that rsyslog will terminate if we can not register our built-in config commands.
2042          * This, I think, is the right thing to do. -- rgerhards, 2007-07-31
2043          */
2044         CHKiRet(regCfSysLineHdlr((uchar *)"logrsyslogstatusmessages", 0, eCmdHdlrBinary, NULL, &bLogStatusMsgs, NULL));
2045         CHKiRet(regCfSysLineHdlr((uchar *)"actionresumeretrycount", 0, eCmdHdlrInt, NULL, &glbliActionResumeRetryCount, NULL));
2046         CHKiRet(regCfSysLineHdlr((uchar *)"defaultruleset", 0, eCmdHdlrGetWord, setDefaultRuleset, NULL, NULL));
2047         CHKiRet(regCfSysLineHdlr((uchar *)"ruleset", 0, eCmdHdlrGetWord, setCurrRuleset, NULL, NULL));
2048         CHKiRet(regCfSysLineHdlr((uchar *)"sleep", 0, eCmdHdlrInt, putToSleep, NULL, NULL));
2049         CHKiRet(regCfSysLineHdlr((uchar *)"mainmsgqueuefilename", 0, eCmdHdlrGetWord, NULL, &pszMainMsgQFName, NULL));
2050         CHKiRet(regCfSysLineHdlr((uchar *)"mainmsgqueuesize", 0, eCmdHdlrInt, NULL, &iMainMsgQueueSize, NULL));
2051         CHKiRet(regCfSysLineHdlr((uchar *)"mainmsgqueuehighwatermark", 0, eCmdHdlrInt, NULL, &iMainMsgQHighWtrMark, NULL));
2052         CHKiRet(regCfSysLineHdlr((uchar *)"mainmsgqueuelowwatermark", 0, eCmdHdlrInt, NULL, &iMainMsgQLowWtrMark, NULL));
2053         CHKiRet(regCfSysLineHdlr((uchar *)"mainmsgqueuediscardmark", 0, eCmdHdlrInt, NULL, &iMainMsgQDiscardMark, NULL));
2054         CHKiRet(regCfSysLineHdlr((uchar *)"mainmsgqueuediscardseverity", 0, eCmdHdlrSeverity, NULL, &iMainMsgQDiscardSeverity, NULL));
2055         CHKiRet(regCfSysLineHdlr((uchar *)"mainmsgqueuecheckpointinterval", 0, eCmdHdlrInt, NULL, &iMainMsgQPersistUpdCnt, NULL));
2056         CHKiRet(regCfSysLineHdlr((uchar *)"mainmsgqueuesyncqueuefiles", 0, eCmdHdlrBinary, NULL, &bMainMsgQSyncQeueFiles, NULL));
2057         CHKiRet(regCfSysLineHdlr((uchar *)"mainmsgqueuetype", 0, eCmdHdlrGetWord, setMainMsgQueType, NULL, NULL));
2058         CHKiRet(regCfSysLineHdlr((uchar *)"mainmsgqueueworkerthreads", 0, eCmdHdlrInt, NULL, &iMainMsgQueueNumWorkers, NULL));
2059         CHKiRet(regCfSysLineHdlr((uchar *)"mainmsgqueuetimeoutshutdown", 0, eCmdHdlrInt, NULL, &iMainMsgQtoQShutdown, NULL));
2060         CHKiRet(regCfSysLineHdlr((uchar *)"mainmsgqueuetimeoutactioncompletion", 0, eCmdHdlrInt, NULL, &iMainMsgQtoActShutdown, NULL));
2061         CHKiRet(regCfSysLineHdlr((uchar *)"mainmsgqueuetimeoutenqueue", 0, eCmdHdlrInt, NULL, &iMainMsgQtoEnq, NULL));
2062         CHKiRet(regCfSysLineHdlr((uchar *)"mainmsgqueueworkertimeoutthreadshutdown", 0, eCmdHdlrInt, NULL, &iMainMsgQtoWrkShutdown, NULL));
2063         CHKiRet(regCfSysLineHdlr((uchar *)"mainmsgqueuedequeueslowdown", 0, eCmdHdlrInt, NULL, &iMainMsgQDeqSlowdown, NULL));
2064         CHKiRet(regCfSysLineHdlr((uchar *)"mainmsgqueueworkerthreadminimummessages", 0, eCmdHdlrInt, NULL, &iMainMsgQWrkMinMsgs, NULL));
2065         CHKiRet(regCfSysLineHdlr((uchar *)"mainmsgqueuemaxfilesize", 0, eCmdHdlrSize, NULL, &iMainMsgQueMaxFileSize, NULL));
2066         CHKiRet(regCfSysLineHdlr((uchar *)"mainmsgqueuedequeuebatchsize", 0, eCmdHdlrSize, NULL, &iMainMsgQueDeqBatchSize, NULL));
2067         CHKiRet(regCfSysLineHdlr((uchar *)"mainmsgqueuemaxdiskspace", 0, eCmdHdlrSize, NULL, &iMainMsgQueMaxDiskSpace, NULL));
2068         CHKiRet(regCfSysLineHdlr((uchar *)"mainmsgqueuesaveonshutdown", 0, eCmdHdlrBinary, NULL, &bMainMsgQSaveOnShutdown, NULL));
2069         CHKiRet(regCfSysLineHdlr((uchar *)"mainmsgqueuedequeuetimebegin", 0, eCmdHdlrInt, NULL, &iMainMsgQueueDeqtWinFromHr, NULL));
2070         CHKiRet(regCfSysLineHdlr((uchar *)"mainmsgqueuedequeuetimeend", 0, eCmdHdlrInt, NULL, &iMainMsgQueueDeqtWinToHr, NULL));
2071         CHKiRet(regCfSysLineHdlr((uchar *)"abortonuncleanconfig", 0, eCmdHdlrBinary, NULL, &bAbortOnUncleanConfig, NULL));
2072         CHKiRet(regCfSysLineHdlr((uchar *)"repeatedmsgreduction", 0, eCmdHdlrBinary, NULL, &bReduceRepeatMsgs, NULL));
2073         CHKiRet(regCfSysLineHdlr((uchar *)"actionexeconlywhenpreviousissuspended", 0, eCmdHdlrBinary, NULL, &bActExecWhenPrevSusp, NULL));
2074         CHKiRet(regCfSysLineHdlr((uchar *)"actionresumeinterval", 0, eCmdHdlrInt, setActionResumeInterval, NULL, NULL));
2075         CHKiRet(regCfSysLineHdlr((uchar *)"template", 0, eCmdHdlrCustomHandler, conf.doNameLine, (void*)DIR_TEMPLATE, NULL));
2076         CHKiRet(regCfSysLineHdlr((uchar *)"outchannel", 0, eCmdHdlrCustomHandler, conf.doNameLine, (void*)DIR_OUTCHANNEL, NULL));
2077         CHKiRet(regCfSysLineHdlr((uchar *)"allowedsender", 0, eCmdHdlrCustomHandler, conf.doNameLine, (void*)DIR_ALLOWEDSENDER, NULL));
2078         CHKiRet(regCfSysLineHdlr((uchar *)"modload", 0, eCmdHdlrCustomHandler, conf.doModLoad, NULL, NULL));
2079         CHKiRet(regCfSysLineHdlr((uchar *)"includeconfig", 0, eCmdHdlrCustomHandler, conf.doIncludeLine, NULL, NULL));
2080         CHKiRet(regCfSysLineHdlr((uchar *)"umask", 0, eCmdHdlrFileCreateMode, setUmask, NULL, NULL));
2081         CHKiRet(regCfSysLineHdlr((uchar *)"maxopenfiles", 0, eCmdHdlrInt, setMaxFiles, NULL, NULL));
2082         CHKiRet(regCfSysLineHdlr((uchar *)"debugprinttemplatelist", 0, eCmdHdlrBinary, NULL, &bDebugPrintTemplateList, NULL));
2083         CHKiRet(regCfSysLineHdlr((uchar *)"debugprintmodulelist", 0, eCmdHdlrBinary, NULL, &bDebugPrintModuleList, NULL));
2084         CHKiRet(regCfSysLineHdlr((uchar *)"debugprintcfsyslinehandlerlist", 0, eCmdHdlrBinary,
2085                  NULL, &bDebugPrintCfSysLineHandlerList, NULL));
2086         CHKiRet(regCfSysLineHdlr((uchar *)"moddir", 0, eCmdHdlrGetWord, NULL, &pModDir, NULL));
2087         CHKiRet(regCfSysLineHdlr((uchar *)"generateconfiggraph", 0, eCmdHdlrGetWord, NULL, &pszConfDAGFile, NULL));
2088         CHKiRet(regCfSysLineHdlr((uchar *)"resetconfigvariables", 1, eCmdHdlrCustomHandler, resetConfigVariables, NULL, NULL));
2089         CHKiRet(regCfSysLineHdlr((uchar *)"errormessagestostderr", 0, eCmdHdlrBinary, NULL, &bErrMsgToStderr, NULL));
2090         CHKiRet(regCfSysLineHdlr((uchar *)"maxmessagesize", 0, eCmdHdlrSize, setMaxMsgSize, NULL, NULL));
2091         CHKiRet(regCfSysLineHdlr((uchar *)"privdroptouser", 0, eCmdHdlrUID, NULL, &uidDropPriv, NULL));
2092         CHKiRet(regCfSysLineHdlr((uchar *)"privdroptouserid", 0, eCmdHdlrInt, NULL, &uidDropPriv, NULL));
2093         CHKiRet(regCfSysLineHdlr((uchar *)"privdroptogroup", 0, eCmdHdlrGID, NULL, &gidDropPriv, NULL));
2094         CHKiRet(regCfSysLineHdlr((uchar *)"privdroptogroupid", 0, eCmdHdlrGID, NULL, &gidDropPriv, NULL));
2095
2096 finalize_it:
2097         RETiRet;
2098 }
2099
2100
2101 /* print version and compile-time setting information.
2102  */
2103 static void printVersion(void)
2104 {
2105         printf("rsyslogd %s, ", VERSION);
2106         printf("compiled with:\n");
2107 #ifdef FEATURE_REGEXP
2108         printf("\tFEATURE_REGEXP:\t\t\t\tYes\n");
2109 #else
2110         printf("\tFEATURE_REGEXP:\t\t\t\tNo\n");
2111 #endif
2112 #if defined(_LARGE_FILES) || (defined (_FILE_OFFSET_BITS) && _FILE_OFFSET_BITS >= 64)
2113         printf("\tFEATURE_LARGEFILE:\t\t\tYes\n");
2114 #else
2115         printf("\tFEATURE_LARGEFILE:\t\t\tNo\n");
2116 #endif
2117 #if defined(SYSLOG_INET) && defined(USE_GSSAPI)
2118         printf("\tGSSAPI Kerberos 5 support:\t\tYes\n");
2119 #else
2120         printf("\tGSSAPI Kerberos 5 support:\t\tNo\n");
2121 #endif
2122 #ifndef NDEBUG
2123         printf("\tFEATURE_DEBUG (debug build, slow code):\tYes\n");
2124 #else
2125         printf("\tFEATURE_DEBUG (debug build, slow code):\tNo\n");
2126 #endif
2127 #ifdef  HAVE_ATOMIC_BUILTINS
2128         printf("\t32bit Atomic operations supported:\tYes\n");
2129 #else
2130         printf("\t32bit Atomic operations supported:\tNo\n");
2131 #endif
2132 #ifdef  HAVE_ATOMIC_BUILTINS_64BIT
2133         printf("\t64bit Atomic operations supported:\tYes\n");
2134 #else
2135         printf("\t64bit Atomic operations supported:\tNo\n");
2136 #endif
2137 #ifdef  RTINST
2138         printf("\tRuntime Instrumentation (slow code):\tYes\n");
2139 #else
2140         printf("\tRuntime Instrumentation (slow code):\tNo\n");
2141 #endif
2142         printf("\nSee http://www.rsyslog.com for more information.\n");
2143 }
2144
2145
2146 /* This function is called after initial initalization. It is used to
2147  * move code out of the too-long main() function.
2148  * rgerhards, 2007-10-17
2149  */
2150 static rsRetVal mainThread()
2151 {
2152         DEFiRet;
2153         uchar *pTmp;
2154
2155         /* initialize the build-in templates */
2156         pTmp = template_DebugFormat;
2157         tplAddLine("RSYSLOG_DebugFormat", &pTmp);
2158         pTmp = template_SyslogProtocol23Format;
2159         tplAddLine("RSYSLOG_SyslogProtocol23Format", &pTmp);
2160         pTmp = template_FileFormat; /* new format for files with high-precision stamp */
2161         tplAddLine("RSYSLOG_FileFormat", &pTmp);
2162         pTmp = template_TraditionalFileFormat;
2163         tplAddLine("RSYSLOG_TraditionalFileFormat", &pTmp);
2164         pTmp = template_WallFmt;
2165         tplAddLine(" WallFmt", &pTmp);
2166         pTmp = template_ForwardFormat;
2167         tplAddLine("RSYSLOG_ForwardFormat", &pTmp);
2168         pTmp = template_TraditionalForwardFormat;
2169         tplAddLine("RSYSLOG_TraditionalForwardFormat", &pTmp);
2170         pTmp = template_StdUsrMsgFmt;
2171         tplAddLine(" StdUsrMsgFmt", &pTmp);
2172         pTmp = template_StdDBFmt;
2173         tplAddLine(" StdDBFmt", &pTmp);
2174         pTmp = template_StdPgSQLFmt;
2175         tplAddLine(" StdPgSQLFmt", &pTmp);
2176         pTmp = template_spoofadr;
2177         tplLastStaticInit(tplAddLine("RSYSLOG_omudpspoofDfltSourceTpl", &pTmp));
2178
2179         CHKiRet(init());
2180
2181         if(Debug && debugging_on) {
2182                 DBGPRINTF("Debugging enabled, SIGUSR1 to turn off debugging.\n");
2183         }
2184
2185         /* Send a signal to the parent so it can terminate.
2186          */
2187         if(myPid != ppid)
2188                 kill(ppid, SIGTERM);
2189
2190
2191         /* If instructed to do so, we now drop privileges. Note that this is not 100% secure,
2192          * because outputs are already running at this time. However, we can implement
2193          * dropping of privileges rather quickly and it will work in many cases. While it is not
2194          * the ultimate solution, the current one is still much better than not being able to
2195          * drop privileges at all. Doing it correctly, requires a change in architecture, which
2196          * we should do over time. TODO -- rgerhards, 2008-11-19
2197          */
2198         if(gidDropPriv != 0) {
2199                 doDropPrivGid(gidDropPriv);
2200         }
2201
2202         if(uidDropPriv != 0) {
2203                 doDropPrivUid(uidDropPriv);
2204         }
2205
2206         /* finally let the inputs run... */
2207         runInputModules();
2208
2209         /* END OF INTIALIZATION
2210          */
2211         DBGPRINTF("initialization completed, transitioning to regular run mode\n");
2212
2213         /* close stderr and stdout if they are kept open during a fork. Note that this
2214          * may introduce subtle security issues: if we are in a jail, one may break out of
2215          * it via these descriptors. But if I close them earlier, error messages will (once
2216          * again) not be emitted to the user that starts the daemon. As root jail support
2217          * is still in its infancy (and not really done), we currently accept this issue.
2218          * rgerhards, 2009-06-29
2219          */
2220         if(!(Debug == DEBUG_FULL || NoFork)) {
2221                 close(1);
2222                 close(2);
2223                 bErrMsgToStderr = 0;
2224         }
2225
2226         mainloop();
2227
2228 finalize_it:
2229         RETiRet;
2230 }
2231
2232
2233 /* Method to initialize all global classes and use the objects that we need.
2234  * rgerhards, 2008-01-04
2235  * rgerhards, 2008-04-16: the actual initialization is now carried out by the runtime
2236  */
2237 static rsRetVal
2238 InitGlobalClasses(void)
2239 {
2240         DEFiRet;
2241         char *pErrObj; /* tells us which object failed if that happens (useful for troubleshooting!) */
2242
2243         /* Intialize the runtime system */
2244         pErrObj = "rsyslog runtime"; /* set in case the runtime errors before setting an object */
2245         CHKiRet(rsrtInit(&pErrObj, &obj));
2246         CHKiRet(rsrtSetErrLogger(submitErrMsg)); /* set out error handler */
2247
2248         /* Now tell the system which classes we need ourselfs */
2249         pErrObj = "glbl";
2250         CHKiRet(objUse(glbl,     CORE_COMPONENT));
2251         pErrObj = "errmsg";
2252         CHKiRet(objUse(errmsg,   CORE_COMPONENT));
2253         pErrObj = "module";
2254         CHKiRet(objUse(module,   CORE_COMPONENT));
2255         pErrObj = "datetime";
2256         CHKiRet(objUse(datetime, CORE_COMPONENT));
2257         pErrObj = "expr";
2258         CHKiRet(objUse(expr,     CORE_COMPONENT));
2259         pErrObj = "rule";
2260         CHKiRet(objUse(rule,     CORE_COMPONENT));
2261         pErrObj = "ruleset";
2262         CHKiRet(objUse(ruleset,  CORE_COMPONENT));
2263         pErrObj = "conf";
2264         CHKiRet(objUse(conf,     CORE_COMPONENT));
2265         pErrObj = "prop";
2266         CHKiRet(objUse(prop,     CORE_COMPONENT));
2267         pErrObj = "parser";
2268         CHKiRet(objUse(parser,     CORE_COMPONENT));
2269
2270         /* intialize some dummy classes that are not part of the runtime */
2271         pErrObj = "action";
2272         CHKiRet(actionClassInit());
2273         pErrObj = "template";
2274         CHKiRet(templateInit());
2275
2276         /* TODO: the dependency on net shall go away! -- rgerhards, 2008-03-07 */
2277         pErrObj = "net";
2278         CHKiRet(objUse(net, LM_NET_FILENAME));
2279
2280 finalize_it:
2281         if(iRet != RS_RET_OK) {
2282                 /* we know we are inside the init sequence, so we can safely emit
2283                  * messages to stderr. -- rgerhards, 2008-04-02
2284                  */
2285                 fprintf(stderr, "Error during class init for object '%s' - failing...\n", pErrObj);
2286         }
2287
2288         RETiRet;
2289 }
2290
2291
2292 /* Method to exit all global classes. We do not do any error checking here,
2293  * because that wouldn't help us at all. So better try to deinit blindly
2294  * as much as succeeds (which usually means everything will). We just must
2295  * be careful to do the de-init in the opposite order of the init, because
2296  * of the dependencies. However, its not as important this time, because
2297  * we have reference counting.
2298  * rgerhards, 2008-03-10
2299  */
2300 static rsRetVal
2301 GlobalClassExit(void)
2302 {
2303         DEFiRet;
2304
2305         /* first, release everything we used ourself */
2306         objRelease(net,      LM_NET_FILENAME);/* TODO: the dependency on net shall go away! -- rgerhards, 2008-03-07 */
2307         objRelease(prop,     CORE_COMPONENT);
2308         objRelease(conf,     CORE_COMPONENT);
2309         objRelease(ruleset,  CORE_COMPONENT);
2310         objRelease(rule,     CORE_COMPONENT);
2311         objRelease(expr,     CORE_COMPONENT);
2312         vmClassExit();                                  /* this is hack, currently core_modules do not get this automatically called */
2313         parserClassExit();                                      /* this is hack, currently core_modules do not get this automatically called */
2314         objRelease(datetime, CORE_COMPONENT);
2315
2316         /* TODO: implement the rest of the deinit */
2317         /* dummy "classes */
2318         strExit();
2319
2320 #if 0
2321         CHKiRet(objGetObjInterface(&obj)); /* this provides the root pointer for all other queries */
2322         /* the following classes were intialized by objClassInit() */
2323         CHKiRet(objUse(errmsg,   CORE_COMPONENT));
2324         CHKiRet(objUse(module,   CORE_COMPONENT));
2325 #endif
2326         rsrtExit(); /* *THIS* *MUST/SHOULD?* always be the first class initilizer being called (except debug)! */
2327
2328         RETiRet;
2329 }
2330
2331
2332 /* some support for command line option parsing. Any non-trivial options must be
2333  * buffered until the complete command line has been parsed. This is necessary to
2334  * prevent dependencies between the options. That, in turn, means we need to have
2335  * something that is capable of buffering options and there values. The follwing
2336  * functions handle that.
2337  * rgerhards, 2008-04-04
2338  */
2339 typedef struct bufOpt {
2340         struct bufOpt *pNext;
2341         char optchar;
2342         char *arg;
2343 } bufOpt_t;
2344 static bufOpt_t *bufOptRoot = NULL;
2345 static bufOpt_t *bufOptLast = NULL;
2346
2347 /* add option buffer */
2348 static rsRetVal
2349 bufOptAdd(char opt, char *arg)
2350 {
2351         DEFiRet;
2352         bufOpt_t *pBuf;
2353
2354         if((pBuf = MALLOC(sizeof(bufOpt_t))) == NULL)
2355                 ABORT_FINALIZE(RS_RET_OUT_OF_MEMORY);
2356
2357         pBuf->optchar = opt;
2358         pBuf->arg = arg;
2359         pBuf->pNext = NULL;
2360
2361         if(bufOptLast == NULL) {
2362                 bufOptRoot = pBuf; /* then there is also no root! */
2363         } else {
2364                 bufOptLast->pNext = pBuf;
2365         }
2366         bufOptLast = pBuf;
2367
2368 finalize_it:
2369         RETiRet;
2370 }
2371
2372
2373
2374 /* remove option buffer from top of list, return values and destruct buffer itself.
2375  * returns RS_RET_END_OF_LINKEDLIST when no more options are present.
2376  * (we use int *opt instead of char *opt to keep consistent with getopt())
2377  */
2378 static rsRetVal
2379 bufOptRemove(int *opt, char **arg)
2380 {
2381         DEFiRet;
2382         bufOpt_t *pBuf;
2383
2384         if(bufOptRoot == NULL)
2385                 ABORT_FINALIZE(RS_RET_END_OF_LINKEDLIST);
2386         pBuf = bufOptRoot;
2387
2388         *opt = pBuf->optchar;
2389         *arg = pBuf->arg;
2390
2391         bufOptRoot = pBuf->pNext;
2392         free(pBuf);
2393
2394 finalize_it:
2395         RETiRet;
2396 }
2397
2398
2399 /* global initialization, to be done only once and before the mainloop is started.
2400  * rgerhards, 2008-07-28 (extracted from realMain())
2401  */
2402 static rsRetVal
2403 doGlblProcessInit(void)
2404 {
2405         struct sigaction sigAct;
2406         int num_fds;
2407         int i;
2408         DEFiRet;
2409
2410         thrdInit();
2411
2412         if( !(Debug == DEBUG_FULL || NoFork) )
2413         {
2414                 DBGPRINTF("Checking pidfile.\n");
2415                 if (!check_pid(PidFile))
2416                 {
2417                         memset(&sigAct, 0, sizeof (sigAct));
2418                         sigemptyset(&sigAct.sa_mask);
2419                         sigAct.sa_handler = doexit;
2420                         sigaction(SIGTERM, &sigAct, NULL);
2421
2422                         if (fork()) {
2423                                 /* Parent process
2424                                  */
2425                                 sleep(300);
2426                                 /* Not reached unless something major went wrong.  5
2427                                  * minutes should be a fair amount of time to wait.
2428                                  * Please note that this procedure is important since
2429                                  * the father must not exit before syslogd isn't
2430                                  * initialized or the klogd won't be able to flush its
2431                                  * logs.  -Joey
2432                                  */
2433                                 exit(1); /* "good" exit - after forking, not diasabling anything */
2434                         }
2435
2436                         num_fds = getdtablesize();
2437                         close(0);
2438                         /* we keep stdout and stderr open in case we have to emit something */
2439                         i = 3;
2440
2441                         /* if (sd_booted()) */ {
2442                                 const char *e;
2443                                 char buf[24] = { '\0' };
2444                                 char *p = NULL;
2445                                 unsigned long l;
2446                                 int sd_fds;
2447
2448                                 /* fork & systemd socket activation:
2449                                  * fetch listen pid and update to ours,
2450                                  * when it is set to pid of our parent.
2451                                  */
2452                                 if ( (e = getenv("LISTEN_PID"))) {
2453                                         errno = 0;
2454                                         l = strtoul(e, &p, 10);
2455                                         if (errno ==  0 && l > 0 && (!p || !*p)) {
2456                                                 if (getppid() == (pid_t)l) {
2457                                                         snprintf(buf, sizeof(buf), "%d",
2458                                                                  getpid());
2459                                                         setenv("LISTEN_PID", buf, 1);
2460                                                 }
2461                                         }
2462                                 }
2463
2464                                 /*
2465                                  * close only all further fds, except
2466                                  * of the fds provided by systemd.
2467                                  */
2468                                 sd_fds = sd_listen_fds(0);
2469                                 if (sd_fds > 0)
2470                                         i = SD_LISTEN_FDS_START + sd_fds;
2471                         }
2472                         for ( ; i < num_fds; i++)
2473                                 (void) close(i);
2474
2475                         untty();
2476                 } else {
2477                         fputs(" Already running. If you want to run multiple instances, you need "
2478                               "to specify different pid files (use -i option)\n", stderr);
2479                         exit(1); /* "good" exit, done if syslogd is already running */
2480                 }
2481         }
2482
2483         /* tuck my process id away */
2484         DBGPRINTF("Writing pidfile %s.\n", PidFile);
2485         if (!check_pid(PidFile))
2486         {
2487                 if (!write_pid(PidFile))
2488                 {
2489                         fputs("Can't write pid.\n", stderr);
2490                         exit(1); /* exit during startup - questionable */
2491                 }
2492         }
2493         else
2494         {
2495                 fputs("Pidfile (and pid) already exist.\n", stderr);
2496                 exit(1); /* exit during startup - questionable */
2497         }
2498         myPid = getpid();       /* save our pid for further testing (also used for messages) */
2499
2500         memset(&sigAct, 0, sizeof (sigAct));
2501         sigemptyset(&sigAct.sa_mask);
2502
2503         sigAct.sa_handler = sigsegvHdlr;
2504         sigaction(SIGSEGV, &sigAct, NULL);
2505         sigAct.sa_handler = sigsegvHdlr;
2506         sigaction(SIGABRT, &sigAct, NULL);
2507         sigAct.sa_handler = doDie;
2508         sigaction(SIGTERM, &sigAct, NULL);
2509         sigAct.sa_handler = Debug ? doDie : SIG_IGN;
2510         sigaction(SIGINT, &sigAct, NULL);
2511         sigaction(SIGQUIT, &sigAct, NULL);
2512         sigAct.sa_handler = reapchild;
2513         sigaction(SIGCHLD, &sigAct, NULL);
2514         sigAct.sa_handler = Debug ? debug_switch : SIG_IGN;
2515         sigaction(SIGUSR1, &sigAct, NULL);
2516         sigAct.sa_handler = sigttin_handler;
2517         sigaction(SIGTTIN, &sigAct, NULL); /* (ab)used to interrupt input threads */
2518         sigAct.sa_handler = SIG_IGN;
2519         sigaction(SIGPIPE, &sigAct, NULL);
2520         sigaction(SIGXFSZ, &sigAct, NULL); /* do not abort if 2gig file limit is hit */
2521
2522         RETiRet;
2523 }
2524
2525
2526 /* This is the main entry point into rsyslogd. Over time, we should try to
2527  * modularize it a bit more...
2528  */
2529 int realMain(int argc, char **argv)
2530 {
2531         DEFiRet;
2532
2533         register uchar *p;
2534         int ch;
2535         struct hostent *hent;
2536         extern int optind;
2537         extern char *optarg;
2538         int bEOptionWasGiven = 0;
2539         int bImUxSockLoaded = 0; /* already generated a $ModLoad imuxsock? */
2540         int iHelperUOpt;
2541         int bChDirRoot = 1; /* change the current working directory to "/"? */
2542         char *arg;      /* for command line option processing */
2543         uchar legacyConfLine[80];
2544         uchar *LocalHostName;
2545         uchar *LocalDomain;
2546         uchar *LocalFQDNName;
2547         char cwdbuf[128]; /* buffer to obtain/display current working directory */
2548
2549         /* first, parse the command line options. We do not carry out any actual work, just
2550          * see what we should do. This relieves us from certain anomalies and we can process
2551          * the parameters down below in the correct order. For example, we must know the
2552          * value of -M before we can do the init, but at the same time we need to have
2553          * the base classes init before we can process most of the options. Now, with the
2554          * split of functionality, this is no longer a problem. Thanks to varmofekoj for
2555          * suggesting this algo.
2556          * Note: where we just need to set some flags and can do so without knowledge
2557          * of other options, we do this during the inital option processing. With later
2558          * versions (if a dependency on -c option is introduced), we must move that code
2559          * to other places, but I think it is quite appropriate and saves code to do this
2560         * only when actually neeeded.
2561          * rgerhards, 2008-04-04
2562          */
2563         while((ch = getopt(argc, argv, "46a:Ac:def:g:hi:l:m:M:nN:op:qQr::s:t:T:u:vwx")) != EOF) {
2564                 switch((char)ch) {
2565                 case '4':
2566                 case '6':
2567                 case 'A':
2568                 case 'a':
2569                 case 'f': /* configuration file */
2570                 case 'h':
2571                 case 'i': /* pid file name */
2572                 case 'l':
2573                 case 'm': /* mark interval */
2574                 case 'n': /* don't fork */
2575                 case 'N': /* enable config verify mode */
2576                 case 'o':
2577                 case 'p':
2578                 case 'q': /* add hostname if DNS resolving has failed */
2579                 case 'Q': /* dont resolve hostnames in ACL to IPs */
2580                 case 's':
2581                 case 'T': /* chroot on startup (primarily for testing) */
2582                 case 'u': /* misc user settings */
2583                 case 'w': /* disable disallowed host warnings */
2584                 case 'x': /* disable dns for remote messages */
2585                         CHKiRet(bufOptAdd(ch, optarg));
2586                         break;
2587                 case 'c':               /* compatibility mode */
2588                         iCompatibilityMode = atoi(optarg);
2589                         break;
2590                 case 'd': /* debug - must be handled now, so that debug is active during init! */
2591                         debugging_on = 1;
2592                         Debug = 1;
2593                         break;
2594                 case 'e':               /* log every message (no repeat message supression) */
2595                         fprintf(stderr, "note: -e option is no longer supported, every message is now logged by default\n");
2596                         bEOptionWasGiven = 1;
2597                         break;
2598                 case 'g':               /* enable tcp gssapi logging */
2599 #if defined(SYSLOG_INET) && defined(USE_GSSAPI)
2600                         CHKiRet(bufOptAdd('g', optarg));
2601 #else
2602                         fprintf(stderr, "rsyslogd: -g not valid - not compiled with gssapi support");
2603 #endif
2604                         break;
2605                 case 'M': /* default module load path -- this MUST be carried out immediately! */
2606                         glblModPath = (uchar*) optarg;
2607                         break;
2608                 case 'r':               /* accept remote messages */
2609 #ifdef SYSLOG_INET
2610                         CHKiRet(bufOptAdd(ch, optarg));
2611 #else
2612                         fprintf(stderr, "rsyslogd: -r not valid - not compiled with network support\n");
2613 #endif
2614                         break;
2615                 case 't':               /* enable tcp logging */
2616 #ifdef SYSLOG_INET
2617                         CHKiRet(bufOptAdd(ch, optarg));
2618 #else
2619                         fprintf(stderr, "rsyslogd: -t not valid - not compiled with network support\n");
2620 #endif
2621                         break;
2622                 case 'v': /* MUST be carried out immediately! */
2623                         printVersion();
2624                         exit(0); /* exit for -v option - so this is a "good one" */
2625                case '?':
2626                 default:
2627                         usage();
2628                 }
2629         }
2630
2631         if(argc - optind)
2632                 usage();
2633
2634         DBGPRINTF("rsyslogd %s startup, compatibility mode %d, module path '%s', cwd:%s\n",
2635                   VERSION, iCompatibilityMode, glblModPath == NULL ? "" : (char*)glblModPath,
2636                   getcwd(cwdbuf, sizeof(cwdbuf)));
2637
2638         /* we are done with the initial option parsing and processing. Now we init the system. */
2639
2640         ppid = getpid();
2641
2642         CHKiRet_Hdlr(InitGlobalClasses()) {
2643                 fprintf(stderr, "rsyslogd initializiation failed - global classes could not be initialized.\n"
2644                                 "Did you do a \"make install\"?\n"
2645                                 "Suggested action: run rsyslogd with -d -n options to see what exactly "
2646                                 "fails.\n");
2647                 FINALIZE;
2648         }
2649
2650         /* doing some core initializations */
2651
2652         /* we need to create the inputName property (only once during our lifetime) */
2653         CHKiRet(prop.Construct(&pInternalInputName));
2654         CHKiRet(prop.SetString(pInternalInputName, UCHAR_CONSTANT("rsyslogd"), sizeof("rsyslgod") - 1));
2655         CHKiRet(prop.ConstructFinalize(pInternalInputName));
2656
2657         CHKiRet(prop.Construct(&pLocalHostIP));
2658         CHKiRet(prop.SetString(pLocalHostIP, UCHAR_CONSTANT("127.0.0.1"), sizeof("127.0.0.1") - 1));
2659         CHKiRet(prop.ConstructFinalize(pLocalHostIP));
2660
2661         /* get our host and domain names - we need to do this early as we may emit
2662          * error log messages, which need the correct hostname. -- rgerhards, 2008-04-04
2663          */
2664         net.getLocalHostname(&LocalFQDNName);
2665         CHKmalloc(LocalHostName = (uchar*) strdup((char*)LocalFQDNName));
2666         glbl.SetLocalFQDNName(LocalFQDNName); /* set the FQDN before we modify it */
2667         if((p = (uchar*)strchr((char*)LocalHostName, '.'))) {
2668                 *p++ = '\0';
2669                 LocalDomain = p;
2670         } else {
2671                 LocalDomain = (uchar*)"";
2672
2673                 /* It's not clearly defined whether gethostname()
2674                  * should return the simple hostname or the fqdn. A
2675                  * good piece of software should be aware of both and
2676                  * we want to distribute good software.  Joey
2677                  *
2678                  * Good software also always checks its return values...
2679                  * If syslogd starts up before DNS is up & /etc/hosts
2680                  * doesn't have LocalHostName listed, gethostbyname will
2681                 * return NULL.
2682                  */
2683                 /* TODO: gethostbyname() is not thread-safe, but replacing it is
2684                  * not urgent as we do not run on multiple threads here. rgerhards, 2007-09-25
2685                  */
2686                 hent = gethostbyname((char*)LocalHostName);
2687                 if(hent) {
2688                         int i = 0;
2689
2690                         if(hent->h_aliases) {
2691                                 size_t hnlen;
2692
2693                                 hnlen = strlen((char *) LocalHostName);
2694
2695                                 for (i = 0; hent->h_aliases[i]; i++) {
2696                                         if (!strncmp(hent->h_aliases[i], (char *) LocalHostName, hnlen)
2697                                             && hent->h_aliases[i][hnlen] == '.') {
2698                                                 /* found a matching hostname */
2699                                                 break;
2700                                         }
2701                                 }
2702                         }
2703
2704                         free(LocalHostName);
2705                         if(hent->h_aliases && hent->h_aliases[i]) {
2706                                 CHKmalloc(LocalHostName = (uchar*)strdup(hent->h_aliases[i]));
2707                         } else {
2708                                 CHKmalloc(LocalHostName = (uchar*)strdup(hent->h_name));
2709                         }
2710
2711                         if((p = (uchar*)strchr((char*)LocalHostName, '.')))
2712                         {
2713                                 *p++ = '\0';
2714                                 LocalDomain = p;
2715                         }
2716                 }
2717         }
2718
2719         /* Convert to lower case to recognize the correct domain laterly */
2720         for(p = LocalDomain ; *p ; p++)
2721                 *p = (char)tolower((int)*p);
2722
2723         /* we now have our hostname and can set it inside the global vars.
2724          * TODO: think if all of this would better be a runtime function
2725          * rgerhards, 2008-04-17
2726          */
2727         glbl.SetLocalHostName(LocalHostName);
2728         glbl.SetLocalDomain(LocalDomain);
2729         glbl.GenerateLocalHostNameProperty(); /* must be redone after conf processing, FQDN setting may have changed */
2730
2731         /* initialize the objects */
2732         if((iRet = modInitIminternal()) != RS_RET_OK) {
2733                 fprintf(stderr, "fatal error: could not initialize errbuf object (error code %d).\n",
2734                         iRet);
2735                 exit(1); /* "good" exit, leaving at init for fatal error */
2736         }
2737
2738         if((iRet = loadBuildInModules()) != RS_RET_OK) {
2739                 fprintf(stderr, "fatal error: could not activate built-in modules. Error code %d.\n",
2740                         iRet);
2741                 exit(1); /* "good" exit, leaving at init for fatal error */
2742         }
2743
2744         /* END core initializations - we now come back to carrying out command line options*/
2745
2746         while((iRet = bufOptRemove(&ch, &arg)) == RS_RET_OK) {
2747                 DBGPRINTF("deque option %c, optarg '%s'\n", ch, (arg == NULL) ? "" : arg);
2748                 switch((char)ch) {
2749                 case '4':
2750                         glbl.SetDefPFFamily(PF_INET);
2751                         break;
2752                 case '6':
2753                         glbl.SetDefPFFamily(PF_INET6);
2754                         break;
2755                 case 'A':
2756                         send_to_all++;
2757                         break;
2758                 case 'a':
2759                         if(iCompatibilityMode < 3) {
2760                                 if(!bImUxSockLoaded) {
2761                                         legacyOptsEnq((uchar *) "ModLoad imuxsock");
2762                                         bImUxSockLoaded = 1;
2763                                 }
2764                                 snprintf((char *) legacyConfLine, sizeof(legacyConfLine), "addunixlistensocket %s", arg);
2765                                 legacyOptsEnq(legacyConfLine);
2766                         } else {
2767                                 fprintf(stderr, "error -a is no longer supported, use module imuxsock instead");
2768                         }
2769                         break;
2770                 case 'f':               /* configuration file */
2771                         ConfFile = (uchar*) arg;
2772                         break;
2773                 case 'g':               /* enable tcp gssapi logging */
2774                         if(iCompatibilityMode < 3) {
2775                                 legacyOptsParseTCP(ch, arg);
2776                         } else
2777                                 fprintf(stderr, "-g option only supported in compatibility modes 0 to 2 - ignored\n");
2778                         break;
2779                 case 'h':
2780                         if(iCompatibilityMode < 3) {
2781                                 errmsg.LogError(0, NO_ERRCODE, "WARNING: -h option is no longer supported - ignored");
2782                         } else {
2783                                 usage(); /* for v3 and above, it simply is an error */
2784                         }
2785                         break;
2786                 case 'i':               /* pid file name */
2787                         PidFile = arg;
2788                         break;
2789                 case 'l':
2790                         if(glbl.GetLocalHosts() != NULL) {
2791                                 fprintf (stderr, "rsyslogd: Only one -l argument allowed, the first one is taken.\n");
2792                         } else {
2793                                 glbl.SetLocalHosts(crunch_list(arg));
2794                         }
2795                         break;
2796                 case 'm':               /* mark interval */
2797                         if(iCompatibilityMode < 3) {
2798                                 MarkInterval = atoi(arg) * 60;
2799                         } else
2800                                 fprintf(stderr,
2801                                         "-m option only supported in compatibility modes 0 to 2 - ignored\n");
2802                         break;
2803                 case 'n':               /* don't fork */
2804                         NoFork = 1;
2805                         break;
2806                 case 'N':               /* enable config verify mode */
2807                         iConfigVerify = atoi(arg);
2808                         break;
2809                 case 'o':
2810                         if(iCompatibilityMode < 3) {
2811                                 if(!bImUxSockLoaded) {
2812                                         legacyOptsEnq((uchar *) "ModLoad imuxsock");
2813                                         bImUxSockLoaded = 1;
2814                                 }
2815                                 legacyOptsEnq((uchar *) "OmitLocalLogging");
2816                         } else {
2817                                 fprintf(stderr, "error -o is no longer supported, use module imuxsock instead");
2818                         }
2819                         break;
2820                 case 'p':
2821                         if(iCompatibilityMode < 3) {
2822                                 if(!bImUxSockLoaded) {
2823                                         legacyOptsEnq((uchar *) "ModLoad imuxsock");
2824                                         bImUxSockLoaded = 1;
2825                                 }
2826                                 snprintf((char *) legacyConfLine, sizeof(legacyConfLine), "SystemLogSocketName %s", arg);
2827                                 legacyOptsEnq(legacyConfLine);
2828                         } else {
2829                                 fprintf(stderr, "error -p is no longer supported, use module imuxsock instead");
2830                         }
2831                         break;
2832                 case 'q':               /* add hostname if DNS resolving has failed */
2833                         *(net.pACLAddHostnameOnFail) = 1;
2834                         break;
2835                 case 'Q':               /* dont resolve hostnames in ACL to IPs */
2836                         *(net.pACLDontResolve) = 1;
2837                         break;
2838                 case 'r':               /* accept remote messages */
2839                         if(iCompatibilityMode < 3) {
2840                                 legacyOptsEnq((uchar *) "ModLoad imudp");
2841                                 snprintf((char *) legacyConfLine, sizeof(legacyConfLine), "UDPServerRun %s", arg);
2842                                 legacyOptsEnq(legacyConfLine);
2843                         } else
2844                                 fprintf(stderr, "-r option only supported in compatibility modes 0 to 2 - ignored\n");
2845                         break;
2846                 case 's':
2847                         if(glbl.GetStripDomains() != NULL) {
2848                                 fprintf (stderr, "rsyslogd: Only one -s argument allowed, the first one is taken.\n");
2849                         } else {
2850                                 glbl.SetStripDomains(crunch_list(arg));
2851                         }
2852                         break;
2853                 case 't':               /* enable tcp logging */
2854                         if(iCompatibilityMode < 3) {
2855                                 legacyOptsParseTCP(ch, arg);
2856                         } else
2857                                 fprintf(stderr, "-t option only supported in compatibility modes 0 to 2 - ignored\n");
2858                         break;
2859                 case 'T':/* chroot() immediately at program startup, but only for testing, NOT security yet */
2860                         if(chroot(arg) != 0) {
2861                                 perror("chroot");
2862                                 exit(1);
2863                         }
2864                         break;
2865                 case 'u':               /* misc user settings */
2866                         iHelperUOpt = atoi(arg);
2867                         if(iHelperUOpt & 0x01)
2868                                 glbl.SetParseHOSTNAMEandTAG(0);
2869                         if(iHelperUOpt & 0x02)
2870                                 bChDirRoot = 0;
2871                         break;
2872                 case 'w':               /* disable disallowed host warnigs */
2873                         glbl.SetOption_DisallowWarning(0);
2874                         break;
2875                 case 'x':               /* disable dns for remote messages */
2876                         glbl.SetDisableDNS(1);
2877                         break;
2878                case '?':
2879                 default:
2880                         usage();
2881                 }
2882         }
2883
2884         if(iRet != RS_RET_END_OF_LINKEDLIST)
2885                 FINALIZE;
2886
2887         if(iConfigVerify) {
2888                 fprintf(stderr, "rsyslogd: version %s, config validation run (level %d), master config %s\n",
2889                         VERSION, iConfigVerify, ConfFile);
2890         }
2891
2892         if(bChDirRoot) {
2893                 if(chdir("/") != 0)
2894                         fprintf(stderr, "Can not do 'cd /' - still trying to run\n");
2895         }
2896
2897
2898         /* process compatibility mode settings */
2899         if(iCompatibilityMode < 4) {
2900                 errmsg.LogError(0, NO_ERRCODE, "WARNING: rsyslogd is running in compatibility mode. Automatically "
2901                                             "generated config directives may interfer with your rsyslog.conf settings. "
2902                                             "We suggest upgrading your config and adding -c5 as the first "
2903                                             "rsyslogd option.");
2904         }
2905
2906         if(iCompatibilityMode < 3) {
2907                 if(MarkInterval > 0) {
2908                         legacyOptsEnq((uchar *) "ModLoad immark");
2909                         snprintf((char *) legacyConfLine, sizeof(legacyConfLine), "MarkMessagePeriod %d", MarkInterval);
2910                         legacyOptsEnq(legacyConfLine);
2911                 }
2912                 if(!bImUxSockLoaded) {
2913                         legacyOptsEnq((uchar *) "ModLoad imuxsock");
2914                 }
2915         }
2916
2917         if(bEOptionWasGiven && iCompatibilityMode < 3) {
2918                 errmsg.LogError(0, NO_ERRCODE, "WARNING: \"message repeated n times\" feature MUST be turned on in "
2919                                             "rsyslog.conf - CURRENTLY EVERY MESSAGE WILL BE LOGGED. Visit "
2920                                             "http://www.rsyslog.com/rptdmsgreduction to learn "
2921                                             "more and cast your vote if you want us to keep this feature.");
2922         }
2923
2924         if(!iConfigVerify)
2925                 CHKiRet(doGlblProcessInit());
2926
2927         CHKiRet(mainThread());
2928
2929         /* do any de-init's that need to be done AFTER this comment */
2930
2931         die(bFinished);
2932
2933         thrdExit();
2934
2935 finalize_it:
2936         if(iRet == RS_RET_VALIDATION_RUN) {
2937                 fprintf(stderr, "rsyslogd: End of config validation run. Bye.\n");
2938         } else if(iRet != RS_RET_OK) {
2939                 fprintf(stderr, "rsyslogd run failed with error %d (see rsyslog.h "
2940                                 "or try http://www.rsyslog.com/e/%d to learn what that number means)\n", iRet, iRet*-1);
2941         }
2942
2943         ENDfunc
2944         return 0;
2945 }
2946
2947
2948 /* This is the main entry point into rsyslogd. This must be a function in its own
2949  * right in order to intialize the debug system in a portable way (otherwise we would
2950  * need to have a statement before variable definitions.
2951  * rgerhards, 20080-01-28
2952  */
2953 int main(int argc, char **argv)
2954 {
2955         dbgClassInit();
2956         return realMain(argc, argv);
2957 }
2958 /* vim:set ai:
2959  */