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	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(rnode, backend, forknum)
#define	relpathperm(rnode, forknum)   relpathbackend(rnode, InvalidBackendId, forknum)
#define	relpath(rnode, forknum)   relpathbackend((rnode).node, (rnode).backend, forknum)

Typedefs
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 dbNode, Oid spcNode)
char *	GetRelationPath (Oid dbNode, Oid spcNode, Oid relNode, int backendId, ForkNumber forkNumber)

Variables
const char *const	forkNames []

Macro Definition Documentation

FORKNAMECHARS

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

Definition at line 57 of file relpath.h.

Referenced by CreateTableSpace().

MAX_FORKNUM

#define MAX_FORKNUM   INIT_FORKNUM

Definition at line 55 of file relpath.h.

Referenced by autoprewarm_database_main(), calculate_indexes_size(), calculate_table_size(), calculate_toast_table_size(), DropRelationFiles(), forkname_chars(), forkname_to_number(), heapam_relation_copy_data(), index_copy_data(), mdopen(), mdunlink(), RelationTruncate(), smgr_redo(), smgrclose(), smgrdounlink(), smgrdounlinkall(), and table_block_relation_size().

OIDCHARS

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

Definition at line 30 of file relpath.h.

Referenced by CreateTableSpace(), parse_filename_for_nontemp_relation(), ResetUnloggedRelationsInDbspaceDir(), and sendDir().

relpath

#define relpath	(		rnode,
			forknum
	)		relpathbackend((rnode).node, (rnode).backend, forknum)

Definition at line 87 of file relpath.h.

Referenced by _mdfd_segpath(), do_pg_start_backup(), GetNewRelFileNode(), mdcreate(), mdextend(), mdopenfork(), mdtruncate(), mdunlinkfork(), process_file(), and ReadBuffer_common().

relpathbackend

#define relpathbackend	(		rnode,
			backend,
			forknum
	)

Value:

GetRelationPath((rnode).dbNode, (rnode).spcNode, (rnode).relNode, \
                    backend, forknum)

Definition at line 78 of file relpath.h.

Referenced by calculate_relation_size(), DropDatabaseBuffers(), DropRelFileNodeAllLocalBuffers(), DropRelFileNodeLocalBuffers(), local_buffer_write_error_callback(), pg_relation_filepath(), PrintBufferLeakWarning(), and RelationCopyStorage().

relpathperm

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

Definition at line 83 of file relpath.h.

Referenced by AbortBufferIO(), datasegpath(), DropDatabaseBuffers(), forget_invalid_pages(), forget_invalid_pages_db(), mdunlinkfiletag(), ReorderBufferCommit(), report_invalid_page(), shared_buffer_write_error_callback(), smgr_desc(), and xact_desc_relations().

TABLESPACE_VERSION_DIRECTORY

#define TABLESPACE_VERSION_DIRECTORY

Value:

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

Definition at line 26 of file relpath.h.

Referenced by calculate_database_size(), calculate_tablespace_size(), create_tablespace_directories(), CreateTableSpace(), destroy_tablespace_directories(), GetDatabasePath(), GetRelationPath(), isRelDataFile(), pg_tablespace_databases(), RelationCacheInitFileRemove(), RemovePgTempFiles(), ResetUnloggedRelations(), sendDir(), sendTablespace(), and TempTablespacePath().

Typedef Documentation

ForkNumber

typedef enum ForkNumber ForkNumber

Enumeration Type Documentation

ForkNumber

enum ForkNumber

Enumerator
InvalidForkNumber
MAIN_FORKNUM
FSM_FORKNUM
VISIBILITYMAP_FORKNUM
INIT_FORKNUM

Definition at line 40 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 78 of file relpath.c.

References forkNames, InvalidForkNumber, and MAX_FORKNUM.

Referenced by looks_like_temp_rel_name(), and parse_filename_for_nontemp_relation().

{
    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;
}

forkname_to_number()

ForkNumber forkname_to_number

(

const char *

forkName

)

Definition at line 47 of file relpath.c.

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

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

{
    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;
}

GetDatabasePath()

char* GetDatabasePath	(	Oid	dbNode,
		Oid	spcNode
	)

Definition at line 107 of file relpath.c.

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

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

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

GetRelationPath()

char* GetRelationPath	(	Oid	dbNode,
		Oid	spcNode,
		Oid	relNode,
		int	backendId,
		ForkNumber	forkNumber
	)

Definition at line 138 of file relpath.c.

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

{
    char       *path;

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

Variable Documentation

forkNames

const char* const forkNames[]

Definition at line 33 of file relpath.c.

Referenced by forkname_chars(), forkname_to_number(), GetRelationPath(), ResetUnloggedRelationsInDbspaceDir(), and XLogDumpDisplayRecord().