printtup.c File Reference

#include "postgres.h"
#include "access/printtup.h"
#include "libpq/libpq.h"
#include "libpq/pqformat.h"
#include "tcop/pquery.h"
#include "utils/lsyscache.h"
#include "utils/memdebug.h"
#include "utils/memutils.h"

Include dependency graph for printtup.c:

Go to the source code of this file.

Data Structures
struct	PrinttupAttrInfo
struct	DR_printtup

Functions
static void	printtup_startup (DestReceiver *self, int operation, TupleDesc typeinfo)
static bool	printtup (TupleTableSlot *slot, DestReceiver *self)
static bool	printtup_20 (TupleTableSlot *slot, DestReceiver *self)
static bool	printtup_internal_20 (TupleTableSlot *slot, DestReceiver *self)
static void	printtup_shutdown (DestReceiver *self)
static void	printtup_destroy (DestReceiver *self)
DestReceiver *	printtup_create_DR (CommandDest dest)
void	SetRemoteDestReceiverParams (DestReceiver *self, Portal portal)
void	SendRowDescriptionMessage (TupleDesc typeinfo, List *targetlist, int16 *formats)
static void	printtup_prepare_info (DR_printtup *myState, TupleDesc typeinfo, int numAttrs)
static void	printatt (unsigned attributeId, Form_pg_attribute attributeP, char *value)
void	debugStartup (DestReceiver *self, int operation, TupleDesc typeinfo)
bool	debugtup (TupleTableSlot *slot, DestReceiver *self)

Function Documentation

void debugStartup	(	DestReceiver *	self,
		int	operation,
		TupleDesc	typeinfo
	)

Definition at line 514 of file printtup.c.

References i, tupleDesc::natts, NULL, printatt(), and TupleDescAttr.

{
    int         natts = typeinfo->natts;
    int         i;

    /*
     * show the return type of the tuples
     */
    for (i = 0; i < natts; ++i)
        printatt((unsigned) i + 1, TupleDescAttr(typeinfo, i), NULL);
    printf("\t----\n");
}

bool debugtup	(	TupleTableSlot *	slot,
		DestReceiver *	self
	)

Definition at line 532 of file printtup.c.

References getTypeOutputInfo(), i, tupleDesc::natts, OidOutputFunctionCall(), printatt(), slot_getattr(), TupleTableSlot::tts_tupleDescriptor, TupleDescAttr, and value.

Referenced by print_slot().

{
    TupleDesc   typeinfo = slot->tts_tupleDescriptor;
    int         natts = typeinfo->natts;
    int         i;
    Datum       attr;
    char       *value;
    bool        isnull;
    Oid         typoutput;
    bool        typisvarlena;

    for (i = 0; i < natts; ++i)
    {
        attr = slot_getattr(slot, i + 1, &isnull);
        if (isnull)
            continue;
        getTypeOutputInfo(TupleDescAttr(typeinfo, i)->atttypid,
                          &typoutput, &typisvarlena);

        value = OidOutputFunctionCall(typoutput, attr);

        printatt((unsigned) i + 1, TupleDescAttr(typeinfo, i), value);
    }
    printf("\t----\n");

    return true;
}

static void printatt ( unsigned  attributeId, Form_pg_attribute  attributeP, char *  value  )

static

Definition at line 493 of file printtup.c.

References NameStr, and NULL.

Referenced by debugStartup(), and debugtup().

{
    printf("\t%2d: %s%s%s%s\t(typeid = %u, len = %d, typmod = %d, byval = %c)\n",
           attributeId,
           NameStr(attributeP->attname),
           value != NULL ? " = \"" : "",
           value != NULL ? value : "",
           value != NULL ? "\"" : "",
           (unsigned int) (attributeP->atttypid),
           attributeP->attlen,
           attributeP->atttypmod,
           attributeP->attbyval ? 't' : 'f');
}

