PostgreSQL Source Code  git master
tcopprot.h
Go to the documentation of this file.
1 /*-------------------------------------------------------------------------
2  *
3  * tcopprot.h
4  * prototypes for postgres.c.
5  *
6  *
7  * Portions Copyright (c) 1996-2023, PostgreSQL Global Development Group
8  * Portions Copyright (c) 1994, Regents of the University of California
9  *
10  * src/include/tcop/tcopprot.h
11  *
12  *-------------------------------------------------------------------------
13  */
14 #ifndef TCOPPROT_H
15 #define TCOPPROT_H
16 
17 #include "nodes/params.h"
18 #include "nodes/parsenodes.h"
19 #include "nodes/plannodes.h"
20 #include "storage/procsignal.h"
21 #include "utils/guc.h"
22 #include "utils/queryenvironment.h"
23 
24 
25 /* Required daylight between max_stack_depth and the kernel limit, in bytes */
26 #define STACK_DEPTH_SLOP (512 * 1024L)
27 
28 extern PGDLLIMPORT CommandDest whereToSendOutput;
29 extern PGDLLIMPORT const char *debug_query_string;
30 extern PGDLLIMPORT int max_stack_depth;
31 extern PGDLLIMPORT int PostAuthDelay;
32 extern PGDLLIMPORT int client_connection_check_interval;
33 
34 /* GUC-configurable parameters */
35 
36 typedef enum
37 {
38  LOGSTMT_NONE, /* log no statements */
39  LOGSTMT_DDL, /* log data definition statements */
40  LOGSTMT_MOD, /* log modification statements, plus DDL */
41  LOGSTMT_ALL /* log all statements */
42 } LogStmtLevel;
43 
44 extern PGDLLIMPORT int log_statement;
45 
46 extern List *pg_parse_query(const char *query_string);
47 extern List *pg_rewrite_query(Query *query);
48 extern List *pg_analyze_and_rewrite_fixedparams(RawStmt *parsetree,
49  const char *query_string,
50  const Oid *paramTypes, int numParams,
51  QueryEnvironment *queryEnv);
52 extern List *pg_analyze_and_rewrite_varparams(RawStmt *parsetree,
53  const char *query_string,
54  Oid **paramTypes,
55  int *numParams,
56  QueryEnvironment *queryEnv);
57 extern List *pg_analyze_and_rewrite_withcb(RawStmt *parsetree,
58  const char *query_string,
59  ParserSetupHook parserSetup,
60  void *parserSetupArg,
61  QueryEnvironment *queryEnv);
62 extern PlannedStmt *pg_plan_query(Query *querytree, const char *query_string,
63  int cursorOptions,
64  ParamListInfo boundParams);
65 extern List *pg_plan_queries(List *querytrees, const char *query_string,
66  int cursorOptions,
67  ParamListInfo boundParams);
68 
69 extern void die(SIGNAL_ARGS);
70 extern void quickdie(SIGNAL_ARGS) pg_attribute_noreturn();
71 extern void StatementCancelHandler(SIGNAL_ARGS);
72 extern void FloatExceptionHandler(SIGNAL_ARGS) pg_attribute_noreturn();
73 extern void HandleRecoveryConflictInterrupt(ProcSignalReason reason);
74 extern void ProcessClientReadInterrupt(bool blocked);
75 extern void ProcessClientWriteInterrupt(bool blocked);
76 
77 extern void process_postgres_switches(int argc, char *argv[],
78  GucContext ctx, const char **dbname);
79 extern void PostgresSingleUserMain(int argc, char *argv[],
80  const char *username) pg_attribute_noreturn();
81 extern void PostgresMain(const char *dbname,
82  const char *username) pg_attribute_noreturn();
83 extern long get_stack_depth_rlimit(void);
84 extern void ResetUsage(void);
85 extern void ShowUsage(const char *title);
86 extern int check_log_duration(char *msec_str, bool was_logged);
87 extern void set_debug_options(int debug_flag,
88  GucContext context, GucSource source);
89 extern bool set_plan_disabling_options(const char *arg,
90  GucContext context, GucSource source);
91 extern const char *get_stats_option_name(const char *arg);
92 
93 #endif /* TCOPPROT_H */
querytree
Datum querytree(PG_FUNCTION_ARGS)
Definition: _int_bool.c:666
PGDLLIMPORT
#define PGDLLIMPORT
Definition: c.h:1326
SIGNAL_ARGS
#define SIGNAL_ARGS
Definition: c.h:1355
pg_attribute_noreturn
#define pg_attribute_noreturn()
Definition: c.h:206
CommandDest
CommandDest
Definition: dest.h:86
GucSource
GucSource
Definition: guc.h:108
GucContext
GucContext
Definition: guc.h:68
ParserSetupHook
void(* ParserSetupHook)(struct ParseState *pstate, void *arg)
Definition: params.h:108
arg
void * arg
Definition: pg_backup_utils.c:27
source
static rewind_source * source
Definition: pg_rewind.c:89
username
const char * username
Definition: pgbench.c:296
Oid
unsigned int Oid
Definition: postgres_ext.h:31
ProcSignalReason
ProcSignalReason
Definition: procsignal.h:31
dbname
char * dbname
Definition: streamutil.c:51
List
Definition: pg_list.h:54
pg_parse_query
List * pg_parse_query(const char *query_string)
Definition: postgres.c:609
process_postgres_switches
void process_postgres_switches(int argc, char *argv[], GucContext ctx, const char **dbname)
Definition: postgres.c:3765
PostAuthDelay
PGDLLIMPORT int PostAuthDelay
Definition: postgres.c:99
FloatExceptionHandler
void FloatExceptionHandler(SIGNAL_ARGS) pg_attribute_noreturn()
Definition: postgres.c:3029
set_debug_options
void set_debug_options(int debug_flag, GucContext context, GucSource source)
Definition: postgres.c:3654
debug_query_string
PGDLLIMPORT const char * debug_query_string
Definition: postgres.c:85
StatementCancelHandler
void StatementCancelHandler(SIGNAL_ARGS)
Definition: postgres.c:3008
get_stack_depth_rlimit
long get_stack_depth_rlimit(void)
Definition: postgres.c:4933
set_plan_disabling_options
bool set_plan_disabling_options(const char *arg, GucContext context, GucSource source)
Definition: postgres.c:3683
PostgresMain
void PostgresMain(const char *dbname, const char *username) pg_attribute_noreturn()
Definition: postgres.c:4127
check_log_duration
int check_log_duration(char *msec_str, bool was_logged)
Definition: postgres.c:2381
pg_analyze_and_rewrite_varparams
List * pg_analyze_and_rewrite_varparams(RawStmt *parsetree, const char *query_string, Oid **paramTypes, int *numParams, QueryEnvironment *queryEnv)
Definition: postgres.c:708
HandleRecoveryConflictInterrupt
void HandleRecoveryConflictInterrupt(ProcSignalReason reason)
Definition: postgres.c:3045
LogStmtLevel
LogStmtLevel
Definition: tcopprot.h:37
LOGSTMT_NONE
@ LOGSTMT_NONE
Definition: tcopprot.h:38
LOGSTMT_MOD
@ LOGSTMT_MOD
Definition: tcopprot.h:40
LOGSTMT_DDL
@ LOGSTMT_DDL
Definition: tcopprot.h:39
LOGSTMT_ALL
@ LOGSTMT_ALL
Definition: tcopprot.h:41
pg_analyze_and_rewrite_withcb
List * pg_analyze_and_rewrite_withcb(RawStmt *parsetree, const char *query_string, ParserSetupHook parserSetup, void *parserSetupArg, QueryEnvironment *queryEnv)
Definition: postgres.c:762
ShowUsage
void ShowUsage(const char *title)
Definition: postgres.c:4972
PostgresSingleUserMain
void PostgresSingleUserMain(int argc, char *argv[], const char *username) pg_attribute_noreturn()
Definition: postgres.c:4017
pg_analyze_and_rewrite_fixedparams
List * pg_analyze_and_rewrite_fixedparams(RawStmt *parsetree, const char *query_string, const Oid *paramTypes, int numParams, QueryEnvironment *queryEnv)
Definition: postgres.c:669
log_statement
PGDLLIMPORT int log_statement
Definition: postgres.c:93
max_stack_depth
PGDLLIMPORT int max_stack_depth
Definition: postgres.c:96
pg_rewrite_query
List * pg_rewrite_query(Query *query)
Definition: postgres.c:802
die
void die(SIGNAL_ARGS)
Definition: postgres.c:2974
get_stats_option_name
const char * get_stats_option_name(const char *arg)
Definition: postgres.c:3725
ProcessClientReadInterrupt
void ProcessClientReadInterrupt(bool blocked)
Definition: postgres.c:507
pg_plan_query
PlannedStmt * pg_plan_query(Query *querytree, const char *query_string, int cursorOptions, ParamListInfo boundParams)
Definition: postgres.c:884
ProcessClientWriteInterrupt
void ProcessClientWriteInterrupt(bool blocked)
Definition: postgres.c:553
ResetUsage
void ResetUsage(void)
Definition: postgres.c:4965
pg_plan_queries
List * pg_plan_queries(List *querytrees, const char *query_string, int cursorOptions, ParamListInfo boundParams)
Definition: postgres.c:970
quickdie
void quickdie(SIGNAL_ARGS) pg_attribute_noreturn()
Definition: postgres.c:2877
whereToSendOutput
PGDLLIMPORT CommandDest whereToSendOutput
Definition: postgres.c:88
client_connection_check_interval
PGDLLIMPORT int client_connection_check_interval
Definition: postgres.c:102