source: lib/iow-lzo.c @ bf7e954

4.0.1-hotfixescachetimestampsdevelopdpdk-ndagetsilivegetfragoffhelplibtrace4ndag_formatpfringrc-4.0.1rc-4.0.2rc-4.0.3rc-4.0.4ringdecrementfixringperformanceringtimestampfixes
Last change on this file since bf7e954 was 7283767, checked in by Perry Lorier <perry@…>, 12 years ago

Fix scheduling of flushing buffers on shutdown

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