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-2002, PostgreSQL Global Development Group
  13  * Portions Copyright (c) 1994, Regents of the University of California
  14  *
  15  * $Id: miscadmin.h,v 1.116 2003/02/22 05:57:45 tgl 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 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.
  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
 100 /*****************************************************************************
 101  *        globals.h --                                                                                                                   *
 102  *****************************************************************************/
 103
 104 /*
 105  * from postmaster/postmaster.c
 106  */
 107 extern bool IsUnderPostmaster;
 108 extern bool ClientAuthInProgress;
 109
 110 extern int      PostmasterMain(int argc, char *argv[]);
 111 extern void ClosePostmasterPorts(bool pgstat_too);
 112
 113 /*
 114  * from utils/init/globals.c
 115  */
 116 extern bool Noversion;
 117 extern char *DataDir;
 118
 119 extern DLLIMPORT int MyProcPid;
 120 extern struct Port *MyProcPort;
 121 extern long MyCancelKey;
 122
 123 extern char OutputFileName[];
 124 extern char pg_pathname[];
 125
 126 /*
 127  * done in storage/backendid.h for now.
 128  *
 129  * extern BackendId    MyBackendId;
 130  */
 131 extern DLLIMPORT Oid MyDatabaseId;
 132
 133 /* Date/Time Configuration
 134  *
 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.
 140  *
 141  * DateStyle specifies preference for date formatting for output.
 142  * EuroDates if client prefers dates interpreted and written w/European conventions.
 143  *
 144  * HasCTZSet is true if user has set timezone as a numeric offset from UTC.
 145  * If so, CTimeZone is the timezone offset in seconds.
 146  */
 147
 148 #define MAXTZLEN                10              /* max TZ name len, not counting tr. null */
 149
 150 #define USE_POSTGRES_DATES              0
 151 #define USE_ISO_DATES                   1
 152 #define USE_SQL_DATES                   2
 153 #define USE_GERMAN_DATES                3
 154
 155 extern int      DateStyle;
 156 extern bool EuroDates;
 157 extern bool HasCTZSet;
 158 extern int      CTimeZone;
 159
 160 extern bool enableFsync;
 161 extern bool allowSystemTableMods;
 162 extern DLLIMPORT int SortMem;
 163 extern int      VacuumMem;
 164
 165 /*
 166  *      A few postmaster startup options are exported here so the
 167  *      configuration file processor can access them.
 168  */
 169
 170 extern bool NetServer;
 171 extern bool EnableSSL;
 172 extern bool SilentMode;
 173 extern int      MaxBackends;
 174 extern int      ReservedBackends;
 175 extern DLLIMPORT int    NBuffers;
 176 extern int      PostPortNumber;
 177 extern int      Unix_socket_permissions;
 178 extern char *Unix_socket_group;
 179 extern char *UnixSocketDir;
 180 extern char *VirtualHost;
 181
 182
 183 /*****************************************************************************
 184  *        pdir.h --                                                                                                                              *
 185  *                      POSTGRES directory path definitions.                                                     *
 186  *****************************************************************************/
 187
 188 extern char *DatabaseName;
 189 extern char *DatabasePath;
 190
 191 /* in utils/misc/database.c */
 192 extern void GetRawDatabaseInfo(const char *name, Oid *db_id, char *path);
 193 extern char *ExpandDatabasePath(const char *path);
 194
 195 /* now in utils/init/miscinit.c */
 196 extern void SetDatabaseName(const char *name);
 197 extern void SetDatabasePath(const char *path);
 198
 199 extern char *GetUserNameFromId(AclId userid);
 200 extern AclId GetUserId(void);
 201 extern void SetUserId(AclId userid);
 202 extern AclId GetSessionUserId(void);
 203 extern void SetSessionUserId(AclId userid);
 204 extern void InitializeSessionUserId(const char *username);
 205 extern void InitializeSessionUserIdStandalone(void);
 206 extern void SetSessionAuthorization(AclId userid);
 207
 208 extern void SetDataDir(const char *dir);
 209
 210 extern int FindExec(char *full_path, const char *argv0,
 211                  const char *binary_name);
 212 extern int      CheckPathAccess(char *path, char *name, int open_mode);
 213
 214 #ifdef CYR_RECODE
 215 extern void SetCharSet(void);
 216 extern char *convertstr(unsigned char *buff, int len, int dest);
 217 #endif
 218
 219 /* in utils/misc/superuser.c */
 220 extern bool superuser(void);    /* current user is superuser */
 221 extern bool superuser_arg(AclId userid);        /* given user is superuser */
 222 extern bool is_dbadmin(Oid dbid);               /* current user is owner of
 223                                                                                  * database */
 224
 225
 226 /*****************************************************************************
 227  *        pmod.h --                                                                                                                              *
 228  *                      POSTGRES processing mode definitions.                                                    *
 229  *****************************************************************************/
 230
 231 /*
 232  * Description:
 233  *              There are three processing modes in POSTGRES.  They are
 234  * BootstrapProcessing or "bootstrap," InitProcessing or
 235  * "initialization," and NormalProcessing or "normal."
 236  *
 237  * The first two processing modes are used during special times. When the
 238  * system state indicates bootstrap processing, transactions are all given
 239  * transaction id "one" and are consequently guaranteed to commit. This mode
 240  * is used during the initial generation of template databases.
 241  *
 242  * Initialization mode: used while starting a backend, until all normal
 243  * initialization is complete.  Some code behaves differently when executed
 244  * in this mode to enable system bootstrapping.
 245  *
 246  * If a POSTGRES binary is in normal mode, then all code may be executed
 247  * normally.
 248  */
 249
 250 typedef enum ProcessingMode
 251 {
 252         BootstrapProcessing,            /* bootstrap creation of template database */
 253         InitProcessing,                         /* initializing system */
 254         NormalProcessing                        /* normal processing */
 255 } ProcessingMode;
 256
 257 extern ProcessingMode Mode;
 258
 259 #define IsBootstrapProcessingMode() ((bool)(Mode == BootstrapProcessing))
 260 #define IsInitProcessingMode() ((bool)(Mode == InitProcessing))
 261 #define IsNormalProcessingMode() ((bool)(Mode == NormalProcessing))
 262
 263 #define SetProcessingMode(mode) \
 264         do { \
 265                 AssertArg((mode) == BootstrapProcessing || \
 266                                   (mode) == InitProcessing || \
 267                                   (mode) == NormalProcessing); \
 268                 Mode = (mode); \
 269         } while(0)
 270
 271 #define GetProcessingMode() Mode
 272
 273
 274 /*****************************************************************************
 275  *        pinit.h --                                                                                                                     *
 276  *                      POSTGRES initialization and cleanup definitions.                                 *
 277  *****************************************************************************/
 278
 279 /* in utils/init/postinit.c */
 280 extern void InitPostgres(const char *dbname, const char *username);
 281 extern void BaseInit(void);
 282
 283 /* in utils/init/miscinit.c */
 284 extern bool CreateDataDirLockFile(const char *datadir, bool amPostmaster);
 285 extern bool CreateSocketLockFile(const char *socketfile, bool amPostmaster);
 286 extern void TouchSocketLockFile(void);
 287 extern void RecordSharedMemoryInLockFile(unsigned long id1,
 288                                                          unsigned long id2);
 289
 290 extern void ValidatePgVersion(const char *path);
 291
 292 /* these externs do not belong here... */
 293 extern void IgnoreSystemIndexes(bool mode);
 294 extern bool IsIgnoringSystemIndexes(void);
 295 extern bool IsCacheInitialized(void);
 296
 297 #endif   /* MISCADMIN_H */