bbstreamer_inject.c File Reference

#include "postgres_fe.h"
#include "bbstreamer.h"
#include "common/file_perm.h"
#include "common/logging.h"

Include dependency graph for bbstreamer_inject.c:

Go to the source code of this file.

Data Structures
struct	bbstreamer_recovery_injector

Typedefs
typedef struct bbstreamer_recovery_injector	bbstreamer_recovery_injector

Functions
static void	bbstreamer_recovery_injector_content (bbstreamer *streamer, bbstreamer_member *member, const char *data, int len, bbstreamer_archive_context context)
static void	bbstreamer_recovery_injector_finalize (bbstreamer *streamer)
static void	bbstreamer_recovery_injector_free (bbstreamer *streamer)
bbstreamer *	bbstreamer_recovery_injector_new (bbstreamer *next, bool is_recovery_guc_supported, PQExpBuffer recoveryconfcontents)
void	bbstreamer_inject_file (bbstreamer *streamer, char *pathname, char *data, int len)

Variables
const bbstreamer_ops	bbstreamer_recovery_injector_ops

Typedef Documentation

bbstreamer_recovery_injector

typedef struct bbstreamer_recovery_injector bbstreamer_recovery_injector

Function Documentation

bbstreamer_inject_file()

void bbstreamer_inject_file	(	bbstreamer *	streamer,
		char *	pathname,
		char *	data,
		int	len
	)

Definition at line 219 of file bbstreamer_inject.c.

{
    bbstreamer_member member;
 
    strlcpy(member.pathname, pathname, MAXPGPATH);
    member.size = len;
    member.mode = pg_file_create_mode;
    member.is_directory = false;
    member.is_link = false;
    member.linktarget[0] = '\0';
 
    /*
     * There seems to be no principled argument for these values, but they are
     * what PostgreSQL has historically used.
     */
    member.uid = 04000;
    member.gid = 02000;
 
    /*
     * We don't know here how to generate valid member headers and trailers
     * for the archiving format in use, so if those are needed, some successor
     * bbstreamer will have to generate them using the data from 'member'.
     */
    bbstreamer_content(streamer, &member, NULL, 0,
                       BBSTREAMER_MEMBER_HEADER);
    bbstreamer_content(streamer, &member, data, len,
                       BBSTREAMER_MEMBER_CONTENTS);
    bbstreamer_content(streamer, &member, NULL, 0,
                       BBSTREAMER_MEMBER_TRAILER);
}

References bbstreamer_content(), BBSTREAMER_MEMBER_CONTENTS, BBSTREAMER_MEMBER_HEADER, BBSTREAMER_MEMBER_TRAILER, data, bbstreamer_member::gid, bbstreamer_member::is_directory, bbstreamer_member::is_link, len, bbstreamer_member::linktarget, MAXPGPATH, bbstreamer_member::mode, bbstreamer_member::pathname, pg_file_create_mode, bbstreamer_member::size, strlcpy(), and bbstreamer_member::uid.

Referenced by bbstreamer_recovery_injector_content(), ReceiveArchiveStream(), and ReceiveTarFile().

bbstreamer_recovery_injector_content()

static void bbstreamer_recovery_injector_content ( bbstreamer *  streamer, bbstreamer_member *  member, const char *  data, int  len, bbstreamer_archive_context  context  )

static

Definition at line 85 of file bbstreamer_inject.c.

