file_ops.h File Reference

#include "filemap.h"

Include dependency graph for file_ops.h:

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

Go to the source code of this file.

Typedefs
typedef void(*	process_file_callback_t) (const char *path, file_type_t type, size_t size, const char *link_target)

Functions
void	open_target_file (const char *path, bool trunc)
void	write_target_range (char *buf, off_t begin, size_t size)
void	close_target_file (void)
void	remove_target_file (const char *path, bool missing_ok)
void	truncate_target_file (const char *path, off_t newsize)
void	create_target (file_entry_t *entry)
void	remove_target (file_entry_t *entry)
void	sync_target_dir (void)
char *	slurpFile (const char *datadir, const char *path, size_t *filesize)
void	traverse_datadir (const char *datadir, process_file_callback_t callback)

Typedef Documentation

process_file_callback_t

typedef void(* process_file_callback_t) (const char *path, file_type_t type, size_t size, const char *link_target)

Definition at line 26 of file file_ops.h.

Function Documentation

close_target_file()

void close_target_file ( void  )

extern

Definition at line 78 of file file_ops.c.

{
    if (dstfd == -1)
        return;
 
    if (close(dstfd) != 0)
        pg_fatal("could not close target file \"%s\": %m",
                 dstpath);
 
    dstfd = -1;
}

References close, dstfd, dstpath, and pg_fatal.

Referenced by createBackupLabel(), open_target_file(), and perform_rewind().

create_target()

void create_target ( file_entry_t *  entry )

extern

Definition at line 159 of file file_ops.c.

{
    Assert(entry->action == FILE_ACTION_CREATE);
    Assert(!entry->target_exists);
 
    switch (entry->source_type)
    {
        case FILE_TYPE_DIRECTORY:
            create_target_dir(entry->path);
            break;
 
        case FILE_TYPE_SYMLINK:
            create_target_symlink(entry->path, entry->source_link_target);
            break;
 
        case FILE_TYPE_REGULAR:
            /* can't happen. Regular files are created with open_target_file. */
            pg_fatal("invalid action (CREATE) for regular file");
            break;
 
        case FILE_TYPE_UNDEFINED:
            pg_fatal("undefined file type for \"%s\"", entry->path);
            break;
    }
}

References file_entry_t::action, Assert, create_target_dir(), create_target_symlink(), FILE_ACTION_CREATE, FILE_TYPE_DIRECTORY, FILE_TYPE_REGULAR, FILE_TYPE_SYMLINK, FILE_TYPE_UNDEFINED, file_entry_t::path, pg_fatal, file_entry_t::source_link_target, file_entry_t::source_type, and file_entry_t::target_exists.

Referenced by perform_rewind().

open_target_file()

void open_target_file ( const char *  path, bool  trunc  )

extern

Definition at line 47 of file file_ops.c.

{
    int         mode;
 
    if (!path_is_safe_for_extraction(path))
        pg_fatal("target file path is unsafe for open: \"%s\"", path);
 
    if (dry_run)
        return;
 
    if (dstfd != -1 && !trunc &&
        strcmp(path, &dstpath[strlen(datadir_target) + 1]) == 0)
        return;                 /* already open */
 
    close_target_file();
 
    snprintf(dstpath, sizeof(dstpath), "%s/%s", datadir_target, path);
 
    mode = O_WRONLY | O_CREAT | PG_BINARY;
    if (trunc)
        mode |= O_TRUNC;
    dstfd = open(dstpath, mode, pg_file_create_mode);
    if (dstfd < 0)
        pg_fatal("could not open target file \"%s\": %m",
                 dstpath);
}

References close_target_file(), datadir_target, dry_run, dstfd, dstpath, fb(), mode, path_is_safe_for_extraction(), PG_BINARY, pg_fatal, pg_file_create_mode, and snprintf.

Referenced by createBackupLabel(), libpq_queue_fetch_file(), local_queue_fetch_file(), local_queue_fetch_range(), and process_queued_fetch_requests().

remove_target()

void remove_target ( file_entry_t *  entry )

extern

Definition at line 133 of file file_ops.c.

{
    Assert(entry->action == FILE_ACTION_REMOVE);
    Assert(entry->target_exists);
 
    switch (entry->target_type)
    {
        case FILE_TYPE_DIRECTORY:
            remove_target_dir(entry->path);
            break;
 
        case FILE_TYPE_REGULAR:
            remove_target_file(entry->path, false);
            break;
 
        case FILE_TYPE_SYMLINK:
            remove_target_symlink(entry->path);
            break;
 
        case FILE_TYPE_UNDEFINED:
            pg_fatal("undefined file type for \"%s\"", entry->path);
            break;
    }
}

References file_entry_t::action, Assert, FILE_ACTION_REMOVE, FILE_TYPE_DIRECTORY, FILE_TYPE_REGULAR, FILE_TYPE_SYMLINK, FILE_TYPE_UNDEFINED, file_entry_t::path, pg_fatal, remove_target_dir(), remove_target_file(), remove_target_symlink(), file_entry_t::target_exists, and file_entry_t::target_type.

Referenced by perform_rewind().

remove_target_file()

void remove_target_file ( const char *  path, bool  missing_ok  )

extern

Definition at line 190 of file file_ops.c.

