2 * Copyright (c) 2005-2008 Poul-Henning Kamp
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * 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(size, 1); \
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 memset(f->obuf, 0, f->obufsize);
243 f->ff->zs->next_out = f->obuf + 5;
244 f->ff->zs->avail_out = f->obufsize - 5;
248 /**********************************************************************
249 * Run the compression engine
250 * Returns -1 if there are trouble writing data
254 fifolog_write_gzip(struct fifolog_writer *f, time_t now)
256 int i, fl, retval = 0;
259 if (f->cleanup || now >= (int)(f->lastsync + f->syncrate)) {
262 f->cnt[FIFOLOG_PT_SYNC]++;
263 } else if (now >= (int)(f->lastwrite + f->writerate)) {
265 f->cnt[FIFOLOG_PT_FLUSH]++;
266 } else if (f->ibufptr == 0)
271 f->ff->zs->avail_in = f->ibufptr;
272 f->ff->zs->next_in = f->ibuf;
275 i = deflate(f->ff->zs, fl);
276 assert(i == Z_OK || i == Z_BUF_ERROR || i == Z_STREAM_END);
278 i = fifolog_write_output(f, fl, now);
284 assert(f->ff->zs->avail_in == 0);
286 if (fl == Z_FINISH) {
287 f->flag |= FIFOLOG_FLG_SYNC;
288 f->ff->zs->next_out = f->obuf + 9;
289 f->ff->zs->avail_out = f->obufsize - 9;
291 assert(Z_OK == deflateReset(f->ff->zs));
296 /**********************************************************************
297 * Poll to see if we need to flush out a record
298 * Returns -1 if there are trouble writing data
302 fifolog_write_poll(struct fifolog_writer *f, time_t now)
307 return (fifolog_write_gzip(f, now));
310 /**********************************************************************
311 * Attempt to write an entry into the ibuf.
312 * Return zero if there is no space, one otherwise
316 fifolog_write_record(struct fifolog_writer *f, uint32_t id, time_t now,
317 const void *ptr, ssize_t len)
319 const unsigned char *p;
323 fifolog_write_assert(f);
324 assert(!(id & (FIFOLOG_TIMESTAMP|FIFOLOG_LENGTH)));
333 id |= FIFOLOG_LENGTH;
337 /* Do a timestamp, if needed */
342 id |= FIFOLOG_TIMESTAMP;
344 /* Emit instance+flag */
348 if (id & FIFOLOG_TIMESTAMP) {
349 be32enc(buf + bufl, (uint32_t)now);
352 if (id & FIFOLOG_LENGTH)
353 buf[bufl++] = (u_char)len;
355 if (bufl + len + f->ibufptr > f->ibufsize)
358 memcpy(f->ibuf + f->ibufptr, buf, bufl);
360 memcpy(f->ibuf + f->ibufptr, p, len);
362 f->cnt[FIFOLOG_PT_BYTES_PRE] += bufl + len;
364 if (id & FIFOLOG_TIMESTAMP)
369 /**********************************************************************
370 * Write an entry, polling the gzip/writer until success.
371 * Long binary entries are broken into 255 byte chunks.
372 * Returns -1 if there are problems writing data
376 fifolog_write_record_poll(struct fifolog_writer *f, uint32_t id, time_t now,
377 const void *ptr, ssize_t len)
380 const unsigned char *p;
385 fifolog_write_assert(f);
387 assert(!(id & (FIFOLOG_TIMESTAMP|FIFOLOG_LENGTH)));
391 if (!fifolog_write_record(f, id, now, ptr, len)) {
392 if (fifolog_write_gzip(f, now) < 0)
394 /* The string could be too long for the ibuf, so... */
395 if (!fifolog_write_record(f, id, now, ptr, len))
399 for (p = ptr; len > 0; len -= l, p += l) {
403 while (!fifolog_write_record(f, id, now, p, l))
404 if (fifolog_write_gzip(f, now) < 0)
408 if (fifolog_write_gzip(f, now) < 0)
410 fifolog_write_assert(f);