tupdesc.c File Reference

#include "postgres.h"
#include "access/htup_details.h"
#include "access/toast_compression.h"
#include "access/tupdesc_details.h"
#include "catalog/catalog.h"
#include "catalog/pg_collation.h"
#include "catalog/pg_type.h"
#include "common/hashfn.h"
#include "utils/builtins.h"
#include "utils/datum.h"
#include "utils/resowner.h"
#include "utils/syscache.h"

Include dependency graph for tupdesc.c:

Go to the source code of this file.

Functions
static void	ResOwnerReleaseTupleDesc (Datum res)
static char *	ResOwnerPrintTupleDesc (Datum res)
static void	ResourceOwnerRememberTupleDesc (ResourceOwner owner, TupleDesc tupdesc)
static void	ResourceOwnerForgetTupleDesc (ResourceOwner owner, TupleDesc tupdesc)
static void	populate_compact_attribute_internal (Form_pg_attribute src, CompactAttribute *dst)
void	populate_compact_attribute (TupleDesc tupdesc, int attnum)
void	verify_compact_attribute (TupleDesc tupdesc, int attnum)
TupleDesc	CreateTemplateTupleDesc (int natts)
TupleDesc	CreateTupleDesc (int natts, Form_pg_attribute *attrs)
TupleDesc	CreateTupleDescCopy (TupleDesc tupdesc)
TupleDesc	CreateTupleDescTruncatedCopy (TupleDesc tupdesc, int natts)
TupleDesc	CreateTupleDescCopyConstr (TupleDesc tupdesc)
void	TupleDescCopy (TupleDesc dst, TupleDesc src)
void	TupleDescCopyEntry (TupleDesc dst, AttrNumber dstAttno, TupleDesc src, AttrNumber srcAttno)
void	FreeTupleDesc (TupleDesc tupdesc)
void	IncrTupleDescRefCount (TupleDesc tupdesc)
void	DecrTupleDescRefCount (TupleDesc tupdesc)
bool	equalTupleDescs (TupleDesc tupdesc1, TupleDesc tupdesc2)
bool	equalRowTypes (TupleDesc tupdesc1, TupleDesc tupdesc2)
uint32	hashRowType (TupleDesc desc)
void	TupleDescInitEntry (TupleDesc desc, AttrNumber attributeNumber, const char *attributeName, Oid oidtypeid, int32 typmod, int attdim)
void	TupleDescInitBuiltinEntry (TupleDesc desc, AttrNumber attributeNumber, const char *attributeName, Oid oidtypeid, int32 typmod, int attdim)
void	TupleDescInitEntryCollation (TupleDesc desc, AttrNumber attributeNumber, Oid collationid)
TupleDesc	BuildDescFromLists (const List *names, const List *types, const List *typmods, const List *collations)
Node *	TupleDescGetDefault (TupleDesc tupdesc, AttrNumber attnum)

Variables
static const ResourceOwnerDesc	tupdesc_resowner_desc

Function Documentation

BuildDescFromLists()

TupleDesc BuildDescFromLists	(	const List *	names,
		const List *	types,
		const List *	typmods,
		const List *	collations
	)

Definition at line 1044 of file tupdesc.c.

{
    int         natts;
    AttrNumber  attnum;
    ListCell   *l1;
    ListCell   *l2;
    ListCell   *l3;
    ListCell   *l4;
    TupleDesc   desc;
 
    natts = list_length(names);
    Assert(natts == list_length(types));
    Assert(natts == list_length(typmods));
    Assert(natts == list_length(collations));
 
    /*
     * allocate a new tuple descriptor
     */
    desc = CreateTemplateTupleDesc(natts);
 
    attnum = 0;
    forfour(l1, names, l2, types, l3, typmods, l4, collations)
    {
        char       *attname = strVal(lfirst(l1));
        Oid         atttypid = lfirst_oid(l2);
        int32       atttypmod = lfirst_int(l3);
        Oid         attcollation = lfirst_oid(l4);
 
        attnum++;
 
        TupleDescInitEntry(desc, attnum, attname, atttypid, atttypmod, 0);
        TupleDescInitEntryCollation(desc, attnum, attcollation);
    }
 
    return desc;
}

References Assert(), attname, attnum, CreateTemplateTupleDesc(), forfour, lfirst, lfirst_int, lfirst_oid, list_length(), strVal, TupleDescInitEntry(), TupleDescInitEntryCollation(), and types.

Referenced by ExecInitFunctionScan(), ExecInitTableFuncScan(), and inline_set_returning_function().

CreateTemplateTupleDesc()

TupleDesc CreateTemplateTupleDesc

(

int

natts

)

Definition at line 175 of file tupdesc.c.

{
    TupleDesc   desc;
 
    /*
     * sanity checks
     */
    Assert(natts >= 0);
 
    /*
     * Allocate enough memory for the tuple descriptor, the CompactAttribute
     * array and also an array of FormData_pg_attribute.
     *
     * Note: the FormData_pg_attribute array stride is
     * sizeof(FormData_pg_attribute), since we declare the array elements as
     * FormData_pg_attribute for notational convenience.  However, we only
     * guarantee that the first ATTRIBUTE_FIXED_PART_SIZE bytes of each entry
     * are valid; most code that copies tupdesc entries around copies just
     * that much.  In principle that could be less due to trailing padding,
     * although with the current definition of pg_attribute there probably
     * isn't any padding.
     */
    desc = (TupleDesc) palloc(offsetof(struct TupleDescData, compact_attrs) +
                              natts * sizeof(CompactAttribute) +
                              natts * sizeof(FormData_pg_attribute));
 
    /*
     * Initialize other fields of the tupdesc.
     */
    desc->natts = natts;
    desc->constr = NULL;
    desc->tdtypeid = RECORDOID;
    desc->tdtypmod = -1;
    desc->tdrefcount = -1;      /* assume not reference-counted */
 
    return desc;
}

References Assert(), TupleDescData::constr, FormData_pg_attribute, TupleDescData::natts, palloc(), TupleDescData::tdrefcount, TupleDescData::tdtypeid, and TupleDescData::tdtypmod.

