summaryrefslogtreecommitdiffstats
path: root/streaming/compression.c
blob: 8f2517a8e353490bb4e51c5cae7d944f0c131a4c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
#include "rrdpush.h"

#ifdef ENABLE_COMPRESSION
#include "lz4.h"

#define STREAM_COMPRESSION_MSG "STREAM_COMPRESSION"

// signature MUST end with a newline
#define SIGNATURE ((uint32_t)('z' | 0x80) | (0x80 << 8) | (0x80 << 16) | ('\n' << 24))
#define SIGNATURE_MASK ((uint32_t)0xff | (0x80 << 8) | (0x80 << 16) | (0xff << 24))
#define SIGNATURE_SIZE 4


/*
 * LZ4 streaming API compressor specific data
 */
struct compressor_data {
    LZ4_stream_t *stream;
    char *input_ring_buffer;
    size_t input_ring_buffer_size;
    size_t input_ring_buffer_pos;
};


/*
 * Reset compressor state for a new stream
 */
static void lz4_compressor_reset(struct compressor_state *state)
{
    if (state->data) {
        if (state->data->stream) {
            LZ4_resetStream_fast(state->data->stream);            
            internal_error(true, "%s: compressor reset", STREAM_COMPRESSION_MSG);
        }
        state->data->input_ring_buffer_pos = 0;
    }
}

/*
 * Destroy compressor state and all related data
 */
static void lz4_compressor_destroy(struct compressor_state **state)
{
    if (state && *state) {
        struct compressor_state *s = *state;
        if (s->data) {
            if (s->data->stream)
                LZ4_freeStream(s->data->stream);
            freez(s->data->input_ring_buffer);
            freez(s->data);
        }
        freez(s->compression_result_buffer);
        freez(s);
        *state = NULL;
        debug(D_STREAM, "%s: Compressor Destroyed.", STREAM_COMPRESSION_MSG);
    }
}

/*
 * Compress the given block of data
 * Compressed data will remain in the internal buffer until the next invocation
 * Return the size of compressed data block as result and the pointer to internal buffer using the last argument
 * or 0 in case of error
 */
static size_t lz4_compressor_compress(struct compressor_state *state, const char *data, size_t size, char **out)
{
    if(unlikely(!state || !size || !out))
        return 0;

    if(unlikely(size > COMPRESSION_MAX_MSG_SIZE)) {
        error("%s: Compression Failed - Message size %lu above compression buffer limit: %d", STREAM_COMPRESSION_MSG, (long unsigned int)size, COMPRESSION_MAX_MSG_SIZE);
        return 0;
    }

    size_t max_dst_size = LZ4_COMPRESSBOUND(size);
    size_t data_size = max_dst_size + SIGNATURE_SIZE;

    if (!state->compression_result_buffer) {
        state->compression_result_buffer = mallocz(data_size);
        state->compression_result_buffer_size = data_size;
    }
    else if(unlikely(state->compression_result_buffer_size < data_size)) {
        state->compression_result_buffer = reallocz(state->compression_result_buffer, data_size);
        state->compression_result_buffer_size = data_size;
    }

    // the ring buffer always has space for LZ4_MAX_MSG_SIZE
    memcpy(state->data->input_ring_buffer + state->data->input_ring_buffer_pos, data, size);

    // this call needs the last 64K of our previous data
    // they are available in the ring buffer
    long int compressed_data_size = LZ4_compress_fast_continue(
        state->data->stream,
        state->data->input_ring_buffer + state->data->input_ring_buffer_pos,
        state->compression_result_buffer + SIGNATURE_SIZE,
        size,
        max_dst_size,
        1);

    if (compressed_data_size < 0) {
        error("Data compression error: %ld", compressed_data_size);
        return 0;
    }

    // update the next writing position of the ring buffer
    state->data->input_ring_buffer_pos += size;
    if(unlikely(state->data->input_ring_buffer_pos >= state->data->input_ring_buffer_size - COMPRESSION_MAX_MSG_SIZE))
        state->data->input_ring_buffer_pos = 0;

    // update the signature header
    uint32_t len = ((compressed_data_size & 0x7f) | 0x80 | (((compressed_data_size & (0x7f << 7)) << 1) | 0x8000)) << 8;
    *(uint32_t *)state->compression_result_buffer = len | SIGNATURE;
    *out = state->compression_result_buffer;
    debug(D_STREAM, "%s: Compressed data header: %ld", STREAM_COMPRESSION_MSG, compressed_data_size);
    return compressed_data_size + SIGNATURE_SIZE;
}

