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-2012, PostgreSQL Global Development Group
14 * Portions Copyright (c) 1994, Regents of the University of California
16 * src/include/miscadmin.h
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 lost connection is handled similarly, although the loss of connection
59 * does not raise a signal, but is detected when we fail to write to the
60 * socket. If there was a signal for a broken connection, we could make use of
61 * it by setting ClientConnectionLost in the signal handler.
63 * A related, but conceptually distinct, mechanism is the "critical section"
64 * mechanism. A critical section not only holds off cancel/die interrupts,
65 * but causes any ereport(ERROR) or ereport(FATAL) to become ereport(PANIC)
66 * --- that is, a system-wide reset is forced. Needless to say, only really
67 * *critical* code should be marked as a critical section! Currently, this
68 * mechanism is only used for XLOG-related code.
70 *****************************************************************************/
73 /* these are marked volatile because they are set by signal handlers: */
74 extern PGDLLIMPORT volatile bool InterruptPending;
75 extern volatile bool QueryCancelPending;
76 extern volatile bool ProcDiePending;
78 extern volatile bool ClientConnectionLost;
80 /* these are marked volatile because they are examined by signal handlers: */
81 extern volatile bool ImmediateInterruptOK;
82 extern PGDLLIMPORT volatile uint32 InterruptHoldoffCount;
83 extern PGDLLIMPORT volatile uint32 CritSectionCount;
85 /* in tcop/postgres.c */
86 extern void ProcessInterrupts(void);
90 #define CHECK_FOR_INTERRUPTS() \
92 if (InterruptPending) \
93 ProcessInterrupts(); \
97 #define CHECK_FOR_INTERRUPTS() \
99 if (UNBLOCKED_SIGNAL_QUEUE()) \
100 pgwin32_dispatch_queued_signals(); \
101 if (InterruptPending) \
102 ProcessInterrupts(); \
107 #define HOLD_INTERRUPTS() (InterruptHoldoffCount++)
109 #define RESUME_INTERRUPTS() \
111 Assert(InterruptHoldoffCount > 0); \
112 InterruptHoldoffCount--; \
115 #define START_CRIT_SECTION() (CritSectionCount++)
117 #define END_CRIT_SECTION() \
119 Assert(CritSectionCount > 0); \
120 CritSectionCount--; \
124 /*****************************************************************************
126 *****************************************************************************/
129 * from utils/init/globals.c
131 extern pid_t PostmasterPid;
132 extern bool IsPostmasterEnvironment;
133 extern PGDLLIMPORT bool IsUnderPostmaster;
134 extern bool IsBinaryUpgrade;
136 extern bool ExitOnAnyError;
138 extern PGDLLIMPORT char *DataDir;
140 extern PGDLLIMPORT int NBuffers;
141 extern int MaxBackends;
142 extern int MaxConnections;
144 extern PGDLLIMPORT int MyProcPid;
145 extern PGDLLIMPORT pg_time_t MyStartTime;
146 extern PGDLLIMPORT struct Port *MyProcPort;
147 extern long MyCancelKey;
148 extern int MyPMChildSlot;
150 extern char OutputFileName[];
151 extern PGDLLIMPORT char my_exec_path[];
152 extern char pkglib_path[];
155 extern char postgres_exec_path[];
159 * done in storage/backendid.h for now.
161 * extern BackendId MyBackendId;
163 extern PGDLLIMPORT Oid MyDatabaseId;
165 extern PGDLLIMPORT Oid MyDatabaseTableSpace;
168 * Date/Time Configuration
170 * DateStyle defines the output formatting choice for date/time types:
171 * USE_POSTGRES_DATES specifies traditional Postgres format
172 * USE_ISO_DATES specifies ISO-compliant format
173 * USE_SQL_DATES specifies Oracle/Ingres-compliant format
174 * USE_GERMAN_DATES specifies German-style dd.mm/yyyy
176 * DateOrder defines the field order to be assumed when reading an
177 * ambiguous date (anything not in YYYY-MM-DD format, with a four-digit
178 * year field first, is taken to be ambiguous):
179 * DATEORDER_YMD specifies field order yy-mm-dd
180 * DATEORDER_DMY specifies field order dd-mm-yy ("European" convention)
181 * DATEORDER_MDY specifies field order mm-dd-yy ("US" convention)
183 * In the Postgres and SQL DateStyles, DateOrder also selects output field
184 * order: day comes before month in DMY style, else month comes before day.
186 * The user-visible "DateStyle" run-time parameter subsumes both of these.
189 /* valid DateStyle values */
190 #define USE_POSTGRES_DATES 0
191 #define USE_ISO_DATES 1
192 #define USE_SQL_DATES 2
193 #define USE_GERMAN_DATES 3
194 #define USE_XSD_DATES 4
196 /* valid DateOrder values */
197 #define DATEORDER_YMD 0
198 #define DATEORDER_DMY 1
199 #define DATEORDER_MDY 2
201 extern int DateStyle;
202 extern int DateOrder;
206 * INTSTYLE_POSTGRES Like Postgres < 8.4 when DateStyle = 'iso'
207 * INTSTYLE_POSTGRES_VERBOSE Like Postgres < 8.4 when DateStyle != 'iso'
208 * INTSTYLE_SQL_STANDARD SQL standard interval literals
209 * INTSTYLE_ISO_8601 ISO-8601-basic formatted intervals
211 #define INTSTYLE_POSTGRES 0
212 #define INTSTYLE_POSTGRES_VERBOSE 1
213 #define INTSTYLE_SQL_STANDARD 2
214 #define INTSTYLE_ISO_8601 3
216 extern int IntervalStyle;
219 * HasCTZSet is true if user has set timezone as a numeric offset from UTC.
220 * If so, CTimeZone is the timezone offset in seconds (using the Unix-ish
221 * sign convention, ie, positive offset is west of UTC, rather than the
222 * SQL-ish convention that positive is east of UTC).
224 extern bool HasCTZSet;
225 extern int CTimeZone;
227 #define MAXTZLEN 10 /* max TZ name len, not counting tr. null */
229 extern bool enableFsync;
230 extern bool allowSystemTableMods;
231 extern PGDLLIMPORT int work_mem;
232 extern PGDLLIMPORT int maintenance_work_mem;
234 extern int VacuumCostPageHit;
235 extern int VacuumCostPageMiss;
236 extern int VacuumCostPageDirty;
237 extern int VacuumCostLimit;
238 extern int VacuumCostDelay;
240 extern int VacuumPageHit;
241 extern int VacuumPageMiss;
242 extern int VacuumPageDirty;
244 extern int VacuumCostBalance;
245 extern bool VacuumCostActive;
248 /* in tcop/postgres.c */
249 extern void check_stack_depth(void);
251 /* in tcop/utility.c */
252 extern void PreventCommandIfReadOnly(const char *cmdname);
253 extern void PreventCommandDuringRecovery(const char *cmdname);
255 /* in utils/misc/guc.c */
256 extern int trace_recovery_messages;
257 extern int trace_recovery(int trace_level);
259 /*****************************************************************************
261 * POSTGRES directory path definitions. *
262 *****************************************************************************/
264 /* flags to be OR'd to form sec_context */
265 #define SECURITY_LOCAL_USERID_CHANGE 0x0001
266 #define SECURITY_RESTRICTED_OPERATION 0x0002
268 extern char *DatabasePath;
270 /* now in utils/init/miscinit.c */
271 extern void SetDatabasePath(const char *path);
273 extern char *GetUserNameFromId(Oid roleid);
274 extern Oid GetUserId(void);
275 extern Oid GetOuterUserId(void);
276 extern Oid GetSessionUserId(void);
277 extern void GetUserIdAndSecContext(Oid *userid, int *sec_context);
278 extern void SetUserIdAndSecContext(Oid userid, int sec_context);
279 extern bool InLocalUserIdChange(void);
280 extern bool InSecurityRestrictedOperation(void);
281 extern void GetUserIdAndContext(Oid *userid, bool *sec_def_context);
282 extern void SetUserIdAndContext(Oid userid, bool sec_def_context);
283 extern void InitializeSessionUserId(const char *rolename);
284 extern void InitializeSessionUserIdStandalone(void);
285 extern void SetSessionAuthorization(Oid userid, bool is_superuser);
286 extern Oid GetCurrentRoleId(void);
287 extern void SetCurrentRoleId(Oid roleid, bool is_superuser);
289 extern void SetDataDir(const char *dir);
290 extern void ChangeToDataDir(void);
291 extern char *make_absolute_path(const char *path);
293 /* in utils/misc/superuser.c */
294 extern bool superuser(void); /* current user is superuser */
295 extern bool superuser_arg(Oid roleid); /* given user is superuser */
298 /*****************************************************************************
300 * POSTGRES processing mode definitions. *
301 *****************************************************************************/
305 * There are three processing modes in POSTGRES. They are
306 * BootstrapProcessing or "bootstrap," InitProcessing or
307 * "initialization," and NormalProcessing or "normal."
309 * The first two processing modes are used during special times. When the
310 * system state indicates bootstrap processing, transactions are all given
311 * transaction id "one" and are consequently guaranteed to commit. This mode
312 * is used during the initial generation of template databases.
314 * Initialization mode: used while starting a backend, until all normal
315 * initialization is complete. Some code behaves differently when executed
316 * in this mode to enable system bootstrapping.
318 * If a POSTGRES binary is in normal mode, then all code may be executed
322 typedef enum ProcessingMode
324 BootstrapProcessing, /* bootstrap creation of template database */
325 InitProcessing, /* initializing system */
326 NormalProcessing /* normal processing */
329 extern ProcessingMode Mode;
331 #define IsBootstrapProcessingMode() ((bool)(Mode == BootstrapProcessing))
332 #define IsInitProcessingMode() ((bool)(Mode == InitProcessing))
333 #define IsNormalProcessingMode() ((bool)(Mode == NormalProcessing))
335 #define SetProcessingMode(mode) \
337 AssertArg((mode) == BootstrapProcessing || \
338 (mode) == InitProcessing || \
339 (mode) == NormalProcessing); \
343 #define GetProcessingMode() Mode
346 /*****************************************************************************
348 * POSTGRES initialization and cleanup definitions. *
349 *****************************************************************************/
351 /* in utils/init/postinit.c */
352 extern void pg_split_opts(char **argv, int *argcp, char *optstr);
353 extern void InitPostgres(const char *in_dbname, Oid dboid, const char *username,
355 extern void BaseInit(void);
357 /* in utils/init/miscinit.c */
358 extern bool IgnoreSystemIndexes;
359 extern PGDLLIMPORT bool process_shared_preload_libraries_in_progress;
360 extern char *shared_preload_libraries_string;
361 extern char *local_preload_libraries_string;
364 * As of 9.1, the contents of the data-directory lock file are:
367 * 1 postmaster PID (or negative of a standalone backend's PID)
368 * 2 data directory path
369 * 3 postmaster start timestamp (time_t representation)
371 * 5 socket directory path (empty on Windows)
372 * 6 first listen_address (IP address or "*"; empty if no TCP port)
373 * 7 shared memory key (not present on Windows)
375 * Lines 6 and up are added via AddToDataDirLockFile() after initial file
376 * creation; they have to be ordered according to time of addition.
378 * The socket lock file, if used, has the same contents as lines 1-5.
380 #define LOCK_FILE_LINE_PID 1
381 #define LOCK_FILE_LINE_DATA_DIR 2
382 #define LOCK_FILE_LINE_START_TIME 3
383 #define LOCK_FILE_LINE_PORT 4
384 #define LOCK_FILE_LINE_SOCKET_DIR 5
385 #define LOCK_FILE_LINE_LISTEN_ADDR 6
386 #define LOCK_FILE_LINE_SHMEM_KEY 7
388 extern void CreateDataDirLockFile(bool amPostmaster);
389 extern void CreateSocketLockFile(const char *socketfile, bool amPostmaster);
390 extern void TouchSocketLockFile(void);
391 extern void AddToDataDirLockFile(int target_line, const char *str);
392 extern void ValidatePgVersion(const char *path);
393 extern void process_shared_preload_libraries(void);
394 extern void process_local_preload_libraries(void);
395 extern void pg_bindtextdomain(const char *domain);
396 extern bool is_authenticated_user_replication_role(void);
398 /* in access/transam/xlog.c */
399 extern bool BackupInProgress(void);
400 extern void CancelBackup(void);
402 #endif /* MISCADMIN_H */