Referenced by aclexplode(), addRangeTableEntryForFunction(), AllocateRelationDesc(), brtuple_disk_tupdesc(), build_function_result_tupdesc_d(), build_row_from_vars(), BuildDescForRelation(), BuildDescFromLists(), BuildHardcodedDescriptor(), ConstructTupleDescriptor(), create_toast_table(), CreateReplicationSlot(), CreateTupleDesc(), CreateTupleDescCopy(), CreateTupleDescCopyConstr(), CreateTupleDescTruncatedCopy(), dblink_get_pkey(), ExecInitFunctionScan(), ExecMakeTableFunctionResult(), ExecTypeFromExprList(), ExecTypeFromTLInternal(), expandRecordVariable(), ExplainResultDesc(), formrdesc(), get_expr_result_type(), GetPGVariableResultDesc(), gistrescan(), IdentifySystem(), init_sexpr(), initGinState(), injection_points_stats_fixed(), libpqrcv_processTuples(), load_relcache_init_file(), materializeResult(), ordered_set_startup(), pg_buffercache_numa_pages(), pg_buffercache_pages(), pg_get_publication_tables(), pg_get_sequence_data(), pg_lock_status(), pg_prepared_xact(), pg_stat_file(), pg_stat_get_archiver(), pg_stat_get_backend_subxact(), pg_stat_get_replication_slot(), pg_stat_get_subscription_stats(), pg_stat_wal_build_tuple(), pg_visibility_tupdesc(), pg_walfile_name_offset(), ReadReplicationSlot(), SendTablespaceList(), SendTimeLineHistory(), SendXlogRecPtrResult(), show_all_settings(), ShowAllGUCConfig(), ShowGUCConfigOption(), StartReplication(), test_predtest(), tsvector_unnest(), and TypeGetTupleDesc().

CreateTupleDesc()

TupleDesc CreateTupleDesc	(	int	natts,
		Form_pg_attribute *	attrs
	)

Definition at line 222 of file tupdesc.c.

{
    TupleDesc   desc;
    int         i;
 
    desc = CreateTemplateTupleDesc(natts);
 
    for (i = 0; i < natts; ++i)
    {
        memcpy(TupleDescAttr(desc, i), attrs[i], ATTRIBUTE_FIXED_PART_SIZE);
        populate_compact_attribute(desc, i);
    }
    return desc;
}

References ATTRIBUTE_FIXED_PART_SIZE, CreateTemplateTupleDesc(), i, populate_compact_attribute(), and TupleDescAttr().

Referenced by AddNewAttributeTuples(), and InsertOneTuple().

CreateTupleDescCopy()

TupleDesc CreateTupleDescCopy

(

TupleDesc

tupdesc

)

Definition at line 245 of file tupdesc.c.

{
    TupleDesc   desc;
    int         i;
 
    desc = CreateTemplateTupleDesc(tupdesc->natts);
 
    /* Flat-copy the attribute array */
    memcpy(TupleDescAttr(desc, 0),
           TupleDescAttr(tupdesc, 0),
           desc->natts * sizeof(FormData_pg_attribute));
 
    /*
     * Since we're not copying constraints and defaults, clear fields
     * associated with them.
     */
    for (i = 0; i < desc->natts; i++)
    {
        Form_pg_attribute att = TupleDescAttr(desc, i);
 
        att->attnotnull = false;
        att->atthasdef = false;
        att->atthasmissing = false;
        att->attidentity = '\0';
        att->attgenerated = '\0';
 
        populate_compact_attribute(desc, i);
    }
 
    /* We can copy the tuple type identification, too */
    desc->tdtypeid = tupdesc->tdtypeid;
    desc->tdtypmod = tupdesc->tdtypmod;
 
    return desc;
}

References CreateTemplateTupleDesc(), FormData_pg_attribute, i, TupleDescData::natts, populate_compact_attribute(), TupleDescData::tdtypeid, TupleDescData::tdtypmod, and TupleDescAttr().

Referenced by assign_record_type_typmod(), BuildTupleHashTable(), cfunc_hashtable_insert(), connectby_text(), connectby_text_serial(), CopyCachedPlan(), crosstab(), crosstab_hash(), database_to_xmlschema_internal(), do_autovacuum(), ExecEvalWholeRowVar(), ExecInitForeignScan(), ExecInitFunctionScan(), ExecInsert(), ExecPrepareTuplestoreResult(), FetchPreparedStatementResultDesc(), fmgr_sql(), get_record_type_from_query(), get_tupdesc_for_join_scan_tuples(), GetAfterTriggersStoreSlot(), getSpGistTupleDesc(), init_sexpr(), InitMaterializedSRF(), make_expanded_record_from_exprecord(), make_expanded_record_from_tupdesc(), materializeResult(), PersistHoldablePortal(), plperl_return_next_internal(), plpgsql_exec_function(), pltcl_func_handler(), PLy_spi_execute_fetch_result(), populate_recordset_worker(), RelationBuildLocalRelation(), RelationNameGetTupleDesc(), RevalidateCachedQuery(), schema_to_xmlschema_internal(), spi_dest_startup(), sql_compile_callback(), storeRow(), update_cached_tupdesc(), and UtilityTupleDescriptor().

CreateTupleDescCopyConstr()

TupleDesc CreateTupleDescCopyConstr

(

TupleDesc

tupdesc

)

Definition at line 333 of file tupdesc.c.

