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-2020, 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;
32 
33 /* GUC-configurable parameters */
34 
35 typedef enum
36 {
37  LOGSTMT_NONE, /* log no statements */
38  LOGSTMT_DDL, /* log data definition statements */
39  LOGSTMT_MOD, /* log modification statements, plus DDL */
40  LOGSTMT_ALL /* log all statements */
41 } LogStmtLevel;
42 
43 extern PGDLLIMPORT int log_statement;
44 
45 extern List *pg_parse_query(const char *query_string);
46 extern List *pg_analyze_and_rewrite(RawStmt *parsetree,
47  const char *query_string,
48  Oid *paramTypes, int numParams,
49  QueryEnvironment *queryEnv);
50 extern List *pg_analyze_and_rewrite_params(RawStmt *parsetree,
51  const char *query_string,
52  ParserSetupHook parserSetup,
53  void *parserSetupArg,
54  QueryEnvironment *queryEnv);
55 extern PlannedStmt *pg_plan_query(Query *querytree, const char *query_string,
56  int cursorOptions,
57  ParamListInfo boundParams);
58 extern List *pg_plan_queries(List *querytrees, const char *query_string,
59  int cursorOptions,
60  ParamListInfo boundParams);
61 
62 extern bool check_max_stack_depth(int *newval, void **extra, GucSource source);
63 extern void assign_max_stack_depth(int newval, void *extra);
64 
65 extern void die(SIGNAL_ARGS);
69 extern void RecoveryConflictInterrupt(ProcSignalReason reason); /* called from SIGUSR1
70  * handler */
71 extern void ProcessClientReadInterrupt(bool blocked);
72 extern void ProcessClientWriteInterrupt(bool blocked);
73 
74 extern void process_postgres_switches(int argc, char *argv[],
75  GucContext ctx, const char **dbname);
76 extern void PostgresMain(int argc, char *argv[],
77  const char *dbname,
78  const char *username) pg_attribute_noreturn();
79 extern long get_stack_depth_rlimit(void);
80 extern void ResetUsage(void);
81 extern void ShowUsage(const char *title);
82 extern int check_log_duration(char *msec_str, bool was_logged);
83 extern void set_debug_options(int debug_flag,
84  GucContext context, GucSource source);
85 extern bool set_plan_disabling_options(const char *arg,
86  GucContext context, GucSource source);
87 extern const char *get_stats_option_name(const char *arg);
88 
89 #endif /* TCOPPROT_H */
int PostAuthDelay
Definition: postgres.c:102
#define pg_attribute_noreturn()
Definition: c.h:145
GucContext
Definition: guc.h:68
bool check_max_stack_depth(int *newval, void **extra, GucSource source)
Definition: postgres.c:3375
CommandDest whereToSendOutput
Definition: postgres.c:91
CommandDest
Definition: dest.h:87
PGDLLIMPORT int log_statement
Definition: postgres.c:96
LogStmtLevel
Definition: tcopprot.h:35
void RecoveryConflictInterrupt(ProcSignalReason reason)
Definition: postgres.c:2896
unsigned int Oid
Definition: postgres_ext.h:31
int max_stack_depth
Definition: postgres.c:99
void PostgresMain(int argc, char *argv[], const char *dbname, const char *username) pg_attribute_noreturn()
Definition: postgres.c:3777
#define PGDLLIMPORT
Definition: c.h:1280
List * pg_analyze_and_rewrite(RawStmt *parsetree, const char *query_string, Oid *paramTypes, int numParams, QueryEnvironment *queryEnv)
Definition: postgres.c:676
GucSource
Definition: guc.h:105
List * pg_plan_queries(List *querytrees, const char *query_string, int cursorOptions, ParamListInfo boundParams)
Definition: postgres.c:943
bool set_plan_disabling_options(const char *arg, GucContext context, GucSource source)
Definition: postgres.c:3436
int check_log_duration(char *msec_str, bool was_logged)
Definition: postgres.c:2322
void quickdie(SIGNAL_ARGS) pg_attribute_noreturn()
Definition: postgres.c:2759
void(* ParserSetupHook)(struct ParseState *pstate, void *arg)
Definition: params.h:108
PGDLLIMPORT const char * debug_query_string
Definition: postgres.c:88
List * pg_parse_query(const char *query_string)
Definition: postgres.c:628
void process_postgres_switches(int argc, char *argv[], GucContext ctx, const char **dbname)
Definition: postgres.c:3518
void set_debug_options(int debug_flag, GucContext context, GucSource source)
Definition: postgres.c:3407
const char * get_stats_option_name(const char *arg)
Definition: postgres.c:3478
List * pg_analyze_and_rewrite_params(RawStmt *parsetree, const char *query_string, ParserSetupHook parserSetup, void *parserSetupArg, QueryEnvironment *queryEnv)
Definition: postgres.c:713
long get_stack_depth_rlimit(void)
Definition: postgres.c:4575
static char * username
Definition: initdb.c:133
#define SIGNAL_ARGS
Definition: c.h:1296
void ProcessClientReadInterrupt(bool blocked)
Definition: postgres.c:526
char * dbname
Definition: streamutil.c:50
#define newval
void StatementCancelHandler(SIGNAL_ARGS)
Definition: postgres.c:2857
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:857
ProcSignalReason
Definition: procsignal.h:30
void * arg
void ShowUsage(const char *title)
Definition: postgres.c:4618
void die(SIGNAL_ARGS)
Definition: postgres.c:2826
void assign_max_stack_depth(int newval, void *extra)
Definition: postgres.c:3392
void FloatExceptionHandler(SIGNAL_ARGS) pg_attribute_noreturn()
Definition: postgres.c:2878
Definition: pg_list.h:50
void ResetUsage(void)
Definition: postgres.c:4611
void ProcessClientWriteInterrupt(bool blocked)
Definition: postgres.c:572