mirror of
https://github.com/MariaDB/server.git
synced 2025-01-20 22:12:30 +01:00
41b29de7ac
------------------------------------------------------------------------
r5092 | marko | 2009-05-25 09:54:17 +0300 (Mon, 25 May 2009) | 1 line
branches/zip: Adjust some function comments after r5091.
------------------------------------------------------------------------
r5100 | marko | 2009-05-25 12:09:45 +0300 (Mon, 25 May 2009) | 1 line
branches/zip: Split some long lines that were introduced in r5091.
------------------------------------------------------------------------
r5101 | marko | 2009-05-25 12:42:47 +0300 (Mon, 25 May 2009) | 2 lines
branches/zip: Introduce the macro TEMP_INDEX_PREFIX_STR.
This is to avoid triggering an error in Doxygen.
------------------------------------------------------------------------
r5102 | marko | 2009-05-25 13:47:14 +0300 (Mon, 25 May 2009) | 1 line
branches/zip: Add missing file comments.
------------------------------------------------------------------------
r5103 | marko | 2009-05-25 13:52:29 +0300 (Mon, 25 May 2009) | 10 lines
branches/zip: Add @file comments, and convert decorative
/*********************************
comments to Doxygen /** style like this:
/*****************************//**
This conversion was performed by the following command:
perl -i -e 'while(<ARGV>){if (m|^/\*{30}\**$|) {
s|\*{4}$|//**| if ++$com>1; $_ .= "\@file $ARGV\n" if $com==2}
print; if(eof){$.=0;undef $com}}' */*[ch] include/univ.i
------------------------------------------------------------------------
r5104 | marko | 2009-05-25 14:39:07 +0300 (Mon, 25 May 2009) | 2 lines
branches/zip: Revert ut0auxconf_* to r5102,
that is, make Doxygen ignore these test programs.
------------------------------------------------------------------------
r5105 | marko | 2009-05-25 14:52:20 +0300 (Mon, 25 May 2009) | 2 lines
branches/zip: Enclose some #error checks inside #ifndef DOXYGEN
to prevent bogus Doxygen errors.
------------------------------------------------------------------------
r5106 | marko | 2009-05-25 16:09:24 +0300 (Mon, 25 May 2009) | 2 lines
branches/zip: Add some Doxygen comments, mainly to structs, typedefs,
macros and global variables. Many more to go.
------------------------------------------------------------------------
r5108 | marko | 2009-05-26 00:32:35 +0300 (Tue, 26 May 2009) | 2 lines
branches/zip: lexyy.c: Remove the inadvertently added @file directive.
There is nothing for Doxygen to see in this file, move along.
------------------------------------------------------------------------
r5125 | marko | 2009-05-26 16:28:49 +0300 (Tue, 26 May 2009) | 3 lines
branches/zip: Add some Doxygen comments for many structs, typedefs,
#defines and global variables. Many are still missing.
------------------------------------------------------------------------
r5134 | marko | 2009-05-27 09:08:43 +0300 (Wed, 27 May 2009) | 1 line
branches/zip: Add some Doxygen @return comments.
------------------------------------------------------------------------
r5139 | marko | 2009-05-27 10:01:40 +0300 (Wed, 27 May 2009) | 1 line
branches/zip: Add Doxyfile.
------------------------------------------------------------------------
r5143 | marko | 2009-05-27 10:57:25 +0300 (Wed, 27 May 2009) | 3 lines
branches/zip: buf0buf.h, Doxyfile: Fix the Doxygen translation.
@defgroup is for source code modules, not for field groups.
Tell Doxygen to expand the UT_LIST declarations.
------------------------------------------------------------------------
150 lines
5.2 KiB
C
150 lines
5.2 KiB
C
/*****************************************************************************
|
|
|
|
Copyright (c) 1996, 2009, Innobase Oy. All Rights Reserved.
|
|
|
|
This program is free software; you can redistribute it and/or modify it under
|
|
the terms of the GNU General Public License as published by the Free Software
|
|
Foundation; version 2 of the License.
|
|
|
|
This program is distributed in the hope that it will be useful, but WITHOUT
|
|
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
|
|
FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
|
|
|
|
You should have received a copy of the GNU General Public License along with
|
|
this program; if not, write to the Free Software Foundation, Inc., 59 Temple
|
|
Place, Suite 330, Boston, MA 02111-1307 USA
|
|
|
|
*****************************************************************************/
|
|
|
|
/**************************************************//**
|
|
@file include/dict0boot.h
|
|
Data dictionary creation and booting
|
|
|
|
Created 4/18/1996 Heikki Tuuri
|
|
*******************************************************/
|
|
|
|
#ifndef dict0boot_h
|
|
#define dict0boot_h
|
|
|
|
#include "univ.i"
|
|
|
|
#include "mtr0mtr.h"
|
|
#include "mtr0log.h"
|
|
#include "ut0byte.h"
|
|
#include "buf0buf.h"
|
|
#include "fsp0fsp.h"
|
|
#include "dict0dict.h"
|
|
|
|
typedef byte dict_hdr_t;
|
|
|
|
/**********************************************************************//**
|
|
Gets a pointer to the dictionary header and x-latches its page.
|
|
@return pointer to the dictionary header, page x-latched */
|
|
UNIV_INTERN
|
|
dict_hdr_t*
|
|
dict_hdr_get(
|
|
/*=========*/
|
|
mtr_t* mtr); /*!< in: mtr */
|
|
/**********************************************************************//**
|
|
Returns a new row, table, index, or tree id.
|
|
@return the new id */
|
|
UNIV_INTERN
|
|
dulint
|
|
dict_hdr_get_new_id(
|
|
/*================*/
|
|
ulint type); /*!< in: DICT_HDR_ROW_ID, ... */
|
|
/**********************************************************************//**
|
|
Returns a new row id.
|
|
@return the new id */
|
|
UNIV_INLINE
|
|
dulint
|
|
dict_sys_get_new_row_id(void);
|
|
/*=========================*/
|
|
/**********************************************************************//**
|
|
Reads a row id from a record or other 6-byte stored form.
|
|
@return row id */
|
|
UNIV_INLINE
|
|
dulint
|
|
dict_sys_read_row_id(
|
|
/*=================*/
|
|
byte* field); /*!< in: record field */
|
|
/**********************************************************************//**
|
|
Writes a row id to a record or other 6-byte stored form. */
|
|
UNIV_INLINE
|
|
void
|
|
dict_sys_write_row_id(
|
|
/*==================*/
|
|
byte* field, /*!< in: record field */
|
|
dulint row_id);/*!< in: row id */
|
|
/*****************************************************************//**
|
|
Initializes the data dictionary memory structures when the database is
|
|
started. This function is also called when the data dictionary is created. */
|
|
UNIV_INTERN
|
|
void
|
|
dict_boot(void);
|
|
/*===========*/
|
|
/*****************************************************************//**
|
|
Creates and initializes the data dictionary at the database creation. */
|
|
UNIV_INTERN
|
|
void
|
|
dict_create(void);
|
|
/*=============*/
|
|
|
|
|
|
/* Space id and page no where the dictionary header resides */
|
|
#define DICT_HDR_SPACE 0 /* the SYSTEM tablespace */
|
|
#define DICT_HDR_PAGE_NO FSP_DICT_HDR_PAGE_NO
|
|
|
|
/* The ids for the basic system tables and their indexes */
|
|
#define DICT_TABLES_ID ut_dulint_create(0, 1)
|
|
#define DICT_COLUMNS_ID ut_dulint_create(0, 2)
|
|
#define DICT_INDEXES_ID ut_dulint_create(0, 3)
|
|
#define DICT_FIELDS_ID ut_dulint_create(0, 4)
|
|
/* The following is a secondary index on SYS_TABLES */
|
|
#define DICT_TABLE_IDS_ID ut_dulint_create(0, 5)
|
|
|
|
#define DICT_HDR_FIRST_ID 10 /* the ids for tables etc. start
|
|
from this number, except for basic
|
|
system tables and their above defined
|
|
indexes; ibuf tables and indexes are
|
|
assigned as the id the number
|
|
DICT_IBUF_ID_MIN plus the space id */
|
|
#define DICT_IBUF_ID_MIN ut_dulint_create(0xFFFFFFFFUL, 0)
|
|
|
|
/* The offset of the dictionary header on the page */
|
|
#define DICT_HDR FSEG_PAGE_DATA
|
|
|
|
/*-------------------------------------------------------------*/
|
|
/* Dictionary header offsets */
|
|
#define DICT_HDR_ROW_ID 0 /* The latest assigned row id */
|
|
#define DICT_HDR_TABLE_ID 8 /* The latest assigned table id */
|
|
#define DICT_HDR_INDEX_ID 16 /* The latest assigned index id */
|
|
#define DICT_HDR_MIX_ID 24 /* Obsolete, always 0. */
|
|
#define DICT_HDR_TABLES 32 /* Root of the table index tree */
|
|
#define DICT_HDR_TABLE_IDS 36 /* Root of the table index tree */
|
|
#define DICT_HDR_COLUMNS 40 /* Root of the column index tree */
|
|
#define DICT_HDR_INDEXES 44 /* Root of the index index tree */
|
|
#define DICT_HDR_FIELDS 48 /* Root of the index field
|
|
index tree */
|
|
|
|
#define DICT_HDR_FSEG_HEADER 56 /* Segment header for the tablespace
|
|
segment into which the dictionary
|
|
header is created */
|
|
/*-------------------------------------------------------------*/
|
|
|
|
/* The field number of the page number field in the sys_indexes table
|
|
clustered index */
|
|
#define DICT_SYS_INDEXES_PAGE_NO_FIELD 8
|
|
#define DICT_SYS_INDEXES_SPACE_NO_FIELD 7
|
|
#define DICT_SYS_INDEXES_TYPE_FIELD 6
|
|
|
|
/* When a row id which is zero modulo this number (which must be a power of
|
|
two) is assigned, the field DICT_HDR_ROW_ID on the dictionary header page is
|
|
updated */
|
|
#define DICT_HDR_ROW_ID_WRITE_MARGIN 256
|
|
|
|
#ifndef UNIV_NONINL
|
|
#include "dict0boot.ic"
|
|
#endif
|
|
|
|
#endif
|