{
    TupleDesc   desc;
    TupleConstr *constr = tupdesc->constr;
    int         i;
 
    desc = CreateTemplateTupleDesc(tupdesc->natts);
 
    /* Flat-copy the attribute array */
    memcpy(TupleDescAttr(desc, 0),
           TupleDescAttr(tupdesc, 0),
           desc->natts * sizeof(FormData_pg_attribute));
 
    for (i = 0; i < desc->natts; i++)
    {
        populate_compact_attribute(desc, i);
 
        TupleDescCompactAttr(desc, i)->attnullability =
            TupleDescCompactAttr(tupdesc, i)->attnullability;
    }
 
    /* Copy the TupleConstr data structure, if any */
    if (constr)
    {
        TupleConstr *cpy = (TupleConstr *) palloc0(sizeof(TupleConstr));
 
        cpy->has_not_null = constr->has_not_null;
        cpy->has_generated_stored = constr->has_generated_stored;
        cpy->has_generated_virtual = constr->has_generated_virtual;
 
        if ((cpy->num_defval = constr->num_defval) > 0)
        {
            cpy->defval = (AttrDefault *) palloc(cpy->num_defval * sizeof(AttrDefault));
            memcpy(cpy->defval, constr->defval, cpy->num_defval * sizeof(AttrDefault));
            for (i = cpy->num_defval - 1; i >= 0; i--)
                cpy->defval[i].adbin = pstrdup(constr->defval[i].adbin);
        }
 
        if (constr->missing)
        {
            cpy->missing = (AttrMissing *) palloc(tupdesc->natts * sizeof(AttrMissing));
            memcpy(cpy->missing, constr->missing, tupdesc->natts * sizeof(AttrMissing));
            for (i = tupdesc->natts - 1; i >= 0; i--)
            {
                if (constr->missing[i].am_present)
                {
                    CompactAttribute *attr = TupleDescCompactAttr(tupdesc, i);
 
                    cpy->missing[i].am_value = datumCopy(constr->missing[i].am_value,
                                                         attr->attbyval,
                                                         attr->attlen);
                }
            }
        }
 
        if ((cpy->num_check = constr->num_check) > 0)
        {
            cpy->check = (ConstrCheck *) palloc(cpy->num_check * sizeof(ConstrCheck));
            memcpy(cpy->check, constr->check, cpy->num_check * sizeof(ConstrCheck));
            for (i = cpy->num_check - 1; i >= 0; i--)
            {
                cpy->check[i].ccname = pstrdup(constr->check[i].ccname);
                cpy->check[i].ccbin = pstrdup(constr->check[i].ccbin);
                cpy->check[i].ccenforced = constr->check[i].ccenforced;
                cpy->check[i].ccvalid = constr->check[i].ccvalid;
                cpy->check[i].ccnoinherit = constr->check[i].ccnoinherit;
            }
        }
 
        desc->constr = cpy;
    }
 
    /* We can copy the tuple type identification, too */
    desc->tdtypeid = tupdesc->tdtypeid;
    desc->tdtypmod = tupdesc->tdtypmod;
 
    return desc;
}

References AttrDefault::adbin, AttrMissing::am_present, AttrMissing::am_value, CompactAttribute::attbyval, CompactAttribute::attlen, CompactAttribute::attnullability, ConstrCheck::ccbin, ConstrCheck::ccenforced, ConstrCheck::ccname, ConstrCheck::ccnoinherit, ConstrCheck::ccvalid, TupleConstr::check, TupleDescData::constr, CreateTemplateTupleDesc(), datumCopy(), TupleConstr::defval, FormData_pg_attribute, TupleConstr::has_generated_stored, TupleConstr::has_generated_virtual, TupleConstr::has_not_null, i, TupleConstr::missing, TupleDescData::natts, TupleConstr::num_check, TupleConstr::num_defval, palloc(), palloc0(), populate_compact_attribute(), pstrdup(), TupleDescData::tdtypeid, TupleDescData::tdtypmod, TupleDescAttr(), and TupleDescCompactAttr().

Referenced by ATGetQueueEntry(), CatalogCacheInitializeCache(), init_tuple_slot(), and lookup_rowtype_tupdesc_copy().

CreateTupleDescTruncatedCopy()

TupleDesc CreateTupleDescTruncatedCopy	(	TupleDesc	tupdesc,
		int	natts
	)

Definition at line 289 of file tupdesc.c.

{
    TupleDesc   desc;
    int         i;
 
    Assert(natts <= tupdesc->natts);
 
    desc = CreateTemplateTupleDesc(natts);
 
    /* Flat-copy the attribute array */
    memcpy(TupleDescAttr(desc, 0),
           TupleDescAttr(tupdesc, 0),
           desc->natts * sizeof(FormData_pg_attribute));
 
    /*
     * Since we're not copying constraints and defaults, clear fields
     * associated with them.
     */
    for (i = 0; i < desc->natts; i++)
    {
        Form_pg_attribute att = TupleDescAttr(desc, i);
 
        att->attnotnull = false;
        att->atthasdef = false;
        att->atthasmissing = false;
        att->attidentity = '\0';
        att->attgenerated = '\0';
 
        populate_compact_attribute(desc, i);
    }
 
    /* We can copy the tuple type identification, too */
    desc->tdtypeid = tupdesc->tdtypeid;
    desc->tdtypmod = tupdesc->tdtypmod;
 
    return desc;
}

References Assert(), CreateTemplateTupleDesc(), FormData_pg_attribute, i, TupleDescData::natts, populate_compact_attribute(), TupleDescData::tdtypeid, TupleDescData::tdtypmod, and TupleDescAttr().

Referenced by gist_page_items(), index_truncate_tuple(), and initGISTstate().

DecrTupleDescRefCount()

void DecrTupleDescRefCount

(

TupleDesc

tupdesc

)

Definition at line 570 of file tupdesc.c.

{
    Assert(tupdesc->tdrefcount > 0);
 
    ResourceOwnerForgetTupleDesc(CurrentResourceOwner, tupdesc);
    if (--tupdesc->tdrefcount == 0)
        FreeTupleDesc(tupdesc);
}

References Assert(), CurrentResourceOwner, FreeTupleDesc(), ResourceOwnerForgetTupleDesc(), and TupleDescData::tdrefcount.

Referenced by cache_record_field_properties(), and ExecEvalConvertRowtype().

equalRowTypes()

bool equalRowTypes	(	TupleDesc	tupdesc1,
		TupleDesc	tupdesc2
	)

Definition at line 770 of file tupdesc.c.

{
    if (tupdesc1->natts != tupdesc2->natts)
        return false;
    if (tupdesc1->tdtypeid != tupdesc2->tdtypeid)
        return false;
 
    for (int i = 0; i < tupdesc1->natts; i++)
    {
        Form_pg_attribute attr1 = TupleDescAttr(tupdesc1, i);
        Form_pg_attribute attr2 = TupleDescAttr(tupdesc2, i);
 
        if (strcmp(NameStr(attr1->attname), NameStr(attr2->attname)) != 0)
            return false;
        if (attr1->atttypid != attr2->atttypid)
            return false;
        if (attr1->atttypmod != attr2->atttypmod)
            return false;
        if (attr1->attcollation != attr2->attcollation)
            return false;
 
        /* Record types derived from tables could have dropped fields. */
        if (attr1->attisdropped != attr2->attisdropped)
            return false;
    }
 
    return true;
}

