~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to plugin/archive/azio.h

Does not work (compile issue in plugin).

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
/*
 
2
  This libary has been modified for use by the MySQL Archive Engine.
 
3
     -Brian Aker
 
4
*/
 
5
 
 
6
/* zlib.h -- interface of the 'zlib' general purpose compression library
 
7
  version 1.2.3, July 18th, 2005
 
8
 
 
9
  Copyright (C) 1995-2005 Jean-loup Gailly and Mark Adler
 
10
 
 
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.
 
14
 
 
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:
 
18
 
 
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.
 
26
 
 
27
  Jean-loup Gailly        Mark Adler
 
28
  jloup@gzip.org          madler@alumni.caltech.edu
 
29
 
 
30
 
 
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).
 
34
*/
 
35
 
 
36
#ifndef PLUGIN_ARCHIVE_AZIO_H
 
37
#define PLUGIN_ARCHIVE_AZIO_H
 
38
 
 
39
/* We currently allow this on all platforms */
 
40
#define AZIO_AIO
 
41
 
 
42
#include <drizzled/common.h>
 
43
#include "drizzled/internal/my_sys.h"
 
44
 
 
45
#include <zlib.h>
 
46
 
 
47
#ifdef  __cplusplus
 
48
extern "C" {
 
49
#endif
 
50
 
 
51
/* Start of MySQL Specific Information */
 
52
 
 
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);
 
58
 
 
59
/*
 
60
  uint64_t + uint64_t + uint64_t + uint64_t + unsigned char
 
61
*/
 
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)
 
67
 
 
68
#define AZHEADER_SIZE 29
 
69
 
 
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
 
75
#define AZ_FRM_POS 5
 
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
 
80
#define AZ_ROW_POS 29
 
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
 
89
 
 
90
 
 
91
/*
 
92
  Flags for state
 
93
*/
 
94
#define AZ_STATE_CLEAN 0
 
95
#define AZ_STATE_DIRTY 1
 
96
#define AZ_STATE_SAVED 2
 
97
#define AZ_STATE_CRASHED 3
 
98
 
 
99
/*
 
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
 
104
  stream interface.
 
105
 
 
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.
 
111
 
 
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.
 
115
 
 
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.
 
120
 
 
121
     This library can optionally read and write gzip streams in memory as well.
 
122
 
 
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.
 
127
 
 
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.
 
131
*/
 
132
 
 
133
 
 
134
/*
 
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.
 
140
 
 
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
 
144
   opaque value.
 
145
 
 
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
 
148
   thread safe.
 
149
 
 
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).
 
158
 
 
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
 
163
   a single step).
 
164
*/
 
165
 
 
166
                        /* constants */
 
167
 
 
168
#define Z_NO_FLUSH      0
 
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
 
172
#define Z_FINISH        4
 
173
#define Z_BLOCK         5
 
174
/* Allowed flush values; see deflate() and inflate() below for details */
 
175
 
 
176
#define Z_OK            0
 
177
#define Z_STREAM_END    1
 
178
#define Z_NEED_DICT     2
 
179
#define Z_ERRNO        (-1)
 
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.
 
187
 */
 
188
 
 
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 */
 
194
 
 
195
#define Z_FILTERED            1
 
196
#define Z_HUFFMAN_ONLY        2
 
197
#define Z_RLE                 3
 
198
#define Z_FIXED               4
 
199
#define Z_DEFAULT_STRATEGY    0
 
200
/* compression strategy; see deflateInit2() below for details */
 
201
 
 
202
#define Z_BINARY   0
 
203
#define Z_TEXT     1
 
204
#define Z_ASCII    Z_TEXT   /* for compatibility with 1.2.2 and earlier */
 
205
#define Z_UNKNOWN  2
 
206
/* Possible values of the data_type field (though see inflate()) */
 
207
 
 
208
#define Z_DEFLATED   8
 
209
/* The deflate compression method (the only one supported in this version) */
 
210
 
 
211
#define Z_NULL  0  /* for initializing zalloc, zfree, opaque */
 
