Line data Source code
1 : /*-------------------------------------------------------------------------
2 : *
3 : * execTuples.c
4 : * Routines dealing with TupleTableSlots. These are used for resource
5 : * management associated with tuples (eg, releasing buffer pins for
6 : * tuples in disk buffers, or freeing the memory occupied by transient
7 : * tuples). Slots also provide access abstraction that lets us implement
8 : * "virtual" tuples to reduce data-copying overhead.
9 : *
10 : * Routines dealing with the type information for tuples. Currently,
11 : * the type information for a tuple is an array of FormData_pg_attribute.
12 : * This information is needed by routines manipulating tuples
13 : * (getattribute, formtuple, etc.).
14 : *
15 : *
16 : * EXAMPLE OF HOW TABLE ROUTINES WORK
17 : * Suppose we have a query such as SELECT emp.name FROM emp and we have
18 : * a single SeqScan node in the query plan.
19 : *
20 : * At ExecutorStart()
21 : * ----------------
22 : *
23 : * - ExecInitSeqScan() calls ExecInitScanTupleSlot() to construct a
24 : * TupleTableSlots for the tuples returned by the access method, and
25 : * ExecInitResultTypeTL() to define the node's return
26 : * type. ExecAssignScanProjectionInfo() will, if necessary, create
27 : * another TupleTableSlot for the tuples resulting from performing
28 : * target list projections.
29 : *
30 : * During ExecutorRun()
31 : * ----------------
32 : * - SeqNext() calls ExecStoreBufferHeapTuple() to place the tuple
33 : * returned by the access method into the scan tuple slot.
34 : *
35 : * - ExecSeqScan() (via ExecScan), if necessary, calls ExecProject(),
36 : * putting the result of the projection in the result tuple slot. If
37 : * not necessary, it directly returns the slot returned by SeqNext().
38 : *
39 : * - ExecutePlan() calls the output function.
40 : *
41 : * The important thing to watch in the executor code is how pointers
42 : * to the slots containing tuples are passed instead of the tuples
43 : * themselves. This facilitates the communication of related information
44 : * (such as whether or not a tuple should be pfreed, what buffer contains
45 : * this tuple, the tuple's tuple descriptor, etc). It also allows us
46 : * to avoid physically constructing projection tuples in many cases.
47 : *
48 : *
49 : * Portions Copyright (c) 1996-2025, PostgreSQL Global Development Group
50 : * Portions Copyright (c) 1994, Regents of the University of California
51 : *
52 : *
53 : * IDENTIFICATION
54 : * src/backend/executor/execTuples.c
55 : *
56 : *-------------------------------------------------------------------------
57 : */
58 : #include "postgres.h"
59 :
60 : #include "access/heaptoast.h"
61 : #include "access/htup_details.h"
62 : #include "access/tupdesc_details.h"
63 : #include "access/xact.h"
64 : #include "catalog/pg_type.h"
65 : #include "funcapi.h"
66 : #include "nodes/nodeFuncs.h"
67 : #include "storage/bufmgr.h"
68 : #include "utils/builtins.h"
69 : #include "utils/expandeddatum.h"
70 : #include "utils/lsyscache.h"
71 : #include "utils/typcache.h"
72 :
73 : static TupleDesc ExecTypeFromTLInternal(List *targetList,
74 : bool skipjunk);
75 : static pg_attribute_always_inline void slot_deform_heap_tuple(TupleTableSlot *slot, HeapTuple tuple, uint32 *offp,
76 : int natts);
77 : static inline void tts_buffer_heap_store_tuple(TupleTableSlot *slot,
78 : HeapTuple tuple,
79 : Buffer buffer,
80 : bool transfer_pin);
81 : static void tts_heap_store_tuple(TupleTableSlot *slot, HeapTuple tuple, bool shouldFree);
82 :
83 :
84 : const TupleTableSlotOps TTSOpsVirtual;
85 : const TupleTableSlotOps TTSOpsHeapTuple;
86 : const TupleTableSlotOps TTSOpsMinimalTuple;
87 : const TupleTableSlotOps TTSOpsBufferHeapTuple;
88 :
89 :
90 : /*
91 : * TupleTableSlotOps implementations.
92 : */
93 :
94 : /*
95 : * TupleTableSlotOps implementation for VirtualTupleTableSlot.
96 : */
97 : static void
98 1337782 : tts_virtual_init(TupleTableSlot *slot)
99 : {
100 1337782 : }
101 :
102 : static void
103 1309022 : tts_virtual_release(TupleTableSlot *slot)
104 : {
105 1309022 : }
106 :
107 : static void
108 85900244 : tts_virtual_clear(TupleTableSlot *slot)
109 : {
110 85900244 : if (unlikely(TTS_SHOULDFREE(slot)))
111 : {
112 1894190 : VirtualTupleTableSlot *vslot = (VirtualTupleTableSlot *) slot;
113 :
114 1894190 : pfree(vslot->data);
115 1894190 : vslot->data = NULL;
116 :
117 1894190 : slot->tts_flags &= ~TTS_FLAG_SHOULDFREE;
118 : }
119 :
120 85900244 : slot->tts_nvalid = 0;
121 85900244 : slot->tts_flags |= TTS_FLAG_EMPTY;
122 85900244 : ItemPointerSetInvalid(&slot->tts_tid);
123 85900244 : }
124 :
125 : /*
126 : * VirtualTupleTableSlots always have fully populated tts_values and
127 : * tts_isnull arrays. So this function should never be called.
128 : */
129 : static void
130 0 : tts_virtual_getsomeattrs(TupleTableSlot *slot, int natts)
131 : {
132 0 : elog(ERROR, "getsomeattrs is not required to be called on a virtual tuple table slot");
133 : }
134 :
135 : /*
136 : * VirtualTupleTableSlots never provide system attributes (except those
137 : * handled generically, such as tableoid). We generally shouldn't get
138 : * here, but provide a user-friendly message if we do.
139 : */
140 : static Datum
141 12 : tts_virtual_getsysattr(TupleTableSlot *slot, int attnum, bool *isnull)
142 : {
143 : Assert(!TTS_EMPTY(slot));
144 :
145 12 : ereport(ERROR,
146 : (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
147 : errmsg("cannot retrieve a system column in this context")));
148 :
149 : return 0; /* silence compiler warnings */
150 : }
151 :
152 : /*
153 : * VirtualTupleTableSlots never have storage tuples. We generally
154 : * shouldn't get here, but provide a user-friendly message if we do.
155 : */
156 : static bool
157 0 : tts_virtual_is_current_xact_tuple(TupleTableSlot *slot)
158 : {
159 : Assert(!TTS_EMPTY(slot));
160 :
161 0 : ereport(ERROR,
162 : (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
163 : errmsg("don't have transaction information for this type of tuple")));
164 :
165 : return false; /* silence compiler warnings */
166 : }
167 :
168 : /*
169 : * To materialize a virtual slot all the datums that aren't passed by value
170 : * have to be copied into the slot's memory context. To do so, compute the
171 : * required size, and allocate enough memory to store all attributes. That's
172 : * good for cache hit ratio, but more importantly requires only memory
173 : * allocation/deallocation.
174 : */
175 : static void
176 4365698 : tts_virtual_materialize(TupleTableSlot *slot)
177 : {
178 4365698 : VirtualTupleTableSlot *vslot = (VirtualTupleTableSlot *) slot;
179 4365698 : TupleDesc desc = slot->tts_tupleDescriptor;
180 4365698 : Size sz = 0;
181 : char *data;
182 :
183 : /* already materialized */
184 4365698 : if (TTS_SHOULDFREE(slot))
185 384636 : return;
186 :
187 : /* compute size of memory required */
188 12748378 : for (int natt = 0; natt < desc->natts; natt++)
189 : {
190 8767316 : CompactAttribute *att = TupleDescCompactAttr(desc, natt);
191 : Datum val;
192 :
193 8767316 : if (att->attbyval || slot->tts_isnull[natt])
194 6477522 : continue;
195 :
196 2289794 : val = slot->tts_values[natt];
197 :
198 2289794 : if (att->attlen == -1 &&
199 1763080 : VARATT_IS_EXTERNAL_EXPANDED(DatumGetPointer(val)))
200 : {
201 : /*
202 : * We want to flatten the expanded value so that the materialized
203 : * slot doesn't depend on it.
204 : */
205 0 : sz = att_nominal_alignby(sz, att->attalignby);
206 0 : sz += EOH_get_flat_size(DatumGetEOHP(val));
207 : }
208 : else
209 : {
210 2289794 : sz = att_nominal_alignby(sz, att->attalignby);
211 2289794 : sz = att_addlength_datum(sz, att->attlen, val);
212 : }
213 : }
214 :
215 : /* all data is byval */
216 3981062 : if (sz == 0)
217 2086754 : return;
218 :
219 : /* allocate memory */
220 1894308 : vslot->data = data = MemoryContextAlloc(slot->tts_mcxt, sz);
221 1894308 : slot->tts_flags |= TTS_FLAG_SHOULDFREE;
222 :
223 : /* and copy all attributes into the pre-allocated space */
224 7448096 : for (int natt = 0; natt < desc->natts; natt++)
225 : {
226 5553788 : CompactAttribute *att = TupleDescCompactAttr(desc, natt);
227 : Datum val;
228 :
229 5553788 : if (att->attbyval || slot->tts_isnull[natt])
230 3263994 : continue;
231 :
232 2289794 : val = slot->tts_values[natt];
233 :
234 2289794 : if (att->attlen == -1 &&
235 1763080 : VARATT_IS_EXTERNAL_EXPANDED(DatumGetPointer(val)))
236 0 : {
237 : Size data_length;
238 :
239 : /*
240 : * We want to flatten the expanded value so that the materialized
241 : * slot doesn't depend on it.
242 : */
243 0 : ExpandedObjectHeader *eoh = DatumGetEOHP(val);
244 :
245 0 : data = (char *) att_nominal_alignby(data,
246 : att->attalignby);
247 0 : data_length = EOH_get_flat_size(eoh);
248 0 : EOH_flatten_into(eoh, data, data_length);
249 :
250 0 : slot->tts_values[natt] = PointerGetDatum(data);
251 0 : data += data_length;
252 : }
253 : else
254 : {
255 2289794 : Size data_length = 0;
256 :
257 2289794 : data = (char *) att_nominal_alignby(data, att->attalignby);
258 2289794 : data_length = att_addlength_datum(data_length, att->attlen, val);
259 :
260 2289794 : memcpy(data, DatumGetPointer(val), data_length);
261 :
262 2289794 : slot->tts_values[natt] = PointerGetDatum(data);
263 2289794 : data += data_length;
264 : }
265 : }
266 : }
267 :
268 : static void
269 138416 : tts_virtual_copyslot(TupleTableSlot *dstslot, TupleTableSlot *srcslot)
270 : {
271 138416 : TupleDesc srcdesc = srcslot->tts_tupleDescriptor;
272 :
273 138416 : tts_virtual_clear(dstslot);
274 :
275 138416 : slot_getallattrs(srcslot);
276 :
277 284188 : for (int natt = 0; natt < srcdesc->natts; natt++)
278 : {
279 145772 : dstslot->tts_values[natt] = srcslot->tts_values[natt];
280 145772 : dstslot->tts_isnull[natt] = srcslot->tts_isnull[natt];
281 : }
282 :
283 138416 : dstslot->tts_nvalid = srcdesc->natts;
284 138416 : dstslot->tts_flags &= ~TTS_FLAG_EMPTY;
285 :
286 : /* make sure storage doesn't depend on external memory */
287 138416 : tts_virtual_materialize(dstslot);
288 138416 : }
289 :
290 : static HeapTuple
291 14619418 : tts_virtual_copy_heap_tuple(TupleTableSlot *slot)
292 : {
293 : Assert(!TTS_EMPTY(slot));
294 :
295 29238836 : return heap_form_tuple(slot->tts_tupleDescriptor,
296 14619418 : slot->tts_values,
297 14619418 : slot->tts_isnull);
298 : }
299 :
300 : static MinimalTuple
301 27143598 : tts_virtual_copy_minimal_tuple(TupleTableSlot *slot, Size extra)
302 : {
303 : Assert(!TTS_EMPTY(slot));
304 :
305 54287196 : return heap_form_minimal_tuple(slot->tts_tupleDescriptor,
306 27143598 : slot->tts_values,
307 27143598 : slot->tts_isnull,
308 : extra);
309 : }
310 :
311 :
312 : /*
313 : * TupleTableSlotOps implementation for HeapTupleTableSlot.
314 : */
315 :
316 : static void
317 4028140 : tts_heap_init(TupleTableSlot *slot)
318 : {
319 4028140 : }
320 :
321 : static void
322 4027150 : tts_heap_release(TupleTableSlot *slot)
323 : {
324 4027150 : }
325 :
326 : static void
327 10061556 : tts_heap_clear(TupleTableSlot *slot)
328 : {
329 10061556 : HeapTupleTableSlot *hslot = (HeapTupleTableSlot *) slot;
330 :
331 : /* Free the memory for the heap tuple if it's allowed. */
332 10061556 : if (TTS_SHOULDFREE(slot))
333 : {
334 1740882 : heap_freetuple(hslot->tuple);
335 1740882 : slot->tts_flags &= ~TTS_FLAG_SHOULDFREE;
336 : }
337 :
338 10061556 : slot->tts_nvalid = 0;
339 10061556 : slot->tts_flags |= TTS_FLAG_EMPTY;
340 10061556 : ItemPointerSetInvalid(&slot->tts_tid);
341 10061556 : hslot->off = 0;
342 10061556 : hslot->tuple = NULL;
343 10061556 : }
344 :
345 : static void
346 10172722 : tts_heap_getsomeattrs(TupleTableSlot *slot, int natts)
347 : {
348 10172722 : HeapTupleTableSlot *hslot = (HeapTupleTableSlot *) slot;
349 :
350 : Assert(!TTS_EMPTY(slot));
351 :
352 10172722 : slot_deform_heap_tuple(slot, hslot->tuple, &hslot->off, natts);
353 10172722 : }
354 :
355 : static Datum
356 0 : tts_heap_getsysattr(TupleTableSlot *slot, int attnum, bool *isnull)
357 : {
358 0 : HeapTupleTableSlot *hslot = (HeapTupleTableSlot *) slot;
359 :
360 : Assert(!TTS_EMPTY(slot));
361 :
362 : /*
363 : * In some code paths it's possible to get here with a non-materialized
364 : * slot, in which case we can't retrieve system columns.
365 : */
366 0 : if (!hslot->tuple)
367 0 : ereport(ERROR,
368 : (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
369 : errmsg("cannot retrieve a system column in this context")));
370 :
371 0 : return heap_getsysattr(hslot->tuple, attnum,
372 : slot->tts_tupleDescriptor, isnull);
373 : }
374 :
375 : static bool
376 0 : tts_heap_is_current_xact_tuple(TupleTableSlot *slot)
377 : {
378 0 : HeapTupleTableSlot *hslot = (HeapTupleTableSlot *) slot;
379 : TransactionId xmin;
380 :
381 : Assert(!TTS_EMPTY(slot));
382 :
383 : /*
384 : * In some code paths it's possible to get here with a non-materialized
385 : * slot, in which case we can't check if tuple is created by the current
386 : * transaction.
387 : */
388 0 : if (!hslot->tuple)
389 0 : ereport(ERROR,
390 : (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
391 : errmsg("don't have a storage tuple in this context")));
392 :
393 0 : xmin = HeapTupleHeaderGetRawXmin(hslot->tuple->t_data);
394 :
395 0 : return TransactionIdIsCurrentTransactionId(xmin);
396 : }
397 :
398 : static void
399 3479260 : tts_heap_materialize(TupleTableSlot *slot)
400 : {
401 3479260 : HeapTupleTableSlot *hslot = (HeapTupleTableSlot *) slot;
402 : MemoryContext oldContext;
403 :
404 : Assert(!TTS_EMPTY(slot));
405 :
406 : /* If slot has its tuple already materialized, nothing to do. */
407 3479260 : if (TTS_SHOULDFREE(slot))
408 1740356 : return;
409 :
410 1738904 : oldContext = MemoryContextSwitchTo(slot->tts_mcxt);
411 :
412 : /*
413 : * Have to deform from scratch, otherwise tts_values[] entries could point
414 : * into the non-materialized tuple (which might be gone when accessed).
415 : */
416 1738904 : slot->tts_nvalid = 0;
417 1738904 : hslot->off = 0;
418 :
419 1738904 : if (!hslot->tuple)
420 1738890 : hslot->tuple = heap_form_tuple(slot->tts_tupleDescriptor,
421 1738890 : slot->tts_values,
422 1738890 : slot->tts_isnull);
423 : else
424 : {
425 : /*
426 : * The tuple contained in this slot is not allocated in the memory
427 : * context of the given slot (else it would have TTS_FLAG_SHOULDFREE
428 : * set). Copy the tuple into the given slot's memory context.
429 : */
430 14 : hslot->tuple = heap_copytuple(hslot->tuple);
431 : }
432 :
433 1738904 : slot->tts_flags |= TTS_FLAG_SHOULDFREE;
434 :
435 1738904 : MemoryContextSwitchTo(oldContext);
436 : }
437 :
438 : static void
439 1796 : tts_heap_copyslot(TupleTableSlot *dstslot, TupleTableSlot *srcslot)
440 : {
441 : HeapTuple tuple;
442 : MemoryContext oldcontext;
443 :
444 1796 : oldcontext = MemoryContextSwitchTo(dstslot->tts_mcxt);
445 1796 : tuple = ExecCopySlotHeapTuple(srcslot);
446 1796 : MemoryContextSwitchTo(oldcontext);
447 :
448 1796 : ExecStoreHeapTuple(tuple, dstslot, true);
449 1796 : }
450 :
451 : static HeapTuple
452 3477258 : tts_heap_get_heap_tuple(TupleTableSlot *slot)
453 : {
454 3477258 : HeapTupleTableSlot *hslot = (HeapTupleTableSlot *) slot;
455 :
456 : Assert(!TTS_EMPTY(slot));
457 3477258 : if (!hslot->tuple)
458 0 : tts_heap_materialize(slot);
459 :
460 3477258 : return hslot->tuple;
461 : }
462 :
463 : static HeapTuple
464 688 : tts_heap_copy_heap_tuple(TupleTableSlot *slot)
465 : {
466 688 : HeapTupleTableSlot *hslot = (HeapTupleTableSlot *) slot;
467 :
468 : Assert(!TTS_EMPTY(slot));
469 688 : if (!hslot->tuple)
470 0 : tts_heap_materialize(slot);
471 :
472 688 : return heap_copytuple(hslot->tuple);
473 : }
474 :
475 : static MinimalTuple
476 5398 : tts_heap_copy_minimal_tuple(TupleTableSlot *slot, Size extra)
477 : {
478 5398 : HeapTupleTableSlot *hslot = (HeapTupleTableSlot *) slot;
479 :
480 5398 : if (!hslot->tuple)
481 38 : tts_heap_materialize(slot);
482 :
483 5398 : return minimal_tuple_from_heap_tuple(hslot->tuple, extra);
484 : }
485 :
486 : static void
487 4292446 : tts_heap_store_tuple(TupleTableSlot *slot, HeapTuple tuple, bool shouldFree)
488 : {
489 4292446 : HeapTupleTableSlot *hslot = (HeapTupleTableSlot *) slot;
490 :
491 4292446 : tts_heap_clear(slot);
492 :
493 4292446 : slot->tts_nvalid = 0;
494 4292446 : hslot->tuple = tuple;
495 4292446 : hslot->off = 0;
496 4292446 : slot->tts_flags &= ~(TTS_FLAG_EMPTY | TTS_FLAG_SHOULDFREE);
497 4292446 : slot->tts_tid = tuple->t_self;
498 :
499 4292446 : if (shouldFree)
500 1996 : slot->tts_flags |= TTS_FLAG_SHOULDFREE;
501 4292446 : }
502 :
503 :
504 : /*
505 : * TupleTableSlotOps implementation for MinimalTupleTableSlot.
506 : */
507 :
508 : static void
509 403126 : tts_minimal_init(TupleTableSlot *slot)
510 : {
511 403126 : MinimalTupleTableSlot *mslot = (MinimalTupleTableSlot *) slot;
512 :
513 : /*
514 : * Initialize the heap tuple pointer to access attributes of the minimal
515 : * tuple contained in the slot as if its a heap tuple.
516 : */
517 403126 : mslot->tuple = &mslot->minhdr;
518 403126 : }
519 :
520 : static void
521 350744 : tts_minimal_release(TupleTableSlot *slot)
522 : {
523 350744 : }
524 :
525 : static void
526 72667262 : tts_minimal_clear(TupleTableSlot *slot)
527 : {
528 72667262 : MinimalTupleTableSlot *mslot = (MinimalTupleTableSlot *) slot;
529 :
530 72667262 : if (TTS_SHOULDFREE(slot))
531 : {
532 12218946 : heap_free_minimal_tuple(mslot->mintuple);
533 12218946 : slot->tts_flags &= ~TTS_FLAG_SHOULDFREE;
534 : }
535 :
536 72667262 : slot->tts_nvalid = 0;
537 72667262 : slot->tts_flags |= TTS_FLAG_EMPTY;
538 72667262 : ItemPointerSetInvalid(&slot->tts_tid);
539 72667262 : mslot->off = 0;
540 72667262 : mslot->mintuple = NULL;
541 72667262 : }
542 :
543 : static void
544 52896620 : tts_minimal_getsomeattrs(TupleTableSlot *slot, int natts)
545 : {
546 52896620 : MinimalTupleTableSlot *mslot = (MinimalTupleTableSlot *) slot;
547 :
548 : Assert(!TTS_EMPTY(slot));
549 :
550 52896620 : slot_deform_heap_tuple(slot, mslot->tuple, &mslot->off, natts);
551 52896620 : }
552 :
553 : /*
554 : * MinimalTupleTableSlots never provide system attributes. We generally
555 : * shouldn't get here, but provide a user-friendly message if we do.
556 : */
557 : static Datum
558 0 : tts_minimal_getsysattr(TupleTableSlot *slot, int attnum, bool *isnull)
559 : {
560 : Assert(!TTS_EMPTY(slot));
561 :
562 0 : ereport(ERROR,
563 : (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
564 : errmsg("cannot retrieve a system column in this context")));
565 :
566 : return 0; /* silence compiler warnings */
567 : }
568 :
569 : /*
570 : * Within MinimalTuple abstraction transaction information is unavailable.
571 : * We generally shouldn't get here, but provide a user-friendly message if
572 : * we do.
573 : */
574 : static bool
575 0 : tts_minimal_is_current_xact_tuple(TupleTableSlot *slot)
576 : {
577 : Assert(!TTS_EMPTY(slot));
578 :
579 0 : ereport(ERROR,
580 : (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
581 : errmsg("don't have transaction information for this type of tuple")));
582 :
583 : return false; /* silence compiler warnings */
584 : }
585 :
586 : static void
587 1607790 : tts_minimal_materialize(TupleTableSlot *slot)
588 : {
589 1607790 : MinimalTupleTableSlot *mslot = (MinimalTupleTableSlot *) slot;
590 : MemoryContext oldContext;
591 :
592 : Assert(!TTS_EMPTY(slot));
593 :
594 : /* If slot has its tuple already materialized, nothing to do. */
595 1607790 : if (TTS_SHOULDFREE(slot))
596 144034 : return;
597 :
598 1463756 : oldContext = MemoryContextSwitchTo(slot->tts_mcxt);
599 :
600 : /*
601 : * Have to deform from scratch, otherwise tts_values[] entries could point
602 : * into the non-materialized tuple (which might be gone when accessed).
603 : */
604 1463756 : slot->tts_nvalid = 0;
605 1463756 : mslot->off = 0;
606 :
607 1463756 : if (!mslot->mintuple)
608 : {
609 1352732 : mslot->mintuple = heap_form_minimal_tuple(slot->tts_tupleDescriptor,
610 1352732 : slot->tts_values,
611 1352732 : slot->tts_isnull,
612 : 0);
613 : }
614 : else
615 : {
616 : /*
617 : * The minimal tuple contained in this slot is not allocated in the
618 : * memory context of the given slot (else it would have
619 : * TTS_FLAG_SHOULDFREE set). Copy the minimal tuple into the given
620 : * slot's memory context.
621 : */
622 111024 : mslot->mintuple = heap_copy_minimal_tuple(mslot->mintuple, 0);
623 : }
624 :
625 1463756 : slot->tts_flags |= TTS_FLAG_SHOULDFREE;
626 :
627 : Assert(mslot->tuple == &mslot->minhdr);
628 :
629 1463756 : mslot->minhdr.t_len = mslot->mintuple->t_len + MINIMAL_TUPLE_OFFSET;
630 1463756 : mslot->minhdr.t_data = (HeapTupleHeader) ((char *) mslot->mintuple - MINIMAL_TUPLE_OFFSET);
631 :
632 1463756 : MemoryContextSwitchTo(oldContext);
633 : }
634 :
635 : static void
636 1107838 : tts_minimal_copyslot(TupleTableSlot *dstslot, TupleTableSlot *srcslot)
637 : {
638 : MemoryContext oldcontext;
639 : MinimalTuple mintuple;
640 :
641 1107838 : oldcontext = MemoryContextSwitchTo(dstslot->tts_mcxt);
642 1107838 : mintuple = ExecCopySlotMinimalTuple(srcslot);
643 1107838 : MemoryContextSwitchTo(oldcontext);
644 :
645 1107838 : ExecStoreMinimalTuple(mintuple, dstslot, true);
646 1107838 : }
647 :
648 : static MinimalTuple
649 4033314 : tts_minimal_get_minimal_tuple(TupleTableSlot *slot)
650 : {
651 4033314 : MinimalTupleTableSlot *mslot = (MinimalTupleTableSlot *) slot;
652 :
653 4033314 : if (!mslot->mintuple)
654 0 : tts_minimal_materialize(slot);
655 :
656 4033314 : return mslot->mintuple;
657 : }
658 :
659 : static HeapTuple
660 781270 : tts_minimal_copy_heap_tuple(TupleTableSlot *slot)
661 : {
662 781270 : MinimalTupleTableSlot *mslot = (MinimalTupleTableSlot *) slot;
663 :
664 781270 : if (!mslot->mintuple)
665 1392 : tts_minimal_materialize(slot);
666 :
667 781270 : return heap_tuple_from_minimal_tuple(mslot->mintuple);
668 : }
669 :
670 : static MinimalTuple
671 2817728 : tts_minimal_copy_minimal_tuple(TupleTableSlot *slot, Size extra)
672 : {
673 2817728 : MinimalTupleTableSlot *mslot = (MinimalTupleTableSlot *) slot;
674 :
675 2817728 : if (!mslot->mintuple)
676 1148432 : tts_minimal_materialize(slot);
677 :
678 2817728 : return heap_copy_minimal_tuple(mslot->mintuple, extra);
679 : }
680 :
681 : static void
682 60509710 : tts_minimal_store_tuple(TupleTableSlot *slot, MinimalTuple mtup, bool shouldFree)
683 : {
684 60509710 : MinimalTupleTableSlot *mslot = (MinimalTupleTableSlot *) slot;
685 :
686 60509710 : tts_minimal_clear(slot);
687 :
688 : Assert(!TTS_SHOULDFREE(slot));
689 : Assert(TTS_EMPTY(slot));
690 :
691 60509710 : slot->tts_flags &= ~TTS_FLAG_EMPTY;
692 60509710 : slot->tts_nvalid = 0;
693 60509710 : mslot->off = 0;
694 :
695 60509710 : mslot->mintuple = mtup;
696 : Assert(mslot->tuple == &mslot->minhdr);
697 60509710 : mslot->minhdr.t_len = mtup->t_len + MINIMAL_TUPLE_OFFSET;
698 60509710 : mslot->minhdr.t_data = (HeapTupleHeader) ((char *) mtup - MINIMAL_TUPLE_OFFSET);
699 : /* no need to set t_self or t_tableOid since we won't allow access */
700 :
701 60509710 : if (shouldFree)
702 10756524 : slot->tts_flags |= TTS_FLAG_SHOULDFREE;
703 60509710 : }
704 :
705 :
706 : /*
707 : * TupleTableSlotOps implementation for BufferHeapTupleTableSlot.
708 : */
709 :
710 : static void
711 27201266 : tts_buffer_heap_init(TupleTableSlot *slot)
712 : {
713 27201266 : }
714 :
715 : static void
716 27187382 : tts_buffer_heap_release(TupleTableSlot *slot)
717 : {
718 27187382 : }
719 :
720 : static void
721 52171774 : tts_buffer_heap_clear(TupleTableSlot *slot)
722 : {
723 52171774 : BufferHeapTupleTableSlot *bslot = (BufferHeapTupleTableSlot *) slot;
724 :
725 : /*
726 : * Free the memory for heap tuple if allowed. A tuple coming from buffer
727 : * can never be freed. But we may have materialized a tuple from buffer.
728 : * Such a tuple can be freed.
729 : */
730 52171774 : if (TTS_SHOULDFREE(slot))
731 : {
732 : /* We should have unpinned the buffer while materializing the tuple. */
733 : Assert(!BufferIsValid(bslot->buffer));
734 :
735 14646836 : heap_freetuple(bslot->base.tuple);
736 14646836 : slot->tts_flags &= ~TTS_FLAG_SHOULDFREE;
737 : }
738 :
739 52171774 : if (BufferIsValid(bslot->buffer))
740 14511810 : ReleaseBuffer(bslot->buffer);
741 :
742 52171774 : slot->tts_nvalid = 0;
743 52171774 : slot->tts_flags |= TTS_FLAG_EMPTY;
744 52171774 : ItemPointerSetInvalid(&slot->tts_tid);
745 52171774 : bslot->base.tuple = NULL;
746 52171774 : bslot->base.off = 0;
747 52171774 : bslot->buffer = InvalidBuffer;
748 52171774 : }
749 :
750 : static void
751 131561796 : tts_buffer_heap_getsomeattrs(TupleTableSlot *slot, int natts)
752 : {
753 131561796 : BufferHeapTupleTableSlot *bslot = (BufferHeapTupleTableSlot *) slot;
754 :
755 : Assert(!TTS_EMPTY(slot));
756 :
757 131561796 : slot_deform_heap_tuple(slot, bslot->base.tuple, &bslot->base.off, natts);
758 131561796 : }
759 :
760 : static Datum
761 144900 : tts_buffer_heap_getsysattr(TupleTableSlot *slot, int attnum, bool *isnull)
762 : {
763 144900 : BufferHeapTupleTableSlot *bslot = (BufferHeapTupleTableSlot *) slot;
764 :
765 : Assert(!TTS_EMPTY(slot));
766 :
767 : /*
768 : * In some code paths it's possible to get here with a non-materialized
769 : * slot, in which case we can't retrieve system columns.
770 : */
771 144900 : if (!bslot->base.tuple)
772 0 : ereport(ERROR,
773 : (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
774 : errmsg("cannot retrieve a system column in this context")));
775 :
776 144900 : return heap_getsysattr(bslot->base.tuple, attnum,
777 : slot->tts_tupleDescriptor, isnull);
778 : }
779 :
780 : static bool
781 924 : tts_buffer_is_current_xact_tuple(TupleTableSlot *slot)
782 : {
783 924 : BufferHeapTupleTableSlot *bslot = (BufferHeapTupleTableSlot *) slot;
784 : TransactionId xmin;
785 :
786 : Assert(!TTS_EMPTY(slot));
787 :
788 : /*
789 : * In some code paths it's possible to get here with a non-materialized
790 : * slot, in which case we can't check if tuple is created by the current
791 : * transaction.
792 : */
793 924 : if (!bslot->base.tuple)
794 0 : ereport(ERROR,
795 : (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
796 : errmsg("don't have a storage tuple in this context")));
797 :
798 924 : xmin = HeapTupleHeaderGetRawXmin(bslot->base.tuple->t_data);
799 :
800 924 : return TransactionIdIsCurrentTransactionId(xmin);
801 : }
802 :
803 : static void
804 29165322 : tts_buffer_heap_materialize(TupleTableSlot *slot)
805 : {
806 29165322 : BufferHeapTupleTableSlot *bslot = (BufferHeapTupleTableSlot *) slot;
807 : MemoryContext oldContext;
808 :
809 : Assert(!TTS_EMPTY(slot));
810 :
811 : /* If slot has its tuple already materialized, nothing to do. */
812 29165322 : if (TTS_SHOULDFREE(slot))
813 25777426 : return;
814 :
815 3387896 : oldContext = MemoryContextSwitchTo(slot->tts_mcxt);
816 :
817 : /*
818 : * Have to deform from scratch, otherwise tts_values[] entries could point
819 : * into the non-materialized tuple (which might be gone when accessed).
820 : */
821 3387896 : bslot->base.off = 0;
822 3387896 : slot->tts_nvalid = 0;
823 :
824 3387896 : if (!bslot->base.tuple)
825 : {
826 : /*
827 : * Normally BufferHeapTupleTableSlot should have a tuple + buffer
828 : * associated with it, unless it's materialized (which would've
829 : * returned above). But when it's useful to allow storing virtual
830 : * tuples in a buffer slot, which then also needs to be
831 : * materializable.
832 : */
833 2993628 : bslot->base.tuple = heap_form_tuple(slot->tts_tupleDescriptor,
834 2993628 : slot->tts_values,
835 2993628 : slot->tts_isnull);
836 : }
837 : else
838 : {
839 394268 : bslot->base.tuple = heap_copytuple(bslot->base.tuple);
840 :
841 : /*
842 : * A heap tuple stored in a BufferHeapTupleTableSlot should have a
843 : * buffer associated with it, unless it's materialized or virtual.
844 : */
845 394268 : if (likely(BufferIsValid(bslot->buffer)))
846 394268 : ReleaseBuffer(bslot->buffer);
847 394268 : bslot->buffer = InvalidBuffer;
848 : }
849 :
850 : /*
851 : * We don't set TTS_FLAG_SHOULDFREE until after releasing the buffer, if
852 : * any. This avoids having a transient state that would fall foul of our
853 : * assertions that a slot with TTS_FLAG_SHOULDFREE doesn't own a buffer.
854 : * In the unlikely event that ReleaseBuffer() above errors out, we'd
855 : * effectively leak the copied tuple, but that seems fairly harmless.
856 : */
857 3387896 : slot->tts_flags |= TTS_FLAG_SHOULDFREE;
858 :
859 3387896 : MemoryContextSwitchTo(oldContext);
860 : }
861 :
862 : static void
863 11592098 : tts_buffer_heap_copyslot(TupleTableSlot *dstslot, TupleTableSlot *srcslot)
864 : {
865 11592098 : BufferHeapTupleTableSlot *bsrcslot = (BufferHeapTupleTableSlot *) srcslot;
866 11592098 : BufferHeapTupleTableSlot *bdstslot = (BufferHeapTupleTableSlot *) dstslot;
867 :
868 : /*
869 : * If the source slot is of a different kind, or is a buffer slot that has
870 : * been materialized / is virtual, make a new copy of the tuple. Otherwise
871 : * make a new reference to the in-buffer tuple.
872 : */
873 11592098 : if (dstslot->tts_ops != srcslot->tts_ops ||
874 6528 : TTS_SHOULDFREE(srcslot) ||
875 6524 : !bsrcslot->base.tuple)
876 11585574 : {
877 : MemoryContext oldContext;
878 :
879 11585574 : ExecClearTuple(dstslot);
880 11585574 : dstslot->tts_flags &= ~TTS_FLAG_EMPTY;
881 11585574 : oldContext = MemoryContextSwitchTo(dstslot->tts_mcxt);
882 11585574 : bdstslot->base.tuple = ExecCopySlotHeapTuple(srcslot);
883 11585574 : dstslot->tts_flags |= TTS_FLAG_SHOULDFREE;
884 11585574 : MemoryContextSwitchTo(oldContext);
885 : }
886 : else
887 : {
888 : Assert(BufferIsValid(bsrcslot->buffer));
889 :
890 6524 : tts_buffer_heap_store_tuple(dstslot, bsrcslot->base.tuple,
891 : bsrcslot->buffer, false);
892 :
893 : /*
894 : * The HeapTupleData portion of the source tuple might be shorter
895 : * lived than the destination slot. Therefore copy the HeapTuple into
896 : * our slot's tupdata, which is guaranteed to live long enough (but
897 : * will still point into the buffer).
898 : */
899 6524 : memcpy(&bdstslot->base.tupdata, bdstslot->base.tuple, sizeof(HeapTupleData));
900 6524 : bdstslot->base.tuple = &bdstslot->base.tupdata;
901 : }
902 11592098 : }
903 :
904 : static HeapTuple
905 38811392 : tts_buffer_heap_get_heap_tuple(TupleTableSlot *slot)
906 : {
907 38811392 : BufferHeapTupleTableSlot *bslot = (BufferHeapTupleTableSlot *) slot;
908 :
909 : Assert(!TTS_EMPTY(slot));
910 :
911 38811392 : if (!bslot->base.tuple)
912 0 : tts_buffer_heap_materialize(slot);
913 :
914 38811392 : return bslot->base.tuple;
915 : }
916 :
917 : static HeapTuple
918 10840784 : tts_buffer_heap_copy_heap_tuple(TupleTableSlot *slot)
919 : {
920 10840784 : BufferHeapTupleTableSlot *bslot = (BufferHeapTupleTableSlot *) slot;
921 :
922 : Assert(!TTS_EMPTY(slot));
923 :
924 10840784 : if (!bslot->base.tuple)
925 0 : tts_buffer_heap_materialize(slot);
926 :
927 10840784 : return heap_copytuple(bslot->base.tuple);
928 : }
929 :
930 : static MinimalTuple
931 2816528 : tts_buffer_heap_copy_minimal_tuple(TupleTableSlot *slot, Size extra)
932 : {
933 2816528 : BufferHeapTupleTableSlot *bslot = (BufferHeapTupleTableSlot *) slot;
934 :
935 : Assert(!TTS_EMPTY(slot));
936 :
937 2816528 : if (!bslot->base.tuple)
938 0 : tts_buffer_heap_materialize(slot);
939 :
940 2816528 : return minimal_tuple_from_heap_tuple(bslot->base.tuple, extra);
941 : }
942 :
943 : static inline void
944 156853026 : tts_buffer_heap_store_tuple(TupleTableSlot *slot, HeapTuple tuple,
945 : Buffer buffer, bool transfer_pin)
946 : {
947 156853026 : BufferHeapTupleTableSlot *bslot = (BufferHeapTupleTableSlot *) slot;
948 :
949 156853026 : if (TTS_SHOULDFREE(slot))
950 : {
951 : /* materialized slot shouldn't have a buffer to release */
952 : Assert(!BufferIsValid(bslot->buffer));
953 :
954 395970 : heap_freetuple(bslot->base.tuple);
955 395970 : slot->tts_flags &= ~TTS_FLAG_SHOULDFREE;
956 : }
957 :
958 156853026 : slot->tts_flags &= ~TTS_FLAG_EMPTY;
959 156853026 : slot->tts_nvalid = 0;
960 156853026 : bslot->base.tuple = tuple;
961 156853026 : bslot->base.off = 0;
962 156853026 : slot->tts_tid = tuple->t_self;
963 :
964 : /*
965 : * If tuple is on a disk page, keep the page pinned as long as we hold a
966 : * pointer into it. We assume the caller already has such a pin. If
967 : * transfer_pin is true, we'll transfer that pin to this slot, if not
968 : * we'll pin it again ourselves.
969 : *
970 : * This is coded to optimize the case where the slot previously held a
971 : * tuple on the same disk page: in that case releasing and re-acquiring
972 : * the pin is a waste of cycles. This is a common situation during
973 : * seqscans, so it's worth troubling over.
974 : */
975 156853026 : if (bslot->buffer != buffer)
976 : {
977 20132144 : if (BufferIsValid(bslot->buffer))
978 5218516 : ReleaseBuffer(bslot->buffer);
979 :
980 20132144 : bslot->buffer = buffer;
981 :
982 20132144 : if (!transfer_pin && BufferIsValid(buffer))
983 19923372 : IncrBufferRefCount(buffer);
984 : }
985 136720882 : else if (transfer_pin && BufferIsValid(buffer))
986 : {
987 : /*
988 : * In transfer_pin mode the caller won't know about the same-page
989 : * optimization, so we gotta release its pin.
990 : */
991 314136 : ReleaseBuffer(buffer);
992 : }
993 156853026 : }
994 :
995 : /*
996 : * slot_deform_heap_tuple_internal
997 : * An always inline helper function for use in slot_deform_heap_tuple to
998 : * allow the compiler to emit specialized versions of this function for
999 : * various combinations of "slow" and "hasnulls". For example, if a
1000 : * given tuple has no nulls, then we needn't check "hasnulls" for every
1001 : * attribute that we're deforming. The caller can just call this
1002 : * function with hasnulls set to constant-false and have the compiler
1003 : * remove the constant-false branches and emit more optimal code.
1004 : *
1005 : * Returns the next attnum to deform, which can be equal to natts when the
1006 : * function manages to deform all requested attributes. *offp is an input and
1007 : * output parameter which is the byte offset within the tuple to start deforming
1008 : * from which, on return, gets set to the offset where the next attribute
1009 : * should be deformed from. *slowp is set to true when subsequent deforming
1010 : * of this tuple must use a version of this function with "slow" passed as
1011 : * true.
1012 : *
1013 : * Callers cannot assume when we return "attnum" (i.e. all requested
1014 : * attributes have been deformed) that slow mode isn't required for any
1015 : * additional deforming as the final attribute may have caused a switch to
1016 : * slow mode.
1017 : */
1018 : static pg_attribute_always_inline int
1019 213518652 : slot_deform_heap_tuple_internal(TupleTableSlot *slot, HeapTuple tuple,
1020 : int attnum, int natts, bool slow,
1021 : bool hasnulls, uint32 *offp, bool *slowp)
1022 : {
1023 213518652 : TupleDesc tupleDesc = slot->tts_tupleDescriptor;
1024 213518652 : Datum *values = slot->tts_values;
1025 213518652 : bool *isnull = slot->tts_isnull;
1026 213518652 : HeapTupleHeader tup = tuple->t_data;
1027 : char *tp; /* ptr to tuple data */
1028 213518652 : bits8 *bp = tup->t_bits; /* ptr to null bitmap in tuple */
1029 213518652 : bool slownext = false;
1030 :
1031 213518652 : tp = (char *) tup + tup->t_hoff;
1032 :
1033 892614624 : for (; attnum < natts; attnum++)
1034 : {
1035 718836624 : CompactAttribute *thisatt = TupleDescCompactAttr(tupleDesc, attnum);
1036 :
1037 718836624 : if (hasnulls && att_isnull(attnum, bp))
1038 : {
1039 41894778 : values[attnum] = (Datum) 0;
1040 41894778 : isnull[attnum] = true;
1041 41894778 : if (!slow)
1042 : {
1043 4645008 : *slowp = true;
1044 4645008 : return attnum + 1;
1045 : }
1046 : else
1047 37249770 : continue;
1048 : }
1049 :
1050 676941846 : isnull[attnum] = false;
1051 :
1052 : /* calculate the offset of this attribute */
1053 676941846 : if (!slow && thisatt->attcacheoff >= 0)
1054 635017186 : *offp = thisatt->attcacheoff;
1055 41924660 : else if (thisatt->attlen == -1)
1056 : {
1057 : /*
1058 : * We can only cache the offset for a varlena attribute if the
1059 : * offset is already suitably aligned, so that there would be no
1060 : * pad bytes in any case: then the offset will be valid for either
1061 : * an aligned or unaligned value.
1062 : */
1063 13484728 : if (!slow && *offp == att_nominal_alignby(*offp, thisatt->attalignby))
1064 85630 : thisatt->attcacheoff = *offp;
1065 : else
1066 : {
1067 13399098 : *offp = att_pointer_alignby(*offp,
1068 : thisatt->attalignby,
1069 : -1,
1070 : tp + *offp);
1071 :
1072 13399098 : if (!slow)
1073 792312 : slownext = true;
1074 : }
1075 : }
1076 : else
1077 : {
1078 : /* not varlena, so safe to use att_nominal_alignby */
1079 28439932 : *offp = att_nominal_alignby(*offp, thisatt->attalignby);
1080 :
1081 28439932 : if (!slow)
1082 732678 : thisatt->attcacheoff = *offp;
1083 : }
1084 :
1085 676941846 : values[attnum] = fetchatt(thisatt, tp + *offp);
1086 :
1087 676941846 : *offp = att_addlength_pointer(*offp, thisatt->attlen, tp + *offp);
1088 :
1089 : /* check if we need to switch to slow mode */
1090 676941846 : if (!slow)
1091 : {
1092 : /*
1093 : * We're unable to deform any further if the above code set
1094 : * 'slownext', or if this isn't a fixed-width attribute.
1095 : */
1096 636627806 : if (slownext || thisatt->attlen <= 0)
1097 : {
1098 35095644 : *slowp = true;
1099 35095644 : return attnum + 1;
1100 : }
1101 : }
1102 : }
1103 :
1104 173778000 : return natts;
1105 : }
1106 :
1107 : /*
1108 : * slot_deform_heap_tuple
1109 : * Given a TupleTableSlot, extract data from the slot's physical tuple
1110 : * into its Datum/isnull arrays. Data is extracted up through the
1111 : * natts'th column (caller must ensure this is a legal column number).
1112 : *
1113 : * This is essentially an incremental version of heap_deform_tuple:
1114 : * on each call we extract attributes up to the one needed, without
1115 : * re-computing information about previously extracted attributes.
1116 : * slot->tts_nvalid is the number of attributes already extracted.
1117 : *
1118 : * This is marked as always inline, so the different offp for different types
1119 : * of slots gets optimized away.
1120 : */
1121 : static pg_attribute_always_inline void
1122 194631138 : slot_deform_heap_tuple(TupleTableSlot *slot, HeapTuple tuple, uint32 *offp,
1123 : int natts)
1124 : {
1125 194631138 : bool hasnulls = HeapTupleHasNulls(tuple);
1126 : int attnum;
1127 : uint32 off; /* offset in tuple data */
1128 : bool slow; /* can we use/set attcacheoff? */
1129 :
1130 : /* We can only fetch as many attributes as the tuple has. */
1131 194631138 : natts = Min(HeapTupleHeaderGetNatts(tuple->t_data), natts);
1132 :
1133 : /*
1134 : * Check whether the first call for this tuple, and initialize or restore
1135 : * loop state.
1136 : */
1137 194631138 : attnum = slot->tts_nvalid;
1138 194631138 : if (attnum == 0)
1139 : {
1140 : /* Start from the first attribute */
1141 168751372 : off = 0;
1142 168751372 : slow = false;
1143 : }
1144 : else
1145 : {
1146 : /* Restore state from previous execution */
1147 25879766 : off = *offp;
1148 25879766 : slow = TTS_SLOW(slot);
1149 : }
1150 :
1151 : /*
1152 : * If 'slow' isn't set, try deforming using deforming code that does not
1153 : * contain any of the extra checks required for non-fixed offset
1154 : * deforming. During deforming, if or when we find a NULL or a variable
1155 : * length attribute, we'll switch to a deforming method which includes the
1156 : * extra code required for non-fixed offset deforming, a.k.a slow mode.
1157 : * Because this is performance critical, we inline
1158 : * slot_deform_heap_tuple_internal passing the 'slow' and 'hasnull'
1159 : * parameters as constants to allow the compiler to emit specialized code
1160 : * with the known-const false comparisons and subsequent branches removed.
1161 : */
1162 194631138 : if (!slow)
1163 : {
1164 : /* Tuple without any NULLs? We can skip doing any NULL checking */
1165 193208344 : if (!hasnulls)
1166 141394786 : attnum = slot_deform_heap_tuple_internal(slot,
1167 : tuple,
1168 : attnum,
1169 : natts,
1170 : false, /* slow */
1171 : false, /* hasnulls */
1172 : &off,
1173 : &slow);
1174 : else
1175 51813558 : attnum = slot_deform_heap_tuple_internal(slot,
1176 : tuple,
1177 : attnum,
1178 : natts,
1179 : false, /* slow */
1180 : true, /* hasnulls */
1181 : &off,
1182 : &slow);
1183 : }
1184 :
1185 : /* If there's still work to do then we must be in slow mode */
1186 194631138 : if (attnum < natts)
1187 : {
1188 : /* XXX is it worth adding a separate call when hasnulls is false? */
1189 20310308 : attnum = slot_deform_heap_tuple_internal(slot,
1190 : tuple,
1191 : attnum,
1192 : natts,
1193 : true, /* slow */
1194 : hasnulls,
1195 : &off,
1196 : &slow);
1197 : }
1198 :
1199 : /*
1200 : * Save state for next execution
1201 : */
1202 194631138 : slot->tts_nvalid = attnum;
1203 194631138 : *offp = off;
1204 194631138 : if (slow)
1205 41163446 : slot->tts_flags |= TTS_FLAG_SLOW;
1206 : else
1207 153467692 : slot->tts_flags &= ~TTS_FLAG_SLOW;
1208 194631138 : }
1209 :
1210 : const TupleTableSlotOps TTSOpsVirtual = {
1211 : .base_slot_size = sizeof(VirtualTupleTableSlot),
1212 : .init = tts_virtual_init,
1213 : .release = tts_virtual_release,
1214 : .clear = tts_virtual_clear,
1215 : .getsomeattrs = tts_virtual_getsomeattrs,
1216 : .getsysattr = tts_virtual_getsysattr,
1217 : .materialize = tts_virtual_materialize,
1218 : .is_current_xact_tuple = tts_virtual_is_current_xact_tuple,
1219 : .copyslot = tts_virtual_copyslot,
1220 :
1221 : /*
1222 : * A virtual tuple table slot can not "own" a heap tuple or a minimal
1223 : * tuple.
1224 : */
1225 : .get_heap_tuple = NULL,
1226 : .get_minimal_tuple = NULL,
1227 : .copy_heap_tuple = tts_virtual_copy_heap_tuple,
1228 : .copy_minimal_tuple = tts_virtual_copy_minimal_tuple
1229 : };
1230 :
1231 : const TupleTableSlotOps TTSOpsHeapTuple = {
1232 : .base_slot_size = sizeof(HeapTupleTableSlot),
1233 : .init = tts_heap_init,
1234 : .release = tts_heap_release,
1235 : .clear = tts_heap_clear,
1236 : .getsomeattrs = tts_heap_getsomeattrs,
1237 : .getsysattr = tts_heap_getsysattr,
1238 : .is_current_xact_tuple = tts_heap_is_current_xact_tuple,
1239 : .materialize = tts_heap_materialize,
1240 : .copyslot = tts_heap_copyslot,
1241 : .get_heap_tuple = tts_heap_get_heap_tuple,
1242 :
1243 : /* A heap tuple table slot can not "own" a minimal tuple. */
1244 : .get_minimal_tuple = NULL,
1245 : .copy_heap_tuple = tts_heap_copy_heap_tuple,
1246 : .copy_minimal_tuple = tts_heap_copy_minimal_tuple
1247 : };
1248 :
1249 : const TupleTableSlotOps TTSOpsMinimalTuple = {
1250 : .base_slot_size = sizeof(MinimalTupleTableSlot),
1251 : .init = tts_minimal_init,
1252 : .release = tts_minimal_release,
1253 : .clear = tts_minimal_clear,
1254 : .getsomeattrs = tts_minimal_getsomeattrs,
1255 : .getsysattr = tts_minimal_getsysattr,
1256 : .is_current_xact_tuple = tts_minimal_is_current_xact_tuple,
1257 : .materialize = tts_minimal_materialize,
1258 : .copyslot = tts_minimal_copyslot,
1259 :
1260 : /* A minimal tuple table slot can not "own" a heap tuple. */
1261 : .get_heap_tuple = NULL,
1262 : .get_minimal_tuple = tts_minimal_get_minimal_tuple,
1263 : .copy_heap_tuple = tts_minimal_copy_heap_tuple,
1264 : .copy_minimal_tuple = tts_minimal_copy_minimal_tuple
1265 : };
1266 :
1267 : const TupleTableSlotOps TTSOpsBufferHeapTuple = {
1268 : .base_slot_size = sizeof(BufferHeapTupleTableSlot),
1269 : .init = tts_buffer_heap_init,
1270 : .release = tts_buffer_heap_release,
1271 : .clear = tts_buffer_heap_clear,
1272 : .getsomeattrs = tts_buffer_heap_getsomeattrs,
1273 : .getsysattr = tts_buffer_heap_getsysattr,
1274 : .is_current_xact_tuple = tts_buffer_is_current_xact_tuple,
1275 : .materialize = tts_buffer_heap_materialize,
1276 : .copyslot = tts_buffer_heap_copyslot,
1277 : .get_heap_tuple = tts_buffer_heap_get_heap_tuple,
1278 :
1279 : /* A buffer heap tuple table slot can not "own" a minimal tuple. */
1280 : .get_minimal_tuple = NULL,
1281 : .copy_heap_tuple = tts_buffer_heap_copy_heap_tuple,
1282 : .copy_minimal_tuple = tts_buffer_heap_copy_minimal_tuple
1283 : };
1284 :
1285 :
1286 : /* ----------------------------------------------------------------
1287 : * tuple table create/delete functions
1288 : * ----------------------------------------------------------------
1289 : */
1290 :
1291 : /* --------------------------------
1292 : * MakeTupleTableSlot
1293 : *
1294 : * Basic routine to make an empty TupleTableSlot of given
1295 : * TupleTableSlotType. If tupleDesc is specified the slot's descriptor is
1296 : * fixed for its lifetime, gaining some efficiency. If that's
1297 : * undesirable, pass NULL.
1298 : * --------------------------------
1299 : */
1300 : TupleTableSlot *
1301 32970314 : MakeTupleTableSlot(TupleDesc tupleDesc,
1302 : const TupleTableSlotOps *tts_ops)
1303 : {
1304 : Size basesz,
1305 : allocsz;
1306 : TupleTableSlot *slot;
1307 :
1308 32970314 : basesz = tts_ops->base_slot_size;
1309 :
1310 : /*
1311 : * When a fixed descriptor is specified, we can reduce overhead by
1312 : * allocating the entire slot in one go.
1313 : */
1314 32970314 : if (tupleDesc)
1315 32907870 : allocsz = MAXALIGN(basesz) +
1316 32907870 : MAXALIGN(tupleDesc->natts * sizeof(Datum)) +
1317 32907870 : MAXALIGN(tupleDesc->natts * sizeof(bool));
1318 : else
1319 62444 : allocsz = basesz;
1320 :
1321 32970314 : slot = palloc0(allocsz);
1322 : /* const for optimization purposes, OK to modify at allocation time */
1323 32970314 : *((const TupleTableSlotOps **) &slot->tts_ops) = tts_ops;
1324 32970314 : slot->type = T_TupleTableSlot;
1325 32970314 : slot->tts_flags |= TTS_FLAG_EMPTY;
1326 32970314 : if (tupleDesc != NULL)
1327 32907870 : slot->tts_flags |= TTS_FLAG_FIXED;
1328 32970314 : slot->tts_tupleDescriptor = tupleDesc;
1329 32970314 : slot->tts_mcxt = CurrentMemoryContext;
1330 32970314 : slot->tts_nvalid = 0;
1331 :
1332 32970314 : if (tupleDesc != NULL)
1333 : {
1334 32907870 : slot->tts_values = (Datum *)
1335 : (((char *) slot)
1336 32907870 : + MAXALIGN(basesz));
1337 32907870 : slot->tts_isnull = (bool *)
1338 : (((char *) slot)
1339 32907870 : + MAXALIGN(basesz)
1340 32907870 : + MAXALIGN(tupleDesc->natts * sizeof(Datum)));
1341 :
1342 32907870 : PinTupleDesc(tupleDesc);
1343 : }
1344 :
1345 : /*
1346 : * And allow slot type specific initialization.
1347 : */
1348 32970314 : slot->tts_ops->init(slot);
1349 :
1350 32970314 : return slot;
1351 : }
1352 :
1353 : /* --------------------------------
1354 : * ExecAllocTableSlot
1355 : *
1356 : * Create a tuple table slot within a tuple table (which is just a List).
1357 : * --------------------------------
1358 : */
1359 : TupleTableSlot *
1360 2064072 : ExecAllocTableSlot(List **tupleTable, TupleDesc desc,
1361 : const TupleTableSlotOps *tts_ops)
1362 : {
1363 2064072 : TupleTableSlot *slot = MakeTupleTableSlot(desc, tts_ops);
1364 :
1365 2064072 : *tupleTable = lappend(*tupleTable, slot);
1366 :
1367 2064072 : return slot;
1368 : }
1369 :
1370 : /* --------------------------------
1371 : * ExecResetTupleTable
1372 : *
1373 : * This releases any resources (buffer pins, tupdesc refcounts)
1374 : * held by the tuple table, and optionally releases the memory
1375 : * occupied by the tuple table data structure.
1376 : * It is expected that this routine be called by ExecEndPlan().
1377 : * --------------------------------
1378 : */
1379 : void
1380 870412 : ExecResetTupleTable(List *tupleTable, /* tuple table */
1381 : bool shouldFree) /* true if we should free memory */
1382 : {
1383 : ListCell *lc;
1384 :
1385 3165054 : foreach(lc, tupleTable)
1386 : {
1387 2294642 : TupleTableSlot *slot = lfirst_node(TupleTableSlot, lc);
1388 :
1389 : /* Always release resources and reset the slot to empty */
1390 2294642 : ExecClearTuple(slot);
1391 2294642 : slot->tts_ops->release(slot);
1392 2294642 : if (slot->tts_tupleDescriptor)
1393 : {
1394 2294588 : ReleaseTupleDesc(slot->tts_tupleDescriptor);
1395 2294588 : slot->tts_tupleDescriptor = NULL;
1396 : }
1397 :
1398 : /* If shouldFree, release memory occupied by the slot itself */
1399 2294642 : if (shouldFree)
1400 : {
1401 5864 : if (!TTS_FIXED(slot))
1402 : {
1403 0 : if (slot->tts_values)
1404 0 : pfree(slot->tts_values);
1405 0 : if (slot->tts_isnull)
1406 0 : pfree(slot->tts_isnull);
1407 : }
1408 5864 : pfree(slot);
1409 : }
1410 : }
1411 :
1412 : /* If shouldFree, release the list structure */
1413 870412 : if (shouldFree)
1414 5724 : list_free(tupleTable);
1415 870412 : }
1416 :
1417 : /* --------------------------------
1418 : * MakeSingleTupleTableSlot
1419 : *
1420 : * This is a convenience routine for operations that need a standalone
1421 : * TupleTableSlot not gotten from the main executor tuple table. It makes
1422 : * a single slot of given TupleTableSlotType and initializes it to use the
1423 : * given tuple descriptor.
1424 : * --------------------------------
1425 : */
1426 : TupleTableSlot *
1427 30906060 : MakeSingleTupleTableSlot(TupleDesc tupdesc,
1428 : const TupleTableSlotOps *tts_ops)
1429 : {
1430 30906060 : TupleTableSlot *slot = MakeTupleTableSlot(tupdesc, tts_ops);
1431 :
1432 30906060 : return slot;
1433 : }
1434 :
1435 : /* --------------------------------
1436 : * ExecDropSingleTupleTableSlot
1437 : *
1438 : * Release a TupleTableSlot made with MakeSingleTupleTableSlot.
1439 : * DON'T use this on a slot that's part of a tuple table list!
1440 : * --------------------------------
1441 : */
1442 : void
1443 30579656 : ExecDropSingleTupleTableSlot(TupleTableSlot *slot)
1444 : {
1445 : /* This should match ExecResetTupleTable's processing of one slot */
1446 : Assert(IsA(slot, TupleTableSlot));
1447 30579656 : ExecClearTuple(slot);
1448 30579656 : slot->tts_ops->release(slot);
1449 30579656 : if (slot->tts_tupleDescriptor)
1450 30579656 : ReleaseTupleDesc(slot->tts_tupleDescriptor);
1451 30579656 : if (!TTS_FIXED(slot))
1452 : {
1453 0 : if (slot->tts_values)
1454 0 : pfree(slot->tts_values);
1455 0 : if (slot->tts_isnull)
1456 0 : pfree(slot->tts_isnull);
1457 : }
1458 30579656 : pfree(slot);
1459 30579656 : }
1460 :
1461 :
1462 : /* ----------------------------------------------------------------
1463 : * tuple table slot accessor functions
1464 : * ----------------------------------------------------------------
1465 : */
1466 :
1467 : /* --------------------------------
1468 : * ExecSetSlotDescriptor
1469 : *
1470 : * This function is used to set the tuple descriptor associated
1471 : * with the slot's tuple. The passed descriptor must have lifespan
1472 : * at least equal to the slot's. If it is a reference-counted descriptor
1473 : * then the reference count is incremented for as long as the slot holds
1474 : * a reference.
1475 : * --------------------------------
1476 : */
1477 : void
1478 62390 : ExecSetSlotDescriptor(TupleTableSlot *slot, /* slot to change */
1479 : TupleDesc tupdesc) /* new tuple descriptor */
1480 : {
1481 : Assert(!TTS_FIXED(slot));
1482 :
1483 : /* For safety, make sure slot is empty before changing it */
1484 62390 : ExecClearTuple(slot);
1485 :
1486 : /*
1487 : * Release any old descriptor. Also release old Datum/isnull arrays if
1488 : * present (we don't bother to check if they could be re-used).
1489 : */
1490 62390 : if (slot->tts_tupleDescriptor)
1491 0 : ReleaseTupleDesc(slot->tts_tupleDescriptor);
1492 :
1493 62390 : if (slot->tts_values)
1494 0 : pfree(slot->tts_values);
1495 62390 : if (slot->tts_isnull)
1496 0 : pfree(slot->tts_isnull);
1497 :
1498 : /*
1499 : * Install the new descriptor; if it's refcounted, bump its refcount.
1500 : */
1501 62390 : slot->tts_tupleDescriptor = tupdesc;
1502 62390 : PinTupleDesc(tupdesc);
1503 :
1504 : /*
1505 : * Allocate Datum/isnull arrays of the appropriate size. These must have
1506 : * the same lifetime as the slot, so allocate in the slot's own context.
1507 : */
1508 62390 : slot->tts_values = (Datum *)
1509 62390 : MemoryContextAlloc(slot->tts_mcxt, tupdesc->natts * sizeof(Datum));
1510 62390 : slot->tts_isnull = (bool *)
1511 62390 : MemoryContextAlloc(slot->tts_mcxt, tupdesc->natts * sizeof(bool));
1512 62390 : }
1513 :
1514 : /* --------------------------------
1515 : * ExecStoreHeapTuple
1516 : *
1517 : * This function is used to store an on-the-fly physical tuple into a specified
1518 : * slot in the tuple table.
1519 : *
1520 : * tuple: tuple to store
1521 : * slot: TTSOpsHeapTuple type slot to store it in
1522 : * shouldFree: true if ExecClearTuple should pfree() the tuple
1523 : * when done with it
1524 : *
1525 : * shouldFree is normally set 'true' for tuples constructed on-the-fly. But it
1526 : * can be 'false' when the referenced tuple is held in a tuple table slot
1527 : * belonging to a lower-level executor Proc node. In this case the lower-level
1528 : * slot retains ownership and responsibility for eventually releasing the
1529 : * tuple. When this method is used, we must be certain that the upper-level
1530 : * Proc node will lose interest in the tuple sooner than the lower-level one
1531 : * does! If you're not certain, copy the lower-level tuple with heap_copytuple
1532 : * and let the upper-level table slot assume ownership of the copy!
1533 : *
1534 : * Return value is just the passed-in slot pointer.
1535 : *
1536 : * If the target slot is not guaranteed to be TTSOpsHeapTuple type slot, use
1537 : * the, more expensive, ExecForceStoreHeapTuple().
1538 : * --------------------------------
1539 : */
1540 : TupleTableSlot *
1541 4292446 : ExecStoreHeapTuple(HeapTuple tuple,
1542 : TupleTableSlot *slot,
1543 : bool shouldFree)
1544 : {
1545 : /*
1546 : * sanity checks
1547 : */
1548 : Assert(tuple != NULL);
1549 : Assert(slot != NULL);
1550 : Assert(slot->tts_tupleDescriptor != NULL);
1551 :
1552 4292446 : if (unlikely(!TTS_IS_HEAPTUPLE(slot)))
1553 0 : elog(ERROR, "trying to store a heap tuple into wrong type of slot");
1554 4292446 : tts_heap_store_tuple(slot, tuple, shouldFree);
1555 :
1556 4292446 : slot->tts_tableOid = tuple->t_tableOid;
1557 :
1558 4292446 : return slot;
1559 : }
1560 :
1561 : /* --------------------------------
1562 : * ExecStoreBufferHeapTuple
1563 : *
1564 : * This function is used to store an on-disk physical tuple from a buffer
1565 : * into a specified slot in the tuple table.
1566 : *
1567 : * tuple: tuple to store
1568 : * slot: TTSOpsBufferHeapTuple type slot to store it in
1569 : * buffer: disk buffer if tuple is in a disk page, else InvalidBuffer
1570 : *
1571 : * The tuple table code acquires a pin on the buffer which is held until the
1572 : * slot is cleared, so that the tuple won't go away on us.
1573 : *
1574 : * Return value is just the passed-in slot pointer.
1575 : *
1576 : * If the target slot is not guaranteed to be TTSOpsBufferHeapTuple type slot,
1577 : * use the, more expensive, ExecForceStoreHeapTuple().
1578 : * --------------------------------
1579 : */
1580 : TupleTableSlot *
1581 156323594 : ExecStoreBufferHeapTuple(HeapTuple tuple,
1582 : TupleTableSlot *slot,
1583 : Buffer buffer)
1584 : {
1585 : /*
1586 : * sanity checks
1587 : */
1588 : Assert(tuple != NULL);
1589 : Assert(slot != NULL);
1590 : Assert(slot->tts_tupleDescriptor != NULL);
1591 : Assert(BufferIsValid(buffer));
1592 :
1593 156323594 : if (unlikely(!TTS_IS_BUFFERTUPLE(slot)))
1594 0 : elog(ERROR, "trying to store an on-disk heap tuple into wrong type of slot");
1595 156323594 : tts_buffer_heap_store_tuple(slot, tuple, buffer, false);
1596 :
1597 156323594 : slot->tts_tableOid = tuple->t_tableOid;
1598 :
1599 156323594 : return slot;
1600 : }
1601 :
1602 : /*
1603 : * Like ExecStoreBufferHeapTuple, but transfer an existing pin from the caller
1604 : * to the slot, i.e. the caller doesn't need to, and may not, release the pin.
1605 : */
1606 : TupleTableSlot *
1607 522908 : ExecStorePinnedBufferHeapTuple(HeapTuple tuple,
1608 : TupleTableSlot *slot,
1609 : Buffer buffer)
1610 : {
1611 : /*
1612 : * sanity checks
1613 : */
1614 : Assert(tuple != NULL);
1615 : Assert(slot != NULL);
1616 : Assert(slot->tts_tupleDescriptor != NULL);
1617 : Assert(BufferIsValid(buffer));
1618 :
1619 522908 : if (unlikely(!TTS_IS_BUFFERTUPLE(slot)))
1620 0 : elog(ERROR, "trying to store an on-disk heap tuple into wrong type of slot");
1621 522908 : tts_buffer_heap_store_tuple(slot, tuple, buffer, true);
1622 :
1623 522908 : slot->tts_tableOid = tuple->t_tableOid;
1624 :
1625 522908 : return slot;
1626 : }
1627 :
1628 : /*
1629 : * Store a minimal tuple into TTSOpsMinimalTuple type slot.
1630 : *
1631 : * If the target slot is not guaranteed to be TTSOpsMinimalTuple type slot,
1632 : * use the, more expensive, ExecForceStoreMinimalTuple().
1633 : */
1634 : TupleTableSlot *
1635 56993180 : ExecStoreMinimalTuple(MinimalTuple mtup,
1636 : TupleTableSlot *slot,
1637 : bool shouldFree)
1638 : {
1639 : /*
1640 : * sanity checks
1641 : */
1642 : Assert(mtup != NULL);
1643 : Assert(slot != NULL);
1644 : Assert(slot->tts_tupleDescriptor != NULL);
1645 :
1646 56993180 : if (unlikely(!TTS_IS_MINIMALTUPLE(slot)))
1647 0 : elog(ERROR, "trying to store a minimal tuple into wrong type of slot");
1648 56993180 : tts_minimal_store_tuple(slot, mtup, shouldFree);
1649 :
1650 56993180 : return slot;
1651 : }
1652 :
1653 : /*
1654 : * Store a HeapTuple into any kind of slot, performing conversion if
1655 : * necessary.
1656 : */
1657 : void
1658 1732384 : ExecForceStoreHeapTuple(HeapTuple tuple,
1659 : TupleTableSlot *slot,
1660 : bool shouldFree)
1661 : {
1662 1732384 : if (TTS_IS_HEAPTUPLE(slot))
1663 : {
1664 522 : ExecStoreHeapTuple(tuple, slot, shouldFree);
1665 : }
1666 1731862 : else if (TTS_IS_BUFFERTUPLE(slot))
1667 : {
1668 : MemoryContext oldContext;
1669 72844 : BufferHeapTupleTableSlot *bslot = (BufferHeapTupleTableSlot *) slot;
1670 :
1671 72844 : ExecClearTuple(slot);
1672 72844 : slot->tts_flags &= ~TTS_FLAG_EMPTY;
1673 72844 : oldContext = MemoryContextSwitchTo(slot->tts_mcxt);
1674 72844 : bslot->base.tuple = heap_copytuple(tuple);
1675 72844 : slot->tts_flags |= TTS_FLAG_SHOULDFREE;
1676 72844 : MemoryContextSwitchTo(oldContext);
1677 :
1678 72844 : if (shouldFree)
1679 70906 : pfree(tuple);
1680 : }
1681 : else
1682 : {
1683 1659018 : ExecClearTuple(slot);
1684 1659018 : heap_deform_tuple(tuple, slot->tts_tupleDescriptor,
1685 : slot->tts_values, slot->tts_isnull);
1686 1659018 : ExecStoreVirtualTuple(slot);
1687 :
1688 1659018 : if (shouldFree)
1689 : {
1690 220566 : ExecMaterializeSlot(slot);
1691 220566 : pfree(tuple);
1692 : }
1693 : }
1694 1732384 : }
1695 :
1696 : /*
1697 : * Store a MinimalTuple into any kind of slot, performing conversion if
1698 : * necessary.
1699 : */
1700 : void
1701 6109586 : ExecForceStoreMinimalTuple(MinimalTuple mtup,
1702 : TupleTableSlot *slot,
1703 : bool shouldFree)
1704 : {
1705 6109586 : if (TTS_IS_MINIMALTUPLE(slot))
1706 : {
1707 3516530 : tts_minimal_store_tuple(slot, mtup, shouldFree);
1708 : }
1709 : else
1710 : {
1711 : HeapTupleData htup;
1712 :
1713 2593056 : ExecClearTuple(slot);
1714 :
1715 2593056 : htup.t_len = mtup->t_len + MINIMAL_TUPLE_OFFSET;
1716 2593056 : htup.t_data = (HeapTupleHeader) ((char *) mtup - MINIMAL_TUPLE_OFFSET);
1717 2593056 : heap_deform_tuple(&htup, slot->tts_tupleDescriptor,
1718 : slot->tts_values, slot->tts_isnull);
1719 2593056 : ExecStoreVirtualTuple(slot);
1720 :
1721 2593056 : if (shouldFree)
1722 : {
1723 1393032 : ExecMaterializeSlot(slot);
1724 1393032 : pfree(mtup);
1725 : }
1726 : }
1727 6109586 : }
1728 :
1729 : /* --------------------------------
1730 : * ExecStoreVirtualTuple
1731 : * Mark a slot as containing a virtual tuple.
1732 : *
1733 : * The protocol for loading a slot with virtual tuple data is:
1734 : * * Call ExecClearTuple to mark the slot empty.
1735 : * * Store data into the Datum/isnull arrays.
1736 : * * Call ExecStoreVirtualTuple to mark the slot valid.
1737 : * This is a bit unclean but it avoids one round of data copying.
1738 : * --------------------------------
1739 : */
1740 : TupleTableSlot *
1741 26412514 : ExecStoreVirtualTuple(TupleTableSlot *slot)
1742 : {
1743 : /*
1744 : * sanity checks
1745 : */
1746 : Assert(slot != NULL);
1747 : Assert(slot->tts_tupleDescriptor != NULL);
1748 : Assert(TTS_EMPTY(slot));
1749 :
1750 26412514 : slot->tts_flags &= ~TTS_FLAG_EMPTY;
1751 26412514 : slot->tts_nvalid = slot->tts_tupleDescriptor->natts;
1752 :
1753 26412514 : return slot;
1754 : }
1755 :
1756 : /* --------------------------------
1757 : * ExecStoreAllNullTuple
1758 : * Set up the slot to contain a null in every column.
1759 : *
1760 : * At first glance this might sound just like ExecClearTuple, but it's
1761 : * entirely different: the slot ends up full, not empty.
1762 : * --------------------------------
1763 : */
1764 : TupleTableSlot *
1765 43226 : ExecStoreAllNullTuple(TupleTableSlot *slot)
1766 : {
1767 : /*
1768 : * sanity checks
1769 : */
1770 : Assert(slot != NULL);
1771 : Assert(slot->tts_tupleDescriptor != NULL);
1772 :
1773 : /* Clear any old contents */
1774 43226 : ExecClearTuple(slot);
1775 :
1776 : /*
1777 : * Fill all the columns of the virtual tuple with nulls
1778 : */
1779 329178 : MemSet(slot->tts_values, 0,
1780 : slot->tts_tupleDescriptor->natts * sizeof(Datum));
1781 43226 : memset(slot->tts_isnull, true,
1782 43226 : slot->tts_tupleDescriptor->natts * sizeof(bool));
1783 :
1784 43226 : return ExecStoreVirtualTuple(slot);
1785 : }
1786 :
1787 : /*
1788 : * Store a HeapTuple in datum form, into a slot. That always requires
1789 : * deforming it and storing it in virtual form.
1790 : *
1791 : * Until the slot is materialized, the contents of the slot depend on the
1792 : * datum.
1793 : */
1794 : void
1795 0 : ExecStoreHeapTupleDatum(Datum data, TupleTableSlot *slot)
1796 : {
1797 0 : HeapTupleData tuple = {0};
1798 : HeapTupleHeader td;
1799 :
1800 0 : td = DatumGetHeapTupleHeader(data);
1801 :
1802 0 : tuple.t_len = HeapTupleHeaderGetDatumLength(td);
1803 0 : tuple.t_self = td->t_ctid;
1804 0 : tuple.t_data = td;
1805 :
1806 0 : ExecClearTuple(slot);
1807 :
1808 0 : heap_deform_tuple(&tuple, slot->tts_tupleDescriptor,
1809 : slot->tts_values, slot->tts_isnull);
1810 0 : ExecStoreVirtualTuple(slot);
1811 0 : }
1812 :
1813 : /*
1814 : * ExecFetchSlotHeapTuple - fetch HeapTuple representing the slot's content
1815 : *
1816 : * The returned HeapTuple represents the slot's content as closely as
1817 : * possible.
1818 : *
1819 : * If materialize is true, the contents of the slots will be made independent
1820 : * from the underlying storage (i.e. all buffer pins are released, memory is
1821 : * allocated in the slot's context).
1822 : *
1823 : * If shouldFree is not-NULL it'll be set to true if the returned tuple has
1824 : * been allocated in the calling memory context, and must be freed by the
1825 : * caller (via explicit pfree() or a memory context reset).
1826 : *
1827 : * NB: If materialize is true, modifications of the returned tuple are
1828 : * allowed. But it depends on the type of the slot whether such modifications
1829 : * will also affect the slot's contents. While that is not the nicest
1830 : * behaviour, all such modifications are in the process of being removed.
1831 : */
1832 : HeapTuple
1833 45352032 : ExecFetchSlotHeapTuple(TupleTableSlot *slot, bool materialize, bool *shouldFree)
1834 : {
1835 : /*
1836 : * sanity checks
1837 : */
1838 : Assert(slot != NULL);
1839 : Assert(!TTS_EMPTY(slot));
1840 :
1841 : /* Materialize the tuple so that the slot "owns" it, if requested. */
1842 45352032 : if (materialize)
1843 20647220 : slot->tts_ops->materialize(slot);
1844 :
1845 45352032 : if (slot->tts_ops->get_heap_tuple == NULL)
1846 : {
1847 3063382 : if (shouldFree)
1848 3063382 : *shouldFree = true;
1849 3063382 : return slot->tts_ops->copy_heap_tuple(slot);
1850 : }
1851 : else
1852 : {
1853 42288650 : if (shouldFree)
1854 37589530 : *shouldFree = false;
1855 42288650 : return slot->tts_ops->get_heap_tuple(slot);
1856 : }
1857 : }
1858 :
1859 : /* --------------------------------
1860 : * ExecFetchSlotMinimalTuple
1861 : * Fetch the slot's minimal physical tuple.
1862 : *
1863 : * If the given tuple table slot can hold a minimal tuple, indicated by a
1864 : * non-NULL get_minimal_tuple callback, the function returns the minimal
1865 : * tuple returned by that callback. It assumes that the minimal tuple
1866 : * returned by the callback is "owned" by the slot i.e. the slot is
1867 : * responsible for freeing the memory consumed by the tuple. Hence it sets
1868 : * *shouldFree to false, indicating that the caller should not free the
1869 : * memory consumed by the minimal tuple. In this case the returned minimal
1870 : * tuple should be considered as read-only.
1871 : *
1872 : * If that callback is not supported, it calls copy_minimal_tuple callback
1873 : * which is expected to return a copy of minimal tuple representing the
1874 : * contents of the slot. In this case *shouldFree is set to true,
1875 : * indicating the caller that it should free the memory consumed by the
1876 : * minimal tuple. In this case the returned minimal tuple may be written
1877 : * up.
1878 : * --------------------------------
1879 : */
1880 : MinimalTuple
1881 18913054 : ExecFetchSlotMinimalTuple(TupleTableSlot *slot,
1882 : bool *shouldFree)
1883 : {
1884 : /*
1885 : * sanity checks
1886 : */
1887 : Assert(slot != NULL);
1888 : Assert(!TTS_EMPTY(slot));
1889 :
1890 18913054 : if (slot->tts_ops->get_minimal_tuple)
1891 : {
1892 4033314 : if (shouldFree)
1893 4033314 : *shouldFree = false;
1894 4033314 : return slot->tts_ops->get_minimal_tuple(slot);
1895 : }
1896 : else
1897 : {
1898 14879740 : if (shouldFree)
1899 14879740 : *shouldFree = true;
1900 14879740 : return slot->tts_ops->copy_minimal_tuple(slot, 0);
1901 : }
1902 : }
1903 :
1904 : /* --------------------------------
1905 : * ExecFetchSlotHeapTupleDatum
1906 : * Fetch the slot's tuple as a composite-type Datum.
1907 : *
1908 : * The result is always freshly palloc'd in the caller's memory context.
1909 : * --------------------------------
1910 : */
1911 : Datum
1912 60598 : ExecFetchSlotHeapTupleDatum(TupleTableSlot *slot)
1913 : {
1914 : HeapTuple tup;
1915 : TupleDesc tupdesc;
1916 : bool shouldFree;
1917 : Datum ret;
1918 :
1919 : /* Fetch slot's contents in regular-physical-tuple form */
1920 60598 : tup = ExecFetchSlotHeapTuple(slot, false, &shouldFree);
1921 60598 : tupdesc = slot->tts_tupleDescriptor;
1922 :
1923 : /* Convert to Datum form */
1924 60598 : ret = heap_copy_tuple_as_datum(tup, tupdesc);
1925 :
1926 60598 : if (shouldFree)
1927 60598 : pfree(tup);
1928 :
1929 60598 : return ret;
1930 : }
1931 :
1932 : /* ----------------------------------------------------------------
1933 : * convenience initialization routines
1934 : * ----------------------------------------------------------------
1935 : */
1936 :
1937 : /* ----------------
1938 : * ExecInitResultTypeTL
1939 : *
1940 : * Initialize result type, using the plan node's targetlist.
1941 : * ----------------
1942 : */
1943 : void
1944 1326942 : ExecInitResultTypeTL(PlanState *planstate)
1945 : {
1946 1326942 : TupleDesc tupDesc = ExecTypeFromTL(planstate->plan->targetlist);
1947 :
1948 1326942 : planstate->ps_ResultTupleDesc = tupDesc;
1949 1326942 : }
1950 :
1951 : /* --------------------------------
1952 : * ExecInit{Result,Scan,Extra}TupleSlot[TL]
1953 : *
1954 : * These are convenience routines to initialize the specified slot
1955 : * in nodes inheriting the appropriate state. ExecInitExtraTupleSlot
1956 : * is used for initializing special-purpose slots.
1957 : * --------------------------------
1958 : */
1959 :
1960 : /* ----------------
1961 : * ExecInitResultTupleSlotTL
1962 : *
1963 : * Initialize result tuple slot, using the tuple descriptor previously
1964 : * computed with ExecInitResultTypeTL().
1965 : * ----------------
1966 : */
1967 : void
1968 899532 : ExecInitResultSlot(PlanState *planstate, const TupleTableSlotOps *tts_ops)
1969 : {
1970 : TupleTableSlot *slot;
1971 :
1972 899532 : slot = ExecAllocTableSlot(&planstate->state->es_tupleTable,
1973 : planstate->ps_ResultTupleDesc, tts_ops);
1974 899532 : planstate->ps_ResultTupleSlot = slot;
1975 :
1976 899532 : planstate->resultopsfixed = planstate->ps_ResultTupleDesc != NULL;
1977 899532 : planstate->resultops = tts_ops;
1978 899532 : planstate->resultopsset = true;
1979 899532 : }
1980 :
1981 : /* ----------------
1982 : * ExecInitResultTupleSlotTL
1983 : *
1984 : * Initialize result tuple slot, using the plan node's targetlist.
1985 : * ----------------
1986 : */
1987 : void
1988 645104 : ExecInitResultTupleSlotTL(PlanState *planstate,
1989 : const TupleTableSlotOps *tts_ops)
1990 : {
1991 645104 : ExecInitResultTypeTL(planstate);
1992 645104 : ExecInitResultSlot(planstate, tts_ops);
1993 645104 : }
1994 :
1995 : /* ----------------
1996 : * ExecInitScanTupleSlot
1997 : * ----------------
1998 : */
1999 : void
2000 688828 : ExecInitScanTupleSlot(EState *estate, ScanState *scanstate,
2001 : TupleDesc tupledesc, const TupleTableSlotOps *tts_ops)
2002 : {
2003 688828 : scanstate->ss_ScanTupleSlot = ExecAllocTableSlot(&estate->es_tupleTable,
2004 : tupledesc, tts_ops);
2005 688828 : scanstate->ps.scandesc = tupledesc;
2006 688828 : scanstate->ps.scanopsfixed = tupledesc != NULL;
2007 688828 : scanstate->ps.scanops = tts_ops;
2008 688828 : scanstate->ps.scanopsset = true;
2009 688828 : }
2010 :
2011 : /* ----------------
2012 : * ExecInitExtraTupleSlot
2013 : *
2014 : * Return a newly created slot. If tupledesc is non-NULL the slot will have
2015 : * that as its fixed tupledesc. Otherwise the caller needs to use
2016 : * ExecSetSlotDescriptor() to set the descriptor before use.
2017 : * ----------------
2018 : */
2019 : TupleTableSlot *
2020 452482 : ExecInitExtraTupleSlot(EState *estate,
2021 : TupleDesc tupledesc,
2022 : const TupleTableSlotOps *tts_ops)
2023 : {
2024 452482 : return ExecAllocTableSlot(&estate->es_tupleTable, tupledesc, tts_ops);
2025 : }
2026 :
2027 : /* ----------------
2028 : * ExecInitNullTupleSlot
2029 : *
2030 : * Build a slot containing an all-nulls tuple of the given type.
2031 : * This is used as a substitute for an input tuple when performing an
2032 : * outer join.
2033 : * ----------------
2034 : */
2035 : TupleTableSlot *
2036 41960 : ExecInitNullTupleSlot(EState *estate, TupleDesc tupType,
2037 : const TupleTableSlotOps *tts_ops)
2038 : {
2039 41960 : TupleTableSlot *slot = ExecInitExtraTupleSlot(estate, tupType, tts_ops);
2040 :
2041 41960 : return ExecStoreAllNullTuple(slot);
2042 : }
2043 :
2044 : /* ---------------------------------------------------------------
2045 : * Routines for setting/accessing attributes in a slot.
2046 : * ---------------------------------------------------------------
2047 : */
2048 :
2049 : /*
2050 : * Fill in missing values for a TupleTableSlot.
2051 : *
2052 : * This is only exposed because it's needed for JIT compiled tuple
2053 : * deforming. That exception aside, there should be no callers outside of this
2054 : * file.
2055 : */
2056 : void
2057 8042 : slot_getmissingattrs(TupleTableSlot *slot, int startAttNum, int lastAttNum)
2058 : {
2059 8042 : AttrMissing *attrmiss = NULL;
2060 :
2061 8042 : if (slot->tts_tupleDescriptor->constr)
2062 4690 : attrmiss = slot->tts_tupleDescriptor->constr->missing;
2063 :
2064 8042 : if (!attrmiss)
2065 : {
2066 : /* no missing values array at all, so just fill everything in as NULL */
2067 3562 : memset(slot->tts_values + startAttNum, 0,
2068 3562 : (lastAttNum - startAttNum) * sizeof(Datum));
2069 3562 : memset(slot->tts_isnull + startAttNum, 1,
2070 3562 : (lastAttNum - startAttNum) * sizeof(bool));
2071 : }
2072 : else
2073 : {
2074 : int missattnum;
2075 :
2076 : /* if there is a missing values array we must process them one by one */
2077 10418 : for (missattnum = startAttNum;
2078 : missattnum < lastAttNum;
2079 5938 : missattnum++)
2080 : {
2081 5938 : slot->tts_values[missattnum] = attrmiss[missattnum].am_value;
2082 5938 : slot->tts_isnull[missattnum] = !attrmiss[missattnum].am_present;
2083 : }
2084 : }
2085 8042 : }
2086 :
2087 : /*
2088 : * slot_getsomeattrs_int - workhorse for slot_getsomeattrs()
2089 : */
2090 : void
2091 193177182 : slot_getsomeattrs_int(TupleTableSlot *slot, int attnum)
2092 : {
2093 : /* Check for caller errors */
2094 : Assert(slot->tts_nvalid < attnum); /* checked in slot_getsomeattrs */
2095 : Assert(attnum > 0);
2096 :
2097 193177182 : if (unlikely(attnum > slot->tts_tupleDescriptor->natts))
2098 0 : elog(ERROR, "invalid attribute number %d", attnum);
2099 :
2100 : /* Fetch as many attributes as possible from the underlying tuple. */
2101 193177182 : slot->tts_ops->getsomeattrs(slot, attnum);
2102 :
2103 : /*
2104 : * If the underlying tuple doesn't have enough attributes, tuple
2105 : * descriptor must have the missing attributes.
2106 : */
2107 193177182 : if (unlikely(slot->tts_nvalid < attnum))
2108 : {
2109 8042 : slot_getmissingattrs(slot, slot->tts_nvalid, attnum);
2110 8042 : slot->tts_nvalid = attnum;
2111 : }
2112 193177182 : }
2113 :
2114 : /* ----------------------------------------------------------------
2115 : * ExecTypeFromTL
2116 : *
2117 : * Generate a tuple descriptor for the result tuple of a targetlist.
2118 : * (A parse/plan tlist must be passed, not an ExprState tlist.)
2119 : * Note that resjunk columns, if any, are included in the result.
2120 : *
2121 : * Currently there are about 4 different places where we create
2122 : * TupleDescriptors. They should all be merged, or perhaps
2123 : * be rewritten to call BuildDesc().
2124 : * ----------------------------------------------------------------
2125 : */
2126 : TupleDesc
2127 1354686 : ExecTypeFromTL(List *targetList)
2128 : {
2129 1354686 : return ExecTypeFromTLInternal(targetList, false);
2130 : }
2131 :
2132 : /* ----------------------------------------------------------------
2133 : * ExecCleanTypeFromTL
2134 : *
2135 : * Same as above, but resjunk columns are omitted from the result.
2136 : * ----------------------------------------------------------------
2137 : */
2138 : TupleDesc
2139 119338 : ExecCleanTypeFromTL(List *targetList)
2140 : {
2141 119338 : return ExecTypeFromTLInternal(targetList, true);
2142 : }
2143 :
2144 : static TupleDesc
2145 1474024 : ExecTypeFromTLInternal(List *targetList, bool skipjunk)
2146 : {
2147 : TupleDesc typeInfo;
2148 : ListCell *l;
2149 : int len;
2150 1474024 : int cur_resno = 1;
2151 :
2152 1474024 : if (skipjunk)
2153 119338 : len = ExecCleanTargetListLength(targetList);
2154 : else
2155 1354686 : len = ExecTargetListLength(targetList);
2156 1474024 : typeInfo = CreateTemplateTupleDesc(len);
2157 :
2158 7784982 : foreach(l, targetList)
2159 : {
2160 6310958 : TargetEntry *tle = lfirst(l);
2161 :
2162 6310958 : if (skipjunk && tle->resjunk)
2163 33708 : continue;
2164 18831750 : TupleDescInitEntry(typeInfo,
2165 : cur_resno,
2166 6277250 : tle->resname,
2167 6277250 : exprType((Node *) tle->expr),
2168 6277250 : exprTypmod((Node *) tle->expr),
2169 : 0);
2170 6277250 : TupleDescInitEntryCollation(typeInfo,
2171 : cur_resno,
2172 6277250 : exprCollation((Node *) tle->expr));
2173 6277250 : cur_resno++;
2174 : }
2175 :
2176 1474024 : return typeInfo;
2177 : }
2178 :
2179 : /*
2180 : * ExecTypeFromExprList - build a tuple descriptor from a list of Exprs
2181 : *
2182 : * This is roughly like ExecTypeFromTL, but we work from bare expressions
2183 : * not TargetEntrys. No names are attached to the tupledesc's columns.
2184 : */
2185 : TupleDesc
2186 13614 : ExecTypeFromExprList(List *exprList)
2187 : {
2188 : TupleDesc typeInfo;
2189 : ListCell *lc;
2190 13614 : int cur_resno = 1;
2191 :
2192 13614 : typeInfo = CreateTemplateTupleDesc(list_length(exprList));
2193 :
2194 38010 : foreach(lc, exprList)
2195 : {
2196 24396 : Node *e = lfirst(lc);
2197 :
2198 24396 : TupleDescInitEntry(typeInfo,
2199 : cur_resno,
2200 : NULL,
2201 : exprType(e),
2202 : exprTypmod(e),
2203 : 0);
2204 24396 : TupleDescInitEntryCollation(typeInfo,
2205 : cur_resno,
2206 : exprCollation(e));
2207 24396 : cur_resno++;
2208 : }
2209 :
2210 13614 : return typeInfo;
2211 : }
2212 :
2213 : /*
2214 : * ExecTypeSetColNames - set column names in a RECORD TupleDesc
2215 : *
2216 : * Column names must be provided as an alias list (list of String nodes).
2217 : */
2218 : void
2219 4004 : ExecTypeSetColNames(TupleDesc typeInfo, List *namesList)
2220 : {
2221 4004 : int colno = 0;
2222 : ListCell *lc;
2223 :
2224 : /* It's only OK to change col names in a not-yet-blessed RECORD type */
2225 : Assert(typeInfo->tdtypeid == RECORDOID);
2226 : Assert(typeInfo->tdtypmod < 0);
2227 :
2228 14330 : foreach(lc, namesList)
2229 : {
2230 10326 : char *cname = strVal(lfirst(lc));
2231 : Form_pg_attribute attr;
2232 :
2233 : /* Guard against too-long names list (probably can't happen) */
2234 10326 : if (colno >= typeInfo->natts)
2235 0 : break;
2236 10326 : attr = TupleDescAttr(typeInfo, colno);
2237 10326 : colno++;
2238 :
2239 : /*
2240 : * Do nothing for empty aliases or dropped columns (these cases
2241 : * probably can't arise in RECORD types, either)
2242 : */
2243 10326 : if (cname[0] == '\0' || attr->attisdropped)
2244 28 : continue;
2245 :
2246 : /* OK, assign the column name */
2247 10298 : namestrcpy(&(attr->attname), cname);
2248 : }
2249 4004 : }
2250 :
2251 : /*
2252 : * BlessTupleDesc - make a completed tuple descriptor useful for SRFs
2253 : *
2254 : * Rowtype Datums returned by a function must contain valid type information.
2255 : * This happens "for free" if the tupdesc came from a relcache entry, but
2256 : * not if we have manufactured a tupdesc for a transient RECORD datatype.
2257 : * In that case we have to notify typcache.c of the existence of the type.
2258 : */
2259 : TupleDesc
2260 77380 : BlessTupleDesc(TupleDesc tupdesc)
2261 : {
2262 77380 : if (tupdesc->tdtypeid == RECORDOID &&
2263 73758 : tupdesc->tdtypmod < 0)
2264 39592 : assign_record_type_typmod(tupdesc);
2265 :
2266 77380 : return tupdesc; /* just for notational convenience */
2267 : }
2268 :
2269 : /*
2270 : * TupleDescGetAttInMetadata - Build an AttInMetadata structure based on the
2271 : * supplied TupleDesc. AttInMetadata can be used in conjunction with C strings
2272 : * to produce a properly formed tuple.
2273 : */
2274 : AttInMetadata *
2275 7890 : TupleDescGetAttInMetadata(TupleDesc tupdesc)
2276 : {
2277 7890 : int natts = tupdesc->natts;
2278 : int i;
2279 : Oid atttypeid;
2280 : Oid attinfuncid;
2281 : FmgrInfo *attinfuncinfo;
2282 : Oid *attioparams;
2283 : int32 *atttypmods;
2284 : AttInMetadata *attinmeta;
2285 :
2286 7890 : attinmeta = (AttInMetadata *) palloc(sizeof(AttInMetadata));
2287 :
2288 : /* "Bless" the tupledesc so that we can make rowtype datums with it */
2289 7890 : attinmeta->tupdesc = BlessTupleDesc(tupdesc);
2290 :
2291 : /*
2292 : * Gather info needed later to call the "in" function for each attribute
2293 : */
2294 7890 : attinfuncinfo = (FmgrInfo *) palloc0(natts * sizeof(FmgrInfo));
2295 7890 : attioparams = (Oid *) palloc0(natts * sizeof(Oid));
2296 7890 : atttypmods = (int32 *) palloc0(natts * sizeof(int32));
2297 :
2298 81734 : for (i = 0; i < natts; i++)
2299 : {
2300 73844 : Form_pg_attribute att = TupleDescAttr(tupdesc, i);
2301 :
2302 : /* Ignore dropped attributes */
2303 73844 : if (!att->attisdropped)
2304 : {
2305 73614 : atttypeid = att->atttypid;
2306 73614 : getTypeInputInfo(atttypeid, &attinfuncid, &attioparams[i]);
2307 73614 : fmgr_info(attinfuncid, &attinfuncinfo[i]);
2308 73614 : atttypmods[i] = att->atttypmod;
2309 : }
2310 : }
2311 7890 : attinmeta->attinfuncs = attinfuncinfo;
2312 7890 : attinmeta->attioparams = attioparams;
2313 7890 : attinmeta->atttypmods = atttypmods;
2314 :
2315 7890 : return attinmeta;
2316 : }
2317 :
2318 : /*
2319 : * BuildTupleFromCStrings - build a HeapTuple given user data in C string form.
2320 : * values is an array of C strings, one for each attribute of the return tuple.
2321 : * A NULL string pointer indicates we want to create a NULL field.
2322 : */
2323 : HeapTuple
2324 1460228 : BuildTupleFromCStrings(AttInMetadata *attinmeta, char **values)
2325 : {
2326 1460228 : TupleDesc tupdesc = attinmeta->tupdesc;
2327 1460228 : int natts = tupdesc->natts;
2328 : Datum *dvalues;
2329 : bool *nulls;
2330 : int i;
2331 : HeapTuple tuple;
2332 :
2333 1460228 : dvalues = (Datum *) palloc(natts * sizeof(Datum));
2334 1460228 : nulls = (bool *) palloc(natts * sizeof(bool));
2335 :
2336 : /*
2337 : * Call the "in" function for each non-dropped attribute, even for nulls,
2338 : * to support domains.
2339 : */
2340 25948266 : for (i = 0; i < natts; i++)
2341 : {
2342 24488040 : if (!TupleDescCompactAttr(tupdesc, i)->attisdropped)
2343 : {
2344 : /* Non-dropped attributes */
2345 48976078 : dvalues[i] = InputFunctionCall(&attinmeta->attinfuncs[i],
2346 24488040 : values[i],
2347 24488040 : attinmeta->attioparams[i],
2348 24488040 : attinmeta->atttypmods[i]);
2349 24488038 : if (values[i] != NULL)
2350 16695370 : nulls[i] = false;
2351 : else
2352 7792668 : nulls[i] = true;
2353 : }
2354 : else
2355 : {
2356 : /* Handle dropped attributes by setting to NULL */
2357 0 : dvalues[i] = (Datum) 0;
2358 0 : nulls[i] = true;
2359 : }
2360 : }
2361 :
2362 : /*
2363 : * Form a tuple
2364 : */
2365 1460226 : tuple = heap_form_tuple(tupdesc, dvalues, nulls);
2366 :
2367 : /*
2368 : * Release locally palloc'd space. XXX would probably be good to pfree
2369 : * values of pass-by-reference datums, as well.
2370 : */
2371 1460226 : pfree(dvalues);
2372 1460226 : pfree(nulls);
2373 :
2374 1460226 : return tuple;
2375 : }
2376 :
2377 : /*
2378 : * HeapTupleHeaderGetDatum - convert a HeapTupleHeader pointer to a Datum.
2379 : *
2380 : * This must *not* get applied to an on-disk tuple; the tuple should be
2381 : * freshly made by heap_form_tuple or some wrapper routine for it (such as
2382 : * BuildTupleFromCStrings). Be sure also that the tupledesc used to build
2383 : * the tuple has a properly "blessed" rowtype.
2384 : *
2385 : * Formerly this was a macro equivalent to PointerGetDatum, relying on the
2386 : * fact that heap_form_tuple fills in the appropriate tuple header fields
2387 : * for a composite Datum. However, we now require that composite Datums not
2388 : * contain any external TOAST pointers. We do not want heap_form_tuple itself
2389 : * to enforce that; more specifically, the rule applies only to actual Datums
2390 : * and not to HeapTuple structures. Therefore, HeapTupleHeaderGetDatum is
2391 : * now a function that detects whether there are externally-toasted fields
2392 : * and constructs a new tuple with inlined fields if so. We still need
2393 : * heap_form_tuple to insert the Datum header fields, because otherwise this
2394 : * code would have no way to obtain a tupledesc for the tuple.
2395 : *
2396 : * Note that if we do build a new tuple, it's palloc'd in the current
2397 : * memory context. Beware of code that changes context between the initial
2398 : * heap_form_tuple/etc call and calling HeapTuple(Header)GetDatum.
2399 : *
2400 : * For performance-critical callers, it could be worthwhile to take extra
2401 : * steps to ensure that there aren't TOAST pointers in the output of
2402 : * heap_form_tuple to begin with. It's likely however that the costs of the
2403 : * typcache lookup and tuple disassembly/reassembly are swamped by TOAST
2404 : * dereference costs, so that the benefits of such extra effort would be
2405 : * minimal.
2406 : *
2407 : * XXX it would likely be better to create wrapper functions that produce
2408 : * a composite Datum from the field values in one step. However, there's
2409 : * enough code using the existing APIs that we couldn't get rid of this
2410 : * hack anytime soon.
2411 : */
2412 : Datum
2413 1739232 : HeapTupleHeaderGetDatum(HeapTupleHeader tuple)
2414 : {
2415 : Datum result;
2416 : TupleDesc tupDesc;
2417 :
2418 : /* No work if there are no external TOAST pointers in the tuple */
2419 1739232 : if (!HeapTupleHeaderHasExternal(tuple))
2420 1739220 : return PointerGetDatum(tuple);
2421 :
2422 : /* Use the type data saved by heap_form_tuple to look up the rowtype */
2423 12 : tupDesc = lookup_rowtype_tupdesc(HeapTupleHeaderGetTypeId(tuple),
2424 : HeapTupleHeaderGetTypMod(tuple));
2425 :
2426 : /* And do the flattening */
2427 12 : result = toast_flatten_tuple_to_datum(tuple,
2428 : HeapTupleHeaderGetDatumLength(tuple),
2429 : tupDesc);
2430 :
2431 12 : ReleaseTupleDesc(tupDesc);
2432 :
2433 12 : return result;
2434 : }
2435 :
2436 :
2437 : /*
2438 : * Functions for sending tuples to the frontend (or other specified destination)
2439 : * as though it is a SELECT result. These are used by utility commands that
2440 : * need to project directly to the destination and don't need or want full
2441 : * table function capability. Currently used by EXPLAIN and SHOW ALL.
2442 : */
2443 : TupOutputState *
2444 29028 : begin_tup_output_tupdesc(DestReceiver *dest,
2445 : TupleDesc tupdesc,
2446 : const TupleTableSlotOps *tts_ops)
2447 : {
2448 : TupOutputState *tstate;
2449 :
2450 29028 : tstate = (TupOutputState *) palloc(sizeof(TupOutputState));
2451 :
2452 29028 : tstate->slot = MakeSingleTupleTableSlot(tupdesc, tts_ops);
2453 29028 : tstate->dest = dest;
2454 :
2455 29028 : tstate->dest->rStartup(tstate->dest, (int) CMD_SELECT, tupdesc);
2456 :
2457 29028 : return tstate;
2458 : }
2459 :
2460 : /*
2461 : * write a single tuple
2462 : */
2463 : void
2464 160126 : do_tup_output(TupOutputState *tstate, const Datum *values, const bool *isnull)
2465 : {
2466 160126 : TupleTableSlot *slot = tstate->slot;
2467 160126 : int natts = slot->tts_tupleDescriptor->natts;
2468 :
2469 : /* make sure the slot is clear */
2470 160126 : ExecClearTuple(slot);
2471 :
2472 : /* insert data */
2473 160126 : memcpy(slot->tts_values, values, natts * sizeof(Datum));
2474 160126 : memcpy(slot->tts_isnull, isnull, natts * sizeof(bool));
2475 :
2476 : /* mark slot as containing a virtual tuple */
2477 160126 : ExecStoreVirtualTuple(slot);
2478 :
2479 : /* send the tuple to the receiver */
2480 160126 : (void) tstate->dest->receiveSlot(slot, tstate->dest);
2481 :
2482 : /* clean up */
2483 160126 : ExecClearTuple(slot);
2484 160126 : }
2485 :
2486 : /*
2487 : * write a chunk of text, breaking at newline characters
2488 : *
2489 : * Should only be used with a single-TEXT-attribute tupdesc.
2490 : */
2491 : void
2492 23312 : do_text_output_multiline(TupOutputState *tstate, const char *txt)
2493 : {
2494 : Datum values[1];
2495 23312 : bool isnull[1] = {false};
2496 :
2497 176244 : while (*txt)
2498 : {
2499 : const char *eol;
2500 : int len;
2501 :
2502 152932 : eol = strchr(txt, '\n');
2503 152932 : if (eol)
2504 : {
2505 152932 : len = eol - txt;
2506 152932 : eol++;
2507 : }
2508 : else
2509 : {
2510 0 : len = strlen(txt);
2511 0 : eol = txt + len;
2512 : }
2513 :
2514 152932 : values[0] = PointerGetDatum(cstring_to_text_with_len(txt, len));
2515 152932 : do_tup_output(tstate, values, isnull);
2516 152932 : pfree(DatumGetPointer(values[0]));
2517 152932 : txt = eol;
2518 : }
2519 23312 : }
2520 :
2521 : void
2522 29028 : end_tup_output(TupOutputState *tstate)
2523 : {
2524 29028 : tstate->dest->rShutdown(tstate->dest);
2525 : /* note that destroying the dest is not ours to do */
2526 29028 : ExecDropSingleTupleTableSlot(tstate->slot);
2527 29028 : pfree(tstate);
2528 29028 : }
|
