test_custom_rmgrs.c File Reference

#include "postgres.h"
#include "access/xlog.h"
#include "access/xlog_internal.h"
#include "access/xloginsert.h"
#include "fmgr.h"
#include "utils/pg_lsn.h"
#include "varatt.h"

Include dependency graph for test_custom_rmgrs.c:

Go to the source code of this file.

Data Structures
struct	xl_testcustomrmgrs_message

Macros
#define	SizeOfTestCustomRmgrsMessage   (offsetof(xl_testcustomrmgrs_message, message))
#define	XLOG_TEST_CUSTOM_RMGRS_MESSAGE   0x00
#define	RM_TESTCUSTOMRMGRS_ID   RM_EXPERIMENTAL_ID
#define	TESTCUSTOMRMGRS_NAME   "test_custom_rmgrs"

Typedefs
typedef struct xl_testcustomrmgrs_message	xl_testcustomrmgrs_message

Functions
void	testcustomrmgrs_redo (XLogReaderState *record)
void	testcustomrmgrs_desc (StringInfo buf, XLogReaderState *record)
const char *	testcustomrmgrs_identify (uint8 info)
void	_PG_init (void)
	PG_FUNCTION_INFO_V1 (test_custom_rmgrs_insert_wal_record)
Datum	test_custom_rmgrs_insert_wal_record (PG_FUNCTION_ARGS)

Variables
	PG_MODULE_MAGIC
static const RmgrData	testcustomrmgrs_rmgr

Macro Definition Documentation

RM_TESTCUSTOMRMGRS_ID

#define RM_TESTCUSTOMRMGRS_ID   RM_EXPERIMENTAL_ID

Definition at line 47 of file test_custom_rmgrs.c.

SizeOfTestCustomRmgrsMessage

#define SizeOfTestCustomRmgrsMessage   (offsetof(xl_testcustomrmgrs_message, message))

Definition at line 38 of file test_custom_rmgrs.c.

TESTCUSTOMRMGRS_NAME

#define TESTCUSTOMRMGRS_NAME   "test_custom_rmgrs"

Definition at line 48 of file test_custom_rmgrs.c.

XLOG_TEST_CUSTOM_RMGRS_MESSAGE

#define XLOG_TEST_CUSTOM_RMGRS_MESSAGE   0x00

Definition at line 39 of file test_custom_rmgrs.c.

Typedef Documentation

xl_testcustomrmgrs_message

typedef struct xl_testcustomrmgrs_message xl_testcustomrmgrs_message

Function Documentation

_PG_init()

void _PG_init

(

void

)

Definition at line 66 of file test_custom_rmgrs.c.

{
    /*
     * In order to create our own custom resource manager, we have to be
     * loaded via shared_preload_libraries. Otherwise, registration will fail.
     */
    RegisterCustomRmgr(RM_TESTCUSTOMRMGRS_ID, &testcustomrmgrs_rmgr);
}

References RegisterCustomRmgr(), RM_TESTCUSTOMRMGRS_ID, and testcustomrmgrs_rmgr.

PG_FUNCTION_INFO_V1()

PG_FUNCTION_INFO_V1

(

test_custom_rmgrs_insert_wal_record

)

test_custom_rmgrs_insert_wal_record()

Datum test_custom_rmgrs_insert_wal_record

(

PG_FUNCTION_ARGS

)

Definition at line 120 of file test_custom_rmgrs.c.

{
    text       *arg = PG_GETARG_TEXT_PP(0);
    char       *payload = VARDATA_ANY(arg);
    Size        len = VARSIZE_ANY_EXHDR(arg);
    XLogRecPtr  lsn;
    xl_testcustomrmgrs_message xlrec;
 
    xlrec.message_size = len;
 
    XLogBeginInsert();
    XLogRegisterData((char *) &xlrec, SizeOfTestCustomRmgrsMessage);
    XLogRegisterData((char *) payload, len);
 
    /* Let's mark this record as unimportant, just in case. */
    XLogSetRecordFlags(XLOG_MARK_UNIMPORTANT);
 
    lsn = XLogInsert(RM_TESTCUSTOMRMGRS_ID, XLOG_TEST_CUSTOM_RMGRS_MESSAGE);
 
    PG_RETURN_LSN(lsn);
}

References arg, len, xl_testcustomrmgrs_message::message_size, PG_GETARG_TEXT_PP, PG_RETURN_LSN, RM_TESTCUSTOMRMGRS_ID, SizeOfTestCustomRmgrsMessage, VARDATA_ANY, VARSIZE_ANY_EXHDR, XLOG_MARK_UNIMPORTANT, XLOG_TEST_CUSTOM_RMGRS_MESSAGE, XLogBeginInsert(), XLogInsert(), XLogRegisterData(), and XLogSetRecordFlags().

testcustomrmgrs_desc()

void testcustomrmgrs_desc	(	StringInfo	buf,
		XLogReaderState *	record
	)

Definition at line 91 of file test_custom_rmgrs.c.

{
    char       *rec = XLogRecGetData(record);
    uint8       info = XLogRecGetInfo(record) & ~XLR_INFO_MASK;
 
    if (info == XLOG_TEST_CUSTOM_RMGRS_MESSAGE)
    {
        xl_testcustomrmgrs_message *xlrec = (xl_testcustomrmgrs_message *) rec;
 
        appendStringInfo(buf, "payload (%zu bytes): ", xlrec->message_size);
        appendBinaryStringInfo(buf, xlrec->message, xlrec->message_size);
    }
}

References appendBinaryStringInfo(), appendStringInfo(), buf, xl_testcustomrmgrs_message::message, xl_testcustomrmgrs_message::message_size, XLOG_TEST_CUSTOM_RMGRS_MESSAGE, XLogRecGetData, XLogRecGetInfo, and XLR_INFO_MASK.

testcustomrmgrs_identify()

const char * testcustomrmgrs_identify

(

uint8

info

)

Definition at line 106 of file test_custom_rmgrs.c.

{
    if ((info & ~XLR_INFO_MASK) == XLOG_TEST_CUSTOM_RMGRS_MESSAGE)
        return "TEST_CUSTOM_RMGRS_MESSAGE";
 
    return NULL;
}

References XLOG_TEST_CUSTOM_RMGRS_MESSAGE, and XLR_INFO_MASK.

testcustomrmgrs_redo()

void testcustomrmgrs_redo

(

XLogReaderState *

record

)

Definition at line 82 of file test_custom_rmgrs.c.

{
    uint8       info = XLogRecGetInfo(record) & ~XLR_INFO_MASK;
 
    if (info != XLOG_TEST_CUSTOM_RMGRS_MESSAGE)
        elog(PANIC, "testcustomrmgrs_redo: unknown op code %u", info);
}

References elog, PANIC, XLOG_TEST_CUSTOM_RMGRS_MESSAGE, XLogRecGetInfo, and XLR_INFO_MASK.

Variable Documentation

PG_MODULE_MAGIC

PG_MODULE_MAGIC

Definition at line 27 of file test_custom_rmgrs.c.

testcustomrmgrs_rmgr

const RmgrData testcustomrmgrs_rmgr

static

Initial value:

= {
    .rm_name = TESTCUSTOMRMGRS_NAME,
    .rm_redo = testcustomrmgrs_redo,
    .rm_desc = testcustomrmgrs_desc,
    .rm_identify = testcustomrmgrs_identify
}

Definition at line 55 of file test_custom_rmgrs.c.

Referenced by _PG_init().