PostgreSQL Source Code git master
genfile.c File Reference
#include "postgres.h"
#include <sys/file.h>
#include <sys/stat.h>
#include <unistd.h>
#include <dirent.h>
#include "access/htup_details.h"
#include "access/xlog_internal.h"
#include "catalog/pg_authid.h"
#include "catalog/pg_tablespace_d.h"
#include "catalog/pg_type.h"
#include "funcapi.h"
#include "mb/pg_wchar.h"
#include "miscadmin.h"
#include "postmaster/syslogger.h"
#include "replication/slot.h"
#include "storage/fd.h"
#include "utils/acl.h"
#include "utils/builtins.h"
#include "utils/memutils.h"
#include "utils/syscache.h"
#include "utils/timestamp.h"
Include dependency graph for genfile.c:

Go to the source code of this file.

Macros

#define MIN_READ_SIZE   4096
 

Functions

static char * convert_and_check_filename (text *arg)
 
static bytearead_binary_file (const char *filename, int64 seek_offset, int64 bytes_to_read, bool missing_ok)
 
static textread_text_file (const char *filename, int64 seek_offset, int64 bytes_to_read, bool missing_ok)
 
static textpg_read_file_common (text *filename_t, int64 seek_offset, int64 bytes_to_read, bool read_to_eof, bool missing_ok)
 
static byteapg_read_binary_file_common (text *filename_t, int64 seek_offset, int64 bytes_to_read, bool read_to_eof, bool missing_ok)
 
Datum pg_read_file_off_len (PG_FUNCTION_ARGS)
 
Datum pg_read_file_off_len_missing (PG_FUNCTION_ARGS)
 
Datum pg_read_file_all (PG_FUNCTION_ARGS)
 
Datum pg_read_file_all_missing (PG_FUNCTION_ARGS)
 
Datum pg_read_binary_file_off_len (PG_FUNCTION_ARGS)
 
Datum pg_read_binary_file_off_len_missing (PG_FUNCTION_ARGS)
 
Datum pg_read_binary_file_all (PG_FUNCTION_ARGS)
 
Datum pg_read_binary_file_all_missing (PG_FUNCTION_ARGS)
 
Datum pg_stat_file (PG_FUNCTION_ARGS)
 
Datum pg_stat_file_1arg (PG_FUNCTION_ARGS)
 
Datum pg_ls_dir (PG_FUNCTION_ARGS)
 
Datum pg_ls_dir_1arg (PG_FUNCTION_ARGS)
 
static Datum pg_ls_dir_files (FunctionCallInfo fcinfo, const char *dir, bool missing_ok)
 
Datum pg_ls_logdir (PG_FUNCTION_ARGS)
 
Datum pg_ls_waldir (PG_FUNCTION_ARGS)
 
static Datum pg_ls_tmpdir (FunctionCallInfo fcinfo, Oid tblspc)
 
Datum pg_ls_tmpdir_noargs (PG_FUNCTION_ARGS)
 
Datum pg_ls_tmpdir_1arg (PG_FUNCTION_ARGS)
 
Datum pg_ls_archive_statusdir (PG_FUNCTION_ARGS)
 
Datum pg_ls_summariesdir (PG_FUNCTION_ARGS)
 
Datum pg_ls_logicalsnapdir (PG_FUNCTION_ARGS)
 
Datum pg_ls_logicalmapdir (PG_FUNCTION_ARGS)
 
Datum pg_ls_replslotdir (PG_FUNCTION_ARGS)
 

Macro Definition Documentation

◆ MIN_READ_SIZE

#define MIN_READ_SIZE   4096

Function Documentation

◆ convert_and_check_filename()

static char * convert_and_check_filename ( text arg)
static

Definition at line 54 of file genfile.c.

55{
56 char *filename;
57
59 canonicalize_path(filename); /* filename can change length here */
60
61 /*
62 * Roles with privileges of the 'pg_read_server_files' role are allowed to
63 * access any files on the server as the PG user, so no need to do any
64 * further checks here.
65 */
66 if (has_privs_of_role(GetUserId(), ROLE_PG_READ_SERVER_FILES))
67 return filename;
68
69 /*
70 * User isn't a member of the pg_read_server_files role, so check if it's
71 * allowable
72 */
74 {
75 /*
76 * Allow absolute paths if within DataDir or Log_directory, even
77 * though Log_directory might be outside DataDir.
78 */
83 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
84 errmsg("absolute path not allowed")));
85 }
88 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
89 errmsg("path must be in or below the data directory")));
90
91 return filename;
92}
bool has_privs_of_role(Oid member, Oid role)
Definition: acl.c:5268
int errcode(int sqlerrcode)
Definition: elog.c:853
int errmsg(const char *fmt,...)
Definition: elog.c:1070
#define ERROR
Definition: elog.h:39
#define ereport(elevel,...)
Definition: elog.h:149
char * DataDir
Definition: globals.c:70
Oid GetUserId(void)
Definition: miscinit.c:517
void * arg
static char * filename
Definition: pg_dumpall.c:119
#define is_absolute_path(filename)
Definition: port.h:104
bool path_is_prefix_of_path(const char *path1, const char *path2)
Definition: path.c:637
bool path_is_relative_and_below_cwd(const char *path)
Definition: path.c:604
void canonicalize_path(char *path)
Definition: path.c:337
char * Log_directory
Definition: syslogger.c:73
char * text_to_cstring(const text *t)
Definition: varlena.c:217

