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-2003, PostgreSQL Global Development Group
14 * Portions Copyright (c) 1994, Regents of the University of California
16 * $PostgreSQL: pgsql/src/include/miscadmin.h,v 1.156 2004/04/12 16:19:18 momjian Exp $
19 * some of the information in this file should be moved to
22 *-------------------------------------------------------------------------
28 /*****************************************************************************
29 * System interrupt and critical section handling
31 * There are two types of interrupts that a running backend needs to accept
32 * without messing up its state: QueryCancel (SIGINT) and ProcDie (SIGTERM).
33 * In both cases, we need to be able to clean up the current transaction
34 * gracefully, so we can't respond to the interrupt instantaneously ---
35 * there's no guarantee that internal data structures would be self-consistent
36 * if the code is interrupted at an arbitrary instant. Instead, the signal
37 * handlers set flags that are checked periodically during execution.
39 * The CHECK_FOR_INTERRUPTS() macro is called at strategically located spots
40 * where it is normally safe to accept a cancel or die interrupt. In some
41 * cases, we invoke CHECK_FOR_INTERRUPTS() inside low-level subroutines that
42 * might sometimes be called in contexts that do *not* want to allow a cancel
43 * or die interrupt. The HOLD_INTERRUPTS() and RESUME_INTERRUPTS() macros
44 * allow code to ensure that no cancel or die interrupt will be accepted,
45 * even if CHECK_FOR_INTERRUPTS() gets called in a subroutine. The interrupt
46 * will be held off until CHECK_FOR_INTERRUPTS() is done outside any
47 * HOLD_INTERRUPTS() ... RESUME_INTERRUPTS() section.
49 * Special mechanisms are used to let an interrupt be accepted when we are
50 * waiting for a lock or when we are waiting for command input (but, of
51 * course, only if the interrupt holdoff counter is zero). See the
52 * related code for details.
54 * A related, but conceptually distinct, mechanism is the "critical section"
55 * mechanism. A critical section not only holds off cancel/die interrupts,
56 * but causes any ereport(ERROR) or ereport(FATAL) to become ereport(PANIC)
57 * --- that is, a system-wide reset is forced. Needless to say, only really
58 * *critical* code should be marked as a critical section! Currently, this
59 * mechanism is only used for XLOG-related code.
61 *****************************************************************************/
64 /* these are marked volatile because they are set by signal handlers: */
65 extern DLLIMPORT volatile bool InterruptPending;
66 extern volatile bool QueryCancelPending;
67 extern volatile bool ProcDiePending;
69 /* these are marked volatile because they are examined by signal handlers: */
70 extern volatile bool ImmediateInterruptOK;
71 extern volatile uint32 InterruptHoldoffCount;
72 extern volatile uint32 CritSectionCount;
74 /* in tcop/postgres.c */
75 extern void ProcessInterrupts(void);
78 #define CHECK_FOR_INTERRUPTS() \
80 if (InterruptPending) \
81 ProcessInterrupts(); \
84 #define CHECK_FOR_INTERRUPTS() \
86 if (WaitForSingleObject(pgwin32_signal_event,0) == WAIT_OBJECT_0) \
87 pgwin32_dispatch_queued_signals(); \
88 if (InterruptPending) \
89 ProcessInterrupts(); \
94 #define HOLD_INTERRUPTS() (InterruptHoldoffCount++)
96 #define RESUME_INTERRUPTS() \
98 Assert(InterruptHoldoffCount > 0); \
99 InterruptHoldoffCount--; \
102 #define START_CRIT_SECTION() (CritSectionCount++)
104 #define END_CRIT_SECTION() \
106 Assert(CritSectionCount > 0); \
107 CritSectionCount--; \
111 /*****************************************************************************
113 *****************************************************************************/
116 * from postmaster/postmaster.c
118 extern bool ClientAuthInProgress;
119 extern const bool ExecBackend;
121 extern int PostmasterMain(int argc, char *argv[]);
123 extern void SubPostmasterMain(int argc, char* argv[]);
125 extern void ClosePostmasterPorts(bool pgstat_too);
128 * from utils/init/globals.c
130 extern pid_t PostmasterPid;
131 extern bool IsPostmasterEnvironment;
132 extern bool IsUnderPostmaster;
134 extern bool ExitOnAnyError;
136 extern char *DataDir;
138 extern DLLIMPORT int MyProcPid;
139 extern struct Port *MyProcPort;
140 extern long MyCancelKey;
142 extern char OutputFileName[];
143 extern char pg_pathname[];
146 * done in storage/backendid.h for now.
148 * extern BackendId MyBackendId;
150 extern DLLIMPORT Oid MyDatabaseId;
153 * Date/Time Configuration
155 * DateStyle defines the output formatting choice for date/time types:
156 * USE_POSTGRES_DATES specifies traditional Postgres format
157 * USE_ISO_DATES specifies ISO-compliant format
158 * USE_SQL_DATES specifies Oracle/Ingres-compliant format
159 * USE_GERMAN_DATES specifies German-style dd.mm/yyyy
161 * DateOrder defines the field order to be assumed when reading an
162 * ambiguous date (anything not in YYYY-MM-DD format, with a four-digit
163 * year field first, is taken to be ambiguous):
164 * DATEORDER_YMD specifies field order yy-mm-dd
165 * DATEORDER_DMY specifies field order dd-mm-yy ("European" convention)
166 * DATEORDER_MDY specifies field order mm-dd-yy ("US" convention)
168 * In the Postgres and SQL DateStyles, DateOrder also selects output field
169 * order: day comes before month in DMY style, else month comes before day.
171 * The user-visible "DateStyle" run-time parameter subsumes both of these.
174 /* valid DateStyle values */
175 #define USE_POSTGRES_DATES 0
176 #define USE_ISO_DATES 1
177 #define USE_SQL_DATES 2
178 #define USE_GERMAN_DATES 3
180 /* valid DateOrder values */
181 #define DATEORDER_YMD 0
182 #define DATEORDER_DMY 1
183 #define DATEORDER_MDY 2
185 extern int DateStyle;
186 extern int DateOrder;
189 * HasCTZSet is true if user has set timezone as a numeric offset from UTC.
190 * If so, CTimeZone is the timezone offset in seconds (using the Unix-ish
191 * sign convention, ie, positive offset is west of UTC, rather than the
192 * SQL-ish convention that positive is east of UTC).
194 extern bool HasCTZSet;
195 extern int CTimeZone;
197 #define MAXTZLEN 10 /* max TZ name len, not counting tr. null */
199 extern bool enableFsync;
200 extern bool allowSystemTableMods;
201 extern DLLIMPORT int work_mem;
202 extern DLLIMPORT int maintenance_work_mem;
204 extern int VacuumCostPageHit;
205 extern int VacuumCostPageMiss;
206 extern int VacuumCostPageDirty;
207 extern int VacuumCostLimit;
208 extern int VacuumCostNaptime;
210 extern int VacuumCostBalance;
211 extern bool VacuumCostActive;
214 * A few postmaster startup options are exported here so the
215 * configuration file processor can access them.
217 extern bool EnableSSL;
218 extern bool SilentMode;
219 extern int MaxBackends;
220 extern int ReservedBackends;
221 extern DLLIMPORT int NBuffers;
222 extern int PostPortNumber;
223 extern int Unix_socket_permissions;
224 extern char *Unix_socket_group;
225 extern char *UnixSocketDir;
226 extern char *ListenAddresses;
229 /* in tcop/postgres.c */
230 extern void check_stack_depth(void);
233 /*****************************************************************************
235 * POSTGRES directory path definitions. *
236 *****************************************************************************/
238 extern char *DatabasePath;
240 /* in utils/misc/database.c */
241 extern void GetRawDatabaseInfo(const char *name, Oid *db_id, char *path);
243 /* now in utils/init/miscinit.c */
244 extern void SetDatabasePath(const char *path);
246 extern char *GetUserNameFromId(AclId userid);
247 extern AclId GetUserId(void);
248 extern void SetUserId(AclId userid);
249 extern AclId GetSessionUserId(void);
250 extern void SetSessionUserId(AclId userid);
251 extern void InitializeSessionUserId(const char *username);
252 extern void InitializeSessionUserIdStandalone(void);
253 extern void SetSessionAuthorization(AclId userid, bool is_superuser);
255 extern void SetDataDir(const char *dir);
257 extern int FindExec(char *full_path, const char *argv0,
258 const char *binary_name);
259 extern int CheckPathAccess(char *path, char *name, int open_mode);
261 /* in utils/misc/superuser.c */
262 extern bool superuser(void); /* current user is superuser */
263 extern bool superuser_arg(AclId userid); /* given user is superuser */
266 /*****************************************************************************
268 * POSTGRES processing mode definitions. *
269 *****************************************************************************/
273 * There are three processing modes in POSTGRES. They are
274 * BootstrapProcessing or "bootstrap," InitProcessing or
275 * "initialization," and NormalProcessing or "normal."
277 * The first two processing modes are used during special times. When the
278 * system state indicates bootstrap processing, transactions are all given
279 * transaction id "one" and are consequently guaranteed to commit. This mode
280 * is used during the initial generation of template databases.
282 * Initialization mode: used while starting a backend, until all normal
283 * initialization is complete. Some code behaves differently when executed
284 * in this mode to enable system bootstrapping.
286 * If a POSTGRES binary is in normal mode, then all code may be executed
290 typedef enum ProcessingMode
292 BootstrapProcessing, /* bootstrap creation of template database */
293 InitProcessing, /* initializing system */
294 NormalProcessing /* normal processing */
297 extern ProcessingMode Mode;
299 #define IsBootstrapProcessingMode() ((bool)(Mode == BootstrapProcessing))
300 #define IsInitProcessingMode() ((bool)(Mode == InitProcessing))
301 #define IsNormalProcessingMode() ((bool)(Mode == NormalProcessing))
303 #define SetProcessingMode(mode) \
305 AssertArg((mode) == BootstrapProcessing || \
306 (mode) == InitProcessing || \
307 (mode) == NormalProcessing); \
311 #define GetProcessingMode() Mode
314 /*****************************************************************************
316 * POSTGRES initialization and cleanup definitions. *
317 *****************************************************************************/
319 /* in utils/init/postinit.c */
320 extern void InitPostgres(const char *dbname, const char *username);
321 extern void BaseInit(void);
323 /* in utils/init/miscinit.c */
324 extern void IgnoreSystemIndexes(bool mode);
325 extern bool IsIgnoringSystemIndexes(void);
326 extern void SetReindexProcessing(Oid heapOid, Oid indexOid);
327 extern bool ReindexIsProcessingHeap(Oid heapOid);
328 extern bool ReindexIsProcessingIndex(Oid indexOid);
329 extern void CreateDataDirLockFile(const char *datadir, bool amPostmaster);
330 extern void CreateSocketLockFile(const char *socketfile, bool amPostmaster);
331 extern void TouchSocketLockFile(void);
332 extern void RecordSharedMemoryInLockFile(unsigned long id1,
334 extern void ValidatePgVersion(const char *path);
335 extern void process_preload_libraries(char *preload_libraries_string);
337 #endif /* MISCADMIN_H */