1 /*-------------------------------------------------------------------------
4 * miscellaneous initialization support stuff
6 * Portions Copyright (c) 1996-2004, PostgreSQL Global Development Group
7 * Portions Copyright (c) 1994, Regents of the University of California
11 * $PostgreSQL: pgsql/src/backend/utils/init/miscinit.c,v 1.132 2004/08/29 05:06:50 momjian Exp $
13 *-------------------------------------------------------------------------
17 #include <sys/param.h>
26 #include <netinet/in.h>
27 #include <arpa/inet.h>
32 #include "catalog/catname.h"
33 #include "catalog/pg_shadow.h"
34 #include "libpq/libpq-be.h"
35 #include "miscadmin.h"
36 #include "storage/fd.h"
37 #include "storage/ipc.h"
38 #include "storage/pg_shmem.h"
39 #include "utils/builtins.h"
40 #include "utils/guc.h"
41 #include "utils/lsyscache.h"
42 #include "utils/syscache.h"
45 ProcessingMode Mode = InitProcessing;
47 /* Note: we rely on these to initialize as zeroes */
48 static char directoryLockFile[MAXPGPATH];
49 static char socketLockFile[MAXPGPATH];
52 /* ----------------------------------------------------------------
53 * ignoring system indexes support stuff
55 * NOTE: "ignoring system indexes" means we do not use the system indexes
56 * for lookups (either in hardwired catalog accesses or in planner-generated
57 * plans). We do, however, still update the indexes when a catalog
58 * modification is made.
59 * ----------------------------------------------------------------
62 static bool isIgnoringSystemIndexes = false;
65 * IsIgnoringSystemIndexes
66 * True if ignoring system indexes.
69 IsIgnoringSystemIndexes(void)
71 return isIgnoringSystemIndexes;
76 * Set true or false whether PostgreSQL ignores system indexes.
79 IgnoreSystemIndexes(bool mode)
81 isIgnoringSystemIndexes = mode;
84 /* ----------------------------------------------------------------
85 * system index reindexing support
87 * When we are busy reindexing a system index, this code provides support
88 * for preventing catalog lookups from using that index.
89 * ----------------------------------------------------------------
92 static Oid currentlyReindexedHeap = InvalidOid;
93 static Oid currentlyReindexedIndex = InvalidOid;
96 * ReindexIsProcessingHeap
97 * True if heap specified by OID is currently being reindexed.
100 ReindexIsProcessingHeap(Oid heapOid)
102 return heapOid == currentlyReindexedHeap;
106 * ReindexIsProcessingIndex
107 * True if index specified by OID is currently being reindexed.
110 ReindexIsProcessingIndex(Oid indexOid)
112 return indexOid == currentlyReindexedIndex;
116 * SetReindexProcessing
117 * Set flag that specified heap/index are being reindexed.
120 SetReindexProcessing(Oid heapOid, Oid indexOid)
122 Assert(OidIsValid(heapOid) && OidIsValid(indexOid));
123 /* Reindexing is not re-entrant. */
124 if (OidIsValid(currentlyReindexedIndex))
125 elog(ERROR, "cannot reindex while reindexing");
126 currentlyReindexedHeap = heapOid;
127 currentlyReindexedIndex = indexOid;
131 * ResetReindexProcessing
132 * Unset reindexing status.
135 ResetReindexProcessing(void)
137 currentlyReindexedHeap = InvalidOid;
138 currentlyReindexedIndex = InvalidOid;
141 /* ----------------------------------------------------------------
142 * database path / name support stuff
143 * ----------------------------------------------------------------
147 SetDatabasePath(const char *path)
154 /* use strdup since this is done before memory contexts are set up */
157 DatabasePath = strdup(path);
158 AssertState(DatabasePath);
163 * Set data directory, but make sure it's an absolute path. Use this,
164 * never set DataDir directly.
167 SetDataDir(const char *dir)
173 /* If presented path is relative, convert to absolute */
174 if (!is_absolute_path(dir))
182 buf = malloc(buflen);
185 (errcode(ERRCODE_OUT_OF_MEMORY),
186 errmsg("out of memory")));
188 if (getcwd(buf, buflen))
190 else if (errno == ERANGE)
199 elog(FATAL, "could not get current working directory: %m");
203 new = malloc(strlen(buf) + 1 + strlen(dir) + 1);
206 (errcode(ERRCODE_OUT_OF_MEMORY),
207 errmsg("out of memory")));
208 sprintf(new, "%s/%s", buf, dir);
216 (errcode(ERRCODE_OUT_OF_MEMORY),
217 errmsg("out of memory")));
220 canonicalize_path(new);
228 /* ----------------------------------------------------------------
231 * The authenticated user is determined at connection start and never
232 * changes. The session user can be changed only by SET SESSION
233 * AUTHORIZATION. The current user may change when "setuid" functions
234 * are implemented. Conceptually there is a stack, whose bottom
235 * is the session user. You are yourself responsible to save and
236 * restore the current user id if you need to change it.
237 * ----------------------------------------------------------------
239 static AclId AuthenticatedUserId = 0;
240 static AclId SessionUserId = 0;
241 static AclId CurrentUserId = 0;
243 static bool AuthenticatedUserIsSuperuser = false;
246 * This function is relevant for all privilege checks.
251 AssertState(AclIdIsValid(CurrentUserId));
252 return CurrentUserId;
257 SetUserId(AclId newid)
259 AssertArg(AclIdIsValid(newid));
260 CurrentUserId = newid;
265 * This value is only relevant for informational purposes.
268 GetSessionUserId(void)
270 AssertState(AclIdIsValid(SessionUserId));
271 return SessionUserId;
276 SetSessionUserId(AclId newid)
278 AssertArg(AclIdIsValid(newid));
279 SessionUserId = newid;
280 /* Current user defaults to session user. */
281 if (!AclIdIsValid(CurrentUserId))
282 CurrentUserId = newid;
287 InitializeSessionUserId(const char *username)
295 * Don't do scans if we're bootstrapping, none of the system catalogs
296 * exist yet, and they should be owned by postgres anyway.
298 AssertState(!IsBootstrapProcessingMode());
301 AssertState(!OidIsValid(AuthenticatedUserId));
303 userTup = SearchSysCache(SHADOWNAME,
304 PointerGetDatum(username),
306 if (!HeapTupleIsValid(userTup))
308 (errcode(ERRCODE_UNDEFINED_OBJECT),
309 errmsg("user \"%s\" does not exist", username)));
311 usesysid = ((Form_pg_shadow) GETSTRUCT(userTup))->usesysid;
313 AuthenticatedUserId = usesysid;
314 AuthenticatedUserIsSuperuser = ((Form_pg_shadow) GETSTRUCT(userTup))->usesuper;
316 SetSessionUserId(usesysid); /* sets CurrentUserId too */
318 /* Record username and superuser status as GUC settings too */
319 SetConfigOption("session_authorization", username,
320 PGC_BACKEND, PGC_S_OVERRIDE);
321 SetConfigOption("is_superuser",
322 AuthenticatedUserIsSuperuser ? "on" : "off",
323 PGC_INTERNAL, PGC_S_OVERRIDE);
326 * Set up user-specific configuration variables. This is a good place
327 * to do it so we don't have to read pg_shadow twice during session
330 datum = SysCacheGetAttr(SHADOWNAME, userTup,
331 Anum_pg_shadow_useconfig, &isnull);
334 ArrayType *a = DatumGetArrayTypeP(datum);
336 ProcessGUCArray(a, PGC_S_USER);
339 ReleaseSysCache(userTup);
344 InitializeSessionUserIdStandalone(void)
346 /* This function should only be called in a single-user backend. */
347 AssertState(!IsUnderPostmaster);
350 AssertState(!OidIsValid(AuthenticatedUserId));
352 AuthenticatedUserId = BOOTSTRAP_USESYSID;
353 AuthenticatedUserIsSuperuser = true;
355 SetSessionUserId(BOOTSTRAP_USESYSID);
360 * Change session auth ID while running
362 * Only a superuser may set auth ID to something other than himself. Note
363 * that in case of multiple SETs in a single session, the original userid's
364 * superuserness is what matters. But we set the GUC variable is_superuser
365 * to indicate whether the *current* session userid is a superuser.
368 SetSessionAuthorization(AclId userid, bool is_superuser)
370 /* Must have authenticated already, else can't make permission check */
371 AssertState(AclIdIsValid(AuthenticatedUserId));
373 if (userid != AuthenticatedUserId &&
374 !AuthenticatedUserIsSuperuser)
376 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
377 errmsg("permission denied to set session authorization")));
379 SetSessionUserId(userid);
382 SetConfigOption("is_superuser",
383 is_superuser ? "on" : "off",
384 PGC_INTERNAL, PGC_S_OVERRIDE);
389 * Get user name from user id
392 GetUserNameFromId(AclId userid)
397 tuple = SearchSysCache(SHADOWSYSID,
398 ObjectIdGetDatum(userid),
400 if (!HeapTupleIsValid(tuple))
402 (errcode(ERRCODE_UNDEFINED_OBJECT),
403 errmsg("invalid user ID: %d", userid)));
405 result = pstrdup(NameStr(((Form_pg_shadow) GETSTRUCT(tuple))->usename));
407 ReleaseSysCache(tuple);
413 /*-------------------------------------------------------------------------
414 * Interlock-file support
416 * These routines are used to create both a data-directory lockfile
417 * ($DATADIR/postmaster.pid) and a Unix-socket-file lockfile ($SOCKFILE.lock).
418 * Both kinds of files contain the same info:
420 * Owning process' PID
421 * Data directory path
423 * By convention, the owning process' PID is negated if it is a standalone
424 * backend rather than a postmaster. This is just for informational purposes.
425 * The path is also just for informational purposes (so that a socket lockfile
426 * can be more easily traced to the associated postmaster).
428 * A data-directory lockfile can optionally contain a third line, containing
429 * the key and ID for the shared memory block used by this postmaster.
431 * On successful lockfile creation, a proc_exit callback to remove the
432 * lockfile is automatically created.
433 *-------------------------------------------------------------------------
437 * proc_exit callback to remove a lockfile.
440 UnlinkLockFile(int status, Datum filename)
442 char *fname = (char *) DatumGetPointer(filename);
446 if (unlink(fname) != 0)
448 /* Should we complain if the unlink fails? */
457 * filename is the name of the lockfile to create.
458 * amPostmaster is used to determine how to encode the output PID.
459 * isDDLock and refName are used to determine what error message to produce.
462 CreateLockFile(const char *filename, bool amPostmaster,
463 bool isDDLock, const char *refName)
466 char buffer[MAXPGPATH + 100];
471 pid_t my_pid = getpid();
474 * We need a loop here because of race conditions. But don't loop
475 * forever (for example, a non-writable $PGDATA directory might cause
476 * a failure that won't go away). 100 tries seems like plenty.
478 for (ntries = 0;; ntries++)
481 * Try to create the lock file --- O_EXCL makes this atomic.
483 fd = open(filename, O_RDWR | O_CREAT | O_EXCL, 0600);
485 break; /* Success; exit the retry loop */
488 * Couldn't create the pid file. Probably it already exists.
490 if ((errno != EEXIST && errno != EACCES) || ntries > 100)
492 (errcode_for_file_access(),
493 errmsg("could not create lock file \"%s\": %m",
497 * Read the file to get the old owner's PID. Note race condition
498 * here: file might have been deleted since we tried to create it.
500 fd = open(filename, O_RDONLY, 0600);
504 continue; /* race condition; try again */
506 (errcode_for_file_access(),
507 errmsg("could not open lock file \"%s\": %m",
510 if ((len = read(fd, buffer, sizeof(buffer) - 1)) < 0)
512 (errcode_for_file_access(),
513 errmsg("could not read lock file \"%s\": %m",
518 encoded_pid = atoi(buffer);
520 /* if pid < 0, the pid is for postgres, not postmaster */
521 other_pid = (pid_t) (encoded_pid < 0 ? -encoded_pid : encoded_pid);
524 elog(FATAL, "bogus data in lock file \"%s\"", filename);
527 * Check to see if the other process still exists
529 * Normally kill() will fail with ESRCH if the given PID doesn't
530 * exist. BeOS returns EINVAL for some silly reason, however.
532 if (other_pid != my_pid)
534 if (kill(other_pid, 0) == 0 ||
541 /* lockfile belongs to a live process */
543 (errcode(ERRCODE_LOCK_FILE_EXISTS),
544 errmsg("lock file \"%s\" already exists",
547 errhint("Is another %s (PID %d) running in data directory \"%s\"?",
548 (encoded_pid < 0 ? "postgres" : "postmaster"),
549 (int) other_pid, refName) :
550 errhint("Is another %s (PID %d) using socket file \"%s\"?",
551 (encoded_pid < 0 ? "postgres" : "postmaster"),
552 (int) other_pid, refName)));
557 * No, the creating process did not exist. However, it could be
558 * that the postmaster crashed (or more likely was kill -9'd by a
559 * clueless admin) but has left orphan backends behind. Check for
560 * this by looking to see if there is an associated shmem segment
561 * that is still in use.
569 ptr = strchr(buffer, '\n');
571 (ptr = strchr(ptr + 1, '\n')) != NULL)
574 if (sscanf(ptr, "%lu %lu", &id1, &id2) == 2)
576 if (PGSharedMemoryIsInUse(id1, id2))
578 (errcode(ERRCODE_LOCK_FILE_EXISTS),
579 errmsg("pre-existing shared memory block "
580 "(key %lu, ID %lu) is still in use",
582 errhint("If you're sure there are no old "
583 "server processes still running, remove "
584 "the shared memory block with "
585 "the command \"ipcrm\", or just delete the file \"%s\".",
592 * Looks like nobody's home. Unlink the file and try again to
593 * create it. Need a loop because of possible race condition
594 * against other would-be creators.
596 if (unlink(filename) < 0)
598 (errcode_for_file_access(),
599 errmsg("could not remove old lock file \"%s\": %m",
601 errhint("The file seems accidentally left over, but "
602 "it could not be removed. Please remove the file "
603 "by hand and try again.")));
607 * Successfully created the file, now fill it.
609 snprintf(buffer, sizeof(buffer), "%d\n%s\n",
610 amPostmaster ? (int) my_pid : -((int) my_pid),
613 if (write(fd, buffer, strlen(buffer)) != strlen(buffer))
615 int save_errno = errno;
619 /* if write didn't set errno, assume problem is no disk space */
620 errno = save_errno ? save_errno : ENOSPC;
622 (errcode_for_file_access(),
623 errmsg("could not write lock file \"%s\": %m", filename)));
627 int save_errno = errno;
632 (errcode_for_file_access(),
633 errmsg("could not write lock file \"%s\": %m", filename)));
637 * Arrange for automatic removal of lockfile at proc_exit.
639 on_proc_exit(UnlinkLockFile, PointerGetDatum(strdup(filename)));
643 CreateDataDirLockFile(const char *datadir, bool amPostmaster)
645 char lockfile[MAXPGPATH];
647 snprintf(lockfile, sizeof(lockfile), "%s/postmaster.pid", datadir);
648 CreateLockFile(lockfile, amPostmaster, true, datadir);
649 /* Save name of lockfile for RecordSharedMemoryInLockFile */
650 strcpy(directoryLockFile, lockfile);
654 CreateSocketLockFile(const char *socketfile, bool amPostmaster)
656 char lockfile[MAXPGPATH];
658 snprintf(lockfile, sizeof(lockfile), "%s.lock", socketfile);
659 CreateLockFile(lockfile, amPostmaster, false, socketfile);
660 /* Save name of lockfile for TouchSocketLockFile */
661 strcpy(socketLockFile, lockfile);
665 * TouchSocketLockFile -- mark socket lock file as recently accessed
667 * This routine should be called every so often to ensure that the lock file
668 * has a recent mod or access date. That saves it
669 * from being removed by overenthusiastic /tmp-directory-cleaner daemons.
670 * (Another reason we should never have put the socket file in /tmp...)
673 TouchSocketLockFile(void)
675 /* Do nothing if we did not create a socket... */
676 if (socketLockFile[0] != '\0')
679 * utime() is POSIX standard, utimes() is a common alternative; if
680 * we have neither, fall back to actually reading the file (which
681 * only sets the access time not mod time, but that should be
682 * enough in most cases). In all paths, we ignore errors.
685 utime(socketLockFile, NULL);
686 #else /* !HAVE_UTIME */
688 utimes(socketLockFile, NULL);
689 #else /* !HAVE_UTIMES */
693 fd = open(socketLockFile, O_RDONLY | PG_BINARY, 0);
696 read(fd, buffer, sizeof(buffer));
699 #endif /* HAVE_UTIMES */
700 #endif /* HAVE_UTIME */
705 * Append information about a shared memory segment to the data directory
706 * lock file (if we have created one).
708 * This may be called multiple times in the life of a postmaster, if we
709 * delete and recreate shmem due to backend crash. Therefore, be prepared
710 * to overwrite existing information. (As of 7.1, a postmaster only creates
711 * one shm seg at a time; but for the purposes here, if we did have more than
712 * one then any one of them would do anyway.)
715 RecordSharedMemoryInLockFile(unsigned long id1, unsigned long id2)
723 * Do nothing if we did not create a lockfile (probably because we are
724 * running standalone).
726 if (directoryLockFile[0] == '\0')
729 fd = open(directoryLockFile, O_RDWR | PG_BINARY, 0);
733 (errcode_for_file_access(),
734 errmsg("could not open file \"%s\": %m",
735 directoryLockFile)));
738 len = read(fd, buffer, sizeof(buffer) - 100);
742 (errcode_for_file_access(),
743 errmsg("could not read from file \"%s\": %m",
744 directoryLockFile)));
751 * Skip over first two lines (PID and path).
753 ptr = strchr(buffer, '\n');
755 (ptr = strchr(ptr + 1, '\n')) == NULL)
757 elog(LOG, "bogus data in \"%s\"", directoryLockFile);
764 * Append key information. Format to try to keep it the same length
765 * always (trailing junk won't hurt, but might confuse humans).
767 sprintf(ptr, "%9lu %9lu\n", id1, id2);
770 * And rewrite the data. Since we write in a single kernel call, this
771 * update should appear atomic to onlookers.
773 len = strlen(buffer);
775 if (lseek(fd, (off_t) 0, SEEK_SET) != 0 ||
776 (int) write(fd, buffer, len) != len)
778 /* if write didn't set errno, assume problem is no disk space */
782 (errcode_for_file_access(),
783 errmsg("could not write to file \"%s\": %m",
784 directoryLockFile)));
791 (errcode_for_file_access(),
792 errmsg("could not write to file \"%s\": %m",
793 directoryLockFile)));
798 /*-------------------------------------------------------------------------
799 * Version checking support
800 *-------------------------------------------------------------------------
804 * Determine whether the PG_VERSION file in directory `path' indicates
805 * a data version compatible with the version of this program.
807 * If compatible, return. Otherwise, ereport(FATAL).
810 ValidatePgVersion(const char *path)
812 char full_path[MAXPGPATH];
820 const char *version_string = PG_VERSION;
822 my_major = strtol(version_string, &endptr, 10);
824 my_minor = strtol(endptr + 1, NULL, 10);
826 snprintf(full_path, sizeof(full_path), "%s/PG_VERSION", path);
828 file = AllocateFile(full_path, "r");
833 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
834 errmsg("\"%s\" is not a valid data directory",
836 errdetail("File \"%s\" is missing.", full_path)));
839 (errcode_for_file_access(),
840 errmsg("could not open file \"%s\": %m", full_path)));
843 ret = fscanf(file, "%ld.%ld", &file_major, &file_minor);
846 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
847 errmsg("\"%s\" is not a valid data directory",
849 errdetail("File \"%s\" does not contain valid data.",
851 errhint("You may need to initdb.")));
855 if (my_major != file_major || my_minor != file_minor)
857 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
858 errmsg("database files are incompatible with server"),
859 errdetail("The data directory was initialized by PostgreSQL version %ld.%ld, "
860 "which is not compatible with this version %s.",
861 file_major, file_minor, version_string)));
864 /*-------------------------------------------------------------------------
865 * Library preload support
866 *-------------------------------------------------------------------------
869 #if defined(__mc68000__) && defined(__ELF__)
870 typedef int32 ((*func_ptr) ());
873 typedef char *((*func_ptr) ());
877 * process any libraries that should be preloaded and
878 * optionally pre-initialized
881 process_preload_libraries(char *preload_libraries_string)
887 if (preload_libraries_string == NULL)
890 /* Need a modifiable copy of string */
891 rawstring = pstrdup(preload_libraries_string);
893 /* Parse string into list of identifiers */
894 if (!SplitIdentifierString(rawstring, ',', &elemlist))
896 /* syntax error in list */
900 (errcode(ERRCODE_SYNTAX_ERROR),
901 errmsg("invalid list syntax for parameter \"preload_libraries\"")));
907 char *tok = (char *) lfirst(l);
908 char *sep = strstr(tok, ":");
909 char *filename = NULL;
910 char *funcname = NULL;
916 * a colon separator implies there is an initialization
917 * function that we need to run in addition to loading the
920 size_t filename_len = sep - tok;
921 size_t funcname_len = strlen(tok) - filename_len - 1;
923 filename = (char *) palloc(filename_len + 1);
924 memcpy(filename, tok, filename_len);
925 filename[filename_len] = '\0';
927 funcname = (char *) palloc(funcname_len + 1);
928 strcpy(funcname, sep + 1);
933 * no separator -- just load the library
935 filename = pstrdup(tok);
939 canonicalize_path(filename);
940 initfunc = (func_ptr) load_external_function(filename, funcname,
947 (errmsg("preloaded library \"%s\" with initialization function \"%s\"",
948 filename, funcname)));
951 (errmsg("preloaded library \"%s\"",