References i, NameStr, TupleDescData::natts, TupleDescData::tdtypeid, and TupleDescAttr().

Referenced by acquire_inherited_sample_rows(), cfunc_match(), ProcedureCreate(), record_type_typmod_compare(), RevalidateCachedQuery(), and shared_record_table_compare().

equalTupleDescs()

bool equalTupleDescs	(	TupleDesc	tupdesc1,
		TupleDesc	tupdesc2
	)

Definition at line 583 of file tupdesc.c.

{
    int         i,
                n;
 
    if (tupdesc1->natts != tupdesc2->natts)
        return false;
    if (tupdesc1->tdtypeid != tupdesc2->tdtypeid)
        return false;
 
    /* tdtypmod and tdrefcount are not checked */
 
    for (i = 0; i < tupdesc1->natts; i++)
    {
        Form_pg_attribute attr1 = TupleDescAttr(tupdesc1, i);
        Form_pg_attribute attr2 = TupleDescAttr(tupdesc2, i);
 
        /*
         * We do not need to check every single field here: we can disregard
         * attrelid and attnum (which were used to place the row in the attrs
         * array in the first place).  It might look like we could dispense
         * with checking attlen/attbyval/attalign, since these are derived
         * from atttypid; but in the case of dropped columns we must check
         * them (since atttypid will be zero for all dropped columns) and in
         * general it seems safer to check them always.
         *
         * We intentionally ignore atthasmissing, since that's not very
         * relevant in tupdescs, which lack the attmissingval field.
         */
        if (strcmp(NameStr(attr1->attname), NameStr(attr2->attname)) != 0)
            return false;
        if (attr1->atttypid != attr2->atttypid)
            return false;
        if (attr1->attlen != attr2->attlen)
            return false;
        if (attr1->attndims != attr2->attndims)
            return false;
        if (attr1->atttypmod != attr2->atttypmod)
            return false;
        if (attr1->attbyval != attr2->attbyval)
            return false;
        if (attr1->attalign != attr2->attalign)
            return false;
        if (attr1->attstorage != attr2->attstorage)
            return false;
        if (attr1->attcompression != attr2->attcompression)
            return false;
        if (attr1->attnotnull != attr2->attnotnull)
            return false;
 
        /*
         * When the column has a not-null constraint, we also need to consider
         * its validity aspect, which only manifests in CompactAttribute->
         * attnullability, so verify that.
         */
        if (attr1->attnotnull)
        {
            CompactAttribute *cattr1 = TupleDescCompactAttr(tupdesc1, i);
            CompactAttribute *cattr2 = TupleDescCompactAttr(tupdesc2, i);
 
            Assert(cattr1->attnullability != ATTNULLABLE_UNKNOWN);
            Assert((cattr1->attnullability == ATTNULLABLE_UNKNOWN) ==
                   (cattr2->attnullability == ATTNULLABLE_UNKNOWN));
 
            if (cattr1->attnullability != cattr2->attnullability)
                return false;
        }
        if (attr1->atthasdef != attr2->atthasdef)
            return false;
        if (attr1->attidentity != attr2->attidentity)
            return false;
        if (attr1->attgenerated != attr2->attgenerated)
            return false;
        if (attr1->attisdropped != attr2->attisdropped)
            return false;
        if (attr1->attislocal != attr2->attislocal)
            return false;
        if (attr1->attinhcount != attr2->attinhcount)
            return false;
        if (attr1->attcollation != attr2->attcollation)
            return false;
        /* variable-length fields are not even present... */
    }
 
    if (tupdesc1->constr != NULL)
    {
        TupleConstr *constr1 = tupdesc1->constr;
        TupleConstr *constr2 = tupdesc2->constr;
 
        if (constr2 == NULL)
            return false;
        if (constr1->has_not_null != constr2->has_not_null)
            return false;
        if (constr1->has_generated_stored != constr2->has_generated_stored)
            return false;
        if (constr1->has_generated_virtual != constr2->has_generated_virtual)
            return false;
        n = constr1->num_defval;
        if (n != (int) constr2->num_defval)
            return false;
        /* We assume here that both AttrDefault arrays are in adnum order */
        for (i = 0; i < n; i++)
        {
            AttrDefault *defval1 = constr1->defval + i;
            AttrDefault *defval2 = constr2->defval + i;
 
            if (defval1->adnum != defval2->adnum)
                return false;
            if (strcmp(defval1->adbin, defval2->adbin) != 0)
                return false;
        }
        if (constr1->missing)
        {
            if (!constr2->missing)
                return false;
            for (i = 0; i < tupdesc1->natts; i++)
            {
                AttrMissing *missval1 = constr1->missing + i;
                AttrMissing *missval2 = constr2->missing + i;
 
                if (missval1->am_present != missval2->am_present)
                    return false;
                if (missval1->am_present)
                {
                    CompactAttribute *missatt1 = TupleDescCompactAttr(tupdesc1, i);
 
                    if (!datumIsEqual(missval1->am_value, missval2->am_value,
                                      missatt1->attbyval, missatt1->attlen))
                        return false;
                }
            }
        }
        else if (constr2->missing)
            return false;
        n = constr1->num_check;
        if (n != (int) constr2->num_check)
            return false;
 
        /*
         * Similarly, we rely here on the ConstrCheck entries being sorted by
         * name.  If there are duplicate names, the outcome of the comparison
         * is uncertain, but that should not happen.
         */
        for (i = 0; i < n; i++)
        {
            ConstrCheck *check1 = constr1->check + i;
            ConstrCheck *check2 = constr2->check + i;
 
            if (!(strcmp(check1->ccname, check2->ccname) == 0 &&
                  strcmp(check1->ccbin, check2->ccbin) == 0 &&
                  check1->ccenforced == check2->ccenforced &&
                  check1->ccvalid == check2->ccvalid &&
                  check1->ccnoinherit == check2->ccnoinherit))
                return false;
        }
    }
    else if (tupdesc2->constr != NULL)
        return false;
    return true;
}