References arg, canonicalize_path(), DataDir, ereport, errcode(), errmsg(), ERROR, filename, GetUserId(), has_privs_of_role(), is_absolute_path, Log_directory, path_is_prefix_of_path(), path_is_relative_and_below_cwd(), and text_to_cstring().

Referenced by pg_ls_dir(), pg_read_binary_file_common(), pg_read_file_common(), and pg_stat_file().

◆ pg_ls_archive_statusdir()

Datum pg_ls_archive_statusdir ( PG_FUNCTION_ARGS  )

Definition at line 687 of file genfile.c.

688{
689 return pg_ls_dir_files(fcinfo, XLOGDIR "/archive_status", true);
690}
static Datum pg_ls_dir_files(FunctionCallInfo fcinfo, const char *dir, bool missing_ok)
Definition: genfile.c:570
#define XLOGDIR

References pg_ls_dir_files(), and XLOGDIR.

◆ pg_ls_dir()

Datum pg_ls_dir ( PG_FUNCTION_ARGS  )

Definition at line 498 of file genfile.c.

499{
500 ReturnSetInfo *rsinfo = (ReturnSetInfo *) fcinfo->resultinfo;
501 char *location;
502 bool missing_ok = false;
503 bool include_dot_dirs = false;
504 DIR *dirdesc;
505 struct dirent *de;
506
508
509 /* check the optional arguments */
510 if (PG_NARGS() == 3)
511 {
512 if (!PG_ARGISNULL(1))
513 missing_ok = PG_GETARG_BOOL(1);
514 if (!PG_ARGISNULL(2))
515 include_dot_dirs = PG_GETARG_BOOL(2);
516 }
517
519
520 dirdesc = AllocateDir(location);
521 if (!dirdesc)
522 {
523 /* Return empty tuplestore if appropriate */
524 if (missing_ok && errno == ENOENT)
525 return (Datum) 0;
526 /* Otherwise, we can let ReadDir() throw the error */
527 }
528
529 while ((de = ReadDir(dirdesc, location)) != NULL)
530 {
531 Datum values[1];
532 bool nulls[1];
533
534 if (!include_dot_dirs &&
535 (strcmp(de->d_name, ".") == 0 ||
536 strcmp(de->d_name, "..") == 0))
537 continue;
538
539 values[0] = CStringGetTextDatum(de->d_name);
540 nulls[0] = false;
541
542 tuplestore_putvalues(rsinfo->setResult, rsinfo->setDesc,
543 values, nulls);
544 }
545
546 FreeDir(dirdesc);
547 return (Datum) 0;
548}
static Datum values[MAXATTR]
Definition: bootstrap.c:151
#define CStringGetTextDatum(s)
Definition: builtins.h:97
int FreeDir(DIR *dir)
Definition: fd.c:2983
DIR * AllocateDir(const char *dirname)
Definition: fd.c:2865
struct dirent * ReadDir(DIR *dir, const char *dirname)
Definition: fd.c:2931
#define PG_GETARG_TEXT_PP(n)
Definition: fmgr.h:309
#define PG_ARGISNULL(n)
Definition: fmgr.h:209
#define PG_NARGS()
Definition: fmgr.h:203
#define PG_GETARG_BOOL(n)
Definition: fmgr.h:274
void InitMaterializedSRF(FunctionCallInfo fcinfo, bits32 flags)
Definition: funcapi.c:76
#define MAT_SRF_USE_EXPECTED_DESC
Definition: funcapi.h:296
static char * convert_and_check_filename(text *arg)
Definition: genfile.c:54
uintptr_t Datum
Definition: postgres.h:69
Definition: dirent.c:26
TupleDesc setDesc
Definition: execnodes.h:358
Tuplestorestate * setResult
Definition: execnodes.h:357
Definition: dirent.h:10
void tuplestore_putvalues(Tuplestorestate *state, TupleDesc tdesc, const Datum *values, const bool *isnull)
Definition: tuplestore.c:784

