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 53 : infobits_desc(StringInfo buf, uint8 infobits, const char *keyname)
28 : {
29 53 : appendStringInfo(buf, "%s: [", keyname);
30 :
31 : Assert(buf->data[buf->len - 1] != ' ');
32 :
33 53 : if (infobits & XLHL_XMAX_IS_MULTI)
34 0 : appendStringInfoString(buf, "IS_MULTI, ");
35 53 : if (infobits & XLHL_XMAX_LOCK_ONLY)
36 10 : appendStringInfoString(buf, "LOCK_ONLY, ");
37 53 : if (infobits & XLHL_XMAX_EXCL_LOCK)
38 10 : appendStringInfoString(buf, "EXCL_LOCK, ");
39 53 : if (infobits & XLHL_XMAX_KEYSHR_LOCK)
40 0 : appendStringInfoString(buf, "KEYSHR_LOCK, ");
41 53 : if (infobits & XLHL_KEYS_UPDATED)
42 20 : appendStringInfoString(buf, "KEYS_UPDATED, ");
43 :
44 53 : if (buf->data[buf->len - 1] == ' ')
45 : {
46 : /* Truncate-away final unneeded ", " */
47 : Assert(buf->data[buf->len - 2] == ',');
48 30 : buf->len -= 2;
49 30 : buf->data[buf->len] = '\0';
50 : }
51 :
52 53 : appendStringInfoChar(buf, ']');
53 53 : }
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 8 : plan_elem_desc(StringInfo buf, void *plan, void *data)
78 : {
79 8 : xlhp_freeze_plan *new_plan = (xlhp_freeze_plan *) plan;
80 8 : OffsetNumber **offsets = data;
81 :
82 8 : appendStringInfo(buf, "{ xmax: %u, infomask: %u, infomask2: %u, ntuples: %u",
83 : new_plan->xmax,
84 8 : new_plan->t_infomask, new_plan->t_infomask2,
85 8 : new_plan->ntuples);
86 :
87 8 : appendStringInfoString(buf, ", offsets:");
88 8 : array_desc(buf, *offsets, sizeof(OffsetNumber), new_plan->ntuples,
89 : &offset_elem_desc, NULL);
90 :
91 8 : *offsets += new_plan->ntuples;
92 :
93 8 : appendStringInfoString(buf, " }");
94 8 : }
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 10192 : 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 10192 : if (flags & XLHP_HAS_FREEZE_PLANS)
114 : {
115 891 : xlhp_freeze_plans *freeze_plans = (xlhp_freeze_plans *) cursor;
116 :
117 891 : *nplans = freeze_plans->nplans;
118 : Assert(*nplans > 0);
119 891 : *plans = freeze_plans->plans;
120 :
121 891 : cursor += offsetof(xlhp_freeze_plans, plans);
122 891 : cursor += sizeof(xlhp_freeze_plan) * *nplans;
123 : }
124 : else
125 : {
126 9301 : *nplans = 0;
127 9301 : *plans = NULL;
128 : }
129 :
130 10192 : if (flags & XLHP_HAS_REDIRECTIONS)
131 : {
132 2125 : xlhp_prune_items *subrecord = (xlhp_prune_items *) cursor;
133 :
134 2125 : *nredirected = subrecord->ntargets;
135 : Assert(*nredirected > 0);
136 2125 : *redirected = &subrecord->data[0];
137 :
138 2125 : cursor += offsetof(xlhp_prune_items, data);
139 2125 : cursor += sizeof(OffsetNumber[2]) * *nredirected;
140 : }
141 : else
142 : {
143 8067 : *nredirected = 0;
144 8067 : *redirected = NULL;
145 : }
146 :
147 10192 : if (flags & XLHP_HAS_DEAD_ITEMS)
148 : {
149 6279 : xlhp_prune_items *subrecord = (xlhp_prune_items *) cursor;
150 :
151 6279 : *ndead = subrecord->ntargets;
152 : Assert(*ndead > 0);
153 6279 : *nowdead = subrecord->data;
154 :
155 6279 : cursor += offsetof(xlhp_prune_items, data);
156 6279 : cursor += sizeof(OffsetNumber) * *ndead;
157 : }
158 : else
159 : {
160 3913 : *ndead = 0;
161 3913 : *nowdead = NULL;
162 : }
163 :
164 10192 : if (flags & XLHP_HAS_NOW_UNUSED_ITEMS)
165 : {
166 4055 : xlhp_prune_items *subrecord = (xlhp_prune_items *) cursor;
167 :
168 4055 : *nunused = subrecord->ntargets;
169 : Assert(*nunused > 0);
170 4055 : *nowunused = subrecord->data;
171 :
172 4055 : cursor += offsetof(xlhp_prune_items, data);
173 4055 : cursor += sizeof(OffsetNumber) * *nunused;
174 : }
175 : else
176 : {
177 6137 : *nunused = 0;
178 6137 : *nowunused = NULL;
179 : }
180 :
181 10192 : *frz_offsets = (OffsetNumber *) cursor;
182 10192 : }
183 :
184 : void
185 30953 : heap_desc(StringInfo buf, XLogReaderState *record)
186 : {
187 30953 : char *rec = XLogRecGetData(record);
188 30953 : uint8 info = XLogRecGetInfo(record) & ~XLR_INFO_MASK;
189 :
190 30953 : info &= XLOG_HEAP_OPMASK;
191 30953 : if (info == XLOG_HEAP_INSERT)
192 : {
193 30898 : xl_heap_insert *xlrec = (xl_heap_insert *) rec;
194 :
195 30898 : appendStringInfo(buf, "off: %u, flags: 0x%02X",
196 30898 : xlrec->offnum,
197 30898 : xlrec->flags);
198 : }
199 55 : else if (info == XLOG_HEAP_DELETE)
200 : {
201 20 : xl_heap_delete *xlrec = (xl_heap_delete *) rec;
202 :
203 20 : appendStringInfo(buf, "xmax: %u, off: %u, ",
204 20 : xlrec->xmax, xlrec->offnum);
205 20 : infobits_desc(buf, xlrec->infobits_set, "infobits");
206 20 : appendStringInfo(buf, ", flags: 0x%02X", xlrec->flags);
207 : }
208 35 : else if (info == XLOG_HEAP_UPDATE)
209 : {
210 11 : xl_heap_update *xlrec = (xl_heap_update *) rec;
211 :
212 11 : appendStringInfo(buf, "old_xmax: %u, old_off: %u, ",
213 11 : xlrec->old_xmax, xlrec->old_offnum);
214 11 : infobits_desc(buf, xlrec->old_infobits_set, "old_infobits");
215 11 : appendStringInfo(buf, ", flags: 0x%02X, new_xmax: %u, new_off: %u",
216 11 : xlrec->flags, xlrec->new_xmax, xlrec->new_offnum);
217 : }
218 24 : else if (info == XLOG_HEAP_HOT_UPDATE)
219 : {
220 12 : xl_heap_update *xlrec = (xl_heap_update *) rec;
221 :
222 12 : appendStringInfo(buf, "old_xmax: %u, old_off: %u, ",
223 12 : xlrec->old_xmax, xlrec->old_offnum);
224 12 : infobits_desc(buf, xlrec->old_infobits_set, "old_infobits");
225 12 : appendStringInfo(buf, ", flags: 0x%02X, new_xmax: %u, new_off: %u",
226 12 : xlrec->flags, xlrec->new_xmax, xlrec->new_offnum);
227 : }
228 12 : 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 12 : 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 12 : else if (info == XLOG_HEAP_LOCK)
245 : {
246 10 : xl_heap_lock *xlrec = (xl_heap_lock *) rec;
247 :
248 10 : appendStringInfo(buf, "xmax: %u, off: %u, ",
249 10 : xlrec->xmax, xlrec->offnum);
250 10 : infobits_desc(buf, xlrec->infobits_set, "infobits");
251 10 : appendStringInfo(buf, ", flags: 0x%02X", xlrec->flags);
252 : }
253 2 : else if (info == XLOG_HEAP_INPLACE)
254 : {
255 2 : xl_heap_inplace *xlrec = (xl_heap_inplace *) rec;
256 :
257 2 : appendStringInfo(buf, "off: %u", xlrec->offnum);
258 2 : standby_desc_invalidations(buf, xlrec->nmsgs, xlrec->msgs,
259 : xlrec->dbId, xlrec->tsId,
260 2 : xlrec->relcacheInitFileInval);
261 : }
262 30953 : }
263 :
264 : void
265 71 : heap2_desc(StringInfo buf, XLogReaderState *record)
266 : {
267 71 : char *rec = XLogRecGetData(record);
268 71 : uint8 info = XLogRecGetInfo(record) & ~XLR_INFO_MASK;
269 :
270 71 : info &= XLOG_HEAP_OPMASK;
271 71 : if (info == XLOG_HEAP2_PRUNE_ON_ACCESS ||
272 22 : info == XLOG_HEAP2_PRUNE_VACUUM_SCAN ||
273 : info == XLOG_HEAP2_PRUNE_VACUUM_CLEANUP)
274 51 : {
275 51 : xl_heap_prune *xlrec = (xl_heap_prune *) rec;
276 :
277 51 : if (xlrec->flags & XLHP_HAS_CONFLICT_HORIZON)
278 : {
279 : TransactionId conflict_xid;
280 :
281 19 : memcpy(&conflict_xid, rec + SizeOfHeapPrune, sizeof(TransactionId));
282 :
283 19 : appendStringInfo(buf, "snapshotConflictHorizon: %u",
284 : conflict_xid);
285 : }
286 :
287 51 : appendStringInfo(buf, ", isCatalogRel: %c",
288 51 : xlrec->flags & XLHP_IS_CATALOG_REL ? 'T' : 'F');
289 :
290 51 : if (xlrec->flags & XLHP_VM_ALL_VISIBLE)
291 : {
292 2 : uint8 vmflags = VISIBILITYMAP_ALL_VISIBLE;
293 :
294 2 : if (xlrec->flags & XLHP_VM_ALL_FROZEN)
295 1 : vmflags |= VISIBILITYMAP_ALL_FROZEN;
296 2 : appendStringInfo(buf, ", vm_flags: 0x%02X", vmflags);
297 : }
298 :
299 51 : 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 51 : char *cursor = XLogRecGetBlockData(record, 0, &datalen);
313 :
314 51 : 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 51 : appendStringInfo(buf, ", nplans: %u, nredirected: %u, ndead: %u, nunused: %u",
321 : nplans, nredirected, ndead, nunused);
322 :
323 51 : if (nplans > 0)
324 : {
325 6 : appendStringInfoString(buf, ", plans:");
326 6 : array_desc(buf, plans, sizeof(xlhp_freeze_plan), nplans,
327 : &plan_elem_desc, &frz_offsets);
328 : }
329 :
330 51 : if (nredirected > 0)
331 : {
332 7 : appendStringInfoString(buf, ", redirected:");
333 7 : array_desc(buf, redirected, sizeof(OffsetNumber) * 2,
334 : nredirected, &redirect_elem_desc, NULL);
335 : }
336 :
337 51 : if (ndead > 0)
338 : {
339 39 : appendStringInfoString(buf, ", dead:");
340 39 : array_desc(buf, nowdead, sizeof(OffsetNumber), ndead,
341 : &offset_elem_desc, NULL);
342 : }
343 :
344 51 : if (nunused > 0)
345 : {
346 12 : appendStringInfoString(buf, ", unused:");
347 12 : array_desc(buf, nowunused, sizeof(OffsetNumber), nunused,
348 : &offset_elem_desc, NULL);
349 : }
350 : }
351 : }
352 20 : else if (info == XLOG_HEAP2_VISIBLE)
353 : {
354 0 : xl_heap_visible *xlrec = (xl_heap_visible *) rec;
355 :
356 0 : appendStringInfo(buf, "snapshotConflictHorizon: %u, flags: 0x%02X",
357 0 : xlrec->snapshotConflictHorizon, xlrec->flags);
358 : }
359 20 : else if (info == XLOG_HEAP2_MULTI_INSERT)
360 : {
361 20 : xl_heap_multi_insert *xlrec = (xl_heap_multi_insert *) rec;
362 20 : bool isinit = (XLogRecGetInfo(record) & XLOG_HEAP_INIT_PAGE) != 0;
363 :
364 20 : appendStringInfo(buf, "ntuples: %d, flags: 0x%02X", xlrec->ntuples,
365 20 : xlrec->flags);
366 :
367 20 : if (xlrec->flags & XLH_INSERT_ALL_FROZEN_SET)
368 0 : appendStringInfo(buf, ", vm_flags: 0x%02X",
369 : VISIBILITYMAP_ALL_VISIBLE |
370 : VISIBILITYMAP_ALL_FROZEN);
371 :
372 20 : if (XLogRecHasBlockData(record, 0) && !isinit)
373 : {
374 18 : appendStringInfoString(buf, ", offsets:");
375 18 : array_desc(buf, xlrec->offsets, sizeof(OffsetNumber),
376 18 : xlrec->ntuples, &offset_elem_desc, NULL);
377 : }
378 : }
379 0 : else if (info == XLOG_HEAP2_LOCK_UPDATED)
380 : {
381 0 : xl_heap_lock_updated *xlrec = (xl_heap_lock_updated *) rec;
382 :
383 0 : appendStringInfo(buf, "xmax: %u, off: %u, ",
384 0 : xlrec->xmax, xlrec->offnum);
385 0 : infobits_desc(buf, xlrec->infobits_set, "infobits");
386 0 : appendStringInfo(buf, ", flags: 0x%02X", xlrec->flags);
387 : }
388 0 : else if (info == XLOG_HEAP2_NEW_CID)
389 : {
390 0 : xl_heap_new_cid *xlrec = (xl_heap_new_cid *) rec;
391 :
392 0 : appendStringInfo(buf, "rel: %u/%u/%u, tid: %u/%u",
393 : xlrec->target_locator.spcOid,
394 : xlrec->target_locator.dbOid,
395 : xlrec->target_locator.relNumber,
396 0 : ItemPointerGetBlockNumber(&(xlrec->target_tid)),
397 0 : ItemPointerGetOffsetNumber(&(xlrec->target_tid)));
398 0 : appendStringInfo(buf, ", cmin: %u, cmax: %u, combo: %u",
399 : xlrec->cmin, xlrec->cmax, xlrec->combocid);
400 : }
401 71 : }
402 :
403 : const char *
404 30953 : heap_identify(uint8 info)
405 : {
406 30953 : const char *id = NULL;
407 :
408 30953 : switch (info & ~XLR_INFO_MASK)
409 : {
410 29488 : case XLOG_HEAP_INSERT:
411 29488 : id = "INSERT";
412 29488 : break;
413 1410 : case XLOG_HEAP_INSERT | XLOG_HEAP_INIT_PAGE:
414 1410 : id = "INSERT+INIT";
415 1410 : break;
416 20 : case XLOG_HEAP_DELETE:
417 20 : id = "DELETE";
418 20 : break;
419 9 : case XLOG_HEAP_UPDATE:
420 9 : id = "UPDATE";
421 9 : break;
422 2 : case XLOG_HEAP_UPDATE | XLOG_HEAP_INIT_PAGE:
423 2 : id = "UPDATE+INIT";
424 2 : break;
425 12 : case XLOG_HEAP_HOT_UPDATE:
426 12 : id = "HOT_UPDATE";
427 12 : break;
428 0 : case XLOG_HEAP_HOT_UPDATE | XLOG_HEAP_INIT_PAGE:
429 0 : id = "HOT_UPDATE+INIT";
430 0 : break;
431 0 : case XLOG_HEAP_TRUNCATE:
432 0 : id = "TRUNCATE";
433 0 : break;
434 0 : case XLOG_HEAP_CONFIRM:
435 0 : id = "HEAP_CONFIRM";
436 0 : break;
437 10 : case XLOG_HEAP_LOCK:
438 10 : id = "LOCK";
439 10 : break;
440 2 : case XLOG_HEAP_INPLACE:
441 2 : id = "INPLACE";
442 2 : break;
443 : }
444 :
445 30953 : return id;
446 : }
447 :
448 : const char *
449 71 : heap2_identify(uint8 info)
450 : {
451 71 : const char *id = NULL;
452 :
453 71 : switch (info & ~XLR_INFO_MASK)
454 : {
455 38 : case XLOG_HEAP2_PRUNE_ON_ACCESS:
456 38 : id = "PRUNE_ON_ACCESS";
457 38 : break;
458 11 : case XLOG_HEAP2_PRUNE_VACUUM_SCAN:
459 11 : id = "PRUNE_VACUUM_SCAN";
460 11 : break;
461 2 : case XLOG_HEAP2_PRUNE_VACUUM_CLEANUP:
462 2 : id = "PRUNE_VACUUM_CLEANUP";
463 2 : break;
464 0 : case XLOG_HEAP2_VISIBLE:
465 0 : id = "VISIBLE";
466 0 : break;
467 20 : case XLOG_HEAP2_MULTI_INSERT:
468 20 : id = "MULTI_INSERT";
469 20 : break;
470 0 : case XLOG_HEAP2_MULTI_INSERT | XLOG_HEAP_INIT_PAGE:
471 0 : id = "MULTI_INSERT+INIT";
472 0 : break;
473 0 : case XLOG_HEAP2_LOCK_UPDATED:
474 0 : id = "LOCK_UPDATED";
475 0 : break;
476 0 : case XLOG_HEAP2_NEW_CID:
477 0 : id = "NEW_CID";
478 0 : break;
479 0 : case XLOG_HEAP2_REWRITE:
480 0 : id = "REWRITE";
481 0 : break;
482 : }
483 :
484 71 : return id;
485 : }
|