References AttrDefault::adbin, AttrDefault::adnum, AttrMissing::am_present, AttrMissing::am_value, Assert(), CompactAttribute::attbyval, CompactAttribute::attlen, CompactAttribute::attnullability, ATTNULLABLE_UNKNOWN, ConstrCheck::ccbin, ConstrCheck::ccenforced, ConstrCheck::ccname, ConstrCheck::ccnoinherit, ConstrCheck::ccvalid, TupleConstr::check, TupleDescData::constr, datumIsEqual(), TupleConstr::defval, TupleConstr::has_generated_stored, TupleConstr::has_generated_virtual, TupleConstr::has_not_null, i, TupleConstr::missing, NameStr, TupleDescData::natts, TupleConstr::num_check, TupleConstr::num_defval, TupleDescData::tdtypeid, TupleDescAttr(), and TupleDescCompactAttr().

Referenced by RelationFindReplTupleSeq(), and RelationRebuildRelation().

FreeTupleDesc()

void FreeTupleDesc

(

TupleDesc

tupdesc

)

Definition at line 495 of file tupdesc.c.

{
    int         i;
 
    /*
     * Possibly this should assert tdrefcount == 0, to disallow explicit
     * freeing of un-refcounted tupdescs?
     */
    Assert(tupdesc->tdrefcount <= 0);
 
    if (tupdesc->constr)
    {
        if (tupdesc->constr->num_defval > 0)
        {
            AttrDefault *attrdef = tupdesc->constr->defval;
 
            for (i = tupdesc->constr->num_defval - 1; i >= 0; i--)
                pfree(attrdef[i].adbin);
            pfree(attrdef);
        }
        if (tupdesc->constr->missing)
        {
            AttrMissing *attrmiss = tupdesc->constr->missing;
 
            for (i = tupdesc->natts - 1; i >= 0; i--)
            {
                if (attrmiss[i].am_present
                    && !TupleDescAttr(tupdesc, i)->attbyval)
                    pfree(DatumGetPointer(attrmiss[i].am_value));
            }
            pfree(attrmiss);
        }
        if (tupdesc->constr->num_check > 0)
        {
            ConstrCheck *check = tupdesc->constr->check;
 
            for (i = tupdesc->constr->num_check - 1; i >= 0; i--)
            {
                pfree(check[i].ccname);
                pfree(check[i].ccbin);
            }
            pfree(check);
        }
        pfree(tupdesc->constr);
    }
 
    pfree(tupdesc);
}

References Assert(), attbyval, TupleConstr::check, TupleDescData::constr, DatumGetPointer(), TupleConstr::defval, i, TupleConstr::missing, TupleDescData::natts, TupleConstr::num_check, TupleConstr::num_defval, pfree(), TupleDescData::tdrefcount, and TupleDescAttr().

Referenced by AddNewAttributeTuples(), AtEOXact_RelationCache(), cfunc_hashtable_delete(), DecrTupleDescRefCount(), ER_mc_callback(), ExecMakeTableFunctionResult(), ExecPrepareTuplestoreResult(), get_record_type_from_query(), get_rel_sync_entry(), InvalidateCompositeTypeCacheEntry(), ordered_set_startup(), PLy_result_dealloc(), RelationDestroyRelation(), ResOwnerReleaseTupleDesc(), RevalidateCachedQuery(), spgendscan(), update_cached_tupdesc(), and walrcv_clear_result().

hashRowType()

uint32 hashRowType

(

TupleDesc

desc

)

Definition at line 806 of file tupdesc.c.

{
    uint32      s;
    int         i;
 
    s = hash_combine(0, hash_uint32(desc->natts));
    s = hash_combine(s, hash_uint32(desc->tdtypeid));
    for (i = 0; i < desc->natts; ++i)
        s = hash_combine(s, hash_uint32(TupleDescAttr(desc, i)->atttypid));
 
    return s;
}

References hash_combine(), hash_uint32(), i, TupleDescData::natts, TupleDescData::tdtypeid, and TupleDescAttr().

Referenced by cfunc_hash(), record_type_typmod_hash(), and shared_record_table_hash().

IncrTupleDescRefCount()

void IncrTupleDescRefCount

(

TupleDesc

tupdesc

)

Definition at line 552 of file tupdesc.c.

{
    Assert(tupdesc->tdrefcount >= 0);
 
    ResourceOwnerEnlarge(CurrentResourceOwner);
    tupdesc->tdrefcount++;
    ResourceOwnerRememberTupleDesc(CurrentResourceOwner, tupdesc);
}

References Assert(), CurrentResourceOwner, ResourceOwnerEnlarge(), ResourceOwnerRememberTupleDesc(), and TupleDescData::tdrefcount.

Referenced by cache_record_field_properties(), and ExecEvalConvertRowtype().

populate_compact_attribute()

void populate_compact_attribute	(	TupleDesc	tupdesc,
		int	attnum
	)

Definition at line 117 of file tupdesc.c.

{
    Form_pg_attribute src = TupleDescAttr(tupdesc, attnum);
    CompactAttribute *dst;
 
    /*
     * Don't use TupleDescCompactAttr to prevent infinite recursion in assert
     * builds.
     */
    dst = &tupdesc->compact_attrs[attnum];
 
    populate_compact_attribute_internal(src, dst);
}

References attnum, TupleDescData::compact_attrs, populate_compact_attribute_internal(), and TupleDescAttr().

Referenced by BuildDescForRelation(), BuildHardcodedDescriptor(), ConstructTupleDescriptor(), CreateTupleDesc(), CreateTupleDescCopy(), CreateTupleDescCopyConstr(), CreateTupleDescTruncatedCopy(), formrdesc(), getSpGistTupleDesc(), load_relcache_init_file(), RelationBuildLocalRelation(), RelationBuildTupleDesc(), TupleDescCopy(), TupleDescCopyEntry(), TupleDescInitBuiltinEntry(), and TupleDescInitEntry().

populate_compact_attribute_internal()

