PostgreSQL Source Code  git master
All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
rmgr.c File Reference
#include "postgres.h"
#include "access/rmgr.h"
#include "access/xlog_internal.h"
#include "fmgr.h"
#include "funcapi.h"
#include "miscadmin.h"
#include "nodes/execnodes.h"
#include "utils/builtins.h"
#include "utils/fmgrprotos.h"
#include "utils/tuplestore.h"
#include "access/brin_xlog.h"
#include "access/clog.h"
#include "access/commit_ts.h"
#include "access/generic_xlog.h"
#include "access/ginxlog.h"
#include "access/gistxlog.h"
#include "access/hash_xlog.h"
#include "access/heapam_xlog.h"
#include "access/multixact.h"
#include "access/nbtxlog.h"
#include "access/spgxlog.h"
#include "access/xact.h"
#include "catalog/storage_xlog.h"
#include "commands/dbcommands_xlog.h"
#include "commands/sequence.h"
#include "commands/tablespace.h"
#include "replication/decode.h"
#include "replication/message.h"
#include "replication/origin.h"
#include "storage/standby.h"
#include "utils/relmapper.h"
#include "access/rmgrlist.h"
Include dependency graph for rmgr.c:

Go to the source code of this file.

Macros

#define PG_RMGR(symname, name, redo, desc, identify, startup, cleanup, mask, decode)    { name, redo, desc, identify, startup, cleanup, mask, decode },
 
#define PG_GET_RESOURCE_MANAGERS_COLS   3
 

Functions

void RmgrStartup (void)
 
void RmgrCleanup (void)
 
void RmgrNotFound (RmgrId rmid)
 
void RegisterCustomRmgr (RmgrId rmid, const RmgrData *rmgr)
 
Datum pg_get_wal_resource_managers (PG_FUNCTION_ARGS)
 

Variables

RmgrData RmgrTable [RM_MAX_ID+1]
 

Macro Definition Documentation

◆ PG_GET_RESOURCE_MANAGERS_COLS

#define PG_GET_RESOURCE_MANAGERS_COLS   3

◆ PG_RMGR

#define PG_RMGR (   symname,
  name,
  redo,
  desc,
  identify,
  startup,
  cleanup,
  mask,
  decode 
)     { name, redo, desc, identify, startup, cleanup, mask, decode },

Definition at line 47 of file rmgr.c.

Function Documentation

◆ pg_get_wal_resource_managers()

Datum pg_get_wal_resource_managers ( PG_FUNCTION_ARGS  )

Definition at line 150 of file rmgr.c.

151 {
152 #define PG_GET_RESOURCE_MANAGERS_COLS 3
153  ReturnSetInfo *rsinfo = (ReturnSetInfo *) fcinfo->resultinfo;
155  bool nulls[PG_GET_RESOURCE_MANAGERS_COLS] = {0};
156 
157  InitMaterializedSRF(fcinfo, 0);
158 
159  for (int rmid = 0; rmid <= RM_MAX_ID; rmid++)
160  {
161  if (!RmgrIdExists(rmid))
162  continue;
163  values[0] = Int32GetDatum(rmid);
164  values[1] = CStringGetTextDatum(GetRmgr(rmid).rm_name);
165  values[2] = BoolGetDatum(RmgrIdIsBuiltin(rmid));
166  tuplestore_putvalues(rsinfo->setResult, rsinfo->setDesc, values, nulls);
167  }
168 
169  return (Datum) 0;
170 }
static Datum values[MAXATTR]
Definition: bootstrap.c:151
#define CStringGetTextDatum(s)
Definition: builtins.h:97
void InitMaterializedSRF(FunctionCallInfo fcinfo, bits32 flags)
Definition: funcapi.c:76
uintptr_t Datum
Definition: postgres.h:64
static Datum BoolGetDatum(bool X)
Definition: postgres.h:102
static Datum Int32GetDatum(int32 X)
Definition: postgres.h:212
#define PG_GET_RESOURCE_MANAGERS_COLS
#define RM_MAX_ID
Definition: rmgr.h:33
static bool RmgrIdIsBuiltin(int rmid)
Definition: rmgr.h:42
void tuplestore_putvalues(Tuplestorestate *state, TupleDesc tdesc, const Datum *values, const bool *isnull)
Definition: tuplestore.c:784
static RmgrData GetRmgr(RmgrId rmid)
static bool RmgrIdExists(RmgrId rmid)

References PG_GET_RESOURCE_MANAGERS_COLS, and values.

◆ RegisterCustomRmgr()

void RegisterCustomRmgr ( RmgrId  rmid,
const RmgrData rmgr 
)

Definition at line 107 of file rmgr.c.

