PostgreSQL Source Code  git master
misc.c File Reference
#include "postgres.h"
#include <sys/file.h>
#include <dirent.h>
#include <fcntl.h>
#include <math.h>
#include <unistd.h>
#include "access/sysattr.h"
#include "access/table.h"
#include "catalog/catalog.h"
#include "catalog/pg_tablespace.h"
#include "catalog/pg_type.h"
#include "commands/dbcommands.h"
#include "commands/tablespace.h"
#include "common/keywords.h"
#include "funcapi.h"
#include "miscadmin.h"
#include "parser/scansup.h"
#include "pgstat.h"
#include "postmaster/syslogger.h"
#include "rewrite/rewriteHandler.h"
#include "storage/fd.h"
#include "tcop/tcopprot.h"
#include "utils/builtins.h"
#include "utils/lsyscache.h"
#include "utils/ruleutils.h"
#include "utils/timestamp.h"
Include dependency graph for misc.c:

Go to the source code of this file.

Macros

#define GetNowFloat()   ((float8) GetCurrentTimestamp() / 1000000.0)
 
#define REQ_EVENTS   ((1 << CMD_UPDATE) | (1 << CMD_DELETE))
 

Functions

static bool count_nulls (FunctionCallInfo fcinfo, int32 *nargs, int32 *nulls)
 
Datum pg_num_nulls (PG_FUNCTION_ARGS)
 
Datum pg_num_nonnulls (PG_FUNCTION_ARGS)
 
Datum current_database (PG_FUNCTION_ARGS)
 
Datum current_query (PG_FUNCTION_ARGS)
 
Datum pg_tablespace_databases (PG_FUNCTION_ARGS)
 
Datum pg_tablespace_location (PG_FUNCTION_ARGS)
 
Datum pg_sleep (PG_FUNCTION_ARGS)
 
Datum pg_get_keywords (PG_FUNCTION_ARGS)
 
Datum pg_typeof (PG_FUNCTION_ARGS)
 
Datum pg_collation_for (PG_FUNCTION_ARGS)
 
Datum pg_relation_is_updatable (PG_FUNCTION_ARGS)
 
Datum pg_column_is_updatable (PG_FUNCTION_ARGS)
 
static bool is_ident_start (unsigned char c)
 
static bool is_ident_cont (unsigned char c)
 
Datum parse_ident (PG_FUNCTION_ARGS)
 
Datum pg_current_logfile (PG_FUNCTION_ARGS)
 
Datum pg_current_logfile_1arg (PG_FUNCTION_ARGS)
 
Datum pg_get_replica_identity_index (PG_FUNCTION_ARGS)
 

Macro Definition Documentation

◆ GetNowFloat

#define GetNowFloat ( )    ((float8) GetCurrentTimestamp() / 1000000.0)

Referenced by pg_sleep().

◆ REQ_EVENTS

#define REQ_EVENTS   ((1 << CMD_UPDATE) | (1 << CMD_DELETE))

Referenced by pg_column_is_updatable().

Function Documentation

◆ count_nulls()

static bool count_nulls ( FunctionCallInfo  fcinfo,
int32 nargs,
int32 nulls 
)
static

Definition at line 51 of file misc.c.

References ARR_DIMS, ARR_NDIM, ARR_NULLBITMAP, ArrayGetNItems(), Assert, FunctionCallInfoBaseData::flinfo, get_base_element_type(), get_fn_expr_argtype(), get_fn_expr_variadic(), i, OidIsValid, PG_ARGISNULL, PG_GETARG_ARRAYTYPE_P, and PG_NARGS.

Referenced by pg_num_nonnulls(), and pg_num_nulls().

53 {
54  int32 count = 0;
55  int i;
56 
57  /* Did we get a VARIADIC array argument, or separate arguments? */
58  if (get_fn_expr_variadic(fcinfo->flinfo))
59  {
60  ArrayType *arr;
61  int ndims,
62  nitems,
63  *dims;
64  bits8 *bitmap;
65 
66  Assert(PG_NARGS() == 1);
67 
68  /*
69  * If we get a null as VARIADIC array argument, we can't say anything
70  * useful about the number of elements, so return NULL. This behavior
71  * is consistent with other variadic functions - see concat_internal.
72  */
73  if (PG_ARGISNULL(0))
74  return false;
75 
76  /*
77  * Non-null argument had better be an array. We assume that any call
78  * context that could let get_fn_expr_variadic return true will have
79  * checked that a VARIADIC-labeled parameter actually is an array. So
80  * it should be okay to just Assert that it's an array rather than
81  * doing a full-fledged error check.
82  */
84 
85  /* OK, safe to fetch the array value */
86  arr = PG_GETARG_ARRAYTYPE_P(0);
87 
88  /* Count the array elements */
89  ndims = ARR_NDIM(arr);
90  dims = ARR_DIMS(arr);
91  nitems = ArrayGetNItems(ndims, dims);
92 
93  /* Count those that are NULL */
94  bitmap = ARR_NULLBITMAP(arr);
95  if (bitmap)
96  {
97  int bitmask = 1;
98 
99  for (i = 0; i < nitems; i++)
100  {
101  if ((*bitmap & bitmask) == 0)
102  count++;
103 
104  bitmask <<= 1;
105  if (bitmask == 0x100)
106  {
107  bitmap++;
108  bitmask = 1;
109  }
110  }
111  }
112 
113  *nargs = nitems;
114  *nulls = count;
115  }
116  else
117  {
118  /* Separate arguments, so just count 'em */
119  for (i = 0; i < PG_NARGS(); i++)
120  {
121  if (PG_ARGISNULL(i))
122  count++;
123  }
124 
125  *nargs = PG_NARGS();
126  *nulls = count;
127  }
128 
129  return true;
130 }
int ArrayGetNItems(int ndim, const int *dims)
Definition: arrayutils.c:75
bool get_fn_expr_variadic(FmgrInfo *flinfo)
Definition: fmgr.c:1938
#define OidIsValid(objectId)
Definition: c.h:651
signed int int32
Definition: c.h:362
#define PG_GETARG_ARRAYTYPE_P(n)
Definition: array.h:251
Oid get_fn_expr_argtype(FmgrInfo *flinfo, int argnum)
Definition: fmgr.c:1804
#define ARR_DIMS(a)
Definition: array.h:282
uint8 bits8
Definition: c.h:381
FmgrInfo * flinfo
Definition: fmgr.h:87
#define PG_ARGISNULL(n)
Definition: fmgr.h:209
#define Assert(condition)
Definition: c.h:745
#define PG_NARGS()
Definition: fmgr.h:203
#define ARR_NDIM(a)
Definition: array.h:278
Oid get_base_element_type(Oid typid)
Definition: lsyscache.c:2709
int i
#define ARR_NULLBITMAP(a)
Definition: array.h:288

