relpath.h File Reference

#include "catalog/catversion.h"

Include dependency graph for relpath.h:

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

Go to the source code of this file.

Data Structures
struct	RelPathStr

Macros
#define	InvalidRelFileNumber   ((RelFileNumber) InvalidOid)
#define	RelFileNumberIsValid(relnumber)    ((bool) ((relnumber) != InvalidRelFileNumber))
#define	TABLESPACE_VERSION_DIRECTORY
#define	PG_TBLSPC_DIR   "pg_tblspc"
#define	PG_TBLSPC_DIR_SLASH
#define	OIDCHARS   10 /* max chars printed by %u */
#define	MAX_FORKNUM   INIT_FORKNUM
#define	FORKNAMECHARS   4 /* max chars for a fork name */
#define	PROCNUMBER_CHARS   6
#define	REL_PATH_STR_MAXLEN
#define	relpathbackend(rlocator, backend, forknum)
#define	relpathperm(rlocator, forknum)    relpathbackend(rlocator, INVALID_PROC_NUMBER, forknum)
#define	relpath(rlocator, forknum)    relpathbackend((rlocator).locator, (rlocator).backend, forknum)

Typedefs
typedef Oid	RelFileNumber
typedef enum ForkNumber	ForkNumber
typedef struct RelPathStr	RelPathStr

Enumerations
enum	ForkNumber {   InvalidForkNumber = -1 , MAIN_FORKNUM = 0 , FSM_FORKNUM , VISIBILITYMAP_FORKNUM ,   INIT_FORKNUM }

Functions
ForkNumber	forkname_to_number (const char *forkName)
int	forkname_chars (const char *str, ForkNumber *fork)
char *	GetDatabasePath (Oid dbOid, Oid spcOid)
RelPathStr	GetRelationPath (Oid dbOid, Oid spcOid, RelFileNumber relNumber, int procNumber, ForkNumber forkNumber)

Variables
PGDLLIMPORT const char *const	forkNames []

Macro Definition Documentation

FORKNAMECHARS

#define FORKNAMECHARS   4 /* max chars for a fork name */

Definition at line 72 of file relpath.h.

InvalidRelFileNumber

#define InvalidRelFileNumber   ((RelFileNumber) InvalidOid)

Definition at line 26 of file relpath.h.

MAX_FORKNUM

#define MAX_FORKNUM   INIT_FORKNUM

Definition at line 70 of file relpath.h.

OIDCHARS

#define OIDCHARS   10 /* max chars printed by %u */

Definition at line 45 of file relpath.h.

PG_TBLSPC_DIR

#define PG_TBLSPC_DIR   "pg_tblspc"

Definition at line 41 of file relpath.h.

PG_TBLSPC_DIR_SLASH

#define PG_TBLSPC_DIR_SLASH

Value:

                                             "pg_tblspc/"   /* required for strings
                                             * comparisons */

Definition at line 42 of file relpath.h.

PROCNUMBER_CHARS

#define PROCNUMBER_CHARS   6

Definition at line 84 of file relpath.h.

REL_PATH_STR_MAXLEN

#define REL_PATH_STR_MAXLEN

Value:

    ( \
        sizeof(PG_TBLSPC_DIR) - 1 \
        + sizeof((char)'/') \
        + OIDCHARS /* spcOid */ \
        + sizeof((char)'/') \
        + sizeof(TABLESPACE_VERSION_DIRECTORY) - 1 \
        + sizeof((char)'/') \
        + OIDCHARS /* dbOid */ \
        + sizeof((char)'/') \
        + sizeof((char)'t') /* temporary table indicator */ \
        + PROCNUMBER_CHARS /* procNumber */ \
        + sizeof((char)'_') \
        + OIDCHARS /* relNumber */ \
        + sizeof((char)'_') \
        + FORKNAMECHARS /* forkNames[forkNumber] */ \
    )

Definition at line 96 of file relpath.h.

RelFileNumberIsValid

#define RelFileNumberIsValid

(

relnumber

)

((bool) ((relnumber) != InvalidRelFileNumber))

Definition at line 27 of file relpath.h.

