Line data Source code
1 : /*-------------------------------------------------------------------------
2 : *
3 : * heapdesc.c
4 : * rmgr descriptor routines for access/heap/heapam.c
5 : *
6 : * Portions Copyright (c) 1996-2026, 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 142135 : infobits_desc(StringInfo buf, uint8 infobits, const char *keyname)
28 : {
29 142135 : appendStringInfo(buf, "%s: [", keyname);
30 :
31 : Assert(buf->data[buf->len - 1] != ' ');
32 :
33 142135 : if (infobits & XLHL_XMAX_IS_MULTI)
34 0 : appendStringInfoString(buf, "IS_MULTI, ");
35 142135 : if (infobits & XLHL_XMAX_LOCK_ONLY)
36 70414 : appendStringInfoString(buf, "LOCK_ONLY, ");
37 142135 : if (infobits & XLHL_XMAX_EXCL_LOCK)
38 70414 : appendStringInfoString(buf, "EXCL_LOCK, ");
39 142135 : if (infobits & XLHL_XMAX_KEYSHR_LOCK)
40 0 : appendStringInfoString(buf, "KEYSHR_LOCK, ");
41 142135 : if (infobits & XLHL_KEYS_UPDATED)
42 429 : appendStringInfoString(buf, "KEYS_UPDATED, ");
43 :
44 142135 : if (buf->data[buf->len - 1] == ' ')
45 : {
46 : /* Truncate-away final unneeded ", " */
47 : Assert(buf->data[buf->len - 2] == ',');
48 70843 : buf->len -= 2;
49 70843 : buf->data[buf->len] = '\0';
50 : }
51 :
52 142135 : appendStringInfoChar(buf, ']');
53 142135 : }
54 :
55 : static void
56 14 : truncate_flags_desc(StringInfo buf, uint8 flags)
57 : {
58 14 : appendStringInfoString(buf, "flags: [");
59 :
60 14 : if (flags & XLH_TRUNCATE_CASCADE)
61 0 : appendStringInfoString(buf, "CASCADE, ");
62 14 : if (flags & XLH_TRUNCATE_RESTART_SEQS)
63 0 : appendStringInfoString(buf, "RESTART_SEQS, ");
64 :
65 14 : 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 14 : appendStringInfoChar(buf, ']');
74 14 : }
75 :
76 : static void
77 607 : plan_elem_desc(StringInfo buf, void *plan, void *data)
78 : {
79 607 : xlhp_freeze_plan *new_plan = (xlhp_freeze_plan *) plan;
80 607 : OffsetNumber **offsets = data;
81 :
82 607 : appendStringInfo(buf, "{ xmax: %u, infomask: %u, infomask2: %u, ntuples: %u",
83 : new_plan->xmax,
84 607 : new_plan->t_infomask, new_plan->t_infomask2,
85 607 : new_plan->ntuples);
86 :
87 607 : appendStringInfoString(buf, ", offsets:");
88 607 : array_desc(buf, *offsets, sizeof(OffsetNumber), new_plan->ntuples,
89 : &offset_elem_desc, NULL);
90 :
91 607 : *offsets += new_plan->ntuples;
92 :
93 607 : appendStringInfoString(buf, " }");
94 607 : }
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 1834 : heap_xlog_deserialize_prune_and_freeze(char *cursor, uint16 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 1834 : if (flags & XLHP_HAS_FREEZE_PLANS)
114 : {
115 505 : xlhp_freeze_plans *freeze_plans = (xlhp_freeze_plans *) cursor;
116 :
117 505 : *nplans = freeze_plans->nplans;
118 : Assert(*nplans > 0);
119 505 : *plans = freeze_plans->plans;
120 :
121 505 : cursor += offsetof(xlhp_freeze_plans, plans);
122 505 : cursor += sizeof(xlhp_freeze_plan) * *nplans;
123 : }
124 : else
125 : {
126 1329 : *nplans = 0;
127 1329 : *plans = NULL;
128 : }
129 :
130 1834 : if (flags & XLHP_HAS_REDIRECTIONS)
131 : {
132 289 : xlhp_prune_items *subrecord = (xlhp_prune_items *) cursor;
133 :
134 289 : *nredirected = subrecord->ntargets;
135 : Assert(*nredirected > 0);
136 289 : *redirected = &subrecord->data[0];
137 :
138 289 : cursor += offsetof(xlhp_prune_items, data);
139 289 : cursor += sizeof(OffsetNumber[2]) * *nredirected;
140 : }
141 : else
142 : {
143 1545 : *nredirected = 0;
144 1545 : *redirected = NULL;
145 : }
146 :
147 1834 : if (flags & XLHP_HAS_DEAD_ITEMS)
148 : {
149 570 : xlhp_prune_items *subrecord = (xlhp_prune_items *) cursor;
150 :
151 570 : *ndead = subrecord->ntargets;
152 : Assert(*ndead > 0);
153 570 : *nowdead = subrecord->data;
154 :
155 570 : cursor += offsetof(xlhp_prune_items, data);
156 570 : cursor += sizeof(OffsetNumber) * *ndead;
157 : }
158 : else
159 : {
160 1264 : *ndead = 0;
161 1264 : *nowdead = NULL;
162 : }
163 :
164 1834 : if (flags & XLHP_HAS_NOW_UNUSED_ITEMS)
165 : {
166 586 : xlhp_prune_items *subrecord = (xlhp_prune_items *) cursor;
167 :
168 586 : *nunused = subrecord->ntargets;
169 : Assert(*nunused > 0);
170 586 : *nowunused = subrecord->data;
171 :
172 586 : cursor += offsetof(xlhp_prune_items, data);
173 586 : cursor += sizeof(OffsetNumber) * *nunused;
174 : }
175 : else
176 : {
177 1248 : *nunused = 0;
178 1248 : *nowunused = NULL;
179 : }
180 :
181 1834 : *frz_offsets = (OffsetNumber *) cursor;
182 1834 : }
183 :
184 : void
185 316605 : heap_desc(StringInfo buf, XLogReaderState *record)
186 : {
187 316605 : char *rec = XLogRecGetData(record);
188 316605 : uint8 info = XLogRecGetInfo(record) & ~XLR_INFO_MASK;
189 :
190 316605 : info &= XLOG_HEAP_OPMASK;
191 316605 : if (info == XLOG_HEAP_INSERT)
192 : {
193 171837 : xl_heap_insert *xlrec = (xl_heap_insert *) rec;
194 :
195 171837 : appendStringInfo(buf, "off: %u, flags: 0x%02X",
196 171837 : xlrec->offnum,
197 171837 : xlrec->flags);
198 : }
199 144768 : else if (info == XLOG_HEAP_DELETE)
200 : {
201 429 : xl_heap_delete *xlrec = (xl_heap_delete *) rec;
202 :
203 429 : appendStringInfo(buf, "xmax: %u, off: %u, ",
204 429 : xlrec->xmax, xlrec->offnum);
205 429 : infobits_desc(buf, xlrec->infobits_set, "infobits");
206 429 : appendStringInfo(buf, ", flags: 0x%02X", xlrec->flags);
207 : }
208 144339 : else if (info == XLOG_HEAP_UPDATE)
209 : {
210 70480 : xl_heap_update *xlrec = (xl_heap_update *) rec;
211 :
212 70480 : appendStringInfo(buf, "old_xmax: %u, old_off: %u, ",
213 70480 : xlrec->old_xmax, xlrec->old_offnum);
214 70480 : infobits_desc(buf, xlrec->old_infobits_set, "old_infobits");
215 70480 : appendStringInfo(buf, ", flags: 0x%02X, new_xmax: %u, new_off: %u",
216 70480 : xlrec->flags, xlrec->new_xmax, xlrec->new_offnum);
217 : }
218 73859 : else if (info == XLOG_HEAP_HOT_UPDATE)
219 : {
220 812 : xl_heap_update *xlrec = (xl_heap_update *) rec;
221 :
222 812 : appendStringInfo(buf, "old_xmax: %u, old_off: %u, ",
223 812 : xlrec->old_xmax, xlrec->old_offnum);
224 812 : infobits_desc(buf, xlrec->old_infobits_set, "old_infobits");
225 812 : appendStringInfo(buf, ", flags: 0x%02X, new_xmax: %u, new_off: %u",
226 812 : xlrec->flags, xlrec->new_xmax, xlrec->new_offnum);
227 : }
228 73047 : else if (info == XLOG_HEAP_TRUNCATE)
229 : {
230 14 : xl_heap_truncate *xlrec = (xl_heap_truncate *) rec;
231 :
232 14 : truncate_flags_desc(buf, xlrec->flags);
233 14 : appendStringInfo(buf, ", nrelids: %u", xlrec->nrelids);
234 14 : appendStringInfoString(buf, ", relids:");
235 14 : array_desc(buf, xlrec->relids, sizeof(Oid), xlrec->nrelids,
236 : &oid_elem_desc, NULL);
237 : }
238 73033 : 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 73033 : else if (info == XLOG_HEAP_LOCK)
245 : {
246 70414 : xl_heap_lock *xlrec = (xl_heap_lock *) rec;
247 :
248 70414 : appendStringInfo(buf, "xmax: %u, off: %u, ",
249 70414 : xlrec->xmax, xlrec->offnum);
250 70414 : infobits_desc(buf, xlrec->infobits_set, "infobits");
251 70414 : appendStringInfo(buf, ", flags: 0x%02X", xlrec->flags);
252 : }
253 2619 : else if (info == XLOG_HEAP_INPLACE)
254 : {
255 2619 : xl_heap_inplace *xlrec = (xl_heap_inplace *) rec;
256 :
257 2619 : appendStringInfo(buf, "off: %u", xlrec->offnum);
258 2619 : standby_desc_invalidations(buf, xlrec->nmsgs, xlrec->msgs,
259 : xlrec->dbId, xlrec->tsId,
260 2619 : xlrec->relcacheInitFileInval);
261 : }
262 316605 : }
263 :
264 : void
265 11901 : heap2_desc(StringInfo buf, XLogReaderState *record)
266 : {
267 11901 : char *rec = XLogRecGetData(record);
268 11901 : uint8 info = XLogRecGetInfo(record) & ~XLR_INFO_MASK;
269 :
270 11901 : info &= XLOG_HEAP_OPMASK;
271 11901 : if (info == XLOG_HEAP2_PRUNE_ON_ACCESS ||
272 9095 : info == XLOG_HEAP2_PRUNE_VACUUM_SCAN ||
273 : info == XLOG_HEAP2_PRUNE_VACUUM_CLEANUP)
274 3304 : {
275 3304 : xl_heap_prune *xlrec = (xl_heap_prune *) rec;
276 :
277 3304 : if (xlrec->flags & XLHP_HAS_CONFLICT_HORIZON)
278 : {
279 : TransactionId conflict_xid;
280 :
281 2389 : memcpy(&conflict_xid, rec + SizeOfHeapPrune, sizeof(TransactionId));
282 :
283 2389 : appendStringInfo(buf, "snapshotConflictHorizon: %u",
284 : conflict_xid);
285 : }
286 :
287 3304 : appendStringInfo(buf, ", isCatalogRel: %c",
288 3304 : xlrec->flags & XLHP_IS_CATALOG_REL ? 'T' : 'F');
289 :
290 3304 : if (xlrec->flags & XLHP_VM_ALL_VISIBLE)
291 : {
292 2470 : uint8 vmflags = VISIBILITYMAP_ALL_VISIBLE;
293 :
294 2470 : if (xlrec->flags & XLHP_VM_ALL_FROZEN)
295 1312 : vmflags |= VISIBILITYMAP_ALL_FROZEN;
296 2470 : appendStringInfo(buf, ", vm_flags: 0x%02X", vmflags);
297 : }
298 :
299 3304 : if (XLogRecHasBlockData(record, 0))
300 : {
301 : Size datalen;
302 : OffsetNumber *redirected;
303 : OffsetNumber *nowdead;
304 : OffsetNumber *nowunused;
305 : int nredirected;
306 : int nunused;
307 : int ndead;
308 : int nplans;
309 : xlhp_freeze_plan *plans;
310 : OffsetNumber *frz_offsets;
311 :
312 1834 : char *cursor = XLogRecGetBlockData(record, 0, &datalen);
313 :
314 1834 : heap_xlog_deserialize_prune_and_freeze(cursor, xlrec->flags,
315 : &nplans, &plans, &frz_offsets,
316 : &nredirected, &redirected,
317 : &ndead, &nowdead,
318 : &nunused, &nowunused);
319 :
320 1834 : appendStringInfo(buf, ", nplans: %u, nredirected: %u, ndead: %u, nunused: %u",
321 : nplans, nredirected, ndead, nunused);
322 :
323 1834 : if (nplans > 0)
324 : {
325 505 : appendStringInfoString(buf, ", plans:");
326 505 : array_desc(buf, plans, sizeof(xlhp_freeze_plan), nplans,
327 : &plan_elem_desc, &frz_offsets);
328 : }
329 :
330 1834 : if (nredirected > 0)
331 : {
332 289 : appendStringInfoString(buf, ", redirected:");
333 289 : array_desc(buf, redirected, sizeof(OffsetNumber) * 2,
334 : nredirected, &redirect_elem_desc, NULL);
335 : }
336 :
337 1834 : if (ndead > 0)
338 : {
339 570 : appendStringInfoString(buf, ", dead:");
340 570 : array_desc(buf, nowdead, sizeof(OffsetNumber), ndead,
341 : &offset_elem_desc, NULL);
342 : }
343 :
344 1834 : if (nunused > 0)
345 : {
346 586 : appendStringInfoString(buf, ", unused:");
347 586 : array_desc(buf, nowunused, sizeof(OffsetNumber), nunused,
348 : &offset_elem_desc, NULL);
349 : }
350 : }
351 : }
352 8597 : else if (info == XLOG_HEAP2_MULTI_INSERT)
353 : {
354 4828 : xl_heap_multi_insert *xlrec = (xl_heap_multi_insert *) rec;
355 4828 : bool isinit = (XLogRecGetInfo(record) & XLOG_HEAP_INIT_PAGE) != 0;
356 :
357 4828 : appendStringInfo(buf, "ntuples: %d, flags: 0x%02X", xlrec->ntuples,
358 4828 : xlrec->flags);
359 :
360 4828 : if (xlrec->flags & XLH_INSERT_ALL_FROZEN_SET)
361 0 : appendStringInfo(buf, ", vm_flags: 0x%02X",
362 : VISIBILITYMAP_ALL_VISIBLE |
363 : VISIBILITYMAP_ALL_FROZEN);
364 :
365 4828 : if (XLogRecHasBlockData(record, 0) && !isinit)
366 : {
367 4616 : appendStringInfoString(buf, ", offsets:");
368 4616 : array_desc(buf, xlrec->offsets, sizeof(OffsetNumber),
369 4616 : xlrec->ntuples, &offset_elem_desc, NULL);
370 : }
371 : }
372 3769 : else if (info == XLOG_HEAP2_LOCK_UPDATED)
373 : {
374 0 : xl_heap_lock_updated *xlrec = (xl_heap_lock_updated *) rec;
375 :
376 0 : appendStringInfo(buf, "xmax: %u, off: %u, ",
377 0 : xlrec->xmax, xlrec->offnum);
378 0 : infobits_desc(buf, xlrec->infobits_set, "infobits");
379 0 : appendStringInfo(buf, ", flags: 0x%02X", xlrec->flags);
380 : }
381 3769 : else if (info == XLOG_HEAP2_NEW_CID)
382 : {
383 3769 : xl_heap_new_cid *xlrec = (xl_heap_new_cid *) rec;
384 :
385 3769 : appendStringInfo(buf, "rel: %u/%u/%u, tid: %u/%u",
386 : xlrec->target_locator.spcOid,
387 : xlrec->target_locator.dbOid,
388 : xlrec->target_locator.relNumber,
389 3769 : ItemPointerGetBlockNumber(&(xlrec->target_tid)),
390 3769 : ItemPointerGetOffsetNumber(&(xlrec->target_tid)));
391 3769 : appendStringInfo(buf, ", cmin: %u, cmax: %u, combo: %u",
392 : xlrec->cmin, xlrec->cmax, xlrec->combocid);
393 : }
394 11901 : }
395 :
396 : const char *
397 316632 : heap_identify(uint8 info)
398 : {
399 316632 : const char *id = NULL;
400 :
401 316632 : switch (info & ~XLR_INFO_MASK)
402 : {
403 169499 : case XLOG_HEAP_INSERT:
404 169499 : id = "INSERT";
405 169499 : break;
406 2344 : case XLOG_HEAP_INSERT | XLOG_HEAP_INIT_PAGE:
407 2344 : id = "INSERT+INIT";
408 2344 : break;
409 432 : case XLOG_HEAP_DELETE:
410 432 : id = "DELETE";
411 432 : break;
412 70019 : case XLOG_HEAP_UPDATE:
413 70019 : id = "UPDATE";
414 70019 : break;
415 467 : case XLOG_HEAP_UPDATE | XLOG_HEAP_INIT_PAGE:
416 467 : id = "UPDATE+INIT";
417 467 : break;
418 815 : case XLOG_HEAP_HOT_UPDATE:
419 815 : id = "HOT_UPDATE";
420 815 : break;
421 0 : case XLOG_HEAP_HOT_UPDATE | XLOG_HEAP_INIT_PAGE:
422 0 : id = "HOT_UPDATE+INIT";
423 0 : break;
424 17 : case XLOG_HEAP_TRUNCATE:
425 17 : id = "TRUNCATE";
426 17 : break;
427 0 : case XLOG_HEAP_CONFIRM:
428 0 : id = "HEAP_CONFIRM";
429 0 : break;
430 70417 : case XLOG_HEAP_LOCK:
431 70417 : id = "LOCK";
432 70417 : break;
433 2622 : case XLOG_HEAP_INPLACE:
434 2622 : id = "INPLACE";
435 2622 : break;
436 : }
437 :
438 316632 : return id;
439 : }
440 :
441 : const char *
442 11919 : heap2_identify(uint8 info)
443 : {
444 11919 : const char *id = NULL;
445 :
446 11919 : switch (info & ~XLR_INFO_MASK)
447 : {
448 395 : case XLOG_HEAP2_PRUNE_ON_ACCESS:
449 395 : id = "PRUNE_ON_ACCESS";
450 395 : break;
451 2417 : case XLOG_HEAP2_PRUNE_VACUUM_SCAN:
452 2417 : id = "PRUNE_VACUUM_SCAN";
453 2417 : break;
454 501 : case XLOG_HEAP2_PRUNE_VACUUM_CLEANUP:
455 501 : id = "PRUNE_VACUUM_CLEANUP";
456 501 : break;
457 4691 : case XLOG_HEAP2_MULTI_INSERT:
458 4691 : id = "MULTI_INSERT";
459 4691 : break;
460 143 : case XLOG_HEAP2_MULTI_INSERT | XLOG_HEAP_INIT_PAGE:
461 143 : id = "MULTI_INSERT+INIT";
462 143 : break;
463 0 : case XLOG_HEAP2_LOCK_UPDATED:
464 0 : id = "LOCK_UPDATED";
465 0 : break;
466 3772 : case XLOG_HEAP2_NEW_CID:
467 3772 : id = "NEW_CID";
468 3772 : break;
469 0 : case XLOG_HEAP2_REWRITE:
470 0 : id = "REWRITE";
471 0 : break;
472 : }
473 :
474 11919 : return id;
475 : }
|
