buffile.h File Reference

#include "storage/fileset.h"

Include dependency graph for buffile.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Typedefs
typedef struct BufFile	BufFile

Functions
BufFile *	BufFileCreateTemp (bool interXact)
void	BufFileClose (BufFile *file)
pg_nodiscard size_t	BufFileRead (BufFile *file, void *ptr, size_t size)
void	BufFileReadExact (BufFile *file, void *ptr, size_t size)
size_t	BufFileReadMaybeEOF (BufFile *file, void *ptr, size_t size, bool eofOK)
void	BufFileWrite (BufFile *file, const void *ptr, size_t size)
int	BufFileSeek (BufFile *file, int fileno, off_t offset, int whence)
void	BufFileTell (BufFile *file, int *fileno, off_t *offset)
int	BufFileSeekBlock (BufFile *file, int64 blknum)
int64	BufFileSize (BufFile *file)
int64	BufFileAppend (BufFile *target, BufFile *source)
BufFile *	BufFileCreateFileSet (FileSet *fileset, const char *name)
void	BufFileExportFileSet (BufFile *file)
BufFile *	BufFileOpenFileSet (FileSet *fileset, const char *name, int mode, bool missing_ok)
void	BufFileDeleteFileSet (FileSet *fileset, const char *name, bool missing_ok)
void	BufFileTruncateFileSet (BufFile *file, int fileno, off_t offset)

Typedef Documentation

BufFile

typedef struct BufFile BufFile

Definition at line 1 of file buffile.h.

Function Documentation

BufFileAppend()

int64 BufFileAppend	(	BufFile *	target,
		BufFile *	source
	)

Definition at line 902 of file buffile.c.

{
    int64       startBlock = (int64) target->numFiles * BUFFILE_SEG_SIZE;
    int         newNumFiles = target->numFiles + source->numFiles;
    int         i;
 
    Assert(source->readOnly);
    Assert(!source->dirty);
 
    if (target->resowner != source->resowner)
        elog(ERROR, "could not append BufFile with non-matching resource owner");
 
    target->files = (File *)
        repalloc(target->files, sizeof(File) * newNumFiles);
    for (i = target->numFiles; i < newNumFiles; i++)
        target->files[i] = source->files[i - target->numFiles];
    target->numFiles = newNumFiles;
 
    return startBlock;
}

References Assert, BUFFILE_SEG_SIZE, elog, ERROR, BufFile::files, i, BufFile::numFiles, repalloc(), BufFile::resowner, and source.

Referenced by LogicalTapeImport().

BufFileClose()

void BufFileClose

(

BufFile *

file

)

Definition at line 412 of file buffile.c.

{
    int         i;
 
    /* flush any unwritten data */
    BufFileFlush(file);
    /* close and delete the underlying file(s) */
    for (i = 0; i < file->numFiles; i++)
        FileClose(file->files[i]);
    /* release the buffer space */
    pfree(file->files);
    pfree(file);
}

References BufFileFlush(), FileClose(), BufFile::files, i, BufFile::numFiles, and pfree().

Referenced by ensure_last_message(), ExecHashJoinNewBatch(), ExecHashTableDestroy(), gistFreeBuildBuffers(), LogicalTapeSetClose(), SendBackupManifest(), stream_abort_internal(), stream_close_file(), sts_end_parallel_scan(), sts_end_write(), sts_parallel_scan_next(), subxact_info_read(), subxact_info_write(), tuplestore_clear(), and tuplestore_end().

BufFileCreateFileSet()

BufFile* BufFileCreateFileSet	(	FileSet *	fileset,
		const char *	name
	)

Definition at line 267 of file buffile.c.

{
    BufFile    *file;
 
    file = makeBufFileCommon(1);
    file->fileset = fileset;
    file->name = pstrdup(name);
    file->files = (File *) palloc(sizeof(File));
    file->files[0] = MakeNewFileSetSegment(file, 0);
    file->readOnly = false;
 
    return file;
}

References BufFile::files, BufFile::fileset, makeBufFileCommon(), MakeNewFileSetSegment(), BufFile::name, name, palloc(), pstrdup(), and BufFile::readOnly.

Referenced by LogicalTapeSetCreate(), stream_open_file(), sts_puttuple(), and subxact_info_write().

