1 /*-------------------------------------------------------------------------
4 * This file contains general postgres administration and initialization
5 * stuff that used to be spread out between the following files:
6 * globals.h global variables
7 * pdir.h directory path crud
8 * pinit.h postgres initialization
9 * pmod.h processing modes
10 * Over time, this has also become the preferred place for widely known
11 * resource-limitation stuff, such as work_mem and check_stack_depth().
13 * Portions Copyright (c) 1996-2008, PostgreSQL Global Development Group
14 * Portions Copyright (c) 1994, Regents of the University of California
16 * $PostgreSQL: pgsql/src/include/miscadmin.h,v 1.204 2008/11/09 00:28:35 tgl Exp $
19 * some of the information in this file should be moved to other files.
21 *-------------------------------------------------------------------------
26 #include "pgtime.h" /* for pg_time_t */
29 #define PG_BACKEND_VERSIONSTR "postgres (PostgreSQL) " PG_VERSION "\n"
32 /*****************************************************************************
33 * System interrupt and critical section handling
35 * There are two types of interrupts that a running backend needs to accept
36 * without messing up its state: QueryCancel (SIGINT) and ProcDie (SIGTERM).
37 * In both cases, we need to be able to clean up the current transaction
38 * gracefully, so we can't respond to the interrupt instantaneously ---
39 * there's no guarantee that internal data structures would be self-consistent
40 * if the code is interrupted at an arbitrary instant. Instead, the signal
41 * handlers set flags that are checked periodically during execution.
43 * The CHECK_FOR_INTERRUPTS() macro is called at strategically located spots
44 * where it is normally safe to accept a cancel or die interrupt. In some
45 * cases, we invoke CHECK_FOR_INTERRUPTS() inside low-level subroutines that
46 * might sometimes be called in contexts that do *not* want to allow a cancel
47 * or die interrupt. The HOLD_INTERRUPTS() and RESUME_INTERRUPTS() macros
48 * allow code to ensure that no cancel or die interrupt will be accepted,
49 * even if CHECK_FOR_INTERRUPTS() gets called in a subroutine. The interrupt
50 * will be held off until CHECK_FOR_INTERRUPTS() is done outside any
51 * HOLD_INTERRUPTS() ... RESUME_INTERRUPTS() section.
53 * Special mechanisms are used to let an interrupt be accepted when we are
54 * waiting for a lock or when we are waiting for command input (but, of
55 * course, only if the interrupt holdoff counter is zero). See the
56 * related code for details.
58 * A related, but conceptually distinct, mechanism is the "critical section"
59 * mechanism. A critical section not only holds off cancel/die interrupts,
60 * but causes any ereport(ERROR) or ereport(FATAL) to become ereport(PANIC)
61 * --- that is, a system-wide reset is forced. Needless to say, only really
62 * *critical* code should be marked as a critical section! Currently, this
63 * mechanism is only used for XLOG-related code.
65 *****************************************************************************/
68 /* these are marked volatile because they are set by signal handlers: */
69 extern PGDLLIMPORT volatile bool InterruptPending;
70 extern volatile bool QueryCancelPending;
71 extern volatile bool ProcDiePending;
73 /* these are marked volatile because they are examined by signal handlers: */
74 extern volatile bool ImmediateInterruptOK;
75 extern PGDLLIMPORT volatile uint32 InterruptHoldoffCount;
76 extern PGDLLIMPORT volatile uint32 CritSectionCount;
78 /* in tcop/postgres.c */
79 extern void ProcessInterrupts(void);
83 #define CHECK_FOR_INTERRUPTS() \
85 if (InterruptPending) \
86 ProcessInterrupts(); \
90 #define CHECK_FOR_INTERRUPTS() \
92 if (UNBLOCKED_SIGNAL_QUEUE()) \
93 pgwin32_dispatch_queued_signals(); \
94 if (InterruptPending) \
95 ProcessInterrupts(); \
100 #define HOLD_INTERRUPTS() (InterruptHoldoffCount++)
102 #define RESUME_INTERRUPTS() \
104 Assert(InterruptHoldoffCount > 0); \
105 InterruptHoldoffCount--; \
108 #define START_CRIT_SECTION() (CritSectionCount++)
110 #define END_CRIT_SECTION() \
112 Assert(CritSectionCount > 0); \
113 CritSectionCount--; \
117 /*****************************************************************************
119 *****************************************************************************/
122 * from utils/init/globals.c
124 extern pid_t PostmasterPid;
125 extern bool IsPostmasterEnvironment;
126 extern bool IsUnderPostmaster;
128 extern bool ExitOnAnyError;
130 extern PGDLLIMPORT char *DataDir;
132 extern PGDLLIMPORT int NBuffers;
133 extern int MaxBackends;
134 extern int MaxConnections;
136 extern PGDLLIMPORT int MyProcPid;
137 extern PGDLLIMPORT pg_time_t MyStartTime;
138 extern PGDLLIMPORT struct Port *MyProcPort;
139 extern long MyCancelKey;
141 extern char OutputFileName[];
142 extern PGDLLIMPORT char my_exec_path[];
143 extern char pkglib_path[];
146 extern char postgres_exec_path[];
150 * done in storage/backendid.h for now.
152 * extern BackendId MyBackendId;
154 extern PGDLLIMPORT Oid MyDatabaseId;
156 extern PGDLLIMPORT Oid MyDatabaseTableSpace;
159 * Date/Time Configuration
161 * DateStyle defines the output formatting choice for date/time types:
162 * USE_POSTGRES_DATES specifies traditional Postgres format
163 * USE_ISO_DATES specifies ISO-compliant format
164 * USE_SQL_DATES specifies Oracle/Ingres-compliant format
165 * USE_GERMAN_DATES specifies German-style dd.mm/yyyy
167 * DateOrder defines the field order to be assumed when reading an
168 * ambiguous date (anything not in YYYY-MM-DD format, with a four-digit
169 * year field first, is taken to be ambiguous):
170 * DATEORDER_YMD specifies field order yy-mm-dd
171 * DATEORDER_DMY specifies field order dd-mm-yy ("European" convention)
172 * DATEORDER_MDY specifies field order mm-dd-yy ("US" convention)
174 * In the Postgres and SQL DateStyles, DateOrder also selects output field
175 * order: day comes before month in DMY style, else month comes before day.
177 * The user-visible "DateStyle" run-time parameter subsumes both of these.
180 /* valid DateStyle values */
181 #define USE_POSTGRES_DATES 0
182 #define USE_ISO_DATES 1
183 #define USE_SQL_DATES 2
184 #define USE_GERMAN_DATES 3
185 #define USE_XSD_DATES 4
187 /* valid DateOrder values */
188 #define DATEORDER_YMD 0
189 #define DATEORDER_DMY 1
190 #define DATEORDER_MDY 2
192 extern int DateStyle;
193 extern int DateOrder;
197 * INTSTYLE_POSTGRES Like Postgres < 8.4 when DateStyle = 'iso'
198 * INTSTYLE_POSTGRES_VERBOSE Like Postgres < 8.4 when DateStyle != 'iso'
199 * INTSTYLE_SQL_STANDARD SQL standard interval literals
201 #define INTSTYLE_POSTGRES 0
202 #define INTSTYLE_POSTGRES_VERBOSE 1
203 #define INTSTYLE_SQL_STANDARD 2
205 extern int IntervalStyle;
208 * HasCTZSet is true if user has set timezone as a numeric offset from UTC.
209 * If so, CTimeZone is the timezone offset in seconds (using the Unix-ish
210 * sign convention, ie, positive offset is west of UTC, rather than the
211 * SQL-ish convention that positive is east of UTC).
213 extern bool HasCTZSet;
214 extern int CTimeZone;
216 #define MAXTZLEN 10 /* max TZ name len, not counting tr. null */
218 extern bool enableFsync;
219 extern bool allowSystemTableMods;
220 extern PGDLLIMPORT int work_mem;
221 extern PGDLLIMPORT int maintenance_work_mem;
223 extern int VacuumCostPageHit;
224 extern int VacuumCostPageMiss;
225 extern int VacuumCostPageDirty;
226 extern int VacuumCostLimit;
227 extern int VacuumCostDelay;
229 extern int VacuumCostBalance;
230 extern bool VacuumCostActive;
233 /* in tcop/postgres.c */
234 extern void check_stack_depth(void);
237 /*****************************************************************************
239 * POSTGRES directory path definitions. *
240 *****************************************************************************/
242 extern char *DatabasePath;
244 /* now in utils/init/miscinit.c */
245 extern void SetDatabasePath(const char *path);
247 extern char *GetUserNameFromId(Oid roleid);
248 extern Oid GetUserId(void);
249 extern Oid GetOuterUserId(void);
250 extern Oid GetSessionUserId(void);
251 extern void GetUserIdAndContext(Oid *userid, bool *sec_def_context);
252 extern void SetUserIdAndContext(Oid userid, bool sec_def_context);
253 extern bool InSecurityDefinerContext(void);
254 extern void InitializeSessionUserId(const char *rolename);
255 extern void InitializeSessionUserIdStandalone(void);
256 extern void SetSessionAuthorization(Oid userid, bool is_superuser);
257 extern Oid GetCurrentRoleId(void);
258 extern void SetCurrentRoleId(Oid roleid, bool is_superuser);
260 extern void SetDataDir(const char *dir);
261 extern void ChangeToDataDir(void);
262 extern char *make_absolute_path(const char *path);
264 /* in utils/misc/superuser.c */
265 extern bool superuser(void); /* current user is superuser */
266 extern bool superuser_arg(Oid roleid); /* given user is superuser */
269 /*****************************************************************************
271 * POSTGRES processing mode definitions. *
272 *****************************************************************************/
276 * There are three processing modes in POSTGRES. They are
277 * BootstrapProcessing or "bootstrap," InitProcessing or
278 * "initialization," and NormalProcessing or "normal."
280 * The first two processing modes are used during special times. When the
281 * system state indicates bootstrap processing, transactions are all given
282 * transaction id "one" and are consequently guaranteed to commit. This mode
283 * is used during the initial generation of template databases.
285 * Initialization mode: used while starting a backend, until all normal
286 * initialization is complete. Some code behaves differently when executed
287 * in this mode to enable system bootstrapping.
289 * If a POSTGRES binary is in normal mode, then all code may be executed
293 typedef enum ProcessingMode
295 BootstrapProcessing, /* bootstrap creation of template database */
296 InitProcessing, /* initializing system */
297 NormalProcessing /* normal processing */
300 extern ProcessingMode Mode;
302 #define IsBootstrapProcessingMode() ((bool)(Mode == BootstrapProcessing))
303 #define IsInitProcessingMode() ((bool)(Mode == InitProcessing))
304 #define IsNormalProcessingMode() ((bool)(Mode == NormalProcessing))
306 #define SetProcessingMode(mode) \
308 AssertArg((mode) == BootstrapProcessing || \
309 (mode) == InitProcessing || \
310 (mode) == NormalProcessing); \
314 #define GetProcessingMode() Mode
317 /*****************************************************************************
319 * POSTGRES initialization and cleanup definitions. *
320 *****************************************************************************/
322 /* in utils/init/postinit.c */
323 extern bool InitPostgres(const char *in_dbname, Oid dboid, const char *username,
325 extern void BaseInit(void);
327 /* in utils/init/miscinit.c */
328 extern bool IgnoreSystemIndexes;
329 extern char *shared_preload_libraries_string;
330 extern char *local_preload_libraries_string;
332 extern void SetReindexProcessing(Oid heapOid, Oid indexOid);
333 extern void ResetReindexProcessing(void);
334 extern bool ReindexIsProcessingHeap(Oid heapOid);
335 extern bool ReindexIsProcessingIndex(Oid indexOid);
336 extern void CreateDataDirLockFile(bool amPostmaster);
337 extern void CreateSocketLockFile(const char *socketfile, bool amPostmaster);
338 extern void TouchSocketLockFile(void);
339 extern void RecordSharedMemoryInLockFile(unsigned long id1,
341 extern void ValidatePgVersion(const char *path);
342 extern void process_shared_preload_libraries(void);
343 extern void process_local_preload_libraries(void);
344 extern void set_text_domain(const char *domain);
346 /* in access/transam/xlog.c */
347 extern bool BackupInProgress(void);
348 extern void CancelBackup(void);
350 #endif /* MISCADMIN_H */