{
    bbstreamer_recovery_injector *mystreamer;
 
    mystreamer = (bbstreamer_recovery_injector *) streamer;
    Assert(member != NULL || context == BBSTREAMER_ARCHIVE_TRAILER);
 
    switch (context)
    {
        case BBSTREAMER_MEMBER_HEADER:
            /* Must copy provided data so we have the option to modify it. */
            memcpy(&mystreamer->member, member, sizeof(bbstreamer_member));
 
            /*
             * On v12+, skip standby.signal and edit postgresql.auto.conf; on
             * older versions, skip recovery.conf.
             */
            if (mystreamer->is_recovery_guc_supported)
            {
                mystreamer->skip_file =
                    (strcmp(member->pathname, "standby.signal") == 0);
                mystreamer->is_postgresql_auto_conf =
                    (strcmp(member->pathname, "postgresql.auto.conf") == 0);
                if (mystreamer->is_postgresql_auto_conf)
                {
                    /* Remember we saw it so we don't add it again. */
                    mystreamer->found_postgresql_auto_conf = true;
 
                    /* Increment length by data to be injected. */
                    mystreamer->member.size +=
                        mystreamer->recoveryconfcontents->len;
 
                    /*
                     * Zap data and len because the archive header is no
                     * longer valid; some subsequent bbstreamer must
                     * regenerate it if it's necessary.
                     */
                    data = NULL;
                    len = 0;
                }
            }
            else
                mystreamer->skip_file =
                    (strcmp(member->pathname, "recovery.conf") == 0);
 
            /* Do not forward if the file is to be skipped. */
            if (mystreamer->skip_file)
                return;
            break;
 
        case BBSTREAMER_MEMBER_CONTENTS:
            /* Do not forward if the file is to be skipped. */
            if (mystreamer->skip_file)
                return;
            break;
 
        case BBSTREAMER_MEMBER_TRAILER:
            /* Do not forward it the file is to be skipped. */
            if (mystreamer->skip_file)
                return;
 
            /* Append provided content to whatever we already sent. */
            if (mystreamer->is_postgresql_auto_conf)
                bbstreamer_content(mystreamer->base.bbs_next, member,
                                   mystreamer->recoveryconfcontents->data,
                                   mystreamer->recoveryconfcontents->len,
                                   BBSTREAMER_MEMBER_CONTENTS);
            break;
 
        case BBSTREAMER_ARCHIVE_TRAILER:
            if (mystreamer->is_recovery_guc_supported)
            {
                /*
                 * If we didn't already find (and thus modify)
                 * postgresql.auto.conf, inject it as an additional archive
                 * member now.
                 */
                if (!mystreamer->found_postgresql_auto_conf)
                    bbstreamer_inject_file(mystreamer->base.bbs_next,
                                           "postgresql.auto.conf",
                                           mystreamer->recoveryconfcontents->data,
                                           mystreamer->recoveryconfcontents->len);
 
                /* Inject empty standby.signal file. */
                bbstreamer_inject_file(mystreamer->base.bbs_next,
                                       "standby.signal", "", 0);
            }
            else
            {
                /* Inject recovery.conf file with specified contents. */
                bbstreamer_inject_file(mystreamer->base.bbs_next,
                                       "recovery.conf",
                                       mystreamer->recoveryconfcontents->data,
                                       mystreamer->recoveryconfcontents->len);
            }
 
            /* Nothing to do here. */
            break;
 
        default:
            /* Shouldn't happen. */
            pg_fatal("unexpected state while injecting recovery settings");
    }
 
    bbstreamer_content(mystreamer->base.bbs_next, &mystreamer->member,
                       data, len, context);
}

References Assert(), bbstreamer_recovery_injector::base, bbstreamer::bbs_next, BBSTREAMER_ARCHIVE_TRAILER, bbstreamer_content(), bbstreamer_inject_file(), BBSTREAMER_MEMBER_CONTENTS, BBSTREAMER_MEMBER_HEADER, BBSTREAMER_MEMBER_TRAILER, PQExpBufferData::data, data, bbstreamer_recovery_injector::found_postgresql_auto_conf, bbstreamer_recovery_injector::is_postgresql_auto_conf, bbstreamer_recovery_injector::is_recovery_guc_supported, PQExpBufferData::len, len, bbstreamer_recovery_injector::member, bbstreamer_member::pathname, pg_fatal, bbstreamer_recovery_injector::recoveryconfcontents, bbstreamer_member::size, and bbstreamer_recovery_injector::skip_file.

bbstreamer_recovery_injector_finalize()

static void bbstreamer_recovery_injector_finalize ( bbstreamer *  streamer )

static

Definition at line 200 of file bbstreamer_inject.c.

{
    bbstreamer_finalize(streamer->bbs_next);
}

References bbstreamer::bbs_next, and bbstreamer_finalize().

bbstreamer_recovery_injector_free()

static void bbstreamer_recovery_injector_free ( bbstreamer *  streamer )

static

Definition at line 209 of file bbstreamer_inject.c.

{
    bbstreamer_free(streamer->bbs_next);
    pfree(streamer);
}

References bbstreamer::bbs_next, bbstreamer_free(), and pfree().

bbstreamer_recovery_injector_new()

bbstreamer* bbstreamer_recovery_injector_new	(	bbstreamer *	next,
		bool	is_recovery_guc_supported,
		PQExpBuffer	recoveryconfcontents
	)

Definition at line 65 of file bbstreamer_inject.c.

{
    bbstreamer_recovery_injector *streamer;
 
    streamer = palloc0(sizeof(bbstreamer_recovery_injector));
    *((const bbstreamer_ops **) &streamer->base.bbs_ops) =
        &bbstreamer_recovery_injector_ops;
    streamer->base.bbs_next = next;
    streamer->is_recovery_guc_supported = is_recovery_guc_supported;
    streamer->recoveryconfcontents = recoveryconfcontents;
 
    return &streamer->base;
}

References bbstreamer_recovery_injector::base, bbstreamer::bbs_next, bbstreamer::bbs_ops, bbstreamer_recovery_injector_ops, bbstreamer_recovery_injector::is_recovery_guc_supported, next, palloc0(), bbstreamer_recovery_injector::recoveryconfcontents, and recoveryconfcontents.

Referenced by CreateBackupStreamer().

Variable Documentation

bbstreamer_recovery_injector_ops

const bbstreamer_ops bbstreamer_recovery_injector_ops

Initial value:

= {
    .content = bbstreamer_recovery_injector_content,
    .finalize = bbstreamer_recovery_injector_finalize,
    .free = bbstreamer_recovery_injector_free
}

Definition at line 36 of file bbstreamer_inject.c.

Referenced by bbstreamer_recovery_injector_new().