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.122 2003/05/28 17:25:02 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 IsPostmasterEnvironment;
108 extern bool IsUnderPostmaster;
109 extern bool ClientAuthInProgress;
110 extern const bool ExecBackend;
112 extern int PostmasterMain(int argc, char *argv[]);
113 extern void ClosePostmasterPorts(bool pgstat_too);
116 * from utils/init/globals.c
118 extern bool Noversion;
119 extern char *DataDir;
121 extern DLLIMPORT int MyProcPid;
122 extern struct Port *MyProcPort;
123 extern long MyCancelKey;
125 extern char OutputFileName[];
126 extern char pg_pathname[];
129 * done in storage/backendid.h for now.
131 * extern BackendId MyBackendId;
133 extern DLLIMPORT Oid MyDatabaseId;
135 /* Date/Time Configuration
137 * Constants to pass info from runtime environment:
138 * USE_POSTGRES_DATES specifies traditional postgres format for output.
139 * USE_ISO_DATES specifies ISO-compliant format for output.
140 * USE_SQL_DATES specified Oracle/Ingres-compliant format for output.
141 * USE_GERMAN_DATES specifies German-style dd.mm/yyyy date format.
143 * DateStyle specifies preference for date formatting for output.
144 * EuroDates if client prefers dates interpreted and written w/European conventions.
146 * HasCTZSet is true if user has set timezone as a numeric offset from UTC.
147 * If so, CTimeZone is the timezone offset in seconds.
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 int CTimeZone;
162 extern bool enableFsync;
163 extern bool allowSystemTableMods;
164 extern DLLIMPORT int SortMem;
165 extern int VacuumMem;
168 * A few postmaster startup options are exported here so the
169 * configuration file processor can access them.
172 extern bool NetServer;
173 extern bool EnableSSL;
174 extern bool SilentMode;
175 extern int MaxBackends;
176 #define DEF_MAXBACKENDS 32
177 extern int ReservedBackends;
178 extern DLLIMPORT int NBuffers;
179 #define DEF_NBUFFERS (DEF_MAXBACKENDS > 8 ? DEF_MAXBACKENDS * 2 : 16)
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);
203 extern char *GetUserNameFromId(AclId userid);
204 extern AclId GetUserId(void);
205 extern void SetUserId(AclId userid);
206 extern AclId GetSessionUserId(void);
207 extern void SetSessionUserId(AclId userid);
208 extern void InitializeSessionUserId(const char *username);
209 extern void InitializeSessionUserIdStandalone(void);
210 extern void SetSessionAuthorization(AclId userid);
212 extern void SetDataDir(const char *dir);
214 extern int FindExec(char *full_path, const char *argv0,
215 const char *binary_name);
216 extern int CheckPathAccess(char *path, char *name, int open_mode);
219 extern void SetCharSet(void);
220 extern char *convertstr(unsigned char *buff, int len, int dest);
223 /* in utils/misc/superuser.c */
224 extern bool superuser(void); /* current user is superuser */
225 extern bool superuser_arg(AclId userid); /* given user is superuser */
226 extern bool is_dbadmin(Oid dbid); /* current user is owner of
230 /*****************************************************************************
232 * POSTGRES processing mode definitions. *
233 *****************************************************************************/
237 * There are three processing modes in POSTGRES. They are
238 * BootstrapProcessing or "bootstrap," InitProcessing or
239 * "initialization," and NormalProcessing or "normal."
241 * The first two processing modes are used during special times. When the
242 * system state indicates bootstrap processing, transactions are all given
243 * transaction id "one" and are consequently guaranteed to commit. This mode
244 * is used during the initial generation of template databases.
246 * Initialization mode: used while starting a backend, until all normal
247 * initialization is complete. Some code behaves differently when executed
248 * in this mode to enable system bootstrapping.
250 * If a POSTGRES binary is in normal mode, then all code may be executed
254 typedef enum ProcessingMode
256 BootstrapProcessing, /* bootstrap creation of template database */
257 InitProcessing, /* initializing system */
258 NormalProcessing /* normal processing */
261 extern ProcessingMode Mode;
263 #define IsBootstrapProcessingMode() ((bool)(Mode == BootstrapProcessing))
264 #define IsInitProcessingMode() ((bool)(Mode == InitProcessing))
265 #define IsNormalProcessingMode() ((bool)(Mode == NormalProcessing))
267 #define SetProcessingMode(mode) \
269 AssertArg((mode) == BootstrapProcessing || \
270 (mode) == InitProcessing || \
271 (mode) == NormalProcessing); \
275 #define GetProcessingMode() Mode
278 /*****************************************************************************
280 * POSTGRES initialization and cleanup definitions. *
281 *****************************************************************************/
283 /* in utils/init/postinit.c */
284 extern void InitPostgres(const char *dbname, const char *username);
285 extern void BaseInit(void);
287 /* in utils/init/miscinit.c */
288 extern bool CreateDataDirLockFile(const char *datadir, bool amPostmaster);
289 extern bool CreateSocketLockFile(const char *socketfile, bool amPostmaster);
290 extern void TouchSocketLockFile(void);
291 extern void RecordSharedMemoryInLockFile(unsigned long id1,
294 extern void ValidatePgVersion(const char *path);
295 extern void process_preload_libraries(char *preload_libraries_string);
297 /* these externs do not belong here... */
298 extern void IgnoreSystemIndexes(bool mode);
299 extern bool IsIgnoringSystemIndexes(void);
300 extern bool IsCacheInitialized(void);
302 #endif /* MISCADMIN_H */