Line data Source code
1 : /*-------------------------------------------------------------------------
2 : *
3 : * heapdesc.c
4 : * rmgr descriptor routines for access/heap/heapam.c
5 : *
6 : * Portions Copyright (c) 1996-2025, PostgreSQL Global Development Group
7 : * Portions Copyright (c) 1994, Regents of the University of California
8 : *
9 : *
10 : * IDENTIFICATION
11 : * src/backend/access/rmgrdesc/heapdesc.c
12 : *
13 : *-------------------------------------------------------------------------
14 : */
15 : #include "postgres.h"
16 :
17 : #include "access/heapam_xlog.h"
18 : #include "access/rmgrdesc_utils.h"
19 : #include "access/visibilitymapdefs.h"
20 : #include "storage/standbydefs.h"
21 :
22 : /*
23 : * NOTE: "keyname" argument cannot have trailing spaces or punctuation
24 : * characters
25 : */
26 : static void
27 100 : infobits_desc(StringInfo buf, uint8 infobits, const char *keyname)
28 : {
29 100 : appendStringInfo(buf, "%s: [", keyname);
30 :
31 : Assert(buf->data[buf->len - 1] != ' ');
32 :
33 100 : if (infobits & XLHL_XMAX_IS_MULTI)
34 0 : appendStringInfoString(buf, "IS_MULTI, ");
35 100 : if (infobits & XLHL_XMAX_LOCK_ONLY)
36 16 : appendStringInfoString(buf, "LOCK_ONLY, ");
37 100 : if (infobits & XLHL_XMAX_EXCL_LOCK)
38 16 : appendStringInfoString(buf, "EXCL_LOCK, ");
39 100 : if (infobits & XLHL_XMAX_KEYSHR_LOCK)
40 0 : appendStringInfoString(buf, "KEYSHR_LOCK, ");
41 100 : if (infobits & XLHL_KEYS_UPDATED)
42 40 : appendStringInfoString(buf, "KEYS_UPDATED, ");
43 :
44 100 : if (buf->data[buf->len - 1] == ' ')
45 : {
46 : /* Truncate-away final unneeded ", " */
47 : Assert(buf->data[buf->len - 2] == ',');
48 56 : buf->len -= 2;
49 56 : buf->data[buf->len] = '\0';
50 : }
51 :
52 100 : appendStringInfoChar(buf, ']');
53 100 : }
54 :
55 : static void
56 0 : truncate_flags_desc(StringInfo buf, uint8 flags)
57 : {
58 0 : appendStringInfoString(buf, "flags: [");
59 :
60 0 : if (flags & XLH_TRUNCATE_CASCADE)
61 0 : appendStringInfoString(buf, "CASCADE, ");
62 0 : if (flags & XLH_TRUNCATE_RESTART_SEQS)
63 0 : appendStringInfoString(buf, "RESTART_SEQS, ");
64 :
65 0 : if (buf->data[buf->len - 1] == ' ')
66 : {
67 : /* Truncate-away final unneeded ", " */
68 : Assert(buf->data[buf->len - 2] == ',');
69 0 : buf->len -= 2;
70 0 : buf->data[buf->len] = '\0';
71 : }
72 :
73 0 : appendStringInfoChar(buf, ']');
74 0 : }
75 :
76 : static void
77 16 : plan_elem_desc(StringInfo buf, void *plan, void *data)
78 : {
79 16 : xlhp_freeze_plan *new_plan = (xlhp_freeze_plan *) plan;
80 16 : OffsetNumber **offsets = data;
81 :
82 16 : appendStringInfo(buf, "{ xmax: %u, infomask: %u, infomask2: %u, ntuples: %u",
83 : new_plan->xmax,
84 16 : new_plan->t_infomask, new_plan->t_infomask2,
85 16 : new_plan->ntuples);
86 :
87 16 : appendStringInfoString(buf, ", offsets:");
88 16 : array_desc(buf, *offsets, sizeof(OffsetNumber), new_plan->ntuples,
89 : &offset_elem_desc, NULL);
90 :
91 16 : *offsets += new_plan->ntuples;
92 :
93 16 : appendStringInfoString(buf, " }");
94 16 : }
95 :
96 :
97 : /*
98 : * Given a MAXALIGNed buffer returned by XLogRecGetBlockData() and pointed to
99 : * by cursor and any xl_heap_prune flags, deserialize the arrays of
100 : * OffsetNumbers contained in an XLOG_HEAP2_PRUNE_* record.
101 : *
102 : * This is in heapdesc.c so it can be shared between heap2_redo and heap2_desc
103 : * code, the latter of which is used in frontend (pg_waldump) code.
104 : */
105 : void
106 18076 : heap_xlog_deserialize_prune_and_freeze(char *cursor, uint8 flags,
107 : int *nplans, xlhp_freeze_plan **plans,
108 : OffsetNumber **frz_offsets,
109 : int *nredirected, OffsetNumber **redirected,
110 : int *ndead, OffsetNumber **nowdead,
111 : int *nunused, OffsetNumber **nowunused)
112 : {
113 18076 : if (flags & XLHP_HAS_FREEZE_PLANS)
114 : {
115 1824 : xlhp_freeze_plans *freeze_plans = (xlhp_freeze_plans *) cursor;
116 :
117 1824 : *nplans = freeze_plans->nplans;
118 : Assert(*nplans > 0);
119 1824 : *plans = freeze_plans->plans;
120 :
121 1824 : cursor += offsetof(xlhp_freeze_plans, plans);
122 1824 : cursor += sizeof(xlhp_freeze_plan) * *nplans;
123 : }
124 : else
125 : {
126 16252 : *nplans = 0;
127 16252 : *plans = NULL;
128 : }
129 :
130 18076 : if (flags & XLHP_HAS_REDIRECTIONS)
131 : {
132 3780 : xlhp_prune_items *subrecord = (xlhp_prune_items *) cursor;
133 :
134 3780 : *nredirected = subrecord->ntargets;
135 : Assert(*nredirected > 0);
136 3780 : *redirected = &subrecord->data[0];
137 :
138 3780 : cursor += offsetof(xlhp_prune_items, data);
139 3780 : cursor += sizeof(OffsetNumber[2]) * *nredirected;
140 : }
141 : else
142 : {
143 14296 : *nredirected = 0;
144 14296 : *redirected = NULL;
145 : }
146 :
147 18076 : if (flags & XLHP_HAS_DEAD_ITEMS)
148 : {
149 11262 : xlhp_prune_items *subrecord = (xlhp_prune_items *) cursor;
150 :
151 11262 : *ndead = subrecord->ntargets;
152 : Assert(*ndead > 0);
153 11262 : *nowdead = subrecord->data;
154 :
155 11262 : cursor += offsetof(xlhp_prune_items, data);
156 11262 : cursor += sizeof(OffsetNumber) * *ndead;
157 : }
158 : else
159 : {
160 6814 : *ndead = 0;
161 6814 : *nowdead = NULL;
162 : }
163 :
164 18076 : if (flags & XLHP_HAS_NOW_UNUSED_ITEMS)
165 : {
166 6756 : xlhp_prune_items *subrecord = (xlhp_prune_items *) cursor;
167 :
168 6756 : *nunused = subrecord->ntargets;
169 : Assert(*nunused > 0);
170 6756 : *nowunused = subrecord->data;
171 :
172 6756 : cursor += offsetof(xlhp_prune_items, data);
173 6756 : cursor += sizeof(OffsetNumber) * *nunused;
174 : }
175 : else
176 : {
177 11320 : *nunused = 0;
178 11320 : *nowunused = NULL;
179 : }
180 :
181 18076 : *frz_offsets = (OffsetNumber *) cursor;
182 18076 : }
183 :
184 : void
185 61902 : heap_desc(StringInfo buf, XLogReaderState *record)
186 : {
187 61902 : char *rec = XLogRecGetData(record);
188 61902 : uint8 info = XLogRecGetInfo(record) & ~XLR_INFO_MASK;
189 :
190 61902 : info &= XLOG_HEAP_OPMASK;
191 61902 : if (info == XLOG_HEAP_INSERT)
192 : {
193 61798 : xl_heap_insert *xlrec = (xl_heap_insert *) rec;
194 :
195 61798 : appendStringInfo(buf, "off: %u, flags: 0x%02X",
196 61798 : xlrec->offnum,
197 61798 : xlrec->flags);
198 : }
199 104 : else if (info == XLOG_HEAP_DELETE)
200 : {
201 40 : xl_heap_delete *xlrec = (xl_heap_delete *) rec;
202 :
203 40 : appendStringInfo(buf, "xmax: %u, off: %u, ",
204 40 : xlrec->xmax, xlrec->offnum);
205 40 : infobits_desc(buf, xlrec->infobits_set, "infobits");
206 40 : appendStringInfo(buf, ", flags: 0x%02X", xlrec->flags);
207 : }
208 64 : else if (info == XLOG_HEAP_UPDATE)
209 : {
210 16 : xl_heap_update *xlrec = (xl_heap_update *) rec;
211 :
212 16 : appendStringInfo(buf, "old_xmax: %u, old_off: %u, ",
213 16 : xlrec->old_xmax, xlrec->old_offnum);
214 16 : infobits_desc(buf, xlrec->old_infobits_set, "old_infobits");
215 16 : appendStringInfo(buf, ", flags: 0x%02X, new_xmax: %u, new_off: %u",
216 16 : xlrec->flags, xlrec->new_xmax, xlrec->new_offnum);
217 : }
218 48 : else if (info == XLOG_HEAP_HOT_UPDATE)
219 : {
220 28 : xl_heap_update *xlrec = (xl_heap_update *) rec;
221 :
222 28 : appendStringInfo(buf, "old_xmax: %u, old_off: %u, ",
223 28 : xlrec->old_xmax, xlrec->old_offnum);
224 28 : infobits_desc(buf, xlrec->old_infobits_set, "old_infobits");
225 28 : appendStringInfo(buf, ", flags: 0x%02X, new_xmax: %u, new_off: %u",
226 28 : xlrec->flags, xlrec->new_xmax, xlrec->new_offnum);
227 : }
228 20 : else if (info == XLOG_HEAP_TRUNCATE)
229 : {
230 0 : xl_heap_truncate *xlrec = (xl_heap_truncate *) rec;
231 :
232 0 : truncate_flags_desc(buf, xlrec->flags);
233 0 : appendStringInfo(buf, ", nrelids: %u", xlrec->nrelids);
234 0 : appendStringInfoString(buf, ", relids:");
235 0 : array_desc(buf, xlrec->relids, sizeof(Oid), xlrec->nrelids,
236 : &oid_elem_desc, NULL);
237 : }
238 20 : else if (info == XLOG_HEAP_CONFIRM)
239 : {
240 0 : xl_heap_confirm *xlrec = (xl_heap_confirm *) rec;
241 :
242 0 : appendStringInfo(buf, "off: %u", xlrec->offnum);
243 : }
244 20 : else if (info == XLOG_HEAP_LOCK)
245 : {
246 16 : xl_heap_lock *xlrec = (xl_heap_lock *) rec;
247 :
248 16 : appendStringInfo(buf, "xmax: %u, off: %u, ",
249 16 : xlrec->xmax, xlrec->offnum);
250 16 : infobits_desc(buf, xlrec->infobits_set, "infobits");
251 16 : appendStringInfo(buf, ", flags: 0x%02X", xlrec->flags);
252 : }
253 4 : else if (info == XLOG_HEAP_INPLACE)
254 : {
255 4 : xl_heap_inplace *xlrec = (xl_heap_inplace *) rec;
256 :
257 4 : appendStringInfo(buf, "off: %u", xlrec->offnum);
258 4 : standby_desc_invalidations(buf, xlrec->nmsgs, xlrec->msgs,
259 : xlrec->dbId, xlrec->tsId,
260 4 : xlrec->relcacheInitFileInval);
261 : }
262 61902 : }
263 :
264 : void
265 150 : heap2_desc(StringInfo buf, XLogReaderState *record)
266 : {
267 150 : char *rec = XLogRecGetData(record);
268 150 : uint8 info = XLogRecGetInfo(record) & ~XLR_INFO_MASK;
269 :
270 150 : info &= XLOG_HEAP_OPMASK;
271 150 : if (info == XLOG_HEAP2_PRUNE_ON_ACCESS ||
272 48 : info == XLOG_HEAP2_PRUNE_VACUUM_SCAN ||
273 : info == XLOG_HEAP2_PRUNE_VACUUM_CLEANUP)
274 106 : {
275 106 : xl_heap_prune *xlrec = (xl_heap_prune *) rec;
276 :
277 106 : if (xlrec->flags & XLHP_HAS_CONFLICT_HORIZON)
278 : {
279 : TransactionId conflict_xid;
280 :
281 36 : memcpy(&conflict_xid, rec + SizeOfHeapPrune, sizeof(TransactionId));
282 :
283 36 : appendStringInfo(buf, "snapshotConflictHorizon: %u",
284 : conflict_xid);
285 : }
286 :
287 106 : appendStringInfo(buf, ", isCatalogRel: %c",
288 106 : xlrec->flags & XLHP_IS_CATALOG_REL ? 'T' : 'F');
289 :
290 106 : if (XLogRecHasBlockData(record, 0))
291 : {
292 : Size datalen;
293 : OffsetNumber *redirected;
294 : OffsetNumber *nowdead;
295 : OffsetNumber *nowunused;
296 : int nredirected;
297 : int nunused;
298 : int ndead;
299 : int nplans;
300 : xlhp_freeze_plan *plans;
301 : OffsetNumber *frz_offsets;
302 :
303 106 : char *cursor = XLogRecGetBlockData(record, 0, &datalen);
304 :
305 106 : heap_xlog_deserialize_prune_and_freeze(cursor, xlrec->flags,
306 : &nplans, &plans, &frz_offsets,
307 : &nredirected, &redirected,
308 : &ndead, &nowdead,
309 : &nunused, &nowunused);
310 :
311 106 : appendStringInfo(buf, ", nplans: %u, nredirected: %u, ndead: %u, nunused: %u",
312 : nplans, nredirected, ndead, nunused);
313 :
314 106 : if (nplans > 0)
315 : {
316 12 : appendStringInfoString(buf, ", plans:");
317 12 : array_desc(buf, plans, sizeof(xlhp_freeze_plan), nplans,
318 : &plan_elem_desc, &frz_offsets);
319 : }
320 :
321 106 : if (nredirected > 0)
322 : {
323 12 : appendStringInfoString(buf, ", redirected:");
324 12 : array_desc(buf, redirected, sizeof(OffsetNumber) * 2,
325 : nredirected, &redirect_elem_desc, NULL);
326 : }
327 :
328 106 : if (ndead > 0)
329 : {
330 82 : appendStringInfoString(buf, ", dead:");
331 82 : array_desc(buf, nowdead, sizeof(OffsetNumber), ndead,
332 : &offset_elem_desc, NULL);
333 : }
334 :
335 106 : if (nunused > 0)
336 : {
337 26 : appendStringInfoString(buf, ", unused:");
338 26 : array_desc(buf, nowunused, sizeof(OffsetNumber), nunused,
339 : &offset_elem_desc, NULL);
340 : }
341 : }
342 : }
343 44 : else if (info == XLOG_HEAP2_VISIBLE)
344 : {
345 4 : xl_heap_visible *xlrec = (xl_heap_visible *) rec;
346 :
347 4 : appendStringInfo(buf, "snapshotConflictHorizon: %u, flags: 0x%02X",
348 4 : xlrec->snapshotConflictHorizon, xlrec->flags);
349 : }
350 40 : else if (info == XLOG_HEAP2_MULTI_INSERT)
351 : {
352 40 : xl_heap_multi_insert *xlrec = (xl_heap_multi_insert *) rec;
353 40 : bool isinit = (XLogRecGetInfo(record) & XLOG_HEAP_INIT_PAGE) != 0;
354 :
355 40 : appendStringInfo(buf, "ntuples: %d, flags: 0x%02X", xlrec->ntuples,
356 40 : xlrec->flags);
357 :
358 40 : if (xlrec->flags & XLH_INSERT_ALL_FROZEN_SET)
359 0 : appendStringInfo(buf, ", vm_flags: 0x%02X",
360 : VISIBILITYMAP_ALL_VISIBLE |
361 : VISIBILITYMAP_ALL_FROZEN);
362 :
363 40 : if (XLogRecHasBlockData(record, 0) && !isinit)
364 : {
365 38 : appendStringInfoString(buf, ", offsets:");
366 38 : array_desc(buf, xlrec->offsets, sizeof(OffsetNumber),
367 38 : xlrec->ntuples, &offset_elem_desc, NULL);
368 : }
369 : }
370 0 : else if (info == XLOG_HEAP2_LOCK_UPDATED)
371 : {
372 0 : xl_heap_lock_updated *xlrec = (xl_heap_lock_updated *) rec;
373 :
374 0 : appendStringInfo(buf, "xmax: %u, off: %u, ",
375 0 : xlrec->xmax, xlrec->offnum);
376 0 : infobits_desc(buf, xlrec->infobits_set, "infobits");
377 0 : appendStringInfo(buf, ", flags: 0x%02X", xlrec->flags);
378 : }
379 0 : else if (info == XLOG_HEAP2_NEW_CID)
380 : {
381 0 : xl_heap_new_cid *xlrec = (xl_heap_new_cid *) rec;
382 :
383 0 : appendStringInfo(buf, "rel: %u/%u/%u, tid: %u/%u",
384 : xlrec->target_locator.spcOid,
385 : xlrec->target_locator.dbOid,
386 : xlrec->target_locator.relNumber,
387 0 : ItemPointerGetBlockNumber(&(xlrec->target_tid)),
388 0 : ItemPointerGetOffsetNumber(&(xlrec->target_tid)));
389 0 : appendStringInfo(buf, ", cmin: %u, cmax: %u, combo: %u",
390 : xlrec->cmin, xlrec->cmax, xlrec->combocid);
391 : }
392 150 : }
393 :
394 : const char *
395 61902 : heap_identify(uint8 info)
396 : {
397 61902 : const char *id = NULL;
398 :
399 61902 : switch (info & ~XLR_INFO_MASK)
400 : {
401 58976 : case XLOG_HEAP_INSERT:
402 58976 : id = "INSERT";
403 58976 : break;
404 2822 : case XLOG_HEAP_INSERT | XLOG_HEAP_INIT_PAGE:
405 2822 : id = "INSERT+INIT";
406 2822 : break;
407 40 : case XLOG_HEAP_DELETE:
408 40 : id = "DELETE";
409 40 : break;
410 14 : case XLOG_HEAP_UPDATE:
411 14 : id = "UPDATE";
412 14 : break;
413 2 : case XLOG_HEAP_UPDATE | XLOG_HEAP_INIT_PAGE:
414 2 : id = "UPDATE+INIT";
415 2 : break;
416 28 : case XLOG_HEAP_HOT_UPDATE:
417 28 : id = "HOT_UPDATE";
418 28 : break;
419 0 : case XLOG_HEAP_HOT_UPDATE | XLOG_HEAP_INIT_PAGE:
420 0 : id = "HOT_UPDATE+INIT";
421 0 : break;
422 0 : case XLOG_HEAP_TRUNCATE:
423 0 : id = "TRUNCATE";
424 0 : break;
425 0 : case XLOG_HEAP_CONFIRM:
426 0 : id = "HEAP_CONFIRM";
427 0 : break;
428 16 : case XLOG_HEAP_LOCK:
429 16 : id = "LOCK";
430 16 : break;
431 4 : case XLOG_HEAP_INPLACE:
432 4 : id = "INPLACE";
433 4 : break;
434 : }
435 :
436 61902 : return id;
437 : }
438 :
439 : const char *
440 150 : heap2_identify(uint8 info)
441 : {
442 150 : const char *id = NULL;
443 :
444 150 : switch (info & ~XLR_INFO_MASK)
445 : {
446 80 : case XLOG_HEAP2_PRUNE_ON_ACCESS:
447 80 : id = "PRUNE_ON_ACCESS";
448 80 : break;
449 22 : case XLOG_HEAP2_PRUNE_VACUUM_SCAN:
450 22 : id = "PRUNE_VACUUM_SCAN";
451 22 : break;
452 4 : case XLOG_HEAP2_PRUNE_VACUUM_CLEANUP:
453 4 : id = "PRUNE_VACUUM_CLEANUP";
454 4 : break;
455 4 : case XLOG_HEAP2_VISIBLE:
456 4 : id = "VISIBLE";
457 4 : break;
458 40 : case XLOG_HEAP2_MULTI_INSERT:
459 40 : id = "MULTI_INSERT";
460 40 : break;
461 0 : case XLOG_HEAP2_MULTI_INSERT | XLOG_HEAP_INIT_PAGE:
462 0 : id = "MULTI_INSERT+INIT";
463 0 : break;
464 0 : case XLOG_HEAP2_LOCK_UPDATED:
465 0 : id = "LOCK_UPDATED";
466 0 : break;
467 0 : case XLOG_HEAP2_NEW_CID:
468 0 : id = "NEW_CID";
469 0 : break;
470 0 : case XLOG_HEAP2_REWRITE:
471 0 : id = "REWRITE";
472 0 : break;
473 : }
474 :
475 150 : return id;
476 : }
|