BufFileCreateTemp()

BufFile* BufFileCreateTemp

(

bool

interXact

)

Definition at line 193 of file buffile.c.

{
    BufFile    *file;
    File        pfile;
 
    /*
     * Ensure that temp tablespaces are set up for OpenTemporaryFile to use.
     * Possibly the caller will have done this already, but it seems useful to
     * double-check here.  Failure to do this at all would result in the temp
     * files always getting placed in the default tablespace, which is a
     * pretty hard-to-detect bug.  Callers may prefer to do it earlier if they
     * want to be sure that any required catalog access is done in some other
     * resource context.
     */
    PrepareTempTablespaces();
 
    pfile = OpenTemporaryFile(interXact);
    Assert(pfile >= 0);
 
    file = makeBufFile(pfile);
    file->isInterXact = interXact;
 
    return file;
}

References Assert, BufFile::isInterXact, makeBufFile(), OpenTemporaryFile(), and PrepareTempTablespaces().

Referenced by ExecHashJoinSaveTuple(), gistInitBuildBuffers(), InitializeBackupManifest(), LogicalTapeSetCreate(), and tuplestore_puttuple_common().

BufFileDeleteFileSet()

void BufFileDeleteFileSet	(	FileSet *	fileset,
		const char *	name,
		bool	missing_ok
	)

Definition at line 364 of file buffile.c.

{
    char        segment_name[MAXPGPATH];
    int         segment = 0;
    bool        found = false;
 
    /*
     * We don't know how many segments the file has.  We'll keep deleting
     * until we run out.  If we don't manage to find even an initial segment,
     * raise an error.
     */
    for (;;)
    {
        FileSetSegmentName(segment_name, name, segment);
        if (!FileSetDelete(fileset, segment_name, true))
            break;
        found = true;
        ++segment;
 
        CHECK_FOR_INTERRUPTS();
    }
 
    if (!found && !missing_ok)
        elog(ERROR, "could not delete unknown BufFile \"%s\"", name);
}

References CHECK_FOR_INTERRUPTS, elog, ERROR, FileSetDelete(), FileSetSegmentName(), MAXPGPATH, and name.

Referenced by stream_cleanup_files(), and subxact_info_write().

BufFileExportFileSet()

void BufFileExportFileSet

(

BufFile *

file

)

Definition at line 394 of file buffile.c.

{
    /* Must be a file belonging to a FileSet. */
    Assert(file->fileset != NULL);
 
    /* It's probably a bug if someone calls this twice. */
    Assert(!file->readOnly);
 
    BufFileFlush(file);
    file->readOnly = true;
}

References Assert, BufFileFlush(), BufFile::fileset, and BufFile::readOnly.

Referenced by LogicalTapeFreeze().

BufFileOpenFileSet()

BufFile* BufFileOpenFileSet	(	FileSet *	fileset,
		const char *	name,
		int	mode,
		bool	missing_ok
	)

Definition at line 291 of file buffile.c.

{
    BufFile    *file;
    char        segment_name[MAXPGPATH];
    Size        capacity = 16;
    File       *files;
    int         nfiles = 0;
 
    files = palloc(sizeof(File) * capacity);
 
    /*
     * We don't know how many segments there are, so we'll probe the
     * filesystem to find out.
     */
    for (;;)
    {
        /* See if we need to expand our file segment array. */
        if (nfiles + 1 > capacity)
        {
            capacity *= 2;
            files = repalloc(files, sizeof(File) * capacity);
        }
        /* Try to load a segment. */
        FileSetSegmentName(segment_name, name, nfiles);
        files[nfiles] = FileSetOpen(fileset, segment_name, mode);
        if (files[nfiles] <= 0)
            break;
        ++nfiles;
 
        CHECK_FOR_INTERRUPTS();
    }
 
    /*
     * If we didn't find any files at all, then no BufFile exists with this
     * name.
     */
    if (nfiles == 0)
    {
        /* free the memory */
        pfree(files);
 
        if (missing_ok)
            return NULL;
 
        ereport(ERROR,
                (errcode_for_file_access(),
                 errmsg("could not open temporary file \"%s\" from BufFile \"%s\": %m",
                        segment_name, name)));
    }
 
    file = makeBufFileCommon(nfiles);
    file->files = files;
    file->readOnly = (mode == O_RDONLY);
    file->fileset = fileset;
    file->name = pstrdup(name);
 
    return file;
}

