PostgreSQL Source Code git master
All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
pgrowlocks.c File Reference
#include "postgres.h"
#include "access/heapam.h"
#include "access/multixact.h"
#include "access/relscan.h"
#include "access/tableam.h"
#include "access/xact.h"
#include "catalog/namespace.h"
#include "catalog/pg_am_d.h"
#include "catalog/pg_authid.h"
#include "funcapi.h"
#include "miscadmin.h"
#include "storage/bufmgr.h"
#include "storage/procarray.h"
#include "utils/acl.h"
#include "utils/fmgrprotos.h"
#include "utils/rel.h"
#include "utils/snapmgr.h"
#include "utils/varlena.h"
Include dependency graph for pgrowlocks.c:

Go to the source code of this file.

Macros

#define NCHARS   32
 
#define Atnum_tid   0
 
#define Atnum_xmax   1
 
#define Atnum_ismulti   2
 
#define Atnum_xids   3
 
#define Atnum_modes   4
 
#define Atnum_pids   5
 

Functions

 PG_MODULE_MAGIC_EXT (.name="pgrowlocks",.version=PG_VERSION)
 
 PG_FUNCTION_INFO_V1 (pgrowlocks)
 
Datum pgrowlocks (PG_FUNCTION_ARGS)
 

Macro Definition Documentation

◆ Atnum_ismulti

#define Atnum_ismulti   2

Definition at line 62 of file pgrowlocks.c.

◆ Atnum_modes

#define Atnum_modes   4

Definition at line 64 of file pgrowlocks.c.

◆ Atnum_pids

#define Atnum_pids   5

Definition at line 65 of file pgrowlocks.c.

◆ Atnum_tid

#define Atnum_tid   0

Definition at line 60 of file pgrowlocks.c.

◆ Atnum_xids

#define Atnum_xids   3

Definition at line 63 of file pgrowlocks.c.

◆ Atnum_xmax

#define Atnum_xmax   1

Definition at line 61 of file pgrowlocks.c.

◆ NCHARS

#define NCHARS   32

Definition at line 58 of file pgrowlocks.c.

Function Documentation

◆ PG_FUNCTION_INFO_V1()

PG_FUNCTION_INFO_V1 ( pgrowlocks  )

◆ PG_MODULE_MAGIC_EXT()

PG_MODULE_MAGIC_EXT ( name = "pgrowlocks",
version = PG_VERSION 
)

◆ pgrowlocks()

Datum pgrowlocks ( PG_FUNCTION_ARGS  )

Definition at line 68 of file pgrowlocks.c.