108 {
109  if (rmgr->rm_name == NULL || strlen(rmgr->rm_name) == 0)
110  ereport(ERROR, (errmsg("custom resource manager name is invalid"),
111  errhint("Provide a non-empty name for the custom resource manager.")));
112 
113  if (!RmgrIdIsCustom(rmid))
114  ereport(ERROR, (errmsg("custom resource manager ID %d is out of range", rmid),
115  errhint("Provide a custom resource manager ID between %d and %d.",
117 
119  ereport(ERROR,
120  (errmsg("failed to register custom resource manager \"%s\" with ID %d", rmgr->rm_name, rmid),
121  errdetail("Custom resource manager must be registered while initializing modules in \"shared_preload_libraries\".")));
122 
123  if (RmgrTable[rmid].rm_name != NULL)
124  ereport(ERROR,
125  (errmsg("failed to register custom resource manager \"%s\" with ID %d", rmgr->rm_name, rmid),
126  errdetail("Custom resource manager \"%s\" already registered with the same ID.",
127  RmgrTable[rmid].rm_name)));
128 
129  /* check for existing rmgr with the same name */
130  for (int existing_rmid = 0; existing_rmid <= RM_MAX_ID; existing_rmid++)
131  {
132  if (!RmgrIdExists(existing_rmid))
133  continue;
134 
135  if (!pg_strcasecmp(RmgrTable[existing_rmid].rm_name, rmgr->rm_name))
136  ereport(ERROR,
137  (errmsg("failed to register custom resource manager \"%s\" with ID %d", rmgr->rm_name, rmid),
138  errdetail("Existing resource manager with ID %d has the same name.", existing_rmid)));
139  }
140 
141  /* register it */
142  RmgrTable[rmid] = *rmgr;
143  ereport(LOG,
144  (errmsg("registered custom resource manager \"%s\" with ID %d",
145  rmgr->rm_name, rmid)));
146 }
int errdetail(const char *fmt,...)
Definition: elog.c:1203
int errhint(const char *fmt,...)
Definition: elog.c:1317
int errmsg(const char *fmt,...)
Definition: elog.c:1070
#define LOG
Definition: elog.h:31
#define ERROR
Definition: elog.h:39
#define ereport(elevel,...)
Definition: elog.h:149
bool process_shared_preload_libraries_in_progress
Definition: miscinit.c:1839
int pg_strcasecmp(const char *s1, const char *s2)
Definition: pgstrcasecmp.c:36
RmgrData RmgrTable[RM_MAX_ID+1]
Definition: rmgr.c:50
static bool RmgrIdIsCustom(int rmid)
Definition: rmgr.h:48
#define RM_MAX_CUSTOM_ID
Definition: rmgr.h:36
#define RM_MIN_CUSTOM_ID
Definition: rmgr.h:35
const char * rm_name

References ereport, errdetail(), errhint(), errmsg(), ERROR, LOG, pg_strcasecmp(), process_shared_preload_libraries_in_progress, RM_MAX_CUSTOM_ID, RM_MAX_ID, RM_MIN_CUSTOM_ID, RmgrData::rm_name, RmgrIdExists(), RmgrIdIsCustom(), and RmgrTable.

Referenced by _PG_init().

◆ RmgrCleanup()

void RmgrCleanup ( void  )

Definition at line 74 of file rmgr.c.

75 {
76  for (int rmid = 0; rmid <= RM_MAX_ID; rmid++)
77  {
78  if (!RmgrIdExists(rmid))
79  continue;
80 
81  if (RmgrTable[rmid].rm_cleanup != NULL)
82  RmgrTable[rmid].rm_cleanup();
83  }
84 }
void(* rm_cleanup)(void)

References RmgrData::rm_cleanup, RM_MAX_ID, RmgrIdExists(), and RmgrTable.

Referenced by PerformWalRecovery().

◆ RmgrNotFound()

void RmgrNotFound ( RmgrId  rmid)

Definition at line 91 of file rmgr.c.

92 {
93  ereport(ERROR, (errmsg("resource manager with ID %d not registered", rmid),
94  errhint("Include the extension module that implements this resource manager in \"shared_preload_libraries\".")));
95 }

References ereport, errhint(), errmsg(), and ERROR.

Referenced by GetRmgr().

◆ RmgrStartup()

void RmgrStartup ( void  )

Definition at line 58 of file rmgr.c.

59 {
60  for (int rmid = 0; rmid <= RM_MAX_ID; rmid++)
61  {
62  if (!RmgrIdExists(rmid))
63  continue;
64 
65  if (RmgrTable[rmid].rm_startup != NULL)
66  RmgrTable[rmid].rm_startup();
67  }
68 }
void(* rm_startup)(void)

References RM_MAX_ID, RmgrData::rm_startup, RmgrIdExists(), and RmgrTable.

Referenced by PerformWalRecovery().

Variable Documentation

◆ RmgrTable

RmgrData RmgrTable[RM_MAX_ID+1]
Initial value:
= {
}

Definition at line 50 of file rmgr.c.

Referenced by GetRmgr(), RegisterCustomRmgr(), RmgrCleanup(), RmgrIdExists(), and RmgrStartup().