drizzle
C++ MySQL-protocol-compatible database server
Loading...
Searching...
No Matches
btr0pcur.h
Go to the documentation of this file.
1/*****************************************************************************
2
3Copyright (C) 1996, 2010, Innobase Oy. All Rights Reserved.
4
5This program is free software; you can redistribute it and/or modify it under
6the terms of the GNU General Public License as published by the Free Software
7Foundation; version 2 of the License.
8
9This program is distributed in the hope that it will be useful, but WITHOUT
10ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
11FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
12
13You should have received a copy of the GNU General Public License along with
14this program; if not, write to the Free Software Foundation, Inc., 51 Franklin
15St, Fifth Floor, Boston, MA 02110-1301 USA
16
17*****************************************************************************/
18
19/**************************************************/
25
26#pragma once
27#ifndef btr0pcur_h
28#define btr0pcur_h
29
30#include "univ.i"
31#include "dict0dict.h"
32#include "data0data.h"
33#include "mtr0mtr.h"
34#include "page0cur.h"
35#include "btr0cur.h"
36#include "btr0btr.h"
37#include "btr0types.h"
38
39/* Relative positions for a stored cursor position */
40#define BTR_PCUR_ON 1
41#define BTR_PCUR_BEFORE 2
42#define BTR_PCUR_AFTER 3
43/* Note that if the tree is not empty, btr_pcur_store_position does not
44use the following, but only uses the above three alternatives, where the
45position is stored relative to a specific record: this makes implementation
46of a scroll cursor easier */
47#define BTR_PCUR_BEFORE_FIRST_IN_TREE 4 /* in an empty tree */
48#define BTR_PCUR_AFTER_LAST_IN_TREE 5 /* in an empty tree */
49
50/**************************************************************/
53UNIV_INTERN
56/*============================*/
57/**************************************************************/
59UNIV_INTERN
60void
62/*====================*/
63 btr_pcur_t* cursor);
64/**************************************************************/
66UNIV_INTERN
67void
69/*==========================*/
70 btr_pcur_t* pcur_receive,
72 btr_pcur_t* pcur_donate);
74/**************************************************************/
76UNIV_INLINE
77void
79/*==========*/
80 btr_pcur_t* pcur);
81/**************************************************************/
84UNIV_INLINE
85void
87/*===============*/
88 dict_index_t* index,
89 const dtuple_t* tuple,
90 ulint mode,
96 ulint latch_mode,
97 btr_pcur_t* cursor,
98 const char* file,
99 ulint line,
100 mtr_t* mtr);
101#define btr_pcur_open(i,t,md,l,c,m) \
102 btr_pcur_open_func(i,t,md,l,c,__FILE__,__LINE__,m)
103/**************************************************************/
106UNIV_INLINE
107void
109/*============================*/
110 dict_index_t* index,
111 const dtuple_t* tuple,
112 ulint mode,
118 ulint latch_mode,
123 btr_pcur_t* cursor,
124 ulint has_search_latch,
127 const char* file,
128 ulint line,
129 mtr_t* mtr);
130#define btr_pcur_open_with_no_init(ix,t,md,l,cur,has,m) \
131 btr_pcur_open_with_no_init_func(ix,t,md,l,cur,has,__FILE__,__LINE__,m)
132
133/*****************************************************************/
135UNIV_INLINE
136void
138/*========================*/
139 ibool from_left,
141 dict_index_t* index,
142 ulint latch_mode,
143 btr_pcur_t* pcur,
144 ibool do_init,
145 mtr_t* mtr);
146/**************************************************************/
150UNIV_INLINE
151ulint
153/*==================*/
154 const btr_pcur_t* cursor);
155/**************************************************************/
159UNIV_INLINE
160ulint
162/*===================*/
163 const btr_pcur_t* cursor);
164/**************************************************************/
171UNIV_INTERN
172void
174/*===========================*/
175 dict_index_t* index,
176 const dtuple_t* tuple,
177 ulint mode,
178 ulint latch_mode,
180 btr_pcur_t* cursor,
182 const char* file,
183 ulint line,
184 mtr_t* mtr);
185#define btr_pcur_open_on_user_rec(i,t,md,l,c,m) \
186 btr_pcur_open_on_user_rec_func(i,t,md,l,c,__FILE__,__LINE__,m)
187/**********************************************************************/
189UNIV_INLINE
190void
192/*==========================*/
193 dict_index_t* index,
194 ulint latch_mode,
195 btr_pcur_t* cursor,
196 const char* file,
197 ulint line,
198 mtr_t* mtr);
199#define btr_pcur_open_at_rnd_pos(i,l,c,m) \
200 btr_pcur_open_at_rnd_pos_func(i,l,c,__FILE__,__LINE__,m)
201/**************************************************************/
204UNIV_INLINE
205void
207/*===========*/
208 btr_pcur_t* cursor);
209/**************************************************************/
216UNIV_INTERN
217void
219/*====================*/
220 btr_pcur_t* cursor,
221 mtr_t* mtr);
222/**************************************************************/
237UNIV_INTERN
238ibool
240/*===========================*/
241 ulint latch_mode,
242 btr_pcur_t* cursor,
243 const char* file,
244 ulint line,
245 mtr_t* mtr);
246#define btr_pcur_restore_position(l,cur,mtr) \
247 btr_pcur_restore_position_func(l,cur,__FILE__,__LINE__,mtr)
248/**************************************************************/
254UNIV_INTERN
255void
257/*==================*/
258 btr_pcur_t* cursor,
259 mtr_t* mtr);
260/*********************************************************/
263UNIV_INLINE
264ulint
266/*=================*/
267 const btr_pcur_t* cursor);
268/**************************************************************/
274UNIV_INLINE
275void
277/*========================*/
278 btr_pcur_t* pcur,
279 mtr_t* mtr);
280/*********************************************************/
284UNIV_INLINE
285ibool
287/*==================*/
288 btr_pcur_t* cursor,
290 mtr_t* mtr);
291/*********************************************************/
295UNIV_INTERN
296ibool
298/*==================*/
299 btr_pcur_t* cursor,
301 mtr_t* mtr);
302/*********************************************************/
304UNIV_INLINE
305void
307/*==========================*/
308 btr_pcur_t* cursor,
309 mtr_t* mtr);
310/*********************************************************/
314UNIV_INLINE
315ibool
317/*===========================*/
318 btr_pcur_t* cursor,
320 mtr_t* mtr);
321/*********************************************************/
326UNIV_INTERN
327void
329/*=======================*/
330 btr_pcur_t* cursor,
332 mtr_t* mtr);
333/*********************************************************/
343UNIV_INTERN
344void
346/*=============================*/
347 btr_pcur_t* cursor,
349 mtr_t* mtr);
350#ifdef UNIV_DEBUG
351/*********************************************************/
354UNIV_INLINE
356btr_pcur_get_btr_cur(
357/*=================*/
358 const btr_pcur_t* cursor);
359/*********************************************************/
362UNIV_INLINE
364btr_pcur_get_page_cur(
365/*==================*/
366 const btr_pcur_t* cursor);
367/*********************************************************/
370UNIV_INLINE
371page_t*
372btr_pcur_get_page(
373/*==============*/
374 const btr_pcur_t* cursor);
375/*********************************************************/
378UNIV_INLINE
380btr_pcur_get_block(
381/*===============*/
382 const btr_pcur_t* cursor);
383/*********************************************************/
386UNIV_INLINE
387rec_t*
388btr_pcur_get_rec(
389/*=============*/
390 const btr_pcur_t* cursor);
391#else /* UNIV_DEBUG */
392# define btr_pcur_get_btr_cur(cursor) (&(cursor)->btr_cur)
393# define btr_pcur_get_page_cur(cursor) (&(cursor)->btr_cur.page_cur)
394# define btr_pcur_get_page(cursor) ((cursor)->btr_cur.page_cur.block->frame)
395# define btr_pcur_get_block(cursor) ((cursor)->btr_cur.page_cur.block)
396# define btr_pcur_get_rec(cursor) ((cursor)->btr_cur.page_cur.rec)
397#endif /* UNIV_DEBUG */
398/*********************************************************/
400UNIV_INLINE
401ibool
403/*====================*/
404 const btr_pcur_t* cursor);
405/*********************************************************/
408UNIV_INLINE
409ibool
411/*===========================*/
412 const btr_pcur_t* cursor);
413/*********************************************************/
416UNIV_INLINE
417ibool
419/*=============================*/
420 const btr_pcur_t* cursor);
421/*********************************************************/
424UNIV_INLINE
425ibool
427/*=============================*/
428 btr_pcur_t* cursor,
429 mtr_t* mtr);
430/*********************************************************/
433UNIV_INLINE
434ibool
436/*===========================*/
437 btr_pcur_t* cursor,
438 mtr_t* mtr);
439/*********************************************************/
441UNIV_INLINE
442void
444/*==========================*/
445 btr_pcur_t* cursor);
446/*********************************************************/
448UNIV_INLINE
449void
451/*==========================*/
452 btr_pcur_t* cursor);
453
454
455/* The persistent B-tree cursor structure. This is used mainly for SQL
456selects, updates, and deletes. */
457
473 rec_t* old_rec;
478 ulint rel_pos;
482 buf_block_t* block_when_stored;/* buffer block when the position was
483 stored */
484 ib_uint64_t modify_clock;
487 ulint pos_state;
496 /*-----------------------------*/
497 /* NOTE that the following fields may possess dynamically allocated
498 memory which should be freed if not needed anymore! */
499
502 ulint buf_size;
504};
505
506#define BTR_PCUR_IS_POSITIONED 1997660512 /* TODO: currently, the state
507 can be BTR_PCUR_IS_POSITIONED,
508 though it really should be
509 BTR_PCUR_WAS_POSITIONED,
510 because we have no obligation
511 to commit the cursor with
512 mtr; similarly latch_mode may
513 be out of date. This can
514 lead to problems if btr_pcur
515 is not used the right way;
516 all current code should be
517 ok. */
518#define BTR_PCUR_WAS_POSITIONED 1187549791
519#define BTR_PCUR_NOT_POSITIONED 1328997689
520
521#define BTR_PCUR_OLD_STORED 908467085
522#define BTR_PCUR_OLD_NOT_STORED 122766467
523
524#ifndef UNIV_NONINL
525#include "btr0pcur.ic"
526#endif
527
528#endif
UNIV_INLINE void btr_pcur_commit_specify_mtr(btr_pcur_t *pcur, mtr_t *mtr)
UNIV_INLINE ibool btr_pcur_move_to_next_user_rec(btr_pcur_t *cursor, mtr_t *mtr)
UNIV_INLINE ibool btr_pcur_is_before_first_on_page(const btr_pcur_t *cursor)
UNIV_INLINE ibool btr_pcur_is_on_user_rec(const btr_pcur_t *cursor)
UNIV_INTERN btr_pcur_t * btr_pcur_create_for_mysql(void)
Definition btr0pcur.cc:41
UNIV_INTERN void btr_pcur_move_backward_from_page(btr_pcur_t *cursor, mtr_t *mtr)
Definition btr0pcur.cc:450
UNIV_INLINE void btr_pcur_init(btr_pcur_t *pcur)
UNIV_INLINE void btr_pcur_move_to_last_on_page(btr_pcur_t *cursor, mtr_t *mtr)
UNIV_INLINE void btr_pcur_move_to_next_on_page(btr_pcur_t *cursor)
UNIV_INTERN void btr_pcur_release_leaf(btr_pcur_t *cursor, mtr_t *mtr)
Definition btr0pcur.cc:369
UNIV_INLINE void btr_pcur_open_at_index_side(ibool from_left, dict_index_t *index, ulint latch_mode, btr_pcur_t *pcur, ibool do_init, mtr_t *mtr)
UNIV_INTERN void btr_pcur_free_for_mysql(btr_pcur_t *cursor)
Definition btr0pcur.cc:58
UNIV_INLINE ibool btr_pcur_is_after_last_on_page(const btr_pcur_t *cursor)
UNIV_INLINE void btr_pcur_move_to_prev_on_page(btr_pcur_t *cursor)
UNIV_INLINE ulint btr_pcur_get_rel_pos(const btr_pcur_t *cursor)
UNIV_INLINE ulint btr_pcur_get_low_match(const btr_pcur_t *cursor)
UNIV_INLINE ibool btr_pcur_move_to_next(btr_pcur_t *cursor, mtr_t *mtr)
UNIV_INTERN ibool btr_pcur_move_to_prev(btr_pcur_t *cursor, mtr_t *mtr)
Definition btr0pcur.cc:525
UNIV_INLINE void btr_pcur_open_with_no_init_func(dict_index_t *index, const dtuple_t *tuple, ulint mode, ulint latch_mode, btr_pcur_t *cursor, ulint has_search_latch, const char *file, ulint line, mtr_t *mtr)
UNIV_INLINE void btr_pcur_close(btr_pcur_t *cursor)
UNIV_INTERN void btr_pcur_open_on_user_rec_func(dict_index_t *index, const dtuple_t *tuple, ulint mode, ulint latch_mode, btr_pcur_t *cursor, const char *file, ulint line, mtr_t *mtr)
Definition btr0pcur.cc:562
UNIV_INLINE ibool btr_pcur_is_before_first_in_tree(btr_pcur_t *cursor, mtr_t *mtr)
UNIV_INTERN void btr_pcur_copy_stored_position(btr_pcur_t *pcur_receive, btr_pcur_t *pcur_donate)
Definition btr0pcur.cc:165
UNIV_INTERN void btr_pcur_move_to_next_page(btr_pcur_t *cursor, mtr_t *mtr)
Definition btr0pcur.cc:395
UNIV_INLINE ulint btr_pcur_get_up_match(const btr_pcur_t *cursor)
UNIV_INLINE void btr_pcur_open_at_rnd_pos_func(dict_index_t *index, ulint latch_mode, btr_pcur_t *cursor, const char *file, ulint line, mtr_t *mtr)
UNIV_INLINE void btr_pcur_open_func(dict_index_t *index, const dtuple_t *tuple, ulint mode, ulint latch_mode, btr_pcur_t *cursor, const char *file, ulint line, mtr_t *mtr)
UNIV_INTERN ibool btr_pcur_restore_position_func(ulint latch_mode, btr_pcur_t *cursor, const char *file, ulint line, mtr_t *mtr)
Definition btr0pcur.cc:208
UNIV_INTERN void btr_pcur_store_position(btr_pcur_t *cursor, mtr_t *mtr)
Definition btr0pcur.cc:89
UNIV_INLINE ibool btr_pcur_is_after_last_in_tree(btr_pcur_t *cursor, mtr_t *mtr)
struct btr_pcur_struct btr_pcur_t
Definition btr0types.h:36
struct btr_cur_struct btr_cur_t
Definition btr0types.h:38
struct buf_block_struct buf_block_t
Definition buf0types.h:33
struct page_cur_struct page_cur_t
Definition page0types.h:39
#define page_t
Definition page0types.h:35
byte * old_rec_buf
Definition btr0pcur.h:500
trx_t * trx_if_known
Definition btr0pcur.h:492
rec_t * old_rec
Definition btr0pcur.h:473
ulint search_mode
Definition btr0pcur.h:491
ib_uint64_t modify_clock
Definition btr0pcur.h:484
btr_cur_t btr_cur
Definition btr0pcur.h:459
ulint old_n_fields
Definition btr0pcur.h:477