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
12 * Portions Copyright (c) 1996-2003, PostgreSQL Global Development Group
13 * Portions Copyright (c) 1994, Regents of the University of California
15 * $Id: miscadmin.h,v 1.131 2003/08/04 02:40:10 momjian Exp $
18 * some of the information in this file should be moved to
21 *-------------------------------------------------------------------------
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;
75 extern void ProcessInterrupts(void);
77 #define CHECK_FOR_INTERRUPTS() \
79 if (InterruptPending) \
80 ProcessInterrupts(); \
83 #define HOLD_INTERRUPTS() (InterruptHoldoffCount++)
85 #define RESUME_INTERRUPTS() \
87 Assert(InterruptHoldoffCount > 0); \
88 InterruptHoldoffCount--; \
91 #define START_CRIT_SECTION() (CritSectionCount++)
93 #define END_CRIT_SECTION() \
95 Assert(CritSectionCount > 0); \
100 /*****************************************************************************
102 *****************************************************************************/
105 * from postmaster/postmaster.c
107 extern bool ClientAuthInProgress;
108 extern const bool ExecBackend;
110 extern int PostmasterMain(int argc, char *argv[]);
111 extern void ClosePostmasterPorts(bool pgstat_too);
114 * from utils/init/globals.c
116 extern bool IsPostmasterEnvironment;
117 extern bool IsUnderPostmaster;
119 extern bool ExitOnAnyError;
121 extern bool Noversion;
122 extern char *DataDir;
124 extern DLLIMPORT int MyProcPid;
125 extern struct Port *MyProcPort;
126 extern long MyCancelKey;
128 extern char OutputFileName[];
129 extern char pg_pathname[];
132 * done in storage/backendid.h for now.
134 * extern BackendId MyBackendId;
136 extern DLLIMPORT Oid MyDatabaseId;
139 * Date/Time Configuration
141 * DateStyle defines the output formatting choice for date/time types:
142 * USE_POSTGRES_DATES specifies traditional Postgres format
143 * USE_ISO_DATES specifies ISO-compliant format
144 * USE_SQL_DATES specifies Oracle/Ingres-compliant format
145 * USE_GERMAN_DATES specifies German-style dd.mm/yyyy
147 * DateOrder defines the field order to be assumed when reading an
148 * ambiguous date (anything not in YYYY-MM-DD format, with a four-digit
149 * year field first, is taken to be ambiguous):
150 * DATEORDER_YMD specifies field order yy-mm-dd
151 * DATEORDER_DMY specifies field order dd-mm-yy ("European" convention)
152 * DATEORDER_MDY specifies field order mm-dd-yy ("US" convention)
154 * In the Postgres and SQL DateStyles, DateOrder also selects output field
155 * order: day comes before month in DMY style, else month comes before day.
157 * The user-visible "DateStyle" run-time parameter subsumes both of these.
160 /* valid DateStyle values */
161 #define USE_POSTGRES_DATES 0
162 #define USE_ISO_DATES 1
163 #define USE_SQL_DATES 2
164 #define USE_GERMAN_DATES 3
166 /* valid DateOrder values */
167 #define DATEORDER_YMD 0
168 #define DATEORDER_DMY 1
169 #define DATEORDER_MDY 2
171 extern int DateStyle;
172 extern int DateOrder;
175 * HasCTZSet is true if user has set timezone as a numeric offset from UTC.
176 * If so, CTimeZone is the timezone offset in seconds (using the Unix-ish
177 * sign convention, ie, positive offset is west of UTC, rather than the
178 * SQL-ish convention that positive is east of UTC).
180 extern bool HasCTZSet;
181 extern int CTimeZone;
183 #define MAXTZLEN 10 /* max TZ name len, not counting tr. null */
185 extern bool enableFsync;
186 extern bool allowSystemTableMods;
187 extern DLLIMPORT int SortMem;
188 extern int VacuumMem;
191 * A few postmaster startup options are exported here so the
192 * configuration file processor can access them.
195 extern bool NetServer;
196 extern bool EnableSSL;
197 extern bool SilentMode;
198 extern int MaxBackends;
200 #define DEF_MAXBACKENDS 32
201 extern int ReservedBackends;
202 extern DLLIMPORT int NBuffers;
204 #define DEF_NBUFFERS (DEF_MAXBACKENDS > 8 ? DEF_MAXBACKENDS * 2 : 16)
205 extern int PostPortNumber;
206 extern int Unix_socket_permissions;
207 extern char *Unix_socket_group;
208 extern char *UnixSocketDir;
209 extern char *VirtualHost;
212 /*****************************************************************************
214 * POSTGRES directory path definitions. *
215 *****************************************************************************/
217 extern char *DatabasePath;
219 /* in utils/misc/database.c */
220 extern void GetRawDatabaseInfo(const char *name, Oid *db_id, char *path);
221 extern char *ExpandDatabasePath(const char *path);
223 /* now in utils/init/miscinit.c */
224 extern void SetDatabasePath(const char *path);
226 extern char *GetUserNameFromId(AclId userid);
227 extern AclId GetUserId(void);
228 extern void SetUserId(AclId userid);
229 extern AclId GetSessionUserId(void);
230 extern void SetSessionUserId(AclId userid);
231 extern void InitializeSessionUserId(const char *username);
232 extern void InitializeSessionUserIdStandalone(void);
233 extern void SetSessionAuthorization(AclId userid, bool is_superuser);
235 extern void SetDataDir(const char *dir);
237 extern int FindExec(char *full_path, const char *argv0,
238 const char *binary_name);
239 extern int CheckPathAccess(char *path, char *name, int open_mode);
242 extern void SetCharSet(void);
243 extern char *convertstr(unsigned char *buff, int len, int dest);
246 /* in utils/misc/superuser.c */
247 extern bool superuser(void); /* current user is superuser */
248 extern bool superuser_arg(AclId userid); /* given user is superuser */
251 /*****************************************************************************
253 * POSTGRES processing mode definitions. *
254 *****************************************************************************/
258 * There are three processing modes in POSTGRES. They are
259 * BootstrapProcessing or "bootstrap," InitProcessing or
260 * "initialization," and NormalProcessing or "normal."
262 * The first two processing modes are used during special times. When the
263 * system state indicates bootstrap processing, transactions are all given
264 * transaction id "one" and are consequently guaranteed to commit. This mode
265 * is used during the initial generation of template databases.
267 * Initialization mode: used while starting a backend, until all normal
268 * initialization is complete. Some code behaves differently when executed
269 * in this mode to enable system bootstrapping.
271 * If a POSTGRES binary is in normal mode, then all code may be executed
275 typedef enum ProcessingMode
277 BootstrapProcessing, /* bootstrap creation of template database */
278 InitProcessing, /* initializing system */
279 NormalProcessing /* normal processing */
282 extern ProcessingMode Mode;
284 #define IsBootstrapProcessingMode() ((bool)(Mode == BootstrapProcessing))
285 #define IsInitProcessingMode() ((bool)(Mode == InitProcessing))
286 #define IsNormalProcessingMode() ((bool)(Mode == NormalProcessing))
288 #define SetProcessingMode(mode) \
290 AssertArg((mode) == BootstrapProcessing || \
291 (mode) == InitProcessing || \
292 (mode) == NormalProcessing); \
296 #define GetProcessingMode() Mode
299 /*****************************************************************************
301 * POSTGRES initialization and cleanup definitions. *
302 *****************************************************************************/
304 /* in utils/init/postinit.c */
305 extern void InitPostgres(const char *dbname, const char *username);
306 extern void BaseInit(void);
308 /* in utils/init/miscinit.c */
309 extern void CreateDataDirLockFile(const char *datadir, bool amPostmaster);
310 extern void CreateSocketLockFile(const char *socketfile, bool amPostmaster);
311 extern void TouchSocketLockFile(void);
312 extern void RecordSharedMemoryInLockFile(unsigned long id1,
315 extern void ValidatePgVersion(const char *path);
316 extern void process_preload_libraries(char *preload_libraries_string);
318 /* these externs do not belong here... */
319 extern void IgnoreSystemIndexes(bool mode);
320 extern bool IsIgnoringSystemIndexes(void);
321 extern bool IsCacheInitialized(void);
323 #endif /* MISCADMIN_H */