source: libwandio/iow-lzo.c @ 60f3c4c

4.0.1-hotfixescachetimestampsdevelopdpdk-ndagetsilivegetfragoffhelplibtrace4ndag_formatpfringrc-4.0.1rc-4.0.2rc-4.0.3rc-4.0.4ringdecrementfixringperformanceringtimestampfixes
Last change on this file since 60f3c4c was 60f3c4c, checked in by Shane Alcock <salcock@…>, 10 years ago
  • Shifted wandio into a separate library, seeing as we're going to be exporting the API now
  • Property mode set to 100644
File size: 14.3 KB
Line 
1/*
2 * This file is part of libtrace
3 *
4 * Copyright (c) 2007,2008,2009,2010 The University of Waikato, Hamilton,
5 * New Zealand.
6 *
7 * Authors: Perry Lorier
8 *          Shane Alcock
9 *         
10 * All rights reserved.
11 *
12 * This code has been developed by the University of Waikato WAND
13 * research group. For further information please see http://www.wand.net.nz/
14 *
15 * libtrace is free software; you can redistribute it and/or modify
16 * it under the terms of the GNU General Public License as published by
17 * the Free Software Foundation; either version 2 of the License, or
18 * (at your option) any later version.
19 *
20 * libtrace is distributed in the hope that it will be useful,
21 * but WITHOUT ANY WARRANTY; without even the implied warranty of
22 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
23 * GNU General Public License for more details.
24 *
25 * You should have received a copy of the GNU General Public License
26 * along with libtrace; if not, write to the Free Software
27 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
28 *
29 * $Id: iow-lzo.c 1521 2010-02-08 22:21:16Z salcock $
30 *
31 */
32
33/* This writes out lzo files in the same format as lzop does.  It's not as
34 * flexible as lzop in an attempt to try and create a very fast method for
35 * writing data out.
36 *
37 * Data is written out in blocks, and the blocks are all compressed in seperate
38 * independant threads (if possible), thus letting you use multicore cpu's to
39 * get compression for the absolute least amount of walltime while capturing.
40 */
41
42#include <lzo/lzo1x.h>
43#include "wandio.h"
44#include "config.h"
45#include <sys/types.h>
46#include <sys/stat.h>
47#include <fcntl.h>
48#include <stdlib.h>
49#include <string.h>
50#include <time.h> /* for mtime */
51#include <errno.h>
52#include <assert.h>
53#include <inttypes.h>
54#include <arpa/inet.h>
55#include <pthread.h>
56#include <unistd.h> /* for sysconf */
57#include <stdbool.h>
58#ifdef HAVE_SYS_PRCTL_H
59#include <sys/prctl.h>
60#endif
61
62#include "libtrace.h"
63
64enum { 
65        M_LZO1X_1     =     1,
66        M_LZO1X_1_15  =     2,
67        M_LZO1X_999   =     3,
68        M_NRV1A       =  0x1a,
69        M_NRV1B       =  0x1b,
70        M_NRV2A       =  0x2a,
71        M_NRV2B       =  0x2b,
72        M_NRV2D       =  0x2d,
73        M_ZLIB        =   128,
74};
75
76static const int F_OS_UNIX   = 0x03000000L;
77static const int F_OS_MASK   = 0xff000000L;
78
79static const int F_CS_NATIVE = 0x00000000L;
80static const int F_CS_MASK   = 0x00f00000L;
81
82static const int F_H_CRC32   = 0x00001000L;
83static const int F_ADLER32_D = 0x00000001L;
84static const int F_ADLER32_C = 0x00000002L;
85
86/* popquiz! You throught "static const int" would be well constant didn't you?
87 * You'd be wrong, you can't use them in places where the compiler needs a
88 * constant, so you need to use an enum, since enums /are/ constant the compiler
89 * will let you use them as such.  Sigh.
90 */
91enum { MAX_BLOCK_SIZE = 128*1024 }; /* lzop can only decompress blocks
92                                        this large */
93
94/* According to lzop lzo can increase the data to this size, so save this
95 * much space in our buffers
96 */
97enum { MAX_BUFFER_SIZE = MAX_BLOCK_SIZE+MAX_BLOCK_SIZE/16+64+3 };
98
99static const unsigned char lzop_magic[9] =
100    { 0x89, 0x4c, 0x5a, 0x4f, 0x00, 0x0d, 0x0a, 0x1a, 0x0a };
101
102
103/* Libtrace IO module implementing a lzo writer */
104
105enum err_t {
106        ERR_OK  = 1,
107        ERR_EOF = 0,
108        ERR_ERROR = -1
109};
110
111const int ADLER32_INIT_VALUE = 1;
112const int CRC32_INIT_VALUE = 0;
113
114struct buffer_t {
115        unsigned int offset;
116        char buffer[MAX_BUFFER_SIZE];
117};
118
119struct lzothread_t {
120        pthread_t thread;
121        pthread_cond_t in_ready;
122        pthread_cond_t out_ready;
123        pthread_mutex_t mutex;
124        bool closing;
125        enum { EMPTY, WAITING, FULL } state;
126        int num;
127        struct buffer_t inbuf;
128        struct buffer_t outbuf;
129};
130
131struct lzow_t {
132        iow_t *child;
133        enum err_t err;
134        int threads;
135        int next_thread;
136        struct lzothread_t *thread;
137};
138
139extern iow_source_t lzo_wsource; 
140
141#define DATA(iow) ((struct lzow_t *)((iow)->data))
142#define min(a,b) ((a)<(b) ? (a) : (b))
143
144static void write_buf(struct buffer_t *buffer,const void *data, size_t len)
145{
146        assert(buffer->offset + len < sizeof(buffer->buffer) && "Exceeded output buffer size in lzo compressor");
147        memcpy(&buffer->buffer[buffer->offset], data, len);
148        buffer->offset += len;
149}
150
151static void write32(struct buffer_t *buffer, uint32_t value)
152{
153        value = htonl(value);
154        write_buf(buffer, &value, sizeof(value));
155}
156
157static void write16(struct buffer_t *buffer, uint16_t value)
158{
159        value = htons(value);
160        write_buf(buffer, &value, sizeof(value));
161}
162
163static void write8(struct buffer_t *buffer, uint8_t value)
164{
165        write_buf(buffer, &value, sizeof(value));
166}
167
168static int lzo_wwrite_block(const char *buffer, off_t len, struct buffer_t *outbuf)
169{
170        char b2[MAX_BUFFER_SIZE];
171        int err;
172        lzo_uint dst_len;
173        char scratch[LZO1X_1_MEM_COMPRESS];
174
175        outbuf->offset=0;
176
177        memset(scratch,0,sizeof(scratch));
178        err=lzo1x_1_compress((void*)buffer, len, 
179                        (void*)b2, &dst_len, 
180                        scratch);
181
182        switch(err) {
183                case LZO_E_OK:
184                        break;
185                case LZO_E_ERROR:
186                        return -EINVAL; /* WTF? */
187                case LZO_E_OUT_OF_MEMORY:
188                        return -ENOMEM; /* Uh oh */
189                case LZO_E_NOT_COMPRESSIBLE:
190                        return -EINVAL; /* Claimed not to be used, dunno what we'll do */
191                case LZO_E_INPUT_OVERRUN:
192                        return -EINVAL;  /* Can't happen on compress? */
193                case LZO_E_OUTPUT_OVERRUN:
194                        return -ENOMEM;
195                case LZO_E_LOOKBEHIND_OVERRUN:
196                        return -EINVAL;
197                case LZO_E_EOF_NOT_FOUND:
198                        return -ENOENT; /* Can't happen on compress? */
199                case LZO_E_INPUT_NOT_CONSUMED:
200                        return -EINVAL;
201                case LZO_E_NOT_YET_IMPLEMENTED:
202                        return -ENOSYS;
203                default:
204                        fprintf(stderr,"Unknown lzo error %d\n",err);
205                        return -EINVAL;
206        }
207
208        write32(outbuf, len); /* Original length */
209        write32(outbuf, min((uint32_t)len,(uint32_t)dst_len));
210        /* CRC32 of the uncompressed buffer */
211#if 0
212        write32(outbuf, lzo_crc32(CRC32_INIT_VALUE, (void*)buffer, len));
213#endif
214        write32(outbuf, 
215                lzo_adler32(ADLER32_INIT_VALUE, (const void*)buffer, len));
216        write_buf(outbuf, b2, dst_len);
217
218        /* Return the number of bytes compressed */
219        return len;
220}
221
222/* There is one of these threads per core in a machine.  This compresses
223 * a block of data and returns it, the main thread tehn is responsible to
224 * write these back out in the right order.
225 */
226static void *lzo_compress_thread(void *data)
227{
228        struct lzothread_t *me = (struct lzothread_t *)data;
229        int err;
230        char namebuf[17];
231
232#ifdef PR_SET_NAME
233        if (prctl(PR_GET_NAME, namebuf, 0,0,0) == 0) {
234                char label[16];
235                namebuf[16] = '\0'; /* Make sure it's NUL terminated */
236                sprintf(label,"[lzo%d]",me->num);
237                /* If the filename is too long, overwrite the last few bytes */
238                if (strlen(namebuf)>=16-strlen(label)) {
239                        strcpy(namebuf+15-strlen(label),label);
240                }
241                else {
242                        strncat(namebuf," ",16);
243                        strncat(namebuf,label,16);
244                }
245                prctl(PR_SET_NAME, namebuf, 0,0,0);
246        }
247#endif
248
249        pthread_mutex_lock(&me->mutex);
250        while (!me->closing) {
251                while (me->state != WAITING) {
252                        if (me->closing)
253                                break;
254                        pthread_cond_wait(&me->in_ready, &me->mutex);
255                }
256                if (me->closing)
257                        break;
258
259                err=lzo_wwrite_block(
260                        me->inbuf.buffer, 
261                        me->inbuf.offset,
262                        &me->outbuf);
263
264                /* Make sure someone else hasn't clobbered us!*/
265                assert(me->state == WAITING);
266                me->state = FULL;
267                pthread_cond_signal(&me->out_ready);
268        }
269        pthread_mutex_unlock(&me->mutex);
270
271        return NULL;
272}
273
274iow_t *lzo_wopen(iow_t *child, int compress_level UNUSED)
275{
276        const int opt_filter = 0;
277        int flags;
278        iow_t *iow;
279        struct buffer_t buffer;
280        buffer.offset=0;
281        int i;
282
283        if (!child)
284                return NULL;
285
286        if (lzo_init() != LZO_E_OK) {
287                /* Fail */
288                return NULL;
289        }
290
291        iow = malloc(sizeof(iow_t));
292        iow->source = &lzo_wsource;
293        iow->data = malloc(sizeof(struct lzow_t));
294
295        DATA(iow)->child = child;
296        DATA(iow)->err = ERR_OK;
297
298        flags = 0;
299        flags |= F_OS_UNIX & F_OS_MASK; /* Operating System */
300        flags |= F_CS_NATIVE & F_CS_MASK;       /* Character Set */
301        flags |= F_ADLER32_D; /* We adler32 the uncompressed data */
302        /* flags |= F_STDIN; */
303        /* flags |= F_STDOUT */
304        /* flags |= F_MULTIPART; */
305        /* flags |= F_H_CRC32; */
306
307        write_buf(&buffer, lzop_magic, sizeof(lzop_magic));
308        write16(&buffer, 0x1010 &0xFFFF); /* version: pretend to be LZOP version 0x1010 from lzop's version.h */
309        write16(&buffer, lzo_version() & 0xFFFF); /* libversion */
310        write16(&buffer, opt_filter ? 0x0950 : 0x0940); /* version needed to extract */
311        write8(&buffer, M_LZO1X_1);     /* method */
312        write8(&buffer, 5); /* level */
313        write32(&buffer, flags); /* flags */
314        /* if (flags & F_H_FILTER)
315                write32(iow, opt_filter);
316        */ 
317        write32(&buffer, 0x600); /* mode: We assume traces may be sensitive */
318        write32(&buffer, time(NULL)); /* mtime */
319        write32(&buffer, 0); /* GMTdiff */
320
321        /* Length, filename */
322        write8(&buffer, strlen("compresseddata"));
323        write_buf(&buffer, "compresseddata",strlen("compresseddata"));
324
325        if (flags & F_H_CRC32) {
326                write32(&buffer, 
327                        lzo_crc32(CRC32_INIT_VALUE, 
328                                (const void*)buffer.buffer+sizeof(lzop_magic), 
329                                buffer.offset-sizeof(lzop_magic)));
330        }
331        else {
332                uint32_t chksum=lzo_adler32(
333                        ADLER32_INIT_VALUE, 
334                        (const void *)buffer.buffer+sizeof(lzop_magic), 
335                        buffer.offset-sizeof(lzop_magic));
336                write32(&buffer, chksum);
337        }
338
339        wandio_wwrite(DATA(iow)->child,
340                buffer.buffer,
341                buffer.offset);
342
343        /* Set up the thread pool -- one thread per core */
344        DATA(iow)->threads = min((uint32_t)sysconf(_SC_NPROCESSORS_ONLN),
345                        use_threads);
346        DATA(iow)->thread = malloc(
347                        sizeof(struct lzothread_t) * DATA(iow)->threads);
348        DATA(iow)->next_thread = 0;
349        for(i=0; i<DATA(iow)->threads; ++i) {
350                pthread_cond_init(&DATA(iow)->thread[i].in_ready, NULL);
351                pthread_cond_init(&DATA(iow)->thread[i].out_ready, NULL);
352                pthread_mutex_init(&DATA(iow)->thread[i].mutex, NULL);
353                DATA(iow)->thread[i].closing = false;
354                DATA(iow)->thread[i].num = i;
355                DATA(iow)->thread[i].state = EMPTY;
356                DATA(iow)->thread[i].inbuf.offset = 0;
357
358                pthread_create(&DATA(iow)->thread[i].thread, 
359                                NULL,
360                                lzo_compress_thread,
361                                (void*)&DATA(iow)->thread[i]);
362        }
363
364        return iow;
365}
366
367static struct lzothread_t *get_next_thread(iow_t *iow)
368{
369        return &DATA(iow)->thread[DATA(iow)->next_thread];
370}
371
372static off_t lzo_wwrite(iow_t *iow, const char *buffer, off_t len)
373{
374        off_t ret = 0;
375        while (len>0) {
376                off_t size = len;
377                off_t err;
378                struct buffer_t outbuf;
379
380                if (!DATA(iow)->threads) {
381                        size = min(len, MAX_BLOCK_SIZE);
382                        err=lzo_wwrite_block(buffer, size, &outbuf);
383                        /* Flush the data out */
384                        wandio_wwrite(DATA(iow)->child,
385                                        outbuf.buffer,
386                                        outbuf.offset);
387
388                        if (err < 0) {/* Error */
389                                if (ret == 0)
390                                        return err;
391                                /* If we've written some data, return that fact now, let them call back
392                                 * and try and write more data, fail again then.
393                                 */
394                                return ret;
395                        }
396                        else {
397                                assert(err == size);
398                                buffer += size;
399                                len -= size;
400                        }
401                }
402                else {
403                        off_t space;
404
405                        pthread_mutex_lock(&get_next_thread(iow)->mutex);
406                        /* If this thread is still compressing, wait for it to finish */
407                        while (get_next_thread(iow)->state == WAITING) {
408                                pthread_cond_wait(
409                                        &get_next_thread(iow)->out_ready, 
410                                        &get_next_thread(iow)->mutex);
411                        }
412
413                        /* Flush any data out thats there */
414                        if (get_next_thread(iow)->state == FULL) {
415                                assert(get_next_thread(iow)->outbuf.offset
416                                                < sizeof(get_next_thread(iow)->outbuf.buffer));
417                                wandio_wwrite(DATA(iow)->child,
418                                                get_next_thread(iow)->outbuf.buffer,
419                                                get_next_thread(iow)->outbuf.offset);
420                                get_next_thread(iow)->state = EMPTY;
421                                get_next_thread(iow)->inbuf.offset = 0;
422                        }
423
424                        assert(get_next_thread(iow)->state == EMPTY);
425
426                        /* Figure out how much space we can copy into this buffer */
427                        assert(MAX_BLOCK_SIZE <= sizeof(get_next_thread(iow)->inbuf.buffer));
428                        space = MAX_BLOCK_SIZE-get_next_thread(iow)->inbuf.offset;
429                        size = min(space, size);
430                        assert(size>0);
431                        assert(size <= MAX_BLOCK_SIZE);
432                        assert(get_next_thread(iow)->inbuf.offset + size <= MAX_BLOCK_SIZE);
433
434                        /* Move our data in */
435                        memcpy(&get_next_thread(iow)->inbuf.buffer[get_next_thread(iow)->inbuf.offset], 
436                                buffer, 
437                                size);
438                        get_next_thread(iow)->inbuf.offset += size;
439
440                        /* If the buffer is now full Trigger the thread to start compressing this block,
441                         * and move onto the next block.
442                         */
443                        if (get_next_thread(iow)->inbuf.offset >= sizeof(get_next_thread(iow)->inbuf.buffer)
444                          ||get_next_thread(iow)->inbuf.offset >= MAX_BLOCK_SIZE) {
445                                assert(get_next_thread(iow)->state == EMPTY);
446                                get_next_thread(iow)->state = WAITING;
447                                pthread_cond_signal(&get_next_thread(iow)->in_ready);
448
449                                pthread_mutex_unlock(&get_next_thread(iow)->mutex);
450
451                                DATA(iow)->next_thread = 
452                                                (DATA(iow)->next_thread+1) % DATA(iow)->threads;
453                        }
454                        else 
455                                pthread_mutex_unlock(&get_next_thread(iow)->mutex);
456
457                        /* Update the lengths */
458                        buffer += size;
459                        len -= size;
460                }
461        }
462        return len;
463}
464
465static void shutdown_thread(iow_t *iow, struct lzothread_t *thread)
466{
467        pthread_mutex_lock(&thread->mutex);
468
469        /* If this buffer is empty it shouldn't have any data in it, we should have taken
470         * care of that before.
471         */
472        /* thread->state == EMPTY implies thread->inbuf.offset == 0 */
473        assert(!(thread->state == EMPTY) || thread->inbuf.offset == 0);
474
475        while (thread->state == WAITING) {
476                pthread_cond_wait(
477                        &thread->out_ready,
478                        &thread->mutex);
479        }
480        if (thread->state == FULL) {
481                wandio_wwrite(DATA(iow)->child,
482                                thread->outbuf.buffer,
483                                thread->outbuf.offset);
484                thread->state = EMPTY;
485                thread->inbuf.offset = 0;
486        }
487        /* Now the thread should be empty, so ask it to shut down */
488        assert(thread->state == EMPTY && thread->inbuf.offset == 0);
489        thread->closing = true;
490        pthread_cond_signal(&thread->in_ready);
491        pthread_mutex_unlock(&thread->mutex);
492        /* And wait for it to die */
493        pthread_join(thread->thread,NULL);
494}
495
496static void lzo_wclose(iow_t *iow)
497{
498        const uint32_t zero = 0;
499        int i;
500
501        /* Flush the last buffer */
502        pthread_mutex_lock(&get_next_thread(iow)->mutex);
503        if (get_next_thread(iow)->state == EMPTY && get_next_thread(iow)->inbuf.offset != 0) {
504                get_next_thread(iow)->state = WAITING;
505                pthread_cond_signal(&get_next_thread(iow)->in_ready);
506        }
507        pthread_mutex_unlock(&get_next_thread(iow)->mutex);
508
509        DATA(iow)->next_thread = 
510                        (DATA(iow)->next_thread+1) % DATA(iow)->threads;
511
512        /* Right, now we have to shutdown all our threads -- in order */
513        for(i=DATA(iow)->next_thread; i<DATA(iow)->threads; ++i) {
514                shutdown_thread(iow,&DATA(iow)->thread[i]);
515        }
516        for(i=0; i<DATA(iow)->next_thread; ++i) {
517                shutdown_thread(iow,&DATA(iow)->thread[i]);
518        }
519
520        /* Write out an end of file marker */
521        wandio_wwrite(DATA(iow)->child,
522                &zero,
523                sizeof(zero));
524
525        /* And clean everything up */
526        wandio_wdestroy(DATA(iow)->child);
527        free(DATA(iow)->thread);
528        free(iow->data);
529        free(iow);
530}
531
532iow_source_t lzo_wsource = {
533        "lzo",
534        lzo_wwrite,
535        lzo_wclose
536};
537
Note: See TracBrowser for help on using the repository browser.