rmgr.h File Reference

#include "access/rmgrlist.h"

Include dependency graph for rmgr.h:

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

Go to the source code of this file.

Macros
#define	PG_RMGR(symname, name, redo, desc, identify, startup, cleanup, mask, decode)    symname,
#define	RM_MAX_ID   UINT8_MAX
#define	RM_MAX_BUILTIN_ID   (RM_NEXT_ID - 1)
#define	RM_MIN_CUSTOM_ID   128
#define	RM_MAX_CUSTOM_ID   UINT8_MAX
#define	RM_N_IDS   (UINT8_MAX + 1)
#define	RM_N_BUILTIN_IDS   (RM_MAX_BUILTIN_ID + 1)
#define	RM_N_CUSTOM_IDS   (RM_MAX_CUSTOM_ID - RM_MIN_CUSTOM_ID + 1)
#define	RmgrIdIsValid(rmid)   (RmgrIdIsBuiltin((rmid)) || RmgrIdIsCustom((rmid)))
#define	RM_EXPERIMENTAL_ID   128

Typedefs
typedef uint8	RmgrId
typedef enum RmgrIds	RmgrIds

Enumerations
enum	RmgrIds { RM_NEXT_ID }

Functions
static bool	RmgrIdIsBuiltin (int rmid)
static bool	RmgrIdIsCustom (int rmid)

Macro Definition Documentation

PG_RMGR

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

Definition at line 22 of file rmgr.h.

{
#include "access/rmgrlist.h"
    RM_NEXT_ID
}           RmgrIds;
 
#undef PG_RMGR
 
#define RM_MAX_ID           UINT8_MAX
#define RM_MAX_BUILTIN_ID   (RM_NEXT_ID - 1)
#define RM_MIN_CUSTOM_ID    128
#define RM_MAX_CUSTOM_ID    UINT8_MAX
#define RM_N_IDS            (UINT8_MAX + 1)
#define RM_N_BUILTIN_IDS    (RM_MAX_BUILTIN_ID + 1)
#define RM_N_CUSTOM_IDS     (RM_MAX_CUSTOM_ID - RM_MIN_CUSTOM_ID + 1)
 
static inline bool
RmgrIdIsBuiltin(int rmid)
{
    return rmid <= RM_MAX_BUILTIN_ID;
}
 
static inline bool
RmgrIdIsCustom(int rmid)
{
    return rmid >= RM_MIN_CUSTOM_ID && rmid <= RM_MAX_CUSTOM_ID;
}
 
#define RmgrIdIsValid(rmid) (RmgrIdIsBuiltin((rmid)) || RmgrIdIsCustom((rmid)))
 
/*
 * RmgrId to use for extensions that require an RmgrId, but are still in
 * development and have not reserved their own unique RmgrId yet. See:
 * https://wiki.postgresql.org/wiki/CustomWALResourceManagers
 */
#define RM_EXPERIMENTAL_ID      128
 
#endif                          /* RMGR_H */

RM_EXPERIMENTAL_ID

#define RM_EXPERIMENTAL_ID   128

Definition at line 60 of file rmgr.h.

RM_MAX_BUILTIN_ID

#define RM_MAX_BUILTIN_ID   (RM_NEXT_ID - 1)

Definition at line 34 of file rmgr.h.

RM_MAX_CUSTOM_ID

#define RM_MAX_CUSTOM_ID   UINT8_MAX

Definition at line 36 of file rmgr.h.

RM_MAX_ID

#define RM_MAX_ID   UINT8_MAX

Definition at line 33 of file rmgr.h.

RM_MIN_CUSTOM_ID

#define RM_MIN_CUSTOM_ID   128

Definition at line 35 of file rmgr.h.

RM_N_BUILTIN_IDS

#define RM_N_BUILTIN_IDS   (RM_MAX_BUILTIN_ID + 1)

Definition at line 38 of file rmgr.h.

RM_N_CUSTOM_IDS

#define RM_N_CUSTOM_IDS   (RM_MAX_CUSTOM_ID - RM_MIN_CUSTOM_ID + 1)

Definition at line 39 of file rmgr.h.

RM_N_IDS

#define RM_N_IDS   (UINT8_MAX + 1)

Definition at line 37 of file rmgr.h.

RmgrIdIsValid

#define RmgrIdIsValid

(

rmid

)

(RmgrIdIsBuiltin((rmid)) || RmgrIdIsCustom((rmid)))

Definition at line 53 of file rmgr.h.

Typedef Documentation

RmgrId

typedef uint8 RmgrId

Definition at line 11 of file rmgr.h.

RmgrIds

typedef enum RmgrIds RmgrIds

Enumeration Type Documentation

RmgrIds

enum RmgrIds

Enumerator
RM_NEXT_ID

Definition at line 25 of file rmgr.h.

{
#include "access/rmgrlist.h"
    RM_NEXT_ID
}           RmgrIds;

Function Documentation

RmgrIdIsBuiltin()

static bool RmgrIdIsBuiltin ( int  rmid )

inlinestatic

Definition at line 42 of file rmgr.h.

{
    return rmid <= RM_MAX_BUILTIN_ID;
}

References RM_MAX_BUILTIN_ID.

Referenced by GetRmgrDesc(), and pg_get_wal_resource_managers().

RmgrIdIsCustom()

static bool RmgrIdIsCustom ( int  rmid )

inlinestatic

Definition at line 48 of file rmgr.h.

{
    return rmid >= RM_MIN_CUSTOM_ID && rmid <= RM_MAX_CUSTOM_ID;
}

References RM_MAX_CUSTOM_ID, and RM_MIN_CUSTOM_ID.

Referenced by main(), RegisterCustomRmgr(), and XLogDumpDisplayStats().