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
|
/* The zlibwrap object.
*
* This is an rsyslog object wrapper around zlib.
*
* Copyright 2009-2022 Rainer Gerhards and Adiscon GmbH.
*
* This file is part of the rsyslog runtime library.
*
* 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 <string.h>
#include <assert.h>
#include <zlib.h>
#include "rsyslog.h"
#include "module-template.h"
#include "obj.h"
#include "stream.h"
#include "zlibw.h"
MODULE_TYPE_LIB
MODULE_TYPE_NOKEEP
/* static data */
DEFobjStaticHelpers
/* ------------------------------ methods ------------------------------ */
/* zlib make strong use of macros for its interface functions, so we can not simply
* pass function pointers to them. Instead, we create very small wrappers which call
* the relevant entry points.
*/
static int myDeflateInit(z_streamp strm, int level)
{
return deflateInit(strm, level);
}
static int myDeflateInit2(z_streamp strm, int level, int method, int windowBits, int memLevel, int strategy)
{
return deflateInit2(strm, level, method, windowBits, memLevel, strategy);
}
static int myDeflateEnd(z_streamp strm)
{
return deflateEnd(strm);
}
static int myDeflate(z_streamp strm, int flush)
{
return deflate(strm, flush);
}
/* finish zlib buffer */
static rsRetVal
doCompressFinish(strm_t *pThis,
rsRetVal (*strmPhysWrite)(strm_t *pThis, uchar *pBuf, size_t lenBuf) )
{
int zRet; /* zlib return state */
DEFiRet;
unsigned outavail;
assert(pThis != NULL);
assert(pThis->compressionDriver == STRM_COMPRESS_ZIP);
if(!pThis->bzInitDone)
goto done;
pThis->zstrm.avail_in = 0;
/* run deflate() on buffer until everything has been compressed */
do {
DBGPRINTF("in deflate() loop, avail_in %d, total_in %ld\n", pThis->zstrm.avail_in,
pThis->zstrm.total_in);
pThis->zstrm.avail_out = pThis->sIOBufSize;
pThis->zstrm.next_out = pThis->pZipBuf;
zRet = deflate(&pThis->zstrm, Z_FINISH); /* no bad return value */
DBGPRINTF("after deflate, ret %d, avail_out %d\n", zRet, pThis->zstrm.avail_out);
outavail = pThis->sIOBufSize - pThis->zstrm.avail_out;
if(outavail != 0) {
CHKiRet(strmPhysWrite(pThis, (uchar*)pThis->pZipBuf, outavail));
}
} while (pThis->zstrm.avail_out == 0);
finalize_it:
zRet = deflateEnd(&pThis->zstrm);
if(zRet != Z_OK) {
LogError(0, RS_RET_ZLIB_ERR, "error %d returned from zlib/deflateEnd()", zRet);
}
pThis->bzInitDone = 0;
done: RETiRet;
}
/* write the output buffer in zip mode
* This means we compress it first and then do a physical write.
* Note that we always do a full deflateInit ... deflate ... deflateEnd
* sequence. While this is not optimal, we need to do it because we need
* to ensure that the file is readable even when we are aborted. Doing the
* full sequence brings us as far towards this goal as possible (and not
* doing it would be a total failure). It may be worth considering to
* add a config switch so that the user can decide the risk he is ready
* to take, but so far this is not yet implemented (not even requested ;)).
* rgerhards, 2009-06-04
*/
static rsRetVal
doStrmWrite(strm_t *pThis, uchar *pBuf, size_t lenBuf, const int bFlush,
rsRetVal (*strmPhysWrite)(strm_t *pThis, uchar *pBuf, size_t lenBuf) )
{
int zRet; /* zlib return state */
DEFiRet;
unsigned outavail = 0;
assert(pThis != NULL);
assert(pBuf != NULL);
assert(pThis->compressionDriver == STRM_COMPRESS_ZIP);
if(!pThis->bzInitDone) {
/* allocate deflate state */
pThis->zstrm.zalloc = Z_NULL;
pThis->zstrm.zfree = Z_NULL;
pThis->zstrm.opaque = Z_NULL;
/* see note in file header for the params we use with deflateInit2() */
zRet = deflateInit2(&pThis->zstrm, pThis->iZipLevel, Z_DEFLATED, 31, 9, Z_DEFAULT_STRATEGY);
if(zRet != Z_OK) {
LogError(0, RS_RET_ZLIB_ERR, "error %d returned from zlib/deflateInit2()", zRet);
ABORT_FINALIZE(RS_RET_ZLIB_ERR);
}
pThis->bzInitDone = RSTRUE;
}
/* now doing the compression */
pThis->zstrm.next_in = (Bytef*) pBuf;
pThis->zstrm.avail_in = lenBuf;
/* run deflate() on buffer until everything has been compressed */
do {
DBGPRINTF("in deflate() loop, avail_in %d, total_in %ld, bFlush %d\n",
pThis->zstrm.avail_in, pThis->zstrm.total_in, bFlush);
pThis->zstrm.avail_out = pThis->sIOBufSize;
pThis->zstrm.next_out = pThis->pZipBuf;
zRet = deflate(&pThis->zstrm, bFlush ? Z_SYNC_FLUSH : Z_NO_FLUSH); /* no bad return value */
DBGPRINTF("after deflate, ret %d, avail_out %d, to write %d\n",
zRet, pThis->zstrm.avail_out, outavail);
if(zRet != Z_OK) {
LogError(0, RS_RET_ZLIB_ERR, "error %d returned from zlib/Deflate()", zRet);
ABORT_FINALIZE(RS_RET_ZLIB_ERR);
}
outavail = pThis->sIOBufSize - pThis->zstrm.avail_out;
if(outavail != 0) {
CHKiRet(strmPhysWrite(pThis, (uchar*)pThis->pZipBuf, outavail));
}
} while (pThis->zstrm.avail_out == 0);
finalize_it:
if(pThis->bzInitDone && pThis->bVeryReliableZip) {
doCompressFinish(pThis, strmPhysWrite);
}
RETiRet;
}
/* destruction of caller's zlib ressources - a dummy for us */
static rsRetVal
zlib_Destruct(ATTR_UNUSED strm_t *pThis)
{
return RS_RET_OK;
}
/* queryInterface function
* rgerhards, 2008-03-05
*/
BEGINobjQueryInterface(zlibw)
CODESTARTobjQueryInterface(zlibw)
if(pIf->ifVersion != zlibwCURR_IF_VERSION) { /* check for current version, increment on each change */
ABORT_FINALIZE(RS_RET_INTERFACE_NOT_SUPPORTED);
}
/* ok, we have the right interface, so let's fill it
* Please note that we may also do some backwards-compatibility
* work here (if we can support an older interface version - that,
* of course, also affects the "if" above).
*/
pIf->DeflateInit = myDeflateInit;
pIf->DeflateInit2 = myDeflateInit2;
pIf->Deflate = myDeflate;
pIf->DeflateEnd = myDeflateEnd;
pIf->doStrmWrite = doStrmWrite;
pIf->doCompressFinish = doCompressFinish;
pIf->Destruct = zlib_Destruct;
finalize_it:
ENDobjQueryInterface(zlibw)
/* Initialize the zlibw class. Must be called as the very first method
* before anything else is called inside this class.
* rgerhards, 2008-02-19
*/
BEGINAbstractObjClassInit(zlibw, 1, OBJ_IS_LOADABLE_MODULE) /* class, version */
/* request objects we use */
/* set our own handlers */
ENDObjClassInit(zlibw)
/* --------------- here now comes the plumbing that makes as a library module --------------- */
BEGINmodExit
CODESTARTmodExit
ENDmodExit
BEGINqueryEtryPt
CODESTARTqueryEtryPt
CODEqueryEtryPt_STD_LIB_QUERIES
ENDqueryEtryPt
BEGINmodInit()
CODESTARTmodInit
*ipIFVersProvided = CURR_MOD_IF_VERSION; /* we only support the current interface specification */
CHKiRet(zlibwClassInit(pModInfo)); /* must be done after tcps_sess, as we use it */
/* Initialize all classes that are in our module - this includes ourselfs */
ENDmodInit
/* vi:set ai:
*/
|