References CHECK_FOR_INTERRUPTS, ereport, errcode_for_file_access(), errmsg(), ERROR, BufFile::files, BufFile::fileset, FileSetOpen(), FileSetSegmentName(), makeBufFileCommon(), MAXPGPATH, mode, BufFile::name, name, palloc(), pfree(), pstrdup(), BufFile::readOnly, and repalloc().

Referenced by apply_spooled_messages(), ensure_last_message(), LogicalTapeImport(), stream_abort_internal(), stream_open_file(), sts_parallel_scan_next(), subxact_info_read(), and subxact_info_write().

BufFileRead()

pg_nodiscard size_t BufFileRead	(	BufFile *	file,
		void *	ptr,
		size_t	size
	)

Definition at line 645 of file buffile.c.

{
    return BufFileReadCommon(file, ptr, size, false, false);
}

References BufFileReadCommon(), and size.

BufFileReadExact()

void BufFileReadExact	(	BufFile *	file,
		void *	ptr,
		size_t	size
	)

Definition at line 654 of file buffile.c.

{
    BufFileReadCommon(file, ptr, size, true, false);
}

References BufFileReadCommon(), and size.

Referenced by apply_spooled_messages(), ExecHashJoinGetSavedTuple(), ltsReadBlock(), ReadTempFileBlock(), readtup_heap(), SendBackupManifest(), sts_parallel_scan_next(), sts_read_tuple(), and subxact_info_read().

BufFileReadMaybeEOF()

size_t BufFileReadMaybeEOF	(	BufFile *	file,
		void *	ptr,
		size_t	size,
		bool	eofOK
	)

Definition at line 664 of file buffile.c.

{
    return BufFileReadCommon(file, ptr, size, true, eofOK);
}

References BufFileReadCommon(), and size.

Referenced by apply_spooled_messages(), ExecHashJoinGetSavedTuple(), and getlen().

BufFileSeek()

int BufFileSeek	(	BufFile *	file,
		int	fileno,
		off_t	offset,
		int	whence
	)

Definition at line 740 of file buffile.c.

{
    int         newFile;
    off_t       newOffset;
 
    switch (whence)
    {
        case SEEK_SET:
            if (fileno < 0)
                return EOF;
            newFile = fileno;
            newOffset = offset;
            break;
        case SEEK_CUR:
 
            /*
             * Relative seek considers only the signed offset, ignoring
             * fileno. Note that large offsets (> 1 GB) risk overflow in this
             * add, unless we have 64-bit off_t.
             */
            newFile = file->curFile;
            newOffset = (file->curOffset + file->pos) + offset;
            break;
        case SEEK_END:
 
            /*
             * The file size of the last file gives us the end offset of that
             * file.
             */
            newFile = file->numFiles - 1;
            newOffset = FileSize(file->files[file->numFiles - 1]);
            if (newOffset < 0)
                ereport(ERROR,
                        (errcode_for_file_access(),
                         errmsg("could not determine size of temporary file \"%s\" from BufFile \"%s\": %m",
                                FilePathName(file->files[file->numFiles - 1]),
                                file->name)));
            break;
        default:
            elog(ERROR, "invalid whence: %d", whence);
            return EOF;
    }
    while (newOffset < 0)
    {
        if (--newFile < 0)
            return EOF;
        newOffset += MAX_PHYSICAL_FILESIZE;
    }
    if (newFile == file->curFile &&
        newOffset >= file->curOffset &&
        newOffset <= file->curOffset + file->nbytes)
    {
        /*
         * Seek is to a point within existing buffer; we can just adjust
         * pos-within-buffer, without flushing buffer.  Note this is OK
         * whether reading or writing, but buffer remains dirty if we were
         * writing.
         */
        file->pos = (int) (newOffset - file->curOffset);
        return 0;
    }
    /* Otherwise, must reposition buffer, so flush any dirty data */
    BufFileFlush(file);
 
    /*
     * At this point and no sooner, check for seek past last segment. The
     * above flush could have created a new segment, so checking sooner would
     * not work (at least not with this code).
     */
 
    /* convert seek to "start of next seg" to "end of last seg" */
    if (newFile == file->numFiles && newOffset == 0)
    {
        newFile--;
        newOffset = MAX_PHYSICAL_FILESIZE;
    }
    while (newOffset > MAX_PHYSICAL_FILESIZE)
    {
        if (++newFile >= file->numFiles)
            return EOF;
        newOffset -= MAX_PHYSICAL_FILESIZE;
    }
    if (newFile >= file->numFiles)
        return EOF;
    /* Seek is OK! */
    file->curFile = newFile;
    file->curOffset = newOffset;
    file->pos = 0;
    file->nbytes = 0;
    return 0;
}

