diff options
Diffstat (limited to 'storage/xtradb/include/row0upd.h')
| -rw-r--r-- | storage/xtradb/include/row0upd.h | 338 |
1 files changed, 173 insertions, 165 deletions
diff --git a/storage/xtradb/include/row0upd.h b/storage/xtradb/include/row0upd.h index 71aa20d158c..635d746d5a1 100644 --- a/storage/xtradb/include/row0upd.h +++ b/storage/xtradb/include/row0upd.h @@ -16,7 +16,8 @@ Place, Suite 330, Boston, MA 02111-1307 USA *****************************************************************************/ -/****************************************************** +/**************************************************//** +@file include/row0upd.h Update of a row Created 12/27/1996 Heikki Tuuri @@ -27,355 +28,360 @@ Created 12/27/1996 Heikki Tuuri #include "univ.i" #include "data0data.h" +#include "row0types.h" #include "btr0types.h" -#include "btr0pcur.h" #include "dict0types.h" #include "trx0types.h" -#include "que0types.h" -#include "row0types.h" -#include "pars0types.h" -/************************************************************************* -Creates an update vector object. */ +#ifndef UNIV_HOTBACKUP +# include "btr0pcur.h" +# include "que0types.h" +# include "pars0types.h" +#endif /* !UNIV_HOTBACKUP */ + +/*********************************************************************//** +Creates an update vector object. +@return own: update vector object */ UNIV_INLINE upd_t* upd_create( /*=======*/ - /* out, own: update vector object */ - ulint n, /* in: number of fields */ - mem_heap_t* heap); /* in: heap from which memory allocated */ -/************************************************************************* + ulint n, /*!< in: number of fields */ + mem_heap_t* heap); /*!< in: heap from which memory allocated */ +/*********************************************************************//** Returns the number of fields in the update vector == number of columns -to be updated by an update vector. */ +to be updated by an update vector. +@return number of fields */ UNIV_INLINE ulint upd_get_n_fields( /*=============*/ - /* out: number of fields */ - const upd_t* update); /* in: update vector */ + const upd_t* update); /*!< in: update vector */ #ifdef UNIV_DEBUG -/************************************************************************* -Returns the nth field of an update vector. */ +/*********************************************************************//** +Returns the nth field of an update vector. +@return update vector field */ UNIV_INLINE upd_field_t* upd_get_nth_field( /*==============*/ - /* out: update vector field */ - const upd_t* update, /* in: update vector */ - ulint n); /* in: field position in update vector */ + const upd_t* update, /*!< in: update vector */ + ulint n); /*!< in: field position in update vector */ #else # define upd_get_nth_field(update, n) ((update)->fields + (n)) #endif -/************************************************************************* +#ifndef UNIV_HOTBACKUP +/*********************************************************************//** Sets an index field number to be updated by an update vector field. */ UNIV_INLINE void upd_field_set_field_no( /*===================*/ - upd_field_t* upd_field, /* in: update vector field */ - ulint field_no, /* in: field number in a clustered + upd_field_t* upd_field, /*!< in: update vector field */ + ulint field_no, /*!< in: field number in a clustered index */ - dict_index_t* index, /* in: index */ - trx_t* trx); /* in: transaction */ -/************************************************************************* -Returns a field of an update vector by field_no. */ + dict_index_t* index, /*!< in: index */ + trx_t* trx); /*!< in: transaction */ +/*********************************************************************//** +Returns a field of an update vector by field_no. +@return update vector field, or NULL */ UNIV_INLINE const upd_field_t* upd_get_field_by_field_no( /*======================*/ - /* out: update vector field, or NULL */ - const upd_t* update, /* in: update vector */ - ulint no) /* in: field_no */ + const upd_t* update, /*!< in: update vector */ + ulint no) /*!< in: field_no */ __attribute__((nonnull, pure)); -/************************************************************************* +/*********************************************************************//** Writes into the redo log the values of trx id and roll ptr and enough info -to determine their positions within a clustered index record. */ +to determine their positions within a clustered index record. +@return new pointer to mlog */ UNIV_INTERN byte* row_upd_write_sys_vals_to_log( /*==========================*/ - /* out: new pointer to mlog */ - dict_index_t* index, /* in: clustered index */ - trx_t* trx, /* in: transaction */ - dulint roll_ptr,/* in: roll ptr of the undo log record */ - byte* log_ptr,/* pointer to a buffer of size > 20 opened + dict_index_t* index, /*!< in: clustered index */ + trx_t* trx, /*!< in: transaction */ + roll_ptr_t roll_ptr,/*!< in: roll ptr of the undo log record */ + byte* log_ptr,/*!< pointer to a buffer of size > 20 opened in mlog */ - mtr_t* mtr); /* in: mtr */ -/************************************************************************* + mtr_t* mtr); /*!< in: mtr */ +/*********************************************************************//** Updates the trx id and roll ptr field in a clustered index record when a row is updated or marked deleted. */ UNIV_INLINE void row_upd_rec_sys_fields( /*===================*/ - rec_t* rec, /* in/out: record */ - page_zip_des_t* page_zip,/* in/out: compressed page whose + rec_t* rec, /*!< in/out: record */ + page_zip_des_t* page_zip,/*!< in/out: compressed page whose uncompressed part will be updated, or NULL */ - dict_index_t* index, /* in: clustered index */ - const ulint* offsets,/* in: rec_get_offsets(rec, index) */ - trx_t* trx, /* in: transaction */ - dulint roll_ptr);/* in: roll ptr of the undo log record */ -/************************************************************************* + dict_index_t* index, /*!< in: clustered index */ + const ulint* offsets,/*!< in: rec_get_offsets(rec, index) */ + trx_t* trx, /*!< in: transaction */ + roll_ptr_t roll_ptr);/*!< in: roll ptr of the undo log record */ +/*********************************************************************//** Sets the trx id or roll ptr field of a clustered index entry. */ UNIV_INTERN void row_upd_index_entry_sys_field( /*==========================*/ - const dtuple_t* entry, /* in: index entry, where the memory buffers + const dtuple_t* entry, /*!< in: index entry, where the memory buffers for sys fields are already allocated: the function just copies the new values to them */ - dict_index_t* index, /* in: clustered index */ - ulint type, /* in: DATA_TRX_ID or DATA_ROLL_PTR */ - dulint val); /* in: value to write */ -/************************************************************************* -Creates an update node for a query graph. */ + dict_index_t* index, /*!< in: clustered index */ + ulint type, /*!< in: DATA_TRX_ID or DATA_ROLL_PTR */ + dulint val); /*!< in: value to write */ +/*********************************************************************//** +Creates an update node for a query graph. +@return own: update node */ UNIV_INTERN upd_node_t* upd_node_create( /*============*/ - /* out, own: update node */ - mem_heap_t* heap); /* in: mem heap where created */ -/*************************************************************** + mem_heap_t* heap); /*!< in: mem heap where created */ +/***********************************************************//** Writes to the redo log the new values of the fields occurring in the index. */ UNIV_INTERN void row_upd_index_write_log( /*====================*/ - const upd_t* update, /* in: update vector */ - byte* log_ptr,/* in: pointer to mlog buffer: must + const upd_t* update, /*!< in: update vector */ + byte* log_ptr,/*!< in: pointer to mlog buffer: must contain at least MLOG_BUF_MARGIN bytes of free space; the buffer is closed within this function */ - mtr_t* mtr); /* in: mtr into whose log to write */ -/*************************************************************** + mtr_t* mtr); /*!< in: mtr into whose log to write */ +/***********************************************************//** Returns TRUE if row update changes size of some field in index or if some -field to be updated is stored externally in rec or update. */ +field to be updated is stored externally in rec or update. +@return TRUE if the update changes the size of some field in index or +the field is external in rec or update */ UNIV_INTERN ibool row_upd_changes_field_size_or_external( /*===================================*/ - /* out: TRUE if the update changes the size of - some field in index or the field is external - in rec or update */ - dict_index_t* index, /* in: index */ - const ulint* offsets,/* in: rec_get_offsets(rec, index) */ - const upd_t* update);/* in: update vector */ -/*************************************************************** + dict_index_t* index, /*!< in: index */ + const ulint* offsets,/*!< in: rec_get_offsets(rec, index) */ + const upd_t* update);/*!< in: update vector */ +#endif /* !UNIV_HOTBACKUP */ +/***********************************************************//** Replaces the new column values stored in the update vector to the record given. No field size changes are allowed. */ UNIV_INTERN void row_upd_rec_in_place( /*=================*/ - rec_t* rec, /* in/out: record where replaced */ - dict_index_t* index, /* in: the index the record belongs to */ - const ulint* offsets,/* in: array returned by rec_get_offsets() */ - const upd_t* update, /* in: update vector */ - page_zip_des_t* page_zip);/* in: compressed page with enough space + rec_t* rec, /*!< in/out: record where replaced */ + dict_index_t* index, /*!< in: the index the record belongs to */ + const ulint* offsets,/*!< in: array returned by rec_get_offsets() */ + const upd_t* update, /*!< in: update vector */ + page_zip_des_t* page_zip);/*!< in: compressed page with enough space available, or NULL */ -/******************************************************************* +#ifndef UNIV_HOTBACKUP +/***************************************************************//** Builds an update vector from those fields which in a secondary index entry differ from a record that has the equal ordering fields. NOTE: we compare -the fields as binary strings! */ +the fields as binary strings! +@return own: update vector of differing fields */ UNIV_INTERN upd_t* row_upd_build_sec_rec_difference_binary( /*====================================*/ - /* out, own: update vector of differing - fields */ - dict_index_t* index, /* in: index */ - const dtuple_t* entry, /* in: entry to insert */ - const rec_t* rec, /* in: secondary index record */ - trx_t* trx, /* in: transaction */ - mem_heap_t* heap); /* in: memory heap from which allocated */ -/******************************************************************* + dict_index_t* index, /*!< in: index */ + const dtuple_t* entry, /*!< in: entry to insert */ + const rec_t* rec, /*!< in: secondary index record */ + trx_t* trx, /*!< in: transaction */ + mem_heap_t* heap); /*!< in: memory heap from which allocated */ +/***************************************************************//** Builds an update vector from those fields, excluding the roll ptr and trx id fields, which in an index entry differ from a record that has -the equal ordering fields. NOTE: we compare the fields as binary strings! */ +the equal ordering fields. NOTE: we compare the fields as binary strings! +@return own: update vector of differing fields, excluding roll ptr and +trx id */ UNIV_INTERN upd_t* row_upd_build_difference_binary( /*============================*/ - /* out, own: update vector of differing - fields, excluding roll ptr and trx id */ - dict_index_t* index, /* in: clustered index */ - const dtuple_t* entry, /* in: entry to insert */ - const rec_t* rec, /* in: clustered index record */ - trx_t* trx, /* in: transaction */ - mem_heap_t* heap); /* in: memory heap from which allocated */ -/*************************************************************** + dict_index_t* index, /*!< in: clustered index */ + const dtuple_t* entry, /*!< in: entry to insert */ + const rec_t* rec, /*!< in: clustered index record */ + trx_t* trx, /*!< in: transaction */ + mem_heap_t* heap); /*!< in: memory heap from which allocated */ +/***********************************************************//** Replaces the new column values stored in the update vector to the index entry given. */ UNIV_INTERN void row_upd_index_replace_new_col_vals_index_pos( /*=========================================*/ - dtuple_t* entry, /* in/out: index entry where replaced; + dtuple_t* entry, /*!< in/out: index entry where replaced; the clustered index record must be covered by a lock or a page latch to prevent deletion (rollback or purge) */ - dict_index_t* index, /* in: index; NOTE that this may also be a + dict_index_t* index, /*!< in: index; NOTE that this may also be a non-clustered index */ - const upd_t* update, /* in: an update vector built for the index so + const upd_t* update, /*!< in: an update vector built for the index so that the field number in an upd_field is the index position */ ibool order_only, - /* in: if TRUE, limit the replacement to + /*!< in: if TRUE, limit the replacement to ordering fields of index; note that this does not work for non-clustered indexes. */ - mem_heap_t* heap) /* in: memory heap for allocating and + mem_heap_t* heap) /*!< in: memory heap for allocating and copying the new values */ __attribute__((nonnull)); -/*************************************************************** +/***********************************************************//** Replaces the new column values stored in the update vector to the index entry given. */ UNIV_INTERN void row_upd_index_replace_new_col_vals( /*===============================*/ - dtuple_t* entry, /* in/out: index entry where replaced; + dtuple_t* entry, /*!< in/out: index entry where replaced; the clustered index record must be covered by a lock or a page latch to prevent deletion (rollback or purge) */ - dict_index_t* index, /* in: index; NOTE that this may also be a + dict_index_t* index, /*!< in: index; NOTE that this may also be a non-clustered index */ - const upd_t* update, /* in: an update vector built for the + const upd_t* update, /*!< in: an update vector built for the CLUSTERED index so that the field number in an upd_field is the clustered index position */ - mem_heap_t* heap) /* in: memory heap for allocating and + mem_heap_t* heap) /*!< in: memory heap for allocating and copying the new values */ __attribute__((nonnull)); -/*************************************************************** +/***********************************************************//** Replaces the new column values stored in the update vector. */ UNIV_INTERN void row_upd_replace( /*============*/ - dtuple_t* row, /* in/out: row where replaced, + dtuple_t* row, /*!< in/out: row where replaced, indexed by col_no; the clustered index record must be covered by a lock or a page latch to prevent deletion (rollback or purge) */ - row_ext_t** ext, /* out, own: NULL, or externally + row_ext_t** ext, /*!< out, own: NULL, or externally stored column prefixes */ - const dict_index_t* index, /* in: clustered index */ - const upd_t* update, /* in: an update vector built for the + const dict_index_t* index, /*!< in: clustered index */ + const upd_t* update, /*!< in: an update vector built for the clustered index */ - mem_heap_t* heap); /* in: memory heap */ -/*************************************************************** + mem_heap_t* heap); /*!< in: memory heap */ +/***********************************************************//** Checks if an update vector changes an ordering field of an index record. + This function is fast if the update vector is short or the number of ordering fields in the index is small. Otherwise, this can be quadratic. -NOTE: we compare the fields as binary strings! */ +NOTE: we compare the fields as binary strings! +@return TRUE if update vector changes an ordering field in the index record */ UNIV_INTERN ibool row_upd_changes_ord_field_binary( /*=============================*/ - /* out: TRUE if update vector changes - an ordering field in the index record; - NOTE: the fields are compared as binary - strings */ - const dtuple_t* row, /* in: old value of row, or NULL if the + const dtuple_t* row, /*!< in: old value of row, or NULL if the row and the data values in update are not known when this function is called, e.g., at compile time */ - dict_index_t* index, /* in: index of the record */ - const upd_t* update);/* in: update vector for the row; NOTE: the + dict_index_t* index, /*!< in: index of the record */ + const upd_t* update);/*!< in: update vector for the row; NOTE: the field numbers in this MUST be clustered index positions! */ -/*************************************************************** +/***********************************************************//** Checks if an update vector changes an ordering field of an index record. This function is fast if the update vector is short or the number of ordering fields in the index is small. Otherwise, this can be quadratic. -NOTE: we compare the fields as binary strings! */ +NOTE: we compare the fields as binary strings! +@return TRUE if update vector may change an ordering field in an index +record */ UNIV_INTERN ibool row_upd_changes_some_index_ord_field_binary( /*========================================*/ - /* out: TRUE if update vector - may change an ordering field - in an index record */ - const dict_table_t* table, /* in: table */ - const upd_t* update);/* in: update vector for the row */ -/*************************************************************** + const dict_table_t* table, /*!< in: table */ + const upd_t* update);/*!< in: update vector for the row */ +/***********************************************************//** Updates a row in a table. This is a high-level function used -in SQL execution graphs. */ +in SQL execution graphs. +@return query thread to run next or NULL */ UNIV_INTERN que_thr_t* row_upd_step( /*=========*/ - /* out: query thread to run next or NULL */ - que_thr_t* thr); /* in: query thread */ -/************************************************************************* -Parses the log data of system field values. */ + que_thr_t* thr); /*!< in: query thread */ +#endif /* !UNIV_HOTBACKUP */ +/*********************************************************************//** +Parses the log data of system field values. +@return log data end or NULL */ UNIV_INTERN byte* row_upd_parse_sys_vals( /*===================*/ - /* out: log data end or NULL */ - byte* ptr, /* in: buffer */ - byte* end_ptr,/* in: buffer end */ - ulint* pos, /* out: TRX_ID position in record */ - dulint* trx_id, /* out: trx id */ - dulint* roll_ptr);/* out: roll ptr */ -/************************************************************************* + byte* ptr, /*!< in: buffer */ + byte* end_ptr,/*!< in: buffer end */ + ulint* pos, /*!< out: TRX_ID position in record */ + trx_id_t* trx_id, /*!< out: trx id */ + roll_ptr_t* roll_ptr);/*!< out: roll ptr */ +/*********************************************************************//** Updates the trx id and roll ptr field in a clustered index record in database recovery. */ UNIV_INTERN void row_upd_rec_sys_fields_in_recovery( /*===============================*/ - rec_t* rec, /* in/out: record */ - page_zip_des_t* page_zip,/* in/out: compressed page, or NULL */ - const ulint* offsets,/* in: array returned by rec_get_offsets() */ - ulint pos, /* in: TRX_ID position in rec */ - dulint trx_id, /* in: transaction id */ - dulint roll_ptr);/* in: roll ptr of the undo log record */ -/************************************************************************* -Parses the log data written by row_upd_index_write_log. */ + rec_t* rec, /*!< in/out: record */ + page_zip_des_t* page_zip,/*!< in/out: compressed page, or NULL */ + const ulint* offsets,/*!< in: array returned by rec_get_offsets() */ + ulint pos, /*!< in: TRX_ID position in rec */ + trx_id_t trx_id, /*!< in: transaction id */ + roll_ptr_t roll_ptr);/*!< in: roll ptr of the undo log record */ +/*********************************************************************//** +Parses the log data written by row_upd_index_write_log. +@return log data end or NULL */ UNIV_INTERN byte* row_upd_index_parse( /*================*/ - /* out: log data end or NULL */ - byte* ptr, /* in: buffer */ - byte* end_ptr,/* in: buffer end */ - mem_heap_t* heap, /* in: memory heap where update vector is + byte* ptr, /*!< in: buffer */ + byte* end_ptr,/*!< in: buffer end */ + mem_heap_t* heap, /*!< in: memory heap where update vector is built */ - upd_t** update_out);/* out: update vector */ + upd_t** update_out);/*!< out: update vector */ /* Update vector field */ struct upd_field_struct{ - unsigned field_no:16; /* field number in an index, usually + unsigned field_no:16; /*!< field number in an index, usually the clustered index, but in updating a secondary index record in btr0cur.c this is the position in the secondary index */ - unsigned orig_len:16; /* original length of the locally +#ifndef UNIV_HOTBACKUP + unsigned orig_len:16; /*!< original length of the locally stored part of an externally stored column, or 0 */ - que_node_t* exp; /* expression for calculating a new + que_node_t* exp; /*!< expression for calculating a new value: it refers to column values and constants in the symbol table of the query graph */ - dfield_t new_val; /* new value for the column */ +#endif /* !UNIV_HOTBACKUP */ + dfield_t new_val; /*!< new value for the column */ }; /* Update vector structure */ struct upd_struct{ - ulint info_bits; /* new value of info bits to record; + ulint info_bits; /*!< new value of info bits to record; default is 0 */ - ulint n_fields; /* number of update fields */ - upd_field_t* fields; /* array of update fields */ + ulint n_fields; /*!< number of update fields */ + upd_field_t* fields; /*!< array of update fields */ }; +#ifndef UNIV_HOTBACKUP /* Update node structure which also implements the delete operation of a row */ struct upd_node_struct{ - que_common_t common; /* node type: QUE_NODE_UPDATE */ + que_common_t common; /*!< node type: QUE_NODE_UPDATE */ ibool is_delete;/* TRUE if delete, FALSE if update */ ibool searched_update; /* TRUE if searched update, FALSE if @@ -391,16 +397,16 @@ struct upd_node_struct{ or ... SET NULL for foreign keys */ mem_heap_t* cascade_heap;/* NULL or a mem heap where the cascade node is created */ - sel_node_t* select; /* query graph subtree implementing a base + sel_node_t* select; /*!< query graph subtree implementing a base table cursor: the rows returned will be updated */ - btr_pcur_t* pcur; /* persistent cursor placed on the clustered + btr_pcur_t* pcur; /*!< persistent cursor placed on the clustered index record which should be updated or deleted; the cursor is stored in the graph of 'select' field above, except in the case of the MySQL interface */ - dict_table_t* table; /* table where updated */ - upd_t* update; /* update vector for the row */ + dict_table_t* table; /*!< table where updated */ + upd_t* update; /*!< update vector for the row */ ulint update_n_fields; /* when this struct is used to implement a cascade operation for foreign keys, we store @@ -419,18 +425,18 @@ struct upd_node_struct{ UPD_NODE_NO_SIZE_CHANGE, ORed */ /*----------------------*/ /* Local storage for this graph node */ - ulint state; /* node execution state */ - dict_index_t* index; /* NULL, or the next index whose record should + ulint state; /*!< node execution state */ + dict_index_t* index; /*!< NULL, or the next index whose record should be updated */ - dtuple_t* row; /* NULL, or a copy (also fields copied to + dtuple_t* row; /*!< NULL, or a copy (also fields copied to heap) of the row to update; this must be reset to NULL after a successful update */ - row_ext_t* ext; /* NULL, or prefixes of the externally + row_ext_t* ext; /*!< NULL, or prefixes of the externally stored columns in the old row */ dtuple_t* upd_row;/* NULL, or a copy of the updated row */ row_ext_t* upd_ext;/* NULL, or prefixes of the externally stored columns in upd_row */ - mem_heap_t* heap; /* memory heap used as auxiliary storage; + mem_heap_t* heap; /*!< memory heap used as auxiliary storage; this must be emptied after a successful update */ /*----------------------*/ @@ -468,6 +474,8 @@ struct upd_node_struct{ #define UPD_NODE_NO_SIZE_CHANGE 2 /* no record field size will be changed in the update */ +#endif /* !UNIV_HOTBACKUP */ + #ifndef UNIV_NONINL #include "row0upd.ic" #endif |