/*
 * Create and initialize compressor state
 * Return the pointer to compressor_state structure created
 */
struct compressor_state *create_compressor()
{
    struct compressor_state *state = callocz(1, sizeof(struct compressor_state));

    state->reset = lz4_compressor_reset;
    state->compress = lz4_compressor_compress;
    state->destroy = lz4_compressor_destroy;

    state->data = callocz(1, sizeof(struct compressor_data));
    state->data->stream = LZ4_createStream();
    state->data->input_ring_buffer_size = LZ4_DECODER_RING_BUFFER_SIZE(COMPRESSION_MAX_MSG_SIZE * 2);
    state->data->input_ring_buffer = callocz(1, state->data->input_ring_buffer_size);
    state->compression_result_buffer_size = 0;
    state->reset(state);
    debug(D_STREAM, "%s: Initialize streaming compression!", STREAM_COMPRESSION_MSG);
    return state;
}

/*
 * LZ4 streaming API decompressor specific data
 */
struct decompressor_stream {
    LZ4_streamDecode_t *lz4_stream;
    char *buffer;
    size_t size;
    size_t write_at;
    size_t read_at;
};

/*
 * Reset decompressor state for a new stream
 */
static void lz4_decompressor_reset(struct decompressor_state *state)
{
    if (state->stream) {
        if (state->stream->lz4_stream)
           LZ4_setStreamDecode(state->stream->lz4_stream, NULL, 0);

        state->stream->write_at = 0;
        state->stream->read_at = 0;
    }
}

/*
 * Destroy decompressor state and all related data
 */
static void lz4_decompressor_destroy(struct decompressor_state **state)
{
    if (state && *state) {
        struct decompressor_state *s = *state;
        if (s->stream) {
            debug(D_STREAM, "%s: Destroying decompressor.", STREAM_COMPRESSION_MSG);
            if (s->stream->lz4_stream)
                LZ4_freeStreamDecode(s->stream->lz4_stream);
            freez(s->stream->buffer);
            freez(s->stream);
        }
        freez(s);
        *state = NULL;
    }
}

static size_t decode_compress_header(const char *data, size_t data_size) {
    if (unlikely(!data || !data_size))
        return 0;

    if (unlikely(data_size != SIGNATURE_SIZE))
        return 0;

    uint32_t sign = *(uint32_t *)data;
    if (unlikely((sign & SIGNATURE_MASK) != SIGNATURE))
        return 0;

    size_t length = ((sign >> 8) & 0x7f) | ((sign >> 9) & (0x7f << 7));
    return length;
}

/*
 * Start the collection of compressed data in an internal buffer
 * Return the size of compressed data or 0 for uncompressed data
 */
static size_t lz4_decompressor_start(struct decompressor_state *state __maybe_unused, const char *header, size_t header_size) {
    if(unlikely(state->stream->read_at != state->stream->write_at))
        fatal("%s: asked to decompress new data, while there are unread data in the decompression buffer!"
        , STREAM_COMPRESSION_MSG);

    return decode_compress_header(header, header_size);
}

/*
 * Decompress the compressed data in the internal buffer
 * Return the size of uncompressed data or 0 for error
 */
