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-2021, 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 
29 extern PGDLLIMPORT const char *debug_query_string;
30 extern int max_stack_depth;
31 extern int PostAuthDelay;
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(RawStmt *parsetree,
49  const char *query_string,
50  Oid *paramTypes, int numParams,
51  QueryEnvironment *queryEnv);
52 extern List *pg_analyze_and_rewrite_params(RawStmt *parsetree,
53  const char *query_string,
54  ParserSetupHook parserSetup,
55  void *parserSetupArg,
56  QueryEnvironment *queryEnv);
57 extern PlannedStmt *pg_plan_query(Query *querytree, const char *query_string,
58  int cursorOptions,
59  ParamListInfo boundParams);
60 extern List *pg_plan_queries(List *querytrees, const char *query_string,
61  int cursorOptions,
62  ParamListInfo boundParams);
63 
64 extern bool check_max_stack_depth(int *newval, void **extra, GucSource source);
65 extern void assign_max_stack_depth(int newval, void *extra);
66 
67 extern void die(SIGNAL_ARGS);
71 extern void RecoveryConflictInterrupt(ProcSignalReason reason); /* called from SIGUSR1
72  * handler */
73 extern void ProcessClientReadInterrupt(bool blocked);
74 extern void ProcessClientWriteInterrupt(bool blocked);
75 
76 extern void process_postgres_switches(int argc, char *argv[],
77  GucContext ctx, const char **dbname);
78 extern void PostgresSingleUserMain(int argc, char *argv[],
79  const char *username) pg_attribute_noreturn();
80 extern void PostgresMain(const char *dbname,
81  const char *username) pg_attribute_noreturn();
82 extern long get_stack_depth_rlimit(void);
83 extern void ResetUsage(void);
84 extern void ShowUsage(const char *title);
85 extern int check_log_duration(char *msec_str, bool was_logged);
86 extern void set_debug_options(int debug_flag,
87  GucContext context, GucSource source);
88 extern bool set_plan_disabling_options(const char *arg,
89  GucContext context, GucSource source);
90 extern const char *get_stats_option_name(const char *arg);
91 
92 #endif /* TCOPPROT_H */
int PostAuthDelay
Definition: postgres.c:103
List * pg_rewrite_query(Query *query)
Definition: postgres.c:737
#define pg_attribute_noreturn()
Definition: c.h:179
GucContext
Definition: guc.h:68
bool check_max_stack_depth(int *newval, void **extra, GucSource source)
Definition: postgres.c:3532
CommandDest whereToSendOutput
Definition: postgres.c:92
CommandDest
Definition: dest.h:87
PGDLLIMPORT int log_statement
Definition: postgres.c:97
LogStmtLevel
Definition: tcopprot.h:36
void RecoveryConflictInterrupt(ProcSignalReason reason)
Definition: postgres.c:2988
unsigned int Oid
Definition: postgres_ext.h:31
int max_stack_depth
Definition: postgres.c:100
#define PGDLLIMPORT
Definition: c.h:1317
List * pg_analyze_and_rewrite(RawStmt *parsetree, const char *query_string, Oid *paramTypes, int numParams, QueryEnvironment *queryEnv)
Definition: postgres.c:642
GucSource
Definition: guc.h:104
List * pg_plan_queries(List *querytrees, const char *query_string, int cursorOptions, ParamListInfo boundParams)
Definition: postgres.c:915
void PostgresMain(const char *dbname, const char *username) pg_attribute_noreturn()
Definition: postgres.c:4015
bool set_plan_disabling_options(const char *arg, GucContext context, GucSource source)
Definition: postgres.c:3593
int check_log_duration(char *msec_str, bool was_logged)
Definition: postgres.c:2324
void quickdie(SIGNAL_ARGS) pg_attribute_noreturn()
Definition: postgres.c:2818
void(* ParserSetupHook)(struct ParseState *pstate, void *arg)
Definition: params.h:108
PGDLLIMPORT const char * debug_query_string
Definition: postgres.c:89
int client_connection_check_interval
Definition: postgres.c:106
List * pg_parse_query(const char *query_string)
Definition: postgres.c:594
const char * username
Definition: pgbench.c:282
void process_postgres_switches(int argc, char *argv[], GucContext ctx, const char **dbname)
Definition: postgres.c:3675
void set_debug_options(int debug_flag, GucContext context, GucSource source)
Definition: postgres.c:3564
const char * get_stats_option_name(const char *arg)
Definition: postgres.c:3635
void PostgresSingleUserMain(int argc, char *argv[], const char *username) pg_attribute_noreturn()
Definition: postgres.c:3928
List * pg_analyze_and_rewrite_params(RawStmt *parsetree, const char *query_string, ParserSetupHook parserSetup, void *parserSetupArg, QueryEnvironment *queryEnv)
Definition: postgres.c:679
long get_stack_depth_rlimit(void)
Definition: postgres.c:4763
#define SIGNAL_ARGS
Definition: c.h:1333
static rewind_source * source
Definition: pg_rewind.c:79
void ProcessClientReadInterrupt(bool blocked)
Definition: postgres.c:492
char * dbname
Definition: streamutil.c:51
#define newval
void StatementCancelHandler(SIGNAL_ARGS)
Definition: postgres.c:2949
Datum querytree(PG_FUNCTION_ARGS)
Definition: _int_bool.c:664
PlannedStmt * pg_plan_query(Query *querytree, const char *query_string, int cursorOptions, ParamListInfo boundParams)
Definition: postgres.c:829
ProcSignalReason
Definition: procsignal.h:30
void * arg
void ShowUsage(const char *title)
Definition: postgres.c:4806
void die(SIGNAL_ARGS)
Definition: postgres.c:2915
void assign_max_stack_depth(int newval, void *extra)
Definition: postgres.c:3549
void FloatExceptionHandler(SIGNAL_ARGS) pg_attribute_noreturn()
Definition: postgres.c:2970
Definition: pg_list.h:50
void ResetUsage(void)
Definition: postgres.c:4799
void ProcessClientWriteInterrupt(bool blocked)
Definition: postgres.c:538