98 lines
2.9 KiB
C
98 lines
2.9 KiB
C
/*-------------------------------------------------------------------------
|
|
*
|
|
* relpath.h
|
|
* Declarations for GetRelationPath() and friends
|
|
*
|
|
* Portions Copyright (c) 1996-2024, PostgreSQL Global Development Group
|
|
* Portions Copyright (c) 1994, Regents of the University of California
|
|
*
|
|
* src/include/common/relpath.h
|
|
*
|
|
*-------------------------------------------------------------------------
|
|
*/
|
|
#ifndef RELPATH_H
|
|
#define RELPATH_H
|
|
|
|
/*
|
|
* 'pgrminclude ignore' needed here because CppAsString2() does not throw
|
|
* an error if the symbol is not defined.
|
|
*/
|
|
#include "catalog/catversion.h" /* pgrminclude ignore */
|
|
|
|
/*
|
|
* RelFileNumber data type identifies the specific relation file name.
|
|
*/
|
|
typedef Oid RelFileNumber;
|
|
#define InvalidRelFileNumber ((RelFileNumber) InvalidOid)
|
|
#define RelFileNumberIsValid(relnumber) \
|
|
((bool) ((relnumber) != InvalidRelFileNumber))
|
|
|
|
/*
|
|
* Name of major-version-specific tablespace subdirectories
|
|
*/
|
|
#define TABLESPACE_VERSION_DIRECTORY "PG_" PG_MAJORVERSION "_" \
|
|
CppAsString2(CATALOG_VERSION_NO)
|
|
|
|
/* Characters to allow for an OID in a relation path */
|
|
#define OIDCHARS 10 /* max chars printed by %u */
|
|
|
|
/*
|
|
* Stuff for fork names.
|
|
*
|
|
* The physical storage of a relation consists of one or more forks.
|
|
* The main fork is always created, but in addition to that there can be
|
|
* additional forks for storing various metadata. ForkNumber is used when
|
|
* we need to refer to a specific fork in a relation.
|
|
*/
|
|
typedef enum ForkNumber
|
|
{
|
|
InvalidForkNumber = -1,
|
|
MAIN_FORKNUM = 0,
|
|
FSM_FORKNUM,
|
|
VISIBILITYMAP_FORKNUM,
|
|
INIT_FORKNUM,
|
|
|
|
/*
|
|
* NOTE: if you add a new fork, change MAX_FORKNUM and possibly
|
|
* FORKNAMECHARS below, and update the forkNames array in
|
|
* src/common/relpath.c
|
|
*/
|
|
} ForkNumber;
|
|
|
|
#define MAX_FORKNUM INIT_FORKNUM
|
|
|
|
#define FORKNAMECHARS 4 /* max chars for a fork name */
|
|
|
|
extern PGDLLIMPORT const char *const forkNames[];
|
|
|
|
extern ForkNumber forkname_to_number(const char *forkName);
|
|
extern int forkname_chars(const char *str, ForkNumber *fork);
|
|
|
|
/*
|
|
* Stuff for computing filesystem pathnames for relations.
|
|
*/
|
|
extern char *GetDatabasePath(Oid dbOid, Oid spcOid);
|
|
|
|
extern char *GetRelationPath(Oid dbOid, Oid spcOid, RelFileNumber relNumber,
|
|
int procNumber, ForkNumber forkNumber);
|
|
|
|
/*
|
|
* Wrapper macros for GetRelationPath. Beware of multiple
|
|
* evaluation of the RelFileLocator or RelFileLocatorBackend argument!
|
|
*/
|
|
|
|
/* First argument is a RelFileLocator */
|
|
#define relpathbackend(rlocator, backend, forknum) \
|
|
GetRelationPath((rlocator).dbOid, (rlocator).spcOid, (rlocator).relNumber, \
|
|
backend, forknum)
|
|
|
|
/* First argument is a RelFileLocator */
|
|
#define relpathperm(rlocator, forknum) \
|
|
relpathbackend(rlocator, INVALID_PROC_NUMBER, forknum)
|
|
|
|
/* First argument is a RelFileLocatorBackend */
|
|
#define relpath(rlocator, forknum) \
|
|
relpathbackend((rlocator).locator, (rlocator).backend, forknum)
|
|
|
|
#endif /* RELPATH_H */
|