Skip to content

Commit ddbd5d8

Browse files
michaelpqmichaelpq
committed
Add to pageinspect function to make t_infomask/t_infomask2 human-readable
Flags of t_infomask and t_infomask2 for each tuple are already included in the information returned by heap_page_items as integers, and we lacked a way to make that information human-readable. Per discussion, the function includes an option which controls if combined flags should be decomposed or not. The default is false, to not decompose combined flags. The module is bumped to version 1.8. Author: Craig Ringer, Sawada Masahiko Reviewed-by: Peter Geoghegan, Robert Haas, Álvaro Herrera, Moon Insung, Amit Kapila, Michael Paquier, Tomas Vondra Discussion: https://postgr.es/m/CAMsr+YEY7jeaXOb+oX+RhDyOFuTMdmHjGsBxL=igCm03J0go9Q@mail.gmail.com
1 parent aafe276 commit ddbd5d8

File tree

7 files changed

+389
-2
lines changed

7 files changed

+389
-2
lines changed

‎contrib/pageinspect/Makefile‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ OBJS = rawpage.o heapfuncs.o btreefuncs.o fsmfuncs.o \
55
brinfuncs.o ginfuncs.o hashfuncs.o $(WIN32RES)
66

77
EXTENSION = pageinspect
8-
DATA = pageinspect--1.6--1.7.sql \
8+
DATA = pageinspect--1.7--1.8.sql pageinspect--1.6--1.7.sql \
99
pageinspect--1.5.sql pageinspect--1.5--1.6.sql \
1010
pageinspect--1.4--1.5.sql pageinspect--1.3--1.4.sql \
1111
pageinspect--1.2--1.3.sql pageinspect--1.1--1.2.sql \

‎contrib/pageinspect/expected/page.out‎

Lines changed: 180 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,186 @@ SELECT * FROM fsm_page_contents(get_raw_page('test1', 'fsm', 0));
8282

8383
(1 row)
8484