References BufFileFlush(), BufFile::curFile, BufFile::curOffset, elog, ereport, errcode_for_file_access(), errmsg(), ERROR, FilePathName(), BufFile::files, FileSize(), MAX_PHYSICAL_FILESIZE, BufFile::name, BufFile::nbytes, BufFile::numFiles, and BufFile::pos.

Referenced by BufFileSeekBlock(), ensure_last_message(), ExecHashJoinNewBatch(), SendBackupManifest(), stream_open_file(), tuplestore_copy_read_pointer(), tuplestore_gettuple(), tuplestore_puttuple_common(), tuplestore_rescan(), and tuplestore_select_read_pointer().

BufFileSeekBlock()

int BufFileSeekBlock	(	BufFile *	file,
		int64	blknum
	)

Definition at line 851 of file buffile.c.

{
    return BufFileSeek(file,
                       (int) (blknum / BUFFILE_SEG_SIZE),
                       (off_t) (blknum % BUFFILE_SEG_SIZE) * BLCKSZ,
                       SEEK_SET);
}

References BUFFILE_SEG_SIZE, and BufFileSeek().

Referenced by ltsReadBlock(), ltsWriteBlock(), ReadTempFileBlock(), sts_parallel_scan_next(), and WriteTempFileBlock().

BufFileSize()

int64 BufFileSize

(

BufFile *

file

)

Definition at line 866 of file buffile.c.

{
    int64       lastFileSize;
 
    /* Get the size of the last physical file. */
    lastFileSize = FileSize(file->files[file->numFiles - 1]);
    if (lastFileSize < 0)
        ereport(ERROR,
                (errcode_for_file_access(),
                 errmsg("could not determine size of temporary file \"%s\" from BufFile \"%s\": %m",
                        FilePathName(file->files[file->numFiles - 1]),
                        file->name)));
 
    return ((file->numFiles - 1) * (int64) MAX_PHYSICAL_FILESIZE) +
        lastFileSize;
}

References ereport, errcode_for_file_access(), errmsg(), ERROR, FilePathName(), BufFile::files, FileSize(), MAX_PHYSICAL_FILESIZE, BufFile::name, and BufFile::numFiles.

Referenced by LogicalTapeImport(), and tuplestore_space_used().

BufFileTell()

void BufFileTell	(	BufFile *	file,
		int *	fileno,
		off_t *	offset
	)

Definition at line 833 of file buffile.c.

{
    *fileno = file->curFile;
    *offset = file->curOffset + file->pos;
}

References BufFile::curFile, BufFile::curOffset, and BufFile::pos.

Referenced by apply_spooled_messages(), dumptuples(), ensure_last_message(), subxact_info_add(), tuplestore_copy_read_pointer(), tuplestore_gettuple(), tuplestore_puttuple_common(), and tuplestore_select_read_pointer().

BufFileTruncateFileSet()

void BufFileTruncateFileSet	(	BufFile *	file,
		int	fileno,
		off_t	offset
	)

Definition at line 928 of file buffile.c.

