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-2004, PostgreSQL Global Development Group
14 * Portions Copyright (c) 1994, Regents of the University of California
16 * $PostgreSQL: pgsql/src/include/miscadmin.h,v 1.170 2004/10/18 16:24:40 momjian Exp $
19 * some of the information in this file should be moved to other files.
21 *-------------------------------------------------------------------------
27 #define PG_VERSIONSTR "postgres (PostgreSQL) " PG_VERSION "\n"
30 /*****************************************************************************
31 * System interrupt and critical section handling
33 * There are two types of interrupts that a running backend needs to accept
34 * without messing up its state: QueryCancel (SIGINT) and ProcDie (SIGTERM).
35 * In both cases, we need to be able to clean up the current transaction
36 * gracefully, so we can't respond to the interrupt instantaneously ---
37 * there's no guarantee that internal data structures would be self-consistent
38 * if the code is interrupted at an arbitrary instant. Instead, the signal
39 * handlers set flags that are checked periodically during execution.
41 * The CHECK_FOR_INTERRUPTS() macro is called at strategically located spots
42 * where it is normally safe to accept a cancel or die interrupt. In some
43 * cases, we invoke CHECK_FOR_INTERRUPTS() inside low-level subroutines that
44 * might sometimes be called in contexts that do *not* want to allow a cancel
45 * or die interrupt. The HOLD_INTERRUPTS() and RESUME_INTERRUPTS() macros
46 * allow code to ensure that no cancel or die interrupt will be accepted,
47 * even if CHECK_FOR_INTERRUPTS() gets called in a subroutine. The interrupt
48 * will be held off until CHECK_FOR_INTERRUPTS() is done outside any
49 * HOLD_INTERRUPTS() ... RESUME_INTERRUPTS() section.
51 * Special mechanisms are used to let an interrupt be accepted when we are
52 * waiting for a lock or when we are waiting for command input (but, of
53 * course, only if the interrupt holdoff counter is zero). See the
54 * related code for details.
56 * A related, but conceptually distinct, mechanism is the "critical section"
57 * mechanism. A critical section not only holds off cancel/die interrupts,
58 * but causes any ereport(ERROR) or ereport(FATAL) to become ereport(PANIC)
59 * --- that is, a system-wide reset is forced. Needless to say, only really
60 * *critical* code should be marked as a critical section! Currently, this
61 * mechanism is only used for XLOG-related code.
63 *****************************************************************************/
66 /* these are marked volatile because they are set by signal handlers: */
67 extern DLLIMPORT volatile bool InterruptPending;
68 extern volatile bool QueryCancelPending;
69 extern volatile bool ProcDiePending;
71 /* these are marked volatile because they are examined by signal handlers: */
72 extern volatile bool ImmediateInterruptOK;
73 extern volatile uint32 InterruptHoldoffCount;
74 extern volatile uint32 CritSectionCount;
76 /* in tcop/postgres.c */
77 extern void ProcessInterrupts(void);
81 #define CHECK_FOR_INTERRUPTS() \
83 if (InterruptPending) \
84 ProcessInterrupts(); \
89 #define CHECK_FOR_INTERRUPTS() \
91 if (WaitForSingleObjectEx(pgwin32_signal_event,0,TRUE) == WAIT_OBJECT_0) \
92 pgwin32_dispatch_queued_signals(); \
93 if (InterruptPending) \
94 ProcessInterrupts(); \
99 #define HOLD_INTERRUPTS() (InterruptHoldoffCount++)
101 #define RESUME_INTERRUPTS() \
103 Assert(InterruptHoldoffCount > 0); \
104 InterruptHoldoffCount--; \
107 #define START_CRIT_SECTION() (CritSectionCount++)
109 #define END_CRIT_SECTION() \
111 Assert(CritSectionCount > 0); \
112 CritSectionCount--; \
116 /*****************************************************************************
118 *****************************************************************************/
121 * from utils/init/globals.c
123 #ifndef WIN32_CLIENT_ONLY
124 extern pid_t PostmasterPid;
126 extern bool IsPostmasterEnvironment;
127 extern bool IsUnderPostmaster;
129 extern bool ExitOnAnyError;
131 extern char *DataDir;
133 extern DLLIMPORT int NBuffers;
134 extern int MaxBackends;
136 extern DLLIMPORT int MyProcPid;
137 extern struct Port *MyProcPort;
138 extern long MyCancelKey;
140 extern char OutputFileName[];
141 extern char my_exec_path[];
142 extern char pkglib_path[];
145 extern char postgres_exec_path[];
149 * done in storage/backendid.h for now.
151 * extern BackendId MyBackendId;
153 extern DLLIMPORT Oid MyDatabaseId;
155 extern DLLIMPORT Oid MyDatabaseTableSpace;
158 * Date/Time Configuration
160 * DateStyle defines the output formatting choice for date/time types:
161 * USE_POSTGRES_DATES specifies traditional Postgres format
162 * USE_ISO_DATES specifies ISO-compliant format
163 * USE_SQL_DATES specifies Oracle/Ingres-compliant format
164 * USE_GERMAN_DATES specifies German-style dd.mm/yyyy
166 * DateOrder defines the field order to be assumed when reading an
167 * ambiguous date (anything not in YYYY-MM-DD format, with a four-digit
168 * year field first, is taken to be ambiguous):
169 * DATEORDER_YMD specifies field order yy-mm-dd
170 * DATEORDER_DMY specifies field order dd-mm-yy ("European" convention)
171 * DATEORDER_MDY specifies field order mm-dd-yy ("US" convention)
173 * In the Postgres and SQL DateStyles, DateOrder also selects output field
174 * order: day comes before month in DMY style, else month comes before day.
176 * The user-visible "DateStyle" run-time parameter subsumes both of these.
179 /* valid DateStyle values */
180 #define USE_POSTGRES_DATES 0
181 #define USE_ISO_DATES 1
182 #define USE_SQL_DATES 2
183 #define USE_GERMAN_DATES 3
185 /* valid DateOrder values */
186 #define DATEORDER_YMD 0
187 #define DATEORDER_DMY 1
188 #define DATEORDER_MDY 2
190 extern int DateStyle;
191 extern int DateOrder;
194 * HasCTZSet is true if user has set timezone as a numeric offset from UTC.
195 * If so, CTimeZone is the timezone offset in seconds (using the Unix-ish
196 * sign convention, ie, positive offset is west of UTC, rather than the
197 * SQL-ish convention that positive is east of UTC).
199 extern bool HasCTZSet;
200 extern int CTimeZone;
202 #define MAXTZLEN 10 /* max TZ name len, not counting tr. null */
204 extern bool enableFsync;
205 extern bool allowSystemTableMods;
206 extern DLLIMPORT int work_mem;
207 extern DLLIMPORT int maintenance_work_mem;
209 extern int VacuumCostPageHit;
210 extern int VacuumCostPageMiss;
211 extern int VacuumCostPageDirty;
212 extern int VacuumCostLimit;
213 extern int VacuumCostDelay;
215 extern int VacuumCostBalance;
216 extern bool VacuumCostActive;
219 /* in tcop/postgres.c */
220 extern void check_stack_depth(void);
223 /*****************************************************************************
225 * POSTGRES directory path definitions. *
226 *****************************************************************************/
228 extern char *DatabasePath;
230 /* in utils/misc/database.c */
231 extern void GetRawDatabaseInfo(const char *name, Oid *db_id, Oid *db_tablespace);
233 /* now in utils/init/miscinit.c */
234 extern void SetDatabasePath(const char *path);
236 extern char *GetUserNameFromId(AclId userid);
237 extern AclId GetUserId(void);
238 extern void SetUserId(AclId userid);
239 extern AclId GetSessionUserId(void);
240 extern void SetSessionUserId(AclId userid);
241 extern void InitializeSessionUserId(const char *username);
242 extern void InitializeSessionUserIdStandalone(void);
243 extern void SetSessionAuthorization(AclId userid, bool is_superuser);
245 extern void SetDataDir(const char *dir);
246 extern char *make_absolute_path(const char *path);
248 /* in utils/misc/superuser.c */
249 extern bool superuser(void); /* current user is superuser */
250 extern bool superuser_arg(AclId userid); /* given user is superuser */
253 /*****************************************************************************
255 * POSTGRES processing mode definitions. *
256 *****************************************************************************/
260 * There are three processing modes in POSTGRES. They are
261 * BootstrapProcessing or "bootstrap," InitProcessing or
262 * "initialization," and NormalProcessing or "normal."
264 * The first two processing modes are used during special times. When the
265 * system state indicates bootstrap processing, transactions are all given
266 * transaction id "one" and are consequently guaranteed to commit. This mode
267 * is used during the initial generation of template databases.
269 * Initialization mode: used while starting a backend, until all normal
270 * initialization is complete. Some code behaves differently when executed
271 * in this mode to enable system bootstrapping.
273 * If a POSTGRES binary is in normal mode, then all code may be executed
277 typedef enum ProcessingMode
279 BootstrapProcessing, /* bootstrap creation of template database */
280 InitProcessing, /* initializing system */
281 NormalProcessing /* normal processing */
284 extern ProcessingMode Mode;
286 #define IsBootstrapProcessingMode() ((bool)(Mode == BootstrapProcessing))
287 #define IsInitProcessingMode() ((bool)(Mode == InitProcessing))
288 #define IsNormalProcessingMode() ((bool)(Mode == NormalProcessing))
290 #define SetProcessingMode(mode) \
292 AssertArg((mode) == BootstrapProcessing || \
293 (mode) == InitProcessing || \
294 (mode) == NormalProcessing); \
298 #define GetProcessingMode() Mode
301 /*****************************************************************************
303 * POSTGRES initialization and cleanup definitions. *
304 *****************************************************************************/
306 /* in utils/init/postinit.c */
307 extern void InitPostgres(const char *dbname, const char *username);
308 extern void BaseInit(void);
310 /* in utils/init/miscinit.c */
311 extern void IgnoreSystemIndexes(bool mode);
312 extern bool IsIgnoringSystemIndexes(void);
313 extern void SetReindexProcessing(Oid heapOid, Oid indexOid);
314 extern void ResetReindexProcessing(void);
315 extern bool ReindexIsProcessingHeap(Oid heapOid);
316 extern bool ReindexIsProcessingIndex(Oid indexOid);
317 extern void CreateDataDirLockFile(const char *datadir, bool amPostmaster);
318 extern void CreateSocketLockFile(const char *socketfile, bool amPostmaster);
319 extern void TouchSocketLockFile(void);
320 extern void RecordSharedMemoryInLockFile(unsigned long id1,
322 extern void ValidatePgVersion(const char *path);
323 extern void process_preload_libraries(char *preload_libraries_string);
325 #endif /* MISCADMIN_H */