85+
-- If we freeze the only tuple on test1, the infomask should
86+
-- always be the same in all test runs. we show raw flags by
87+
-- default: HEAP_XMIN_COMMITTED and HEAP_XMIN_INVALID.
88+
VACUUM FREEZE test1;
89+
SELECT t_infomask, t_infomask2, flags
90+
FROM heap_page_items(get_raw_page('test1', 0)),
91+
LATERAL heap_tuple_infomask_flags(t_infomask, t_infomask2) m(flags);
92+
t_infomask | t_infomask2 | flags
93+
------------+-------------+-----------------------------------------------------------
94+
2816 | 2 | {HEAP_XMAX_INVALID,HEAP_XMIN_COMMITTED,HEAP_XMIN_INVALID}
95+
(1 row)
96+
97+
-- output the decoded flag HEAP_XMIN_FROZEN instead
98+
SELECT t_infomask, t_infomask2, flags
99+
FROM heap_page_items(get_raw_page('test1', 0)),
100+
LATERAL heap_tuple_infomask_flags(t_infomask, t_infomask2, true) m(flags);
101+
t_infomask | t_infomask2 | flags
102+
------------+-------------+--------------------------------------
103+
2816 | 2 | {HEAP_XMAX_INVALID,HEAP_XMIN_FROZEN}
104+
(1 row)
105+
106+
-- tests for decoding of combined flags
107+
-- HEAP_XMAX_SHR_LOCK = (HEAP_XMAX_EXCL_LOCK | HEAP_XMAX_KEYSHR_LOCK)
108+
SELECT heap_tuple_infomask_flags(x'0050'::int, 0, true);
109+
heap_tuple_infomask_flags
110+
---------------------------
111+
{HEAP_XMAX_SHR_LOCK}
112+
(1 row)
113+
114+
SELECT heap_tuple_infomask_flags(x'0050'::int, 0, false);
115+
heap_tuple_infomask_flags
116+
---------------------------------------------
117+
{HEAP_XMAX_EXCL_LOCK,HEAP_XMAX_KEYSHR_LOCK}
118+
(1 row)
119+
120+
-- HEAP_XMIN_FROZEN = (HEAP_XMIN_COMMITTED | HEAP_XMIN_INVALID)
121+
SELECT heap_tuple_infomask_flags(x'0300'::int, 0, true);
122+
heap_tuple_infomask_flags
123+
---------------------------
124+
{HEAP_XMIN_FROZEN}
125+
(1 row)
126+
127+
SELECT heap_tuple_infomask_flags(x'0300'::int, 0, false);
128+
heap_tuple_infomask_flags
129+
-----------------------------------------
130+
{HEAP_XMIN_COMMITTED,HEAP_XMIN_INVALID}
131+
(1 row)
132+
133+
-- HEAP_MOVED = (HEAP_MOVED_IN | HEAP_MOVED_OFF)
134+
SELECT heap_tuple_infomask_flags(x'C000'::int, 0, true);
135+
heap_tuple_infomask_flags
136+
---------------------------
137+
{HEAP_MOVED}
138+
(1 row)
139+
140+
SELECT heap_tuple_infomask_flags(x'C000'::int, 0, false);
141+
heap_tuple_infomask_flags
142+
--------------------------------
143+
{HEAP_MOVED_IN,HEAP_MOVED_OFF}
144+
(1 row)
145+
146+
-- HEAP_LOCKED_UPGRADED = (HEAP_XMAX_IS_MULTI | HEAP_XMAX_LOCK_ONLY)
147+
SELECT heap_tuple_infomask_flags(x'1080'::int, 0, true);
148+
heap_tuple_infomask_flags
149+
---------------------------
150+
{HEAP_LOCKED_UPGRADED}
151+
(1 row)
152+
153+
SELECT heap_tuple_infomask_flags(x'1080'::int, 0, false);
154+
heap_tuple_infomask_flags
155+
------------------------------------------
156+
{HEAP_XMAX_LOCK_ONLY,HEAP_XMAX_IS_MULTI}
157+
(1 row)
158+
159+
-- test all flags of t_infomask and t_infomask2
160+
SELECT unnest(heap_tuple_infomask_flags(x'FFFF'::int, x'FFFF'::int, false))
161+
AS flags ORDER BY 1;
162+
flags
163+
-----------------------
164+
HEAP_COMBOCID
165+
HEAP_HASEXTERNAL
166+
HEAP_HASNULL
167+
HEAP_HASOID_OLD
168+
HEAP_HASVARWIDTH
169+
HEAP_HOT_UPDATED
170+
HEAP_KEYS_UPDATED
171+
HEAP_MOVED_IN
172+
HEAP_MOVED_OFF
173+
HEAP_ONLY_TUPLE
174+
HEAP_UPDATED
175+
HEAP_XMAX_COMMITTED
176+
HEAP_XMAX_EXCL_LOCK
177+
HEAP_XMAX_INVALID
178+
HEAP_XMAX_IS_MULTI
179+
HEAP_XMAX_KEYSHR_LOCK
180+
HEAP_XMAX_LOCK_ONLY
181+
HEAP_XMIN_COMMITTED
182+
HEAP_XMIN_INVALID
183+
(19 rows)
184+
185+
SELECT unnest(heap_tuple_infomask_flags(x'FFFF'::int, x'FFFF'::int, true))
186+
AS flags ORDER BY 1;
187+
flags
188+
---------------------
189+
HEAP_COMBOCID
190+
HEAP_HASEXTERNAL
191+
HEAP_HASNULL
192+
HEAP_HASOID_OLD
193+
HEAP_HASVARWIDTH
194+
HEAP_HOT_UPDATED
195+
HEAP_KEYS_UPDATED
196+
HEAP_MOVED
197+
HEAP_ONLY_TUPLE
198+
HEAP_UPDATED
199+
HEAP_XMAX_COMMITTED
200+
HEAP_XMAX_INVALID
201+
HEAP_XMAX_IS_MULTI
202+
HEAP_XMAX_LOCK_ONLY
203+
HEAP_XMAX_SHR_LOCK
204+
HEAP_XMIN_FROZEN
205+
(16 rows)
206+
207+
SELECT unnest(heap_tuple_infomask_flags(-1, -1, false))
208+
AS flags ORDER BY 1;
209+
flags
210+
-----------------------
211+
HEAP_COMBOCID
212+
HEAP_HASEXTERNAL
213+
HEAP_HASNULL
214+
HEAP_HASOID_OLD
215+
HEAP_HASVARWIDTH
216+
HEAP_HOT_UPDATED
217+
HEAP_KEYS_UPDATED
218+
HEAP_MOVED_IN
219+
HEAP_MOVED_OFF
220+
HEAP_ONLY_TUPLE
221+
HEAP_UPDATED
222+
HEAP_XMAX_COMMITTED
223+
HEAP_XMAX_EXCL_LOCK
224+
HEAP_XMAX_INVALID
225+
HEAP_XMAX_IS_MULTI
226+
HEAP_XMAX_KEYSHR_LOCK
227+
HEAP_XMAX_LOCK_ONLY
228+
HEAP_XMIN_COMMITTED
229+
HEAP_XMIN_INVALID
230+
(19 rows)
231+
232+
SELECT unnest(heap_tuple_infomask_flags(-1, -1, true))
233+
AS flags ORDER BY 1;
234+
flags
235+
---------------------
236+
HEAP_COMBOCID
237+
HEAP_HASEXTERNAL
238+
HEAP_HASNULL
239+
HEAP_HASOID_OLD
240+
HEAP_HASVARWIDTH
241+
HEAP_HOT_UPDATED
242+
HEAP_KEYS_UPDATED
243+
HEAP_MOVED
244+
HEAP_ONLY_TUPLE
245+
HEAP_UPDATED
246+
HEAP_XMAX_COMMITTED
247+
HEAP_XMAX_INVALID
248+
HEAP_XMAX_IS_MULTI
249+
HEAP_XMAX_LOCK_ONLY
250+
HEAP_XMAX_SHR_LOCK
251+
HEAP_XMIN_FROZEN
252+
(16 rows)
253+
254+
-- no flags
255+
SELECT unnest(heap_tuple_infomask_flags(0, 0, false));
256+
unnest
257+
--------
258+
(0 rows)
259+
260+
SELECT unnest(heap_tuple_infomask_flags(0, 0, true));
261+
unnest
262+
--------
263+
(0 rows)
264+
85265
DROP TABLE test1;
86266
-- check that using any of these functions with a partitioned table or index
87267
-- would fail