{
    int         numFiles = file->numFiles;
    int         newFile = fileno;
    off_t       newOffset = file->curOffset;
    char        segment_name[MAXPGPATH];
    int         i;
 
    /*
     * Loop over all the files up to the given fileno and remove the files
     * that are greater than the fileno and truncate the given file up to the
     * offset. Note that we also remove the given fileno if the offset is 0
     * provided it is not the first file in which we truncate it.
     */
    for (i = file->numFiles - 1; i >= fileno; i--)
    {
        if ((i != fileno || offset == 0) && i != 0)
        {
            FileSetSegmentName(segment_name, file->name, i);
            FileClose(file->files[i]);
            if (!FileSetDelete(file->fileset, segment_name, true))
                ereport(ERROR,
                        (errcode_for_file_access(),
                         errmsg("could not delete fileset \"%s\": %m",
                                segment_name)));
            numFiles--;
            newOffset = MAX_PHYSICAL_FILESIZE;
 
            /*
             * This is required to indicate that we have deleted the given
             * fileno.
             */
            if (i == fileno)
                newFile--;
        }
        else
        {
            if (FileTruncate(file->files[i], offset,
                             WAIT_EVENT_BUFFILE_TRUNCATE) < 0)
                ereport(ERROR,
                        (errcode_for_file_access(),
                         errmsg("could not truncate file \"%s\": %m",
                                FilePathName(file->files[i]))));
            newOffset = offset;
        }
    }
 
    file->numFiles = numFiles;
 
    /*
     * If the truncate point is within existing buffer then we can just adjust
     * pos within buffer.
     */
    if (newFile == file->curFile &&
        newOffset >= file->curOffset &&
        newOffset <= file->curOffset + file->nbytes)
    {
        /* No need to reset the current pos if the new pos is greater. */
        if (newOffset <= file->curOffset + file->pos)
            file->pos = (int) (newOffset - file->curOffset);
 
        /* Adjust the nbytes for the current buffer. */
        file->nbytes = (int) (newOffset - file->curOffset);
    }
    else if (newFile == file->curFile &&
             newOffset < file->curOffset)
    {
        /*
         * The truncate point is within the existing file but prior to the
         * current position, so we can forget the current buffer and reset the
         * current position.
         */
        file->curOffset = newOffset;
        file->pos = 0;
        file->nbytes = 0;
    }
    else if (newFile < file->curFile)
    {
        /*
         * The truncate point is prior to the current file, so need to reset
         * the current position accordingly.
         */
        file->curFile = newFile;
        file->curOffset = newOffset;
        file->pos = 0;
        file->nbytes = 0;
    }
    /* Nothing to do, if the truncate point is beyond current file. */
}

References BufFile::curFile, BufFile::curOffset, ereport, errcode_for_file_access(), errmsg(), ERROR, FileClose(), FilePathName(), BufFile::files, BufFile::fileset, FileSetDelete(), FileSetSegmentName(), FileTruncate(), i, MAX_PHYSICAL_FILESIZE, MAXPGPATH, BufFile::name, BufFile::nbytes, BufFile::numFiles, and BufFile::pos.

Referenced by stream_abort_internal().

BufFileWrite()

void BufFileWrite	(	BufFile *	file,
		const void *	ptr,
		size_t	size
	)

Definition at line 676 of file buffile.c.

{
    size_t      nthistime;
 
    Assert(!file->readOnly);
 
    while (size > 0)
    {
        if (file->pos >= BLCKSZ)
        {
            /* Buffer full, dump it out */
            if (file->dirty)
                BufFileDumpBuffer(file);
            else
            {
                /* Hmm, went directly from reading to writing? */
                file->curOffset += file->pos;
                file->pos = 0;
                file->nbytes = 0;
            }
        }
 
        nthistime = BLCKSZ - file->pos;
        if (nthistime > size)
            nthistime = size;
        Assert(nthistime > 0);
 
        memcpy(file->buffer.data + file->pos, ptr, nthistime);
 
        file->dirty = true;
        file->pos += nthistime;
        if (file->nbytes < file->pos)
            file->nbytes = file->pos;
        ptr = (const char *) ptr + nthistime;
        size -= nthistime;
    }
}

References Assert, BufFile::buffer, BufFileDumpBuffer(), BufFile::curOffset, PGAlignedBlock::data, BufFile::dirty, BufFile::nbytes, BufFile::pos, BufFile::readOnly, and size.

Referenced by AppendStringToManifest(), ExecHashJoinSaveTuple(), ltsWriteBlock(), stream_write_change(), sts_flush_chunk(), subxact_info_write(), WriteTempFileBlock(), and writetup_heap().