← Back to branch summary

~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to mysys/iocache.h

pandora-build v0.71. Added check for avahi.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mysys/iocache.h
 
1
/* - mode: c; c-basic-offset: 2; indent-tabs-mode: nil; -*-
 
2
 *  vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
 
3
 *
 
4
 *  Copyright (C) 2008 MySQL
 
5
 *
 
6
 *  This program is free software; you can redistribute it and/or modify
 
7
 *  it under the terms of the GNU General Public License as published by
 
8
 *  the Free Software Foundation; either version 2 of the License, or
 
9
 *  (at your option) any later version.
 
10
 *
 
11
 *  This program is distributed in the hope that it will be useful,
 
12
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 
13
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
14
 *  GNU General Public License for more details.
 
15
 *
 
16
 *  You should have received a copy of the GNU General Public License
 
17
 *  along with this program; if not, write to the Free Software
 
18
 *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 
19
 */
 
20
 
 
21
#ifndef MYSYS_IOCACHE_H
 
22
#define MYSYS_IOCACHE_H
 
23
 
 
24
#include <mysys/my_sys.h>
 
25
 
 
26
#if defined(__cplusplus)
 
27
extern "C" {
 
28
#endif
 
29
 
 
30
struct st_io_cache;
 
31
typedef int (*IO_CACHE_CALLBACK)(struct st_io_cache*);
 
32
 
 
33
typedef struct st_io_cache_share
 
34
{
 
35
  pthread_mutex_t       mutex;           /* To sync on reads into buffer. */
 
36
  pthread_cond_t        cond;            /* To wait for signals. */
 
37
  pthread_cond_t        cond_writer;     /* For a synchronized writer. */
 
38
  /* Offset in file corresponding to the first byte of buffer. */
 
39
  my_off_t              pos_in_file;
 
40
  /* If a synchronized write cache is the source of the data. */
 
41
  struct st_io_cache    *source_cache;
 
42
  unsigned char                 *buffer;         /* The read buffer. */
 
43
  unsigned char                 *read_end;       /* Behind last valid byte of buffer. */
 
44
  int                   running_threads; /* threads not in lock. */
 
45
  int                   total_threads;   /* threads sharing the cache. */
 
46
  int                   error;           /* Last error. */
 
47
} IO_CACHE_SHARE;
 
48
 
 
49
typedef struct st_io_cache    /* Used when cacheing files */
 
50
{
 
51
  /* Offset in file corresponding to the first byte of unsigned char* buffer. */
 
52
  my_off_t pos_in_file;
 
53
  /*
 
54
    The offset of end of file for READ_CACHE and WRITE_CACHE.
 
55
    For SEQ_READ_APPEND it the maximum of the actual end of file and
 
56
    the position represented by read_end.
 
57
  */
 
58
  my_off_t end_of_file;
 
59
  /* Points to current read position in the buffer */
 
60
  unsigned char  *read_pos;
 
61
  /* the non-inclusive boundary in the buffer for the currently valid read */
 
62
  unsigned char  *read_end;
 
63
  unsigned char  *buffer;        /* The read buffer */
 
64
  /* Used in ASYNC_IO */
 
65
  unsigned char  *request_pos;
 
66
 
 
67
  /* Only used in WRITE caches and in SEQ_READ_APPEND to buffer writes */
 
68
  unsigned char  *write_buffer;
 
69
  /*
 
70
    Only used in SEQ_READ_APPEND, and points to the current read position
 
71
    in the write buffer. Note that reads in SEQ_READ_APPEND caches can
 
72
    happen from both read buffer (unsigned char* buffer) and write buffer
 
73
    (unsigned char* write_buffer).
 
74
  */
 
75
  unsigned char *append_read_pos;
 
76
  /* Points to current write position in the write buffer */
 
77
  unsigned char *write_pos;
 
78
  /* The non-inclusive boundary of the valid write area */
 
79
  unsigned char *write_end;
 
80
 
 
81
  /*
 
82
    Current_pos and current_end are convenience variables used by
 
83
    my_b_tell() and other routines that need to know the current offset
 
84
    current_pos points to &write_pos, and current_end to &write_end in a
 
85
    WRITE_CACHE, and &read_pos and &read_end respectively otherwise
 
86
  */
 
87
  unsigned char  **current_pos, **current_end;
 
88
  /*
 
89
    The lock is for append buffer used in SEQ_READ_APPEND cache
 
90
    need mutex copying from append buffer to read buffer.
 
91
  */
 
92
  pthread_mutex_t append_buffer_lock;
 
93
  /*
 
94
    The following is used when several threads are reading the
 
95
    same file in parallel. They are synchronized on disk
 
96
    accesses reading the cached part of the file asynchronously.
 
97
    It should be set to NULL to disable the feature.  Only
 
98
    READ_CACHE mode is supported.
 
99
  */
 
100
  IO_CACHE_SHARE *share;
 
101
  /*
 
102
    A caller will use my_b_read() macro to read from the cache
 
103
    if the data is already in cache, it will be simply copied with
 
104
    memcpy() and internal variables will be accordinging updated with
 
105
    no functions invoked. However, if the data is not fully in the cache,
 
106
    my_b_read() will call read_function to fetch the data. read_function
 
107
    must never be invoked directly.
 
108
  */
 
109
  int (*read_function)(struct st_io_cache *,unsigned char *,size_t);
 
110
  /*
 
111
    Same idea as in the case of read_function, except my_b_write() needs to
 
112
    be replaced with my_b_append() for a SEQ_READ_APPEND cache
 
113
  */
 
114
  int (*write_function)(struct st_io_cache *,const unsigned char *,size_t);
 
115
  /*
 
116
    Specifies the type of the cache. Depending on the type of the cache
 
117
    certain operations might not be available and yield unpredicatable
 
118
    results. Details to be documented later
 
119
  */
 
120
  enum cache_type type;
 
121
  int error;
 
122
  /*
 
123
    Callbacks when the actual read I/O happens. These were added and
 
124
    are currently used for binary logging of LOAD DATA INFILE - when a
 
125
    block is read from the file, we create a block create/append event, and
 
126
    when IO_CACHE is closed, we create an end event. These functions could,
 
127
    of course be used for other things
 
128
  */
 
129
  IO_CACHE_CALLBACK pre_read;
 
130
  IO_CACHE_CALLBACK post_read;
 
131
  IO_CACHE_CALLBACK pre_close;
 
132
  void* arg;        /* for use by pre/post_read */
 
133
  char *file_name;      /* if used with 'open_cached_file' */
 
134
  char *dir,*prefix;
 
135
  File file; /* file descriptor */
 
136
  /*
 
137
    seek_not_done is set by my_b_seek() to inform the upcoming read/write
 
138
    operation that a seek needs to be preformed prior to the actual I/O
 
139
    error is 0 if the cache operation was successful, -1 if there was a
 
140
    "hard" error, and the actual number of I/O-ed bytes if the read/write was
 
141
    partial.
 
142
  */
 
143
  int  seek_not_done;
 
144
  /* buffer_length is memory size allocated for buffer or write_buffer */
 
145
  size_t  buffer_length;
 
146
  /* read_length is the same as buffer_length except when we use async io */
 
147
  size_t  read_length;
 
148
  myf  myflags;      /* Flags used to my_read/my_write */
 
149
  /*
 
150
    alloced_buffer is 1 if the buffer was allocated by init_io_cache() and
 
151
    0 if it was supplied by the user.
 
152
    Currently READ_NET is the only one that will use a buffer allocated
 
153
    somewhere else
 
154
  */
 
155
  bool alloced_buffer;
 
156
#ifdef HAVE_AIOWAIT
 
157
  /*
 
158
    As inidicated by ifdef, this is for async I/O, which is not currently
 
159
    used (because it's not reliable on all systems)
 
160
  */
 
161
  uint32_t inited;
 
162
  my_off_t aio_read_pos;
 
163
  my_aio_result aio_result;
 
164
#endif
 
165
} IO_CACHE;
 
166
 
 
167
extern int init_io_cache(IO_CACHE *info,File file,size_t cachesize,
 
168
                         enum cache_type type,my_off_t seek_offset,
 
169
                         bool use_async_io, myf cache_myflags);
 
170
extern bool reinit_io_cache(IO_CACHE *info,enum cache_type type,
 
171
                            my_off_t seek_offset,bool use_async_io,
 
172
                            bool clear_cache);
 
173
extern void setup_io_cache(IO_CACHE* info);
 
174
extern void init_io_cache_share(IO_CACHE *read_cache, IO_CACHE_SHARE *cshare,
 
175
                                IO_CACHE *write_cache, uint32_t num_threads);
 
176
extern void remove_io_thread(IO_CACHE *info);
 
177
extern int _my_b_get(IO_CACHE *info);
 
178
extern int _my_b_async_read(IO_CACHE *info,unsigned char *Buffer,size_t Count);
 
179
 
 
180
extern int my_block_write(IO_CACHE *info, const unsigned char *Buffer,
 
181
                          size_t Count, my_off_t pos);
 
182
extern int my_b_flush_io_cache(IO_CACHE *info, int need_append_buffer_lock);
 
183
 
 
184
#define flush_io_cache(info) my_b_flush_io_cache((info),1)
 
185
 
 
186
extern int end_io_cache(IO_CACHE *info);
 
187
extern bool open_cached_file(IO_CACHE *cache,const char *dir,
 
188
                             const char *prefix, size_t cache_size,
 
189
                             myf cache_myflags);
 
190
extern bool real_open_cached_file(IO_CACHE *cache);
 
191
extern void close_cached_file(IO_CACHE *cache);
 
192
 
 
193
#if defined(__cplusplus)
 
194
}
 
195
#endif
 
196
 
 
197
#endif /* MYSYS_IOCACHE_H */