2005-10-27 11:48:10 +00:00
|
|
|
/******************************************************
|
|
|
|
Compressed page interface
|
|
|
|
|
|
|
|
(c) 2005 Innobase Oy
|
|
|
|
|
|
|
|
Created June 2005 by Marko Makela
|
|
|
|
*******************************************************/
|
|
|
|
|
|
|
|
#ifndef page0zip_h
|
|
|
|
#define page0zip_h
|
|
|
|
|
|
|
|
#ifdef UNIV_MATERIALIZE
|
|
|
|
# undef UNIV_INLINE
|
|
|
|
# define UNIV_INLINE
|
|
|
|
#endif
|
|
|
|
|
|
|
|
#include "mtr0types.h"
|
|
|
|
#include "page0types.h"
|
2006-02-10 15:06:17 +00:00
|
|
|
#include "dict0types.h"
|
|
|
|
#include "ut0byte.h"
|
2005-10-27 11:48:10 +00:00
|
|
|
|
|
|
|
/**************************************************************************
|
|
|
|
Initialize a compressed page descriptor. */
|
|
|
|
UNIV_INLINE
|
|
|
|
void
|
|
|
|
page_zip_des_init(
|
|
|
|
/*==============*/
|
|
|
|
page_zip_des_t* page_zip); /* in/out: compressed page
|
|
|
|
descriptor */
|
|
|
|
|
|
|
|
/**************************************************************************
|
|
|
|
Compress a page. */
|
|
|
|
|
|
|
|
ibool
|
|
|
|
page_zip_compress(
|
|
|
|
/*==============*/
|
|
|
|
/* out: TRUE on success, FALSE on failure;
|
|
|
|
page_zip will be left intact on failure. */
|
2006-02-10 15:06:17 +00:00
|
|
|
page_zip_des_t* page_zip,/* in: size; out: data, n_blobs,
|
|
|
|
m_start, m_end */
|
|
|
|
const page_t* page, /* in: uncompressed page */
|
|
|
|
dict_index_t* index, /* in: index of the B-tree node */
|
|
|
|
mtr_t* mtr) /* in: mini-transaction handle,
|
|
|
|
or NULL if no logging is needed */
|
|
|
|
__attribute__((nonnull(1,2,3)));
|
2005-10-27 11:48:10 +00:00
|
|
|
|
|
|
|
/**************************************************************************
|
2005-11-25 12:34:38 +00:00
|
|
|
Decompress a page. This function should tolerate errors on the compressed
|
|
|
|
page. Instead of letting assertions fail, it will return FALSE if an
|
|
|
|
inconsistency is detected. */
|
2005-10-27 11:48:10 +00:00
|
|
|
|
|
|
|
ibool
|
|
|
|
page_zip_decompress(
|
|
|
|
/*================*/
|
|
|
|
/* out: TRUE on success, FALSE on failure */
|
2006-02-10 15:06:17 +00:00
|
|
|
page_zip_des_t* page_zip,/* in: data, size;
|
|
|
|
out: m_start, m_end, n_blobs */
|
2005-10-27 11:48:10 +00:00
|
|
|
page_t* page, /* out: uncompressed page, may be trashed */
|
|
|
|
mtr_t* mtr) /* in: mini-transaction handle,
|
|
|
|
or NULL if no logging is needed */
|
|
|
|
__attribute__((warn_unused_result, nonnull(1, 2)));
|
|
|
|
|
|
|
|
#ifdef UNIV_DEBUG
|
|
|
|
/**************************************************************************
|
|
|
|
Validate a compressed page descriptor. */
|
|
|
|
UNIV_INLINE
|
|
|
|
ibool
|
|
|
|
page_zip_simple_validate(
|
|
|
|
/*=====================*/
|
|
|
|
/* out: TRUE if ok */
|
|
|
|
const page_zip_des_t* page_zip); /* in: compressed page
|
|
|
|
descriptor */
|
2005-11-30 13:57:54 +00:00
|
|
|
#endif /* UNIV_DEBUG */
|
2005-10-27 11:48:10 +00:00
|
|
|
|
2005-11-30 13:57:54 +00:00
|
|
|
#if defined UNIV_DEBUG || defined UNIV_ZIP_DEBUG
|
2005-10-27 11:48:10 +00:00
|
|
|
/**************************************************************************
|
|
|
|
Check that the compressed and decompressed pages match. */
|
|
|
|
|
|
|
|
ibool
|
|
|
|
page_zip_validate(
|
|
|
|
/*==============*/
|
|
|
|
const page_zip_des_t* page_zip,/* in: compressed page */
|
2006-02-10 15:06:17 +00:00
|
|
|
const page_t* page) /* in: uncompressed page */
|
|
|
|
__attribute__((nonnull));
|
2005-11-30 13:57:54 +00:00
|
|
|
#endif /* UNIV_DEBUG || UNIV_ZIP_DEBUG */
|
2005-10-27 11:48:10 +00:00
|
|
|
|
|
|
|
/**************************************************************************
|
|
|
|
Ensure that enough space is available in the modification log.
|
|
|
|
If not, try to compress the page. */
|
|
|
|
UNIV_INLINE
|
|
|
|
ibool
|
|
|
|
page_zip_alloc(
|
|
|
|
/*===========*/
|
|
|
|
/* out: TRUE if enough space is available */
|
|
|
|
page_zip_des_t* page_zip,/* in/out: compressed page;
|
|
|
|
will only be modified if compression is needed
|
|
|
|
and successful */
|
|
|
|
const page_t* page, /* in: uncompressed page */
|
2006-02-10 15:06:17 +00:00
|
|
|
dict_index_t* index, /* in: index of the B-tree node */
|
|
|
|
mtr_t* mtr, /* in: mini-transaction handle,
|
|
|
|
or NULL if no logging is desired */
|
|
|
|
ulint length, /* in: combined size of the record */
|
|
|
|
ulint create) /* in: nonzero=add the record to the heap */
|
|
|
|
__attribute__((warn_unused_result, nonnull(1,2,3)));
|
2005-10-27 11:48:10 +00:00
|
|
|
|
|
|
|
/**************************************************************************
|
2006-02-10 15:06:17 +00:00
|
|
|
Write an entire record on the compressed page. The data must already
|
|
|
|
have been written to the uncompressed page. */
|
2005-10-27 11:48:10 +00:00
|
|
|
|
2006-02-10 15:06:17 +00:00
|
|
|
void
|
|
|
|
page_zip_write_rec(
|
|
|
|
/*===============*/
|
|
|
|
page_zip_des_t* page_zip,/* in/out: compressed page */
|
|
|
|
const byte* rec, /* in: record being written */
|
2006-03-06 21:00:05 +00:00
|
|
|
dict_index_t* index, /* in: the index the record belongs to */
|
2006-02-10 15:06:17 +00:00
|
|
|
const ulint* offsets)/* in: rec_get_offsets(rec, index) */
|
|
|
|
__attribute__((nonnull));
|
2005-10-27 11:48:10 +00:00
|
|
|
|
|
|
|
/**************************************************************************
|
2006-02-10 15:06:17 +00:00
|
|
|
Write the BLOB pointer of a record on the leaf page of a clustered index.
|
|
|
|
The information must already have been updated on the uncompressed page. */
|
2005-10-27 11:48:10 +00:00
|
|
|
|
|
|
|
void
|
2006-02-10 15:06:17 +00:00
|
|
|
page_zip_write_blob_ptr(
|
|
|
|
/*====================*/
|
2005-10-27 11:48:10 +00:00
|
|
|
page_zip_des_t* page_zip,/* in/out: compressed page */
|
2006-02-10 15:06:17 +00:00
|
|
|
const byte* rec, /* in/out: record whose data is being
|
|
|
|
written */
|
|
|
|
dict_index_t* index, /* in: index of the page */
|
|
|
|
const ulint* offsets,/* in: rec_get_offsets(rec, index) */
|
|
|
|
ulint n, /* in: column index */
|
|
|
|
mtr_t* mtr) /* in: mini-transaction handle,
|
|
|
|
or NULL if no logging is needed */
|
|
|
|
__attribute__((nonnull(1,2,3,4)));
|
|
|
|
|
|
|
|
/**************************************************************************
|
|
|
|
Write the node pointer of a record on a non-leaf compressed page. */
|
|
|
|
|
|
|
|
void
|
|
|
|
page_zip_write_node_ptr(
|
|
|
|
/*====================*/
|
|
|
|
page_zip_des_t* page_zip,/* in/out: compressed page */
|
|
|
|
byte* rec, /* in/out: record */
|
|
|
|
ulint size, /* in: data size of rec */
|
|
|
|
ulint ptr, /* in: node pointer */
|
|
|
|
mtr_t* mtr) /* in: mini-transaction, or NULL */
|
|
|
|
__attribute__((nonnull(1,2)));
|
|
|
|
|
|
|
|
/**************************************************************************
|
2006-03-09 17:26:02 +00:00
|
|
|
Write the trx_id and roll_ptr of a record on a B-tree leaf node page. */
|
2006-02-10 15:06:17 +00:00
|
|
|
|
|
|
|
void
|
2006-03-09 17:26:02 +00:00
|
|
|
page_zip_write_trx_id_and_roll_ptr(
|
|
|
|
/*===============================*/
|
2006-02-10 15:06:17 +00:00
|
|
|
page_zip_des_t* page_zip,/* in/out: compressed page */
|
|
|
|
byte* rec, /* in/out: record */
|
2006-03-09 17:26:02 +00:00
|
|
|
const ulint* offsets,/* in: rec_get_offsets(rec, index) */
|
|
|
|
ulint trx_id_col,/* in: column number of TRX_ID in rec */
|
2006-02-10 15:06:17 +00:00
|
|
|
dulint trx_id, /* in: transaction identifier */
|
2006-03-09 17:26:02 +00:00
|
|
|
dulint roll_ptr)/* in: roll_ptr */
|
|
|
|
__attribute__((nonnull));
|
2006-02-10 15:06:17 +00:00
|
|
|
|
|
|
|
/**************************************************************************
|
|
|
|
Clear a record on the uncompressed and compressed page, if possible. */
|
|
|
|
|
|
|
|
void
|
|
|
|
page_zip_clear_rec(
|
|
|
|
/*===============*/
|
|
|
|
page_zip_des_t* page_zip,/* in/out: compressed page */
|
|
|
|
byte* rec, /* in/out: record to clear */
|
|
|
|
dict_index_t* index, /* in: index of rec */
|
|
|
|
const ulint* offsets,/* in: rec_get_offsets(rec, index) */
|
|
|
|
mtr_t* mtr) /* in: mini-transaction */
|
|
|
|
__attribute__((nonnull));
|
|
|
|
|
|
|
|
/**************************************************************************
|
|
|
|
Populate the dense page directory on the compressed page
|
|
|
|
from the sparse directory on the uncompressed row_format=compact page. */
|
|
|
|
void
|
|
|
|
page_zip_dir_rewrite(
|
|
|
|
/*=================*/
|
|
|
|
page_zip_des_t* page_zip,/* out: dense directory on compressed page */
|
|
|
|
const page_t* page) /* in: uncompressed page */
|
|
|
|
__attribute__((nonnull));
|
|
|
|
|
|
|
|
/**************************************************************************
|
|
|
|
Write the "deleted" flag of a record on a compressed page. The flag must
|
|
|
|
already have been written on the uncompressed page. */
|
|
|
|
|
|
|
|
void
|
|
|
|
page_zip_rec_set_deleted(
|
|
|
|
/*=====================*/
|
|
|
|
page_zip_des_t* page_zip,/* in/out: compressed page */
|
|
|
|
const byte* rec, /* in: record on the uncompressed page */
|
|
|
|
ulint flag) /* in: the deleted flag (nonzero=TRUE) */
|
|
|
|
__attribute__((nonnull));
|
|
|
|
|
|
|
|
/**************************************************************************
|
|
|
|
Write the "owned" flag of a record on a compressed page. The n_owned field
|
|
|
|
must already have been written on the uncompressed page. */
|
|
|
|
|
|
|
|
void
|
|
|
|
page_zip_rec_set_owned(
|
|
|
|
/*===================*/
|
|
|
|
page_zip_des_t* page_zip,/* in/out: compressed page */
|
|
|
|
const byte* rec, /* in: record on the uncompressed page */
|
|
|
|
ulint flag) /* in: the owned flag (nonzero=TRUE) */
|
|
|
|
__attribute__((nonnull));
|
|
|
|
|
|
|
|
/**************************************************************************
|
|
|
|
Shift the dense page directory when a record is deleted. */
|
|
|
|
|
|
|
|
void
|
|
|
|
page_zip_dir_delete(
|
|
|
|
/*================*/
|
|
|
|
page_zip_des_t* page_zip,/* in/out: compressed page */
|
|
|
|
const byte* rec, /* in: deleted record */
|
|
|
|
const byte* free) /* in: previous start of the free list */
|
2006-03-08 22:19:20 +00:00
|
|
|
__attribute__((nonnull(1,2)));
|
2005-10-27 11:48:10 +00:00
|
|
|
|
2006-03-06 21:00:05 +00:00
|
|
|
/**************************************************************************
|
|
|
|
Add a slot to the dense page directory. */
|
|
|
|
|
|
|
|
void
|
|
|
|
page_zip_dir_add_slot(
|
|
|
|
/*==================*/
|
2006-03-09 17:26:02 +00:00
|
|
|
page_zip_des_t* page_zip, /* in/out: compressed page */
|
|
|
|
ulint is_clustered) /* in: nonzero for clustered index,
|
|
|
|
zero for others */
|
2006-03-06 21:00:05 +00:00
|
|
|
__attribute__((nonnull));
|
|
|
|
|
2005-10-27 11:48:10 +00:00
|
|
|
/**************************************************************************
|
|
|
|
Write data to the uncompressed header portion of a page. The data must
|
2006-02-10 15:06:17 +00:00
|
|
|
already have been written to the uncompressed page.
|
|
|
|
However, the data portion of the uncompressed page may differ from
|
|
|
|
the compressed page when a record is being inserted in
|
|
|
|
page_cur_insert_rec_low(). */
|
2005-10-27 11:48:10 +00:00
|
|
|
UNIV_INLINE
|
|
|
|
void
|
|
|
|
page_zip_write_header(
|
|
|
|
/*==================*/
|
|
|
|
page_zip_des_t* page_zip,/* in/out: compressed page */
|
|
|
|
const byte* str, /* in: address on the uncompressed page */
|
2006-02-22 13:02:40 +00:00
|
|
|
ulint length, /* in: length of the data */
|
|
|
|
mtr_t* mtr) /* in: mini-transaction, or NULL */
|
|
|
|
__attribute__((nonnull(1,2)));
|
2005-10-27 11:48:10 +00:00
|
|
|
|
|
|
|
#ifdef UNIV_MATERIALIZE
|
|
|
|
# undef UNIV_INLINE
|
|
|
|
# define UNIV_INLINE UNIV_INLINE_ORIGINAL
|
|
|
|
#endif
|
|
|
|
|
|
|
|
#ifndef UNIV_NONINL
|
|
|
|
# include "page0zip.ic"
|
|
|
|
#endif
|
|
|
|
|
|
|
|
#endif /* page0zip_h */
|