relpath

#define relpath	(		rlocator,
			forknum
	)		relpathbackend((rlocator).locator, (rlocator).backend, forknum)

Definition at line 150 of file relpath.h.

relpathbackend

#define relpathbackend	(		rlocator,
			backend,
			forknum
	)

Value:

    GetRelationPath((rlocator).dbOid, (rlocator).spcOid, (rlocator).relNumber, \
                    backend, forknum)

Definition at line 141 of file relpath.h.

relpathperm

#define relpathperm	(		rlocator,
			forknum
	)		relpathbackend(rlocator, INVALID_PROC_NUMBER, forknum)

Definition at line 146 of file relpath.h.

TABLESPACE_VERSION_DIRECTORY

#define TABLESPACE_VERSION_DIRECTORY

Value:

                                    "PG_" PG_MAJORVERSION "_" \
                                    CppAsString2(CATALOG_VERSION_NO)

Definition at line 33 of file relpath.h.

Typedef Documentation

ForkNumber

typedef enum ForkNumber ForkNumber

RelFileNumber

typedef Oid RelFileNumber

Definition at line 25 of file relpath.h.

RelPathStr

typedef struct RelPathStr RelPathStr

Enumeration Type Documentation

ForkNumber

enum ForkNumber

Enumerator
InvalidForkNumber
MAIN_FORKNUM
FSM_FORKNUM
VISIBILITYMAP_FORKNUM
INIT_FORKNUM

Definition at line 55 of file relpath.h.

