File-based list utilities. More...

#include "univ.i"
#include "fil0fil.h"
#include "mtr0mtr.h"
#include "fut0lst.ic"

Classes
struct	flst_bnode_t
	In-memory representation of flst_base_node_t. More...

Typedefs
typedef byte	flst_base_node_t

typedef byte	flst_node_t

Functions
static void	flst_init (flst_base_node_t base, mtr_t mtr)
	Initializes a list base node. More...

void	flst_add_last (flst_base_node_t base, flst_node_t node, mtr_t *mtr)
	Adds a node as the last node in a list. More...

void	flst_add_first (flst_base_node_t base, flst_node_t node, mtr_t *mtr)
	Adds a node as the first node in a list. More...

void	flst_remove (flst_base_node_t base, flst_node_t node2, mtr_t *mtr)
	Removes a node. More...

static ulint	flst_get_len (const flst_base_node_t *base)
	Get the length of a list. More...

static fil_addr_t	flst_get_first (const flst_base_node_t base, mtr_t mtr)
	Gets list first node address. More...

static fil_addr_t	flst_get_last (const flst_base_node_t base, mtr_t mtr)
	Gets list last node address. More...

static fil_addr_t	flst_get_next_addr (const flst_node_t node, mtr_t mtr)
	Gets list next node address. More...

static fil_addr_t	flst_get_prev_addr (const flst_node_t node, mtr_t mtr)
	Gets list prev node address. More...

static void	flst_write_addr (fil_faddr_t faddr, fil_addr_t addr, mtr_t mtr)
	Writes a file address. More...

static fil_addr_t	flst_read_addr (const fil_faddr_t faddr, mtr_t mtr)
	Reads a file address. More...

void	flst_validate (const flst_base_node_t base, mtr_t mtr1)
	Validates a file-based list. More...

void	flst_insert_after (flst_base_node_t base, flst_node_t node1, flst_node_t node2, mtr_t mtr)
	Inserts a node after another in a list. More...

void	flst_insert_before (flst_base_node_t base, flst_node_t node2, flst_node_t node3, mtr_t mtr)
	Inserts a node before another in a list. More...

std::ostream &	operator<< (std::ostream &out, const flst_bnode_t &obj)

Variables
constexpr ulint	FLST_BASE_NODE_SIZE = 4 + 2 * FIL_ADDR_SIZE

constexpr ulint	FLST_NODE_SIZE = 2 * FIL_ADDR_SIZE

Detailed Description

File-based list utilities.

Created 11/28/1995 Heikki Tuuri

Typedef Documentation

◆ flst_base_node_t

typedef byte flst_base_node_t

◆ flst_node_t

typedef byte flst_node_t

Function Documentation

◆ flst_add_first()

void flst_add_first	(	flst_base_node_t *	base,
		flst_node_t *	node,
		mtr_t *	mtr
	)

Adds a node as the first node in a list.

Parameters

[in]	base	Pointer to base node of list
[in]	node	Node to add
[in]	mtr	Mini-transaction handle

◆ flst_add_last()

void flst_add_last	(	flst_base_node_t *	base,
		flst_node_t *	node,
		mtr_t *	mtr
	)

Adds a node as the last node in a list.

Parameters

[in]	base	Pointer to base node of list
[in]	node	Node to add
[in]	mtr	Mini-transaction handle

◆ flst_get_first()

static fil_addr_t flst_get_first	(	const flst_base_node_t *	base,
		mtr_t *	mtr
	)

inlinestatic

Gets list first node address.

Parameters

[in]	base	Pointer to base node
[in]	mtr	Mini-transaction handle

Returns: file address

◆ flst_get_last()

static fil_addr_t flst_get_last	(	const flst_base_node_t *	base,
		mtr_t *	mtr
	)

inlinestatic

Gets list last node address.

Parameters

[in]	base	Pointer to base node
[in]	mtr	Mini-transaction handle

Returns: file address

◆ flst_get_len()

static ulint flst_get_len ( const flst_base_node_t * base )

inlinestatic

Get the length of a list.

Parameters

[in] base base node

Returns: length

◆ flst_get_next_addr()

static fil_addr_t flst_get_next_addr	(	const flst_node_t *	node,
		mtr_t *	mtr
	)