69{
71 ReturnSetInfo *rsinfo = (ReturnSetInfo *) fcinfo->resultinfo;
72 AttInMetadata *attinmeta;
73 Relation rel;
74 RangeVar *relrv;
75 TableScanDesc scan;
76 HeapScanDesc hscan;
77 HeapTuple tuple;
78 AclResult aclresult;
79 char **values;
80
81 InitMaterializedSRF(fcinfo, 0);
82
83 /* Access the table */
85 rel = relation_openrv(relrv, AccessShareLock);
86
87 if (rel->rd_rel->relkind == RELKIND_PARTITIONED_TABLE)
89 (errcode(ERRCODE_WRONG_OBJECT_TYPE),
90 errmsg("\"%s\" is a partitioned table",
92 errdetail("Partitioned tables do not contain rows.")));
93 else if (rel->rd_rel->relkind != RELKIND_RELATION)
95 (errcode(ERRCODE_WRONG_OBJECT_TYPE),
96 errmsg("\"%s\" is not a table",
98 else if (rel->rd_rel->relam != HEAP_TABLE_AM_OID)
100 (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
101 errmsg("only heap AM is supported")));
102
103 /*
104 * check permissions: must have SELECT on table or be in
105 * pg_stat_scan_tables
106 */
107 aclresult = pg_class_aclcheck(RelationGetRelid(rel), GetUserId(),
108 ACL_SELECT);
109 if (aclresult != ACLCHECK_OK)
110 aclresult = has_privs_of_role(GetUserId(), ROLE_PG_STAT_SCAN_TABLES) ? ACLCHECK_OK : ACLCHECK_NO_PRIV;
111
112 if (aclresult != ACLCHECK_OK)
113 aclcheck_error(aclresult, get_relkind_objtype(rel->rd_rel->relkind),
115
116 /* Scan the relation */
117 scan = table_beginscan(rel, GetActiveSnapshot(), 0, NULL);
118 hscan = (HeapScanDesc) scan;
119
120 attinmeta = TupleDescGetAttInMetadata(rsinfo->setDesc);
121
122 values = (char **) palloc(rsinfo->setDesc->natts * sizeof(char *));
123
124 while ((tuple = heap_getnext(scan, ForwardScanDirection)) != NULL)
125 {
126 TM_Result htsu;
127 TransactionId xmax;
128 uint16 infomask;
129
130 /* must hold a buffer lock to call HeapTupleSatisfiesUpdate */
131 LockBuffer(hscan->rs_cbuf, BUFFER_LOCK_SHARE);
132
133 htsu = HeapTupleSatisfiesUpdate(tuple,
134 GetCurrentCommandId(false),
135 hscan->rs_cbuf);
136 xmax = HeapTupleHeaderGetRawXmax(tuple->t_data);
137 infomask = tuple->t_data->t_infomask;
138
139 /*
140 * A tuple is locked if HTSU returns BeingModified.
141 */
142 if (htsu == TM_BeingModified)
143 {
145 PointerGetDatum(&tuple->t_self));
146
147 values[Atnum_xmax] = palloc(NCHARS * sizeof(char));
148 snprintf(values[Atnum_xmax], NCHARS, "%u", xmax);
149 if (infomask & HEAP_XMAX_IS_MULTI)
150 {
151 MultiXactMember *members;
152 int nmembers;
153 bool first = true;
154 bool allow_old;
155
156 values[Atnum_ismulti] = pstrdup("true");
157
158 allow_old = HEAP_LOCKED_UPGRADED(infomask);
159 nmembers = GetMultiXactIdMembers(xmax, &members, allow_old,
160 false);
161 if (nmembers == -1)
162 {
163 values[Atnum_xids] = "{0}";
164 values[Atnum_modes] = "{transient upgrade status}";
165 values[Atnum_pids] = "{0}";
166 }
167 else
168 {
169 int j;
170
171 values[Atnum_xids] = palloc(NCHARS * nmembers);
172 values[Atnum_modes] = palloc(NCHARS * nmembers);
173 values[Atnum_pids] = palloc(NCHARS * nmembers);
174
175 strcpy(values[Atnum_xids], "{");
176 strcpy(values[Atnum_modes], "{");
177 strcpy(values[Atnum_pids], "{");
178
179 for (j = 0; j < nmembers; j++)
180 {
181 char buf[NCHARS];
182
183 if (!first)
184 {
185 strcat(values[Atnum_xids], ",");
186 strcat(values[Atnum_modes], ",");
187 strcat(values[Atnum_pids], ",");
188 }
189 snprintf(buf, NCHARS, "%u", members[j].xid);
190 strcat(values[Atnum_xids], buf);
191 switch (members[j].status)
192 {
194 snprintf(buf, NCHARS, "Update");
195 break;
197 snprintf(buf, NCHARS, "No Key Update");
198 break;
200 snprintf(buf, NCHARS, "For Update");
201 break;
203 snprintf(buf, NCHARS, "For No Key Update");
204 break;
206 snprintf(buf, NCHARS, "For Share");
207 break;
209 snprintf(buf, NCHARS, "For Key Share");
210 break;
211 }
212 strcat(values[Atnum_modes], buf);
213 snprintf(buf, NCHARS, "%d",
214 BackendXidGetPid(members[j].xid));
215 strcat(values[Atnum_pids], buf);
216
217 first = false;
218 }
219
220 strcat(values[Atnum_xids], "}");
221 strcat(values[Atnum_modes], "}");
222 strcat(values[Atnum_pids], "}");
223 }
224 }
225 else
226 {
227 values[Atnum_ismulti] = pstrdup("false");
228
229 values[Atnum_xids] = palloc(NCHARS * sizeof(char));
230 snprintf(values[Atnum_xids], NCHARS, "{%u}", xmax);
231
233 if (infomask & HEAP_XMAX_LOCK_ONLY)
234 {
235 if (HEAP_XMAX_IS_SHR_LOCKED(infomask))
236 snprintf(values[Atnum_modes], NCHARS, "{For Share}");
237 else if (HEAP_XMAX_IS_KEYSHR_LOCKED(infomask))
238 snprintf(values[Atnum_modes], NCHARS, "{For Key Share}");
239 else if (HEAP_XMAX_IS_EXCL_LOCKED(infomask))
240 {
241 if (tuple->t_data->t_infomask2 & HEAP_KEYS_UPDATED)
242 snprintf(values[Atnum_modes], NCHARS, "{For Update}");
243 else
244 snprintf(values[Atnum_modes], NCHARS, "{For No Key Update}");
245 }
246 else
247 /* neither keyshare nor exclusive bit it set */
249 "{transient upgrade status}");
250 }
251 else
252 {
253 if (tuple->t_data->t_infomask2 & HEAP_KEYS_UPDATED)
254 snprintf(values[Atnum_modes], NCHARS, "{Update}");
255 else
256 snprintf(values[Atnum_modes], NCHARS, "{No Key Update}");
257 }
258
259 values[Atnum_pids] = palloc(NCHARS * sizeof(char));
261 BackendXidGetPid(xmax));
262 }
263
264 LockBuffer(hscan->rs_cbuf, BUFFER_LOCK_UNLOCK);
265
266 /* build a tuple */
267 tuple = BuildTupleFromCStrings(attinmeta, values);
268 tuplestore_puttuple(rsinfo->setResult, tuple);
269 }
270 else
271 {
272 LockBuffer(hscan->rs_cbuf, BUFFER_LOCK_UNLOCK);
273 }
274 }
275
276 table_endscan(scan);
278 return (Datum) 0;
279}
bool has_privs_of_role(Oid member, Oid role)
Definition: acl.c:5268
AclResult
Definition: acl.h:182
@ ACLCHECK_NO_PRIV
Definition: acl.h:184
@ ACLCHECK_OK
Definition: acl.h:183
void aclcheck_error(AclResult aclerr, ObjectType objtype, const char *objectname)
Definition: aclchk.c:2639
AclResult pg_class_aclcheck(Oid table_oid, Oid roleid, AclMode mode)
Definition: aclchk.c:4024
static Datum values[MAXATTR]
Definition: bootstrap.c:151
void LockBuffer(Buffer buffer, int mode)
Definition: bufmgr.c:5607
#define BUFFER_LOCK_UNLOCK
Definition: bufmgr.h:196
#define BUFFER_LOCK_SHARE
Definition: bufmgr.h:197
uint16_t uint16
Definition: c.h:501
uint32 TransactionId
Definition: c.h:623
int errdetail(const char *fmt,...)
Definition: elog.c:1204
int errcode(int sqlerrcode)
Definition: elog.c:854
int errmsg(const char *fmt,...)
Definition: elog.c:1071
#define ERROR
Definition: elog.h:39
#define ereport(elevel,...)
Definition: elog.h:149
HeapTuple BuildTupleFromCStrings(AttInMetadata *attinmeta, char **values)
Definition: execTuples.c:2324
AttInMetadata * TupleDescGetAttInMetadata(TupleDesc tupdesc)
Definition: execTuples.c:2275
#define PG_GETARG_TEXT_PP(n)
Definition: fmgr.h:309
#define DirectFunctionCall1(func, arg1)
Definition: fmgr.h:682
void InitMaterializedSRF(FunctionCallInfo fcinfo, bits32 flags)
Definition: funcapi.c:76
HeapTuple heap_getnext(TableScanDesc sscan, ScanDirection direction)
Definition: heapam.c:1314
struct HeapScanDescData * HeapScanDesc
Definition: heapam.h:100
TM_Result HeapTupleSatisfiesUpdate(HeapTuple htup, CommandId curcid, Buffer buffer)
static bool HEAP_XMAX_IS_SHR_LOCKED(int16 infomask)
Definition: htup_details.h:263
#define HEAP_KEYS_UPDATED
Definition: htup_details.h:289
#define HEAP_XMAX_LOCK_ONLY
Definition: htup_details.h:197
static TransactionId HeapTupleHeaderGetRawXmax(const HeapTupleHeaderData *tup)
Definition: htup_details.h:377
static bool HEAP_XMAX_IS_KEYSHR_LOCKED(int16 infomask)
Definition: htup_details.h:275
#define HEAP_XMAX_IS_MULTI
Definition: htup_details.h:209
static bool HEAP_LOCKED_UPGRADED(uint16 infomask)
Definition: htup_details.h:251
static bool HEAP_XMAX_IS_EXCL_LOCKED(int16 infomask)
Definition: htup_details.h:269
int j
Definition: isn.c:78
#define AccessShareLock
Definition: lockdefs.h:36
char * pstrdup(const char *in)
Definition: mcxt.c:2325
void * palloc(Size size)
Definition: mcxt.c:1943
Oid GetUserId(void)
Definition: miscinit.c:520
int GetMultiXactIdMembers(MultiXactId multi, MultiXactMember **members, bool from_pgupgrade, bool isLockOnly)
Definition: multixact.c:1299
@ MultiXactStatusForShare
Definition: multixact.h:40
@ MultiXactStatusForNoKeyUpdate
Definition: multixact.h:41
@ MultiXactStatusNoKeyUpdate
Definition: multixact.h:44
@ MultiXactStatusUpdate
Definition: multixact.h:46
@ MultiXactStatusForUpdate
Definition: multixact.h:42
@ MultiXactStatusForKeyShare
Definition: multixact.h:39
RangeVar * makeRangeVarFromNameList(const List *names)
Definition: namespace.c:3554
ObjectType get_relkind_objtype(char relkind)
#define ACL_SELECT
Definition: parsenodes.h:77
NameData relname
Definition: pg_class.h:38
static char * buf
Definition: pg_test_fsync.c:72
#define Atnum_modes
Definition: pgrowlocks.c:64
#define NCHARS
Definition: pgrowlocks.c:58
#define Atnum_xids
Definition: pgrowlocks.c:63
#define Atnum_ismulti
Definition: pgrowlocks.c:62
#define Atnum_tid
Definition: pgrowlocks.c:60
#define Atnum_pids
Definition: pgrowlocks.c:65
#define Atnum_xmax
Definition: pgrowlocks.c:61
#define snprintf
Definition: port.h:239
static Datum PointerGetDatum(const void *X)
Definition: postgres.h:327
uintptr_t Datum
Definition: postgres.h:69
int BackendXidGetPid(TransactionId xid)
Definition: procarray.c:3256
#define RelationGetRelid(relation)
Definition: rel.h:516
#define RelationGetRelationName(relation)
Definition: rel.h:550
@ ForwardScanDirection
Definition: sdir.h:28
Snapshot GetActiveSnapshot(void)
Definition: snapmgr.c:787
Relation relation_openrv(const RangeVar *relation, LOCKMODE lockmode)
Definition: relation.c:137
TupleDesc setDesc
Definition: execnodes.h:359
Tuplestorestate * setResult
Definition: execnodes.h:358
Definition: c.h:658
void table_close(Relation relation, LOCKMODE lockmode)
Definition: table.c:126
static TableScanDesc table_beginscan(Relation rel, Snapshot snapshot, int nkeys, struct ScanKeyData *key)
Definition: tableam.h:870
static void table_endscan(TableScanDesc scan)
Definition: tableam.h:979
TM_Result
Definition: tableam.h:72
@ TM_BeingModified
Definition: tableam.h:99
Datum tidout(PG_FUNCTION_ARGS)
Definition: tid.c:119
void tuplestore_puttuple(Tuplestorestate *state, HeapTuple tuple)
Definition: tuplestore.c:764
List * textToQualifiedNameList(text *textval)
Definition: varlena.c:3467
CommandId GetCurrentCommandId(bool used)
Definition: xact.c:829

