mirror of
https://git.postgresql.org/git/postgresql.git
synced 2024-08-22 13:53:22 +02:00
576 lines
14 KiB
C
576 lines
14 KiB
C
/*-------------------------------------------------------------------------
|
|
*
|
|
* misc.c
|
|
*
|
|
*
|
|
* Portions Copyright (c) 1996-2014, PostgreSQL Global Development Group
|
|
* Portions Copyright (c) 1994, Regents of the University of California
|
|
*
|
|
*
|
|
* IDENTIFICATION
|
|
* src/backend/utils/adt/misc.c
|
|
*
|
|
*-------------------------------------------------------------------------
|
|
*/
|
|
#include "postgres.h"
|
|
|
|
#include <sys/file.h>
|
|
#include <signal.h>
|
|
#include <dirent.h>
|
|
#include <math.h>
|
|
#include <unistd.h>
|
|
|
|
#include "access/sysattr.h"
|
|
#include "catalog/catalog.h"
|
|
#include "catalog/pg_tablespace.h"
|
|
#include "catalog/pg_type.h"
|
|
#include "commands/dbcommands.h"
|
|
#include "common/relpath.h"
|
|
#include "funcapi.h"
|
|
#include "miscadmin.h"
|
|
#include "parser/keywords.h"
|
|
#include "postmaster/syslogger.h"
|
|
#include "rewrite/rewriteHandler.h"
|
|
#include "storage/fd.h"
|
|
#include "storage/pmsignal.h"
|
|
#include "storage/proc.h"
|
|
#include "storage/procarray.h"
|
|
#include "utils/lsyscache.h"
|
|
#include "tcop/tcopprot.h"
|
|
#include "utils/builtins.h"
|
|
#include "utils/timestamp.h"
|
|
|
|
#define atooid(x) ((Oid) strtoul((x), NULL, 10))
|
|
|
|
|
|
/*
|
|
* current_database()
|
|
* Expose the current database to the user
|
|
*/
|
|
Datum
|
|
current_database(PG_FUNCTION_ARGS)
|
|
{
|
|
Name db;
|
|
|
|
db = (Name) palloc(NAMEDATALEN);
|
|
|
|
namestrcpy(db, get_database_name(MyDatabaseId));
|
|
PG_RETURN_NAME(db);
|
|
}
|
|
|
|
|
|
/*
|
|
* current_query()
|
|
* Expose the current query to the user (useful in stored procedures)
|
|
* We might want to use ActivePortal->sourceText someday.
|
|
*/
|
|
Datum
|
|
current_query(PG_FUNCTION_ARGS)
|
|
{
|
|
/* there is no easy way to access the more concise 'query_string' */
|
|
if (debug_query_string)
|
|
PG_RETURN_TEXT_P(cstring_to_text(debug_query_string));
|
|
else
|
|
PG_RETURN_NULL();
|
|
}
|
|
|
|
/*
|
|
* Send a signal to another backend.
|
|
*
|
|
* The signal is delivered if the user is either a superuser or the same
|
|
* role as the backend being signaled. For "dangerous" signals, an explicit
|
|
* check for superuser needs to be done prior to calling this function.
|
|
*
|
|
* Returns 0 on success, 1 on general failure, and 2 on permission error.
|
|
* In the event of a general failure (return code 1), a warning message will
|
|
* be emitted. For permission errors, doing that is the responsibility of
|
|
* the caller.
|
|
*/
|
|
#define SIGNAL_BACKEND_SUCCESS 0
|
|
#define SIGNAL_BACKEND_ERROR 1
|
|
#define SIGNAL_BACKEND_NOPERMISSION 2
|
|
static int
|
|
pg_signal_backend(int pid, int sig)
|
|
{
|
|
PGPROC *proc = BackendPidGetProc(pid);
|
|
|
|
/*
|
|
* BackendPidGetProc returns NULL if the pid isn't valid; but by the time
|
|
* we reach kill(), a process for which we get a valid proc here might
|
|
* have terminated on its own. There's no way to acquire a lock on an
|
|
* arbitrary process to prevent that. But since so far all the callers of
|
|
* this mechanism involve some request for ending the process anyway, that
|
|
* it might end on its own first is not a problem.
|
|
*/
|
|
if (proc == NULL)
|
|
{
|
|
/*
|
|
* This is just a warning so a loop-through-resultset will not abort
|
|
* if one backend terminated on its own during the run.
|
|
*/
|
|
ereport(WARNING,
|
|
(errmsg("PID %d is not a PostgreSQL server process", pid)));
|
|
return SIGNAL_BACKEND_ERROR;
|
|
}
|
|
|
|
if (!(superuser() || proc->roleId == GetUserId()))
|
|
return SIGNAL_BACKEND_NOPERMISSION;
|
|
|
|
/*
|
|
* Can the process we just validated above end, followed by the pid being
|
|
* recycled for a new process, before reaching here? Then we'd be trying
|
|
* to kill the wrong thing. Seems near impossible when sequential pid
|
|
* assignment and wraparound is used. Perhaps it could happen on a system
|
|
* where pid re-use is randomized. That race condition possibility seems
|
|
* too unlikely to worry about.
|
|
*/
|
|
|
|
/* If we have setsid(), signal the backend's whole process group */
|
|
#ifdef HAVE_SETSID
|
|
if (kill(-pid, sig))
|
|
#else
|
|
if (kill(pid, sig))
|
|
#endif
|
|
{
|
|
/* Again, just a warning to allow loops */
|
|
ereport(WARNING,
|
|
(errmsg("could not send signal to process %d: %m", pid)));
|
|
return SIGNAL_BACKEND_ERROR;
|
|
}
|
|
return SIGNAL_BACKEND_SUCCESS;
|
|
}
|
|
|
|
/*
|
|
* Signal to cancel a backend process. This is allowed if you are superuser or
|
|
* have the same role as the process being canceled.
|
|
*/
|
|
Datum
|
|
pg_cancel_backend(PG_FUNCTION_ARGS)
|
|
{
|
|
int r = pg_signal_backend(PG_GETARG_INT32(0), SIGINT);
|
|
|
|
if (r == SIGNAL_BACKEND_NOPERMISSION)
|
|
ereport(ERROR,
|
|
(errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
|
|
(errmsg("must be superuser or have the same role to cancel queries running in other server processes"))));
|
|
|
|
PG_RETURN_BOOL(r == SIGNAL_BACKEND_SUCCESS);
|
|
}
|
|
|
|
/*
|
|
* Signal to terminate a backend process. This is allowed if you are superuser
|
|
* or have the same role as the process being terminated.
|
|
*/
|
|
Datum
|
|
pg_terminate_backend(PG_FUNCTION_ARGS)
|
|
{
|
|
int r = pg_signal_backend(PG_GETARG_INT32(0), SIGTERM);
|
|
|
|
if (r == SIGNAL_BACKEND_NOPERMISSION)
|
|
ereport(ERROR,
|
|
(errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
|
|
(errmsg("must be superuser or have the same role to terminate other server processes"))));
|
|
|
|
PG_RETURN_BOOL(r == SIGNAL_BACKEND_SUCCESS);
|
|
}
|
|
|
|
/*
|
|
* Signal to reload the database configuration
|
|
*/
|
|
Datum
|
|
pg_reload_conf(PG_FUNCTION_ARGS)
|
|
{
|
|
if (!superuser())
|
|
ereport(ERROR,
|
|
(errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
|
|
(errmsg("must be superuser to signal the postmaster"))));
|
|
|
|
if (kill(PostmasterPid, SIGHUP))
|
|
{
|
|
ereport(WARNING,
|
|
(errmsg("failed to send signal to postmaster: %m")));
|
|
PG_RETURN_BOOL(false);
|
|
}
|
|
|
|
PG_RETURN_BOOL(true);
|
|
}
|
|
|
|
|
|
/*
|
|
* Rotate log file
|
|
*/
|
|
Datum
|
|
pg_rotate_logfile(PG_FUNCTION_ARGS)
|
|
{
|
|
if (!superuser())
|
|
ereport(ERROR,
|
|
(errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
|
|
(errmsg("must be superuser to rotate log files"))));
|
|
|
|
if (!Logging_collector)
|
|
{
|
|
ereport(WARNING,
|
|
(errmsg("rotation not possible because log collection not active")));
|
|
PG_RETURN_BOOL(false);
|
|
}
|
|
|
|
SendPostmasterSignal(PMSIGNAL_ROTATE_LOGFILE);
|
|
PG_RETURN_BOOL(true);
|
|
}
|
|
|
|
/* Function to find out which databases make use of a tablespace */
|
|
|
|
typedef struct
|
|
{
|
|
char *location;
|
|
DIR *dirdesc;
|
|
} ts_db_fctx;
|
|
|
|
Datum
|
|
pg_tablespace_databases(PG_FUNCTION_ARGS)
|
|
{
|
|
FuncCallContext *funcctx;
|
|
struct dirent *de;
|
|
ts_db_fctx *fctx;
|
|
|
|
if (SRF_IS_FIRSTCALL())
|
|
{
|
|
MemoryContext oldcontext;
|
|
Oid tablespaceOid = PG_GETARG_OID(0);
|
|
|
|
funcctx = SRF_FIRSTCALL_INIT();
|
|
oldcontext = MemoryContextSwitchTo(funcctx->multi_call_memory_ctx);
|
|
|
|
fctx = palloc(sizeof(ts_db_fctx));
|
|
|
|
if (tablespaceOid == GLOBALTABLESPACE_OID)
|
|
{
|
|
fctx->dirdesc = NULL;
|
|
ereport(WARNING,
|
|
(errmsg("global tablespace never has databases")));
|
|
}
|
|
else
|
|
{
|
|
if (tablespaceOid == DEFAULTTABLESPACE_OID)
|
|
fctx->location = psprintf("base");
|
|
else
|
|
fctx->location = psprintf("pg_tblspc/%u/%s", tablespaceOid,
|
|
TABLESPACE_VERSION_DIRECTORY);
|
|
|
|
fctx->dirdesc = AllocateDir(fctx->location);
|
|
|
|
if (!fctx->dirdesc)
|
|
{
|
|
/* the only expected error is ENOENT */
|
|
if (errno != ENOENT)
|
|
ereport(ERROR,
|
|
(errcode_for_file_access(),
|
|
errmsg("could not open directory \"%s\": %m",
|
|
fctx->location)));
|
|
ereport(WARNING,
|
|
(errmsg("%u is not a tablespace OID", tablespaceOid)));
|
|
}
|
|
}
|
|
funcctx->user_fctx = fctx;
|
|
MemoryContextSwitchTo(oldcontext);
|
|
}
|
|
|
|
funcctx = SRF_PERCALL_SETUP();
|
|
fctx = (ts_db_fctx *) funcctx->user_fctx;
|
|
|
|
if (!fctx->dirdesc) /* not a tablespace */
|
|
SRF_RETURN_DONE(funcctx);
|
|
|
|
while ((de = ReadDir(fctx->dirdesc, fctx->location)) != NULL)
|
|
{
|
|
char *subdir;
|
|
DIR *dirdesc;
|
|
Oid datOid = atooid(de->d_name);
|
|
|
|
/* this test skips . and .., but is awfully weak */
|
|
if (!datOid)
|
|
continue;
|
|
|
|
/* if database subdir is empty, don't report tablespace as used */
|
|
|
|
subdir = psprintf("%s/%s", fctx->location, de->d_name);
|
|
dirdesc = AllocateDir(subdir);
|
|
while ((de = ReadDir(dirdesc, subdir)) != NULL)
|
|
{
|
|
if (strcmp(de->d_name, ".") != 0 && strcmp(de->d_name, "..") != 0)
|
|
break;
|
|
}
|
|
FreeDir(dirdesc);
|
|
pfree(subdir);
|
|
|
|
if (!de)
|
|
continue; /* indeed, nothing in it */
|
|
|
|
SRF_RETURN_NEXT(funcctx, ObjectIdGetDatum(datOid));
|
|
}
|
|
|
|
FreeDir(fctx->dirdesc);
|
|
SRF_RETURN_DONE(funcctx);
|
|
}
|
|
|
|
|
|
/*
|
|
* pg_tablespace_location - get location for a tablespace
|
|
*/
|
|
Datum
|
|
pg_tablespace_location(PG_FUNCTION_ARGS)
|
|
{
|
|
Oid tablespaceOid = PG_GETARG_OID(0);
|
|
char sourcepath[MAXPGPATH];
|
|
char targetpath[MAXPGPATH];
|
|
int rllen;
|
|
|
|
/*
|
|
* It's useful to apply this function to pg_class.reltablespace, wherein
|
|
* zero means "the database's default tablespace". So, rather than
|
|
* throwing an error for zero, we choose to assume that's what is meant.
|
|
*/
|
|
if (tablespaceOid == InvalidOid)
|
|
tablespaceOid = MyDatabaseTableSpace;
|
|
|
|
/*
|
|
* Return empty string for the cluster's default tablespaces
|
|
*/
|
|
if (tablespaceOid == DEFAULTTABLESPACE_OID ||
|
|
tablespaceOid == GLOBALTABLESPACE_OID)
|
|
PG_RETURN_TEXT_P(cstring_to_text(""));
|
|
|
|
#if defined(HAVE_READLINK) || defined(WIN32)
|
|
|
|
/*
|
|
* Find the location of the tablespace by reading the symbolic link that
|
|
* is in pg_tblspc/<oid>.
|
|
*/
|
|
snprintf(sourcepath, sizeof(sourcepath), "pg_tblspc/%u", tablespaceOid);
|
|
|
|
rllen = readlink(sourcepath, targetpath, sizeof(targetpath));
|
|
if (rllen < 0)
|
|
ereport(ERROR,
|
|
(errmsg("could not read symbolic link \"%s\": %m",
|
|
sourcepath)));
|
|
else if (rllen >= sizeof(targetpath))
|
|
ereport(ERROR,
|
|
(errmsg("symbolic link \"%s\" target is too long",
|
|
sourcepath)));
|
|
targetpath[rllen] = '\0';
|
|
|
|
PG_RETURN_TEXT_P(cstring_to_text(targetpath));
|
|
#else
|
|
ereport(ERROR,
|
|
(errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
|
|
errmsg("tablespaces are not supported on this platform")));
|
|
PG_RETURN_NULL();
|
|
#endif
|
|
}
|
|
|
|
/*
|
|
* pg_sleep - delay for N seconds
|
|
*/
|
|
Datum
|
|
pg_sleep(PG_FUNCTION_ARGS)
|
|
{
|
|
float8 secs = PG_GETARG_FLOAT8(0);
|
|
float8 endtime;
|
|
|
|
/*
|
|
* We sleep using WaitLatch, to ensure that we'll wake up promptly if an
|
|
* important signal (such as SIGALRM or SIGINT) arrives. Because
|
|
* WaitLatch's upper limit of delay is INT_MAX milliseconds, and the user
|
|
* might ask for more than that, we sleep for at most 10 minutes and then
|
|
* loop.
|
|
*
|
|
* By computing the intended stop time initially, we avoid accumulation of
|
|
* extra delay across multiple sleeps. This also ensures we won't delay
|
|
* less than the specified time when WaitLatch is terminated early by a
|
|
* non-query-cancelling signal such as SIGHUP.
|
|
*/
|
|
|
|
#ifdef HAVE_INT64_TIMESTAMP
|
|
#define GetNowFloat() ((float8) GetCurrentTimestamp() / 1000000.0)
|
|
#else
|
|
#define GetNowFloat() GetCurrentTimestamp()
|
|
#endif
|
|
|
|
endtime = GetNowFloat() + secs;
|
|
|
|
for (;;)
|
|
{
|
|
float8 delay;
|
|
long delay_ms;
|
|
|
|
CHECK_FOR_INTERRUPTS();
|
|
|
|
delay = endtime - GetNowFloat();
|
|
if (delay >= 600.0)
|
|
delay_ms = 600000;
|
|
else if (delay > 0.0)
|
|
delay_ms = (long) ceil(delay * 1000.0);
|
|
else
|
|
break;
|
|
|
|
(void) WaitLatch(&MyProc->procLatch,
|
|
WL_LATCH_SET | WL_TIMEOUT,
|
|
delay_ms);
|
|
ResetLatch(&MyProc->procLatch);
|
|
}
|
|
|
|
PG_RETURN_VOID();
|
|
}
|
|
|
|
/* Function to return the list of grammar keywords */
|
|
Datum
|
|
pg_get_keywords(PG_FUNCTION_ARGS)
|
|
{
|
|
FuncCallContext *funcctx;
|
|
|
|
if (SRF_IS_FIRSTCALL())
|
|
{
|
|
MemoryContext oldcontext;
|
|
TupleDesc tupdesc;
|
|
|
|
funcctx = SRF_FIRSTCALL_INIT();
|
|
oldcontext = MemoryContextSwitchTo(funcctx->multi_call_memory_ctx);
|
|
|
|
tupdesc = CreateTemplateTupleDesc(3, false);
|
|
TupleDescInitEntry(tupdesc, (AttrNumber) 1, "word",
|
|
TEXTOID, -1, 0);
|
|
TupleDescInitEntry(tupdesc, (AttrNumber) 2, "catcode",
|
|
CHAROID, -1, 0);
|
|
TupleDescInitEntry(tupdesc, (AttrNumber) 3, "catdesc",
|
|
TEXTOID, -1, 0);
|
|
|
|
funcctx->attinmeta = TupleDescGetAttInMetadata(tupdesc);
|
|
|
|
MemoryContextSwitchTo(oldcontext);
|
|
}
|
|
|
|
funcctx = SRF_PERCALL_SETUP();
|
|
|
|
if (funcctx->call_cntr < NumScanKeywords)
|
|
{
|
|
char *values[3];
|
|
HeapTuple tuple;
|
|
|
|
/* cast-away-const is ugly but alternatives aren't much better */
|
|
values[0] = (char *) ScanKeywords[funcctx->call_cntr].name;
|
|
|
|
switch (ScanKeywords[funcctx->call_cntr].category)
|
|
{
|
|
case UNRESERVED_KEYWORD:
|
|
values[1] = "U";
|
|
values[2] = _("unreserved");
|
|
break;
|
|
case COL_NAME_KEYWORD:
|
|
values[1] = "C";
|
|
values[2] = _("unreserved (cannot be function or type name)");
|
|
break;
|
|
case TYPE_FUNC_NAME_KEYWORD:
|
|
values[1] = "T";
|
|
values[2] = _("reserved (can be function or type name)");
|
|
break;
|
|
case RESERVED_KEYWORD:
|
|
values[1] = "R";
|
|
values[2] = _("reserved");
|
|
break;
|
|
default: /* shouldn't be possible */
|
|
values[1] = NULL;
|
|
values[2] = NULL;
|
|
break;
|
|
}
|
|
|
|
tuple = BuildTupleFromCStrings(funcctx->attinmeta, values);
|
|
|
|
SRF_RETURN_NEXT(funcctx, HeapTupleGetDatum(tuple));
|
|
}
|
|
|
|
SRF_RETURN_DONE(funcctx);
|
|
}
|
|
|
|
|
|
/*
|
|
* Return the type of the argument.
|
|
*/
|
|
Datum
|
|
pg_typeof(PG_FUNCTION_ARGS)
|
|
{
|
|
PG_RETURN_OID(get_fn_expr_argtype(fcinfo->flinfo, 0));
|
|
}
|
|
|
|
|
|
/*
|
|
* Implementation of the COLLATE FOR expression; returns the collation
|
|
* of the argument.
|
|
*/
|
|
Datum
|
|
pg_collation_for(PG_FUNCTION_ARGS)
|
|
{
|
|
Oid typeid;
|
|
Oid collid;
|
|
|
|
typeid = get_fn_expr_argtype(fcinfo->flinfo, 0);
|
|
if (!typeid)
|
|
PG_RETURN_NULL();
|
|
if (!type_is_collatable(typeid) && typeid != UNKNOWNOID)
|
|
ereport(ERROR,
|
|
(errcode(ERRCODE_DATATYPE_MISMATCH),
|
|
errmsg("collations are not supported by type %s",
|
|
format_type_be(typeid))));
|
|
|
|
collid = PG_GET_COLLATION();
|
|
if (!collid)
|
|
PG_RETURN_NULL();
|
|
PG_RETURN_TEXT_P(cstring_to_text(generate_collation_name(collid)));
|
|
}
|
|
|
|
|
|
/*
|
|
* pg_relation_is_updatable - determine which update events the specified
|
|
* relation supports.
|
|
*
|
|
* This relies on relation_is_updatable() in rewriteHandler.c, which see
|
|
* for additional information.
|
|
*/
|
|
Datum
|
|
pg_relation_is_updatable(PG_FUNCTION_ARGS)
|
|
{
|
|
Oid reloid = PG_GETARG_OID(0);
|
|
bool include_triggers = PG_GETARG_BOOL(1);
|
|
|
|
PG_RETURN_INT32(relation_is_updatable(reloid, include_triggers, NULL));
|
|
}
|
|
|
|
/*
|
|
* pg_column_is_updatable - determine whether a column is updatable
|
|
*
|
|
* This function encapsulates the decision about just what
|
|
* information_schema.columns.is_updatable actually means. It's not clear
|
|
* whether deletability of the column's relation should be required, so
|
|
* we want that decision in C code where we could change it without initdb.
|
|
*/
|
|
Datum
|
|
pg_column_is_updatable(PG_FUNCTION_ARGS)
|
|
{
|
|
Oid reloid = PG_GETARG_OID(0);
|
|
AttrNumber attnum = PG_GETARG_INT16(1);
|
|
AttrNumber col = attnum - FirstLowInvalidHeapAttributeNumber;
|
|
bool include_triggers = PG_GETARG_BOOL(2);
|
|
int events;
|
|
|
|
/* System columns are never updatable */
|
|
if (attnum <= 0)
|
|
PG_RETURN_BOOL(false);
|
|
|
|
events = relation_is_updatable(reloid, include_triggers,
|
|
bms_make_singleton(col));
|
|
|
|
/* We require both updatability and deletability of the relation */
|
|
#define REQ_EVENTS ((1 << CMD_UPDATE) | (1 << CMD_DELETE))
|
|
|
|
PG_RETURN_BOOL((events & REQ_EVENTS) == REQ_EVENTS);
|
|
}
|