static bool printtup ( TupleTableSlot *  slot, DestReceiver *  self  )

static

Definition at line 300 of file printtup.c.

References DR_printtup::attrinfo, buf, DatumGetPointer, PrinttupAttrInfo::finfo, PrinttupAttrInfo::format, i, MemoryContextReset(), MemoryContextSwitchTo(), DR_printtup::myinfo, DR_printtup::nattrs, tupleDesc::natts, OutputFunctionCall(), pq_beginmessage(), pq_endmessage(), pq_sendbytes(), pq_sendcountedtext(), pq_sendint(), printtup_prepare_info(), SendFunctionCall(), slot_getallattrs(), DR_printtup::tmpcontext, TupleTableSlot::tts_isnull, TupleTableSlot::tts_tupleDescriptor, TupleTableSlot::tts_values, PrinttupAttrInfo::typisvarlena, VALGRIND_CHECK_MEM_IS_DEFINED, VARDATA, VARHDRSZ, VARSIZE, and VARSIZE_ANY.

Referenced by printtup_create_DR().

{
    TupleDesc   typeinfo = slot->tts_tupleDescriptor;
    DR_printtup *myState = (DR_printtup *) self;
    MemoryContext oldcontext;
    StringInfoData buf;
    int         natts = typeinfo->natts;
    int         i;

    /* Set or update my derived attribute info, if needed */
    if (myState->attrinfo != typeinfo || myState->nattrs != natts)
        printtup_prepare_info(myState, typeinfo, natts);

    /* Make sure the tuple is fully deconstructed */
    slot_getallattrs(slot);

    /* Switch into per-row context so we can recover memory below */
    oldcontext = MemoryContextSwitchTo(myState->tmpcontext);

    /*
     * Prepare a DataRow message (note buffer is in per-row context)
     */
    pq_beginmessage(&buf, 'D');

    pq_sendint(&buf, natts, 2);

    /*
     * send the attributes of this tuple
     */
    for (i = 0; i < natts; ++i)
    {
        PrinttupAttrInfo *thisState = myState->myinfo + i;
        Datum       attr = slot->tts_values[i];

        if (slot->tts_isnull[i])
        {
            pq_sendint(&buf, -1, 4);
            continue;
        }

        /*
         * Here we catch undefined bytes in datums that are returned to the
         * client without hitting disk; see comments at the related check in
         * PageAddItem().  This test is most useful for uncompressed,
         * non-external datums, but we're quite likely to see such here when
         * testing new C functions.
         */
        if (thisState->typisvarlena)
            VALGRIND_CHECK_MEM_IS_DEFINED(DatumGetPointer(attr),
                                          VARSIZE_ANY(attr));

        if (thisState->format == 0)
        {
            /* Text output */
            char       *outputstr;

            outputstr = OutputFunctionCall(&thisState->finfo, attr);
            pq_sendcountedtext(&buf, outputstr, strlen(outputstr), false);
        }
        else
        {
            /* Binary output */
            bytea      *outputbytes;

            outputbytes = SendFunctionCall(&thisState->finfo, attr);
            pq_sendint(&buf, VARSIZE(outputbytes) - VARHDRSZ, 4);
            pq_sendbytes(&buf, VARDATA(outputbytes),
                         VARSIZE(outputbytes) - VARHDRSZ);
        }
    }

    pq_endmessage(&buf);

    /* Return to caller's context, and flush row's temporary memory */
    MemoryContextSwitchTo(oldcontext);
    MemoryContextReset(myState->tmpcontext);

    return true;
}

static bool printtup_20 ( TupleTableSlot *  slot, DestReceiver *  self  )

static

Definition at line 385 of file printtup.c.

