8
0
mirror of https://github.com/FirebirdSQL/firebird.git synced 2025-01-27 18:03:04 +01:00
firebird-mirror/src/jrd/btn.h
brodsom 75a0483d75 -Comment some common.h unused macros
-Replace VA_START macro with va_start function (it was already some places where it is not used)
2004-05-23 23:28:06 +00:00

115 lines
3.6 KiB
C++

/*
* PROGRAM: JRD Access Method
* MODULE: btn.h
* DESCRIPTION: B-tree management code
*
* The contents of this file are subject to the Initial
* Developer's Public License Version 1.0 (the "License");
* you may not use this file except in compliance with the
* License. You may obtain a copy of the License at
* http://www.ibphoenix.com/main.nfs?a=ibphoenix&page=ibp_idpl.
*
* Software distributed under the License is distributed AS IS,
* WITHOUT WARRANTY OF ANY KIND, either express or implied.
* See the License for the specific language governing rights
* and limitations under the License.
*
* The Original Code was created by Arno Brinkman
* for the Firebird Open Source RDBMS project.
*
* Copyright (c) 2003 Arno Brinkman and all contributors
* signed below.
*
* All Rights Reserved.
* Contributor(s): ______________________________________.
*/
#ifndef JRD_BTN_H
#define JRD_BTN_H
#include "firebird.h" // needed for get_long
#include "memory_routines.h" // needed for get_long
#include "../jrd/common.h"
#include "../jrd/ods.h"
#include "../include/fb_vector.h"
#include "../common/classes/array.h"
// format of expanded index node, used for backwards navigation
struct btree_exp
{
UCHAR btx_previous_length; // AB: total size for previous node --length of data for previous node
UCHAR btx_btr_previous_length; // length of data for previous node on btree page
UCHAR btx_data[1]; // expanded data element
};
const int BTX_SIZE = 2;
const int BTN_END_LEVEL_FLAG = 1;
const int BTN_END_BUCKET_FLAG = 2;
const int BTN_DUPLICATE_FLAG = 3;
const int BTN_DUPLICATE_MARKER = 1;
// format of expanded index buffer
struct exp_index_buf
{
USHORT exp_length;
ULONG exp_incarnation;
btree_exp exp_nodes[1];
};
const size_t EXP_SIZE = OFFSETA (exp_index_buf*, exp_nodes);
struct dynKey
{
USHORT keyLength;
UCHAR* keyData;
};
typedef Firebird::vector<dynKey*> keyList;
typedef Firebird::HalfStaticArray<Ods::IndexJumpNode, 32> jumpNodeList;
namespace BTreeNode {
USHORT computePrefix(const UCHAR* prevString, USHORT prevLength,
const UCHAR* string, USHORT length);
SLONG findPageInDuplicates(const Ods::btree_page* page, UCHAR* pointer,
SLONG previousNumber, SLONG findRecordNumber);
USHORT getJumpNodeSize(const Ods::IndexJumpNode* jumpNode, SCHAR flags);
USHORT getNodeSize(const Ods::IndexNode* indexNode, SCHAR flags, bool leafNode = true);
UCHAR* getPointerFirstNode(Ods::btree_page* page, Ods::IndexJumpInfo* jumpInfo = NULL);
bool keyEquality(USHORT length, const UCHAR* data, const Ods::IndexNode* indexNode);
#ifdef SCROLLABLE_CURSORS
UCHAR* lastNode(btree_page* page, exp_index_buf* expanded_page, btree_exp** expanded_node);
#endif
UCHAR* nextNode(Ods::IndexNode* node, UCHAR* pointer,
SCHAR flags, btree_exp** expanded_node);
UCHAR* previousNode(Ods::IndexNode* node, UCHAR* pointer,
SCHAR flags, btree_exp** expanded_node);
void quad_put(SLONG value, UCHAR *data);
UCHAR* readJumpInfo(Ods::IndexJumpInfo* jumpInfo, UCHAR* pagePointer);
UCHAR* readJumpNode(Ods::IndexJumpNode* jumpNode, UCHAR* pagePointer, SCHAR flags);
UCHAR* readNode(Ods::IndexNode* indexNode, UCHAR* pagePointer, SCHAR flags,
bool leafNode);
UCHAR* writeJumpInfo(Ods::btree_page* page, const Ods::IndexJumpInfo* jumpInfo);
UCHAR* writeJumpNode(Ods::IndexJumpNode* jumpNode, UCHAR* pagePointer, SCHAR flags);
UCHAR* writeNode(Ods::IndexNode* indexNode, UCHAR* pagePointer, SCHAR flags,
bool leafNode, bool withData = true);
void setEndBucket(Ods::IndexNode* indexNode, bool leafNode = true);
void setEndLevel(Ods::IndexNode* indexNode, bool leafNode = true);
} // namespace BTreeNode
#endif // JRD_BTN_H