2 * SPDX-License-Identifier: BSD-2-Clause
4 * Copyright (c) 2005-2008 Poul-Henning Kamp
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36 #include <sys/endian.h>
41 #include "libfifolog_int.h"
42 #include "fifolog_write.h"
45 static int fifolog_write_gzip(struct fifolog_writer *f, time_t now);
47 #define ALLOC(ptr, size) do { \
48 (*(ptr)) = calloc(1, size); \
49 assert(*(ptr) != NULL); \
53 const char *fifolog_write_statnames[] = {
54 [FIFOLOG_PT_BYTES_PRE] = "Bytes before compression",
55 [FIFOLOG_PT_BYTES_POST] = "Bytes after compression",
56 [FIFOLOG_PT_WRITES] = "Writes",
57 [FIFOLOG_PT_FLUSH] = "Flushes",
58 [FIFOLOG_PT_SYNC] = "Syncs",
59 [FIFOLOG_PT_RUNTIME] = "Runtime"
62 /**********************************************************************
63 * Check that everything is all right
66 fifolog_write_assert(const struct fifolog_writer *f)
69 CHECK_OBJ_NOTNULL(f, FIFOLOG_WRITER_MAGIC);
70 assert(f->ff->zs->next_out + f->ff->zs->avail_out == \
71 f->obuf + f->obufsize);
74 /**********************************************************************
75 * Allocate/Destroy a new fifolog writer instance
78 struct fifolog_writer *
79 fifolog_write_new(void)
81 struct fifolog_writer *f;
83 ALLOC_OBJ(f, FIFOLOG_WRITER_MAGIC);
89 fifolog_write_destroy(struct fifolog_writer *f)
97 /**********************************************************************
98 * Open/Close the fifolog
102 fifolog_write_close(struct fifolog_writer *f)
106 CHECK_OBJ_NOTNULL(f, FIFOLOG_WRITER_MAGIC);
107 fifolog_write_assert(f);
111 fifolog_write_gzip(f, now);
112 fifolog_write_assert(f);
113 fifolog_int_close(&f->ff);
118 fifolog_write_open(struct fifolog_writer *f, const char *fn,
119 unsigned writerate, unsigned syncrate, unsigned compression)
126 CHECK_OBJ_NOTNULL(f, FIFOLOG_WRITER_MAGIC);
128 /* Check for legal compression value */
129 if (compression > Z_BEST_COMPRESSION)
130 return ("Illegal compression value");
132 f->writerate = writerate;
133 f->syncrate = syncrate;
134 f->compression = compression;
136 /* Reset statistics */
137 memset(f->cnt, 0, sizeof f->cnt);
139 es = fifolog_int_open(&f->ff, fn, 1);
142 es = fifolog_int_findend(f->ff, &o);
145 i = fifolog_int_read(f->ff, o);
147 return ("Read error, looking for seq");
148 f->seq = be32dec(f->ff->recbuf);
157 f->obufsize = f->ff->recsize;
158 ALLOC(&f->obuf, f->obufsize);
160 f->ibufsize = f->obufsize * 10;
161 ALLOC(&f->ibuf, f->ibufsize);
164 i = deflateInit(f->ff->zs, (int)f->compression);
167 f->flag |= FIFOLOG_FLG_RESTART;
168 f->flag |= FIFOLOG_FLG_SYNC;
169 f->ff->zs->next_out = f->obuf + 9;
170 f->ff->zs->avail_out = f->obufsize - 9;
177 fifolog_write_assert(f);
181 /**********************************************************************
182 * Write an output record
183 * Returns -1 if there are trouble writing data
187 fifolog_write_output(struct fifolog_writer *f, int fl, time_t now)
189 long h, l = f->ff->zs->next_out - f->obuf;
194 be32enc(f->obuf, f->seq);
195 f->obuf[h] = f->flag;
197 if (f->flag & FIFOLOG_FLG_SYNC) {
198 be32enc(f->obuf + h, now);
199 h += 4; /* timestamp */
202 assert(l <= (long)f->ff->recsize); /* NB: l includes h */
205 /* We will never write an entirely empty buffer */
209 if (l < (long)f->ff->recsize && fl == Z_NO_FLUSH)
212 w = f->ff->recsize - l;
214 be32enc(f->obuf + f->ff->recsize - 4, w);
215 f->obuf[4] |= FIFOLOG_FLG_4BYTE;
217 f->obuf[f->ff->recsize - 1] = (uint8_t)w;
218 f->obuf[4] |= FIFOLOG_FLG_1BYTE;
221 f->cnt[FIFOLOG_PT_BYTES_POST] += l - h;
223 i = pwrite(f->ff->fd, f->obuf, f->ff->recsize,
224 (f->recno + 1) * f->ff->recsize);
225 if (i != f->ff->recsize)
230 f->cnt[FIFOLOG_PT_WRITES]++;
231 f->cnt[FIFOLOG_PT_RUNTIME] = now - f->starttime;
235 * We increment these even on error, so as to properly skip bad,
236 * sectors or other light trouble.
242 * Ensure we wrap recno once we hit the file size (in records.)
244 if (f->recno >= f->ff->logsize)
245 /* recno 0 is header; skip */
250 memset(f->obuf, 0, f->obufsize);
251 f->ff->zs->next_out = f->obuf + 5;
252 f->ff->zs->avail_out = f->obufsize - 5;
256 /**********************************************************************
257 * Run the compression engine
258 * Returns -1 if there are trouble writing data
262 fifolog_write_gzip(struct fifolog_writer *f, time_t now)
264 int i, fl, retval = 0;
267 if (f->cleanup || now >= (int)(f->lastsync + f->syncrate)) {
270 f->cnt[FIFOLOG_PT_SYNC]++;
271 } else if (now >= (int)(f->lastwrite + f->writerate)) {
273 f->cnt[FIFOLOG_PT_FLUSH]++;
274 } else if (f->ibufptr == 0)
279 f->ff->zs->avail_in = f->ibufptr;
280 f->ff->zs->next_in = f->ibuf;
283 i = deflate(f->ff->zs, fl);
284 assert(i == Z_OK || i == Z_BUF_ERROR || i == Z_STREAM_END);
286 i = fifolog_write_output(f, fl, now);
292 assert(f->ff->zs->avail_in == 0);
294 if (fl == Z_FINISH) {
295 f->flag |= FIFOLOG_FLG_SYNC;
296 f->ff->zs->next_out = f->obuf + 9;
297 f->ff->zs->avail_out = f->obufsize - 9;
299 assert(Z_OK == deflateReset(f->ff->zs));
304 /**********************************************************************
305 * Poll to see if we need to flush out a record
306 * Returns -1 if there are trouble writing data
310 fifolog_write_poll(struct fifolog_writer *f, time_t now)
315 return (fifolog_write_gzip(f, now));
318 /**********************************************************************
319 * Attempt to write an entry into the ibuf.
320 * Return zero if there is no space, one otherwise
324 fifolog_write_record(struct fifolog_writer *f, uint32_t id, time_t now,
325 const void *ptr, ssize_t len)
327 const unsigned char *p;
331 fifolog_write_assert(f);
332 assert(!(id & (FIFOLOG_TIMESTAMP|FIFOLOG_LENGTH)));
341 id |= FIFOLOG_LENGTH;
345 /* Do a timestamp, if needed */
350 id |= FIFOLOG_TIMESTAMP;
352 /* Emit instance+flag */
356 if (id & FIFOLOG_TIMESTAMP) {
357 be32enc(buf + bufl, (uint32_t)now);
360 if (id & FIFOLOG_LENGTH)
361 buf[bufl++] = (u_char)len;
363 if (bufl + len + f->ibufptr > f->ibufsize)
366 memcpy(f->ibuf + f->ibufptr, buf, bufl);
368 memcpy(f->ibuf + f->ibufptr, p, len);
370 f->cnt[FIFOLOG_PT_BYTES_PRE] += bufl + len;
372 if (id & FIFOLOG_TIMESTAMP)
377 /**********************************************************************
378 * Write an entry, polling the gzip/writer until success.
379 * Long binary entries are broken into 255 byte chunks.
380 * Returns -1 if there are problems writing data
384 fifolog_write_record_poll(struct fifolog_writer *f, uint32_t id, time_t now,
385 const void *ptr, ssize_t len)
388 const unsigned char *p;
393 fifolog_write_assert(f);
395 assert(!(id & (FIFOLOG_TIMESTAMP|FIFOLOG_LENGTH)));
399 if (!fifolog_write_record(f, id, now, ptr, len)) {
400 if (fifolog_write_gzip(f, now) < 0)
402 /* The string could be too long for the ibuf, so... */
403 if (!fifolog_write_record(f, id, now, ptr, len))
407 for (p = ptr; len > 0; len -= l, p += l) {
411 while (!fifolog_write_record(f, id, now, p, l))
412 if (fifolog_write_gzip(f, now) < 0)
416 if (fifolog_write_gzip(f, now) < 0)
418 fifolog_write_assert(f);