References AllocateDir(), convert_and_check_filename(), CStringGetTextDatum, FreeDir(), InitMaterializedSRF(), MAT_SRF_USE_EXPECTED_DESC, PG_ARGISNULL, PG_GETARG_BOOL, PG_GETARG_TEXT_PP, PG_NARGS, ReadDir(), ReturnSetInfo::setDesc, ReturnSetInfo::setResult, tuplestore_putvalues(), and values.

Referenced by pg_ls_dir_1arg().

◆ pg_ls_dir_1arg()

Datum pg_ls_dir_1arg ( PG_FUNCTION_ARGS  )

Definition at line 558 of file genfile.c.

559{
560 return pg_ls_dir(fcinfo);
561}
Datum pg_ls_dir(PG_FUNCTION_ARGS)
Definition: genfile.c:498

References pg_ls_dir().

◆ pg_ls_dir_files()

static Datum pg_ls_dir_files ( FunctionCallInfo  fcinfo,
const char *  dir,
bool  missing_ok 
)
static

Definition at line 570 of file genfile.c.

571{
572 ReturnSetInfo *rsinfo = (ReturnSetInfo *) fcinfo->resultinfo;
573 DIR *dirdesc;
574 struct dirent *de;
575
576 InitMaterializedSRF(fcinfo, 0);
577
578 /*
579 * Now walk the directory. Note that we must do this within a single SRF
580 * call, not leave the directory open across multiple calls, since we
581 * can't count on the SRF being run to completion.
582 */
583 dirdesc = AllocateDir(dir);
584 if (!dirdesc)
585 {
586 /* Return empty tuplestore if appropriate */
587 if (missing_ok && errno == ENOENT)
588 return (Datum) 0;
589 /* Otherwise, we can let ReadDir() throw the error */
590 }
591
592 while ((de = ReadDir(dirdesc, dir)) != NULL)
593 {
594 Datum values[3];
595 bool nulls[3];
596 char path[MAXPGPATH * 2];
597 struct stat attrib;
598
599 /* Skip hidden files */
600 if (de->d_name[0] == '.')
601 continue;
602
603 /* Get the file info */
604 snprintf(path, sizeof(path), "%s/%s", dir, de->d_name);
605 if (stat(path, &attrib) < 0)
606 {
607 /* Ignore concurrently-deleted files, else complain */
608 if (errno == ENOENT)
609 continue;
612 errmsg("could not stat file \"%s\": %m", path)));
613 }
614
615 /* Ignore anything but regular files */
616 if (!S_ISREG(attrib.st_mode))
617 continue;
618
619 values[0] = CStringGetTextDatum(de->d_name);
620 values[1] = Int64GetDatum((int64) attrib.st_size);
621 values[2] = TimestampTzGetDatum(time_t_to_timestamptz(attrib.st_mtime));
622 memset(nulls, 0, sizeof(nulls));
623
624 tuplestore_putvalues(rsinfo->setResult, rsinfo->setDesc, values, nulls);
625 }
626
627 FreeDir(dirdesc);
628 return (Datum) 0;
629}
TimestampTz time_t_to_timestamptz(pg_time_t tm)
Definition: timestamp.c:1801
int64_t int64
Definition: c.h:485
int errcode_for_file_access(void)
Definition: elog.c:876
Datum Int64GetDatum(int64 X)
Definition: fmgr.c:1807
#define MAXPGPATH
#define snprintf
Definition: port.h:239
fmNodePtr resultinfo
Definition: fmgr.h:89
static Datum TimestampTzGetDatum(TimestampTz X)
Definition: timestamp.h:52
#define stat
Definition: win32_port.h:274
#define S_ISREG(m)
Definition: win32_port.h:318

References AllocateDir(), CStringGetTextDatum, ereport, errcode_for_file_access(), errmsg(), ERROR, FreeDir(), InitMaterializedSRF(), Int64GetDatum(), MAXPGPATH, ReadDir(), FunctionCallInfoBaseData::resultinfo, S_ISREG, ReturnSetInfo::setDesc, ReturnSetInfo::setResult, snprintf, stat::st_mode, stat::st_mtime, stat::st_size, stat, time_t_to_timestamptz(), TimestampTzGetDatum(), tuplestore_putvalues(), and values.

Referenced by pg_ls_archive_statusdir(), pg_ls_logdir(), pg_ls_logicalmapdir(), pg_ls_logicalsnapdir(), pg_ls_replslotdir(), pg_ls_summariesdir(), pg_ls_tmpdir(), and pg_ls_waldir().

◆ pg_ls_logdir()

Datum pg_ls_logdir ( PG_FUNCTION_ARGS  )

Definition at line 633 of file genfile.c.