References Assert, DR_printtup::attrinfo, buf, PrinttupAttrInfo::finfo, PrinttupAttrInfo::format, i, MemoryContextReset(), MemoryContextSwitchTo(), DR_printtup::myinfo, DR_printtup::nattrs, tupleDesc::natts, OutputFunctionCall(), pq_beginmessage(), pq_endmessage(), pq_sendcountedtext(), pq_sendint(), printtup_prepare_info(), slot_getallattrs(), DR_printtup::tmpcontext, TupleTableSlot::tts_isnull, TupleTableSlot::tts_tupleDescriptor, and TupleTableSlot::tts_values.

Referenced by SetRemoteDestReceiverParams().

{
    TupleDesc   typeinfo = slot->tts_tupleDescriptor;
    DR_printtup *myState = (DR_printtup *) self;
    MemoryContext oldcontext;
    StringInfoData buf;
    int         natts = typeinfo->natts;
    int         i,
                j,
                k;

    /* Set or update my derived attribute info, if needed */
    if (myState->attrinfo != typeinfo || myState->nattrs != natts)
        printtup_prepare_info(myState, typeinfo, natts);

    /* Make sure the tuple is fully deconstructed */
    slot_getallattrs(slot);

    /* Switch into per-row context so we can recover memory below */
    oldcontext = MemoryContextSwitchTo(myState->tmpcontext);

    /*
     * tell the frontend to expect new tuple data (in ASCII style)
     */
    pq_beginmessage(&buf, 'D');

    /*
     * send a bitmap of which attributes are not null
     */
    j = 0;
    k = 1 << 7;
    for (i = 0; i < natts; ++i)
    {
        if (!slot->tts_isnull[i])
            j |= k;             /* set bit if not null */
        k >>= 1;
        if (k == 0)             /* end of byte? */
        {
            pq_sendint(&buf, j, 1);
            j = 0;
            k = 1 << 7;
        }
    }
    if (k != (1 << 7))          /* flush last partial byte */
        pq_sendint(&buf, j, 1);

    /*
     * send the attributes of this tuple
     */
    for (i = 0; i < natts; ++i)
    {
        PrinttupAttrInfo *thisState = myState->myinfo + i;
        Datum       attr = slot->tts_values[i];
        char       *outputstr;

        if (slot->tts_isnull[i])
            continue;

        Assert(thisState->format == 0);

        outputstr = OutputFunctionCall(&thisState->finfo, attr);
        pq_sendcountedtext(&buf, outputstr, strlen(outputstr), true);
    }

    pq_endmessage(&buf);

    /* Return to caller's context, and flush row's temporary memory */
    MemoryContextSwitchTo(oldcontext);
    MemoryContextReset(myState->tmpcontext);

    return true;
}

DestReceiver* printtup_create_DR

(

CommandDest

dest

)

Definition at line 73 of file printtup.c.

References DestRemote, NULL, palloc0(), printtup(), printtup_destroy(), printtup_shutdown(), and printtup_startup().

Referenced by CreateDestReceiver().

{
    DR_printtup *self = (DR_printtup *) palloc0(sizeof(DR_printtup));

    self->pub.receiveSlot = printtup;   /* might get changed later */
    self->pub.rStartup = printtup_startup;
    self->pub.rShutdown = printtup_shutdown;
    self->pub.rDestroy = printtup_destroy;
    self->pub.mydest = dest;

    /*
     * Send T message automatically if DestRemote, but not if
     * DestRemoteExecute
     */
    self->sendDescrip = (dest == DestRemote);

    self->attrinfo = NULL;
    self->nattrs = 0;
    self->myinfo = NULL;
    self->tmpcontext = NULL;

    return (DestReceiver *) self;
}

static void printtup_destroy ( DestReceiver *  self )

static

Definition at line 483 of file printtup.c.

References pfree().

Referenced by printtup_create_DR().

{
    pfree(self);
}

static bool printtup_internal_20 ( TupleTableSlot *  slot, DestReceiver *  self  )

static

Definition at line 570 of file printtup.c.