{
    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
     */

Function Documentation

forkname_chars()

int forkname_chars	(	const char *	str,
		ForkNumber *	fork
	)

Definition at line 81 of file relpath.c.

{
    ForkNumber  forkNum;
 
    for (forkNum = 1; forkNum <= MAX_FORKNUM; forkNum++)
    {
        int         len = strlen(forkNames[forkNum]);
 
        if (strncmp(forkNames[forkNum], str, len) == 0)
        {
            if (fork)
                *fork = forkNum;
            return len;
        }
    }
    if (fork)
        *fork = InvalidForkNumber;
    return 0;
}

References forkNames, InvalidForkNumber, len, MAX_FORKNUM, and str.

Referenced by looks_like_temp_rel_name(), and parse_filename_for_nontemp_relation().

forkname_to_number()

ForkNumber forkname_to_number

(

const char *

forkName

)

Definition at line 50 of file relpath.c.

{
    ForkNumber  forkNum;
 
    for (forkNum = 0; forkNum <= MAX_FORKNUM; forkNum++)
        if (strcmp(forkNames[forkNum], forkName) == 0)
            return forkNum;
 
#ifndef FRONTEND
    ereport(ERROR,
            (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
             errmsg("invalid fork name"),
             errhint("Valid fork names are \"main\", \"fsm\", "
                     "\"vm\", and \"init\".")));
#endif
 
    return InvalidForkNumber;
}

References ereport, errcode(), errhint(), errmsg(), ERROR, forkNames, InvalidForkNumber, and MAX_FORKNUM.

Referenced by get_raw_page_fork(), get_raw_page_fork_1_9(), main(), pg_prewarm(), and pg_relation_size().

GetDatabasePath()

char * GetDatabasePath	(	Oid	dbOid,
		Oid	spcOid
	)

Definition at line 110 of file relpath.c.

{
    if (spcOid == GLOBALTABLESPACE_OID)
    {
        /* Shared system relations live in {datadir}/global */
        Assert(dbOid == 0);
        return pstrdup("global");
    }
    else if (spcOid == DEFAULTTABLESPACE_OID)
    {
        /* The default tablespace is {datadir}/base */
        return psprintf("base/%u", dbOid);
    }
    else
    {
        /* All other tablespaces are accessed via symlinks */
        return psprintf("%s/%u/%s/%u",
                        PG_TBLSPC_DIR, spcOid,
                        TABLESPACE_VERSION_DIRECTORY, dbOid);
    }
}

References Assert(), PG_TBLSPC_DIR, psprintf(), pstrdup(), and TABLESPACE_VERSION_DIRECTORY.

Referenced by check_db_file_conflict(), CreateDatabaseUsingFileCopy(), CreateDatabaseUsingWalLog(), createdb(), dbase_redo(), InitPostgres(), movedb(), movedb_failure_callback(), ProcessCommittedInvalidationMessages(), relmap_redo(), remove_dbtablespaces(), and TablespaceCreateDbspace().

GetRelationPath()

RelPathStr GetRelationPath	(	Oid	dbOid,
		Oid	spcOid,
		RelFileNumber	relNumber,
		int	procNumber,
		ForkNumber	forkNumber
	)

Definition at line 143 of file relpath.c.

{
    RelPathStr  rp;
 
    if (spcOid == GLOBALTABLESPACE_OID)
    {
        /* Shared system relations live in {datadir}/global */
        Assert(dbOid == 0);
        Assert(procNumber == INVALID_PROC_NUMBER);
        if (forkNumber != MAIN_FORKNUM)
            sprintf(rp.str, "global/%u_%s",
                    relNumber, forkNames[forkNumber]);
        else
            sprintf(rp.str, "global/%u",
                    relNumber);
    }
    else if (spcOid == DEFAULTTABLESPACE_OID)
    {
        /* The default tablespace is {datadir}/base */
        if (procNumber == INVALID_PROC_NUMBER)
        {
            if (forkNumber != MAIN_FORKNUM)
            {
                sprintf(rp.str, "base/%u/%u_%s",
                        dbOid, relNumber,
                        forkNames[forkNumber]);
            }
            else
                sprintf(rp.str, "base/%u/%u",
                        dbOid, relNumber);
        }
        else
        {
            if (forkNumber != MAIN_FORKNUM)
                sprintf(rp.str, "base/%u/t%d_%u_%s",
                        dbOid, procNumber, relNumber,
                        forkNames[forkNumber]);
            else
                sprintf(rp.str, "base/%u/t%d_%u",
                        dbOid, procNumber, relNumber);
        }
    }
    else
    {
        /* All other tablespaces are accessed via symlinks */
        if (procNumber == INVALID_PROC_NUMBER)
        {
            if (forkNumber != MAIN_FORKNUM)
                sprintf(rp.str, "%s/%u/%s/%u/%u_%s",
                        PG_TBLSPC_DIR, spcOid,
                        TABLESPACE_VERSION_DIRECTORY,
                        dbOid, relNumber,
                        forkNames[forkNumber]);
            else
                sprintf(rp.str, "%s/%u/%s/%u/%u",
                        PG_TBLSPC_DIR, spcOid,
                        TABLESPACE_VERSION_DIRECTORY,
                        dbOid, relNumber);
        }
        else
        {
            if (forkNumber != MAIN_FORKNUM)
                sprintf(rp.str, "%s/%u/%s/%u/t%d_%u_%s",
                        PG_TBLSPC_DIR, spcOid,
                        TABLESPACE_VERSION_DIRECTORY,
                        dbOid, procNumber, relNumber,
                        forkNames[forkNumber]);
            else
                sprintf(rp.str, "%s/%u/%s/%u/t%d_%u",
                        PG_TBLSPC_DIR, spcOid,
                        TABLESPACE_VERSION_DIRECTORY,
                        dbOid, procNumber, relNumber);
        }
    }
 
    Assert(strnlen(rp.str, REL_PATH_STR_MAXLEN + 1) <= REL_PATH_STR_MAXLEN);
 
    return rp;
}

References Assert(), forkNames, INVALID_PROC_NUMBER, MAIN_FORKNUM, PG_TBLSPC_DIR, REL_PATH_STR_MAXLEN, sprintf, RelPathStr::str, strnlen(), and TABLESPACE_VERSION_DIRECTORY.

Referenced by GetIncrementalFilePath(), and test_relpath().

Variable Documentation

forkNames

PGDLLIMPORT const char* const forkNames[]

extern

Definition at line 33 of file relpath.c.

Referenced by dump_one_relation(), forkname_chars(), forkname_to_number(), GetRelationPath(), XLogRecGetBlockRefInfo(), and XLogRecordSaveFPWs().