mirror of
https://github.com/postgres/postgres.git
synced 2026-01-29 12:02:15 +03:00
51efe38cb9
This commit adds timeout that is expected to be used as a prevention of long-running queries. Any session within the transaction will be terminated after spanning longer than this timeout. However, this timeout is not applied to prepared transactions. Only transactions with user connections are affected. Discussion: https://postgr.es/m/CAAhFRxiQsRs2Eq5kCo9nXE3HTugsAAJdSQSmxncivebAxdmBjQ%40mail.gmail.com Author: Andrey Borodin <amborodin@acm.org> Author: Japin Li <japinli@hotmail.com> Author: Junwang Zhao <zhjwpku@gmail.com> Reviewed-by: Nikolay Samokhvalov <samokhvalov@gmail.com> Reviewed-by: Andres Freund <andres@anarazel.de> Reviewed-by: Fujii Masao <masao.fujii@oss.nttdata.com> Reviewed-by: bt23nguyent <bt23nguyent@oss.nttdata.com> Reviewed-by: Yuhang Qiu <iamqyh@gmail.com>
97 lines
2.8 KiB
C
97 lines
2.8 KiB
C
/*-------------------------------------------------------------------------
|
|
*
|
|
* timeout.h
|
|
* Routines to multiplex SIGALRM interrupts for multiple timeout reasons.
|
|
*
|
|
*
|
|
* Portions Copyright (c) 1996-2024, PostgreSQL Global Development Group
|
|
* Portions Copyright (c) 1994, Regents of the University of California
|
|
*
|
|
* src/include/utils/timeout.h
|
|
*
|
|
*-------------------------------------------------------------------------
|
|
*/
|
|
#ifndef TIMEOUT_H
|
|
#define TIMEOUT_H
|
|
|
|
#include "datatype/timestamp.h"
|
|
|
|
/*
|
|
* Identifiers for timeout reasons. Note that in case multiple timeouts
|
|
* trigger at the same time, they are serviced in the order of this enum.
|
|
*/
|
|
typedef enum TimeoutId
|
|
{
|
|
/* Predefined timeout reasons */
|
|
STARTUP_PACKET_TIMEOUT,
|
|
DEADLOCK_TIMEOUT,
|
|
LOCK_TIMEOUT,
|
|
STATEMENT_TIMEOUT,
|
|
STANDBY_DEADLOCK_TIMEOUT,
|
|
STANDBY_TIMEOUT,
|
|
STANDBY_LOCK_TIMEOUT,
|
|
IDLE_IN_TRANSACTION_SESSION_TIMEOUT,
|
|
TRANSACTION_TIMEOUT,
|
|
IDLE_SESSION_TIMEOUT,
|
|
IDLE_STATS_UPDATE_TIMEOUT,
|
|
CLIENT_CONNECTION_CHECK_TIMEOUT,
|
|
STARTUP_PROGRESS_TIMEOUT,
|
|
/* First user-definable timeout reason */
|
|
USER_TIMEOUT,
|
|
/* Maximum number of timeout reasons */
|
|
MAX_TIMEOUTS = USER_TIMEOUT + 10
|
|
} TimeoutId;
|
|
|
|
/* callback function signature */
|
|
typedef void (*timeout_handler_proc) (void);
|
|
|
|
/*
|
|
* Parameter structure for setting multiple timeouts at once
|
|
*/
|
|
typedef enum TimeoutType
|
|
{
|
|
TMPARAM_AFTER,
|
|
TMPARAM_AT,
|
|
TMPARAM_EVERY,
|
|
} TimeoutType;
|
|
|
|
typedef struct
|
|
{
|
|
TimeoutId id; /* timeout to set */
|
|
TimeoutType type; /* TMPARAM_AFTER or TMPARAM_AT */
|
|
int delay_ms; /* only used for TMPARAM_AFTER/EVERY */
|
|
TimestampTz fin_time; /* only used for TMPARAM_AT */
|
|
} EnableTimeoutParams;
|
|
|
|
/*
|
|
* Parameter structure for clearing multiple timeouts at once
|
|
*/
|
|
typedef struct
|
|
{
|
|
TimeoutId id; /* timeout to clear */
|
|
bool keep_indicator; /* keep the indicator flag? */
|
|
} DisableTimeoutParams;
|
|
|
|
/* timeout setup */
|
|
extern void InitializeTimeouts(void);
|
|
extern TimeoutId RegisterTimeout(TimeoutId id, timeout_handler_proc handler);
|
|
extern void reschedule_timeouts(void);
|
|
|
|
/* timeout operation */
|
|
extern void enable_timeout_after(TimeoutId id, int delay_ms);
|
|
extern void enable_timeout_every(TimeoutId id, TimestampTz fin_time,
|
|
int delay_ms);
|
|
extern void enable_timeout_at(TimeoutId id, TimestampTz fin_time);
|
|
extern void enable_timeouts(const EnableTimeoutParams *timeouts, int count);
|
|
extern void disable_timeout(TimeoutId id, bool keep_indicator);
|
|
extern void disable_timeouts(const DisableTimeoutParams *timeouts, int count);
|
|
extern void disable_all_timeouts(bool keep_indicators);
|
|
|
|
/* accessors */
|
|
extern bool get_timeout_active(TimeoutId id);
|
|
extern bool get_timeout_indicator(TimeoutId id, bool reset_indicator);
|
|
extern TimestampTz get_timeout_start_time(TimeoutId id);
|
|
extern TimestampTz get_timeout_finish_time(TimeoutId id);
|
|
|
|
#endif /* TIMEOUT_H */
|