mirror of
https://github.com/postgres/postgres.git
synced 2025-04-25 21:42:33 +03:00
c30f54ad73
Provide a new GUC check_client_connection_interval that can be used to check whether the client connection has gone away, while running very long queries. It is disabled by default. For now this uses a non-standard Linux extension (also adopted by at least one other OS). POLLRDHUP is not defined by POSIX, and other OSes don't have a reliable way to know if a connection was closed without actually trying to read or write. In future we might consider trying to send a no-op/heartbeat message instead, but that could require protocol changes. Author: Sergey Cherkashin <s.cherkashin@postgrespro.ru> Author: Thomas Munro <thomas.munro@gmail.com> Reviewed-by: Thomas Munro <thomas.munro@gmail.com> Reviewed-by: Tatsuo Ishii <ishii@sraoss.co.jp> Reviewed-by: Konstantin Knizhnik <k.knizhnik@postgrespro.ru> Reviewed-by: Zhihong Yu <zyu@yugabyte.com> Reviewed-by: Andres Freund <andres@anarazel.de> Reviewed-by: Maksim Milyutin <milyutinma@gmail.com> Reviewed-by: Tsunakawa, Takayuki/綱川 貴之 <tsunakawa.takay@fujitsu.com> Reviewed-by: Tom Lane <tgl@sss.pgh.pa.us> (much earlier version) Discussion: https://postgr.es/m/77def86b27e41f0efcba411460e929ae%40postgrespro.ru
91 lines
2.6 KiB
C
91 lines
2.6 KiB
C
/*-------------------------------------------------------------------------
|
|
*
|
|
* timeout.h
|
|
* Routines to multiplex SIGALRM interrupts for multiple timeout reasons.
|
|
*
|
|
*
|
|
* Portions Copyright (c) 1996-2021, 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,
|
|
IDLE_SESSION_TIMEOUT,
|
|
CLIENT_CONNECTION_CHECK_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
|
|
} TimeoutType;
|
|
|
|
typedef struct
|
|
{
|
|
TimeoutId id; /* timeout to set */
|
|
TimeoutType type; /* TMPARAM_AFTER or TMPARAM_AT */
|
|
int delay_ms; /* only used for TMPARAM_AFTER */
|
|
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_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 */
|