mariadb/storage/perfschema/table_replication_applier_status.h

118 lines
3.2 KiB
C
Raw Normal View History

2019-12-10 15:35:00 +01:00
/*
Copyright (c) 2013, 2023, Oracle and/or its affiliates.
2019-12-10 15:35:00 +01:00
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License, version 2.0,
as published by the Free Software Foundation.
This program is also distributed with certain software (including
but not limited to OpenSSL) that is licensed under separate terms,
as designated in a particular file or component or in included license
documentation. The authors of MySQL hereby grant you an additional
permission to link the program and your derivative works with the
separately licensed software that they have included with MySQL.
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, version 2.0, 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 */
#ifndef TABLE_REPLICATION_APPLIER_STATUS_H
#define TABLE_REPLICATION_APPLIER_STATUS_H
/**
@file storage/perfschema/table_replication_applier_status.h
Table replication_applier_status (declarations).
*/
#include "pfs_column_types.h"
#include "pfs_engine_table.h"
#include "rpl_mi.h"
#include "mysql_com.h"
#include "my_thread.h"
class Master_info;
/**
@addtogroup Performance_schema_tables
@{
*/
#ifndef ENUM_RPL_YES_NO
#define ENUM_RPL_YES_NO
/** enum values for Service_State field*/
enum enum_rpl_yes_no {
PS_RPL_YES= 1,
PS_RPL_NO
};
#endif
/** A row in the table. */
struct st_row_applier_status {
char channel_name[CHANNEL_NAME_LENGTH];
uint channel_name_length;
enum_rpl_yes_no service_state;
uint remaining_delay;
bool remaining_delay_is_set;
Fix inconsistent definition of PERFORMANCE_SCHEMA.REPLICATION_APPLIER_STATUS.COUNT_TRANSACTIONS_RETRIES column This column (`COUNT_TRANSACTIONS_RETRIES`) is defined as `BIGINT UNSIGNED` (64-bit unsigned integer) in the user-visible SQL definition: https://github.com/MariaDB/server/blob/182ff21ace34ea4f00fb5b66689b172323d91f99/storage/perfschema/table_replication_applier_status.cc#L66 "COUNT_TRANSACTIONS_RETRIES BIGINT unsigned not null comment 'The number of retries that were made because the replication SQL thread failed to apply a transaction.'," And its value is internally set/updated using the `set_field_ulonglong` function: https://github.com/MariaDB/server/blob/182ff21ace34ea4f00fb5b66689b172323d91f99/storage/perfschema/table_replication_applier_status.cc#L231-L233 case 3: /* total number of times transactions were retried */ set_field_ulonglong(f, m_row.count_transactions_retries); break; … but the structure where it is stored allocates only `ulong` for it: https://github.com/MariaDB/server/blob/182ff21ace34ea4f00fb5b66689b172323d91f99/storage/perfschema/table_replication_applier_status.h#L62 ulong count_transactions_retries; As a result of this inconsistency: 1. On any platform where `ulong` is `uint32_t` and `ulonglong` is `uint64_t`, setting this value would corrupt the 4 bytes of memory *following* the 4 bytes actually allocated for it. Likely this problem was never noticed because this is the final element in the structure, and the structure is padded by the compiler to prevent memory corruption errors. 2. On any BIG-ENDIAN platform where `ulong` is `uint32_t` and `ulonglong` is `uint64_t`, reading back the value of this column will result in total garbage. Likely this problem was never noticed because MariaDB has not been tested on 32-bit big-endian platforms. In order not to affect the user-visible/SQL definition of this column, the correct way to fix this issue is to change it to `ulonglong` in the structure definition. See https://github.com/MariaDB/server/pull/2763/files#r1329110832 for the original identification and discussion of this issue. All new code of the whole pull request, including one or several files that are either new files or modified ones, are contributed under the BSD-new license. I am contributing on behalf of my employer Amazon Web Services
2023-12-06 12:03:27 -08:00
ulonglong count_transactions_retries;
2019-12-10 15:35:00 +01:00
};
/** Table PERFORMANCE_SCHEMA.replication_applier_status */
class table_replication_applier_status: public PFS_engine_table
{
typedef PFS_simple_index pos_t;
private:
void make_row(Master_info *mi);
/** Table share lock. */
static THR_LOCK m_table_lock;
/** Fields definition. */
static TABLE_FIELD_DEF m_field_def;
/** Current row */
st_row_applier_status m_row;
/** True is the current row exists. */
bool m_row_exists;
/** Current position. */
pos_t m_pos;
/** Next position. */
pos_t m_next_pos;
protected:
/**
Read the current row values.
@param table Table handle
@param buf row buffer
@param fields Table fields
@param read_all true if all columns are read.
*/
int read_row_values(TABLE *table,
unsigned char *buf,
Field **fields,
bool read_all) override;
2019-12-10 15:35:00 +01:00
table_replication_applier_status();
public:
~table_replication_applier_status();
2022-07-29 14:48:01 +02:00
static PFS_engine_table_share_state m_share_state;
2019-12-10 15:35:00 +01:00
/** Table share. */
static PFS_engine_table_share m_share;
static PFS_engine_table* create();
static ha_rows get_row_count();
int rnd_next() override;
int rnd_pos(const void *pos) override;
void reset_position(void) override;
2019-12-10 15:35:00 +01:00
};
/** @} */
#endif