634{
635 return pg_ls_dir_files(fcinfo, Log_directory, false);
636}

References Log_directory, and pg_ls_dir_files().

◆ pg_ls_logicalmapdir()

Datum pg_ls_logicalmapdir ( PG_FUNCTION_ARGS  )

Definition at line 716 of file genfile.c.

717{
718 return pg_ls_dir_files(fcinfo, PG_LOGICAL_MAPPINGS_DIR, false);
719}
#define PG_LOGICAL_MAPPINGS_DIR
Definition: reorderbuffer.h:23

References PG_LOGICAL_MAPPINGS_DIR, and pg_ls_dir_files().

◆ pg_ls_logicalsnapdir()

Datum pg_ls_logicalsnapdir ( PG_FUNCTION_ARGS  )

Definition at line 706 of file genfile.c.

707{
708 return pg_ls_dir_files(fcinfo, PG_LOGICAL_SNAPSHOTS_DIR, false);
709}
#define PG_LOGICAL_SNAPSHOTS_DIR
Definition: reorderbuffer.h:24

References PG_LOGICAL_SNAPSHOTS_DIR, and pg_ls_dir_files().

◆ pg_ls_replslotdir()

Datum pg_ls_replslotdir ( PG_FUNCTION_ARGS  )

Definition at line 726 of file genfile.c.

727{
728 text *slotname_t;
729 char path[MAXPGPATH];
730 char *slotname;
731
732 slotname_t = PG_GETARG_TEXT_PP(0);
733
734 slotname = text_to_cstring(slotname_t);
735
736 if (!SearchNamedReplicationSlot(slotname, true))
738 (errcode(ERRCODE_UNDEFINED_OBJECT),
739 errmsg("replication slot \"%s\" does not exist",
740 slotname)));
741
742 snprintf(path, sizeof(path), "%s/%s", PG_REPLSLOT_DIR, slotname);
743
744 return pg_ls_dir_files(fcinfo, path, false);
745}
ReplicationSlot * SearchNamedReplicationSlot(const char *name, bool need_lock)
Definition: slot.c:464
#define PG_REPLSLOT_DIR
Definition: slot.h:21
Definition: c.h:644

References ereport, errcode(), errmsg(), ERROR, MAXPGPATH, PG_GETARG_TEXT_PP, pg_ls_dir_files(), PG_REPLSLOT_DIR, SearchNamedReplicationSlot(), snprintf, and text_to_cstring().

◆ pg_ls_summariesdir()

Datum pg_ls_summariesdir ( PG_FUNCTION_ARGS  )

Definition at line 696 of file genfile.c.

697{
698 return pg_ls_dir_files(fcinfo, XLOGDIR "/summaries", true);
699}

References pg_ls_dir_files(), and XLOGDIR.

◆ pg_ls_tmpdir()

static Datum pg_ls_tmpdir ( FunctionCallInfo  fcinfo,
Oid  tblspc 
)
static

Definition at line 649 of file genfile.c.

650{
651 char path[MAXPGPATH];
652
653 if (!SearchSysCacheExists1(TABLESPACEOID, ObjectIdGetDatum(tblspc)))
655 (errcode(ERRCODE_UNDEFINED_OBJECT),
656 errmsg("tablespace with OID %u does not exist",
657 tblspc)));
658
659 TempTablespacePath(path, tblspc);
660 return pg_ls_dir_files(fcinfo, path, true);
661}
void TempTablespacePath(char *path, Oid tablespace)
Definition: fd.c:1778
static Datum ObjectIdGetDatum(Oid X)
Definition: postgres.h:257
#define SearchSysCacheExists1(cacheId, key1)
Definition: syscache.h:100

References ereport, errcode(), errmsg(), ERROR, MAXPGPATH, ObjectIdGetDatum(), pg_ls_dir_files(), SearchSysCacheExists1, and TempTablespacePath().

Referenced by pg_ls_tmpdir_1arg(), and pg_ls_tmpdir_noargs().

◆ pg_ls_tmpdir_1arg()

Datum pg_ls_tmpdir_1arg ( PG_FUNCTION_ARGS  )

Definition at line 678 of file genfile.c.

679{
680 return pg_ls_tmpdir(fcinfo, PG_GETARG_OID(0));
681}
#define PG_GETARG_OID(n)
Definition: fmgr.h:275
static Datum pg_ls_tmpdir(FunctionCallInfo fcinfo, Oid tblspc)
Definition: genfile.c:649

References PG_GETARG_OID, and pg_ls_tmpdir().

◆ pg_ls_tmpdir_noargs()

Datum pg_ls_tmpdir_noargs ( PG_FUNCTION_ARGS  )

