~drizzle-trunk/drizzle/development

/*****************************************************************************

Copyright (C) 2007, 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., 51 Franklin

St, Fifth Floor, Boston, MA 02110-1301 USA

*****************************************************************************/

/**************************************************//**

@file include/lock0priv.h

Lock module internal structures and methods.

Created July 12, 2007 Vasil Dimov

*******************************************************/

#pragma once

#ifndef lock0priv_h

#define lock0priv_h

#ifndef LOCK_MODULE_IMPLEMENTATION

/* If you need to access members of the structures defined in this

file, please write appropriate functions that retrieve them and put

those functions in lock/ */

#error Do not include lock0priv.h outside of the lock/ module

#endif

#include "univ.i"

#include "dict0types.h"

#include "hash0hash.h"

#include "trx0types.h"

#include "ut0lst.h"

/** A table lock */

typedef struct lock_table_struct	lock_table_t;

/** A table lock */

struct lock_table_struct {

	dict_table_t*	table;		/*!< database table in dictionary

					cache */

	UT_LIST_NODE_T(lock_t)

			locks;		/*!< list of locks on the same

					table */

};

/** Record lock for a page */

typedef struct lock_rec_struct		lock_rec_t;

/** Record lock for a page */

struct lock_rec_struct {

	ulint	space;			/*!< space id */

	ulint	page_no;		/*!< page number */

	ulint	n_bits;			/*!< number of bits in the lock

					bitmap; NOTE: the lock bitmap is

					placed immediately after the

					lock struct */

};

/** Lock struct */

struct lock_struct {

	trx_t*		trx;		/*!< transaction owning the

					lock */

	UT_LIST_NODE_T(lock_t)

			trx_locks;	/*!< list of the locks of the

					transaction */

	ulint		type_mode;	/*!< lock type, mode, LOCK_GAP or

					LOCK_REC_NOT_GAP,

					LOCK_INSERT_INTENTION,

					wait flag, ORed */

	hash_node_t	hash;		/*!< hash chain node for a record

					lock */

	dict_index_t*	index;		/*!< index for a record lock */

	union {

		lock_table_t	tab_lock;/*!< table lock */

		lock_rec_t	rec_lock;/*!< record lock */

	} un_member;			/*!< lock details */

};

/*********************************************************************//**

Gets the type of a lock.

@return	LOCK_TABLE or LOCK_REC */

UNIV_INLINE

ulint

lock_get_type_low(

/*==============*/

	const lock_t*	lock);	/*!< in: lock */

/*********************************************************************//**

Gets the previous record lock set on a record.

@return	previous lock on the same record, NULL if none exists */

UNIV_INTERN

const lock_t*

lock_rec_get_prev(

/*==============*/

	const lock_t*	in_lock,/*!< in: record lock */

	ulint		heap_no);/*!< in: heap number of the record */

#ifndef UNIV_NONINL

#include "lock0priv.ic"

#endif

#endif /* lock0priv_h */