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-2017, PostgreSQL Global Development Group
  14  * Portions Copyright (c) 1994, Regents of the University of California
  15  *
  16  * src/include/miscadmin.h
  17  *
  18  * NOTES
  19  *        some of the information in this file should be moved to other files.
  20  *
  21  *-------------------------------------------------------------------------
  22  */
  23 #ifndef MISCADMIN_H
  24 #define MISCADMIN_H
  25
  26 #include <signal.h>
  27
  28 #include "pgtime.h"                             /* for pg_time_t */
  29
  30
  31 #define InvalidPid                              (-1)
  32
  33
  34 /*****************************************************************************
  35  *        System interrupt and critical section handling
  36  *
  37  * There are two types of interrupts that a running backend needs to accept
  38  * without messing up its state: QueryCancel (SIGINT) and ProcDie (SIGTERM).
  39  * In both cases, we need to be able to clean up the current transaction
  40  * gracefully, so we can't respond to the interrupt instantaneously ---
  41  * there's no guarantee that internal data structures would be self-consistent
  42  * if the code is interrupted at an arbitrary instant.  Instead, the signal
  43  * handlers set flags that are checked periodically during execution.
  44  *
  45  * The CHECK_FOR_INTERRUPTS() macro is called at strategically located spots
  46  * where it is normally safe to accept a cancel or die interrupt.  In some
  47  * cases, we invoke CHECK_FOR_INTERRUPTS() inside low-level subroutines that
  48  * might sometimes be called in contexts that do *not* want to allow a cancel
  49  * or die interrupt.  The HOLD_INTERRUPTS() and RESUME_INTERRUPTS() macros
  50  * allow code to ensure that no cancel or die interrupt will be accepted,
  51  * even if CHECK_FOR_INTERRUPTS() gets called in a subroutine.  The interrupt
  52  * will be held off until CHECK_FOR_INTERRUPTS() is done outside any
  53  * HOLD_INTERRUPTS() ... RESUME_INTERRUPTS() section.
  54  *
  55  * There is also a mechanism to prevent query cancel interrupts, while still
  56  * allowing die interrupts: HOLD_CANCEL_INTERRUPTS() and
  57  * RESUME_CANCEL_INTERRUPTS().
  58  *
  59  * Special mechanisms are used to let an interrupt be accepted when we are
  60  * waiting for a lock or when we are waiting for command input (but, of
  61  * course, only if the interrupt holdoff counter is zero).  See the
  62  * related code for details.
  63  *
  64  * A lost connection is handled similarly, although the loss of connection
  65  * does not raise a signal, but is detected when we fail to write to the
  66  * socket. If there was a signal for a broken connection, we could make use of
  67  * it by setting ClientConnectionLost in the signal handler.
  68  *
  69  * A related, but conceptually distinct, mechanism is the "critical section"
  70  * mechanism.  A critical section not only holds off cancel/die interrupts,
  71  * but causes any ereport(ERROR) or ereport(FATAL) to become ereport(PANIC)
  72  * --- that is, a system-wide reset is forced.  Needless to say, only really
  73  * *critical* code should be marked as a critical section!      Currently, this
  74  * mechanism is only used for XLOG-related code.
  75  *
  76  *****************************************************************************/
  77
  78 /* in globals.c */
  79 /* these are marked volatile because they are set by signal handlers: */
  80 extern PGDLLIMPORT volatile bool InterruptPending;
  81 extern PGDLLIMPORT volatile bool QueryCancelPending;
  82 extern PGDLLIMPORT volatile bool ProcDiePending;
  83 extern PGDLLIMPORT volatile bool IdleInTransactionSessionTimeoutPending;
  84 extern PGDLLIMPORT volatile sig_atomic_t ConfigReloadPending;
  85
  86 extern volatile bool ClientConnectionLost;
  87
  88 /* these are marked volatile because they are examined by signal handlers: */
  89 extern PGDLLIMPORT volatile uint32 InterruptHoldoffCount;
  90 extern PGDLLIMPORT volatile uint32 QueryCancelHoldoffCount;
  91 extern PGDLLIMPORT volatile uint32 CritSectionCount;
  92
  93 /* in tcop/postgres.c */
  94 extern void ProcessInterrupts(void);
  95
  96 #ifndef WIN32
  97
  98 #define CHECK_FOR_INTERRUPTS() \
  99 do { \
 100         if (InterruptPending) \
 101                 ProcessInterrupts(); \
 102 } while(0)
 103 #else                                                   /* WIN32 */
 104
 105 #define CHECK_FOR_INTERRUPTS() \
 106 do { \
 107         if (UNBLOCKED_SIGNAL_QUEUE()) \
 108                 pgwin32_dispatch_queued_signals(); \
 109         if (InterruptPending) \
 110                 ProcessInterrupts(); \
 111 } while(0)
 112 #endif                                                  /* WIN32 */
 113
 114
 115 #define HOLD_INTERRUPTS()  (InterruptHoldoffCount++)
 116
 117 #define RESUME_INTERRUPTS() \
 118 do { \
 119         Assert(InterruptHoldoffCount > 0); \
 120         InterruptHoldoffCount--; \
 121 } while(0)
 122
 123 #define HOLD_CANCEL_INTERRUPTS()  (QueryCancelHoldoffCount++)
 124
 125 #define RESUME_CANCEL_INTERRUPTS() \
 126 do { \
 127         Assert(QueryCancelHoldoffCount > 0); \
 128         QueryCancelHoldoffCount--; \
 129 } while(0)
 130
 131 #define START_CRIT_SECTION()  (CritSectionCount++)
 132
 133 #define END_CRIT_SECTION() \
 134 do { \
 135         Assert(CritSectionCount > 0); \
 136         CritSectionCount--; \
 137 } while(0)
 138
 139
 140 /*****************************************************************************
 141  *        globals.h --                                                                                                                   *
 142  *****************************************************************************/
 143
 144 /*
 145  * from utils/init/globals.c
 146  */
 147 extern PGDLLIMPORT pid_t PostmasterPid;
 148 extern PGDLLIMPORT bool IsPostmasterEnvironment;
 149 extern PGDLLIMPORT bool IsUnderPostmaster;
 150 extern PGDLLIMPORT bool IsBackgroundWorker;
 151 extern PGDLLIMPORT bool IsBinaryUpgrade;
 152
 153 extern bool ExitOnAnyError;
 154
 155 extern PGDLLIMPORT char *DataDir;
 156
 157 extern PGDLLIMPORT int NBuffers;
 158 extern int      MaxBackends;
 159 extern int      MaxConnections;
 160 extern int      max_worker_processes;
 161 extern int      max_parallel_workers;
 162
 163 extern PGDLLIMPORT int MyProcPid;
 164 extern PGDLLIMPORT pg_time_t MyStartTime;
 165 extern PGDLLIMPORT struct Port *MyProcPort;
 166 extern PGDLLIMPORT struct Latch *MyLatch;
 167 extern int32 MyCancelKey;
 168 extern int      MyPMChildSlot;
 169
 170 extern char OutputFileName[];
 171 extern PGDLLIMPORT char my_exec_path[];
 172 extern char pkglib_path[];
 173
 174 #ifdef EXEC_BACKEND
 175 extern char postgres_exec_path[];
 176 #endif
 177
 178 /*
 179  * done in storage/backendid.h for now.
 180  *
 181  * extern BackendId    MyBackendId;
 182  */
 183 extern PGDLLIMPORT Oid MyDatabaseId;
 184
 185 extern PGDLLIMPORT Oid MyDatabaseTableSpace;
 186
 187 /*
 188  * Date/Time Configuration
 189  *
 190  * DateStyle defines the output formatting choice for date/time types:
 191  *      USE_POSTGRES_DATES specifies traditional Postgres format
 192  *      USE_ISO_DATES specifies ISO-compliant format
 193  *      USE_SQL_DATES specifies Oracle/Ingres-compliant format
 194  *      USE_GERMAN_DATES specifies German-style dd.mm/yyyy
 195  *
 196  * DateOrder defines the field order to be assumed when reading an
 197  * ambiguous date (anything not in YYYY-MM-DD format, with a four-digit
 198  * year field first, is taken to be ambiguous):
 199  *      DATEORDER_YMD specifies field order yy-mm-dd
 200  *      DATEORDER_DMY specifies field order dd-mm-yy ("European" convention)
 201  *      DATEORDER_MDY specifies field order mm-dd-yy ("US" convention)
 202  *
 203  * In the Postgres and SQL DateStyles, DateOrder also selects output field
 204  * order: day comes before month in DMY style, else month comes before day.
 205  *
 206  * The user-visible "DateStyle" run-time parameter subsumes both of these.
 207  */
 208
 209 /* valid DateStyle values */
 210 #define USE_POSTGRES_DATES              0
 211 #define USE_ISO_DATES                   1
 212 #define USE_SQL_DATES                   2
 213 #define USE_GERMAN_DATES                3
 214 #define USE_XSD_DATES                   4
 215
 216 /* valid DateOrder values */
 217 #define DATEORDER_YMD                   0
 218 #define DATEORDER_DMY                   1
 219 #define DATEORDER_MDY                   2
 220
 221 extern PGDLLIMPORT int DateStyle;
 222 extern PGDLLIMPORT int DateOrder;
 223
 224 /*
 225  * IntervalStyles
 226  *       INTSTYLE_POSTGRES                         Like Postgres < 8.4 when DateStyle = 'iso'
 227  *       INTSTYLE_POSTGRES_VERBOSE         Like Postgres < 8.4 when DateStyle != 'iso'
 228  *       INTSTYLE_SQL_STANDARD             SQL standard interval literals
 229  *       INTSTYLE_ISO_8601                         ISO-8601-basic formatted intervals
 230  */
 231 #define INTSTYLE_POSTGRES                       0
 232 #define INTSTYLE_POSTGRES_VERBOSE       1
 233 #define INTSTYLE_SQL_STANDARD           2
 234 #define INTSTYLE_ISO_8601                       3
 235
 236 extern PGDLLIMPORT int IntervalStyle;
 237
 238 #define MAXTZLEN                10              /* max TZ name len, not counting tr. null */
 239
 240 extern bool enableFsync;
 241 extern bool allowSystemTableMods;
 242 extern PGDLLIMPORT int work_mem;
 243 extern PGDLLIMPORT int maintenance_work_mem;
 244
 245 extern int      VacuumCostPageHit;
 246 extern int      VacuumCostPageMiss;
 247 extern int      VacuumCostPageDirty;
 248 extern int      VacuumCostLimit;
 249 extern int      VacuumCostDelay;
 250
 251 extern int      VacuumPageHit;
 252 extern int      VacuumPageMiss;
 253 extern int      VacuumPageDirty;
 254
 255 extern int      VacuumCostBalance;
 256 extern bool VacuumCostActive;
 257
 258
 259 /* in tcop/postgres.c */
 260
 261 #if defined(__ia64__) || defined(__ia64)
 262 typedef struct
 263 {
 264         char       *stack_base_ptr;
 265         char       *register_stack_base_ptr;
 266 } pg_stack_base_t;
 267 #else
 268 typedef char *pg_stack_base_t;
 269 #endif
 270
 271 extern pg_stack_base_t set_stack_base(void);
 272 extern void restore_stack_base(pg_stack_base_t base);
 273 extern void check_stack_depth(void);
 274 extern bool stack_is_too_deep(void);
 275
 276 extern void PostgresSigHupHandler(SIGNAL_ARGS);
 277
 278 /* in tcop/utility.c */
 279 extern void PreventCommandIfReadOnly(const char *cmdname);
 280 extern void PreventCommandIfParallelMode(const char *cmdname);
 281 extern void PreventCommandDuringRecovery(const char *cmdname);
 282
 283 /* in utils/misc/guc.c */
 284 extern int      trace_recovery_messages;
 285 extern int      trace_recovery(int trace_level);
 286
 287 /*****************************************************************************
 288  *        pdir.h --                                                                                                                              *
 289  *                      POSTGRES directory path definitions.                             *
 290  *****************************************************************************/
 291
 292 /* flags to be OR'd to form sec_context */
 293 #define SECURITY_LOCAL_USERID_CHANGE    0x0001
 294 #define SECURITY_RESTRICTED_OPERATION   0x0002
 295 #define SECURITY_NOFORCE_RLS                    0x0004
 296
 297 extern char *DatabasePath;
 298
 299 /* now in utils/init/miscinit.c */
 300 extern void InitPostmasterChild(void);
 301 extern void InitStandaloneProcess(const char *argv0);
 302
 303 extern void SetDatabasePath(const char *path);
 304
 305 extern char *GetUserNameFromId(Oid roleid, bool noerr);
 306 extern Oid      GetUserId(void);
 307 extern Oid      GetOuterUserId(void);
 308 extern Oid      GetSessionUserId(void);
 309 extern Oid      GetAuthenticatedUserId(void);
 310 extern void GetUserIdAndSecContext(Oid *userid, int *sec_context);
 311 extern void SetUserIdAndSecContext(Oid userid, int sec_context);
 312 extern bool InLocalUserIdChange(void);
 313 extern bool InSecurityRestrictedOperation(void);
 314 extern bool InNoForceRLSOperation(void);
 315 extern void GetUserIdAndContext(Oid *userid, bool *sec_def_context);
 316 extern void SetUserIdAndContext(Oid userid, bool sec_def_context);
 317 extern void InitializeSessionUserId(const char *rolename, Oid useroid);
 318 extern void InitializeSessionUserIdStandalone(void);
 319 extern void SetSessionAuthorization(Oid userid, bool is_superuser);
 320 extern Oid      GetCurrentRoleId(void);
 321 extern void SetCurrentRoleId(Oid roleid, bool is_superuser);
 322
 323 extern void SetDataDir(const char *dir);
 324 extern void ChangeToDataDir(void);
 325
 326 extern void SwitchToSharedLatch(void);
 327 extern void SwitchBackToLocalLatch(void);
 328
 329 /* in utils/misc/superuser.c */
 330 extern bool superuser(void);    /* current user is superuser */
 331 extern bool superuser_arg(Oid roleid);  /* given user is superuser */
 332
 333
 334 /*****************************************************************************
 335  *        pmod.h --                                                                                                                              *
 336  *                      POSTGRES processing mode definitions.                            *
 337  *****************************************************************************/
 338
 339 /*
 340  * Description:
 341  *              There are three processing modes in POSTGRES.  They are
 342  * BootstrapProcessing or "bootstrap," InitProcessing or
 343  * "initialization," and NormalProcessing or "normal."
 344  *
 345  * The first two processing modes are used during special times. When the
 346  * system state indicates bootstrap processing, transactions are all given
 347  * transaction id "one" and are consequently guaranteed to commit. This mode
 348  * is used during the initial generation of template databases.
 349  *
 350  * Initialization mode: used while starting a backend, until all normal
 351  * initialization is complete.  Some code behaves differently when executed
 352  * in this mode to enable system bootstrapping.
 353  *
 354  * If a POSTGRES backend process is in normal mode, then all code may be
 355  * executed normally.
 356  */
 357
 358 typedef enum ProcessingMode
 359 {
 360         BootstrapProcessing,            /* bootstrap creation of template database */
 361         InitProcessing,                         /* initializing system */
 362         NormalProcessing                        /* normal processing */
 363 } ProcessingMode;
 364
 365 extern ProcessingMode Mode;
 366
 367 #define IsBootstrapProcessingMode() (Mode == BootstrapProcessing)
 368 #define IsInitProcessingMode()          (Mode == InitProcessing)
 369 #define IsNormalProcessingMode()        (Mode == NormalProcessing)
 370
 371 #define GetProcessingMode() Mode
 372
 373 #define SetProcessingMode(mode) \
 374         do { \
 375                 AssertArg((mode) == BootstrapProcessing || \
 376                                   (mode) == InitProcessing || \
 377                                   (mode) == NormalProcessing); \
 378                 Mode = (mode); \
 379         } while(0)
 380
 381
 382 /*
 383  * Auxiliary-process type identifiers.  These used to be in bootstrap.h
 384  * but it seems saner to have them here, with the ProcessingMode stuff.
 385  * The MyAuxProcType global is defined and set in bootstrap.c.
 386  */
 387
 388 typedef enum
 389 {
 390         NotAnAuxProcess = -1,
 391         CheckerProcess = 0,
 392         BootstrapProcess,
 393         StartupProcess,
 394         BgWriterProcess,
 395         CheckpointerProcess,
 396         WalWriterProcess,
 397         WalReceiverProcess,
 398
 399         NUM_AUXPROCTYPES                        /* Must be last! */
 400 } AuxProcType;
 401
 402 extern AuxProcType MyAuxProcType;
 403
 404 #define AmBootstrapProcess()            (MyAuxProcType == BootstrapProcess)
 405 #define AmStartupProcess()                      (MyAuxProcType == StartupProcess)
 406 #define AmBackgroundWriterProcess() (MyAuxProcType == BgWriterProcess)
 407 #define AmCheckpointerProcess()         (MyAuxProcType == CheckpointerProcess)
 408 #define AmWalWriterProcess()            (MyAuxProcType == WalWriterProcess)
 409 #define AmWalReceiverProcess()          (MyAuxProcType == WalReceiverProcess)
 410
 411
 412 /*****************************************************************************
 413  *        pinit.h --                                                                                                                     *
 414  *                      POSTGRES initialization and cleanup definitions.                 *
 415  *****************************************************************************/
 416
 417 /* in utils/init/postinit.c */
 418 extern void pg_split_opts(char **argv, int *argcp, const char *optstr);
 419 extern void InitializeMaxBackends(void);
 420 extern void InitPostgres(const char *in_dbname, Oid dboid, const char *username,
 421                          Oid useroid, char *out_dbname);
 422 extern void BaseInit(void);
 423
 424 /* in utils/init/miscinit.c */
 425 extern bool IgnoreSystemIndexes;
 426 extern PGDLLIMPORT bool process_shared_preload_libraries_in_progress;
 427 extern char *session_preload_libraries_string;
 428 extern char *shared_preload_libraries_string;
 429 extern char *local_preload_libraries_string;
 430
 431 extern void CreateDataDirLockFile(bool amPostmaster);
 432 extern void CreateSocketLockFile(const char *socketfile, bool amPostmaster,
 433                                          const char *socketDir);
 434 extern void TouchSocketLockFiles(void);
 435 extern void AddToDataDirLockFile(int target_line, const char *str);
 436 extern bool RecheckDataDirLockFile(void);
 437 extern void ValidatePgVersion(const char *path);
 438 extern void process_shared_preload_libraries(void);
 439 extern void process_session_preload_libraries(void);
 440 extern void pg_bindtextdomain(const char *domain);
 441 extern bool has_rolreplication(Oid roleid);
 442
 443 /* in access/transam/xlog.c */
 444 extern bool BackupInProgress(void);
 445 extern void CancelBackup(void);
 446
 447 #endif                                                  /* MISCADMIN_H */