static void populate_compact_attribute_internal ( Form_pg_attribute  src, CompactAttribute *  dst  )

inlinestatic

Definition at line 65 of file tupdesc.c.

{
    memset(dst, 0, sizeof(CompactAttribute));
 
    dst->attcacheoff = -1;
    dst->attlen = src->attlen;
 
    dst->attbyval = src->attbyval;
    dst->attispackable = (src->attstorage != TYPSTORAGE_PLAIN);
    dst->atthasmissing = src->atthasmissing;
    dst->attisdropped = src->attisdropped;
    dst->attgenerated = (src->attgenerated != '\0');
 
    /*
     * Assign nullability status for this column.  Assuming that a constraint
     * exists, at this point we don't know if a not-null constraint is valid,
     * so we assign UNKNOWN unless the table is a catalog, in which case we
     * know it's valid.
     */
    dst->attnullability = !src->attnotnull ? ATTNULLABLE_UNRESTRICTED :
        IsCatalogRelationOid(src->attrelid) ? ATTNULLABLE_VALID :
        ATTNULLABLE_UNKNOWN;
 
    switch (src->attalign)
    {
        case TYPALIGN_INT:
            dst->attalignby = ALIGNOF_INT;
            break;
        case TYPALIGN_CHAR:
            dst->attalignby = sizeof(char);
            break;
        case TYPALIGN_DOUBLE:
            dst->attalignby = ALIGNOF_DOUBLE;
            break;
        case TYPALIGN_SHORT:
            dst->attalignby = ALIGNOF_SHORT;
            break;
        default:
            dst->attalignby = 0;
            elog(ERROR, "invalid attalign value: %c", src->attalign);
            break;
    }
}

References CompactAttribute::attalignby, CompactAttribute::attbyval, CompactAttribute::attcacheoff, CompactAttribute::attgenerated, CompactAttribute::atthasmissing, CompactAttribute::attisdropped, CompactAttribute::attispackable, CompactAttribute::attlen, CompactAttribute::attnullability, ATTNULLABLE_UNKNOWN, ATTNULLABLE_UNRESTRICTED, ATTNULLABLE_VALID, elog, ERROR, and IsCatalogRelationOid().

Referenced by populate_compact_attribute(), and verify_compact_attribute().

ResourceOwnerForgetTupleDesc()

static void ResourceOwnerForgetTupleDesc ( ResourceOwner  owner, TupleDesc  tupdesc  )

inlinestatic

Definition at line 55 of file tupdesc.c.

{
    ResourceOwnerForget(owner, PointerGetDatum(tupdesc), &tupdesc_resowner_desc);
}

References PointerGetDatum(), ResourceOwnerForget(), and tupdesc_resowner_desc.

Referenced by DecrTupleDescRefCount().

ResourceOwnerRememberTupleDesc()

static void ResourceOwnerRememberTupleDesc ( ResourceOwner  owner, TupleDesc  tupdesc  )

inlinestatic

Definition at line 49 of file tupdesc.c.

{
    ResourceOwnerRemember(owner, PointerGetDatum(tupdesc), &tupdesc_resowner_desc);
}

References PointerGetDatum(), ResourceOwnerRemember(), and tupdesc_resowner_desc.

Referenced by IncrTupleDescRefCount().

ResOwnerPrintTupleDesc()

static char * ResOwnerPrintTupleDesc ( Datum  res )

static

Definition at line 1120 of file tupdesc.c.

{
    TupleDesc   tupdesc = (TupleDesc) DatumGetPointer(res);
 
    return psprintf("TupleDesc %p (%u,%d)",
                    tupdesc, tupdesc->tdtypeid, tupdesc->tdtypmod);
}

References DatumGetPointer(), psprintf(), TupleDescData::tdtypeid, and TupleDescData::tdtypmod.

ResOwnerReleaseTupleDesc()

static void ResOwnerReleaseTupleDesc ( Datum  res )

static

Definition at line 1109 of file tupdesc.c.

{
    TupleDesc   tupdesc = (TupleDesc) DatumGetPointer(res);
 
    /* Like DecrTupleDescRefCount, but don't call ResourceOwnerForget() */
    Assert(tupdesc->tdrefcount > 0);
    if (--tupdesc->tdrefcount == 0)
        FreeTupleDesc(tupdesc);
}

References Assert(), DatumGetPointer(), FreeTupleDesc(), and TupleDescData::tdrefcount.

TupleDescCopy()

void TupleDescCopy	(	TupleDesc	dst,
		TupleDesc	src
	)

Definition at line 421 of file tupdesc.c.

{
    int         i;
 
    /* Flat-copy the header and attribute arrays */
    memcpy(dst, src, TupleDescSize(src));
 
    /*
     * Since we're not copying constraints and defaults, clear fields
     * associated with them.
     */
    for (i = 0; i < dst->natts; i++)
    {
        Form_pg_attribute att = TupleDescAttr(dst, i);
 
        att->attnotnull = false;
        att->atthasdef = false;
        att->atthasmissing = false;
        att->attidentity = '\0';
        att->attgenerated = '\0';
 
        populate_compact_attribute(dst, i);
    }
    dst->constr = NULL;
 
    /*
     * Also, assume the destination is not to be ref-counted.  (Copying the
     * source's refcount would be wrong in any case.)
     */
    dst->tdrefcount = -1;
}

References TupleDescData::constr, i, TupleDescData::natts, populate_compact_attribute(), TupleDescData::tdrefcount, TupleDescAttr(), and TupleDescSize.

Referenced by share_tupledesc().

TupleDescCopyEntry()

void TupleDescCopyEntry	(	TupleDesc	dst,
		AttrNumber	dstAttno,
		TupleDesc	src,
		AttrNumber	srcAttno
	)

Definition at line 461 of file tupdesc.c.