Definition at line 668 of file genfile.c.

669{
670 return pg_ls_tmpdir(fcinfo, DEFAULTTABLESPACE_OID);
671}

References pg_ls_tmpdir().

◆ pg_ls_waldir()

Datum pg_ls_waldir ( PG_FUNCTION_ARGS  )

Definition at line 640 of file genfile.c.

641{
642 return pg_ls_dir_files(fcinfo, XLOGDIR, false);
643}

References pg_ls_dir_files(), and XLOGDIR.

◆ pg_read_binary_file_all()

Datum pg_read_binary_file_all ( PG_FUNCTION_ARGS  )

Definition at line 381 of file genfile.c.

382{
383 text *filename_t = PG_GETARG_TEXT_PP(0);
384 text *ret;
385
386 ret = pg_read_binary_file_common(filename_t, 0, -1, true, false);
387
388 if (!ret)
390
392}
#define PG_RETURN_BYTEA_P(x)
Definition: fmgr.h:371
#define PG_RETURN_NULL()
Definition: fmgr.h:345
static bytea * pg_read_binary_file_common(text *filename_t, int64 seek_offset, int64 bytes_to_read, bool read_to_eof, bool missing_ok)
Definition: genfile.c:260

References PG_GETARG_TEXT_PP, pg_read_binary_file_common(), PG_RETURN_BYTEA_P, and PG_RETURN_NULL.

◆ pg_read_binary_file_all_missing()

Datum pg_read_binary_file_all_missing ( PG_FUNCTION_ARGS  )

Definition at line 395 of file genfile.c.

396{
397 text *filename_t = PG_GETARG_TEXT_PP(0);
398 bool missing_ok = PG_GETARG_BOOL(1);
399 text *ret;
400
401 ret = pg_read_binary_file_common(filename_t, 0, -1, true, missing_ok);
402
403 if (!ret)
405
407}

References PG_GETARG_BOOL, PG_GETARG_TEXT_PP, pg_read_binary_file_common(), PG_RETURN_BYTEA_P, and PG_RETURN_NULL.

◆ pg_read_binary_file_common()

static bytea * pg_read_binary_file_common ( text filename_t,
int64  seek_offset,
int64  bytes_to_read,
bool  read_to_eof,
bool  missing_ok 
)
static

Definition at line 260 of file genfile.c.

263{
264 if (read_to_eof)
265 Assert(bytes_to_read == -1);
266 else if (bytes_to_read < 0)
268 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
269 errmsg("requested length cannot be negative")));
270
272 seek_offset, bytes_to_read, missing_ok);
273}
#define Assert(condition)
Definition: c.h:815
static bytea * read_binary_file(const char *filename, int64 seek_offset, int64 bytes_to_read, bool missing_ok)
Definition: genfile.c:103

References Assert, convert_and_check_filename(), ereport, errcode(), errmsg(), ERROR, and read_binary_file().

Referenced by pg_read_binary_file_all(), pg_read_binary_file_all_missing(), pg_read_binary_file_off_len(), and pg_read_binary_file_off_len_missing().

◆ pg_read_binary_file_off_len()

Datum pg_read_binary_file_off_len ( PG_FUNCTION_ARGS  )

Definition at line 348 of file genfile.c.

349{
350 text *filename_t = PG_GETARG_TEXT_PP(0);
351 int64 seek_offset = PG_GETARG_INT64(1);
352 int64 bytes_to_read = PG_GETARG_INT64(2);
353 text *ret;
354
355 ret = pg_read_binary_file_common(filename_t, seek_offset, bytes_to_read,
356 false, false);
357 if (!ret)
359
361}
#define PG_GETARG_INT64(n)
Definition: fmgr.h:283

References PG_GETARG_INT64, PG_GETARG_TEXT_PP, pg_read_binary_file_common(), PG_RETURN_BYTEA_P, and PG_RETURN_NULL.

◆ pg_read_binary_file_off_len_missing()

Datum pg_read_binary_file_off_len_missing ( PG_FUNCTION_ARGS  )

Definition at line 364 of file genfile.c.

365{
366 text *filename_t = PG_GETARG_TEXT_PP(0);
367 int64 seek_offset = PG_GETARG_INT64(1);
368 int64 bytes_to_read = PG_GETARG_INT64(2);
369 bool missing_ok = PG_GETARG_BOOL(3);
370 text *ret;
371
372 ret = pg_read_binary_file_common(filename_t, seek_offset, bytes_to_read,
373 false, missing_ok);
374 if (!ret)
376
378}

References PG_GETARG_BOOL, PG_GETARG_INT64, PG_GETARG_TEXT_PP, pg_read_binary_file_common(), PG_RETURN_BYTEA_P, and PG_RETURN_NULL.