References Assert, DR_printtup::attrinfo, buf, PrinttupAttrInfo::finfo, PrinttupAttrInfo::format, i, MemoryContextReset(), MemoryContextSwitchTo(), DR_printtup::myinfo, DR_printtup::nattrs, tupleDesc::natts, pq_beginmessage(), pq_endmessage(), pq_sendbytes(), pq_sendint(), printtup_prepare_info(), SendFunctionCall(), slot_getallattrs(), DR_printtup::tmpcontext, TupleTableSlot::tts_isnull, TupleTableSlot::tts_tupleDescriptor, TupleTableSlot::tts_values, VARDATA, VARHDRSZ, and VARSIZE.

Referenced by SetRemoteDestReceiverParams().

{
    TupleDesc   typeinfo = slot->tts_tupleDescriptor;
    DR_printtup *myState = (DR_printtup *) self;
    MemoryContext oldcontext;
    StringInfoData buf;
    int         natts = typeinfo->natts;
    int         i,
                j,
                k;

    /* Set or update my derived attribute info, if needed */
    if (myState->attrinfo != typeinfo || myState->nattrs != natts)
        printtup_prepare_info(myState, typeinfo, natts);

    /* Make sure the tuple is fully deconstructed */
    slot_getallattrs(slot);

    /* Switch into per-row context so we can recover memory below */
    oldcontext = MemoryContextSwitchTo(myState->tmpcontext);

    /*
     * tell the frontend to expect new tuple data (in binary style)
     */
    pq_beginmessage(&buf, 'B');

    /*
     * send a bitmap of which attributes are not null
     */
    j = 0;
    k = 1 << 7;
    for (i = 0; i < natts; ++i)
    {
        if (!slot->tts_isnull[i])
            j |= k;             /* set bit if not null */
        k >>= 1;
        if (k == 0)             /* end of byte? */
        {
            pq_sendint(&buf, j, 1);
            j = 0;
            k = 1 << 7;
        }
    }
    if (k != (1 << 7))          /* flush last partial byte */
        pq_sendint(&buf, j, 1);

    /*
     * send the attributes of this tuple
     */
    for (i = 0; i < natts; ++i)
    {
        PrinttupAttrInfo *thisState = myState->myinfo + i;
        Datum       attr = slot->tts_values[i];
        bytea      *outputbytes;

        if (slot->tts_isnull[i])
            continue;

        Assert(thisState->format == 1);

        outputbytes = SendFunctionCall(&thisState->finfo, attr);
        pq_sendint(&buf, VARSIZE(outputbytes) - VARHDRSZ, 4);
        pq_sendbytes(&buf, VARDATA(outputbytes),
                     VARSIZE(outputbytes) - VARHDRSZ);
    }

    pq_endmessage(&buf);

    /* Return to caller's context, and flush row's temporary memory */
    MemoryContextSwitchTo(oldcontext);
    MemoryContextReset(myState->tmpcontext);

    return true;
}

static void printtup_prepare_info ( DR_printtup *  myState, TupleDesc  typeinfo, int  numAttrs  )

static

Definition at line 249 of file printtup.c.

References DR_printtup::attrinfo, ereport, errcode(), errmsg(), ERROR, PrinttupAttrInfo::finfo, fmgr_info(), PrinttupAttrInfo::format, format, PortalData::formats, getTypeBinaryOutputInfo(), getTypeOutputInfo(), i, DR_printtup::myinfo, DR_printtup::nattrs, NULL, palloc0(), pfree(), DR_printtup::portal, TupleDescAttr, PrinttupAttrInfo::typisvarlena, PrinttupAttrInfo::typoutput, and PrinttupAttrInfo::typsend.

Referenced by printtup(), printtup_20(), and printtup_internal_20().