{
    Form_pg_attribute dstAtt = TupleDescAttr(dst, dstAttno - 1);
    Form_pg_attribute srcAtt = TupleDescAttr(src, srcAttno - 1);
 
    /*
     * sanity checks
     */
    Assert(PointerIsValid(src));
    Assert(PointerIsValid(dst));
    Assert(srcAttno >= 1);
    Assert(srcAttno <= src->natts);
    Assert(dstAttno >= 1);
    Assert(dstAttno <= dst->natts);
 
    memcpy(dstAtt, srcAtt, ATTRIBUTE_FIXED_PART_SIZE);
 
    dstAtt->attnum = dstAttno;
 
    /* since we're not copying constraints or defaults, clear these */
    dstAtt->attnotnull = false;
    dstAtt->atthasdef = false;
    dstAtt->atthasmissing = false;
    dstAtt->attidentity = '\0';
    dstAtt->attgenerated = '\0';
 
    populate_compact_attribute(dst, dstAttno - 1);
}

References Assert(), ATTRIBUTE_FIXED_PART_SIZE, PointerIsValid, populate_compact_attribute(), and TupleDescAttr().

Referenced by addRangeTableEntryForFunction(), ExecInitFunctionScan(), and ordered_set_startup().

TupleDescGetDefault()

Node * TupleDescGetDefault	(	TupleDesc	tupdesc,
		AttrNumber	attnum
	)

Definition at line 1085 of file tupdesc.c.

{
    Node       *result = NULL;
 
    if (tupdesc->constr)
    {
        AttrDefault *attrdef = tupdesc->constr->defval;
 
        for (int i = 0; i < tupdesc->constr->num_defval; i++)
        {
            if (attrdef[i].adnum == attnum)
            {
                result = stringToNode(attrdef[i].adbin);
                break;
            }
        }
    }
 
    return result;
}

References attnum, TupleDescData::constr, TupleConstr::defval, i, TupleConstr::num_defval, and stringToNode().

Referenced by build_column_default(), expandTableLikeClause(), and MergeAttributes().

TupleDescInitBuiltinEntry()

void TupleDescInitBuiltinEntry	(	TupleDesc	desc,
		AttrNumber	attributeNumber,
		const char *	attributeName,
		Oid	oidtypeid,
		int32	typmod,
		int	attdim
	)

Definition at line 911 of file tupdesc.c.

{
    Form_pg_attribute att;
 
    /* sanity checks */
    Assert(PointerIsValid(desc));
    Assert(attributeNumber >= 1);
    Assert(attributeNumber <= desc->natts);
    Assert(attdim >= 0);
    Assert(attdim <= PG_INT16_MAX);
 
    /* initialize the attribute fields */
    att = TupleDescAttr(desc, attributeNumber - 1);
    att->attrelid = 0;          /* dummy value */
 
    /* unlike TupleDescInitEntry, we require an attribute name */
    Assert(attributeName != NULL);
    namestrcpy(&(att->attname), attributeName);
 
    att->atttypmod = typmod;
 
    att->attnum = attributeNumber;
    att->attndims = attdim;
 
    att->attnotnull = false;
    att->atthasdef = false;
    att->atthasmissing = false;
    att->attidentity = '\0';
    att->attgenerated = '\0';
    att->attisdropped = false;
    att->attislocal = true;
    att->attinhcount = 0;
    /* variable-length fields are not present in tupledescs */
 
    att->atttypid = oidtypeid;
 
    /*
     * Our goal here is to support just enough types to let basic builtin
     * commands work without catalog access - e.g. so that we can do certain
     * things even in processes that are not connected to a database.
     */
    switch (oidtypeid)
    {
        case TEXTOID:
        case TEXTARRAYOID:
            att->attlen = -1;
            att->attbyval = false;
            att->attalign = TYPALIGN_INT;
            att->attstorage = TYPSTORAGE_EXTENDED;
            att->attcompression = InvalidCompressionMethod;
            att->attcollation = DEFAULT_COLLATION_OID;
            break;
 
        case BOOLOID:
            att->attlen = 1;
            att->attbyval = true;
            att->attalign = TYPALIGN_CHAR;
            att->attstorage = TYPSTORAGE_PLAIN;
            att->attcompression = InvalidCompressionMethod;
            att->attcollation = InvalidOid;
            break;
 
        case INT4OID:
            att->attlen = 4;
            att->attbyval = true;
            att->attalign = TYPALIGN_INT;
            att->attstorage = TYPSTORAGE_PLAIN;
            att->attcompression = InvalidCompressionMethod;
            att->attcollation = InvalidOid;
            break;
 
        case INT8OID:
            att->attlen = 8;
            att->attbyval = FLOAT8PASSBYVAL;
            att->attalign = TYPALIGN_DOUBLE;
            att->attstorage = TYPSTORAGE_PLAIN;
            att->attcompression = InvalidCompressionMethod;
            att->attcollation = InvalidOid;
            break;
 
        case OIDOID:
            att->attlen = 4;
            att->attbyval = true;
            att->attalign = TYPALIGN_INT;
            att->attstorage = TYPSTORAGE_PLAIN;
            att->attcompression = InvalidCompressionMethod;
            att->attcollation = InvalidOid;
            break;
 
        default:
            elog(ERROR, "unsupported type %u", oidtypeid);
    }
 
    populate_compact_attribute(desc, attributeNumber - 1);
}

References Assert(), elog, ERROR, FLOAT8PASSBYVAL, InvalidCompressionMethod, InvalidOid, namestrcpy(), PG_INT16_MAX, PointerIsValid, populate_compact_attribute(), and TupleDescAttr().

Referenced by CreateReplicationSlot(), IdentifySystem(), ReadReplicationSlot(), SendTablespaceList(), SendTimeLineHistory(), SendXlogRecPtrResult(), ShowAllGUCConfig(), ShowGUCConfigOption(), and StartReplication().

TupleDescInitEntry()

void TupleDescInitEntry	(	TupleDesc	desc,
		AttrNumber	attributeNumber,
		const char *	attributeName,
		Oid	oidtypeid,
		int32	typmod,
		int	attdim
	)

Definition at line 835 of file tupdesc.c.