{
    char        dstpath[MAXPGPATH];
 
    if (!path_is_safe_for_extraction(path))
        pg_fatal("target file path is unsafe for removal: \"%s\"", path);
 
    if (dry_run)
        return;
 
    snprintf(dstpath, sizeof(dstpath), "%s/%s", datadir_target, path);
    if (unlink(dstpath) != 0)
    {
        if (errno == ENOENT && missing_ok)
            return;
 
        pg_fatal("could not remove file \"%s\": %m",
                 dstpath);
    }
}

References datadir_target, dry_run, dstpath, fb(), MAXPGPATH, path_is_safe_for_extraction(), pg_fatal, and snprintf.

Referenced by process_queued_fetch_requests(), and remove_target().

slurpFile()

char * slurpFile ( const char *  datadir, const char *  path, size_t *  filesize  )

extern

Definition at line 337 of file file_ops.c.

{
    int         fd;
    char       *buffer;
    struct stat statbuf;
    char        fullpath[MAXPGPATH];
    int         len;
    int         r;
 
    snprintf(fullpath, sizeof(fullpath), "%s/%s", datadir, path);
 
    if ((fd = open(fullpath, O_RDONLY | PG_BINARY, 0)) == -1)
        pg_fatal("could not open file \"%s\" for reading: %m",
                 fullpath);
 
    if (fstat(fd, &statbuf) < 0)
        pg_fatal("could not stat file \"%s\": %m",
                 fullpath);
 
    len = statbuf.st_size;
 
    buffer = pg_malloc(len + 1);
 
    r = read(fd, buffer, len);
    if (r != len)
    {
        if (r < 0)
            pg_fatal("could not read file \"%s\": %m",
                     fullpath);
        else
            pg_fatal("could not read file \"%s\": read %d of %zu",
                     fullpath, r, (Size) len);
    }
    close(fd);
 
    /* Zero-terminate the buffer. */
    buffer[len] = '\0';
 
    if (filesize)
        *filesize = len;
    return buffer;
}

References close, datadir, fb(), fd(), fstat, len, MAXPGPATH, PG_BINARY, pg_fatal, pg_malloc(), read, and snprintf.

Referenced by getTimelineHistory(), local_fetch_file(), and main().

sync_target_dir()

void sync_target_dir ( void  )

extern

Definition at line 317 of file file_ops.c.

{
    if (!do_sync || dry_run)
        return;
 
    sync_pgdata(datadir_target, PG_VERSION_NUM, sync_method, true);
}

References datadir_target, do_sync, dry_run, fb(), and sync_method.

Referenced by main().

traverse_datadir()

void traverse_datadir ( const char *  datadir, process_file_callback_t  callback  )

extern

Definition at line 385 of file file_ops.c.

{
    recurse_dir(datadir, NULL, callback);
}

References callback(), datadir, fb(), and recurse_dir().

Referenced by local_traverse_files(), and main().

truncate_target_file()

void truncate_target_file ( const char *  path, off_t  newsize  )

extern

Definition at line 212 of file file_ops.c.

{
    char        dstpath[MAXPGPATH];
    int         fd;
 
    if (!path_is_safe_for_extraction(path))
        pg_fatal("target file path is unsafe for truncation: \"%s\"", path);
 
    if (dry_run)
        return;
 
    snprintf(dstpath, sizeof(dstpath), "%s/%s", datadir_target, path);
 
    fd = open(dstpath, O_WRONLY, pg_file_create_mode);
    if (fd < 0)
        pg_fatal("could not open file \"%s\" for truncation: %m",
                 dstpath);
 
    if (ftruncate(fd, newsize) != 0)
        pg_fatal("could not truncate file \"%s\" to %u: %m",
                 dstpath, (unsigned int) newsize);
 
    close(fd);
}

References close, datadir_target, dry_run, dstpath, fb(), fd(), MAXPGPATH, path_is_safe_for_extraction(), pg_fatal, pg_file_create_mode, and snprintf.

Referenced by perform_rewind().

write_target_range()

void write_target_range ( char *  buf, off_t  begin, size_t  size  )

extern

Definition at line 91 of file file_ops.c.

{
    size_t      writeleft;
    char       *p;
 
    /* update progress report */
    fetch_done += size;
    progress_report(false);
 
    if (dry_run)
        return;
 
    if (lseek(dstfd, begin, SEEK_SET) == -1)
        pg_fatal("could not seek in target file \"%s\": %m",
                 dstpath);
 
    writeleft = size;
    p = buf;
    while (writeleft > 0)
    {
        ssize_t     writelen;
 
        errno = 0;
        writelen = write(dstfd, p, writeleft);
        if (writelen < 0)
        {
            /* if write didn't set errno, assume problem is no disk space */
            if (errno == 0)
                errno = ENOSPC;
            pg_fatal("could not write file \"%s\": %m",
                     dstpath);
        }
 
        p += writelen;
        writeleft -= writelen;
    }
 
    /* keep the file open, in case we need to copy more blocks in it */
}

References buf, dry_run, dstfd, dstpath, fb(), fetch_done, pg_fatal, progress_report(), and write.

Referenced by createBackupLabel(), local_queue_fetch_file(), local_queue_fetch_range(), and process_queued_fetch_requests().