2
This libary has been modified for use by the MySQL Archive Engine.
6
/* zlib.h -- interface of the 'zlib' general purpose compression library
7
version 1.2.3, July 18th, 2005
9
Copyright (C) 1995-2005 Jean-loup Gailly and Mark Adler
11
This software is provided 'as-is', without any express or implied
12
warranty. In no event will the authors be held liable for any damages
13
arising from the use of this software.
15
Permission is granted to anyone to use this software for any purpose,
16
including commercial applications, and to alter it and redistribute it
17
freely, subject to the following restrictions:
19
1. The origin of this software must not be misrepresented; you must not
20
claim that you wrote the original software. If you use this software
21
in a product, an acknowledgment in the product documentation would be
22
appreciated but is not required.
23
2. Altered source versions must be plainly marked as such, and must not be
24
misrepresented as being the original software.
25
3. This notice may not be removed or altered from any source distribution.
27
Jean-loup Gailly Mark Adler
28
jloup@gzip.org madler@alumni.caltech.edu
31
The data format used by the zlib library is described by RFCs (Request for
32
Comments) 1950 to 1952 in the files http://www.ietf.org/rfc/rfc1950.txt
33
(zlib format), rfc1951.txt (deflate format) and rfc1952.txt (gzip format).
36
#ifndef PLUGIN_ARCHIVE_AZIO_H
37
#define PLUGIN_ARCHIVE_AZIO_H
39
/* We currently allow this on all platforms */
42
#include <drizzled/common.h>
43
#include "drizzled/internal/my_sys.h"
51
/* Start of MySQL Specific Information */
53
/* Some personal debugging functions */
54
#define WATCHPOINT fprintf(stderr, "\nWATCHPOINT %s:%d (%s)\n", __FILE__, __LINE__,__func__);fflush(stderr);
55
#define WATCHPOINT_STRING(A) fprintf(stderr, "\nWATCHPOINT %s:%d (%s) %s\n", __FILE__, __LINE__,__func__,A);fflush(stderr);
56
#define WATCHPOINT_NUMBER(A) fprintf(stderr, "\nWATCHPOINT %s:%d (%s) %d\n", __FILE__, __LINE__,__func__,(int)(A));fflush(stderr);
57
#define WATCHPOINT_ERRNO(A) fprintf(stderr, "\nWATCHPOINT %s:%d (%s) %s\n", __FILE__, __LINE__,__func__, strerror(A));A= 0;fflush(stderr);
60
uint64_t + uint64_t + uint64_t + uint64_t + unsigned char
62
#define AZMETA_BUFFER_SIZE sizeof(uint64_t) \
63
+ sizeof(uint64_t) + sizeof(uint64_t) + sizeof(uint64_t) \
64
+ sizeof(unsigned int) + sizeof(unsigned int) \
65
+ sizeof(unsigned int) + sizeof(unsigned int) \
66
+ sizeof(unsigned char)
68
#define AZHEADER_SIZE 29
70
#define AZ_MAGIC_POS 0
71
#define AZ_VERSION_POS 1
72
#define AZ_MINOR_VERSION_POS 2
73
#define AZ_BLOCK_POS 3
74
#define AZ_STRATEGY_POS 4
76
#define AZ_FRM_LENGTH_POS 9
77
#define AZ_META_POS 13
78
#define AZ_META_LENGTH_POS 17
79
#define AZ_START_POS 21
81
#define AZ_FLUSH_POS 37
82
#define AZ_CHECK_POS 45
83
#define AZ_AUTOINCREMENT_POS 53
84
#define AZ_LONGEST_POS 61
85
#define AZ_SHORTEST_POS 65
86
#define AZ_COMMENT_POS 69
87
#define AZ_COMMENT_LENGTH_POS 73
88
#define AZ_DIRTY_POS 77
94
#define AZ_STATE_CLEAN 0
95
#define AZ_STATE_DIRTY 1
96
#define AZ_STATE_SAVED 2
97
#define AZ_STATE_CRASHED 3
100
The 'zlib' compression library provides in-memory compression and
101
decompression functions, including integrity checks of the uncompressed
102
data. This version of the library supports only one compression method
103
(deflation) but other algorithms will be added later and will have the same
106
Compression can be done in a single step if the buffers are large
107
enough (for example if an input file is mmap'ed), or can be done by
108
repeated calls of the compression function. In the latter case, the
109
application must provide more input and/or consume the output
110
(providing more output space) before each call.
112
The compressed data format used by default by the in-memory functions is
113
the zlib format, which is a zlib wrapper documented in RFC 1950, wrapped
114
around a deflate stream, which is itself documented in RFC 1951.
116
The library also supports reading and writing files in gzip (.gz) format
117
with an interface similar to that of stdio using the functions that start
118
with "gz". The gzip format is different from the zlib format. gzip is a
119
gzip wrapper, documented in RFC 1952, wrapped around a deflate stream.
121
This library can optionally read and write gzip streams in memory as well.
123
The zlib format was designed to be compact and fast for use in memory
124
and on communications channels. The gzip format was designed for single-
125
file compression on file systems, has a larger header than zlib to maintain
126
directory information, and uses a different, slower check method than zlib.
128
The library does not install any signal handler. The decoder checks
129
the consistency of the compressed data, so the library should never
130
crash even in case of corrupted input.
135
The application must update next_in and avail_in when avail_in has
136
dropped to zero. It must update next_out and avail_out when avail_out
137
has dropped to zero. The application must initialize zalloc, zfree and
138
opaque before calling the init function. All other fields are set by the
139
compression library and must not be updated by the application.
141
The opaque value provided by the application will be passed as the first
142
parameter for calls of zalloc and zfree. This can be useful for custom
143
memory management. The compression library attaches no meaning to the
146
zalloc must return Z_NULL if there is not enough memory for the object.
147
If zlib is used in a multi-threaded application, zalloc and zfree must be
150
On 16-bit systems, the functions zalloc and zfree must be able to allocate
151
exactly 65536 bytes, but will not be required to allocate more than this
152
if the symbol MAXSEG_64K is defined (see zconf.h). WARNING: On MSDOS,
153
pointers returned by zalloc for objects of exactly 65536 bytes *must*
154
have their offset normalized to zero. The default allocation function
155
provided by this library ensures this (see zutil.c). To reduce memory
156
requirements and avoid any allocation of 64K objects, at the expense of
157
compression ratio, compile the library with -DMAX_WBITS=14 (see zconf.h).
159
The fields total_in and total_out can be used for statistics or
160
progress reports. After compression, total_in holds the total size of
161
the uncompressed data and may be saved for use in the decompressor
162
(particularly if the decompressor wants to decompress everything in
169
#define Z_PARTIAL_FLUSH 1 /* will be removed, use Z_SYNC_FLUSH instead */
170
#define Z_SYNC_FLUSH 2
171
#define Z_FULL_FLUSH 3
174
/* Allowed flush values; see deflate() and inflate() below for details */
177
#define Z_STREAM_END 1
178
#define Z_NEED_DICT 2
180
#define Z_STREAM_ERROR (-2)
181
#define Z_DATA_ERROR (-3)
182
#define Z_MEM_ERROR (-4)
183
#define Z_BUF_ERROR (-5)
184
#define Z_VERSION_ERROR (-6)
185
/* Return codes for the compression/decompression functions. Negative
186
* values are errors, positive values are used for special but normal events.
189
#define Z_NO_COMPRESSION 0
190
#define Z_BEST_SPEED 1
191
#define Z_BEST_COMPRESSION 9
192
#define Z_DEFAULT_COMPRESSION (-1)
193
/* compression levels */
196
#define Z_HUFFMAN_ONLY 2
199
#define Z_DEFAULT_STRATEGY 0
200
/* compression strategy; see deflateInit2() below for details */
204
#define Z_ASCII Z_TEXT /* for compatibility with 1.2.2 and earlier */
206
/* Possible values of the data_type field (though see inflate()) */
209
/* The deflate compression method (the only one supported in this version) */
211
#define Z_NULL 0 /* for initializing zalloc, zfree, opaque */
212
#define AZ_BUFSIZE_READ 32768
213
#define AZ_BUFSIZE_WRITE 16384
227
typedef class azio_container azio_container;
229
class azio_container {
232
az_thread_type ready;
236
pthread_mutex_t thresh_mutex;
237
pthread_cond_t threshhold;
238
pthread_t mainthread; /* Thread descriptor */
251
typedef class azio_stream {
254
int z_err; /* error code for last stream operation */
255
int z_eof; /* set if end of input file */
256
int file; /* .gz file */
257
Byte *inbuf; /* input buffer */
258
Byte buffer1[AZ_BUFSIZE_READ]; /* input buffer */
259
Byte buffer2[AZ_BUFSIZE_READ]; /* input buffer */
260
Byte outbuf[AZ_BUFSIZE_WRITE]; /* output buffer */
261
int aio_inited; /* Are we good to go */
262
uLong crc; /* crc32 of uncompressed data */
263
char *msg; /* error message */
264
char mode; /* 'w' or 'r' */
265
size_t start; /* start of compressed data in file (header skipped) */
266
size_t in; /* bytes into deflate or inflate */
267
size_t out; /* bytes out of deflate or inflate */
268
size_t pos; /* bytes out of deflate or inflate */
269
int back; /* one character push-back */
270
int last; /* true if push-back is last character */
271
unsigned char version; /* Version */
272
unsigned char minor_version; /* Version */
273
unsigned int block_size; /* Block Size */
274
uint64_t check_point; /* Last position we checked */
275
uint64_t forced_flushes; /* Forced Flushes */
276
uint64_t rows; /* rows */
277
uint64_t auto_increment; /* auto increment field */
278
unsigned int longest_row; /* Longest row */
279
unsigned int shortest_row; /* Shortest row */
280
unsigned char dirty; /* State of file */
281
unsigned int frm_start_pos; /* Position for start of FRM */
282
unsigned int frm_length; /* Position for start of FRM */
283
unsigned int comment_start_pos; /* Position for start of comment */
284
unsigned int comment_length; /* Position for start of comment */
287
azio_container container;
319
comment_start_pos(0),
323
memset(buffer1, 0, AZ_BUFSIZE_READ);
324
memset(buffer2, 0, AZ_BUFSIZE_READ);
325
memset(outbuf, 0, AZ_BUFSIZE_WRITE);
330
/* basic functions */
332
int azopen(azio_stream *s, const char *path, int Flags, az_method method);
334
Opens a gzip (.gz) file for reading or writing. The mode parameter
335
is as in fopen ("rb" or "wb") but can also include a compression level
336
("wb9") or a strategy: 'f' for filtered data as in "wb6f", 'h' for
337
Huffman only compression as in "wb1h", or 'R' for run-length encoding
338
as in "wb1R". (See the description of deflateInit2 for more information
339
about the strategy parameter.)
341
azopen can be used to read a file which is not in gzip format; in this
342
case gzread will directly read from the file without decompression.
344
azopen returns NULL if the file could not be opened or if there was
345
insufficient memory to allocate the (de)compression state; errno
346
can be checked to distinguish the two cases (if errno is zero, the
347
zlib error is Z_MEM_ERROR). */
349
int azdopen(azio_stream *s,int fd, int Flags);
351
azdopen() associates a azio_stream with the file descriptor fd. File
352
descriptors are obtained from calls like open, dup, creat, pipe or
353
fileno (in the file has been previously opened with fopen).
354
The mode parameter is as in azopen.
355
The next call of gzclose on the returned azio_stream will also close the
356
file descriptor fd, just like fclose(fdopen(fd), mode) closes the file
357
descriptor fd. If you want to keep fd open, use azdopen(dup(fd), mode).
358
azdopen returns NULL if there was insufficient memory to allocate
359
the (de)compression state.
362
extern int azflush(azio_stream *file, int flush);
364
Flushes all pending output into the compressed file. The parameter
365
flush is as in the deflate() function. The return value is the zlib
366
error number (see function gzerror below). gzflush returns Z_OK if
367
the flush parameter is Z_FINISH and all output could be flushed.
368
gzflush should be called only when strictly necessary because it can
372
extern size_t azseek (azio_stream *file,
373
size_t offset, int whence);
375
Sets the starting position for the next gzread or gzwrite on the
376
given compressed file. The offset represents a number of bytes in the
377
uncompressed data stream. The whence parameter is defined as in lseek(2);
378
the value SEEK_END is not supported.
379
If the file is opened for reading, this function is emulated but can be
380
extremely slow. If the file is opened for writing, only forward seeks are
381
supported; gzseek then compresses a sequence of zeroes up to the new
384
gzseek returns the resulting offset location as measured in bytes from
385
the beginning of the uncompressed stream, or -1 in case of error, in
386
particular if the file is opened for writing and the new starting position
387
would be before the current position.
390
extern size_t aztell(azio_stream *file);
392
Returns the starting position for the next gzread or gzwrite on the
393
given compressed file. This position represents a number of bytes in the
394
uncompressed data stream.
396
gztell(file) is equivalent to gzseek(file, 0L, SEEK_CUR)
399
extern int azclose(azio_stream *file);
401
Flushes all pending output if necessary, closes the compressed file
402
and deallocates all the (de)compression state. The return value is the zlib
403
error number (see function gzerror below).
406
int azread_init(azio_stream *s);
407
size_t azwrite_row(azio_stream *s, void *buf, unsigned int len);
408
size_t azread_row(azio_stream *s, int *error);
410
extern int azwrite_frm (azio_stream *s, const char *blob, unsigned int length);
411
extern int azread_frm (azio_stream *s, char *blob);
412
extern int azwrite_comment (azio_stream *s, const char *blob, unsigned int length);
413
extern int azread_comment (azio_stream *s, char *blob);
419
#endif /* PLUGIN_ARCHIVE_AZIO_H */
added
removed
plugin/archive/azio.h