212
#define AZ_BUFSIZE_READ 32768
 
213
#define AZ_BUFSIZE_WRITE 16384
 
214
 
 
215
typedef enum {
 
216
  AZ_THREAD_FINISHED,
 
217
  AZ_THREAD_ACTIVE,
 
218
  AZ_THREAD_DEAD
 
219
} az_thread_type;
 
220
 
 
221
typedef enum {
 
222
  AZ_METHOD_BLOCK,
 
223
  AZ_METHOD_AIO,
 
224
  AZ_METHOD_MAX
 
225
} az_method;
 
226
 
 
227
typedef struct azio_container_st azio_container_st;
 
228
 
 
229
struct azio_container_st {
 
230
  int fd;
 
231
  az_thread_type ready;
 
232
  size_t offset;
 
233
  size_t read_size;
 
234
  void *buffer;
 
235
  pthread_mutex_t thresh_mutex;
 
236
  pthread_cond_t threshhold;
 
237
  pthread_t mainthread;            /* Thread descriptor */
 
238
};
 
239
 
 
240
 
 
241
typedef struct azio_stream {
 
242
  z_stream stream;
 
243
  int      z_err;   /* error code for last stream operation */
 
244
  int      z_eof;   /* set if end of input file */
 
245
  int     file;   /* .gz file */
 
246
  Byte     *inbuf;  /* input buffer */
 
247
  Byte     buffer1[AZ_BUFSIZE_READ];  /* input buffer */
 
248
  Byte     buffer2[AZ_BUFSIZE_READ];  /* input buffer */
 
249
  Byte     outbuf[AZ_BUFSIZE_WRITE]; /* output buffer */
 
250
  int      aio_inited; /* Are we good to go */
 
251
  uLong    crc;     /* crc32 of uncompressed data */
 
252
  char     *msg;    /* error message */
 
253
  char     mode;    /* 'w' or 'r' */
 
254
  size_t  start;   /* start of compressed data in file (header skipped) */
 
255
  size_t  in;      /* bytes into deflate or inflate */
 
256
  size_t  out;     /* bytes out of deflate or inflate */
 
257
  size_t  pos;     /* bytes out of deflate or inflate */
 
258
  int      back;    /* one character push-back */
 
259
  int      last;    /* true if push-back is last character */
 
260
  unsigned char version;   /* Version */
 
261
  unsigned char minor_version;   /* Version */
 
262
  unsigned int block_size;   /* Block Size */
 
263
  uint64_t check_point;   /* Last position we checked */
 
264
  uint64_t forced_flushes;   /* Forced Flushes */
 
265
  uint64_t rows;   /* rows */
 
266
  uint64_t auto_increment;   /* auto increment field */
 
267
  unsigned int longest_row;   /* Longest row */
 
268
  unsigned int shortest_row;   /* Shortest row */
 
269
  unsigned char dirty;   /* State of file */
 
270
  unsigned int frm_start_pos;   /* Position for start of FRM */
 
271
  unsigned int frm_length;   /* Position for start of FRM */
 
272
  unsigned int comment_start_pos;   /* Position for start of comment */
 
273
  unsigned int comment_length;   /* Position for start of comment */
 
274
#ifdef AZIO_AIO
 
275
  azio_container_st container;
 
276
#endif
 
277
  az_method method;
 
278
  char *row_ptr;
 
279
} azio_stream;
 
280
 
 
281
                        /* basic functions */
 
282
 
 
283
int azopen(azio_stream *s, const char *path, int Flags, az_method method);
 