◆ pg_read_file_all()

Datum pg_read_file_all ( PG_FUNCTION_ARGS  )

Definition at line 319 of file genfile.c.

320{
321 text *filename_t = PG_GETARG_TEXT_PP(0);
322 text *ret;
323
324 ret = pg_read_file_common(filename_t, 0, -1, true, false);
325
326 if (!ret)
328
329 PG_RETURN_TEXT_P(ret);
330}
#define PG_RETURN_TEXT_P(x)
Definition: fmgr.h:372
static text * pg_read_file_common(text *filename_t, int64 seek_offset, int64 bytes_to_read, bool read_to_eof, bool missing_ok)
Definition: genfile.c:240

References PG_GETARG_TEXT_PP, pg_read_file_common(), PG_RETURN_NULL, and PG_RETURN_TEXT_P.

◆ pg_read_file_all_missing()

Datum pg_read_file_all_missing ( PG_FUNCTION_ARGS  )

Definition at line 333 of file genfile.c.

334{
335 text *filename_t = PG_GETARG_TEXT_PP(0);
336 bool missing_ok = PG_GETARG_BOOL(1);
337 text *ret;
338
339 ret = pg_read_file_common(filename_t, 0, -1, true, missing_ok);
340
341 if (!ret)
343
344 PG_RETURN_TEXT_P(ret);
345}

References PG_GETARG_BOOL, PG_GETARG_TEXT_PP, pg_read_file_common(), PG_RETURN_NULL, and PG_RETURN_TEXT_P.

◆ pg_read_file_common()

static text * pg_read_file_common ( text filename_t,
int64  seek_offset,
int64  bytes_to_read,
bool  read_to_eof,
bool  missing_ok 
)
static

Definition at line 240 of file genfile.c.

242{
243 if (read_to_eof)
244 Assert(bytes_to_read == -1);
245 else if (bytes_to_read < 0)
247 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
248 errmsg("requested length cannot be negative")));
249
251 seek_offset, bytes_to_read, missing_ok);
252}
static text * read_text_file(const char *filename, int64 seek_offset, int64 bytes_to_read, bool missing_ok)
Definition: genfile.c:211

References Assert, convert_and_check_filename(), ereport, errcode(), errmsg(), ERROR, and read_text_file().

Referenced by pg_read_file_all(), pg_read_file_all_missing(), pg_read_file_off_len(), and pg_read_file_off_len_missing().

◆ pg_read_file_off_len()

Datum pg_read_file_off_len ( PG_FUNCTION_ARGS  )

Definition at line 285 of file genfile.c.

286{
287 text *filename_t = PG_GETARG_TEXT_PP(0);
288 int64 seek_offset = PG_GETARG_INT64(1);
289 int64 bytes_to_read = PG_GETARG_INT64(2);
290 text *ret;
291
292 ret = pg_read_file_common(filename_t, seek_offset, bytes_to_read,
293 false, false);
294 if (!ret)
296
297 PG_RETURN_TEXT_P(ret);
298}

References PG_GETARG_INT64, PG_GETARG_TEXT_PP, pg_read_file_common(), PG_RETURN_NULL, and PG_RETURN_TEXT_P.

◆ pg_read_file_off_len_missing()

Datum pg_read_file_off_len_missing ( PG_FUNCTION_ARGS  )

Definition at line 301 of file genfile.c.

302{
303 text *filename_t = PG_GETARG_TEXT_PP(0);
304 int64 seek_offset = PG_GETARG_INT64(1);
305 int64 bytes_to_read = PG_GETARG_INT64(2);
306 bool missing_ok = PG_GETARG_BOOL(3);
307 text *ret;
308
309 ret = pg_read_file_common(filename_t, seek_offset, bytes_to_read,
310 false, missing_ok);
311
312 if (!ret)
314
315 PG_RETURN_TEXT_P(ret);
316}

References PG_GETARG_BOOL, PG_GETARG_INT64, PG_GETARG_TEXT_PP, pg_read_file_common(), PG_RETURN_NULL, and PG_RETURN_TEXT_P.

◆ pg_stat_file()

Datum pg_stat_file ( PG_FUNCTION_ARGS  )

Definition at line 413 of file genfile.c.

