/
omfile.c
1644 lines (1465 loc) · 56.3 KB
/
omfile.c
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/* omfile.c
* This is the implementation of the build-in file output module.
*
* NOTE: read comments in module-template.h to understand how this file
* works!
*
* File begun on 2007-07-21 by RGerhards (extracted from syslogd.c, which
* at the time of the fork from sysklogd was under BSD license)
*
* A large re-write of this file was done in June, 2009. The focus was
* to introduce many more features (like zipped writing), clean up the code
* and make it more reliable. In short, that rewrite tries to provide a new
* solid basis for the next three to five years to come. During it, bugs
* may have been introduced ;) -- rgerhards, 2009-06-04
*
* Note that as of 2010-02-28 this module does no longer handle
* pipes. These have been moved to ompipe, to reduced the entanglement
* between the two different functionalities. -- rgerhards
*
* Copyright 2007-2024 Adiscon GmbH.
*
* This file is part of rsyslog.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
* -or-
* see COPYING.ASL20 in the source distribution
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#include "config.h"
#include <stdio.h>
#include <stdarg.h>
#include <stdlib.h>
#include <string.h>
#include <time.h>
#include <assert.h>
#include <errno.h>
#include <ctype.h>
#include <libgen.h>
#include <unistd.h>
#include <sys/file.h>
#include <fcntl.h>
#ifdef HAVE_ATOMIC_BUILTINS
# include <pthread.h>
#endif
#include "rsyslog.h"
#include "conf.h"
#include "syslogd-types.h"
#include "srUtils.h"
#include "template.h"
#include "outchannel.h"
#include "omfile.h"
#include "cfsysline.h"
#include "module-template.h"
#include "errmsg.h"
#include "stream.h"
#include "unicode-helper.h"
#include "atomic.h"
#include "statsobj.h"
#include "sigprov.h"
#include "cryprov.h"
#include "parserif.h"
#include "janitor.h"
#include "rsconf.h"
MODULE_TYPE_OUTPUT
MODULE_TYPE_NOKEEP
MODULE_CNFNAME("omfile")
/* forward definitions */
static rsRetVal resetConfigVariables(uchar __attribute__((unused)) *pp, void __attribute__((unused)) *pVal);
/* internal structures
*/
DEF_OMOD_STATIC_DATA
DEFobjCurrIf(strm)
DEFobjCurrIf(statsobj)
/* for our current LRU mechanism, we need a monotonically increasing counters. We use
* it much like a "Lamport logical clock": we do not need the actual time, we just need
* to know the sequence in which files were accessed. So we use a simple counter to
* create that sequence. We use an unsigned 64 bit value which is extremely unlike to
* wrap within the lifetime of a process. If we process 1,000,000 file writes per
* second, the process could still exist over 500,000 years before a wrap to 0 happens.
* That should be sufficient (and even than, there would no really bad effect ;)).
* The variable below is the global counter/clock.
*/
#ifdef HAVE_ATOMIC_BUILTINS64
static uint64 clockFileAccess = 0;
#else
static unsigned clockFileAccess = 0;
#endif
/* and the "tick" function */
#ifndef HAVE_ATOMIC_BUILTINS
static pthread_mutex_t mutClock;
#endif
static uint64
getClockFileAccess(void)
{
#ifdef HAVE_ATOMIC_BUILTINS64
return ATOMIC_INC_AND_FETCH_uint64(&clockFileAccess, &mutClock);
#else
return ATOMIC_INC_AND_FETCH_unsigned(&clockFileAccess, &mutClock);
#endif
}
/* The following structure is a dynafile name cache entry.
*/
struct s_dynaFileCacheEntry {
uchar *pName; /* name currently open, if dynamic name */
strm_t *pStrm; /* our output stream */
void *sigprovFileData; /* opaque data ptr for provider use */
uint64 clkTickAccessed;/* for LRU - based on clockFileAccess */
short nInactive; /* number of minutes not writen - for close timeout */
};
typedef struct s_dynaFileCacheEntry dynaFileCacheEntry;
#define IOBUF_DFLT_SIZE 4096 /* default size for io buffers */
#define FLUSH_INTRVL_DFLT 1 /* default buffer flush interval (in seconds) */
#define USE_ASYNCWRITER_DFLT 0 /* default buffer use async writer */
#define FLUSHONTX_DFLT 1 /* default for flush on TX end */
typedef struct _instanceData {
pthread_mutex_t mutWrite; /* guard against multiple instances writing to single file */
uchar *fname; /* file or template name (display only) */
uchar *tplName; /* name of assigned template */
strm_t *pStrm; /* our output stream */
short nInactive; /* number of minutes not writen (STATIC files only) */
char bDynamicName; /* 0 - static name, 1 - dynamic name (with properties) */
int isDevNull; /* do we "write" to /dev/null? - if so, do nothing */
int fCreateMode; /* file creation mode for open() */
int fDirCreateMode; /* creation mode for mkdir() */
int bCreateDirs; /* auto-create directories? */
int bSyncFile; /* should the file by sync()'ed? 1- yes, 0- no */
uint8_t iNumTpls; /* number of tpls we use */
uid_t fileUID; /* IDs for creation */
uid_t dirUID;
gid_t fileGID;
gid_t dirGID;
int bFailOnChown; /* fail creation if chown fails? */
uchar *sigprovName; /* signature provider */
uchar *sigprovNameFull;/* full internal signature provider name */
sigprov_if_t sigprov; /* ptr to signature provider interface */
void *sigprovData; /* opaque data ptr for provider use */
void *sigprovFileData;/* opaque data ptr for file instance */
sbool useSigprov; /* quicker than checkig ptr (1 vs 8 bytes!) */
uchar *cryprovName; /* crypto provider */
uchar *cryprovNameFull;/* full internal crypto provider name */
void *cryprovData; /* opaque data ptr for provider use */
cryprov_if_t cryprov; /* ptr to crypto provider interface */
sbool useCryprov; /* quicker than checkig ptr (1 vs 8 bytes!) */
int iCurrElt; /* currently active cache element (-1 = none) */
int iCurrCacheSize; /* currently cache size (1-based) */
int iDynaFileCacheSize; /* size of file handle cache */
/* The cache is implemented as an array. An empty element is indicated
* by a NULL pointer. Memory is allocated as needed. The following
* pointer points to the overall structure.
*/
dynaFileCacheEntry **dynCache;
off_t iSizeLimit; /* file size limit, 0 = no limit */
uchar *pszSizeLimitCmd; /* command to carry out when size limit is reached */
int iZipLevel; /* zip mode to use for this selector */
int iIOBufSize; /* size of associated io buffer */
int iFlushInterval; /* how fast flush buffer on inactivity? */
short iCloseTimeout; /* after how many *minutes* shall the file be closed if inactive? */
sbool bFlushOnTXEnd; /* flush write buffers when transaction has ended? */
sbool bUseAsyncWriter; /* use async stream writer? */
sbool bVeryRobustZip;
statsobj_t *stats; /* dynafile, primarily cache stats */
STATSCOUNTER_DEF(ctrRequests, mutCtrRequests);
STATSCOUNTER_DEF(ctrLevel0, mutCtrLevel0);
STATSCOUNTER_DEF(ctrEvict, mutCtrEvict);
STATSCOUNTER_DEF(ctrMiss, mutCtrMiss);
STATSCOUNTER_DEF(ctrMax, mutCtrMax);
STATSCOUNTER_DEF(ctrCloseTimeouts, mutCtrCloseTimeouts);
char janitorID[128]; /* holds ID for janitor calls */
} instanceData;
typedef struct wrkrInstanceData {
instanceData *pData;
} wrkrInstanceData_t;
typedef struct configSettings_s {
int iDynaFileCacheSize; /* max cache for dynamic files */
int fCreateMode; /* mode to use when creating files */
int fDirCreateMode; /* mode to use when creating files */
int bFailOnChown; /* fail if chown fails? */
uid_t fileUID; /* UID to be used for newly created files */
uid_t fileGID; /* GID to be used for newly created files */
uid_t dirUID; /* UID to be used for newly created directories */
uid_t dirGID; /* GID to be used for newly created directories */
int bCreateDirs;/* auto-create directories for dynaFiles: 0 - no, 1 - yes */
int bEnableSync;/* enable syncing of files (no dash in front of pathname in conf): 0 - no, 1 - yes */
int iZipLevel; /* zip compression mode (0..9 as usual) */
sbool bFlushOnTXEnd;/* flush write buffers when transaction has ended? */
int64 iIOBufSize; /* size of an io buffer */
int iFlushInterval; /* how often flush the output buffer on inactivity? */
int bUseAsyncWriter; /* should we enable asynchronous writing? */
EMPTY_STRUCT
} configSettings_t;
static configSettings_t cs;
uchar *pszFileDfltTplName; /* name of the default template to use */
struct modConfData_s {
rsconf_t *pConf; /* our overall config object */
uchar *tplName; /* default template */
int fCreateMode; /* default mode to use when creating files */
int fDirCreateMode; /* default mode to use when creating files */
uid_t fileUID; /* default IDs for creation */
uid_t dirUID;
gid_t fileGID;
gid_t dirGID;
int bDynafileDoNotSuspend;
strm_compressionDriver_t compressionDriver;
int compressionDriver_workers;
};
static modConfData_t *loadModConf = NULL;/* modConf ptr to use for the current load process */
static modConfData_t *runModConf = NULL;/* modConf ptr to use for the current exec process */
/* tables for interfacing with the v6 config system */
/* module-global parameters */
static struct cnfparamdescr modpdescr[] = {
{ "template", eCmdHdlrGetWord, 0 },
{ "compression.driver", eCmdHdlrGetWord, 0 },
{ "compression.zstd.workers", eCmdHdlrPositiveInt, 0 },
{ "dircreatemode", eCmdHdlrFileCreateMode, 0 },
{ "filecreatemode", eCmdHdlrFileCreateMode, 0 },
{ "dirowner", eCmdHdlrUID, 0 },
{ "dirownernum", eCmdHdlrInt, 0 },
{ "dirgroup", eCmdHdlrGID, 0 },
{ "dirgroupnum", eCmdHdlrInt, 0 },
{ "fileowner", eCmdHdlrUID, 0 },
{ "fileownernum", eCmdHdlrInt, 0 },
{ "filegroup", eCmdHdlrGID, 0 },
{ "dynafile.donotsuspend", eCmdHdlrBinary, 0 },
{ "filegroupnum", eCmdHdlrInt, 0 },
};
static struct cnfparamblk modpblk =
{ CNFPARAMBLK_VERSION,
sizeof(modpdescr)/sizeof(struct cnfparamdescr),
modpdescr
};
/* action (instance) parameters */
static struct cnfparamdescr actpdescr[] = {
{ "dynafilecachesize", eCmdHdlrInt, 0 }, /* legacy: dynafilecachesize */
{ "ziplevel", eCmdHdlrInt, 0 }, /* legacy: omfileziplevel */
{ "flushinterval", eCmdHdlrInt, 0 }, /* legacy: omfileflushinterval */
{ "asyncwriting", eCmdHdlrBinary, 0 }, /* legacy: omfileasyncwriting */
{ "veryrobustzip", eCmdHdlrBinary, 0 },
{ "flushontxend", eCmdHdlrBinary, 0 }, /* legacy: omfileflushontxend */
{ "iobuffersize", eCmdHdlrSize, 0 }, /* legacy: omfileiobuffersize */
{ "dirowner", eCmdHdlrUID, 0 }, /* legacy: dirowner */
{ "dirownernum", eCmdHdlrInt, 0 }, /* legacy: dirownernum */
{ "dirgroup", eCmdHdlrGID, 0 }, /* legacy: dirgroup */
{ "dirgroupnum", eCmdHdlrInt, 0 }, /* legacy: dirgroupnum */
{ "fileowner", eCmdHdlrUID, 0 }, /* legacy: fileowner */
{ "fileownernum", eCmdHdlrInt, 0 }, /* legacy: fileownernum */
{ "filegroup", eCmdHdlrGID, 0 }, /* legacy: filegroup */
{ "filegroupnum", eCmdHdlrInt, 0 }, /* legacy: filegroupnum */
{ "dircreatemode", eCmdHdlrFileCreateMode, 0 }, /* legacy: dircreatemode */
{ "filecreatemode", eCmdHdlrFileCreateMode, 0 }, /* legacy: filecreatemode */
{ "failonchownfailure", eCmdHdlrBinary, 0 }, /* legacy: failonchownfailure */
{ "createdirs", eCmdHdlrBinary, 0 }, /* legacy: createdirs */
{ "sync", eCmdHdlrBinary, 0 }, /* legacy: actionfileenablesync */
{ "file", eCmdHdlrString, 0 }, /* either "file" or ... */
{ "dynafile", eCmdHdlrString, 0 }, /* "dynafile" MUST be present */
{ "sig.provider", eCmdHdlrGetWord, 0 },
{ "cry.provider", eCmdHdlrGetWord, 0 },
{ "closetimeout", eCmdHdlrPositiveInt, 0 },
{ "rotation.sizelimit", eCmdHdlrSize, 0 },
{ "rotation.sizelimitcommand", eCmdHdlrString, 0 },
{ "template", eCmdHdlrGetWord, 0 }
};
static struct cnfparamblk actpblk =
{ CNFPARAMBLK_VERSION,
sizeof(actpdescr)/sizeof(struct cnfparamdescr),
actpdescr
};
/* this function gets the default template. It coordinates action between
* old-style and new-style configuration parts.
*/
static uchar*
getDfltTpl(void)
{
if(loadModConf != NULL && loadModConf->tplName != NULL)
return loadModConf->tplName;
else if(pszFileDfltTplName == NULL)
return (uchar*)"RSYSLOG_FileFormat";
else
return pszFileDfltTplName;
}
BEGINinitConfVars /* (re)set config variables to default values */
CODESTARTinitConfVars
pszFileDfltTplName = NULL; /* make sure this can be free'ed! */
iRet = resetConfigVariables(NULL, NULL); /* params are dummies */
ENDinitConfVars
BEGINisCompatibleWithFeature
CODESTARTisCompatibleWithFeature
if(eFeat == sFEATURERepeatedMsgReduction)
iRet = RS_RET_OK;
ENDisCompatibleWithFeature
BEGINdbgPrintInstInfo
CODESTARTdbgPrintInstInfo
if(pData->bDynamicName) {
dbgprintf("[dynamic]\n");
} else { /* regular file */
dbgprintf("%s%s\n", pData->fname,
(pData->pStrm == NULL) ? " (closed)" : "");
}
dbgprintf("\ttemplate='%s'\n", pData->fname);
dbgprintf("\tuse async writer=%d\n", pData->bUseAsyncWriter);
dbgprintf("\tflush on TX end=%d\n", pData->bFlushOnTXEnd);
dbgprintf("\tflush interval=%d\n", pData->iFlushInterval);
dbgprintf("\tfile cache size=%d\n", pData->iDynaFileCacheSize);
dbgprintf("\tcreate directories: %s\n", pData->bCreateDirs ? "on" : "off");
dbgprintf("\tvery robust zip: %s\n", pData->bCreateDirs ? "on" : "off");
dbgprintf("\tfile owner %d, group %d\n", (int) pData->fileUID, (int) pData->fileGID);
dbgprintf("\tdirectory owner %d, group %d\n", (int) pData->dirUID, (int) pData->dirGID);
dbgprintf("\tdir create mode 0%3.3o, file create mode 0%3.3o\n",
pData->fDirCreateMode, pData->fCreateMode);
dbgprintf("\tfail if owner/group can not be set: %s\n", pData->bFailOnChown ? "yes" : "no");
ENDdbgPrintInstInfo
/* set the default template to be used
* This is a module-global parameter, and as such needs special handling. It needs to
* be coordinated with values set via the v2 config system (rsyslog v6+). What we do
* is we do not permit this directive after the v2 config system has been used to set
* the parameter.
*/
static rsRetVal
setLegacyDfltTpl(void __attribute__((unused)) *pVal, uchar* newVal)
{
DEFiRet;
if(loadModConf != NULL && loadModConf->tplName != NULL) {
free(newVal);
parser_errmsg("omfile: default template already set via module "
"global parameter - can no longer be changed");
ABORT_FINALIZE(RS_RET_ERR);
}
free(pszFileDfltTplName);
pszFileDfltTplName = newVal;
finalize_it:
RETiRet;
}
/* set the dynaFile cache size. Does some limit checking.
* rgerhards, 2007-07-31
*/
static rsRetVal setDynaFileCacheSize(void __attribute__((unused)) *pVal, int iNewVal)
{
DEFiRet;
if(iNewVal < 1) {
errno = 0;
parser_errmsg(
"DynaFileCacheSize must be greater 0 (%d given), changed to 1.", iNewVal);
iRet = RS_RET_VAL_OUT_OF_RANGE;
iNewVal = 1;
} else if(iNewVal > 25000) {
errno = 0;
parser_warnmsg("DynaFileCacheSize is larger than 25,000 (%d given) - this looks very "
"large. Is it intended?", iNewVal);
}
cs.iDynaFileCacheSize = iNewVal;
DBGPRINTF("DynaFileCacheSize changed to %d.\n", iNewVal);
RETiRet;
}
/* Helper to cfline(). Parses a output channel name up until the first
* comma and then looks for the template specifier. Tries
* to find that template. Maps the output channel to the
* proper filed structure settings. Everything is stored in the
* filed struct. Over time, the dependency on filed might be
* removed.
* rgerhards 2005-06-21
*/
static rsRetVal cflineParseOutchannel(instanceData *pData, uchar* p, omodStringRequest_t *pOMSR,
int iEntry, int iTplOpts)
{
DEFiRet;
size_t i;
struct outchannel *pOch;
char szBuf[128]; /* should be more than sufficient */
++p; /* skip '$' */
i = 0;
/* get outchannel name */
while(*p && *p != ';' && *p != ' ' &&
i < (sizeof(szBuf) - 1) ) {
szBuf[i++] = *p++;
}
szBuf[i] = '\0';
/* got the name, now look up the channel... */
pOch = ochFind(szBuf, i);
if(pOch == NULL) {
parser_errmsg(
"outchannel '%s' not found - ignoring action line",
szBuf);
ABORT_FINALIZE(RS_RET_NOT_FOUND);
}
/* check if there is a file name in the outchannel... */
if(pOch->pszFileTemplate == NULL) {
parser_errmsg(
"outchannel '%s' has no file name template - ignoring action line",
szBuf);
ABORT_FINALIZE(RS_RET_ERR);
}
/* OK, we finally got a correct template. So let's use it... */
pData->fname = ustrdup(pOch->pszFileTemplate);
pData->iSizeLimit = pOch->uSizeLimit;
/* WARNING: It is dangerous "just" to pass the pointer. As we
* never rebuild the output channel description, this is acceptable here.
*/
pData->pszSizeLimitCmd = pOch->cmdOnSizeLimit;
iRet = cflineParseTemplateName(&p, pOMSR, iEntry, iTplOpts, getDfltTpl());
finalize_it:
RETiRet;
}
/* This function deletes an entry from the dynamic file name
* cache. A pointer to the cache must be passed in as well
* as the index of the to-be-deleted entry. This index may
* point to an unallocated entry, in whcih case the
* function immediately returns. Parameter bFreeEntry is 1
* if the entry should be free()ed and 0 if not.
*/
static rsRetVal
dynaFileDelCacheEntry(instanceData *__restrict__ const pData, const int iEntry, const int bFreeEntry)
{
dynaFileCacheEntry **pCache = pData->dynCache;
DEFiRet;
assert(pCache != NULL);
if(pCache[iEntry] == NULL)
FINALIZE;
DBGPRINTF("Removing entry %d for file '%s' from dynaCache.\n", iEntry,
pCache[iEntry]->pName == NULL ? UCHAR_CONSTANT("[OPEN FAILED]") : pCache[iEntry]->pName);
if(pCache[iEntry]->pName != NULL) {
free(pCache[iEntry]->pName);
pCache[iEntry]->pName = NULL;
}
if(pCache[iEntry]->pStrm != NULL) {
if(iEntry == pData->iCurrElt) {
pData->iCurrElt = -1;
pData->pStrm = NULL;
}
strm.Destruct(&pCache[iEntry]->pStrm);
if(pData->useSigprov) {
pData->sigprov.OnFileClose(pCache[iEntry]->sigprovFileData);
pCache[iEntry]->sigprovFileData = NULL;
}
}
if(bFreeEntry) {
free(pCache[iEntry]);
pCache[iEntry] = NULL;
}
finalize_it:
RETiRet;
}
/* This function frees all dynamic file name cache entries and closes the
* relevant files. Part of Shutdown and HUP processing.
* rgerhards, 2008-10-23
*/
static void
dynaFileFreeCacheEntries(instanceData *__restrict__ const pData)
{
register int i;
assert(pData != NULL);
for(i = 0 ; i < pData->iCurrCacheSize ; ++i) {
dynaFileDelCacheEntry(pData, i, 1);
}
/* invalidate current element */
pData->iCurrElt = -1;
pData->pStrm = NULL;
}
/* This function frees the dynamic file name cache.
*/
static void dynaFileFreeCache(instanceData *__restrict__ const pData)
{
assert(pData != NULL);
dynaFileFreeCacheEntries(pData);
if(pData->dynCache != NULL)
free(pData->dynCache);
}
/* close current file */
static rsRetVal
closeFile(instanceData *__restrict__ const pData)
{
DEFiRet;
if(pData->useSigprov) {
pData->sigprov.OnFileClose(pData->sigprovFileData);
pData->sigprovFileData = NULL;
}
strm.Destruct(&pData->pStrm);
RETiRet;
}
/* This prepares the signature provider to process a file */
static rsRetVal
sigprovPrepare(instanceData *__restrict__ const pData, uchar *__restrict__ const fn)
{
DEFiRet;
pData->sigprov.OnFileOpen(pData->sigprovData, fn, &pData->sigprovFileData);
RETiRet;
}
/* This is now shared code for all types of files. It simply prepares
* file access, which, among others, means the the file wil be opened
* and any directories in between will be created (based on config, of
* course). -- rgerhards, 2008-10-22
* changed to iRet interface - 2009-03-19
*/
static rsRetVal
prepareFile(instanceData *__restrict__ const pData, const uchar *__restrict__ const newFileName)
{
int fd;
char errStr[1024]; /* buffer for strerr() */
DEFiRet;
pData->pStrm = NULL;
if(access((char*)newFileName, F_OK) != 0) {
/* file does not exist, create it (and eventually parent directories */
if(pData->bCreateDirs) {
/* We first need to create parent dirs if they are missing.
* We do not report any errors here ourselfs but let the code
* fall through to error handler below.
*/
if(makeFileParentDirs(newFileName, ustrlen(newFileName),
pData->fDirCreateMode, pData->dirUID,
pData->dirGID, pData->bFailOnChown) != 0) {
rs_strerror_r(errno, errStr, sizeof(errStr));
parser_errmsg( "omfile: creating parent "
"directories for file '%s' failed: %s",
newFileName, errStr);
ABORT_FINALIZE(RS_RET_ERR); /* we give up */
}
}
/* no matter if we needed to create directories or not, we now try to create
* the file. -- rgerhards, 2008-12-18 (based on patch from William Tisater)
*/
fd = open((char*) newFileName, O_WRONLY|O_APPEND|O_CREAT|O_NOCTTY|O_CLOEXEC,
pData->fCreateMode);
if(fd != -1) {
/* check and set uid/gid */
if(pData->fileUID != (uid_t)-1 || pData->fileGID != (gid_t) -1) {
/* we need to set owner/group */
if(fchown(fd, pData->fileUID, pData->fileGID) != 0) {
rs_strerror_r(errno, errStr, sizeof(errStr));
parser_errmsg(
"omfile: chown for file '%s' failed: %s",
newFileName, errStr);
if(pData->bFailOnChown) {
close(fd);
ABORT_FINALIZE(RS_RET_ERR); /* we give up */
}
/* we will silently ignore the chown() failure
* if configured to do so.
*/
}
}
close(fd); /* close again, as we need a stream further on */
}
}
/* the copies below are clumpsy, but there is no way around given the
* anomalies in dirname() and basename() [they MODIFY the provided buffer...]
*/
uchar szNameBuf[MAXFNAME+1];
uchar szDirName[MAXFNAME+1];
uchar szBaseName[MAXFNAME+1];
ustrncpy(szNameBuf, newFileName, MAXFNAME);
szNameBuf[MAXFNAME] = '\0';
ustrncpy(szDirName, (uchar*)dirname((char*)szNameBuf), MAXFNAME);
szDirName[MAXFNAME] = '\0';
ustrncpy(szNameBuf, newFileName, MAXFNAME);
szNameBuf[MAXFNAME] = '\0';
ustrncpy(szBaseName, (uchar*)basename((char*)szNameBuf), MAXFNAME);
szBaseName[MAXFNAME] = '\0';
CHKiRet(strm.Construct(&pData->pStrm));
CHKiRet(strm.SetFName(pData->pStrm, szBaseName, ustrlen(szBaseName)));
CHKiRet(strm.SetDir(pData->pStrm, szDirName, ustrlen(szDirName)));
CHKiRet(strm.SetiZipLevel(pData->pStrm, pData->iZipLevel));
CHKiRet(strm.SetbVeryReliableZip(pData->pStrm, pData->bVeryRobustZip));
CHKiRet(strm.SetsIOBufSize(pData->pStrm, (size_t) pData->iIOBufSize));
CHKiRet(strm.SettOperationsMode(pData->pStrm, STREAMMODE_WRITE_APPEND));
CHKiRet(strm.SettOpenMode(pData->pStrm, cs.fCreateMode));
CHKiRet(strm.SetcompressionDriver(pData->pStrm, runModConf->compressionDriver));
CHKiRet(strm.SetCompressionWorkers(pData->pStrm, runModConf->compressionDriver_workers));
CHKiRet(strm.SetbSync(pData->pStrm, pData->bSyncFile));
CHKiRet(strm.SetsType(pData->pStrm, STREAMTYPE_FILE_SINGLE));
CHKiRet(strm.SetiSizeLimit(pData->pStrm, pData->iSizeLimit));
if(pData->useCryprov) {
CHKiRet(strm.Setcryprov(pData->pStrm, &pData->cryprov));
CHKiRet(strm.SetcryprovData(pData->pStrm, pData->cryprovData));
}
/* set the flush interval only if we actually use it - otherwise it will activate
* async processing, which is a real performance waste if we do not do buffered
* writes! -- rgerhards, 2009-07-06
*/
if(pData->bUseAsyncWriter)
CHKiRet(strm.SetiFlushInterval(pData->pStrm, pData->iFlushInterval));
if(pData->pszSizeLimitCmd != NULL)
CHKiRet(strm.SetpszSizeLimitCmd(pData->pStrm, ustrdup(pData->pszSizeLimitCmd)));
CHKiRet(strm.ConstructFinalize(pData->pStrm));
if(pData->useSigprov)
sigprovPrepare(pData, szNameBuf);
finalize_it:
if(iRet != RS_RET_OK) {
if(pData->pStrm != NULL) {
closeFile(pData);
}
}
RETiRet;
}
/* This function handles dynamic file names. It checks if the
* requested file name is already open and, if not, does everything
* needed to switch to the it.
* Function returns 0 if all went well and non-zero otherwise.
* On successful return pData->fd must point to the correct file to
* be written.
* This is a helper to writeFile(). rgerhards, 2007-07-03
*/
static rsRetVal ATTR_NONNULL()
prepareDynFile(instanceData *__restrict__ const pData, const uchar *__restrict__ const newFileName)
{
uint64 ctOldest; /* "timestamp" of oldest element */
int iOldest;
int i;
int iFirstFree;
rsRetVal localRet;
dynaFileCacheEntry **pCache;
DEFiRet;
assert(pData != NULL);
assert(newFileName != NULL);
pCache = pData->dynCache;
/* first check, if we still have the current file */
if( (pData->iCurrElt != -1)
&& !ustrcmp(newFileName, pCache[pData->iCurrElt]->pName)) {
/* great, we are all set */
pCache[pData->iCurrElt]->clkTickAccessed = getClockFileAccess();
STATSCOUNTER_INC(pData->ctrLevel0, pData->mutCtrLevel0);
/* LRU needs only a strictly monotonically increasing counter, so such a one could do */
FINALIZE;
}
/* ok, no luck - current file cannot be re-used */
/* if we need to flush (at least) on TXEnd, we need to flush now - because
* we do not know if we will otherwise come back to this file to flush it
* at end of TX. see https://github.com/rsyslog/rsyslog/issues/2502
*/
if(((runModConf->pConf->globals.glblDevOptions & DEV_OPTION_8_1905_HANG_TEST) == 0) &&
pData->bFlushOnTXEnd && pData->pStrm != NULL) {
CHKiRet(strm.Flush(pData->pStrm));
}
/* Now let's search the table if we find a matching spot.
* While doing so, we also prepare for creation of a new one.
*/
pData->iCurrElt = -1; /* invalid current element pointer */
iFirstFree = -1; /* not yet found */
iOldest = 0; /* we assume the first element to be the oldest - that will change as we loop */
ctOldest = getClockFileAccess(); /* there must always be an older one */
for(i = 0 ; i < pData->iCurrCacheSize ; ++i) {
if(pCache[i] == NULL || pCache[i]->pName == NULL) {
if(iFirstFree == -1)
iFirstFree = i;
} else { /* got an element, let's see if it matches */
if(!ustrcmp(newFileName, pCache[i]->pName)) {
/* we found our element! */
pData->pStrm = pCache[i]->pStrm;
if(pData->useSigprov)
pData->sigprovFileData = pCache[i]->sigprovFileData;
pData->iCurrElt = i;
pCache[i]->clkTickAccessed = getClockFileAccess(); /* update "timestamp" for LRU */
FINALIZE;
}
/* did not find it - so lets keep track of the counters for LRU */
if(pCache[i]->clkTickAccessed < ctOldest) {
ctOldest = pCache[i]->clkTickAccessed;
iOldest = i;
}
}
}
/* we have not found an entry */
STATSCOUNTER_INC(pData->ctrMiss, pData->mutCtrMiss);
/* similarly, we need to set the current pStrm to NULL, because otherwise, if prepareFile() fails,
* we may end up using an old stream. This bug depends on how exactly prepareFile fails,
* but it could be triggered in the common case of a failed open() system call.
* rgerhards, 2010-03-22
*/
pData->pStrm = NULL, pData->sigprovFileData = NULL;
if(iFirstFree == -1 && (pData->iCurrCacheSize < pData->iDynaFileCacheSize)) {
/* there is space left, so set it to that index */
iFirstFree = pData->iCurrCacheSize++;
STATSCOUNTER_SETMAX_NOMUT(pData->ctrMax, (unsigned) pData->iCurrCacheSize);
}
/* Note that the following code sequence does not work with the cache entry itself,
* but rather with pData->pStrm, the (sole) stream pointer in the non-dynafile case.
* The cache array is only updated after the open was successful. -- rgerhards, 2010-03-21
*/
if(iFirstFree == -1) {
dynaFileDelCacheEntry(pData, iOldest, 0);
STATSCOUNTER_INC(pData->ctrEvict, pData->mutCtrEvict);
iFirstFree = iOldest; /* this one *is* now free ;) */
} else {
/* we need to allocate memory for the cache structure */
CHKmalloc(pCache[iFirstFree] = (dynaFileCacheEntry*) calloc(1, sizeof(dynaFileCacheEntry)));
}
/* Ok, we finally can open the file */
localRet = prepareFile(pData, newFileName); /* ignore exact error, we check fd below */
/* check if we had an error */
if(localRet != RS_RET_OK) {
/* We do no longer care about internal messages. The errmsg rate limiter
* will take care of too-frequent error messages.
*/
parser_errmsg("Could not open dynamic file '%s' [state %d] - discarding "
"message", newFileName, localRet);
ABORT_FINALIZE(localRet);
}
if((pCache[iFirstFree]->pName = ustrdup(newFileName)) == NULL) {
closeFile(pData); /* need to free failed entry! */
ABORT_FINALIZE(RS_RET_OUT_OF_MEMORY);
}
pCache[iFirstFree]->pStrm = pData->pStrm;
if(pData->useSigprov)
pCache[iFirstFree]->sigprovFileData = pData->sigprovFileData;
pCache[iFirstFree]->clkTickAccessed = getClockFileAccess();
pData->iCurrElt = iFirstFree;
DBGPRINTF("Added new entry %d for file cache, file '%s'.\n", iFirstFree, newFileName);
finalize_it:
if(iRet == RS_RET_OK)
pCache[pData->iCurrElt]->nInactive = 0;
RETiRet;
}
/* do the actual write process. This function is to be called once we are ready for writing.
* It will do buffered writes and persist data only when the buffer is full. Note that we must
* be careful to detect when the file handle changed.
* rgerhards, 2009-06-03
*/
static rsRetVal
doWrite(instanceData *__restrict__ const pData, uchar *__restrict__ const pszBuf, const int lenBuf)
{
DEFiRet;
assert(pData != NULL);
assert(pszBuf != NULL);
DBGPRINTF("omfile: write to stream, pData->pStrm %p, lenBuf %d, strt data %.128s\n",
pData->pStrm, lenBuf, pszBuf);
if(pData->pStrm != NULL){
CHKiRet(strm.Write(pData->pStrm, pszBuf, lenBuf));
if(pData->useSigprov) {
CHKiRet(pData->sigprov.OnRecordWrite(pData->sigprovFileData, pszBuf, lenBuf));
}
}
finalize_it:
RETiRet;
}
/* rgerhards 2004-11-11: write to a file output. */
static rsRetVal
writeFile(instanceData *__restrict__ const pData,
const actWrkrIParams_t *__restrict__ const pParam,
const int iMsg)
{
DEFiRet;
STATSCOUNTER_INC(pData->ctrRequests, pData->mutCtrRequests);
/* first check if we have a dynamic file name and, if so,
* check if it still is ok or a new file needs to be created
*/
if(pData->bDynamicName) {
DBGPRINTF("omfile: file to log to: %s\n",
actParam(pParam, pData->iNumTpls, iMsg, 1).param);
CHKiRet(prepareDynFile(pData, actParam(pParam, pData->iNumTpls, iMsg, 1).param));
} else { /* "regular", non-dynafile */
if(pData->pStrm == NULL) {
CHKiRet(prepareFile(pData, pData->fname));
if(pData->pStrm == NULL) {
parser_errmsg(
"Could not open output file '%s'", pData->fname);
}
}
pData->nInactive = 0;
}
iRet = doWrite(pData, actParam(pParam, pData->iNumTpls, iMsg, 0).param,
actParam(pParam, pData->iNumTpls, iMsg, 0).lenStr);
finalize_it:
RETiRet;
}
BEGINbeginCnfLoad
CODESTARTbeginCnfLoad
loadModConf = pModConf;
pModConf->pConf = pConf;
pModConf->tplName = NULL;
pModConf->fCreateMode = 0644;
pModConf->fDirCreateMode = 0700;
pModConf->fileUID = -1;
pModConf->dirUID = -1;
pModConf->fileGID = -1;
pModConf->dirGID = -1;
pModConf->bDynafileDoNotSuspend = 1;
ENDbeginCnfLoad
BEGINsetModCnf
struct cnfparamvals *pvals = NULL;
int i;
CODESTARTsetModCnf
pvals = nvlstGetParams(lst, &modpblk, NULL);
if(pvals == NULL) {
parser_errmsg("error processing module "
"config parameters [module(...)]");
ABORT_FINALIZE(RS_RET_MISSING_CNFPARAMS);
}
if(Debug) {
dbgprintf("module (global) param blk for omfile:\n");
cnfparamsPrint(&modpblk, pvals);
}
for(i = 0 ; i < modpblk.nParams ; ++i) {
if(!pvals[i].bUsed) {
continue;
}
if(!strcmp(modpblk.descr[i].name, "template")) {
loadModConf->tplName = (uchar*)es_str2cstr(pvals[i].val.d.estr, NULL);
if(pszFileDfltTplName != NULL) {
parser_errmsg("omfile: warning: default template was already "
"set via legacy directive - may lead to inconsistent "
"results.");
}
} else if(!strcmp(modpblk.descr[i].name, "compression.driver")) {
if(!es_strcasebufcmp(pvals[i].val.d.estr, (const unsigned char*) "zlib", 4)) {
loadModConf->compressionDriver = STRM_COMPRESS_ZIP;
} else if(!es_strcasebufcmp(pvals[i].val.d.estr, (const unsigned char*) "zstd", 4)) {
loadModConf->compressionDriver = STRM_COMPRESS_ZSTD;
} else {
parser_errmsg("omfile: error: invalid compression.driver driver "
"name - noch applying setting. Valid drivers: 'zlib' and "
"'zstd'.");
}
} else if(!strcmp(modpblk.descr[i].name, "compression.zstd.workers")) {
loadModConf->compressionDriver_workers = (int) pvals[i].val.d.n;
} else if(!strcmp(modpblk.descr[i].name, "dircreatemode")) {
loadModConf->fDirCreateMode = (int) pvals[i].val.d.n;
} else if(!strcmp(modpblk.descr[i].name, "filecreatemode")) {
loadModConf->fCreateMode = (int) pvals[i].val.d.n;
} else if(!strcmp(modpblk.descr[i].name, "dirowner")) {
loadModConf->dirUID = (int) pvals[i].val.d.n;
} else if(!strcmp(modpblk.descr[i].name, "dirownernum")) {
loadModConf->dirUID = (int) pvals[i].val.d.n;
} else if(!strcmp(modpblk.descr[i].name, "dirgroup")) {
loadModConf->dirGID = (int) pvals[i].val.d.n;
} else if(!strcmp(modpblk.descr[i].name, "dirgroupnum")) {
loadModConf->dirGID = (int) pvals[i].val.d.n;
} else if(!strcmp(modpblk.descr[i].name, "fileowner")) {
loadModConf->fileUID = (int) pvals[i].val.d.n;
} else if(!strcmp(modpblk.descr[i].name, "fileownernum")) {
loadModConf->fileUID = (int) pvals[i].val.d.n;
} else if(!strcmp(modpblk.descr[i].name, "filegroup")) {
loadModConf->fileGID = (int) pvals[i].val.d.n;
} else if(!strcmp(modpblk.descr[i].name, "filegroupnum")) {
loadModConf->fileGID = (int) pvals[i].val.d.n;
} else if(!strcmp(modpblk.descr[i].name, "dynafile.donotsuspend")) {
loadModConf->bDynafileDoNotSuspend = (int) pvals[i].val.d.n;
} else {
dbgprintf("omfile: program error, non-handled "
"param '%s' in beginCnfLoad\n", modpblk.descr[i].name);
}
}
finalize_it:
if(pvals != NULL)
cnfparamvalsDestruct(pvals, &modpblk);
ENDsetModCnf
/* This function checks dynafile cache for janitor action */
static void
janitorChkDynaFiles(instanceData *__restrict__ const pData)
{
int i;
dynaFileCacheEntry **pCache = pData->dynCache;
for(i = 0 ; i < pData->iCurrCacheSize ; ++i) {
if(pCache[i] == NULL)
continue;
DBGPRINTF("omfile janitor: checking dynafile %d:%s, inactive since %d\n", i,
pCache[i]->pName == NULL ? UCHAR_CONSTANT("[OPEN FAILED]") : pCache[i]->pName,
(int) pCache[i]->nInactive);
if(pCache[i]->nInactive >= pData->iCloseTimeout) {
STATSCOUNTER_INC(pData->ctrCloseTimeouts, pData->mutCtrCloseTimeouts);
dynaFileDelCacheEntry(pData, i, 1);
if(pData->iCurrElt == i)
pData->iCurrElt = -1; /* no longer available! */
} else {
pCache[i]->nInactive += runModConf->pConf->globals.janitorInterval;
}
}
}
/* callback for the janitor. This cleans out files (if so configured) */
static void
janitorCB(void *pUsr)
{
instanceData *__restrict__ const pData = (instanceData *) pUsr;
pthread_mutex_lock(&pData->mutWrite);
if(pData->bDynamicName) {
janitorChkDynaFiles(pData);
} else {
if(pData->pStrm != NULL) {
DBGPRINTF("omfile janitor: checking file %s, inactive since %d\n",
pData->fname, pData->nInactive);
if(pData->nInactive >= pData->iCloseTimeout) {
STATSCOUNTER_INC(pData->ctrCloseTimeouts, pData->mutCtrCloseTimeouts);
closeFile(pData);
} else {
pData->nInactive += runModConf->pConf->globals.janitorInterval;
}
}
}
pthread_mutex_unlock(&pData->mutWrite);
}