◆ current_database()

Datum current_database ( PG_FUNCTION_ARGS  )

Definition at line 170 of file misc.c.

References get_database_name(), MyDatabaseId, NAMEDATALEN, namestrcpy(), palloc(), and PG_RETURN_NAME.

Referenced by ExecEvalSQLValueFunction().

171 {
172  Name db;
173 
174  db = (Name) palloc(NAMEDATALEN);
175 
177  PG_RETURN_NAME(db);
178 }
int namestrcpy(Name name, const char *str)
Definition: name.c:250
#define NAMEDATALEN
char * get_database_name(Oid dbid)
Definition: dbcommands.c:2155
Definition: c.h:616
Oid MyDatabaseId
Definition: globals.c:85
void * palloc(Size size)
Definition: mcxt.c:949
NameData * Name
Definition: c.h:620
#define PG_RETURN_NAME(x)
Definition: fmgr.h:362

◆ current_query()

Datum current_query ( PG_FUNCTION_ARGS  )

Definition at line 187 of file misc.c.

References cstring_to_text(), debug_query_string, PG_RETURN_NULL, and PG_RETURN_TEXT_P.

Referenced by dblink_current_query().

188 {
189  /* there is no easy way to access the more concise 'query_string' */
190  if (debug_query_string)
192  else
193  PG_RETURN_NULL();
194 }
const char * debug_query_string
Definition: postgres.c:88
#define PG_RETURN_TEXT_P(x)
Definition: fmgr.h:370
text * cstring_to_text(const char *s)
Definition: varlena.c:172
#define PG_RETURN_NULL()
Definition: fmgr.h:344

◆ is_ident_cont()

static bool is_ident_cont ( unsigned char  c)
static

Definition at line 583 of file misc.c.

References is_ident_start().

Referenced by parse_ident().

584 {
585  /* Can be digit or dollar sign ... */
586  if ((c >= '0' && c <= '9') || c == '$')
587  return true;
588  /* ... or an identifier start character */
589  return is_ident_start(c);
590 }
static bool is_ident_start(unsigned char c)
Definition: misc.c:565
char * c

◆ is_ident_start()

static bool is_ident_start ( unsigned char  c)
static

Definition at line 565 of file misc.c.

References IS_HIGHBIT_SET.

Referenced by is_ident_cont(), and parse_ident().

566 {
567  /* Underscores and ASCII letters are OK */
568  if (c == '_')
569  return true;
570  if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z'))
571  return true;
572  /* Any high-bit-set character is OK (might be part of a multibyte char) */
573  if (IS_HIGHBIT_SET(c))
574  return true;
575  return false;
576 }
#define IS_HIGHBIT_SET(ch)
Definition: c.h:1126
char * c

◆ parse_ident()

Datum parse_ident ( PG_FUNCTION_ARGS  )

Definition at line 598 of file misc.c.

References accumArrayResult(), cstring_to_text_with_len(), CStringGetTextDatum, CurrentMemoryContext, downcase_identifier(), ereport, errcode(), errdetail(), errmsg(), ERROR, is_ident_cont(), is_ident_start(), makeArrayResult(), PG_GETARG_BOOL, PG_GETARG_TEXT_PP, PG_RETURN_DATUM, PointerGetDatum, scanner_isspace(), and text_to_cstring().

