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-2002, PostgreSQL Global Development Group
13 * Portions Copyright (c) 1994, Regents of the University of California
15 * $Id: miscadmin.h,v 1.114 2002/12/09 18:21:43 tgl 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 elog(ERROR) or elog(FATAL) to become elog(PANIC) --- that is,
57 * a system-wide reset is forced. Needless to say, only really *critical*
58 * code should be marked as a critical section! Currently, this mechanism
59 * 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 IsUnderPostmaster;
108 extern bool ClientAuthInProgress;
110 extern int PostmasterMain(int argc, char *argv[]);
111 extern void ClosePostmasterPorts(bool pgstat_too);
114 * from utils/init/globals.c
116 extern bool Noversion;
117 extern char *DataDir;
119 extern DLLIMPORT int MyProcPid;
120 extern struct Port *MyProcPort;
121 extern long MyCancelKey;
123 extern char OutputFileName[];
124 extern char pg_pathname[];
127 * done in storage/backendid.h for now.
129 * extern BackendId MyBackendId;
131 extern DLLIMPORT Oid MyDatabaseId;
133 /* Date/Time Configuration
135 * Constants to pass info from runtime environment:
136 * USE_POSTGRES_DATES specifies traditional postgres format for output.
137 * USE_ISO_DATES specifies ISO-compliant format for output.
138 * USE_SQL_DATES specified Oracle/Ingres-compliant format for output.
139 * USE_GERMAN_DATES specifies German-style dd.mm/yyyy date format.
141 * DateStyle specifies preference for date formatting for output.
142 * EuroDates if client prefers dates interpreted and written w/European conventions.
144 * HasCTZSet if client timezone is specified by client.
145 * CDayLight is the apparent daylight savings time status.
146 * CTimeZone is the timezone offset in seconds.
147 * CTZName is the timezone label.
150 #define MAXTZLEN 10 /* max TZ name len, not counting tr. null */
152 #define USE_POSTGRES_DATES 0
153 #define USE_ISO_DATES 1
154 #define USE_SQL_DATES 2
155 #define USE_GERMAN_DATES 3
157 extern int DateStyle;
158 extern bool EuroDates;
159 extern bool HasCTZSet;
160 extern bool CDayLight;
161 extern int CTimeZone;
162 extern char CTZName[];
164 extern bool enableFsync;
165 extern bool allowSystemTableMods;
166 extern DLLIMPORT int SortMem;
167 extern int VacuumMem;
170 * A few postmaster startup options are exported here so the
171 * configuration file processor can access them.
174 extern bool NetServer;
175 extern bool EnableSSL;
176 extern bool SilentMode;
177 extern int MaxBackends;
178 extern int ReservedBackends;
180 extern int PostPortNumber;
181 extern int Unix_socket_permissions;
182 extern char *Unix_socket_group;
183 extern char *UnixSocketDir;
184 extern char *VirtualHost;
187 /*****************************************************************************
189 * POSTGRES directory path definitions. *
190 *****************************************************************************/
192 extern char *DatabaseName;
193 extern char *DatabasePath;
195 /* in utils/misc/database.c */
196 extern void GetRawDatabaseInfo(const char *name, Oid *db_id, char *path);
197 extern char *ExpandDatabasePath(const char *path);
199 /* now in utils/init/miscinit.c */
200 extern void SetDatabaseName(const char *name);
201 extern void SetDatabasePath(const char *path);
204 * AclId system identifier for the user, group, etc.
208 extern char *GetUserNameFromId(AclId userid);
210 extern AclId GetUserId(void);
211 extern void SetUserId(AclId userid);
212 extern AclId GetSessionUserId(void);
213 extern void SetSessionUserId(AclId userid);
214 extern void InitializeSessionUserId(const char *username);
215 extern void InitializeSessionUserIdStandalone(void);
216 extern void SetSessionAuthorization(AclId userid);
218 extern void SetDataDir(const char *dir);
220 extern int FindExec(char *full_path, const char *argv0,
221 const char *binary_name);
222 extern int CheckPathAccess(char *path, char *name, int open_mode);
225 extern void SetCharSet(void);
226 extern char *convertstr(unsigned char *buff, int len, int dest);
229 /* in utils/misc/superuser.c */
230 extern bool superuser(void); /* current user is superuser */
231 extern bool superuser_arg(AclId userid); /* given user is superuser */
232 extern bool is_dbadmin(Oid dbid); /* current user is owner of
236 /*****************************************************************************
238 * POSTGRES processing mode definitions. *
239 *****************************************************************************/
243 * There are three processing modes in POSTGRES. They are
244 * BootstrapProcessing or "bootstrap," InitProcessing or
245 * "initialization," and NormalProcessing or "normal."
247 * The first two processing modes are used during special times. When the
248 * system state indicates bootstrap processing, transactions are all given
249 * transaction id "one" and are consequently guaranteed to commit. This mode
250 * is used during the initial generation of template databases.
252 * Initialization mode: used while starting a backend, until all normal
253 * initialization is complete. Some code behaves differently when executed
254 * in this mode to enable system bootstrapping.
256 * If a POSTGRES binary is in normal mode, then all code may be executed
260 typedef enum ProcessingMode
262 BootstrapProcessing, /* bootstrap creation of template database */
263 InitProcessing, /* initializing system */
264 NormalProcessing /* normal processing */
267 extern ProcessingMode Mode;
269 #define IsBootstrapProcessingMode() ((bool)(Mode == BootstrapProcessing))
270 #define IsInitProcessingMode() ((bool)(Mode == InitProcessing))
271 #define IsNormalProcessingMode() ((bool)(Mode == NormalProcessing))
273 #define SetProcessingMode(mode) \
275 AssertArg((mode) == BootstrapProcessing || \
276 (mode) == InitProcessing || \
277 (mode) == NormalProcessing); \
281 #define GetProcessingMode() Mode
284 /*****************************************************************************
286 * POSTGRES initialization and cleanup definitions. *
287 *****************************************************************************/
289 /* in utils/init/postinit.c */
290 extern void InitPostgres(const char *dbname, const char *username);
291 extern void BaseInit(void);
293 /* in utils/init/miscinit.c */
294 extern bool CreateDataDirLockFile(const char *datadir, bool amPostmaster);
295 extern bool CreateSocketLockFile(const char *socketfile, bool amPostmaster);
296 extern void TouchSocketLockFile(void);
297 extern void RecordSharedMemoryInLockFile(unsigned long id1,
300 extern void ValidatePgVersion(const char *path);
302 /* these externs do not belong here... */
303 extern void IgnoreSystemIndexes(bool mode);
304 extern bool IsIgnoringSystemIndexes(void);
305 extern bool IsCacheInitialized(void);
307 #endif /* MISCADMIN_H */