{
    int16      *formats = myState->portal->formats;
    int         i;

    /* get rid of any old data */
    if (myState->myinfo)
        pfree(myState->myinfo);
    myState->myinfo = NULL;

    myState->attrinfo = typeinfo;
    myState->nattrs = numAttrs;
    if (numAttrs <= 0)
        return;

    myState->myinfo = (PrinttupAttrInfo *)
        palloc0(numAttrs * sizeof(PrinttupAttrInfo));

    for (i = 0; i < numAttrs; i++)
    {
        PrinttupAttrInfo *thisState = myState->myinfo + i;
        int16       format = (formats ? formats[i] : 0);
        Form_pg_attribute attr = TupleDescAttr(typeinfo, i);

        thisState->format = format;
        if (format == 0)
        {
            getTypeOutputInfo(attr->atttypid,
                              &thisState->typoutput,
                              &thisState->typisvarlena);
            fmgr_info(thisState->typoutput, &thisState->finfo);
        }
        else if (format == 1)
        {
            getTypeBinaryOutputInfo(attr->atttypid,
                                    &thisState->typsend,
                                    &thisState->typisvarlena);
            fmgr_info(thisState->typsend, &thisState->finfo);
        }
        else
            ereport(ERROR,
                    (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
                     errmsg("unsupported format code: %d", format)));
    }
}

static void printtup_shutdown ( DestReceiver *  self )

static

Definition at line 463 of file printtup.c.

References DR_printtup::attrinfo, MemoryContextDelete(), DR_printtup::myinfo, NULL, pfree(), and DR_printtup::tmpcontext.

Referenced by printtup_create_DR().

{
    DR_printtup *myState = (DR_printtup *) self;

    if (myState->myinfo)
        pfree(myState->myinfo);
    myState->myinfo = NULL;

    myState->attrinfo = NULL;

    if (myState->tmpcontext)
        MemoryContextDelete(myState->tmpcontext);
    myState->tmpcontext = NULL;
}

static void printtup_startup ( DestReceiver *  self, int  operation, TupleDesc  typeinfo  )

static

Definition at line 125 of file printtup.c.

References ALLOCSET_DEFAULT_SIZES, AllocSetContextCreate(), CurrentMemoryContext, FetchPortalTargetList(), PortalData::formats, FrontendProtocol, PortalData::name, NULL, PG_PROTOCOL_MAJOR, DR_printtup::portal, pq_puttextmessage(), DR_printtup::sendDescrip, SendRowDescriptionMessage(), and DR_printtup::tmpcontext.

Referenced by printtup_create_DR().

{
    DR_printtup *myState = (DR_printtup *) self;
    Portal      portal = myState->portal;

    /*
     * Create a temporary memory context that we can reset once per row to
     * recover palloc'd memory.  This avoids any problems with leaks inside
     * datatype output routines, and should be faster than retail pfree's
     * anyway.
     */
    myState->tmpcontext = AllocSetContextCreate(CurrentMemoryContext,
                                                "printtup",
                                                ALLOCSET_DEFAULT_SIZES);

    if (PG_PROTOCOL_MAJOR(FrontendProtocol) < 3)
    {
        /*
         * Send portal name to frontend (obsolete cruft, gone in proto 3.0)
         *
         * If portal name not specified, use "blank" portal.
         */
        const char *portalName = portal->name;

        if (portalName == NULL || portalName[0] == '\0')
            portalName = "blank";

        pq_puttextmessage('P', portalName);
    }

    /*
     * If we are supposed to emit row descriptions, then send the tuple
     * descriptor of the tuples.
     */
    if (myState->sendDescrip)
        SendRowDescriptionMessage(typeinfo,
                                  FetchPortalTargetList(portal),
                                  portal->formats);

    /* ----------------
     * We could set up the derived attr info at this time, but we postpone it
     * until the first call of printtup, for 2 reasons:
     * 1. We don't waste time (compared to the old way) if there are no
     *    tuples at all to output.
     * 2. Checking in printtup allows us to handle the case that the tuples
     *    change type midway through (although this probably can't happen in
     *    the current executor).
     * ----------------
     */
}

