You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
139 lines
3.9 KiB
139 lines
3.9 KiB
/* Copyright (c) 2017, 2019, Oracle and/or its affiliates. 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, 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 SQL_LOCK_INCLUDED
|
|
#define SQL_LOCK_INCLUDED
|
|
|
|
#include <sys/types.h>
|
|
|
|
#include "my_sqlcommand.h" // SQLCOM_LOCK_INSTANCE, SQLCOM_UNLOCK_INSTANCE
|
|
#include "sql_cmd.h" // Sql_cmd
|
|
|
|
class THD;
|
|
|
|
/**
|
|
Sql_cmd_lock_instance represents statement LOCK INSTANCE FOR BACKUP.
|
|
*/
|
|
|
|
class Sql_cmd_lock_instance : public Sql_cmd {
|
|
public:
|
|
/**
|
|
Execute LOCK INSTANCE statement once.
|
|
|
|
@param thd Thread handler
|
|
|
|
@returns false on success, true on error
|
|
*/
|
|
|
|
virtual bool execute(THD *thd);
|
|
|
|
virtual enum_sql_command sql_command_code() const {
|
|
return SQLCOM_LOCK_INSTANCE;
|
|
}
|
|
};
|
|
|
|
/**
|
|
Sql_cmd_unlock_instance represents statement UNLOCK INSTANCE.
|
|
*/
|
|
|
|
class Sql_cmd_unlock_instance : public Sql_cmd {
|
|
public:
|
|
/**
|
|
Execute UNLOCK INSTANCE statement once.
|
|
|
|
@param thd Thread handler
|
|
|
|
@returns false on success, true on error
|
|
*/
|
|
|
|
virtual bool execute(THD *thd);
|
|
|
|
virtual enum_sql_command sql_command_code() const {
|
|
return SQLCOM_UNLOCK_INSTANCE;
|
|
}
|
|
};
|
|
|
|
/**
|
|
Acquire exclusive Backup Lock.
|
|
|
|
@param[in] thd Current thread context
|
|
@param[in] lock_wait_timeout How many seconds to wait before timeout.
|
|
@param[in] for_trx true if MDL duration is MDL_TRANSACTION
|
|
false if MDL duration is MDL_EXPLICIT
|
|
|
|
@return Operation status.
|
|
@retval false Success
|
|
@retval true Failure
|
|
*/
|
|
|
|
bool acquire_exclusive_backup_lock(THD *thd, unsigned long lock_wait_timeout,
|
|
bool for_trx);
|
|
|
|
/**
|
|
Acquire shared Backup Lock.
|
|
|
|
@param[in] thd Current thread context
|
|
@param[in] lock_wait_timeout How many seconds to wait before timeout.
|
|
@param[in] for_trx true if MDL duration is MDL_TRANSACTION
|
|
false if MDL duration is MDL_EXPLICIT
|
|
|
|
@return Operation status.
|
|
@retval false Success
|
|
@retval true Failure
|
|
*/
|
|
|
|
bool acquire_shared_backup_lock(THD *thd, unsigned long lock_wait_timeout,
|
|
bool for_trx = true);
|
|
|
|
/**
|
|
Release Backup Lock if it was acquired.
|
|
|
|
@param[in] thd Current thread context
|
|
*/
|
|
|
|
void release_backup_lock(THD *thd);
|
|
|
|
/**
|
|
There are three possible results while checking if the instance is locked for
|
|
backup.
|
|
*/
|
|
|
|
enum class Is_instance_backup_locked_result {
|
|
NOT_LOCKED = 0,
|
|
LOCKED = 1,
|
|
OOM = 2
|
|
};
|
|
|
|
/**
|
|
Check if this server instance is locked with Backup Lock. In fact, it checks
|
|
if any thread owns BACKUP_LOCK.
|
|
|
|
@param[in] thd Current thread context
|
|
|
|
@retval NOT_LOCKED Backup Lock is not acquired by any thread.
|
|
@retval LOCKED Backup Lock is acquired by a thread.
|
|
@retval OOM Error occurred (OOM) when checking lock ownership.
|
|
*/
|
|
|
|
Is_instance_backup_locked_result is_instance_backup_locked(THD *thd);
|
|
|
|
#endif /* SQL_LOCK_INCLUDED */
|
|
|