static size_t lz4_decompressor_decompress(struct decompressor_state *state, const char *compressed_data, size_t compressed_size) {
    if (unlikely(!state || !compressed_data || !compressed_size))
        return 0;

    if(unlikely(state->stream->read_at != state->stream->write_at))
        fatal("%s: asked to decompress new data, while there are unread data in the decompression buffer!"
              , STREAM_COMPRESSION_MSG);

    if (unlikely(state->stream->write_at >= state->stream->size / 2)) {
        state->stream->write_at = 0;
        state->stream->read_at = 0;
    }

    long int decompressed_size = LZ4_decompress_safe_continue(
            state->stream->lz4_stream
            , compressed_data
            , state->stream->buffer + state->stream->write_at
            , (int)compressed_size
            , (int)(state->stream->size - state->stream->write_at)
            );

    if (unlikely(decompressed_size < 0)) {
        error("%s: decompressor returned negative decompressed bytes: %ld", STREAM_COMPRESSION_MSG, decompressed_size);
        return 0;
    }

    if(unlikely(decompressed_size + state->stream->write_at > state->stream->size))
        fatal("%s: decompressor overflown the stream_buffer. size: %zu, pos: %zu, added: %ld, exceeding the buffer by %zu"
              , STREAM_COMPRESSION_MSG
              , state->stream->size
              , state->stream->write_at
              , decompressed_size
              , (size_t)(state->stream->write_at + decompressed_size - state->stream->size)
              );

    state->stream->write_at += decompressed_size;

    // statistics
    state->total_compressed += compressed_size + SIGNATURE_SIZE;
    state->total_uncompressed += decompressed_size;
    state->packet_count++;

    return decompressed_size;
}

/*
 * Return the size of uncompressed data left in the internal buffer or 0 for error
 */
static size_t lz4_decompressor_decompressed_bytes_in_buffer(struct decompressor_state *state) {
    if(unlikely(state->stream->read_at > state->stream->write_at))
        fatal("%s: invalid read/write stream positions"
        , STREAM_COMPRESSION_MSG);

    return state->stream->write_at - state->stream->read_at;
}

/*
 * Fill the buffer provided with uncompressed data from the internal buffer
 * Return the size of uncompressed data copied or 0 for error
 */
static size_t lz4_decompressor_get(struct decompressor_state *state, char *dst, size_t size) {
    if (unlikely(!state || !size || !dst))
        return 0;

    size_t remaining = lz4_decompressor_decompressed_bytes_in_buffer(state);
    if(unlikely(!remaining))
        return 0;

    size_t bytes_to_return = size;
    if(bytes_to_return > remaining)
        bytes_to_return = remaining;

    memcpy(dst, state->stream->buffer + state->stream->read_at, bytes_to_return);
    state->stream->read_at += bytes_to_return;

    if(unlikely(state->stream->read_at > state->stream->write_at))
        fatal("%s: invalid read/write stream positions"
        , STREAM_COMPRESSION_MSG);

    return bytes_to_return;
}

/*
 * Create and initialize decompressor state
 * Return the pointer to decompressor_state structure created
 */
struct decompressor_state *create_decompressor()
{
    struct decompressor_state *state = callocz(1, sizeof(struct decompressor_state));
    state->signature_size = SIGNATURE_SIZE;
    state->reset = lz4_decompressor_reset;
    state->start = lz4_decompressor_start;
    state->decompress = lz4_decompressor_decompress;
    state->get = lz4_decompressor_get;
    state->decompressed_bytes_in_buffer = lz4_decompressor_decompressed_bytes_in_buffer;
    state->destroy = lz4_decompressor_destroy;

    state->stream = callocz(1, sizeof(struct decompressor_stream));
    fatal_assert(state->stream);
    state->stream->lz4_stream = LZ4_createStreamDecode();
    state->stream->size = LZ4_decoderRingBufferSize(COMPRESSION_MAX_MSG_SIZE) * 2;
    state->stream->buffer = mallocz(state->stream->size);
    fatal_assert(state->stream->buffer);
    state->reset(state);
    debug(D_STREAM, "%s: Initialize streaming decompression!", STREAM_COMPRESSION_MSG);
    return state;
}
#endif