‎contrib/pageinspect/heapfuncs.c‎

Lines changed: 109 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@
3333
#include "catalog/pg_am_d.h"
3434
#include "catalog/pg_type.h"
3535
#include "miscadmin.h"
36+
#include "port/pg_bitutils.h"
3637
#include "utils/array.h"
3738
#include "utils/builtins.h"
3839
#include "utils/rel.h"
@@ -494,3 +495,111 @@ tuple_data_split(PG_FUNCTION_ARGS)
494495

495496
PG_RETURN_ARRAYTYPE_P(res);
496497
}
498+
499+
/*
500+
* heap_tuple_infomask_flags
501+
*
502+
* Decode into a human-readable format t_infomask and t_infomask2 associated
503+
* to a tuple. All the flags are described in access/htup_details.h.
504+
*/
505+
PG_FUNCTION_INFO_V1(heap_tuple_infomask_flags);
506+
507+
Datum
508+
heap_tuple_infomask_flags(PG_FUNCTION_ARGS)
509+
{
510+
uint16 t_infomask = PG_GETARG_INT16(0);
511+
uint16 t_infomask2 = PG_GETARG_INT16(1);
512+
bool decode_combined = PG_GETARG_BOOL(2);
513+
int cnt = 0;
514+
ArrayType *a;
515+
int bitcnt;
516+
Datum *d;
517+
518+
if (!superuser())
519+
ereport(ERROR,
520+
(errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
521+
errmsg("must be superuser to use raw page functions")));
522+
523+
bitcnt = pg_popcount((const char *) &t_infomask, sizeof(uint16)) +
524+
pg_popcount((const char *) &t_infomask2, sizeof(uint16));
525+
526+
/* If no flags, return an empty array */
527+
if (bitcnt <= 0)
528+
PG_RETURN_POINTER(construct_empty_array(TEXTOID));
529+
530+
d = (Datum *) palloc0(sizeof(Datum) * bitcnt);
531+
532+
/* decode t_infomask */
533+
if ((t_infomask & HEAP_HASNULL) != 0)
534+
d[cnt++] = CStringGetTextDatum("HEAP_HASNULL");
535+
if ((t_infomask & HEAP_HASVARWIDTH) != 0)
536+
d[cnt++] = CStringGetTextDatum("HEAP_HASVARWIDTH");
537+
if ((t_infomask & HEAP_HASEXTERNAL) != 0)
538+
d[cnt++] = CStringGetTextDatum("HEAP_HASEXTERNAL");
539+
if ((t_infomask & HEAP_HASOID_OLD) != 0)
540+
d[cnt++] = CStringGetTextDatum("HEAP_HASOID_OLD");
541+
if ((t_infomask & HEAP_COMBOCID) != 0)
542+
d[cnt++] = CStringGetTextDatum("HEAP_COMBOCID");
543+
if ((t_infomask & HEAP_XMAX_COMMITTED) != 0)
544+
d[cnt++] = CStringGetTextDatum("HEAP_XMAX_COMMITTED");
545+
if ((t_infomask & HEAP_XMAX_INVALID) != 0)
546+
d[cnt++] = CStringGetTextDatum("HEAP_XMAX_INVALID");
547+
if ((t_infomask & HEAP_UPDATED) != 0)
548+
d[cnt++] = CStringGetTextDatum("HEAP_UPDATED");
549+
550+
/* decode combined masks of t_infomaks */
551+
if (decode_combined && (t_infomask & HEAP_XMAX_SHR_LOCK) != 0)
552+
d[cnt++] = CStringGetTextDatum("HEAP_XMAX_SHR_LOCK");
553+
else
554+
{
555+
if ((t_infomask & HEAP_XMAX_EXCL_LOCK) != 0)
556+
d[cnt++] = CStringGetTextDatum("HEAP_XMAX_EXCL_LOCK");
557+
if ((t_infomask & HEAP_XMAX_KEYSHR_LOCK) != 0)
558+
d[cnt++] = CStringGetTextDatum("HEAP_XMAX_KEYSHR_LOCK");
559+
}
560+
561+
if (decode_combined && (t_infomask & HEAP_XMIN_FROZEN) != 0)
562+
d[cnt++] = CStringGetTextDatum("HEAP_XMIN_FROZEN");
563+
else
564+
{
565+
if ((t_infomask & HEAP_XMIN_COMMITTED) != 0)
566+
d[cnt++] = CStringGetTextDatum("HEAP_XMIN_COMMITTED");
567+
if ((t_infomask & HEAP_XMIN_INVALID) != 0)
568+
d[cnt++] = CStringGetTextDatum("HEAP_XMIN_INVALID");
569+
}
570+
571+
if (decode_combined && (t_infomask & HEAP_MOVED) != 0)
572+
d[cnt++] = CStringGetTextDatum("HEAP_MOVED");
573+
else
574+
{
575+
if ((t_infomask & HEAP_MOVED_IN) != 0)
576+
d[cnt++] = CStringGetTextDatum("HEAP_MOVED_IN");
577+
if ((t_infomask & HEAP_MOVED_OFF) != 0)
578+
d[cnt++] = CStringGetTextDatum("HEAP_MOVED_OFF");
579+
}
580+
581+
if (decode_combined && HEAP_LOCKED_UPGRADED(t_infomask))
582+
d[cnt++] = CStringGetTextDatum("HEAP_LOCKED_UPGRADED");
583+
else
584+
{
585+
if (HEAP_XMAX_IS_LOCKED_ONLY(t_infomask))
586+
d[cnt++] = CStringGetTextDatum("HEAP_XMAX_LOCK_ONLY");
587+
if ((t_infomask & HEAP_XMAX_IS_MULTI) != 0)
588+
d[cnt++] = CStringGetTextDatum("HEAP_XMAX_IS_MULTI");
589+
}
590+
591+
/* decode t_infomask2 */
592+
if ((t_infomask2 & HEAP_KEYS_UPDATED) != 0)
593+
d[cnt++] = CStringGetTextDatum("HEAP_KEYS_UPDATED");
594+
if ((t_infomask2 & HEAP_HOT_UPDATED) != 0)
595+
d[cnt++] = CStringGetTextDatum("HEAP_HOT_UPDATED");
596+
if ((t_infomask2 & HEAP_ONLY_TUPLE) != 0)
597+
d[cnt++] = CStringGetTextDatum("HEAP_ONLY_TUPLE");
598+
599+
Assert(cnt <= bitcnt);
600+
a = construct_array(d, cnt, TEXTOID, -1, false, 'i');
601+
602+
pfree(d);
603+
604+
PG_RETURN_POINTER(a);
605+
}