599 {
600  text *qualname = PG_GETARG_TEXT_PP(0);
601  bool strict = PG_GETARG_BOOL(1);
602  char *qualname_str = text_to_cstring(qualname);
603  ArrayBuildState *astate = NULL;
604  char *nextp;
605  bool after_dot = false;
606 
607  /*
608  * The code below scribbles on qualname_str in some cases, so we should
609  * reconvert qualname if we need to show the original string in error
610  * messages.
611  */
612  nextp = qualname_str;
613 
614  /* skip leading whitespace */
615  while (scanner_isspace(*nextp))
616  nextp++;
617 
618  for (;;)
619  {
620  char *curname;
621  bool missing_ident = true;
622 
623  if (*nextp == '"')
624  {
625  char *endp;
626 
627  curname = nextp + 1;
628  for (;;)
629  {
630  endp = strchr(nextp + 1, '"');
631  if (endp == NULL)
632  ereport(ERROR,
633  (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
634  errmsg("string is not a valid identifier: \"%s\"",
635  text_to_cstring(qualname)),
636  errdetail("String has unclosed double quotes.")));
637  if (endp[1] != '"')
638  break;
639  memmove(endp, endp + 1, strlen(endp));
640  nextp = endp;
641  }
642  nextp = endp + 1;
643  *endp = '\0';
644 
645  if (endp - curname == 0)
646  ereport(ERROR,
647  (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
648  errmsg("string is not a valid identifier: \"%s\"",
649  text_to_cstring(qualname)),
650  errdetail("Quoted identifier must not be empty.")));
651 
652  astate = accumArrayResult(astate, CStringGetTextDatum(curname),
653  false, TEXTOID, CurrentMemoryContext);
654  missing_ident = false;
655  }
656  else if (is_ident_start((unsigned char) *nextp))
657  {
658  char *downname;
659  int len;
660  text *part;
661 
662  curname = nextp++;
663  while (is_ident_cont((unsigned char) *nextp))
664  nextp++;
665 
666  len = nextp - curname;
667 
668  /*
669  * We don't implicitly truncate identifiers. This is useful for
670  * allowing the user to check for specific parts of the identifier
671  * being too long. It's easy enough for the user to get the
672  * truncated names by casting our output to name[].
673  */
674  downname = downcase_identifier(curname, len, false, false);
675  part = cstring_to_text_with_len(downname, len);
676  astate = accumArrayResult(astate, PointerGetDatum(part), false,
677  TEXTOID, CurrentMemoryContext);
678  missing_ident = false;
679  }
680 
681  if (missing_ident)
682  {
683  /* Different error messages based on where we failed. */
684  if (*nextp == '.')
685  ereport(ERROR,
686  (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
687  errmsg("string is not a valid identifier: \"%s\"",
688  text_to_cstring(qualname)),
689  errdetail("No valid identifier before \".\".")));
690  else if (after_dot)
691  ereport(ERROR,
692  (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
693  errmsg("string is not a valid identifier: \"%s\"",
694  text_to_cstring(qualname)),
695  errdetail("No valid identifier after \".\".")));
696  else
697  ereport(ERROR,
698  (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
699  errmsg("string is not a valid identifier: \"%s\"",
700  text_to_cstring(qualname))));
701  }
702 
703  while (scanner_isspace(*nextp))
704  nextp++;
705 
706  if (*nextp == '.')
707  {
708  after_dot = true;
709  nextp++;
710  while (scanner_isspace(*nextp))
711  nextp++;
712  }
713  else if (*nextp == '\0')
714  {
715  break;
716  }
717  else
718  {
719  if (strict)
720  ereport(ERROR,
721  (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
722  errmsg("string is not a valid identifier: \"%s\"",
723  text_to_cstring(qualname))));
724  break;
725  }
726  }
727 
729 }
static bool is_ident_start(unsigned char c)
Definition: misc.c:565
#define PointerGetDatum(X)
Definition: postgres.h:556
int errcode(int sqlerrcode)
Definition: elog.c:610
#define PG_GETARG_BOOL(n)
Definition: fmgr.h:274
#define PG_GETARG_TEXT_PP(n)
Definition: fmgr.h:308
#define ERROR
Definition: elog.h:43
text * cstring_to_text_with_len(const char *s, int len)
Definition: varlena.c:184
int errdetail(const char *fmt,...)
Definition: elog.c:957
MemoryContext CurrentMemoryContext
Definition: mcxt.c:38
Datum makeArrayResult(ArrayBuildState *astate, MemoryContext rcontext)
Definition: arrayfuncs.c:5144
#define PG_RETURN_DATUM(x)
Definition: fmgr.h:352
bool scanner_isspace(char ch)
Definition: scansup.c:210
char * downcase_identifier(const char *ident, int len, bool warn, bool truncate)
Definition: scansup.c:139
#define ereport(elevel,...)
Definition: elog.h:144
static bool is_ident_cont(unsigned char c)
Definition: misc.c:583
char * text_to_cstring(const text *t)
Definition: varlena.c:205
ArrayBuildState * accumArrayResult(ArrayBuildState *astate, Datum dvalue, bool disnull, Oid element_type, MemoryContext rcontext)
Definition: arrayfuncs.c:5080
int errmsg(const char *fmt,...)
Definition: elog.c:824
#define CStringGetTextDatum(s)
Definition: builtins.h:87
Definition: c.h:562

◆ pg_collation_for()

Datum pg_collation_for ( PG_FUNCTION_ARGS  )

Definition at line 492 of file misc.c.

References cstring_to_text(), ereport, errcode(), errmsg(), ERROR, format_type_be(), generate_collation_name(), get_fn_expr_argtype(), PG_GET_COLLATION, PG_RETURN_NULL, PG_RETURN_TEXT_P, and type_is_collatable().

493 {
494  Oid typeid;
495  Oid collid;
496 
497  typeid = get_fn_expr_argtype(fcinfo->flinfo, 0);
498  if (!typeid)
499  PG_RETURN_NULL();
500  if (!type_is_collatable(typeid) && typeid != UNKNOWNOID)
501  ereport(ERROR,
502  (errcode(ERRCODE_DATATYPE_MISMATCH),
503  errmsg("collations are not supported by type %s",
504  format_type_be(typeid))));
505 
506  collid = PG_GET_COLLATION();
507  if (!collid)
508  PG_RETURN_NULL();
510 }
int errcode(int sqlerrcode)
Definition: elog.c:610
char * format_type_be(Oid type_oid)
Definition: format_type.c:339
unsigned int Oid
Definition: postgres_ext.h:31
#define PG_GET_COLLATION()
Definition: fmgr.h:198
char * generate_collation_name(Oid collid)
Definition: ruleutils.c:11243
#define ERROR
Definition: elog.h:43
Oid get_fn_expr_argtype(FmgrInfo *flinfo, int argnum)
Definition: fmgr.c:1804
#define ereport(elevel,...)
Definition: elog.h:144
#define PG_RETURN_TEXT_P(x)
Definition: fmgr.h:370
text * cstring_to_text(const char *s)
Definition: varlena.c:172
int errmsg(const char *fmt,...)
Definition: elog.c:824
bool type_is_collatable(Oid typid)
Definition: lsyscache.c:2958
#define PG_RETURN_NULL()
Definition: fmgr.h:344

◆ pg_column_is_updatable()

Datum pg_column_is_updatable ( PG_FUNCTION_ARGS  )

Definition at line 538 of file misc.c.

