Branch data Line data Source code
1 : : /*-------------------------------------------------------------------------
2 : : *
3 : : * toast_helper.c
4 : : * Helper functions for table AMs implementing compressed or
5 : : * out-of-line storage of varlena attributes.
6 : : *
7 : : * Copyright (c) 2000-2026, PostgreSQL Global Development Group
8 : : *
9 : : * IDENTIFICATION
10 : : * src/backend/access/table/toast_helper.c
11 : : *
12 : : *-------------------------------------------------------------------------
13 : : */
14 : :
15 : : #include "postgres.h"
16 : :
17 : : #include "access/detoast.h"
18 : : #include "access/toast_helper.h"
19 : : #include "access/toast_internals.h"
20 : : #include "catalog/pg_type_d.h"
21 : : #include "varatt.h"
22 : :
23 : :
24 : : /*
25 : : * Prepare to TOAST a tuple.
26 : : *
27 : : * tupleDesc, toast_values, and toast_isnull are required parameters; they
28 : : * provide the necessary details about the tuple to be toasted.
29 : : *
30 : : * toast_oldvalues and toast_oldisnull should be NULL for a newly-inserted
31 : : * tuple; for an update, they should describe the existing tuple.
32 : : *
33 : : * All of these arrays should have a length equal to tupleDesc->natts.
34 : : *
35 : : * On return, toast_flags and toast_attr will have been initialized.
36 : : * toast_flags is just a single uint8, but toast_attr is a caller-provided
37 : : * array with a length equal to tupleDesc->natts. The caller need not
38 : : * perform any initialization of the array before calling this function.
39 : : */
40 : : void
41 : 2290 : toast_tuple_init(ToastTupleContext *ttc)
42 : : {
43 : 2290 : TupleDesc tupleDesc = ttc->ttc_rel->rd_att;
44 : 2290 : int numAttrs = tupleDesc->natts;
45 : 2290 : int i;
46 : :
47 : 2290 : ttc->ttc_flags = 0;
48 : :
49 [ + + ]: 15543 : for (i = 0; i < numAttrs; i++)
50 : : {
51 : 13253 : Form_pg_attribute att = TupleDescAttr(tupleDesc, i);
52 : 13253 : struct varlena *old_value;
53 : 13253 : struct varlena *new_value;
54 : :
55 : 13253 : ttc->ttc_attr[i].tai_colflags = 0;
56 : 13253 : ttc->ttc_attr[i].tai_oldexternal = NULL;
57 : 13253 : ttc->ttc_attr[i].tai_compression = att->attcompression;
58 : :
59 [ + + ]: 13253 : if (ttc->ttc_oldvalues != NULL)
60 : : {
61 : : /*
62 : : * For UPDATE get the old and new values of this attribute
63 : : */
64 : 1199 : old_value =
65 : 1199 : (struct varlena *) DatumGetPointer(ttc->ttc_oldvalues[i]);
66 : 1199 : new_value =
67 : 1199 : (struct varlena *) DatumGetPointer(ttc->ttc_values[i]);
68 : :
69 : : /*
70 : : * If the old value is stored on disk, check if it has changed so
71 : : * we have to delete it later.
72 : : */
73 [ + + + + : 1199 : if (att->attlen == -1 && !ttc->ttc_oldisnull[i] &&
+ + ]
74 : 228 : VARATT_IS_EXTERNAL_ONDISK(old_value))
75 : : {
76 [ + - ]: 35 : if (ttc->ttc_isnull[i] ||
77 [ + + - + ]: 35 : !VARATT_IS_EXTERNAL_ONDISK(new_value) ||
78 : 20 : memcmp(old_value, new_value,
79 : 20 : VARSIZE_EXTERNAL(old_value)) != 0)
80 : : {
81 : : /*
82 : : * The old external stored value isn't needed any more
83 : : * after the update
84 : : */
85 : 25 : ttc->ttc_attr[i].tai_colflags |= TOASTCOL_NEEDS_DELETE_OLD;
86 : 25 : ttc->ttc_flags |= TOAST_NEEDS_DELETE_OLD;
87 : 25 : }
88 : : else
89 : : {
90 : : /*
91 : : * This attribute isn't changed by this update so we reuse
92 : : * the original reference to the old value in the new
93 : : * tuple.
94 : : */
95 : 10 : ttc->ttc_attr[i].tai_colflags |= TOASTCOL_IGNORE;
96 : 10 : continue;
97 : : }
98 : 25 : }
99 : 1189 : }
100 : : else
101 : : {
102 : : /*
103 : : * For INSERT simply get the new value
104 : : */
105 : 12054 : new_value = (struct varlena *) DatumGetPointer(ttc->ttc_values[i]);
106 : : }
107 : :
108 : : /*
109 : : * Handle NULL attributes
110 : : */
111 [ + + ]: 13243 : if (ttc->ttc_isnull[i])
112 : : {
113 : 868 : ttc->ttc_attr[i].tai_colflags |= TOASTCOL_IGNORE;
114 : 868 : ttc->ttc_flags |= TOAST_HAS_NULLS;
115 : 868 : continue;
116 : : }
117 : :
118 : : /*
119 : : * Now look at varlena attributes
120 : : */
121 [ + + ]: 12375 : if (att->attlen == -1)
122 : : {
123 : : /*
124 : : * If the table's attribute says PLAIN always, force it so.
125 : : */
126 [ + + ]: 3290 : if (att->attstorage == TYPSTORAGE_PLAIN)
127 : 80 : ttc->ttc_attr[i].tai_colflags |= TOASTCOL_IGNORE;
128 : :
129 : : /*
130 : : * We took care of UPDATE above, so any external value we find
131 : : * still in the tuple must be someone else's that we cannot reuse
132 : : * (this includes the case of an out-of-line in-memory datum).
133 : : * Fetch it back (without decompression, unless we are forcing
134 : : * PLAIN storage). If necessary, we'll push it out as a new
135 : : * external value below.
136 : : */
137 [ + + ]: 3290 : if (VARATT_IS_EXTERNAL(new_value))
138 : : {
139 : 104 : ttc->ttc_attr[i].tai_oldexternal = new_value;
140 [ - + ]: 104 : if (att->attstorage == TYPSTORAGE_PLAIN)
141 : 0 : new_value = detoast_attr(new_value);
142 : : else
143 : 104 : new_value = detoast_external_attr(new_value);
144 : 104 : ttc->ttc_values[i] = PointerGetDatum(new_value);
145 : 104 : ttc->ttc_attr[i].tai_colflags |= TOASTCOL_NEEDS_FREE;
146 : 104 : ttc->ttc_flags |= (TOAST_NEEDS_CHANGE | TOAST_NEEDS_FREE);
147 : 104 : }
148 : :
149 : : /*
150 : : * Remember the size of this attribute
151 : : */
152 : 3290 : ttc->ttc_attr[i].tai_size = VARSIZE_ANY(new_value);
153 : 3290 : }
154 : : else
155 : : {
156 : : /*
157 : : * Not a varlena attribute, plain storage always
158 : : */
159 : 9085 : ttc->ttc_attr[i].tai_colflags |= TOASTCOL_IGNORE;
160 : : }
161 [ - + + ]: 13253 : }
162 : 2290 : }
163 : :
164 : : /*
165 : : * Find the largest varlena attribute that satisfies certain criteria.
166 : : *
167 : : * The relevant column must not be marked TOASTCOL_IGNORE, and if the
168 : : * for_compression flag is passed as true, it must also not be marked
169 : : * TOASTCOL_INCOMPRESSIBLE.
170 : : *
171 : : * The column must have attstorage EXTERNAL or EXTENDED if check_main is
172 : : * false, and must have attstorage MAIN if check_main is true.
173 : : *
174 : : * The column must have a minimum size of MAXALIGN(TOAST_POINTER_SIZE);
175 : : * if not, no benefit is to be expected by compressing it.
176 : : *
177 : : * The return value is the index of the biggest suitable column, or
178 : : * -1 if there is none.
179 : : */
180 : : int
181 : 2439 : toast_tuple_find_biggest_attribute(ToastTupleContext *ttc,
182 : : bool for_compression, bool check_main)
183 : : {
184 : 2439 : TupleDesc tupleDesc = ttc->ttc_rel->rd_att;
185 : 2439 : int numAttrs = tupleDesc->natts;
186 : 2439 : int biggest_attno = -1;
187 : 2439 : int32 biggest_size = MAXALIGN(TOAST_POINTER_SIZE);
188 : 2439 : int32 skip_colflags = TOASTCOL_IGNORE;
189 : 2439 : int i;
190 : :
191 [ + + ]: 2439 : if (for_compression)
192 : 2386 : skip_colflags |= TOASTCOL_INCOMPRESSIBLE;
193 : :
194 [ + + ]: 18558 : for (i = 0; i < numAttrs; i++)
195 : : {
196 : 16119 : Form_pg_attribute att = TupleDescAttr(tupleDesc, i);
197 : :
198 [ + + ]: 16119 : if ((ttc->ttc_attr[i].tai_colflags & skip_colflags) != 0)
199 : 12471 : continue;
200 [ - + ]: 3648 : if (VARATT_IS_EXTERNAL(DatumGetPointer(ttc->ttc_values[i])))
201 : 0 : continue; /* can't happen, toast_action would be PLAIN */
202 [ + + + + ]: 3648 : if (for_compression &&
203 : 3532 : VARATT_IS_COMPRESSED(DatumGetPointer(ttc->ttc_values[i])))
204 : 151 : continue;
205 [ + + + - ]: 3497 : if (check_main && att->attstorage != TYPSTORAGE_MAIN)
206 : 0 : continue;
207 [ + + + + : 3497 : if (!check_main && att->attstorage != TYPSTORAGE_EXTENDED &&
+ + ]
208 : 157 : att->attstorage != TYPSTORAGE_EXTERNAL)
209 : 22 : continue;
210 : :
211 [ + + ]: 3475 : if (ttc->ttc_attr[i].tai_size > biggest_size)
212 : : {
213 : 2653 : biggest_attno = i;
214 : 2653 : biggest_size = ttc->ttc_attr[i].tai_size;
215 : 2653 : }
216 [ - + + ]: 16119 : }
217 : :
218 : 4878 : return biggest_attno;
219 : 2439 : }
220 : :
221 : : /*
222 : : * Try compression for an attribute.
223 : : *
224 : : * If we find that the attribute is not compressible, mark it so.
225 : : */
226 : : void
227 : 2200 : toast_tuple_try_compression(ToastTupleContext *ttc, int attribute)
228 : : {
229 : 2200 : Datum *value = &ttc->ttc_values[attribute];
230 : 2200 : Datum new_value;
231 : 2200 : ToastAttrInfo *attr = &ttc->ttc_attr[attribute];
232 : :
233 : 2200 : new_value = toast_compress_datum(*value, attr->tai_compression);
234 : :
235 [ + + ]: 2200 : if (DatumGetPointer(new_value) != NULL)
236 : : {
237 : : /* successful compression */
238 [ + + ]: 2170 : if ((attr->tai_colflags & TOASTCOL_NEEDS_FREE) != 0)
239 : 5 : pfree(DatumGetPointer(*value));
240 : 2170 : *value = new_value;
241 : 2170 : attr->tai_colflags |= TOASTCOL_NEEDS_FREE;
242 : 2170 : attr->tai_size = VARSIZE(DatumGetPointer(*value));
243 : 2170 : ttc->ttc_flags |= (TOAST_NEEDS_CHANGE | TOAST_NEEDS_FREE);
244 : 2170 : }
245 : : else
246 : : {
247 : : /* incompressible, ignore on subsequent compression passes */
248 : 30 : attr->tai_colflags |= TOASTCOL_INCOMPRESSIBLE;
249 : : }
250 : 2200 : }
251 : :
252 : : /*
253 : : * Move an attribute to external storage.
254 : : */
255 : : void
256 : 320 : toast_tuple_externalize(ToastTupleContext *ttc, int attribute, int options)
257 : : {
258 : 320 : Datum *value = &ttc->ttc_values[attribute];
259 : 320 : Datum old_value = *value;
260 : 320 : ToastAttrInfo *attr = &ttc->ttc_attr[attribute];
261 : :
262 : 320 : attr->tai_colflags |= TOASTCOL_IGNORE;
263 : 640 : *value = toast_save_datum(ttc->ttc_rel, old_value, attr->tai_oldexternal,
264 : 320 : options);
265 [ + + ]: 320 : if ((attr->tai_colflags & TOASTCOL_NEEDS_FREE) != 0)
266 : 225 : pfree(DatumGetPointer(old_value));
267 : 320 : attr->tai_colflags |= TOASTCOL_NEEDS_FREE;
268 : 320 : ttc->ttc_flags |= (TOAST_NEEDS_CHANGE | TOAST_NEEDS_FREE);
269 : 320 : }
270 : :
271 : : /*
272 : : * Perform appropriate cleanup after one tuple has been subjected to TOAST.
273 : : */
274 : : void
275 : 2290 : toast_tuple_cleanup(ToastTupleContext *ttc)
276 : : {
277 : 2290 : TupleDesc tupleDesc = ttc->ttc_rel->rd_att;
278 : 2290 : int numAttrs = tupleDesc->natts;
279 : :
280 : : /*
281 : : * Free allocated temp values
282 : : */
283 [ + + ]: 2290 : if ((ttc->ttc_flags & TOAST_NEEDS_FREE) != 0)
284 : : {
285 : 2277 : int i;
286 : :
287 [ + + ]: 15497 : for (i = 0; i < numAttrs; i++)
288 : : {
289 : 13220 : ToastAttrInfo *attr = &ttc->ttc_attr[i];
290 : :
291 [ + + ]: 13220 : if ((attr->tai_colflags & TOASTCOL_NEEDS_FREE) != 0)
292 : 2364 : pfree(DatumGetPointer(ttc->ttc_values[i]));
293 : 13220 : }
294 : 2277 : }
295 : :
296 : : /*
297 : : * Delete external values from the old tuple
298 : : */
299 [ + + ]: 2290 : if ((ttc->ttc_flags & TOAST_NEEDS_DELETE_OLD) != 0)
300 : : {
301 : 21 : int i;
302 : :
303 [ + + ]: 257 : for (i = 0; i < numAttrs; i++)
304 : : {
305 : 236 : ToastAttrInfo *attr = &ttc->ttc_attr[i];
306 : :
307 [ + + ]: 236 : if ((attr->tai_colflags & TOASTCOL_NEEDS_DELETE_OLD) != 0)
308 : 25 : toast_delete_datum(ttc->ttc_rel, ttc->ttc_oldvalues[i], false);
309 : 236 : }
310 : 21 : }
311 : 2290 : }
312 : :
313 : : /*
314 : : * Check for external stored attributes and delete them from the secondary
315 : : * relation.
316 : : */
317 : : void
318 : 79 : toast_delete_external(Relation rel, const Datum *values, const bool *isnull,
319 : : bool is_speculative)
320 : : {
321 : 79 : TupleDesc tupleDesc = rel->rd_att;
322 : 79 : int numAttrs = tupleDesc->natts;
323 : 79 : int i;
324 : :
325 [ + + ]: 652 : for (i = 0; i < numAttrs; i++)
326 : : {
327 [ + + ]: 573 : if (TupleDescCompactAttr(tupleDesc, i)->attlen == -1)
328 : : {
329 : 193 : Datum value = values[i];
330 : :
331 [ + + ]: 193 : if (isnull[i])
332 : 55 : continue;
333 [ + + ]: 138 : else if (VARATT_IS_EXTERNAL_ONDISK(DatumGetPointer(value)))
334 : 81 : toast_delete_datum(rel, value, is_speculative);
335 [ - + + ]: 193 : }
336 : 518 : }
337 : 79 : }
|