284
/*
 
285
     Opens a gzip (.gz) file for reading or writing. The mode parameter
 
286
   is as in fopen ("rb" or "wb") but can also include a compression level
 
287
   ("wb9") or a strategy: 'f' for filtered data as in "wb6f", 'h' for
 
288
   Huffman only compression as in "wb1h", or 'R' for run-length encoding
 
289
   as in "wb1R". (See the description of deflateInit2 for more information
 
290
   about the strategy parameter.)
 
291
 
 
292
     azopen can be used to read a file which is not in gzip format; in this
 
293
   case gzread will directly read from the file without decompression.
 
294
 
 
295
     azopen returns NULL if the file could not be opened or if there was
 
296
   insufficient memory to allocate the (de)compression state; errno
 
297
   can be checked to distinguish the two cases (if errno is zero, the
 
298
   zlib error is Z_MEM_ERROR).  */
 
299
 
 
300
int azdopen(azio_stream *s,int fd, int Flags);
 
301
/*
 
302
     azdopen() associates a azio_stream with the file descriptor fd.  File
 
303
   descriptors are obtained from calls like open, dup, creat, pipe or
 
304
   fileno (in the file has been previously opened with fopen).
 
305
   The mode parameter is as in azopen.
 
306
     The next call of gzclose on the returned azio_stream will also close the
 
307
   file descriptor fd, just like fclose(fdopen(fd), mode) closes the file
 
308
   descriptor fd. If you want to keep fd open, use azdopen(dup(fd), mode).
 
309
     azdopen returns NULL if there was insufficient memory to allocate
 
310
   the (de)compression state.
 
311
*/
 
312
 
 
313
extern int azflush(azio_stream *file, int flush);
 
314
/*
 
315
     Flushes all pending output into the compressed file. The parameter
 
316
   flush is as in the deflate() function. The return value is the zlib
 
317
   error number (see function gzerror below). gzflush returns Z_OK if
 
318
   the flush parameter is Z_FINISH and all output could be flushed.
 
319
     gzflush should be called only when strictly necessary because it can
 
320
   degrade compression.
 
321
*/
 
322
 
 
323
extern size_t azseek (azio_stream *file,
 
324
                                      size_t offset, int whence);
 
325
/*
 
326
      Sets the starting position for the next gzread or gzwrite on the
 
327
   given compressed file. The offset represents a number of bytes in the
 
328
   uncompressed data stream. The whence parameter is defined as in lseek(2);
 
329
   the value SEEK_END is not supported.
 
330
     If the file is opened for reading, this function is emulated but can be
 
331
   extremely slow. If the file is opened for writing, only forward seeks are
 
332
   supported; gzseek then compresses a sequence of zeroes up to the new
 
333
   starting position.
 
334
 
 
335
      gzseek returns the resulting offset location as measured in bytes from
 
336
   the beginning of the uncompressed stream, or -1 in case of error, in
 
337
   particular if the file is opened for writing and the new starting position
 
338
   would be before the current position.
 
339
*/
 
340
 
 
341
extern size_t aztell(azio_stream *file);
 
342
/*
 
343
     Returns the starting position for the next gzread or gzwrite on the
 
344
   given compressed file. This position represents a number of bytes in the
 
345
   uncompressed data stream.
 
346
 
 
347
   gztell(file) is equivalent to gzseek(file, 0L, SEEK_CUR)
 
348
*/
 
349
 
 
350
extern int azclose(azio_stream *file);
 
351
/*
 
352
     Flushes all pending output if necessary, closes the compressed file
 
353
   and deallocates all the (de)compression state. The return value is the zlib
 
354
   error number (see function gzerror below).
 
355
*/
 
356
 
 
357
int azread_init(azio_stream *s);
 
358
size_t azwrite_row(azio_stream *s, void *buf, unsigned int len);
 
359
size_t azread_row(azio_stream *s, int *error);
 
360
 
 
361
extern int azwrite_frm (azio_stream *s, const char *blob, unsigned int length);
 
362
extern int azread_frm (azio_stream *s, char *blob);
 
363
extern int azwrite_comment (azio_stream *s, const char *blob, unsigned int length);
 
364
extern int azread_comment (azio_stream *s, char *blob);
 
365
 
 
366
#ifdef  __cplusplus
 
367
}
 
368
#endif
 
369
 
 
370
#endif /* PLUGIN_ARCHIVE_AZIO_H */