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.107 2002/08/29 21:02:12 momjian 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 #include <sys/types.h>
  27
  28
  29 /*****************************************************************************
  30  *        System interrupt and critical section handling
  31  *
  32  * There are two types of interrupts that a running backend needs to accept
  33  * without messing up its state: QueryCancel (SIGINT) and ProcDie (SIGTERM).
  34  * In both cases, we need to be able to clean up the current transaction
  35  * gracefully, so we can't respond to the interrupt instantaneously ---
  36  * there's no guarantee that internal data structures would be self-consistent
  37  * if the code is interrupted at an arbitrary instant.  Instead, the signal
  38  * handlers set flags that are checked periodically during execution.
  39  *
  40  * The CHECK_FOR_INTERRUPTS() macro is called at strategically located spots
  41  * where it is normally safe to accept a cancel or die interrupt.  In some
  42  * cases, we invoke CHECK_FOR_INTERRUPTS() inside low-level subroutines that
  43  * might sometimes be called in contexts that do *not* want to allow a cancel
  44  * or die interrupt.  The HOLD_INTERRUPTS() and RESUME_INTERRUPTS() macros
  45  * allow code to ensure that no cancel or die interrupt will be accepted,
  46  * even if CHECK_FOR_INTERRUPTS() gets called in a subroutine.  The interrupt
  47  * will be held off until CHECK_FOR_INTERRUPTS() is done outside any
  48  * HOLD_INTERRUPTS() ... RESUME_INTERRUPTS() section.
  49  *
  50  * Special mechanisms are used to let an interrupt be accepted when we are
  51  * waiting for a lock or when we are waiting for command input (but, of
  52  * course, only if the interrupt holdoff counter is zero).      See the
  53  * related code for details.
  54  *
  55  * A related, but conceptually distinct, mechanism is the "critical section"
  56  * mechanism.  A critical section not only holds off cancel/die interrupts,
  57  * but causes any elog(ERROR) or elog(FATAL) to become elog(STOP) --- that is,
  58  * a system-wide reset is forced.  Needless to say, only really *critical*
  59  * code should be marked as a critical section!  Currently, this mechanism
  60  * is only used for XLOG-related code.
  61  *
  62  *****************************************************************************/
  63
  64 /* in globals.c */
  65 /* these are marked volatile because they are set by signal handlers: */
  66 extern volatile bool InterruptPending;
  67 extern volatile bool QueryCancelPending;
  68 extern volatile bool ProcDiePending;
  69
  70 /* these are marked volatile because they are examined by signal handlers: */
  71 extern volatile bool ImmediateInterruptOK;
  72 extern volatile uint32 InterruptHoldoffCount;
  73 extern volatile uint32 CritSectionCount;
  74
  75 /* in postgres.c */
  76 extern void ProcessInterrupts(void);
  77
  78 #define CHECK_FOR_INTERRUPTS() \
  79         do { \
  80                 if (InterruptPending) \
  81                         ProcessInterrupts(); \
  82         } while(0)
  83
  84 #define HOLD_INTERRUPTS()  (InterruptHoldoffCount++)
  85
  86 #define RESUME_INTERRUPTS() \
  87         do { \
  88                 Assert(InterruptHoldoffCount > 0); \
  89                 InterruptHoldoffCount--; \
  90         } while(0)
  91
  92 #define START_CRIT_SECTION()  (CritSectionCount++)
  93
  94 #define END_CRIT_SECTION() \
  95         do { \
  96                 Assert(CritSectionCount > 0); \
  97                 CritSectionCount--; \
  98         } while(0)
  99
 100
 101 /*****************************************************************************
 102  *        globals.h --                                                                                                                   *
 103  *****************************************************************************/
 104
 105 /*
 106  * from postmaster/postmaster.c
 107  */
 108 extern bool IsUnderPostmaster;
 109 extern bool ClientAuthInProgress;
 110
 111 extern int      PostmasterMain(int argc, char *argv[]);
 112 extern void ClosePostmasterPorts(bool pgstat_too);
 113
 114 /*
 115  * from utils/init/globals.c
 116  */
 117 extern bool Noversion;
 118 extern char *DataDir;
 119
 120 extern DLLIMPORT int MyProcPid;
 121 extern struct Port *MyProcPort;
 122 extern long MyCancelKey;
 123
 124 extern char OutputFileName[];
 125 extern char pg_pathname[];
 126
 127 /*
 128  * done in storage/backendid.h for now.
 129  *
 130  * extern BackendId    MyBackendId;
 131  */
 132 extern DLLIMPORT Oid MyDatabaseId;
 133
 134 /* Date/Time Configuration
 135  *
 136  * Constants to pass info from runtime environment:
 137  *      USE_POSTGRES_DATES specifies traditional postgres format for output.
 138  *      USE_ISO_DATES specifies ISO-compliant format for output.
 139  *      USE_SQL_DATES specified Oracle/Ingres-compliant format for output.
 140  *      USE_GERMAN_DATES specifies German-style dd.mm/yyyy date format.
 141  *
 142  * DateStyle specifies preference for date formatting for output.
 143  * EuroDates if client prefers dates interpreted and written w/European conventions.
 144  *
 145  * HasCTZSet if client timezone is specified by client.
 146  * CDayLight is the apparent daylight savings time status.
 147  * CTimeZone is the timezone offset in seconds.
 148  * CTZName is the timezone label.
 149  */
 150
 151 #define MAXTZLEN                10              /* max TZ name len, not counting tr. null */
 152
 153 #define USE_POSTGRES_DATES              0
 154 #define USE_ISO_DATES                   1
 155 #define USE_SQL_DATES                   2
 156 #define USE_GERMAN_DATES                3
 157
 158 extern int      DateStyle;
 159 extern bool EuroDates;
 160 extern bool HasCTZSet;
 161 extern bool CDayLight;
 162 extern int      CTimeZone;
 163 extern char CTZName[];
 164
 165 extern char FloatFormat[];
 166 extern char DateFormat[];
 167
 168 extern bool enableFsync;
 169 extern bool allowSystemTableMods;
 170 extern int      SortMem;
 171 extern int      VacuumMem;
 172
 173 /*
 174  *      A few postmaster startup options are exported here so the
 175  *      configuration file processor can access them.
 176  */
 177
 178 extern bool NetServer;
 179 extern bool EnableSSL;
 180 extern bool SilentMode;
 181 extern int      MaxBackends;
 182 extern int      ReservedBackends;
 183 extern int      NBuffers;
 184 extern int      PostPortNumber;
 185 extern int      Unix_socket_permissions;
 186 extern char *Unix_socket_group;
 187 extern char *UnixSocketDir;
 188 extern char *VirtualHost;
 189
 190
 191 /*****************************************************************************
 192  *        pdir.h --                                                                                                                              *
 193  *                      POSTGRES directory path definitions.                                                     *
 194  *****************************************************************************/
 195
 196 extern char *DatabaseName;
 197 extern char *DatabasePath;
 198
 199 /* in utils/misc/database.c */
 200 extern void GetRawDatabaseInfo(const char *name, Oid *db_id, char *path);
 201 extern char *ExpandDatabasePath(const char *path);
 202
 203 /* now in utils/init/miscinit.c */
 204 extern void SetDatabaseName(const char *name);
 205 extern void SetDatabasePath(const char *path);
 206
 207 extern char *GetUserNameFromId(Oid userid);
 208
 209 extern Oid      GetUserId(void);
 210 extern void SetUserId(Oid userid);
 211 extern Oid      GetSessionUserId(void);
 212 extern void SetSessionUserId(Oid userid);
 213 extern void InitializeSessionUserId(const char *username);
 214 extern void InitializeSessionUserIdStandalone(void);
 215 extern void SetSessionAuthorization(Oid userid);
 216
 217 extern void SetDataDir(const char *dir);
 218
 219 extern int FindExec(char *full_path, const char *argv0,
 220                  const char *binary_name);
 221 extern int      CheckPathAccess(char *path, char *name, int open_mode);
 222
 223 #ifdef CYR_RECODE
 224 extern void SetCharSet(void);
 225 extern char *convertstr(unsigned char *buff, int len, int dest);
 226 #endif
 227
 228 /* in utils/misc/superuser.c */
 229 extern bool superuser(void);    /* current user is superuser */
 230 extern bool superuser_arg(Oid userid);  /* given user is superuser */
 231 extern bool is_dbadmin(Oid dbid);               /* current user is owner of
 232                                                                                  * database */
 233
 234
 235 /*****************************************************************************
 236  *        pmod.h --                                                                                                                              *
 237  *                      POSTGRES processing mode definitions.                                                    *
 238  *****************************************************************************/
 239
 240 /*
 241  * Description:
 242  *              There are three processing modes in POSTGRES.  They are
 243  * BootstrapProcessing or "bootstrap," InitProcessing or
 244  * "initialization," and NormalProcessing or "normal."
 245  *
 246  * The first two processing modes are used during special times. When the
 247  * system state indicates bootstrap processing, transactions are all given
 248  * transaction id "one" and are consequently guaranteed to commit. This mode
 249  * is used during the initial generation of template databases.
 250  *
 251  * Initialization mode: used while starting a backend, until all normal
 252  * initialization is complete.  Some code behaves differently when executed
 253  * in this mode to enable system bootstrapping.
 254  *
 255  * If a POSTGRES binary is in normal mode, then all code may be executed
 256  * normally.
 257  */
 258
 259 typedef enum ProcessingMode
 260 {
 261         BootstrapProcessing,            /* bootstrap creation of template database */
 262         InitProcessing,                         /* initializing system */
 263         NormalProcessing                        /* normal processing */
 264 } ProcessingMode;
 265
 266 extern ProcessingMode Mode;
 267
 268 #define IsBootstrapProcessingMode() ((bool)(Mode == BootstrapProcessing))
 269 #define IsInitProcessingMode() ((bool)(Mode == InitProcessing))
 270 #define IsNormalProcessingMode() ((bool)(Mode == NormalProcessing))
 271
 272 #define SetProcessingMode(mode) \
 273         do { \
 274                 AssertArg((mode) == BootstrapProcessing || \
 275                                   (mode) == InitProcessing || \
 276                                   (mode) == NormalProcessing); \
 277                 Mode = (mode); \
 278         } while(0)
 279
 280 #define GetProcessingMode() Mode
 281
 282
 283 /*****************************************************************************
 284  *        pinit.h --                                                                                                                     *
 285  *                      POSTGRES initialization and cleanup definitions.                                 *
 286  *****************************************************************************/
 287
 288 /* in utils/init/postinit.c */
 289 extern void InitPostgres(const char *dbname, const char *username);
 290 extern void BaseInit(void);
 291
 292 /* in utils/init/miscinit.c */
 293 extern bool CreateDataDirLockFile(const char *datadir, bool amPostmaster);
 294 extern bool CreateSocketLockFile(const char *socketfile, bool amPostmaster);
 295 extern void TouchSocketLockFile(void);
 296 extern void RecordSharedMemoryInLockFile(unsigned long id1,
 297                                                                                  unsigned long id2);
 298
 299 extern void ValidatePgVersion(const char *path);
 300
 301 /* these externs do not belong here... */
 302 extern void IgnoreSystemIndexes(bool mode);
 303 extern bool IsIgnoringSystemIndexes(void);
 304 extern bool IsCacheInitialized(void);
 305
 306 #endif   /* MISCADMIN_H */