Age Owner Branch data TLA Line data Source code
1 : : /*-------------------------------------------------------------------------
2 : : *
3 : : * printtup.c
4 : : * Routines to print out tuples to the destination (both frontend
5 : : * clients and standalone backends are supported here).
6 : : *
7 : : *
8 : : * Portions Copyright (c) 1996-2024, PostgreSQL Global Development Group
9 : : * Portions Copyright (c) 1994, Regents of the University of California
10 : : *
11 : : * IDENTIFICATION
12 : : * src/backend/access/common/printtup.c
13 : : *
14 : : *-------------------------------------------------------------------------
15 : : */
16 : : #include "postgres.h"
17 : :
18 : : #include "access/printtup.h"
19 : : #include "libpq/pqformat.h"
20 : : #include "tcop/pquery.h"
21 : : #include "utils/lsyscache.h"
22 : : #include "utils/memdebug.h"
23 : : #include "utils/memutils.h"
24 : :
25 : :
26 : : static void printtup_startup(DestReceiver *self, int operation,
27 : : TupleDesc typeinfo);
28 : : static bool printtup(TupleTableSlot *slot, DestReceiver *self);
29 : : static void printtup_shutdown(DestReceiver *self);
30 : : static void printtup_destroy(DestReceiver *self);
31 : :
32 : : /* ----------------------------------------------------------------
33 : : * printtup / debugtup support
34 : : * ----------------------------------------------------------------
35 : : */
36 : :
37 : : /* ----------------
38 : : * Private state for a printtup destination object
39 : : *
40 : : * NOTE: finfo is the lookup info for either typoutput or typsend, whichever
41 : : * we are using for this column.
42 : : * ----------------
43 : : */
44 : : typedef struct
45 : : { /* Per-attribute information */
46 : : Oid typoutput; /* Oid for the type's text output fn */
47 : : Oid typsend; /* Oid for the type's binary output fn */
48 : : bool typisvarlena; /* is it varlena (ie possibly toastable)? */
49 : : int16 format; /* format code for this column */
50 : : FmgrInfo finfo; /* Precomputed call info for output fn */
51 : : } PrinttupAttrInfo;
52 : :
53 : : typedef struct
54 : : {
55 : : DestReceiver pub; /* publicly-known function pointers */
56 : : Portal portal; /* the Portal we are printing from */
57 : : bool sendDescrip; /* send RowDescription at startup? */
58 : : TupleDesc attrinfo; /* The attr info we are set up for */
59 : : int nattrs;
60 : : PrinttupAttrInfo *myinfo; /* Cached info about each attr */
61 : : StringInfoData buf; /* output buffer (*not* in tmpcontext) */
62 : : MemoryContext tmpcontext; /* Memory context for per-row workspace */
63 : : } DR_printtup;
64 : :
65 : : /* ----------------
66 : : * Initialize: create a DestReceiver for printtup
67 : : * ----------------
68 : : */
69 : : DestReceiver *
5614 tgl@sss.pgh.pa.us 70 :CBC 277314 : printtup_create_DR(CommandDest dest)
71 : : {
72 : 277314 : DR_printtup *self = (DR_printtup *) palloc0(sizeof(DR_printtup));
73 : :
5421 bruce@momjian.us 74 : 277314 : self->pub.receiveSlot = printtup; /* might get changed later */
7557 tgl@sss.pgh.pa.us 75 : 277314 : self->pub.rStartup = printtup_startup;
76 : 277314 : self->pub.rShutdown = printtup_shutdown;
77 : 277314 : self->pub.rDestroy = printtup_destroy;
7649 78 : 277314 : self->pub.mydest = dest;
79 : :
80 : : /*
81 : : * Send T message automatically if DestRemote, but not if
82 : : * DestRemoteExecute
83 : : */
6737 alvherre@alvh.no-ip. 84 : 277314 : self->sendDescrip = (dest == DestRemote);
85 : :
9209 tgl@sss.pgh.pa.us 86 : 277314 : self->attrinfo = NULL;
87 : 277314 : self->nattrs = 0;
88 : 277314 : self->myinfo = NULL;
1854 89 : 277314 : self->buf.data = NULL;
3815 90 : 277314 : self->tmpcontext = NULL;
91 : :
9091 bruce@momjian.us 92 : 277314 : return (DestReceiver *) self;
93 : : }
94 : :
95 : : /*
96 : : * Set parameters for a DestRemote (or DestRemoteExecute) receiver
97 : : */
98 : : void
5614 tgl@sss.pgh.pa.us 99 : 277314 : SetRemoteDestReceiverParams(DestReceiver *self, Portal portal)
100 : : {
101 : 277314 : DR_printtup *myState = (DR_printtup *) self;
102 : :
103 [ + + - + ]: 277314 : Assert(myState->pub.mydest == DestRemote ||
104 : : myState->pub.mydest == DestRemoteExecute);
105 : :
106 : 277314 : myState->portal = portal;
107 : 277314 : }
108 : :
109 : : static void
7647 110 : 131745 : printtup_startup(DestReceiver *self, int operation, TupleDesc typeinfo)
111 : : {
7650 112 : 131745 : DR_printtup *myState = (DR_printtup *) self;
7559 bruce@momjian.us 113 : 131745 : Portal portal = myState->portal;
114 : :
115 : : /*
116 : : * Create I/O buffer to be used for all messages. This cannot be inside
117 : : * tmpcontext, since we want to re-use it across rows.
118 : : */
2377 andres@anarazel.de 119 : 131745 : initStringInfo(&myState->buf);
120 : :
121 : : /*
122 : : * Create a temporary memory context that we can reset once per row to
123 : : * recover palloc'd memory. This avoids any problems with leaks inside
124 : : * datatype output routines, and should be faster than retail pfree's
125 : : * anyway.
126 : : */
3815 tgl@sss.pgh.pa.us 127 : 131745 : myState->tmpcontext = AllocSetContextCreate(CurrentMemoryContext,
128 : : "printtup",
129 : : ALLOCSET_DEFAULT_SIZES);
130 : :
131 : : /*
132 : : * If we are supposed to emit row descriptions, then send the tuple
133 : : * descriptor of the tuples.
134 : : */
6455 135 [ + + ]: 131745 : if (myState->sendDescrip)
2377 andres@anarazel.de 136 : 127414 : SendRowDescriptionMessage(&myState->buf,
137 : : typeinfo,
138 : : FetchPortalTargetList(portal),
139 : : portal->formats);
140 : :
141 : : /* ----------------
142 : : * We could set up the derived attr info at this time, but we postpone it
143 : : * until the first call of printtup, for 2 reasons:
144 : : * 1. We don't waste time (compared to the old way) if there are no
145 : : * tuples at all to output.
146 : : * 2. Checking in printtup allows us to handle the case that the tuples
147 : : * change type midway through (although this probably can't happen in
148 : : * the current executor).
149 : : * ----------------
150 : : */
9209 tgl@sss.pgh.pa.us 151 : 131745 : }
152 : :
153 : : /*
154 : : * SendRowDescriptionMessage --- send a RowDescription message to the frontend
155 : : *
156 : : * Notes: the TupleDesc has typically been manufactured by ExecTypeFromTL()
157 : : * or some similar function; it does not contain a full set of fields.
158 : : * The targetlist will be NIL when executing a utility function that does
159 : : * not have a plan. If the targetlist isn't NIL then it is a Query node's
160 : : * targetlist; it is up to us to ignore resjunk columns in it. The formats[]
161 : : * array pointer might be NULL (if we are doing Describe on a prepared stmt);
162 : : * send zeroes for the format codes in that case.
163 : : */
164 : : void
2377 andres@anarazel.de 165 : 131791 : SendRowDescriptionMessage(StringInfo buf, TupleDesc typeinfo,
166 : : List *targetlist, int16 *formats)
167 : : {
7650 tgl@sss.pgh.pa.us 168 : 131791 : int natts = typeinfo->natts;
169 : : int i;
1137 heikki.linnakangas@i 170 : 131791 : ListCell *tlist_item = list_head(targetlist);
171 : :
172 : : /* tuple descriptor message type */
2377 andres@anarazel.de 173 : 131791 : pq_beginmessage_reuse(buf, 'T');
174 : : /* # of attrs in tuples */
175 : 131791 : pq_sendint16(buf, natts);
176 : :
177 : : /*
178 : : * Preallocate memory for the entire message to be sent. That allows to
179 : : * use the significantly faster inline pqformat.h functions and to avoid
180 : : * reallocations.
181 : : *
182 : : * Have to overestimate the size of the column-names, to account for
183 : : * character set overhead.
184 : : */
185 : 131791 : enlargeStringInfo(buf, (NAMEDATALEN * MAX_CONVERSION_GROWTH /* attname */
186 : : + sizeof(Oid) /* resorigtbl */
187 : : + sizeof(AttrNumber) /* resorigcol */
188 : : + sizeof(Oid) /* atttypid */
189 : : + sizeof(int16) /* attlen */
190 : : + sizeof(int32) /* attypmod */
191 : : + sizeof(int16) /* format */
192 : : ) * natts);
193 : :
7650 tgl@sss.pgh.pa.us 194 [ + + ]: 535976 : for (i = 0; i < natts; ++i)
195 : : {
2429 andres@anarazel.de 196 : 404185 : Form_pg_attribute att = TupleDescAttr(typeinfo, i);
197 : 404185 : Oid atttypid = att->atttypid;
198 : 404185 : int32 atttypmod = att->atttypmod;
199 : : Oid resorigtbl;
200 : : AttrNumber resorigcol;
201 : : int16 format;
202 : :
203 : : /*
204 : : * If column is a domain, send the base type and typmod instead.
205 : : * Lookup before sending any ints, for efficiency.
206 : : */
2377 207 : 404185 : atttypid = getBaseTypeAndTypmod(atttypid, &atttypmod);
208 : :
209 : : /* Do we have a non-resjunk tlist item? */
210 [ + + ]: 404185 : while (tlist_item &&
211 [ - + ]: 396715 : ((TargetEntry *) lfirst(tlist_item))->resjunk)
1735 tgl@sss.pgh.pa.us 212 :UBC 0 : tlist_item = lnext(targetlist, tlist_item);
2377 andres@anarazel.de 213 [ + + ]:CBC 404185 : if (tlist_item)
214 : : {
215 : 396715 : TargetEntry *tle = (TargetEntry *) lfirst(tlist_item);
216 : :
217 : 396715 : resorigtbl = tle->resorigtbl;
218 : 396715 : resorigcol = tle->resorigcol;
1735 tgl@sss.pgh.pa.us 219 : 396715 : tlist_item = lnext(targetlist, tlist_item);
220 : : }
221 : : else
222 : : {
223 : : /* No info available, so send zeroes */
2377 andres@anarazel.de 224 : 7470 : resorigtbl = 0;
225 : 7470 : resorigcol = 0;
226 : : }
227 : :
228 [ + + ]: 404185 : if (formats)
229 : 404050 : format = formats[i];
230 : : else
231 : 135 : format = 0;
232 : :
233 : 404185 : pq_writestring(buf, NameStr(att->attname));
234 : 404185 : pq_writeint32(buf, resorigtbl);
235 : 404185 : pq_writeint16(buf, resorigcol);
236 : 404185 : pq_writeint32(buf, atttypid);
237 : 404185 : pq_writeint16(buf, att->attlen);
238 : 404185 : pq_writeint32(buf, atttypmod);
239 : 404185 : pq_writeint16(buf, format);
240 : : }
241 : :
1137 heikki.linnakangas@i 242 : 131791 : pq_endmessage_reuse(buf);
7650 tgl@sss.pgh.pa.us 243 : 131791 : }
244 : :
245 : : /*
246 : : * Get the lookup info that printtup() needs
247 : : */
248 : : static void
9091 bruce@momjian.us 249 : 111720 : printtup_prepare_info(DR_printtup *myState, TupleDesc typeinfo, int numAttrs)
250 : : {
7646 tgl@sss.pgh.pa.us 251 : 111720 : int16 *formats = myState->portal->formats;
252 : : int i;
253 : :
254 : : /* get rid of any old data */
9209 255 [ + + ]: 111720 : if (myState->myinfo)
7254 256 : 793 : pfree(myState->myinfo);
9209 257 : 111720 : myState->myinfo = NULL;
258 : :
259 : 111720 : myState->attrinfo = typeinfo;
260 : 111720 : myState->nattrs = numAttrs;
261 [ + + ]: 111720 : if (numAttrs <= 0)
262 : 56 : return;
263 : :
9091 bruce@momjian.us 264 : 111664 : myState->myinfo = (PrinttupAttrInfo *)
7646 tgl@sss.pgh.pa.us 265 : 111664 : palloc0(numAttrs * sizeof(PrinttupAttrInfo));
266 : :
9209 267 [ + + ]: 436417 : for (i = 0; i < numAttrs; i++)
268 : : {
9091 bruce@momjian.us 269 : 324753 : PrinttupAttrInfo *thisState = myState->myinfo + i;
7646 tgl@sss.pgh.pa.us 270 [ + + ]: 324753 : int16 format = (formats ? formats[i] : 0);
2429 andres@anarazel.de 271 : 324753 : Form_pg_attribute attr = TupleDescAttr(typeinfo, i);
272 : :
7646 tgl@sss.pgh.pa.us 273 : 324753 : thisState->format = format;
274 [ + + ]: 324753 : if (format == 0)
275 : : {
2429 andres@anarazel.de 276 : 324714 : getTypeOutputInfo(attr->atttypid,
277 : : &thisState->typoutput,
278 : : &thisState->typisvarlena);
9209 tgl@sss.pgh.pa.us 279 : 324714 : fmgr_info(thisState->typoutput, &thisState->finfo);
280 : : }
7646 281 [ + - ]: 39 : else if (format == 1)
282 : : {
2429 andres@anarazel.de 283 : 39 : getTypeBinaryOutputInfo(attr->atttypid,
284 : : &thisState->typsend,
285 : : &thisState->typisvarlena);
7646 tgl@sss.pgh.pa.us 286 : 39 : fmgr_info(thisState->typsend, &thisState->finfo);
287 : : }
288 : : else
7573 tgl@sss.pgh.pa.us 289 [ # # ]:UBC 0 : ereport(ERROR,
290 : : (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
291 : : errmsg("unsupported format code: %d", format)));
292 : : }
293 : : }
294 : :
295 : : /* ----------------
296 : : * printtup --- send a tuple to the client
297 : : *
298 : : * Note: if you change this function, see also serializeAnalyzeReceive
299 : : * in explain.c, which is meant to replicate the computations done here.
300 : : * ----------------
301 : : */
302 : : static bool
6969 tgl@sss.pgh.pa.us 303 :CBC 3212811 : printtup(TupleTableSlot *slot, DestReceiver *self)
304 : : {
6756 bruce@momjian.us 305 : 3212811 : TupleDesc typeinfo = slot->tts_tupleDescriptor;
7647 tgl@sss.pgh.pa.us 306 : 3212811 : DR_printtup *myState = (DR_printtup *) self;
307 : : MemoryContext oldcontext;
2377 andres@anarazel.de 308 : 3212811 : StringInfo buf = &myState->buf;
7629 tgl@sss.pgh.pa.us 309 : 3212811 : int natts = typeinfo->natts;
310 : : int i;
311 : :
312 : : /* Set or update my derived attribute info, if needed */
7647 313 [ + + - + ]: 3212811 : if (myState->attrinfo != typeinfo || myState->nattrs != natts)
314 : 111720 : printtup_prepare_info(myState, typeinfo, natts);
315 : :
316 : : /* Make sure the tuple is fully deconstructed */
6969 317 : 3212811 : slot_getallattrs(slot);
318 : :
319 : : /* Switch into per-row context so we can recover memory below */
3815 320 : 3212811 : oldcontext = MemoryContextSwitchTo(myState->tmpcontext);
321 : :
322 : : /*
323 : : * Prepare a DataRow message (note buffer is in per-query context)
324 : : */
2377 andres@anarazel.de 325 : 3212811 : pq_beginmessage_reuse(buf, 'D');
326 : :
327 : 3212811 : pq_sendint16(buf, natts);
328 : :
329 : : /*
330 : : * send the attributes of this tuple
331 : : */
7647 tgl@sss.pgh.pa.us 332 [ + + ]: 17532775 : for (i = 0; i < natts; ++i)
333 : : {
334 : 14319964 : PrinttupAttrInfo *thisState = myState->myinfo + i;
3815 335 : 14319964 : Datum attr = slot->tts_values[i];
336 : :
6969 337 [ + + ]: 14319964 : if (slot->tts_isnull[i])
338 : : {
2377 andres@anarazel.de 339 : 703738 : pq_sendint32(buf, -1);
7647 tgl@sss.pgh.pa.us 340 : 703738 : continue;
341 : : }
342 : :
343 : : /*
344 : : * Here we catch undefined bytes in datums that are returned to the
345 : : * client without hitting disk; see comments at the related check in
346 : : * PageAddItem(). This test is most useful for uncompressed,
347 : : * non-external datums, but we're quite likely to see such here when
348 : : * testing new C functions.
349 : : */
7646 350 : 13616226 : if (thisState->typisvarlena)
351 : : VALGRIND_CHECK_MEM_IS_DEFINED(DatumGetPointer(attr),
352 : : VARSIZE_ANY(attr));
353 : :
354 [ + + ]: 13616226 : if (thisState->format == 0)
355 : : {
356 : : /* Text output */
357 : : char *outputstr;
358 : :
6585 359 : 13608924 : outputstr = OutputFunctionCall(&thisState->finfo, attr);
41 heikki.linnakangas@i 360 :GNC 13608924 : pq_sendcountedtext(buf, outputstr, strlen(outputstr));
361 : : }
362 : : else
363 : : {
364 : : /* Binary output */
365 : : bytea *outputbytes;
366 : :
6585 tgl@sss.pgh.pa.us 367 :CBC 7302 : outputbytes = SendFunctionCall(&thisState->finfo, attr);
2377 andres@anarazel.de 368 : 7302 : pq_sendint32(buf, VARSIZE(outputbytes) - VARHDRSZ);
369 : 7302 : pq_sendbytes(buf, VARDATA(outputbytes),
7646 tgl@sss.pgh.pa.us 370 : 7302 : VARSIZE(outputbytes) - VARHDRSZ);
371 : : }
372 : : }
373 : :
2377 andres@anarazel.de 374 : 3212811 : pq_endmessage_reuse(buf);
375 : :
376 : : /* Return to caller's context, and flush row's temporary memory */
3815 tgl@sss.pgh.pa.us 377 : 3212811 : MemoryContextSwitchTo(oldcontext);
378 : 3212811 : MemoryContextReset(myState->tmpcontext);
379 : :
2869 rhaas@postgresql.org 380 : 3212811 : return true;
381 : : }
382 : :
383 : : /* ----------------
384 : : * printtup_shutdown
385 : : * ----------------
386 : : */
387 : : static void
7649 tgl@sss.pgh.pa.us 388 : 128541 : printtup_shutdown(DestReceiver *self)
389 : : {
9091 bruce@momjian.us 390 : 128541 : DR_printtup *myState = (DR_printtup *) self;
391 : :
9209 tgl@sss.pgh.pa.us 392 [ + + ]: 128541 : if (myState->myinfo)
393 : 110777 : pfree(myState->myinfo);
7649 394 : 128541 : myState->myinfo = NULL;
395 : :
396 : 128541 : myState->attrinfo = NULL;
397 : :
1854 398 [ + - ]: 128541 : if (myState->buf.data)
399 : 128541 : pfree(myState->buf.data);
400 : 128541 : myState->buf.data = NULL;
401 : :
3815 402 [ + - ]: 128541 : if (myState->tmpcontext)
403 : 128541 : MemoryContextDelete(myState->tmpcontext);
404 : 128541 : myState->tmpcontext = NULL;
7649 405 : 128541 : }
406 : :
407 : : /* ----------------
408 : : * printtup_destroy
409 : : * ----------------
410 : : */
411 : : static void
412 : 264432 : printtup_destroy(DestReceiver *self)
413 : : {
414 : 264432 : pfree(self);
9209 415 : 264432 : }
416 : :
417 : : /* ----------------
418 : : * printatt
419 : : * ----------------
420 : : */
421 : : static void
10141 scrappy@hub.org 422 : 148 : printatt(unsigned attributeId,
423 : : Form_pg_attribute attributeP,
424 : : char *value)
425 : : {
9467 bruce@momjian.us 426 [ + - + + : 148 : printf("\t%2d: %s%s%s%s\t(typeid = %u, len = %d, typmod = %d, byval = %c)\n",
+ + + + ]
427 : : attributeId,
428 : : NameStr(attributeP->attname),
429 : : value != NULL ? " = \"" : "",
430 : : value != NULL ? value : "",
431 : : value != NULL ? "\"" : "",
432 : : (unsigned int) (attributeP->atttypid),
433 : : attributeP->attlen,
434 : : attributeP->atttypmod,
435 : : attributeP->attbyval ? 't' : 'f');
10141 scrappy@hub.org 436 : 148 : }
437 : :
438 : : /* ----------------
439 : : * debugStartup - prepare to print tuples for an interactive backend
440 : : * ----------------
441 : : */
442 : : void
7647 tgl@sss.pgh.pa.us 443 : 74 : debugStartup(DestReceiver *self, int operation, TupleDesc typeinfo)
444 : : {
445 : 74 : int natts = typeinfo->natts;
446 : : int i;
447 : :
448 : : /*
449 : : * show the return type of the tuples
450 : : */
451 [ + + ]: 148 : for (i = 0; i < natts; ++i)
2429 andres@anarazel.de 452 : 74 : printatt((unsigned) i + 1, TupleDescAttr(typeinfo, i), NULL);
7647 tgl@sss.pgh.pa.us 453 : 74 : printf("\t----\n");
8082 454 : 74 : }
455 : :
456 : : /* ----------------
457 : : * debugtup - print one tuple for an interactive backend
458 : : * ----------------
459 : : */
460 : : bool
6969 461 : 74 : debugtup(TupleTableSlot *slot, DestReceiver *self)
462 : : {
463 : 74 : TupleDesc typeinfo = slot->tts_tupleDescriptor;
7629 464 : 74 : int natts = typeinfo->natts;
465 : : int i;
466 : : Datum attr;
467 : : char *value;
468 : : bool isnull;
469 : : Oid typoutput;
470 : : bool typisvarlena;
471 : :
8535 472 [ + + ]: 148 : for (i = 0; i < natts; ++i)
473 : : {
3815 474 : 74 : attr = slot_getattr(slot, i + 1, &isnull);
9212 475 [ - + ]: 74 : if (isnull)
9212 tgl@sss.pgh.pa.us 476 :UBC 0 : continue;
2429 andres@anarazel.de 477 :CBC 74 : getTypeOutputInfo(TupleDescAttr(typeinfo, i)->atttypid,
478 : : &typoutput, &typisvarlena);
479 : :
6585 tgl@sss.pgh.pa.us 480 : 74 : value = OidOutputFunctionCall(typoutput, attr);
481 : :
2429 andres@anarazel.de 482 : 74 : printatt((unsigned) i + 1, TupleDescAttr(typeinfo, i), value);
483 : : }
9716 bruce@momjian.us 484 : 74 : printf("\t----\n");
485 : :
2869 rhaas@postgresql.org 486 : 74 : return true;
487 : : }
|
