source: libwandio/iow-lzo.c @ f7bcbfb

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