414{
415 text *filename_t = PG_GETARG_TEXT_PP(0);
416 char *filename;
417 struct stat fst;
418 Datum values[6];
419 bool isnull[6];
420 HeapTuple tuple;
421 TupleDesc tupdesc;
422 bool missing_ok = false;
423
424 /* check the optional argument */
425 if (PG_NARGS() == 2)
426 missing_ok = PG_GETARG_BOOL(1);
427
429
430 if (stat(filename, &fst) < 0)
431 {
432 if (missing_ok && errno == ENOENT)
434 else
437 errmsg("could not stat file \"%s\": %m", filename)));
438 }
439
440 /*
441 * This record type had better match the output parameters declared for me
442 * in pg_proc.h.
443 */
444 tupdesc = CreateTemplateTupleDesc(6);
445 TupleDescInitEntry(tupdesc, (AttrNumber) 1,
446 "size", INT8OID, -1, 0);
447 TupleDescInitEntry(tupdesc, (AttrNumber) 2,
448 "access", TIMESTAMPTZOID, -1, 0);
449 TupleDescInitEntry(tupdesc, (AttrNumber) 3,
450 "modification", TIMESTAMPTZOID, -1, 0);
451 TupleDescInitEntry(tupdesc, (AttrNumber) 4,
452 "change", TIMESTAMPTZOID, -1, 0);
453 TupleDescInitEntry(tupdesc, (AttrNumber) 5,
454 "creation", TIMESTAMPTZOID, -1, 0);
455 TupleDescInitEntry(tupdesc, (AttrNumber) 6,
456 "isdir", BOOLOID, -1, 0);
457 BlessTupleDesc(tupdesc);
458
459 memset(isnull, false, sizeof(isnull));
460
461 values[0] = Int64GetDatum((int64) fst.st_size);
464 /* Unix has file status change time, while Win32 has creation time */
465#if !defined(WIN32) && !defined(__CYGWIN__)
467 isnull[4] = true;
468#else
469 isnull[3] = true;
471#endif
472 values[5] = BoolGetDatum(S_ISDIR(fst.st_mode));
473
474 tuple = heap_form_tuple(tupdesc, values, isnull);
475
477
479}
int16 AttrNumber
Definition: attnum.h:21
TupleDesc BlessTupleDesc(TupleDesc tupdesc)
Definition: execTuples.c:2258
#define PG_RETURN_DATUM(x)
Definition: fmgr.h:353
static Datum HeapTupleGetDatum(const HeapTupleData *tuple)
Definition: funcapi.h:230
HeapTuple heap_form_tuple(TupleDesc tupleDescriptor, const Datum *values, const bool *isnull)
Definition: heaptuple.c:1117
void pfree(void *pointer)
Definition: mcxt.c:1521
static Datum BoolGetDatum(bool X)
Definition: postgres.h:107
TupleDesc CreateTemplateTupleDesc(int natts)
Definition: tupdesc.c:164
void TupleDescInitEntry(TupleDesc desc, AttrNumber attributeNumber, const char *attributeName, Oid oidtypeid, int32 typmod, int attdim)
Definition: tupdesc.c:801
#define S_ISDIR(m)
Definition: win32_port.h:315

References BlessTupleDesc(), BoolGetDatum(), convert_and_check_filename(), CreateTemplateTupleDesc(), ereport, errcode_for_file_access(), errmsg(), ERROR, filename, heap_form_tuple(), HeapTupleGetDatum(), Int64GetDatum(), pfree(), PG_GETARG_BOOL, PG_GETARG_TEXT_PP, PG_NARGS, PG_RETURN_DATUM, PG_RETURN_NULL, S_ISDIR, stat::st_atime, stat::st_ctime, stat::st_mode, stat::st_mtime, stat::st_size, stat, time_t_to_timestamptz(), TimestampTzGetDatum(), TupleDescInitEntry(), and values.

Referenced by pg_stat_file_1arg().

◆ pg_stat_file_1arg()

Datum pg_stat_file_1arg ( PG_FUNCTION_ARGS  )

Definition at line 489 of file genfile.c.

490{
491 return pg_stat_file(fcinfo);
492}
Datum pg_stat_file(PG_FUNCTION_ARGS)
Definition: genfile.c:413

References pg_stat_file().

◆ read_binary_file()

static bytea * read_binary_file ( const char *  filename,
int64  seek_offset,
int64  bytes_to_read,
bool  missing_ok 
)
static

Definition at line 103 of file genfile.c.