{
    HeapTuple   tuple;
    Form_pg_type typeForm;
    Form_pg_attribute att;
 
    /*
     * sanity checks
     */
    Assert(PointerIsValid(desc));
    Assert(attributeNumber >= 1);
    Assert(attributeNumber <= desc->natts);
    Assert(attdim >= 0);
    Assert(attdim <= PG_INT16_MAX);
 
    /*
     * initialize the attribute fields
     */
    att = TupleDescAttr(desc, attributeNumber - 1);
 
    att->attrelid = 0;          /* dummy value */
 
    /*
     * Note: attributeName can be NULL, because the planner doesn't always
     * fill in valid resname values in targetlists, particularly for resjunk
     * attributes. Also, do nothing if caller wants to re-use the old attname.
     */
    if (attributeName == NULL)
        MemSet(NameStr(att->attname), 0, NAMEDATALEN);
    else if (attributeName != NameStr(att->attname))
        namestrcpy(&(att->attname), attributeName);
 
    att->atttypmod = typmod;
 
    att->attnum = attributeNumber;
    att->attndims = attdim;
 
    att->attnotnull = false;
    att->atthasdef = false;
    att->atthasmissing = false;
    att->attidentity = '\0';
    att->attgenerated = '\0';
    att->attisdropped = false;
    att->attislocal = true;
    att->attinhcount = 0;
    /* variable-length fields are not present in tupledescs */
 
    tuple = SearchSysCache1(TYPEOID, ObjectIdGetDatum(oidtypeid));
    if (!HeapTupleIsValid(tuple))
        elog(ERROR, "cache lookup failed for type %u", oidtypeid);
    typeForm = (Form_pg_type) GETSTRUCT(tuple);
 
    att->atttypid = oidtypeid;
    att->attlen = typeForm->typlen;
    att->attbyval = typeForm->typbyval;
    att->attalign = typeForm->typalign;
    att->attstorage = typeForm->typstorage;
    att->attcompression = InvalidCompressionMethod;
    att->attcollation = typeForm->typcollation;
 
    populate_compact_attribute(desc, attributeNumber - 1);
 
    ReleaseSysCache(tuple);
}

References Assert(), elog, ERROR, GETSTRUCT(), HeapTupleIsValid, InvalidCompressionMethod, MemSet, NAMEDATALEN, NameStr, namestrcpy(), ObjectIdGetDatum(), PG_INT16_MAX, PointerIsValid, populate_compact_attribute(), ReleaseSysCache(), SearchSysCache1(), and TupleDescAttr().

Referenced by aclexplode(), addRangeTableEntryForFunction(), brtuple_disk_tupdesc(), build_function_result_tupdesc_d(), build_row_from_vars(), BuildDescForRelation(), BuildDescFromLists(), CallStmtResultDesc(), create_toast_table(), dblink_get_pkey(), ExecInitFunctionScan(), ExecMakeTableFunctionResult(), ExecTypeFromExprList(), ExecTypeFromTLInternal(), expandRecordVariable(), ExplainResultDesc(), get_expr_result_type(), GetPGVariableResultDesc(), gistrescan(), init_sexpr(), initGinState(), injection_points_stats_fixed(), libpqrcv_processTuples(), materializeResult(), ordered_set_startup(), pg_buffercache_numa_pages(), pg_buffercache_pages(), pg_get_publication_tables(), pg_get_sequence_data(), pg_lock_status(), pg_prepared_xact(), pg_stat_file(), pg_stat_get_archiver(), pg_stat_get_backend_subxact(), pg_stat_get_replication_slot(), pg_stat_get_subscription_stats(), pg_stat_wal_build_tuple(), pg_visibility_tupdesc(), pg_walfile_name_offset(), resolve_polymorphic_tupdesc(), show_all_settings(), test_predtest(), tsvector_unnest(), and TypeGetTupleDesc().

TupleDescInitEntryCollation()

void TupleDescInitEntryCollation	(	TupleDesc	desc,
		AttrNumber	attributeNumber,
		Oid	collationid
	)

Definition at line 1019 of file tupdesc.c.

{
    /*
     * sanity checks
     */
    Assert(PointerIsValid(desc));
    Assert(attributeNumber >= 1);
    Assert(attributeNumber <= desc->natts);
 
    TupleDescAttr(desc, attributeNumber - 1)->attcollation = collationid;
}

References Assert(), PointerIsValid, and TupleDescAttr().

Referenced by addRangeTableEntryForFunction(), build_row_from_vars(), BuildDescForRelation(), BuildDescFromLists(), ExecInitFunctionScan(), ExecTypeFromExprList(), ExecTypeFromTLInternal(), expandRecordVariable(), get_expr_result_type(), initGinState(), and resolve_polymorphic_tupdesc().

verify_compact_attribute()

void verify_compact_attribute	(	TupleDesc	tupdesc,
		int	attnum
	)

Definition at line 142 of file tupdesc.c.

{
#ifdef USE_ASSERT_CHECKING
    CompactAttribute *cattr = &tupdesc->compact_attrs[attnum];
    Form_pg_attribute attr = TupleDescAttr(tupdesc, attnum);
    CompactAttribute tmp;
 
    /*
     * Populate the temporary CompactAttribute from the corresponding
     * Form_pg_attribute
     */
    populate_compact_attribute_internal(attr, &tmp);
 
    /*
     * Make the attcacheoff match since it's been reset to -1 by
     * populate_compact_attribute_internal.  Same with attnullability.
     */
    tmp.attcacheoff = cattr->attcacheoff;
    tmp.attnullability = cattr->attnullability;
 
    /* Check the freshly populated CompactAttribute matches the TupleDesc's */
    Assert(memcmp(&tmp, cattr, sizeof(CompactAttribute)) == 0);
#endif
}

References Assert(), CompactAttribute::attcacheoff, CompactAttribute::attnullability, attnum, TupleDescData::compact_attrs, populate_compact_attribute_internal(), and TupleDescAttr().

Referenced by TupleDescCompactAttr().

Variable Documentation

tupdesc_resowner_desc

const ResourceOwnerDesc tupdesc_resowner_desc

static

Initial value:

=
{
    .name = "tupdesc reference",
    .release_phase = RESOURCE_RELEASE_AFTER_LOCKS,
    .release_priority = RELEASE_PRIO_TUPDESC_REFS,
    .ReleaseResource = ResOwnerReleaseTupleDesc,
    .DebugPrint = ResOwnerPrintTupleDesc
}

Definition at line 38 of file tupdesc.c.

Referenced by ResourceOwnerForgetTupleDesc(), and ResourceOwnerRememberTupleDesc().