inlinestatic

Gets list next node address.

Parameters

[in]	node	Pointer to node
[in]	mtr	Mini-transaction handle

Returns: file address

◆ flst_get_prev_addr()

static fil_addr_t flst_get_prev_addr	(	const flst_node_t *	node,
		mtr_t *	mtr
	)

inlinestatic

Gets list prev node address.

Parameters

[in]	node	Pointer to node
[in]	mtr	Mini-transaction handle

Returns: file address

◆ flst_init()

static void flst_init	(	flst_base_node_t *	base,
		mtr_t *	mtr
	)

inlinestatic

Initializes a list base node.

Parameters

[in]	base	Pointer to base node
[in]	mtr	Mini-transaction handle

◆ flst_insert_after()

void flst_insert_after	(	flst_base_node_t *	base,
		flst_node_t *	node1,
		flst_node_t *	node2,
		mtr_t *	mtr
	)

Inserts a node after another in a list.

Parameters

[in]	base	Pointer to base node of list
[in]	node1	Node to insert after
[in]	node2	Node to add
[in]	mtr	Mini-transaction handle.

in: mini-transaction handle

Parameters

base	in: pointer to base node of list
node1	in: node to insert after
node2	in: node to add
mtr	in: mini-transaction handle

◆ flst_insert_before()

void flst_insert_before	(	flst_base_node_t *	base,
		flst_node_t *	node2,
		flst_node_t *	node3,
		mtr_t *	mtr
	)

Inserts a node before another in a list.

Parameters

[in]	base	Pointer to base node of list
[in]	node2	Node to insert
[in]	node3	Node to insert before
[in]	mtr	Mini-transaction handle.

in: mini-transaction handle

Parameters

base	in: pointer to base node of list
node2	in: node to insert
node3	in: node to insert before
mtr	in: mini-transaction handle

◆ flst_read_addr()

static fil_addr_t flst_read_addr	(	const fil_faddr_t *	faddr,
		mtr_t *	mtr
	)

inlinestatic

Reads a file address.

Parameters

[in]	faddr	Pointer to file faddress
[in]	mtr	Mini-transaction handle

Returns: file address

◆ flst_remove()

void flst_remove	(	flst_base_node_t *	base,
		flst_node_t *	node2,
		mtr_t *	mtr
	)

Removes a node.

Parameters

[in]	base	Pointer to base node of list
[in]	node2	Node to remove
[in]	mtr	Mini-transaction handle

◆ flst_validate()

void flst_validate	(	const flst_base_node_t *	base,
		mtr_t *	mtr1
	)

Validates a file-based list.

Parameters

[in]	base	pointer to base node of list
[in]	mtr1	mtr

◆ flst_write_addr()

static void flst_write_addr	(	fil_faddr_t *	faddr,
		fil_addr_t	addr,
		mtr_t *	mtr
	)

inlinestatic

Writes a file address.

Parameters

[in]	faddr	Pointer to file faddress
[in]	addr	File address
[in]	mtr	Mini-transaction handle

◆ operator<<()

std::ostream & operator<<	(	std::ostream &	out,
		const flst_bnode_t &	obj
	)

inline

Variable Documentation

◆ FLST_BASE_NODE_SIZE

constexpr ulint FLST_BASE_NODE_SIZE = 4 + 2 * FIL_ADDR_SIZE

constexpr

◆ FLST_NODE_SIZE

constexpr ulint FLST_NODE_SIZE = 2 * FIL_ADDR_SIZE

constexpr

Classes

Typedefs

Functions

Variables

Detailed Description

Typedef Documentation

◆ flst_base_node_t

◆ flst_node_t

Function Documentation

◆ flst_add_first()

◆ flst_add_last()

◆ flst_get_first()

◆ flst_get_last()

◆ flst_get_len()

◆ flst_get_next_addr()

◆ flst_get_prev_addr()

◆ flst_init()

◆ flst_insert_after()

◆ flst_insert_before()

◆ flst_read_addr()

◆ flst_remove()

◆ flst_validate()

◆ flst_write_addr()

◆ operator<<()

Variable Documentation

◆ FLST_BASE_NODE_SIZE

◆ FLST_NODE_SIZE