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