20
21
Functions for easy reading of records, possible through a cache
24
#include <drizzled/drizzled.h>
25
#include <drizzled/error.h>
26
#include <drizzled/internal/iocache.h>
27
#include <drizzled/internal/my_sys.h>
28
#include <drizzled/optimizer/range.h>
29
#include <drizzled/plugin/storage_engine.h>
30
#include <drizzled/records.h>
31
#include <drizzled/session.h>
32
#include <drizzled/table.h>
37
static int rr_sequential(ReadRecord *info);
38
static int rr_quick(ReadRecord *info);
39
static int rr_from_tempfile(ReadRecord *info);
40
static int rr_unpack_from_tempfile(ReadRecord *info);
41
static int rr_unpack_from_buffer(ReadRecord *info);
42
static int rr_from_pointers(ReadRecord *info);
43
static int rr_from_cache(ReadRecord *info);
23
#include <drizzled/server_includes.h>
25
static int rr_quick(READ_RECORD *info);
26
int rr_sequential(READ_RECORD *info);
27
static int rr_from_tempfile(READ_RECORD *info);
28
static int rr_unpack_from_tempfile(READ_RECORD *info);
29
static int rr_unpack_from_buffer(READ_RECORD *info);
30
static int rr_from_pointers(READ_RECORD *info);
31
static int rr_from_cache(READ_RECORD *info);
32
static int init_rr_cache(THD *thd, READ_RECORD *info);
44
33
static int rr_cmp(unsigned char *a,unsigned char *b);
45
static int rr_index_first(ReadRecord *info);
46
static int rr_index(ReadRecord *info);
48
void ReadRecord::init_reard_record_sequential()
50
read_record= rr_sequential;
53
int ReadRecord::init_read_record_idx(Session *,
58
table_arg->emptyRecord();
60
cursor= table->cursor;
61
record= table->getInsertRecord();
62
print_error= print_error_arg;
34
static int rr_index_first(READ_RECORD *info);
35
static int rr_index(READ_RECORD *info);
39
Initialize READ_RECORD structure to perform full index scan (in forward
40
direction) using read_record.read_record() interface.
42
This function has been added at late stage and is used only by
43
UPDATE/DELETE. Other statements perform index scans using
44
join_read_first/next functions.
46
@param info READ_RECORD structure to initialize.
47
@param thd Thread handle
48
@param table Table to be accessed
49
@param print_error If true, call table->file->print_error() if an error
50
occurs (except for end-of-records error)
51
@param idx index to scan
54
void init_read_record_idx(READ_RECORD *info,
55
THD *thd __attribute__((unused)),
57
bool print_error, uint32_t idx)
60
memset(info, 0, sizeof(*info));
62
info->file= table->file;
63
info->record= table->record[0];
64
info->print_error= print_error;
64
66
table->status=0; /* And it's always found */
65
if (not table->cursor->inited)
67
int error= table->cursor->startIndexScan(idx, 1);
67
if (!table->file->inited)
68
table->file->ha_index_init(idx, 1);
71
69
/* read_record will be changed to rr_index in rr_index_first */
72
read_record= rr_index_first;
70
info->read_record= rr_index_first;
78
int ReadRecord::init_read_record(Session *session_arg,
80
optimizer::SqlSelect *select_arg,
75
init_read_record is used to scan by using a number of different methods.
76
Which method to use is set-up in this call so that later calls to
77
the info->read_record will call the appropriate method using a function
80
There are five methods that relate completely to the sort function
81
filesort. The result of a filesort is retrieved using read_record
82
calls. The other two methods are used for normal table access.
84
The filesort will produce references to the records sorted, these
85
references can be stored in memory or in a temporary file.
87
The temporary file is normally used when the references doesn't fit into
88
a properly sized memory buffer. For most small queries the references
89
are stored in the memory buffer.
91
The temporary file is also used when performing an update where a key is
94
Methods used when ref's are in memory (using rr_from_pointers):
95
rr_unpack_from_buffer:
96
----------------------
97
This method is used when table->sort.addon_field is allocated.
98
This is allocated for most SELECT queries not involving any BLOB's.
99
In this case the records are fetched from a memory buffer.
102
Used when the above is not true, UPDATE, DELETE and so forth and
103
SELECT's involving BLOB's. It is also used when the addon_field
104
buffer is not allocated due to that its size was bigger than the
105
session variable max_length_for_sort_data.
106
In this case the record data is fetched from the handler using the
107
saved reference using the rnd_pos handler call.
109
Methods used when ref's are in a temporary file (using rr_from_tempfile)
110
rr_unpack_from_tempfile:
111
------------------------
112
Same as rr_unpack_from_buffer except that references are fetched from
113
temporary file. Should obviously not really happen other than in
114
strange configurations.
118
Same as rr_from_pointers except that references are fetched from
119
temporary file instead of from
122
This is a special variant of rr_from_tempfile that can be used for
123
handlers that is not using the HA_FAST_KEY_READ table flag. Instead
124
of reading the references one by one from the temporary file it reads
125
a set of them, sorts them and reads all of them into a buffer which
126
is then used for a number of subsequent calls to rr_from_cache.
127
It is only used for SELECT queries and a number of other conditions
130
All other accesses use either index access methods (rr_quick) or a full
131
table scan (rr_sequential).
134
rr_quick uses one of the QUICK_SELECT classes in opt_range.cc to
135
perform an index scan. There are loads of functionality hidden
136
in these quick classes. It handles all index scans of various kinds.
139
This is the most basic access method of a table using rnd_init,
140
rnd_next and rnd_end. No indexes are used.
142
void init_read_record(READ_RECORD *info,THD *thd, Table *table,
144
int use_record_cache, bool print_error)
84
internal::IO_CACHE *tempfile;
89
cursor= table->cursor;
90
forms= &table; /* Only one table */
148
memset(info, 0, sizeof(*info));
151
info->file= table->file;
152
info->forms= &info->table; /* Only one table */
154
if (table->s->tmp_table == NON_TRANSACTIONAL_TMP_TABLE &&
155
!table->sort.addon_field)
156
table->file->extra(HA_EXTRA_MMAP);
92
158
if (table->sort.addon_field)
94
rec_buf= table->sort.addon_buf;
95
ref_length= table->sort.addon_length;
160
info->rec_buf= table->sort.addon_buf;
161
info->ref_length= table->sort.addon_length;
100
record= table->getInsertRecord();
101
ref_length= table->cursor->ref_length;
166
info->record= table->record[0];
167
info->ref_length= table->file->ref_length;
104
print_error= print_error_arg;
105
ignore_not_found_rows= 0;
170
info->print_error=print_error;
171
info->ignore_not_found_rows= 0;
106
172
table->status=0; /* And it's always found */
108
if (select && my_b_inited(select->file))
110
tempfile= select->file;
174
if (select && my_b_inited(&select->file))
175
tempfile= &select->file;
114
177
tempfile= table->sort.io_cache;
117
178
if (tempfile && my_b_inited(tempfile)) // Test if ref-records was used
119
read_record= (table->sort.addon_field ?
120
rr_unpack_from_tempfile : rr_from_tempfile);
123
io_cache->reinit_io_cache(internal::READ_CACHE,0L,0,0);
124
ref_pos=table->cursor->ref;
125
if (!table->cursor->inited)
127
error= table->cursor->startTableScan(0);
180
info->read_record= (table->sort.addon_field ?
181
rr_unpack_from_tempfile : rr_from_tempfile);
182
info->io_cache=tempfile;
183
reinit_io_cache(info->io_cache,READ_CACHE,0L,0,0);
184
info->ref_pos=table->file->ref;
185
if (!table->file->inited)
186
table->file->ha_rnd_init(0);
133
189
table->sort.addon_field is checked because if we use addon fields,
135
191
and table->sort.io_cache is read sequentially
137
193
if (!table->sort.addon_field &&
138
session->variables.read_rnd_buff_size &&
139
!(table->cursor->getEngine()->check_flag(HTON_BIT_FAST_KEY_READ)) &&
140
(table->db_stat & HA_READ_ONLY ||
141
table->reginfo.lock_type <= TL_READ_NO_INSERT) &&
142
(uint64_t) table->getShare()->getRecordLength() * (table->cursor->stats.records+
143
table->cursor->stats.deleted) >
144
(uint64_t) MIN_FILE_LENGTH_TO_USE_ROW_CACHE &&
145
io_cache->end_of_file/ref_length * table->getShare()->getRecordLength() >
146
(internal::my_off_t) MIN_ROWS_TO_USE_TABLE_CACHE &&
147
!table->getShare()->blob_fields &&
148
ref_length <= MAX_REFLENGTH)
194
thd->variables.read_rnd_buff_size &&
195
!(table->file->ha_table_flags() & HA_FAST_KEY_READ) &&
196
(table->db_stat & HA_READ_ONLY ||
197
table->reginfo.lock_type <= TL_READ_NO_INSERT) &&
198
(uint64_t) table->s->reclength* (table->file->stats.records+
199
table->file->stats.deleted) >
200
(uint64_t) MIN_FILE_LENGTH_TO_USE_ROW_CACHE &&
201
info->io_cache->end_of_file/info->ref_length * table->s->reclength >
202
(my_off_t) MIN_ROWS_TO_USE_TABLE_CACHE &&
203
!table->s->blob_fields &&
204
info->ref_length <= MAX_REFLENGTH)
206
if (! init_rr_cache(thd, info))
152
read_record= rr_from_cache;
208
info->read_record=rr_from_cache;
156
212
else if (select && select->quick)
158
read_record= rr_quick;
214
info->read_record=rr_quick;
160
216
else if (table->sort.record_pointers)
162
error= table->cursor->startTableScan(0);
166
cache_pos=table->sort.record_pointers;
167
cache_end= cache_pos+ table->sort.found_records * ref_length;
168
read_record= (table->sort.addon_field ? rr_unpack_from_buffer : rr_from_pointers);
218
table->file->ha_rnd_init(0);
219
info->cache_pos=table->sort.record_pointers;
220
info->cache_end=info->cache_pos+
221
table->sort.found_records*info->ref_length;
222
info->read_record= (table->sort.addon_field ?
223
rr_unpack_from_buffer : rr_from_pointers);
172
read_record= rr_sequential;
173
error= table->cursor->startTableScan(1);
227
info->read_record=rr_sequential;
228
table->file->ha_rnd_init(1);
177
229
/* We can use record cache if we don't update dynamic length tables */
178
230
if (!table->no_cache &&
179
(use_record_cache > 0 ||
180
(int) table->reginfo.lock_type <= (int) TL_READ_WITH_SHARED_LOCKS ||
181
!(table->getShare()->db_options_in_use & HA_OPTION_PACK_RECORD)))
183
table->cursor->extra_opt(HA_EXTRA_CACHE, session->variables.read_buff_size);
231
(use_record_cache > 0 ||
232
(int) table->reginfo.lock_type <= (int) TL_READ_HIGH_PRIORITY ||
233
!(table->s->db_options_in_use & HA_OPTION_PACK_RECORD) ||
234
(use_record_cache < 0 &&
235
!(table->file->ha_table_flags() & HA_NOT_DELETE_WITH_CACHE))))
236
table->file->extra_opt(HA_EXTRA_CACHE, thd->variables.read_buff_size);
239
Do condition pushdown for UPDATE/DELETE.
240
TODO: Remove this from here as it causes two condition pushdown calls
241
when we're running a SELECT and the condition cannot be pushed down.
243
if (thd->variables.engine_condition_pushdown &&
244
select && select->cond &&
245
(select->cond->used_tables() & table->map) &&
246
!table->file->pushed_cond)
247
table->file->cond_push(select->cond);
188
250
} /* init_read_record */
191
void ReadRecord::end_read_record()
254
void end_read_record(READ_RECORD *info)
192
255
{ /* free cache if used */
195
global_read_rnd_buffer.sub(session->variables.read_rnd_buff_size);
258
free((char*) info->cache);
201
table->filesort_free_buffers();
202
(void) cursor->extra(HA_EXTRA_NO_CACHE);
203
if (read_record != rr_quick) // otherwise quick_range does it
204
(void) cursor->ha_index_or_rnd_end();
263
filesort_free_buffers(info->table,0);
264
(void) info->file->extra(HA_EXTRA_NO_CACHE);
265
if (info->read_record != rr_quick) // otherwise quick_range does it
266
(void) info->file->ha_index_or_rnd_end();
210
static int rr_handle_error(ReadRecord *info, int error)
271
static int rr_handle_error(READ_RECORD *info, int error)
212
273
if (error == HA_ERR_END_OF_FILE)
216
277
if (info->print_error)
217
info->table->print_error(error, MYF(0));
278
info->table->file->print_error(error, MYF(0));
218
279
if (error < 0) // Fix negative BDB errno
224
286
/** Read a record from head-database. */
225
static int rr_quick(ReadRecord *info)
288
static int rr_quick(READ_RECORD *info)
228
291
while ((tmp= info->select->quick->get_next()))
230
if (info->session->getKilled())
293
if (info->thd->killed)
232
295
my_error(ER_SERVER_SHUTDOWN, MYF(0));
480
/* cacheing of records from a database */
410
/* cacheing of records from a database */
411
bool ReadRecord::init_rr_cache()
482
static int init_rr_cache(THD *thd, READ_RECORD *info)
413
uint32_t local_rec_cache_size;
415
struct_length= 3 + MAX_REFLENGTH;
416
reclength= ALIGN_SIZE(table->getShare()->getRecordLength() + 1);
417
if (reclength < struct_length)
418
reclength= ALIGN_SIZE(struct_length);
420
error_offset= table->getShare()->getRecordLength();
421
cache_records= (session->variables.read_rnd_buff_size /
422
(reclength + struct_length));
423
local_rec_cache_size= cache_records * reclength;
424
rec_cache_size= cache_records * ref_length;
426
if (not global_read_rnd_buffer.add(session->variables.read_rnd_buff_size))
428
my_error(ER_OUT_OF_GLOBAL_READRNDMEMORY, MYF(ME_ERROR+ME_WAITTANG));
484
uint32_t rec_cache_size;
486
info->struct_length= 3+MAX_REFLENGTH;
487
info->reclength= ALIGN_SIZE(info->table->s->reclength+1);
488
if (info->reclength < info->struct_length)
489
info->reclength= ALIGN_SIZE(info->struct_length);
491
info->error_offset= info->table->s->reclength;
492
info->cache_records= (thd->variables.read_rnd_buff_size /
493
(info->reclength+info->struct_length));
494
rec_cache_size= info->cache_records*info->reclength;
495
info->rec_cache_size= info->cache_records*info->ref_length;
432
497
// We have to allocate one more byte to use uint3korr (see comments for it)
433
if (cache_records <= 2 ||
434
!(cache=(unsigned char*) malloc(local_rec_cache_size + cache_records * struct_length + 1)))
498
if (info->cache_records <= 2 ||
499
!(info->cache=(unsigned char*) my_malloc_lock(rec_cache_size+info->cache_records*
500
info->struct_length+1,
439
504
// Avoid warnings in qsort
440
memset(cache, 0, local_rec_cache_size + cache_records * struct_length + 1);
505
memset(info->cache, 0,
506
rec_cache_size+info->cache_records* info->struct_length+1);
442
read_positions= cache + local_rec_cache_size;
443
cache_pos= cache_end= cache;
508
info->read_positions=info->cache+rec_cache_size;
509
info->cache_pos=info->cache_end=info->cache;
446
511
} /* init_rr_cache */
448
static int rr_from_cache(ReadRecord *info)
514
static int rr_from_cache(READ_RECORD *info)
451
internal::my_off_t rest_of_file;
518
my_off_t rest_of_file;
453
520
unsigned char *position,*ref_position,*record_pos;
460
527
if (info->cache_pos[info->error_offset])
462
shortget(error,info->cache_pos);
463
if (info->print_error)
464
info->table->print_error(error,MYF(0));
529
shortget(error,info->cache_pos);
530
if (info->print_error)
531
info->table->file->print_error(error,MYF(0));
469
memcpy(info->record,info->cache_pos, (size_t) info->table->getShare()->getRecordLength());
536
memcpy(info->record,info->cache_pos,
537
(size_t) info->table->s->reclength);
471
info->cache_pos+= info->reclength;
539
info->cache_pos+=info->reclength;
472
540
return ((int) error);
474
542
length=info->rec_cache_size;
475
rest_of_file= info->io_cache->end_of_file - my_b_tell(info->io_cache);
476
if ((internal::my_off_t) length > rest_of_file)
543
rest_of_file=info->io_cache->end_of_file - my_b_tell(info->io_cache);
544
if ((my_off_t) length > rest_of_file)
478
545
length= (uint32_t) rest_of_file;
481
if (!length || my_b_read(info->io_cache, info->getCache(), length))
546
if (!length || my_b_read(info->io_cache,info->cache,length))
483
return -1; /* End of cursor */
548
return -1; /* End of file */
486
551
length/=info->ref_length;
487
position=info->getCache();
552
position=info->cache;
488
553
ref_position=info->read_positions;
489
for (uint32_t i= 0 ; i < length ; i++,position+=info->ref_length)
554
for (i=0 ; i < length ; i++,position+=info->ref_length)
491
556
memcpy(ref_position,position,(size_t) info->ref_length);
492
557
ref_position+=MAX_REFLENGTH;
493
558
int3store(ref_position,(long) i);
496
internal::my_qsort(info->read_positions, length, info->struct_length,
561
my_qsort(info->read_positions, length, info->struct_length,
499
564
position=info->read_positions;
500
for (uint32_t i= 0 ; i < length ; i++)
565
for (i=0 ; i < length ; i++)
502
memcpy(info->ref_pos, position, (size_t)info->ref_length);
567
memcpy(info->ref_pos,position,(size_t) info->ref_length);
503
568
position+=MAX_REFLENGTH;
504
569
record=uint3korr(position);
506
record_pos= info->getCache() + record * info->reclength;
507
if ((error=(int16_t) info->cursor->rnd_pos(record_pos,info->ref_pos)))
571
record_pos=info->cache+record*info->reclength;
572
if ((error=(int16_t) info->file->rnd_pos(record_pos,info->ref_pos)))
509
record_pos[info->error_offset]=1;
510
shortstore(record_pos,error);
574
record_pos[info->error_offset]=1;
575
shortstore(record_pos,error);
513
record_pos[info->error_offset]=0;
578
record_pos[info->error_offset]=0;
515
info->cache_end= (info->cache_pos= info->getCache())+length*info->reclength;
580
info->cache_end=(info->cache_pos=info->cache)+length*info->reclength;
517
582
} /* rr_from_cache */
519
585
static int rr_cmp(unsigned char *a,unsigned char *b)
521
587
if (a[0] != b[0])