1
/* -*- mode: c++; c-basic-offset: 2; indent-tabs-mode: nil; -*-
2
* vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
4
* Copyright (C) 2008-2009 Sun Microsystems
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; version 2 of the License.
10
* This program is distributed in the hope that it will be useful,
11
* but WITHOUT ANY WARRANTY; without even the implied warranty of
12
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13
* GNU General Public License for more details.
15
* You should have received a copy of the GNU General Public License
16
* along with this program; if not, write to the Free Software
17
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
21
#include "drizzled/session.h"
22
#include "drizzled/optimizer/quick_range.h"
23
#include "drizzled/optimizer/quick_range_select.h"
24
#include "drizzled/sql_bitmap.h"
25
#include "drizzled/internal/m_string.h"
27
#include "drizzled/memory/multi_malloc.h"
35
optimizer::QuickRangeSelect::QuickRangeSelect(Session *session,
39
memory::Root *parent_alloc,
46
in_ror_merged_scan(false),
59
my_bitmap_map *bitmap= NULL;
64
key_part_info= head->key_info[index].key_part;
65
my_init_dynamic_array(&ranges, sizeof(optimizer::QuickRange*), 16, 16);
67
/* 'session' is not accessible in QuickRangeSelect::reset(). */
68
mrr_buf_size= session->variables.read_rnd_buff_size;
71
if (! no_alloc && ! parent_alloc)
73
// Allocates everything through the internal memroot
74
memory::init_sql_alloc(&alloc, session->variables.range_alloc_block_size, 0);
75
session->mem_root= &alloc;
79
memset(&alloc, 0, sizeof(alloc));
83
record= head->record[0];
84
save_read_set= head->read_set;
85
save_write_set= head->write_set;
87
/* Allocate a bitmap for used columns. Using memory::sql_alloc instead of malloc
88
simply as a "fix" to the MySQL 6.0 code that also free()s it at the
89
same time we destroy the mem_root.
92
bitmap= reinterpret_cast<my_bitmap_map*>(memory::sql_alloc(head->s->column_bitmap_size));
95
column_bitmap.setBitmap(NULL);
100
column_bitmap.init(bitmap, head->s->fields);
105
int optimizer::QuickRangeSelect::init()
107
if (cursor->inited != Cursor::NONE)
108
cursor->ha_index_or_rnd_end();
109
return (cursor->ha_index_init(index, 1));
113
void optimizer::QuickRangeSelect::range_end()
115
if (cursor->inited != Cursor::NONE)
116
cursor->ha_index_or_rnd_end();
120
optimizer::QuickRangeSelect::~QuickRangeSelect()
124
/* cursor is NULL for CPK scan on covering ROR-intersection */
131
cursor->extra(HA_EXTRA_NO_KEYREAD);
135
cursor->ha_external_lock(current_session, F_UNLCK);
140
delete_dynamic(&ranges); /* ranges are allocated in alloc */
141
free_root(&alloc,MYF(0));
143
head->column_bitmaps_set(save_read_set, save_write_set);
144
assert(mrr_buf_desc == NULL);
152
int optimizer::QuickRangeSelect::init_ror_merged_scan(bool reuse_handler)
154
Cursor *save_file= cursor, *org_file;
157
in_ror_merged_scan= 1;
160
if (init() || reset())
164
head->column_bitmaps_set(&column_bitmap, &column_bitmap);
168
/* Create a separate Cursor object for this quick select */
171
/* already have own 'Cursor' object. */
175
session= head->in_use;
176
if (! (cursor= head->cursor->clone(session->mem_root)))
179
Manually set the error flag. Note: there seems to be quite a few
180
places where a failure could cause the server to "hang" the client by
181
sending no response to a query. ATM those are not real errors because
182
the storage engine calls in question happen to never fail with the
183
existing storage engines.
185
my_error(ER_OUT_OF_RESOURCES, MYF(0));
186
/* Caller will free the memory */
190
head->column_bitmaps_set(&column_bitmap, &column_bitmap);
192
if (cursor->ha_external_lock(session, F_RDLCK))
195
if (init() || reset())
197
cursor->ha_external_lock(session, F_UNLCK);
202
last_rowid= cursor->ref;
206
We are only going to read key fields and call position() on 'cursor'
207
The following sets head->tmp_set to only use this key and then updates
208
head->read_set and head->write_set to use this bitmap.
209
The now bitmap is stored in 'column_bitmap' which is used in ::get_next()
211
org_file= head->cursor;
212
head->cursor= cursor;
213
/* We don't have to set 'head->keyread' here as the 'cursor' is unique */
214
if (! head->no_keyread)
217
head->mark_columns_used_by_index(index);
219
head->prepare_for_position();
220
head->cursor= org_file;
221
column_bitmap= *head->read_set;
222
head->column_bitmaps_set(&column_bitmap, &column_bitmap);
227
head->column_bitmaps_set(save_read_set, save_write_set);
234
void optimizer::QuickRangeSelect::save_last_pos()
236
cursor->position(record);
240
bool optimizer::QuickRangeSelect::unique_key_range() const
242
if (ranges.elements == 1)
244
optimizer::QuickRange *tmp= *((optimizer::QuickRange**)ranges.buffer);
245
if ((tmp->flag & (EQ_RANGE | NULL_RANGE)) == EQ_RANGE)
247
KEY *key=head->key_info+index;
248
return ((key->flags & (HA_NOSAME)) == HA_NOSAME &&
249
key->key_length == tmp->min_length);
256
int optimizer::QuickRangeSelect::reset()
258
uint32_t buf_size= 0;
259
unsigned char *mrange_buff= NULL;
261
HANDLER_BUFFER empty_buf;
263
cur_range= (optimizer::QuickRange**) ranges.buffer;
265
if (cursor->inited == Cursor::NONE && (error= cursor->ha_index_init(index, 1)))
270
/* Allocate buffer if we need one but haven't allocated it yet */
271
if (mrr_buf_size && ! mrr_buf_desc)
273
buf_size= mrr_buf_size;
274
while (buf_size && ! memory::multi_malloc(false,
276
sizeof(*mrr_buf_desc),
281
/* Try to shrink the buffers until both are 0. */
286
return HA_ERR_OUT_OF_MEM;
289
/* Initialize the Cursor buffer. */
290
mrr_buf_desc->buffer= mrange_buff;
291
mrr_buf_desc->buffer_end= mrange_buff + buf_size;
292
mrr_buf_desc->end_of_used_area= mrange_buff;
297
empty_buf.buffer= NULL;
298
empty_buf.buffer_end= NULL;
299
empty_buf.end_of_used_area= NULL;
304
mrr_flags|= HA_MRR_SORTED;
306
RANGE_SEQ_IF seq_funcs= {
307
optimizer::quick_range_seq_init,
308
optimizer::quick_range_seq_next
310
error= cursor->multi_range_read_init(&seq_funcs,
314
mrr_buf_desc ? mrr_buf_desc : &empty_buf);
319
int optimizer::QuickRangeSelect::get_next()
322
if (in_ror_merged_scan)
325
We don't need to signal the bitmap change as the bitmap is always the
326
same for this head->cursor
328
head->column_bitmaps_set(&column_bitmap, &column_bitmap);
331
int result= cursor->multi_range_read_next(&dummy);
333
if (in_ror_merged_scan)
335
/* Restore bitmaps set on entry */
336
head->column_bitmaps_set(save_read_set, save_write_set);
342
int optimizer::QuickRangeSelect::get_next_prefix(uint32_t prefix_length,
343
key_part_map keypart_map,
344
unsigned char *cur_prefix)
349
key_range start_key, end_key;
352
/* Read the next record in the same range with prefix after cur_prefix. */
353
assert(cur_prefix != 0);
354
result= cursor->index_read_map(record,
358
if (result || (cursor->compare_key(cursor->end_range) <= 0))
362
uint32_t count= ranges.elements - (cur_range - (optimizer::QuickRange**) ranges.buffer);
365
/* Ranges have already been used up before. None is left for read. */
367
return HA_ERR_END_OF_FILE;
369
last_range= *(cur_range++);
371
start_key.key= (const unsigned char*) last_range->min_key;
372
start_key.length= min(last_range->min_length, (uint16_t)prefix_length);
373
start_key.keypart_map= last_range->min_keypart_map & keypart_map;
374
start_key.flag= ((last_range->flag & NEAR_MIN) ? HA_READ_AFTER_KEY :
375
(last_range->flag & EQ_RANGE) ?
376
HA_READ_KEY_EXACT : HA_READ_KEY_OR_NEXT);
377
end_key.key= (const unsigned char*) last_range->max_key;
378
end_key.length= min(last_range->max_length, (uint16_t)prefix_length);
379
end_key.keypart_map= last_range->max_keypart_map & keypart_map;
381
We use READ_AFTER_KEY here because if we are reading on a key
382
prefix we want to find all keys with this prefix
384
end_key.flag= (last_range->flag & NEAR_MAX ? HA_READ_BEFORE_KEY :
387
result= cursor->read_range_first(last_range->min_keypart_map ? &start_key : 0,
388
last_range->max_keypart_map ? &end_key : 0,
389
test(last_range->flag & EQ_RANGE),
391
if (last_range->flag == (UNIQUE_RANGE | EQ_RANGE))
392
last_range= 0; // Stop searching
394
if (result != HA_ERR_END_OF_FILE)
396
last_range= 0; // No matching rows; go to next range
401
bool optimizer::QuickRangeSelect::row_in_ranges()
403
optimizer::QuickRange *res= NULL;
405
uint32_t max= ranges.elements - 1;
406
uint32_t mid= (max + min) / 2;
410
if (cmp_next(*(optimizer::QuickRange**)dynamic_array_ptr(&ranges, mid)))
412
/* current row value > mid->max */
417
mid= (min + max) / 2;
419
res= *(optimizer::QuickRange**)dynamic_array_ptr(&ranges, mid);
420
return (! cmp_next(res) && ! cmp_prev(res));
424
int optimizer::QuickRangeSelect::cmp_next(optimizer::QuickRange *range_arg)
426
if (range_arg->flag & NO_MAX_RANGE)
427
return 0; /* key can't be to large */
429
KEY_PART *key_part= key_parts;
430
uint32_t store_length;
432
for (unsigned char *key=range_arg->max_key, *end=key+range_arg->max_length;
434
key+= store_length, key_part++)
437
store_length= key_part->store_length;
438
if (key_part->null_bit)
442
if (! key_part->field->is_null())
446
else if (key_part->field->is_null())
448
key++; // Skip null byte
451
if ((cmp= key_part->field->key_cmp(key, key_part->length)) < 0)
456
return (range_arg->flag & NEAR_MAX) ? 1 : 0; // Exact match
460
int optimizer::QuickRangeSelect::cmp_prev(optimizer::QuickRange *range_arg)
462
if (range_arg->flag & NO_MIN_RANGE)
463
return 0; /* key can't be to small */
465
int cmp= key_cmp(key_part_info,
467
range_arg->min_length);
468
if (cmp > 0 || (cmp == 0 && (range_arg->flag & NEAR_MIN) == false))
470
return 1; // outside of range
474
void optimizer::QuickRangeSelect::add_info_string(String *str)
476
KEY *key_info= head->key_info + index;
477
str->append(key_info->name);
481
void optimizer::QuickRangeSelect::add_keys_and_lengths(String *key_names,
482
String *used_lengths)
486
KEY *key_info= head->key_info + index;
487
key_names->append(key_info->name);
488
length= internal::int64_t2str(max_used_key_length, buf, 10) - buf;
489
used_lengths->append(buf, length);
494
This is a hack: we inherit from QUICK_SELECT so that we can use the
495
get_next() interface, but we have to hold a pointer to the original
496
QUICK_SELECT because its data are used all over the place. What
497
should be done is to factor out the data that is needed into a base
498
class (QUICK_SELECT), and then have two subclasses (_ASC and _DESC)
499
which handle the ranges and implement the get_next() function. But
500
for now, this seems to work right at least.
502
optimizer::QuickSelectDescending::QuickSelectDescending(optimizer::QuickRangeSelect *q, uint32_t, bool *)
504
optimizer::QuickRangeSelect(*q)
506
optimizer::QuickRange **pr= (optimizer::QuickRange**) ranges.buffer;
507
optimizer::QuickRange **end_range= pr + ranges.elements;
508
for (; pr != end_range; pr++)
510
rev_ranges.push_back(*pr);
512
rev_it= rev_ranges.begin();
514
/* Remove EQ_RANGE flag for keys that are not using the full key */
515
for (vector<optimizer::QuickRange *>::iterator it= rev_ranges.begin();
516
it != rev_ranges.end();
519
optimizer::QuickRange *r= *it;
520
if ((r->flag & EQ_RANGE) &&
521
head->key_info[index].key_length != r->max_length)
526
q->dont_free= 1; // Don't free shared mem
531
int optimizer::QuickSelectDescending::get_next()
533
/* The max key is handled as follows:
534
* - if there is NO_MAX_RANGE, start at the end and move backwards
535
* - if it is an EQ_RANGE, which means that max key covers the entire
536
* key, go directly to the key and read through it (sorting backwards is
537
* same as sorting forwards)
538
* - if it is NEAR_MAX, go to the key or next, step back once, and
540
* - otherwise (not NEAR_MAX == include the key), go after the key,
541
* step back once, and move backwards
547
{ // Already read through key
548
result= ((last_range->flag & EQ_RANGE) ?
549
cursor->index_next_same(record, last_range->min_key,
550
last_range->min_length) :
551
cursor->index_prev(record));
554
if (cmp_prev(*(rev_it - 1)) == 0)
557
else if (result != HA_ERR_END_OF_FILE)
561
if (rev_it == rev_ranges.end())
563
return HA_ERR_END_OF_FILE; // All ranges used
568
if (last_range->flag & NO_MAX_RANGE) // Read last record
571
if ((local_error= cursor->index_last(record)))
572
return local_error; // Empty table
573
if (cmp_prev(last_range) == 0)
575
last_range= 0; // No match; go to next range
579
if (last_range->flag & EQ_RANGE)
581
result = cursor->index_read_map(record,
583
last_range->max_keypart_map,
588
assert(last_range->flag & NEAR_MAX ||
589
range_reads_after_key(last_range));
590
result= cursor->index_read_map(record,
592
last_range->max_keypart_map,
593
((last_range->flag & NEAR_MAX) ?
595
HA_READ_PREFIX_LAST_OR_PREV));
599
if (result != HA_ERR_KEY_NOT_FOUND && result != HA_ERR_END_OF_FILE)
601
last_range= 0; // Not found, to next range
604
if (cmp_prev(last_range) == 0)
606
if (last_range->flag == (UNIQUE_RANGE | EQ_RANGE))
607
last_range= 0; // Stop searching
608
return 0; // Found key is in range
610
last_range= 0; // To next range
616
* true if this range will require using HA_READ_AFTER_KEY
617
See comment in get_next() about this
619
bool optimizer::QuickSelectDescending::range_reads_after_key(optimizer::QuickRange *range_arg)
621
return ((range_arg->flag & (NO_MAX_RANGE | NEAR_MAX)) ||
622
! (range_arg->flag & EQ_RANGE) ||
623
head->key_info[index].key_length != range_arg->max_length) ? 1 : 0;
627
} /* namespace drizzled */