References attnum, bms_make_singleton(), FirstLowInvalidHeapAttributeNumber, NIL, PG_GETARG_BOOL, PG_GETARG_INT16, PG_GETARG_OID, PG_RETURN_BOOL, relation_is_updatable(), and REQ_EVENTS.

539 {
540  Oid reloid = PG_GETARG_OID(0);
543  bool include_triggers = PG_GETARG_BOOL(2);
544  int events;
545 
546  /* System columns are never updatable */
547  if (attnum <= 0)
548  PG_RETURN_BOOL(false);
549 
550  events = relation_is_updatable(reloid, NIL, include_triggers,
551  bms_make_singleton(col));
552 
553  /* We require both updatability and deletability of the relation */
554 #define REQ_EVENTS ((1 << CMD_UPDATE) | (1 << CMD_DELETE))
555 
556  PG_RETURN_BOOL((events & REQ_EVENTS) == REQ_EVENTS);
557 }
#define NIL
Definition: pg_list.h:65
#define FirstLowInvalidHeapAttributeNumber
Definition: sysattr.h:27
#define PG_GETARG_BOOL(n)
Definition: fmgr.h:274
unsigned int Oid
Definition: postgres_ext.h:31
Bitmapset * bms_make_singleton(int x)
Definition: bitmapset.c:186
#define PG_GETARG_OID(n)
Definition: fmgr.h:275
int relation_is_updatable(Oid reloid, List *outer_reloids, bool include_triggers, Bitmapset *include_cols)
#define PG_RETURN_BOOL(x)
Definition: fmgr.h:358
#define PG_GETARG_INT16(n)
Definition: fmgr.h:271
#define REQ_EVENTS
int16 attnum
Definition: pg_attribute.h:79
int16 AttrNumber
Definition: attnum.h:21

◆ pg_current_logfile()

Datum pg_current_logfile ( PG_FUNCTION_ARGS  )

Definition at line 737 of file misc.c.

References AllocateFile(), cstring_to_text(), elog, ereport, errcode(), errcode_for_file_access(), errhint(), errmsg(), ERROR, fd(), FreeFile(), LOG_METAINFO_DATAFILE, MAXPGPATH, PG_ARGISNULL, PG_GETARG_TEXT_PP, PG_NARGS, PG_RETURN_NULL, PG_RETURN_TEXT_P, and text_to_cstring().

Referenced by pg_current_logfile_1arg().

