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.

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

Typedefs
typedef Oid	RelFileNumber
typedef enum ForkNumber	ForkNumber

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)
char *	GetRelationPath (Oid dbOid, Oid spcOid, RelFileNumber relNumber, int backendId, ForkNumber forkNumber)

Variables
PGDLLIMPORT const char *const	forkNames []

Macro Definition Documentation

FORKNAMECHARS

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

Definition at line 64 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 62 of file relpath.h.

OIDCHARS

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

Definition at line 37 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 94 of file relpath.h.

relpathbackend

#define relpathbackend	(		rlocator,
			backend,
			forknum
	)

Value:

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

Definition at line 85 of file relpath.h.

relpathperm

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

Definition at line 90 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.

Enumeration Type Documentation

ForkNumber

enum ForkNumber

Enumerator
InvalidForkNumber
MAIN_FORKNUM
FSM_FORKNUM
VISIBILITYMAP_FORKNUM
INIT_FORKNUM

Definition at line 47 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
     */
} ForkNumber;

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 generate_unaccent_rules::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("pg_tblspc/%u/%s/%u",
                        spcOid, TABLESPACE_VERSION_DIRECTORY, dbOid);
    }
}

References Assert(), 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()

char* GetRelationPath	(	Oid	dbOid,
		Oid	spcOid,
		RelFileNumber	relNumber,
		int	backendId,
		ForkNumber	forkNumber
	)

Definition at line 141 of file relpath.c.

{
    char       *path;
 
    if (spcOid == GLOBALTABLESPACE_OID)
    {
        /* Shared system relations live in {datadir}/global */
        Assert(dbOid == 0);
        Assert(backendId == InvalidBackendId);
        if (forkNumber != MAIN_FORKNUM)
            path = psprintf("global/%u_%s",
                            relNumber, forkNames[forkNumber]);
        else
            path = psprintf("global/%u", relNumber);
    }
    else if (spcOid == DEFAULTTABLESPACE_OID)
    {
        /* The default tablespace is {datadir}/base */
        if (backendId == InvalidBackendId)
        {
            if (forkNumber != MAIN_FORKNUM)
                path = psprintf("base/%u/%u_%s",
                                dbOid, relNumber,
                                forkNames[forkNumber]);
            else
                path = psprintf("base/%u/%u",
                                dbOid, relNumber);
        }
        else
        {
            if (forkNumber != MAIN_FORKNUM)
                path = psprintf("base/%u/t%d_%u_%s",
                                dbOid, backendId, relNumber,
                                forkNames[forkNumber]);
            else
                path = psprintf("base/%u/t%d_%u",
                                dbOid, backendId, relNumber);
        }
    }
    else
    {
        /* All other tablespaces are accessed via symlinks */
        if (backendId == InvalidBackendId)
        {
            if (forkNumber != MAIN_FORKNUM)
                path = psprintf("pg_tblspc/%u/%s/%u/%u_%s",
                                spcOid, TABLESPACE_VERSION_DIRECTORY,
                                dbOid, relNumber,
                                forkNames[forkNumber]);
            else
                path = psprintf("pg_tblspc/%u/%s/%u/%u",
                                spcOid, TABLESPACE_VERSION_DIRECTORY,
                                dbOid, relNumber);
        }
        else
        {
            if (forkNumber != MAIN_FORKNUM)
                path = psprintf("pg_tblspc/%u/%s/%u/t%d_%u_%s",
                                spcOid, TABLESPACE_VERSION_DIRECTORY,
                                dbOid, backendId, relNumber,
                                forkNames[forkNumber]);
            else
                path = psprintf("pg_tblspc/%u/%s/%u/t%d_%u",
                                spcOid, TABLESPACE_VERSION_DIRECTORY,
                                dbOid, backendId, relNumber);
        }
    }
    return path;
}

References Assert(), forkNames, InvalidBackendId, MAIN_FORKNUM, psprintf(), and TABLESPACE_VERSION_DIRECTORY.

Variable Documentation

forkNames

PGDLLIMPORT const char* const forkNames[]

extern

Definition at line 33 of file relpath.c.

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