105{
106 bytea *buf;
107 size_t nbytes = 0;
108 FILE *file;
109
110 /* clamp request size to what we can actually deliver */
111 if (bytes_to_read > (int64) (MaxAllocSize - VARHDRSZ))
113 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
114 errmsg("requested length too large")));
115
116 if ((file = AllocateFile(filename, PG_BINARY_R)) == NULL)
117 {
118 if (missing_ok && errno == ENOENT)
119 return NULL;
120 else
123 errmsg("could not open file \"%s\" for reading: %m",
124 filename)));
125 }
126
127 if (fseeko(file, (off_t) seek_offset,
128 (seek_offset >= 0) ? SEEK_SET : SEEK_END) != 0)
131 errmsg("could not seek in file \"%s\": %m", filename)));
132
133 if (bytes_to_read >= 0)
134 {
135 /* If passed explicit read size just do it */
136 buf = (bytea *) palloc((Size) bytes_to_read + VARHDRSZ);
137
138 nbytes = fread(VARDATA(buf), 1, (size_t) bytes_to_read, file);
139 }
140 else
141 {
142 /* Negative read size, read rest of file */
143 StringInfoData sbuf;
144
145 initStringInfo(&sbuf);
146 /* Leave room in the buffer for the varlena length word */
147 sbuf.len += VARHDRSZ;
148 Assert(sbuf.len < sbuf.maxlen);
149
150 while (!(feof(file) || ferror(file)))
151 {
152 size_t rbytes;
153
154 /* Minimum amount to read at a time */
155#define MIN_READ_SIZE 4096
156
157 /*
158 * If not at end of file, and sbuf.len is equal to MaxAllocSize -
159 * 1, then either the file is too large, or there is nothing left
160 * to read. Attempt to read one more byte to see if the end of
161 * file has been reached. If not, the file is too large; we'd
162 * rather give the error message for that ourselves.
163 */
164 if (sbuf.len == MaxAllocSize - 1)
165 {
166 char rbuf[1];
167
168 if (fread(rbuf, 1, 1, file) != 0 || !feof(file))
170 (errcode(ERRCODE_PROGRAM_LIMIT_EXCEEDED),
171 errmsg("file length too large")));
172 else
173 break;
174 }
175
176 /* OK, ensure that we can read at least MIN_READ_SIZE */
178
179 /*
180 * stringinfo.c likes to allocate in powers of 2, so it's likely
181 * that much more space is available than we asked for. Use all
182 * of it, rather than making more fread calls than necessary.
183 */
184 rbytes = fread(sbuf.data + sbuf.len, 1,
185 (size_t) (sbuf.maxlen - sbuf.len - 1), file);
186 sbuf.len += rbytes;
187 nbytes += rbytes;
188 }
189
190 /* Now we can commandeer the stringinfo's buffer as the result */
191 buf = (bytea *) sbuf.data;
192 }
193
194 if (ferror(file))
197 errmsg("could not read file \"%s\": %m", filename)));
198
199 SET_VARSIZE(buf, nbytes + VARHDRSZ);
200
201 FreeFile(file);
202
203 return buf;
204}
#define PG_BINARY_R
Definition: c.h:1232
#define VARHDRSZ
Definition: c.h:649
size_t Size
Definition: c.h:562
int FreeFile(FILE *file)
Definition: fd.c:2803
FILE * AllocateFile(const char *name, const char *mode)
Definition: fd.c:2605
#define MaxAllocSize
Definition: fe_memutils.h:22
#define MIN_READ_SIZE
void * palloc(Size size)
Definition: mcxt.c:1317
static char * buf
Definition: pg_test_fsync.c:72
void enlargeStringInfo(StringInfo str, int needed)
Definition: stringinfo.c:337
void initStringInfo(StringInfo str)
Definition: stringinfo.c:97
#define VARDATA(PTR)
Definition: varatt.h:278
#define SET_VARSIZE(PTR, len)
Definition: varatt.h:305
#define fseeko(stream, offset, origin)
Definition: win32_port.h:206

References AllocateFile(), Assert, buf, StringInfoData::data, enlargeStringInfo(), ereport, errcode(), errcode_for_file_access(), errmsg(), ERROR, filename, FreeFile(), fseeko, initStringInfo(), StringInfoData::len, MaxAllocSize, StringInfoData::maxlen, MIN_READ_SIZE, palloc(), PG_BINARY_R, SET_VARSIZE, VARDATA, and VARHDRSZ.

Referenced by pg_read_binary_file_common(), and read_text_file().

◆ read_text_file()

static text * read_text_file ( const char *  filename,
int64  seek_offset,
int64  bytes_to_read,
bool  missing_ok 
)
static

Definition at line 211 of file genfile.c.

213{
214 bytea *buf;
215
216 buf = read_binary_file(filename, seek_offset, bytes_to_read, missing_ok);
217
218 if (buf != NULL)
219 {
220 /* Make sure the input is valid */
222
223 /* OK, we can cast it to text safely */
224 return (text *) buf;
225 }
226 else
227 return NULL;
228}
bool pg_verifymbstr(const char *mbstr, int len, bool noError)
Definition: mbutils.c:1556
#define VARSIZE(PTR)
Definition: varatt.h:279

References buf, filename, pg_verifymbstr(), read_binary_file(), VARDATA, VARHDRSZ, and VARSIZE.

Referenced by pg_read_file_common().