738 {
739  FILE *fd;
740  char lbuffer[MAXPGPATH];
741  char *logfmt;
742 
743  /* The log format parameter is optional */
744  if (PG_NARGS() == 0 || PG_ARGISNULL(0))
745  logfmt = NULL;
746  else
747  {
748  logfmt = text_to_cstring(PG_GETARG_TEXT_PP(0));
749 
750  if (strcmp(logfmt, "stderr") != 0 && strcmp(logfmt, "csvlog") != 0)
751  ereport(ERROR,
752  (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
753  errmsg("log format \"%s\" is not supported", logfmt),
754  errhint("The supported log formats are \"stderr\" and \"csvlog\".")));
755  }
756 
758  if (fd == NULL)
759  {
760  if (errno != ENOENT)
761  ereport(ERROR,
763  errmsg("could not read file \"%s\": %m",
765  PG_RETURN_NULL();
766  }
767 
768 #ifdef WIN32
769  /* syslogger.c writes CRLF line endings on Windows */
770  _setmode(_fileno(fd), _O_TEXT);
771 #endif
772 
773  /*
774  * Read the file to gather current log filename(s) registered by the
775  * syslogger.
776  */
777  while (fgets(lbuffer, sizeof(lbuffer), fd) != NULL)
778  {
779  char *log_format;
780  char *log_filepath;
781  char *nlpos;
782 
783  /* Extract log format and log file path from the line. */
784  log_format = lbuffer;
785  log_filepath = strchr(lbuffer, ' ');
786  if (log_filepath == NULL)
787  {
788  /* Uh oh. No space found, so file content is corrupted. */
789  elog(ERROR,
790  "missing space character in \"%s\"", LOG_METAINFO_DATAFILE);
791  break;
792  }
793 
794  *log_filepath = '\0';
795  log_filepath++;
796  nlpos = strchr(log_filepath, '\n');
797  if (nlpos == NULL)
798  {
799  /* Uh oh. No newline found, so file content is corrupted. */
800  elog(ERROR,
801  "missing newline character in \"%s\"", LOG_METAINFO_DATAFILE);
802  break;
803  }
804  *nlpos = '\0';
805 
806  if (logfmt == NULL || strcmp(logfmt, log_format) == 0)
807  {
808  FreeFile(fd);
809  PG_RETURN_TEXT_P(cstring_to_text(log_filepath));
810  }
811  }
812 
813  /* Close the current log filename file. */
814  FreeFile(fd);
815 
816  PG_RETURN_NULL();
817 }
int errhint(const char *fmt,...)
Definition: elog.c:1071
int errcode(int sqlerrcode)
Definition: elog.c:610
#define LOG_METAINFO_DATAFILE
Definition: syslogger.h:95
static int fd(const char *x, int i)
Definition: preproc-init.c:105
#define PG_GETARG_TEXT_PP(n)
Definition: fmgr.h:308
#define ERROR
Definition: elog.h:43
#define MAXPGPATH
int errcode_for_file_access(void)
Definition: elog.c:633
FILE * AllocateFile(const char *name, const char *mode)
Definition: fd.c:2322
#define ereport(elevel,...)
Definition: elog.h:144
#define PG_RETURN_TEXT_P(x)
Definition: fmgr.h:370
text * cstring_to_text(const char *s)
Definition: varlena.c:172
#define PG_ARGISNULL(n)
Definition: fmgr.h:209
#define PG_NARGS()
Definition: fmgr.h:203
int FreeFile(FILE *file)
Definition: fd.c:2521
char * text_to_cstring(const text *t)
Definition: varlena.c:205
int errmsg(const char *fmt,...)
Definition: elog.c:824
#define elog(elevel,...)
Definition: elog.h:214
#define PG_RETURN_NULL()
Definition: fmgr.h:344

◆ pg_current_logfile_1arg()

Datum pg_current_logfile_1arg ( PG_FUNCTION_ARGS  )

Definition at line 827 of file misc.c.

References pg_current_logfile().

828 {
829  return pg_current_logfile(fcinfo);
830 }
Datum pg_current_logfile(PG_FUNCTION_ARGS)
Definition: misc.c:737

◆ pg_get_keywords()

Datum pg_get_keywords ( PG_FUNCTION_ARGS  )

Definition at line 407 of file misc.c.

References _, FuncCallContext::attinmeta, BuildTupleFromCStrings(), FuncCallContext::call_cntr, COL_NAME_KEYWORD, CreateTemplateTupleDesc(), GetScanKeyword(), HeapTupleGetDatum, MemoryContextSwitchTo(), FuncCallContext::multi_call_memory_ctx, ScanKeywordList::num_keywords, RESERVED_KEYWORD, ScanKeywordCategories, ScanKeywords, SRF_FIRSTCALL_INIT, SRF_IS_FIRSTCALL, SRF_PERCALL_SETUP, SRF_RETURN_DONE, SRF_RETURN_NEXT, TupleDescGetAttInMetadata(), TupleDescInitEntry(), TYPE_FUNC_NAME_KEYWORD, unconstify, UNRESERVED_KEYWORD, and values.

408 {
409  FuncCallContext *funcctx;
410 
411  if (SRF_IS_FIRSTCALL())
412  {
413  MemoryContext oldcontext;
414  TupleDesc tupdesc;
415 
416  funcctx = SRF_FIRSTCALL_INIT();
417  oldcontext = MemoryContextSwitchTo(funcctx->multi_call_memory_ctx);
418 
419  tupdesc = CreateTemplateTupleDesc(3);
420  TupleDescInitEntry(tupdesc, (AttrNumber) 1, "word",
421  TEXTOID, -1, 0);
422  TupleDescInitEntry(tupdesc, (AttrNumber) 2, "catcode",
423  CHAROID, -1, 0);
424  TupleDescInitEntry(tupdesc, (AttrNumber) 3, "catdesc",
425  TEXTOID, -1, 0);
426 
427  funcctx->attinmeta = TupleDescGetAttInMetadata(tupdesc);
428 
429  MemoryContextSwitchTo(oldcontext);
430  }
431 
432  funcctx = SRF_PERCALL_SETUP();
433 
434  if (funcctx->call_cntr < ScanKeywords.num_keywords)
435  {
436  char *values[3];
437  HeapTuple tuple;
438 
439  /* cast-away-const is ugly but alternatives aren't much better */
440  values[0] = unconstify(char *,
441  GetScanKeyword(funcctx->call_cntr,
442  &ScanKeywords));
443 
444  switch (ScanKeywordCategories[funcctx->call_cntr])
445  {
446  case UNRESERVED_KEYWORD:
447  values[1] = "U";
448  values[2] = _("unreserved");
449  break;
450  case COL_NAME_KEYWORD:
451  values[1] = "C";
452  values[2] = _("unreserved (cannot be function or type name)");
453  break;
455  values[1] = "T";
456  values[2] = _("reserved (can be function or type name)");
457  break;
458  case RESERVED_KEYWORD:
459  values[1] = "R";
460  values[2] = _("reserved");
461  break;
462  default: /* shouldn't be possible */
463  values[1] = NULL;
464  values[2] = NULL;
465  break;
466  }
467 
468  tuple = BuildTupleFromCStrings(funcctx->attinmeta, values);
469 
470  SRF_RETURN_NEXT(funcctx, HeapTupleGetDatum(tuple));
471  }
472 
473  SRF_RETURN_DONE(funcctx);
474 }
uint64 call_cntr
Definition: funcapi.h:65
TupleDesc CreateTemplateTupleDesc(int natts)
Definition: tupdesc.c:44
#define SRF_IS_FIRSTCALL()
Definition: funcapi.h:293
static MemoryContext MemoryContextSwitchTo(MemoryContext context)
Definition: palloc.h:109
const uint8 ScanKeywordCategories[SCANKEYWORDS_NUM_KEYWORDS]
Definition: keywords.c:29
#define UNRESERVED_KEYWORD
Definition: keywords.h:20
#define SRF_PERCALL_SETUP()
Definition: funcapi.h:297
static const char * GetScanKeyword(int n, const ScanKeywordList *keywords)
Definition: kwlookup.h:39
HeapTuple BuildTupleFromCStrings(AttInMetadata *attinmeta, char **values)
Definition: execTuples.c:2116
PGDLLIMPORT const ScanKeywordList ScanKeywords
#define SRF_RETURN_NEXT(_funcctx, _result)
Definition: funcapi.h:299
#define TYPE_FUNC_NAME_KEYWORD
Definition: keywords.h:22
AttInMetadata * attinmeta
Definition: funcapi.h:91
void TupleDescInitEntry(TupleDesc desc, AttrNumber attributeNumber, const char *attributeName, Oid oidtypeid, int32 typmod, int attdim)
Definition: tupdesc.c:603
#define unconstify(underlying_type, expr)
Definition: c.h:1212
int num_keywords
Definition: kwlookup.h:30
AttInMetadata * TupleDescGetAttInMetadata(TupleDesc tupdesc)
Definition: execTuples.c:2067
#define RESERVED_KEYWORD
Definition: keywords.h:23
MemoryContext multi_call_memory_ctx
Definition: funcapi.h:101
#define HeapTupleGetDatum(tuple)
Definition: funcapi.h:220
#define COL_NAME_KEYWORD
Definition: keywords.h:21
static Datum values[MAXATTR]
Definition: bootstrap.c:167
int16 AttrNumber
Definition: attnum.h:21
#define _(x)
Definition: elog.c:88
#define SRF_RETURN_DONE(_funcctx)
Definition: funcapi.h:317
#define SRF_FIRSTCALL_INIT()
Definition: funcapi.h:295

◆ pg_get_replica_identity_index()

Datum pg_get_replica_identity_index ( PG_FUNCTION_ARGS  )

Definition at line 836 of file misc.c.

References AccessShareLock, OidIsValid, PG_GETARG_OID, PG_RETURN_NULL, PG_RETURN_OID, RelationGetReplicaIndex(), table_close(), and table_open().

837 {
838  Oid reloid = PG_GETARG_OID(0);
839  Oid idxoid;
840  Relation rel;
841 
842  rel = table_open(reloid, AccessShareLock);
843  idxoid = RelationGetReplicaIndex(rel);
845 
846  if (OidIsValid(idxoid))
847  PG_RETURN_OID(idxoid);
848  else
849  PG_RETURN_NULL();
850 }
void table_close(Relation relation, LOCKMODE lockmode)
Definition: table.c:133
Oid RelationGetReplicaIndex(Relation relation)
Definition: relcache.c:4716
#define AccessShareLock
Definition: lockdefs.h:36
unsigned int Oid
Definition: postgres_ext.h:31
#define OidIsValid(objectId)
Definition: c.h:651
#define PG_GETARG_OID(n)
Definition: fmgr.h:275
Relation table_open(Oid relationId, LOCKMODE lockmode)
Definition: table.c:39
#define PG_RETURN_OID(x)
Definition: fmgr.h:359
#define PG_RETURN_NULL()
Definition: fmgr.h:344

◆ pg_num_nonnulls()

Datum pg_num_nonnulls ( PG_FUNCTION_ARGS  )

Definition at line 153 of file misc.c.

References count_nulls(), PG_RETURN_INT32, and PG_RETURN_NULL.

154 {
155  int32 nargs,
156  nulls;
157 
158  if (!count_nulls(fcinfo, &nargs, &nulls))
159  PG_RETURN_NULL();
160 
161  PG_RETURN_INT32(nargs - nulls);
162 }
static bool count_nulls(FunctionCallInfo fcinfo, int32 *nargs, int32 *nulls)
Definition: misc.c:51
#define PG_RETURN_INT32(x)
Definition: fmgr.h:353
signed int int32
Definition: c.h:362
#define PG_RETURN_NULL()
Definition: fmgr.h:344

◆ pg_num_nulls()

Datum pg_num_nulls ( PG_FUNCTION_ARGS  )

Definition at line 137 of file misc.c.

References count_nulls(), PG_RETURN_INT32, and PG_RETURN_NULL.

138 {
139  int32 nargs,
140  nulls;
141 
142  if (!count_nulls(fcinfo, &nargs, &nulls))
143  PG_RETURN_NULL();
144 
145  PG_RETURN_INT32(nulls);
146 }
static bool count_nulls(FunctionCallInfo fcinfo, int32 *nargs, int32 *nulls)
Definition: misc.c:51
#define PG_RETURN_INT32(x)
Definition: fmgr.h:353
signed int int32
Definition: c.h:362
#define PG_RETURN_NULL()
Definition: fmgr.h:344

◆ pg_relation_is_updatable()

Datum pg_relation_is_updatable ( PG_FUNCTION_ARGS  )

Definition at line 521 of file misc.c.

References NIL, PG_GETARG_BOOL, PG_GETARG_OID, PG_RETURN_INT32, and relation_is_updatable().

522 {
523  Oid reloid = PG_GETARG_OID(0);
524  bool include_triggers = PG_GETARG_BOOL(1);
525 
526  PG_RETURN_INT32(relation_is_updatable(reloid, NIL, include_triggers, NULL));
527 }
#define NIL
Definition: pg_list.h:65
#define PG_RETURN_INT32(x)
Definition: fmgr.h:353
#define PG_GETARG_BOOL(n)
Definition: fmgr.h:274
unsigned int Oid
Definition: postgres_ext.h:31
#define PG_GETARG_OID(n)
Definition: fmgr.h:275
int relation_is_updatable(Oid reloid, List *outer_reloids, bool include_triggers, Bitmapset *include_cols)

◆ pg_sleep()

Datum pg_sleep ( PG_FUNCTION_ARGS  )

Definition at line 359 of file misc.c.

References CHECK_FOR_INTERRUPTS, GetNowFloat, MyLatch, PG_GETARG_FLOAT8, PG_RETURN_VOID, ResetLatch(), WAIT_EVENT_PG_SLEEP, WaitLatch(), WL_EXIT_ON_PM_DEATH, WL_LATCH_SET, and WL_TIMEOUT.

360 {
361  float8 secs = PG_GETARG_FLOAT8(0);
362  float8 endtime;
363 
364  /*
365  * We sleep using WaitLatch, to ensure that we'll wake up promptly if an
366  * important signal (such as SIGALRM or SIGINT) arrives. Because
367  * WaitLatch's upper limit of delay is INT_MAX milliseconds, and the user
368  * might ask for more than that, we sleep for at most 10 minutes and then
369  * loop.
370  *
371  * By computing the intended stop time initially, we avoid accumulation of
372  * extra delay across multiple sleeps. This also ensures we won't delay
373  * less than the specified time when WaitLatch is terminated early by a
374  * non-query-canceling signal such as SIGHUP.
375  */
376 #define GetNowFloat() ((float8) GetCurrentTimestamp() / 1000000.0)
377 
378  endtime = GetNowFloat() + secs;
379 
380  for (;;)
381  {
382  float8 delay;
383  long delay_ms;
384 
386 
387  delay = endtime - GetNowFloat();
388  if (delay >= 600.0)
389  delay_ms = 600000;
390  else if (delay > 0.0)
391  delay_ms = (long) ceil(delay * 1000.0);
392  else
393  break;
394 
395  (void) WaitLatch(MyLatch,
397  delay_ms,
400  }
401 
402  PG_RETURN_VOID();
403 }
#define PG_GETARG_FLOAT8(n)
Definition: fmgr.h:281
#define WL_TIMEOUT
Definition: latch.h:127
void ResetLatch(Latch *latch)
Definition: latch.c:588
int WaitLatch(Latch *latch, int wakeEvents, long timeout, uint32 wait_event_info)
Definition: latch.c:390
#define GetNowFloat()
double float8
Definition: c.h:498
#define PG_RETURN_VOID()
Definition: fmgr.h:348
struct Latch * MyLatch
Definition: globals.c:54
#define CHECK_FOR_INTERRUPTS()
Definition: miscadmin.h:99
#define WL_LATCH_SET
Definition: latch.h:124
#define WL_EXIT_ON_PM_DEATH
Definition: latch.h:129

◆ pg_tablespace_databases()

Datum pg_tablespace_databases ( PG_FUNCTION_ARGS  )

Definition at line 199 of file misc.c.

References AllocateDir(), ReturnSetInfo::allowedModes, atooid, CreateTemplateTupleDesc(), directory_is_empty(), ReturnSetInfo::econtext, ExprContext::ecxt_per_query_memory, ereport, errcode(), errcode_for_file_access(), errmsg(), ERROR, FreeDir(), IsA, MemoryContextSwitchTo(), ObjectIdGetDatum, pfree(), PG_GETARG_OID, psprintf(), ReadDir(), ReturnSetInfo::returnMode, ReturnSetInfo::setDesc, ReturnSetInfo::setResult, SFRM_Materialize, SFRM_Materialize_Random, TABLESPACE_VERSION_DIRECTORY, TupleDescInitEntry(), tuplestore_begin_heap(), tuplestore_putvalues(), values, WARNING, and work_mem.

200 {
201  Oid tablespaceOid = PG_GETARG_OID(0);
202  ReturnSetInfo *rsinfo = (ReturnSetInfo *) fcinfo->resultinfo;
203  bool randomAccess;
204  TupleDesc tupdesc;
205  Tuplestorestate *tupstore;
206  char *location;
207  DIR *dirdesc;
208  struct dirent *de;
209  MemoryContext oldcontext;
210 
211  /* check to see if caller supports us returning a tuplestore */
212  if (rsinfo == NULL || !IsA(rsinfo, ReturnSetInfo))
213  ereport(ERROR,
214  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
215  errmsg("set-valued function called in context that cannot accept a set")));
216  if (!(rsinfo->allowedModes & SFRM_Materialize))
217  ereport(ERROR,
218  (errcode(ERRCODE_SYNTAX_ERROR),
219  errmsg("materialize mode required, but it is not allowed in this context")));
220 
221  /* The tupdesc and tuplestore must be created in ecxt_per_query_memory */
223 
224  tupdesc = CreateTemplateTupleDesc(1);
225  TupleDescInitEntry(tupdesc, (AttrNumber) 1, "pg_tablespace_databases",
226  OIDOID, -1, 0);
227 
228  randomAccess = (rsinfo->allowedModes & SFRM_Materialize_Random) != 0;
229  tupstore = tuplestore_begin_heap(randomAccess, false, work_mem);
230 
231  rsinfo->returnMode = SFRM_Materialize;
232  rsinfo->setResult = tupstore;
233  rsinfo->setDesc = tupdesc;
234 
235  MemoryContextSwitchTo(oldcontext);
236 
237  if (tablespaceOid == GLOBALTABLESPACE_OID)
238  {
240  (errmsg("global tablespace never has databases")));
241  /* return empty tuplestore */
242  return (Datum) 0;
243  }
244 
245  if (tablespaceOid == DEFAULTTABLESPACE_OID)
246  location = psprintf("base");
247  else
248  location = psprintf("pg_tblspc/%u/%s", tablespaceOid,
250 
251  dirdesc = AllocateDir(location);
252 
253  if (!dirdesc)
254  {
255  /* the only expected error is ENOENT */
256  if (errno != ENOENT)
257  ereport(ERROR,
259  errmsg("could not open directory \"%s\": %m",
260  location)));
262  (errmsg("%u is not a tablespace OID", tablespaceOid)));
263  /* return empty tuplestore */
264  return (Datum) 0;
265  }
266 
267  while ((de = ReadDir(dirdesc, location)) != NULL)
268  {
269  Oid datOid = atooid(de->d_name);
270  char *subdir;
271  bool isempty;
272  Datum values[1];
273  bool nulls[1];
274 
275  /* this test skips . and .., but is awfully weak */
276  if (!datOid)
277  continue;
278 
279  /* if database subdir is empty, don't report tablespace as used */
280 
281  subdir = psprintf("%s/%s", location, de->d_name);
282  isempty = directory_is_empty(subdir);
283  pfree(subdir);
284 
285  if (isempty)
286  continue; /* indeed, nothing in it */
287 
288  values[0] = ObjectIdGetDatum(datOid);
289  nulls[0] = false;
290 
291  tuplestore_putvalues(tupstore, tupdesc, values, nulls);
292  }
293 
294  FreeDir(dirdesc);
295  return (Datum) 0;
296 }
void tuplestore_putvalues(Tuplestorestate *state, TupleDesc tdesc, Datum *values, bool *isnull)
Definition: tuplestore.c:750
#define IsA(nodeptr, _type_)
Definition: nodes.h:580
TupleDesc CreateTemplateTupleDesc(int natts)
Definition: tupdesc.c:44
char * psprintf(const char *fmt,...)
Definition: psprintf.c:46
static MemoryContext MemoryContextSwitchTo(MemoryContext context)
Definition: palloc.h:109
int errcode(int sqlerrcode)
Definition: elog.c:610
bool directory_is_empty(const char *path)
Definition: tablespace.c:846
unsigned int Oid
Definition: postgres_ext.h:31
Definition: dirent.h:9
void pfree(void *pointer)
Definition: mcxt.c:1056
Definition: dirent.c:25
#define ObjectIdGetDatum(X)
Definition: postgres.h:507
#define ERROR
Definition: elog.h:43
#define TABLESPACE_VERSION_DIRECTORY
Definition: relpath.h:26
#define PG_GETARG_OID(n)
Definition: fmgr.h:275
int errcode_for_file_access(void)
Definition: elog.c:633
DIR * AllocateDir(const char *dirname)
Definition: fd.c:2583
void TupleDescInitEntry(TupleDesc desc, AttrNumber attributeNumber, const char *attributeName, Oid oidtypeid, int32 typmod, int attdim)
Definition: tupdesc.c:603
#define atooid(x)
Definition: postgres_ext.h:42
#define WARNING
Definition: elog.h:40
Tuplestorestate * tuplestore_begin_heap(bool randomAccess, bool interXact, int maxKBytes)
Definition: tuplestore.c:318
uintptr_t Datum
Definition: postgres.h:367
int work_mem
Definition: globals.c:121
#define ereport(elevel,...)
Definition: elog.h:144
int allowedModes
Definition: execnodes.h:305
SetFunctionReturnMode returnMode
Definition: execnodes.h:307
struct dirent * ReadDir(DIR *dir, const char *dirname)
Definition: fd.c:2649
MemoryContext ecxt_per_query_memory
Definition: execnodes.h:233
Tuplestorestate * setResult
Definition: execnodes.h:310
static Datum values[MAXATTR]
Definition: bootstrap.c:167
ExprContext * econtext
Definition: execnodes.h:303
TupleDesc setDesc
Definition: execnodes.h:311
int errmsg(const char *fmt,...)
Definition: elog.c:824
int16 AttrNumber
Definition: attnum.h:21
int FreeDir(DIR *dir)
Definition: fd.c:2701

