source: libwandio/iow-lzo.c @ d6a56b6

4.0.1-hotfixescachetimestampsdevelopdpdk-ndagetsilivegetfragoffhelplibtrace4ndag_formatpfringrc-4.0.1rc-4.0.2rc-4.0.3rc-4.0.4ringdecrementfixringperformanceringtimestampfixes
Last change on this file since d6a56b6 was 4a2529b, checked in by Shane Alcock <salcock@…>, 8 years ago

Fix set but unused variable in the lzo code

  • Property mode set to 100644
File size: 14.4 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                if (err < 0)
264                        break; 
265                /* Make sure someone else hasn't clobbered us!*/
266                assert(me->state == WAITING);
267                me->state = FULL;
268                pthread_cond_signal(&me->out_ready);
269        }
270        pthread_mutex_unlock(&me->mutex);
271
272        return NULL;
273}
274
275iow_t *lzo_wopen(iow_t *child, int compress_level UNUSED)
276{
277        const int opt_filter = 0;
278        int flags;
279        iow_t *iow;
280        struct buffer_t buffer;
281        buffer.offset=0;
282        int i;
283
284        if (!child)
285                return NULL;
286
287        if (lzo_init() != LZO_E_OK) {
288                /* Fail */
289                return NULL;
290        }
291
292        iow = malloc(sizeof(iow_t));
293        iow->source = &lzo_wsource;
294        iow->data = malloc(sizeof(struct lzow_t));
295
296        DATA(iow)->child = child;
297        DATA(iow)->err = ERR_OK;
298
299        flags = 0;
300        flags |= F_OS_UNIX & F_OS_MASK; /* Operating System */
301        flags |= F_CS_NATIVE & F_CS_MASK;       /* Character Set */
302        flags |= F_ADLER32_D; /* We adler32 the uncompressed data */
303        /* flags |= F_STDIN; */
304        /* flags |= F_STDOUT */
305        /* flags |= F_MULTIPART; */
306        /* flags |= F_H_CRC32; */
307
308        write_buf(&buffer, lzop_magic, sizeof(lzop_magic));
309        write16(&buffer, 0x1010 &0xFFFF); /* version: pretend to be LZOP version 0x1010 from lzop's version.h */
310        write16(&buffer, lzo_version() & 0xFFFF); /* libversion */
311        write16(&buffer, opt_filter ? 0x0950 : 0x0940); /* version needed to extract */
312        write8(&buffer, M_LZO1X_1);     /* method */
313        write8(&buffer, 5); /* level */
314        write32(&buffer, flags); /* flags */
315        /* if (flags & F_H_FILTER)
316                write32(iow, opt_filter);
317        */ 
318        write32(&buffer, 0x600); /* mode: We assume traces may be sensitive */
319        write32(&buffer, time(NULL)); /* mtime */
320        write32(&buffer, 0); /* GMTdiff */
321
322        /* Length, filename */
323        write8(&buffer, strlen("compresseddata"));
324        write_buf(&buffer, "compresseddata",strlen("compresseddata"));
325
326        if (flags & F_H_CRC32) {
327                write32(&buffer, 
328                        lzo_crc32(CRC32_INIT_VALUE, 
329                                (const void*)buffer.buffer+sizeof(lzop_magic), 
330                                buffer.offset-sizeof(lzop_magic)));
331        }
332        else {
333                uint32_t chksum=lzo_adler32(
334                        ADLER32_INIT_VALUE, 
335                        (const void *)buffer.buffer+sizeof(lzop_magic), 
336                        buffer.offset-sizeof(lzop_magic));
337                write32(&buffer, chksum);
338        }
339
340        wandio_wwrite(DATA(iow)->child,
341                buffer.buffer,
342                buffer.offset);
343
344        /* Set up the thread pool -- one thread per core */
345        DATA(iow)->threads = min((uint32_t)sysconf(_SC_NPROCESSORS_ONLN),
346                        use_threads);
347        DATA(iow)->thread = malloc(
348                        sizeof(struct lzothread_t) * DATA(iow)->threads);
349        DATA(iow)->next_thread = 0;
350        for(i=0; i<DATA(iow)->threads; ++i) {
351                pthread_cond_init(&DATA(iow)->thread[i].in_ready, NULL);
352                pthread_cond_init(&DATA(iow)->thread[i].out_ready, NULL);
353                pthread_mutex_init(&DATA(iow)->thread[i].mutex, NULL);
354                DATA(iow)->thread[i].closing = false;
355                DATA(iow)->thread[i].num = i;
356                DATA(iow)->thread[i].state = EMPTY;
357                DATA(iow)->thread[i].inbuf.offset = 0;
358
359                pthread_create(&DATA(iow)->thread[i].thread, 
360                                NULL,
361                                lzo_compress_thread,
362                                (void*)&DATA(iow)->thread[i]);
363        }
364
365        return iow;
366}
367
368static struct lzothread_t *get_next_thread(iow_t *iow)
369{
370        return &DATA(iow)->thread[DATA(iow)->next_thread];
371}
372
373static off_t lzo_wwrite(iow_t *iow, const char *buffer, off_t len)
374{
375        off_t ret = 0;
376        while (len>0) {
377                off_t size = len;
378                off_t err;
379                struct buffer_t outbuf;
380
381                if (!DATA(iow)->threads) {
382                        size = min(len, MAX_BLOCK_SIZE);
383                        err=lzo_wwrite_block(buffer, size, &outbuf);
384                        /* Flush the data out */
385                        wandio_wwrite(DATA(iow)->child,
386                                        outbuf.buffer,
387                                        outbuf.offset);
388
389                        if (err < 0) {/* Error */
390                                if (ret == 0)
391                                        return err;
392                                /* If we've written some data, return that fact now, let them call back
393                                 * and try and write more data, fail again then.
394                                 */
395                                return ret;
396                        }
397                        else {
398                                assert(err == size);
399                                buffer += size;
400                                len -= size;
401                        }
402                }
403                else {
404                        off_t space;
405
406                        pthread_mutex_lock(&get_next_thread(iow)->mutex);
407                        /* If this thread is still compressing, wait for it to finish */
408                        while (get_next_thread(iow)->state == WAITING) {
409                                pthread_cond_wait(
410                                        &get_next_thread(iow)->out_ready, 
411                                        &get_next_thread(iow)->mutex);
412                        }
413
414                        /* Flush any data out thats there */
415                        if (get_next_thread(iow)->state == FULL) {
416                                assert(get_next_thread(iow)->outbuf.offset
417                                                < sizeof(get_next_thread(iow)->outbuf.buffer));
418                                wandio_wwrite(DATA(iow)->child,
419                                                get_next_thread(iow)->outbuf.buffer,
420                                                get_next_thread(iow)->outbuf.offset);
421                                get_next_thread(iow)->state = EMPTY;
422                                get_next_thread(iow)->inbuf.offset = 0;
423                        }
424
425                        assert(get_next_thread(iow)->state == EMPTY);
426
427                        /* Figure out how much space we can copy into this buffer */
428                        assert(MAX_BLOCK_SIZE <= sizeof(get_next_thread(iow)->inbuf.buffer));
429                        space = MAX_BLOCK_SIZE-get_next_thread(iow)->inbuf.offset;
430                        size = min(space, size);
431                        assert(size>0);
432                        assert(size <= MAX_BLOCK_SIZE);
433                        assert(get_next_thread(iow)->inbuf.offset + size <= MAX_BLOCK_SIZE);
434
435                        /* Move our data in */
436                        memcpy(&get_next_thread(iow)->inbuf.buffer[get_next_thread(iow)->inbuf.offset], 
437                                buffer, 
438                                size);
439                        get_next_thread(iow)->inbuf.offset += size;
440
441                        /* If the buffer is now full Trigger the thread to start compressing this block,
442                         * and move onto the next block.
443                         */
444                        if (get_next_thread(iow)->inbuf.offset >= sizeof(get_next_thread(iow)->inbuf.buffer)
445                          ||get_next_thread(iow)->inbuf.offset >= MAX_BLOCK_SIZE) {
446                                assert(get_next_thread(iow)->state == EMPTY);
447                                get_next_thread(iow)->state = WAITING;
448                                pthread_cond_signal(&get_next_thread(iow)->in_ready);
449
450                                pthread_mutex_unlock(&get_next_thread(iow)->mutex);
451
452                                DATA(iow)->next_thread = 
453                                                (DATA(iow)->next_thread+1) % DATA(iow)->threads;
454                        }
455                        else 
456                                pthread_mutex_unlock(&get_next_thread(iow)->mutex);
457
458                        /* Update the lengths */
459                        buffer += size;
460                        len -= size;
461                }
462        }
463        return len;
464}
465
466static void shutdown_thread(iow_t *iow, struct lzothread_t *thread)
467{
468        pthread_mutex_lock(&thread->mutex);
469
470        /* If this buffer is empty it shouldn't have any data in it, we should have taken
471         * care of that before.
472         */
473        /* thread->state == EMPTY implies thread->inbuf.offset == 0 */
474        assert(!(thread->state == EMPTY) || thread->inbuf.offset == 0);
475
476        while (thread->state == WAITING) {
477                pthread_cond_wait(
478                        &thread->out_ready,
479                        &thread->mutex);
480        }
481        if (thread->state == FULL) {
482                wandio_wwrite(DATA(iow)->child,
483                                thread->outbuf.buffer,
484                                thread->outbuf.offset);
485                thread->state = EMPTY;
486                thread->inbuf.offset = 0;
487        }
488        /* Now the thread should be empty, so ask it to shut down */
489        assert(thread->state == EMPTY && thread->inbuf.offset == 0);
490        thread->closing = true;
491        pthread_cond_signal(&thread->in_ready);
492        pthread_mutex_unlock(&thread->mutex);
493        /* And wait for it to die */
494        pthread_join(thread->thread,NULL);
495}
496
497static void lzo_wclose(iow_t *iow)
498{
499        const uint32_t zero = 0;
500        int i;
501
502        /* Flush the last buffer */
503        pthread_mutex_lock(&get_next_thread(iow)->mutex);
504        if (get_next_thread(iow)->state == EMPTY && get_next_thread(iow)->inbuf.offset != 0) {
505                get_next_thread(iow)->state = WAITING;
506                pthread_cond_signal(&get_next_thread(iow)->in_ready);
507        }
508        pthread_mutex_unlock(&get_next_thread(iow)->mutex);
509
510        DATA(iow)->next_thread = 
511                        (DATA(iow)->next_thread+1) % DATA(iow)->threads;
512
513        /* Right, now we have to shutdown all our threads -- in order */
514        for(i=DATA(iow)->next_thread; i<DATA(iow)->threads; ++i) {
515                shutdown_thread(iow,&DATA(iow)->thread[i]);
516        }
517        for(i=0; i<DATA(iow)->next_thread; ++i) {
518                shutdown_thread(iow,&DATA(iow)->thread[i]);
519        }
520
521        /* Write out an end of file marker */
522        wandio_wwrite(DATA(iow)->child,
523                &zero,
524                sizeof(zero));
525
526        /* And clean everything up */
527        wandio_wdestroy(DATA(iow)->child);
528        free(DATA(iow)->thread);
529        free(iow->data);
530        free(iow);
531}
532
533iow_source_t lzo_wsource = {
534        "lzo",
535        lzo_wwrite,
536        lzo_wclose
537};
538
Note: See TracBrowser for help on using the repository browser.