References AccessShareLock, ACL_SELECT, aclcheck_error(), ACLCHECK_NO_PRIV, ACLCHECK_OK, Atnum_ismulti, Atnum_modes, Atnum_pids, Atnum_tid, Atnum_xids, Atnum_xmax, BackendXidGetPid(), buf, BUFFER_LOCK_SHARE, BUFFER_LOCK_UNLOCK, BuildTupleFromCStrings(), DirectFunctionCall1, ereport, errcode(), errdetail(), errmsg(), ERROR, ForwardScanDirection, get_relkind_objtype(), GetActiveSnapshot(), GetCurrentCommandId(), GetMultiXactIdMembers(), GetUserId(), has_privs_of_role(), heap_getnext(), HEAP_KEYS_UPDATED, HEAP_LOCKED_UPGRADED(), HEAP_XMAX_IS_EXCL_LOCKED(), HEAP_XMAX_IS_KEYSHR_LOCKED(), HEAP_XMAX_IS_MULTI, HEAP_XMAX_IS_SHR_LOCKED(), HEAP_XMAX_LOCK_ONLY, HeapTupleHeaderGetRawXmax(), HeapTupleSatisfiesUpdate(), InitMaterializedSRF(), j, LockBuffer(), makeRangeVarFromNameList(), MultiXactStatusForKeyShare, MultiXactStatusForNoKeyUpdate, MultiXactStatusForShare, MultiXactStatusForUpdate, MultiXactStatusNoKeyUpdate, MultiXactStatusUpdate, TupleDescData::natts, NCHARS, palloc(), pg_class_aclcheck(), PG_GETARG_TEXT_PP, PointerGetDatum(), pstrdup(), relation_openrv(), RelationGetRelationName, RelationGetRelid, relname, ReturnSetInfo::setDesc, ReturnSetInfo::setResult, snprintf, table_beginscan(), table_close(), table_endscan(), textToQualifiedNameList(), tidout(), TM_BeingModified, TupleDescGetAttInMetadata(), tuplestore_puttuple(), and values.