◆ pg_tablespace_location()

Datum pg_tablespace_location ( PG_FUNCTION_ARGS  )

Definition at line 303 of file misc.c.

References cstring_to_text(), ereport, errcode(), errcode_for_file_access(), errmsg(), ERROR, InvalidOid, MAXPGPATH, MyDatabaseTableSpace, PG_GETARG_OID, PG_RETURN_NULL, PG_RETURN_TEXT_P, readlink, and snprintf.

304 {
305  Oid tablespaceOid = PG_GETARG_OID(0);
306  char sourcepath[MAXPGPATH];
307  char targetpath[MAXPGPATH];
308  int rllen;
309 
310  /*
311  * It's useful to apply this function to pg_class.reltablespace, wherein
312  * zero means "the database's default tablespace". So, rather than
313  * throwing an error for zero, we choose to assume that's what is meant.
314  */
315  if (tablespaceOid == InvalidOid)
316  tablespaceOid = MyDatabaseTableSpace;
317 
318  /*
319  * Return empty string for the cluster's default tablespaces
320  */
321  if (tablespaceOid == DEFAULTTABLESPACE_OID ||
322  tablespaceOid == GLOBALTABLESPACE_OID)
324 
325 #if defined(HAVE_READLINK) || defined(WIN32)
326 
327  /*
328  * Find the location of the tablespace by reading the symbolic link that
329  * is in pg_tblspc/<oid>.
330  */
331  snprintf(sourcepath, sizeof(sourcepath), "pg_tblspc/%u", tablespaceOid);
332 
333  rllen = readlink(sourcepath, targetpath, sizeof(targetpath));
334  if (rllen < 0)
335  ereport(ERROR,
337  errmsg("could not read symbolic link \"%s\": %m",
338  sourcepath)));
339  if (rllen >= sizeof(targetpath))
340  ereport(ERROR,
341  (errcode(ERRCODE_PROGRAM_LIMIT_EXCEEDED),
342  errmsg("symbolic link \"%s\" target is too long",
343  sourcepath)));
344  targetpath[rllen] = '\0';
345 
346  PG_RETURN_TEXT_P(cstring_to_text(targetpath));
347 #else
348  ereport(ERROR,
349  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
350  errmsg("tablespaces are not supported on this platform")));
351  PG_RETURN_NULL();
352 #endif
353 }
int errcode(int sqlerrcode)
Definition: elog.c:610
unsigned int Oid
Definition: postgres_ext.h:31
Oid MyDatabaseTableSpace
Definition: globals.c:87
#define ERROR
Definition: elog.h:43
#define MAXPGPATH
#define PG_GETARG_OID(n)
Definition: fmgr.h:275
#define readlink(path, buf, size)
Definition: win32_port.h:222
int errcode_for_file_access(void)
Definition: elog.c:633
#define InvalidOid
Definition: postgres_ext.h:36
#define ereport(elevel,...)
Definition: elog.h:144
#define PG_RETURN_TEXT_P(x)
Definition: fmgr.h:370
text * cstring_to_text(const char *s)
Definition: varlena.c:172
int errmsg(const char *fmt,...)
Definition: elog.c:824
#define snprintf
Definition: port.h:193
#define PG_RETURN_NULL()
Definition: fmgr.h:344

◆ pg_typeof()

Datum pg_typeof ( PG_FUNCTION_ARGS  )

Definition at line 481 of file misc.c.

References get_fn_expr_argtype(), and PG_RETURN_OID.

482 {
483  PG_RETURN_OID(get_fn_expr_argtype(fcinfo->flinfo, 0));
484 }
Oid get_fn_expr_argtype(FmgrInfo *flinfo, int argnum)
Definition: fmgr.c:1804
#define PG_RETURN_OID(x)
Definition: fmgr.h:359