void SendRowDescriptionMessage	(	TupleDesc	typeinfo,
		List *	targetlist,
		int16 *	formats
	)

Definition at line 188 of file printtup.c.

References buf, FrontendProtocol, getBaseTypeAndTypmod(), i, lfirst, list_head(), lnext, NameStr, tupleDesc::natts, PG_PROTOCOL_MAJOR, pq_beginmessage(), pq_endmessage(), pq_sendint(), pq_sendstring(), TargetEntry::resorigcol, TargetEntry::resorigtbl, and TupleDescAttr.

Referenced by exec_describe_portal_message(), exec_describe_statement_message(), and printtup_startup().

{
    int         natts = typeinfo->natts;
    int         proto = PG_PROTOCOL_MAJOR(FrontendProtocol);
    int         i;
    StringInfoData buf;
    ListCell   *tlist_item = list_head(targetlist);

    pq_beginmessage(&buf, 'T'); /* tuple descriptor message type */
    pq_sendint(&buf, natts, 2); /* # of attrs in tuples */

    for (i = 0; i < natts; ++i)
    {
        Form_pg_attribute att = TupleDescAttr(typeinfo, i);
        Oid         atttypid = att->atttypid;
        int32       atttypmod = att->atttypmod;

        pq_sendstring(&buf, NameStr(att->attname));
        /* column ID info appears in protocol 3.0 and up */
        if (proto >= 3)
        {
            /* Do we have a non-resjunk tlist item? */
            while (tlist_item &&
                   ((TargetEntry *) lfirst(tlist_item))->resjunk)
                tlist_item = lnext(tlist_item);
            if (tlist_item)
            {
                TargetEntry *tle = (TargetEntry *) lfirst(tlist_item);

                pq_sendint(&buf, tle->resorigtbl, 4);
                pq_sendint(&buf, tle->resorigcol, 2);
                tlist_item = lnext(tlist_item);
            }
            else
            {
                /* No info available, so send zeroes */
                pq_sendint(&buf, 0, 4);
                pq_sendint(&buf, 0, 2);
            }
        }
        /* If column is a domain, send the base type and typmod instead */
        atttypid = getBaseTypeAndTypmod(atttypid, &atttypmod);
        pq_sendint(&buf, (int) atttypid, sizeof(atttypid));
        pq_sendint(&buf, att->attlen, sizeof(att->attlen));
        pq_sendint(&buf, atttypmod, sizeof(atttypmod));
        /* format info appears in protocol 3.0 and up */
        if (proto >= 3)
        {
            if (formats)
                pq_sendint(&buf, formats[i], 2);
            else
                pq_sendint(&buf, 0, 2);
        }
    }
    pq_endmessage(&buf);
}

void SetRemoteDestReceiverParams	(	DestReceiver *	self,
		Portal	portal
	)

Definition at line 101 of file printtup.c.

References Assert, DestRemote, DestRemoteExecute, PortalData::formats, FrontendProtocol, _DestReceiver::mydest, PG_PROTOCOL_MAJOR, DR_printtup::portal, printtup_20(), printtup_internal_20(), DR_printtup::pub, and _DestReceiver::receiveSlot.

Referenced by exec_execute_message(), and exec_simple_query().

{
    DR_printtup *myState = (DR_printtup *) self;

    Assert(myState->pub.mydest == DestRemote ||
           myState->pub.mydest == DestRemoteExecute);

    myState->portal = portal;

    if (PG_PROTOCOL_MAJOR(FrontendProtocol) < 3)
    {
        /*
         * In protocol 2.0 the Bind message does not exist, so there is no way
         * for the columns to have different print formats; it's sufficient to
         * look at the first one.
         */
        if (portal->formats && portal->formats[0] != 0)
            myState->pub.receiveSlot = printtup_internal_20;
        else
            myState->pub.receiveSlot = printtup_20;
    }
}