granicus.if.org Git - postgresql/blob - src/include/miscadmin.h

   1 /*-------------------------------------------------------------------------
   2  *
   3  * miscadmin.h
   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  *
  11  *
  12  * Portions Copyright (c) 1996-2003, PostgreSQL Global Development Group
  13  * Portions Copyright (c) 1994, Regents of the University of California
  14  *
  15  * $Id: miscadmin.h,v 1.135 2003/11/13 00:40:01 wieck Exp $
  16  *
  17  * NOTES
  18  *        some of the information in this file should be moved to
  19  *        other files.
  20  *
  21  *-------------------------------------------------------------------------
  22  */
  23 #ifndef MISCADMIN_H
  24 #define MISCADMIN_H
  25
  26
  27
  28 /*****************************************************************************
  29  *        System interrupt and critical section handling
  30  *
  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.
  38  *
  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.
  48  *
  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.
  53  *
  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.
  60  *
  61  *****************************************************************************/
  62
  63 /* in globals.c */
  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;
  68
  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;
  73
  74 /* in postgres.c */
  75 extern void ProcessInterrupts(void);
  76
  77 #define CHECK_FOR_INTERRUPTS() \
  78         do { \
  79                 if (InterruptPending) \
  80                         ProcessInterrupts(); \
  81         } while(0)
  82
  83 #define HOLD_INTERRUPTS()  (InterruptHoldoffCount++)
  84
  85 #define RESUME_INTERRUPTS() \
  86         do { \
  87                 Assert(InterruptHoldoffCount > 0); \
  88                 InterruptHoldoffCount--; \
  89         } while(0)
  90
  91 #define START_CRIT_SECTION()  (CritSectionCount++)
  92
  93 #define END_CRIT_SECTION() \
  94         do { \
  95                 Assert(CritSectionCount > 0); \
  96                 CritSectionCount--; \
  97         } while(0)
  98
  99 #define PG_DELAY(_msec) \
 100 { \
 101         struct timeval delay; \
 102         delay.tv_sec = (_msec) / 1000; \
 103         delay.tv_usec = ((_msec) % 1000) * 1000; \
 104         (void) select(0, NULL, NULL, NULL, &delay); \
 105 }
 106
 107 /*****************************************************************************
 108  *        globals.h --                                                                                                                   *
 109  *****************************************************************************/
 110
 111 /*
 112  * from postmaster/postmaster.c
 113  */
 114 extern bool ClientAuthInProgress;
 115 extern const bool ExecBackend;
 116
 117 extern int      PostmasterMain(int argc, char *argv[]);
 118 extern void ClosePostmasterPorts(bool pgstat_too);
 119
 120 /*
 121  * from utils/init/globals.c
 122  */
 123 extern bool IsPostmasterEnvironment;
 124 extern bool IsUnderPostmaster;
 125
 126 extern bool ExitOnAnyError;
 127
 128 extern bool Noversion;
 129 extern char *DataDir;
 130
 131 extern DLLIMPORT int MyProcPid;
 132 extern struct Port *MyProcPort;
 133 extern long MyCancelKey;
 134
 135 extern char OutputFileName[];
 136 extern char pg_pathname[];
 137
 138 /*
 139  * done in storage/backendid.h for now.
 140  *
 141  * extern BackendId    MyBackendId;
 142  */
 143 extern DLLIMPORT Oid MyDatabaseId;
 144
 145 /*
 146  * Date/Time Configuration
 147  *
 148  * DateStyle defines the output formatting choice for date/time types:
 149  *      USE_POSTGRES_DATES specifies traditional Postgres format
 150  *      USE_ISO_DATES specifies ISO-compliant format
 151  *      USE_SQL_DATES specifies Oracle/Ingres-compliant format
 152  *      USE_GERMAN_DATES specifies German-style dd.mm/yyyy
 153  *
 154  * DateOrder defines the field order to be assumed when reading an
 155  * ambiguous date (anything not in YYYY-MM-DD format, with a four-digit
 156  * year field first, is taken to be ambiguous):
 157  *      DATEORDER_YMD specifies field order yy-mm-dd
 158  *      DATEORDER_DMY specifies field order dd-mm-yy ("European" convention)
 159  *      DATEORDER_MDY specifies field order mm-dd-yy ("US" convention)
 160  *
 161  * In the Postgres and SQL DateStyles, DateOrder also selects output field
 162  * order: day comes before month in DMY style, else month comes before day.
 163  *
 164  * The user-visible "DateStyle" run-time parameter subsumes both of these.
 165  */
 166
 167 /* valid DateStyle values */
 168 #define USE_POSTGRES_DATES              0
 169 #define USE_ISO_DATES                   1
 170 #define USE_SQL_DATES                   2
 171 #define USE_GERMAN_DATES                3
 172
 173 /* valid DateOrder values */
 174 #define DATEORDER_YMD                   0
 175 #define DATEORDER_DMY                   1
 176 #define DATEORDER_MDY                   2
 177
 178 extern int      DateStyle;
 179 extern int      DateOrder;
 180
 181 /*
 182  * HasCTZSet is true if user has set timezone as a numeric offset from UTC.
 183  * If so, CTimeZone is the timezone offset in seconds (using the Unix-ish
 184  * sign convention, ie, positive offset is west of UTC, rather than the
 185  * SQL-ish convention that positive is east of UTC).
 186  */
 187 extern bool HasCTZSet;
 188 extern int      CTimeZone;
 189
 190 #define MAXTZLEN                10              /* max TZ name len, not counting tr. null */
 191
 192 extern bool enableFsync;
 193 extern bool allowSystemTableMods;
 194 extern DLLIMPORT int SortMem;
 195 extern int      VacuumMem;
 196
 197 /*
 198  *      A few postmaster startup options are exported here so the
 199  *      configuration file processor can access them.
 200  */
 201 extern bool NetServer;
 202 extern bool EnableSSL;
 203 extern bool SilentMode;
 204 extern int      MaxBackends;
 205 extern int      ReservedBackends;
 206 extern DLLIMPORT int NBuffers;
 207 extern int      PostPortNumber;
 208 extern int      Unix_socket_permissions;
 209 extern char *Unix_socket_group;
 210 extern char *UnixSocketDir;
 211 extern char *VirtualHost;
 212
 213
 214 /*****************************************************************************
 215  *        pdir.h --                                                                                                                              *
 216  *                      POSTGRES directory path definitions.                                                     *
 217  *****************************************************************************/
 218
 219 extern char *DatabasePath;
 220
 221 /* in utils/misc/database.c */
 222 extern void GetRawDatabaseInfo(const char *name, Oid *db_id, char *path);
 223 extern char *ExpandDatabasePath(const char *path);
 224
 225 /* now in utils/init/miscinit.c */
 226 extern void SetDatabasePath(const char *path);
 227
 228 extern char *GetUserNameFromId(AclId userid);
 229 extern AclId GetUserId(void);
 230 extern void SetUserId(AclId userid);
 231 extern AclId GetSessionUserId(void);
 232 extern void SetSessionUserId(AclId userid);
 233 extern void InitializeSessionUserId(const char *username);
 234 extern void InitializeSessionUserIdStandalone(void);
 235 extern void SetSessionAuthorization(AclId userid, bool is_superuser);
 236
 237 extern void SetDataDir(const char *dir);
 238
 239 extern int FindExec(char *full_path, const char *argv0,
 240                  const char *binary_name);
 241 extern int      CheckPathAccess(char *path, char *name, int open_mode);
 242
 243 /* in utils/misc/superuser.c */
 244 extern bool superuser(void);    /* current user is superuser */
 245 extern bool superuser_arg(AclId userid);                /* given user is superuser */
 246
 247
 248 /*****************************************************************************
 249  *        pmod.h --                                                                                                                              *
 250  *                      POSTGRES processing mode definitions.                                                    *
 251  *****************************************************************************/
 252
 253 /*
 254  * Description:
 255  *              There are three processing modes in POSTGRES.  They are
 256  * BootstrapProcessing or "bootstrap," InitProcessing or
 257  * "initialization," and NormalProcessing or "normal."
 258  *
 259  * The first two processing modes are used during special times. When the
 260  * system state indicates bootstrap processing, transactions are all given
 261  * transaction id "one" and are consequently guaranteed to commit. This mode
 262  * is used during the initial generation of template databases.
 263  *
 264  * Initialization mode: used while starting a backend, until all normal
 265  * initialization is complete.  Some code behaves differently when executed
 266  * in this mode to enable system bootstrapping.
 267  *
 268  * If a POSTGRES binary is in normal mode, then all code may be executed
 269  * normally.
 270  */
 271
 272 typedef enum ProcessingMode
 273 {
 274         BootstrapProcessing,            /* bootstrap creation of template database */
 275         InitProcessing,                         /* initializing system */
 276         NormalProcessing                        /* normal processing */
 277 } ProcessingMode;
 278
 279 extern ProcessingMode Mode;
 280
 281 #define IsBootstrapProcessingMode() ((bool)(Mode == BootstrapProcessing))
 282 #define IsInitProcessingMode() ((bool)(Mode == InitProcessing))
 283 #define IsNormalProcessingMode() ((bool)(Mode == NormalProcessing))
 284
 285 #define SetProcessingMode(mode) \
 286         do { \
 287                 AssertArg((mode) == BootstrapProcessing || \
 288                                   (mode) == InitProcessing || \
 289                                   (mode) == NormalProcessing); \
 290                 Mode = (mode); \
 291         } while(0)
 292
 293 #define GetProcessingMode() Mode
 294
 295
 296 /*****************************************************************************
 297  *        pinit.h --                                                                                                                     *
 298  *                      POSTGRES initialization and cleanup definitions.                                 *
 299  *****************************************************************************/
 300
 301 /* in utils/init/postinit.c */
 302 extern void InitPostgres(const char *dbname, const char *username);
 303 extern void BaseInit(void);
 304
 305 /* in utils/init/miscinit.c */
 306 extern void IgnoreSystemIndexes(bool mode);
 307 extern bool IsIgnoringSystemIndexes(void);
 308 extern void SetReindexProcessing(Oid heapOid, Oid indexOid);
 309 extern bool ReindexIsProcessingHeap(Oid heapOid);
 310 extern bool ReindexIsProcessingIndex(Oid indexOid);
 311 extern void CreateDataDirLockFile(const char *datadir, bool amPostmaster);
 312 extern void CreateSocketLockFile(const char *socketfile, bool amPostmaster);
 313 extern void TouchSocketLockFile(void);
 314 extern void RecordSharedMemoryInLockFile(unsigned long id1,
 315                                                          unsigned long id2);
 316 extern void ValidatePgVersion(const char *path);
 317 extern void process_preload_libraries(char *preload_libraries_string);
 318
 319 #endif   /* MISCADMIN_H */