‎contrib/pageinspect/pageinspect--1.7--1.8.sql‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
/* contrib/pageinspect/pageinspect--1.7--1.8.sql */
2+
3+
-- complain if script is sourced in psql, rather than via ALTER EXTENSION
4+
\echo Use "ALTER EXTENSION pageinspect UPDATE TO '1.8'" to load this file. \quit
5+
6+
--
7+
-- heap_tuple_infomask_flags()
8+
--
9+
CREATE FUNCTION heap_tuple_infomask_flags(
10+
t_infomask integer,
11+
t_infomask2 integer,
12+
decode_combined boolean DEFAULT false)
13+
RETURNS text[]
14+
AS 'MODULE_PATHNAME', 'heap_tuple_infomask_flags'
15+
LANGUAGE C STRICT PARALLEL SAFE;

‎contrib/pageinspect/pageinspect.control‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# pageinspect extension
22
comment = 'inspect the contents of database pages at a low level'
3-
default_version = '1.7'
3+
default_version = '1.8'
44
module_pathname = '$libdir/pageinspect'
55
relocatable = true

‎contrib/pageinspect/sql/page.sql‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,48 @@ SELECT tuple_data_split('test1'::regclass, t_data, t_infomask, t_infomask2, t_bi
3131

3232
SELECT * FROM fsm_page_contents(get_raw_page('test1', 'fsm', 0));
3333

34+
-- If we freeze the only tuple on test1, the infomask should
35+
-- always be the same in all test runs. we show raw flags by
36+
-- default: HEAP_XMIN_COMMITTED and HEAP_XMIN_INVALID.
37+
VACUUM FREEZE test1;
38+
39+
SELECT t_infomask, t_infomask2, flags
40+
FROM heap_page_items(get_raw_page('test1', 0)),
41+
LATERAL heap_tuple_infomask_flags(t_infomask, t_infomask2) m(flags);
42+
43+
-- output the decoded flag HEAP_XMIN_FROZEN instead
44+
SELECT t_infomask, t_infomask2, flags
45+
FROM heap_page_items(get_raw_page('test1', 0)),
46+
LATERAL heap_tuple_infomask_flags(t_infomask, t_infomask2, true) m(flags);
47+
48+
-- tests for decoding of combined flags
49+
-- HEAP_XMAX_SHR_LOCK = (HEAP_XMAX_EXCL_LOCK | HEAP_XMAX_KEYSHR_LOCK)
50+
SELECT heap_tuple_infomask_flags(x'0050'::int, 0, true);
51+
SELECT heap_tuple_infomask_flags(x'0050'::int, 0, false);
52+
-- HEAP_XMIN_FROZEN = (HEAP_XMIN_COMMITTED | HEAP_XMIN_INVALID)
53+
SELECT heap_tuple_infomask_flags(x'0300'::int, 0, true);
54+
SELECT heap_tuple_infomask_flags(x'0300'::int, 0, false);
55+
-- HEAP_MOVED = (HEAP_MOVED_IN | HEAP_MOVED_OFF)
56+
SELECT heap_tuple_infomask_flags(x'C000'::int, 0, true);
57+
SELECT heap_tuple_infomask_flags(x'C000'::int, 0, false);
58+
-- HEAP_LOCKED_UPGRADED = (HEAP_XMAX_IS_MULTI | HEAP_XMAX_LOCK_ONLY)
59+
SELECT heap_tuple_infomask_flags(x'1080'::int, 0, true);
60+
SELECT heap_tuple_infomask_flags(x'1080'::int, 0, false);
61+
62+
-- test all flags of t_infomask and t_infomask2
63+
SELECT unnest(heap_tuple_infomask_flags(x'FFFF'::int, x'FFFF'::int, false))
64+
AS flags ORDER BY 1;
65+
SELECT unnest(heap_tuple_infomask_flags(x'FFFF'::int, x'FFFF'::int, true))
66+
AS flags ORDER BY 1;
67+
SELECT unnest(heap_tuple_infomask_flags(-1, -1, false))
68+
AS flags ORDER BY 1;
69+
SELECT unnest(heap_tuple_infomask_flags(-1, -1, true))
70+
AS flags ORDER BY 1;
71+
72+
-- no flags
73+
SELECT unnest(heap_tuple_infomask_flags(0, 0, false));
74+
SELECT unnest(heap_tuple_infomask_flags(0, 0, true));
75+
3476
DROP TABLE test1;
3577

3678
-- check that using any of these functions with a partitioned table or index

0 commit comments

Comments
 (0)