proc.c 51.8 KB
Newer Older
1 2
/*-------------------------------------------------------------------------
 *
3
 * proc.c
4
 *	  routines to manage per-process shared memory data structure
5
 *
B
Bruce Momjian 已提交
6
 * Portions Copyright (c) 1996-2011, PostgreSQL Global Development Group
B
Add:  
Bruce Momjian 已提交
7
 * Portions Copyright (c) 1994, Regents of the University of California
8 9 10
 *
 *
 * IDENTIFICATION
11
 *	  src/backend/storage/lmgr/proc.c
12 13 14 15 16
 *
 *-------------------------------------------------------------------------
 */
/*
 * Interface (a):
17
 *		ProcSleep(), ProcWakeup(),
18 19
 *		ProcQueueAlloc() -- create a shm queue for sleeping processes
 *		ProcQueueInit() -- create a queue without allocing memory
20
 *
21 22
 * Waiting for a lock causes the backend to be put to sleep.  Whoever releases
 * the lock wakes the process up again (and gives it an error code so it knows
23 24 25 26
 * whether it was awoken on an error condition).
 *
 * Interface (b):
 *
27 28
 * ProcReleaseLocks -- frees the locks associated with current transaction
 *
29
 * ProcKill -- destroys the shared memory state (and locks)
30
 * associated with the process.
31
 */
32 33
#include "postgres.h"

34
#include <signal.h>
35 36
#include <unistd.h>
#include <sys/time.h>
M
Marc G. Fournier 已提交
37

38
#include "access/transam.h"
39
#include "access/xact.h"
40
#include "miscadmin.h"
41
#include "postmaster/autovacuum.h"
42
#include "replication/syncrep.h"
43
#include "storage/ipc.h"
44
#include "storage/lmgr.h"
45
#include "storage/pmsignal.h"
46
#include "storage/proc.h"
47
#include "storage/procarray.h"
48
#include "storage/procsignal.h"
49
#include "storage/spin.h"
50

51

52
/* GUC variables */
B
Bruce Momjian 已提交
53
int			DeadlockTimeout = 1000;
54
int			StatementTimeout = 0;
55
bool		log_lock_waits = false;
M
 
Marc G. Fournier 已提交
56

57
/* Pointer to this process's PGPROC struct, if any */
J
Jan Wieck 已提交
58
PGPROC	   *MyProc = NULL;
59 60

/*
J
Jan Wieck 已提交
61
 * This spinlock protects the freelist of recycled PGPROC structures.
62
 * We cannot use an LWLock because the LWLock manager depends on already
J
Jan Wieck 已提交
63
 * having a PGPROC and a wait semaphore!  But these structures are touched
64 65
 * relatively infrequently (only at backend startup or shutdown) and not for
 * very long, so a spinlock is okay.
66
 */
67
NON_EXEC_STATIC slock_t *ProcStructLock = NULL;
68

69
/* Pointers to shared-memory structures */
70
PROC_HDR *ProcGlobal = NULL;
71
NON_EXEC_STATIC PGPROC *AuxiliaryProcs = NULL;
72

73 74
/* If we are waiting for a lock, this points to the associated LOCALLOCK */
static LOCALLOCK *lockAwaited = NULL;
75

76
/* Mark these volatile because they can be changed by signal handler */
77
static volatile bool standby_timeout_active = false;
78 79
static volatile bool statement_timeout_active = false;
static volatile bool deadlock_timeout_active = false;
80
static volatile DeadLockState deadlock_state = DS_NOT_YET_CHECKED;
81
volatile bool cancel_from_timeout = false;
B
Bruce Momjian 已提交
82

83 84 85
/* timeout_start_time is set when log_lock_waits is true */
static TimestampTz timeout_start_time;

86
/* statement_fin_time is valid only if statement_timeout_active is true */
87
static TimestampTz statement_fin_time;
88
static TimestampTz statement_fin_time2; /* valid only in recovery */
89 90


91
static void RemoveProcFromArray(int code, Datum arg);
92
static void ProcKill(int code, Datum arg);
93
static void AuxiliaryProcKill(int code, Datum arg);
94
static bool CheckStatementTimeout(void);
95
static bool CheckStandbyTimeout(void);
96

V
Vadim B. Mikheev 已提交
97

98 99 100
/*
 * Report shared-memory space needed by InitProcGlobal.
 */
101
Size
102
ProcGlobalShmemSize(void)
103
{
104 105 106 107
	Size		size = 0;

	/* ProcGlobal */
	size = add_size(size, sizeof(PROC_HDR));
108 109
	/* AuxiliaryProcs */
	size = add_size(size, mul_size(NUM_AUXILIARY_PROCS, sizeof(PGPROC)));
110
	/* MyProcs, including autovacuum workers and launcher */
111 112 113
	size = add_size(size, mul_size(MaxBackends, sizeof(PGPROC)));
	/* ProcStructLock */
	size = add_size(size, sizeof(slock_t));
114 115 116 117

	return size;
}

118 119 120 121
/*
 * Report number of semaphores needed by InitProcGlobal.
 */
int
122
ProcGlobalSemas(void)
123
{
124 125 126 127
	/*
	 * We need a sema per backend (including autovacuum), plus one for each
	 * auxiliary process.
	 */
128
	return MaxBackends + NUM_AUXILIARY_PROCS;
129 130
}

131 132
/*
 * InitProcGlobal -
133 134
 *	  Initialize the global process table during postmaster or standalone
 *	  backend startup.
135
 *
136
 *	  We also create all the per-process semaphores we will need to support
137 138 139 140 141 142 143
 *	  the requested number of backends.  We used to allocate semaphores
 *	  only when backends were actually started up, but that is bad because
 *	  it lets Postgres fail under load --- a lot of Unix systems are
 *	  (mis)configured with small limits on the number of semaphores, and
 *	  running out when trying to start another backend is a common failure.
 *	  So, now we grab enough semaphores to support the desired max number
 *	  of backends immediately at initialization --- if the sysadmin has set
144 145
 *	  MaxConnections or autovacuum_max_workers higher than his kernel will
 *	  support, he'll find out sooner rather than later.
146 147 148 149
 *
 *	  Another reason for creating semaphores here is that the semaphore
 *	  implementation typically requires us to create semaphores in the
 *	  postmaster, not in backends.
150 151
 *
 * Note: this is NOT called by individual backends under a postmaster,
152
 * not even in the EXEC_BACKEND case.  The ProcGlobal and AuxiliaryProcs
153
 * pointers must be propagated specially for EXEC_BACKEND operation.
154 155
 */
void
156
InitProcGlobal(void)
157
{
158 159 160
	PGPROC	   *procs;
	int			i;
	bool		found;
R
Robert Haas 已提交
161
	uint32		TotalProcs = MaxBackends + NUM_AUXILIARY_PROCS;
162

163
	/* Create the ProcGlobal shared structure */
164
	ProcGlobal = (PROC_HDR *)
165 166
		ShmemInitStruct("Proc Header", sizeof(PROC_HDR), &found);
	Assert(!found);
167

168 169 170
	/*
	 * Initialize the data structures.
	 */
R
Robert Haas 已提交
171
	ProcGlobal->spins_per_delay = DEFAULT_SPINS_PER_DELAY;
172 173
	ProcGlobal->freeProcs = NULL;
	ProcGlobal->autovacFreeProcs = NULL;
174 175 176
	ProcGlobal->startupProc = NULL;
	ProcGlobal->startupProcPid = 0;
	ProcGlobal->startupBufferPinWaitBufId = -1;
177

178
	/*
R
Robert Haas 已提交
179 180 181
	 * Create and initialize all the PGPROC structures we'll need (except for
	 * those used for 2PC, which are embedded within a GlobalTransactionData
	 * struct).
182
	 *
R
Robert Haas 已提交
183 184 185 186
	 * There are three separate consumers of PGPROC structures: (1) normal
	 * backends, (2) autovacuum workers and the autovacuum launcher, and (3)
	 * auxiliary processes.  Each PGPROC structure is dedicated to exactly
	 * one of these purposes, and they do not move between groups.
187
	 */
R
Robert Haas 已提交
188
	procs = (PGPROC *) ShmemAlloc(TotalProcs * sizeof(PGPROC));
189 190
	ProcGlobal->allProcs = procs;
	ProcGlobal->allProcCount = TotalProcs;
191 192 193 194
	if (!procs)
		ereport(FATAL,
				(errcode(ERRCODE_OUT_OF_MEMORY),
				 errmsg("out of shared memory")));
R
Robert Haas 已提交
195 196
	MemSet(procs, 0, TotalProcs * sizeof(PGPROC));
	for (i = 0; i < TotalProcs; i++)
197
	{
R
Robert Haas 已提交
198
		/* Common initialization for all PGPROCs, regardless of type. */
199
		PGSemaphoreCreate(&(procs[i].sem));
200
		procs[i].backendLock = LWLockAssign();
201
		InitSharedLatch(&procs[i].waitLatch);
R
Robert Haas 已提交
202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221

		/*
		 * Newly created PGPROCs for normal backends or for autovacuum must
		 * be queued up on the appropriate free list.  Because there can only
		 * ever be a small, fixed number of auxiliary processes, no free
		 * list is used in that case; InitAuxiliaryProcess() instead uses a
		 * linear search.
		 */
		if (i < MaxConnections)
		{
			/* PGPROC for normal backend, add to freeProcs list */
			procs[i].links.next = (SHM_QUEUE *) ProcGlobal->freeProcs;
			ProcGlobal->freeProcs = &procs[i];
		}
		else if (i < MaxBackends)
		{
			/* PGPROC for AV launcher/worker, add to autovacFreeProcs list */
			procs[i].links.next = (SHM_QUEUE *) ProcGlobal->autovacFreeProcs;
			ProcGlobal->autovacFreeProcs = &procs[i];
		}
222 223
	}

224
	/*
R
Robert Haas 已提交
225 226
	 * Save a pointer to the block of PGPROC structures reserved for
	 * auxiliary proceses.
227
	 */
R
Robert Haas 已提交
228
	AuxiliaryProcs = &procs[MaxBackends];
229 230 231 232

	/* Create ProcStructLock spinlock, too */
	ProcStructLock = (slock_t *) ShmemAlloc(sizeof(slock_t));
	SpinLockInit(ProcStructLock);
233 234
}

235
/*
236
 * InitProcess -- initialize a per-process data structure for this backend
237 238
 */
void
239
InitProcess(void)
240
{
241 242
	/* use volatile pointer to prevent code rearrangement */
	volatile PROC_HDR *procglobal = ProcGlobal;
243
	int			i;
244 245

	/*
246 247
	 * ProcGlobal should be set up already (if we are a backend, we inherit
	 * this by fork() or EXEC_BACKEND mechanism from the postmaster).
248
	 */
249
	if (procglobal == NULL)
250
		elog(PANIC, "proc header uninitialized");
251 252

	if (MyProc != NULL)
253
		elog(ERROR, "you already exist");
254

255
	/*
B
Bruce Momjian 已提交
256 257
	 * Try to get a proc struct from the free list.  If this fails, we must be
	 * out of PGPROC structures (not to mention semaphores).
258
	 *
B
Bruce Momjian 已提交
259 260
	 * While we are holding the ProcStructLock, also copy the current shared
	 * estimate of spins_per_delay to local storage.
261
	 */
262
	SpinLockAcquire(ProcStructLock);
263

264 265
	set_spins_per_delay(procglobal->spins_per_delay);

266
	if (IsAnyAutoVacuumProcess())
267
		MyProc = procglobal->autovacFreeProcs;
268
	else
269
		MyProc = procglobal->freeProcs;
270

271
	if (MyProc != NULL)
272
	{
273
		if (IsAnyAutoVacuumProcess())
274
			procglobal->autovacFreeProcs = (PGPROC *) MyProc->links.next;
275
		else
276
			procglobal->freeProcs = (PGPROC *) MyProc->links.next;
277
		SpinLockRelease(ProcStructLock);
278 279 280 281
	}
	else
	{
		/*
B
Bruce Momjian 已提交
282 283
		 * If we reach here, all the PGPROCs are in use.  This is one of the
		 * possible places to detect "too many backends", so give the standard
284 285
		 * error message.  XXX do we need to give a different failure message
		 * in the autovacuum case?
286
		 */
287
		SpinLockRelease(ProcStructLock);
288 289 290
		ereport(FATAL,
				(errcode(ERRCODE_TOO_MANY_CONNECTIONS),
				 errmsg("sorry, too many clients already")));
291
	}
292

293 294
	/*
	 * Now that we have a PGPROC, mark ourselves as an active postmaster
295
	 * child; this is so that the postmaster can detect it if we exit without
296 297
	 * cleaning up.  (XXX autovac launcher currently doesn't participate in
	 * this; it probably should.)
298
	 */
299
	if (IsUnderPostmaster && !IsAutoVacuumLauncherProcess())
300
		MarkPostmasterChildActive();
301

302
	/*
B
Bruce Momjian 已提交
303 304
	 * Initialize all fields of MyProc, except for the semaphore which was
	 * prepared for us by InitProcGlobal.
305
	 */
306
	SHMQueueElemInit(&(MyProc->links));
307
	MyProc->waitStatus = STATUS_OK;
308
	MyProc->lxid = InvalidLocalTransactionId;
309
	MyProc->xid = InvalidTransactionId;
310
	MyProc->xmin = InvalidTransactionId;
311
	MyProc->pid = MyProcPid;
312 313
	/* backendId, databaseId and roleId will be filled in later */
	MyProc->backendId = InvalidBackendId;
314
	MyProc->databaseId = InvalidOid;
315
	MyProc->roleId = InvalidOid;
316
	MyProc->inCommit = false;
317
	MyProc->vacuumFlags = 0;
318
	/* NB -- autovac launcher intentionally does not set IS_AUTOVACUUM */
319 320
	if (IsAutoVacuumWorkerProcess())
		MyProc->vacuumFlags |= PROC_IS_AUTOVACUUM;
321 322 323
	MyProc->lwWaiting = false;
	MyProc->lwExclusive = false;
	MyProc->lwWaitLink = NULL;
324
	MyProc->waitLock = NULL;
325
	MyProc->waitProcLock = NULL;
326 327
	for (i = 0; i < NUM_LOCK_PARTITIONS; i++)
		SHMQueueInit(&(MyProc->myProcLocks[i]));
328
	MyProc->recoveryConflictPending = false;
329

330 331 332 333 334
	/* Initialise for sync rep */
	MyProc->waitLSN.xlogid = 0;
	MyProc->waitLSN.xrecoff = 0;
	MyProc->syncRepState = SYNC_REP_NOT_WAITING;
	SHMQueueElemInit(&(MyProc->syncRepLinks));
335
	OwnLatch(&MyProc->waitLatch);
336

337
	/*
338
	 * We might be reusing a semaphore that belonged to a failed process. So
B
Bruce Momjian 已提交
339
	 * be careful and reinitialize its value here.	(This is not strictly
340
	 * necessary anymore, but seems like a good idea for cleanliness.)
341
	 */
342
	PGSemaphoreReset(&MyProc->sem);
343

344
	/*
345
	 * Arrange to clean up at backend exit.
346
	 */
347
	on_shmem_exit(ProcKill, 0);
348 349

	/*
B
Bruce Momjian 已提交
350 351
	 * Now that we have a PGPROC, we could try to acquire locks, so initialize
	 * the deadlock checker.
352 353
	 */
	InitDeadLockChecking();
354 355
}

356 357 358 359
/*
 * InitProcessPhase2 -- make MyProc visible in the shared ProcArray.
 *
 * This is separate from InitProcess because we can't acquire LWLocks until
360 361
 * we've created a PGPROC, but in the EXEC_BACKEND case ProcArrayAdd won't
 * work until after we've done CreateSharedMemoryAndSemaphores.
362 363 364 365 366 367 368 369 370 371 372 373 374 375
 */
void
InitProcessPhase2(void)
{
	Assert(MyProc != NULL);

	/*
	 * Add our PGPROC to the PGPROC array in shared memory.
	 */
	ProcArrayAdd(MyProc);

	/*
	 * Arrange to clean that up at backend exit.
	 */
376
	on_shmem_exit(SyncRepCleanupAtProcExit, 0);
377 378 379
	on_shmem_exit(RemoveProcFromArray, 0);
}

380
/*
381
 * InitAuxiliaryProcess -- create a per-auxiliary-process data structure
382
 *
383 384
 * This is called by bgwriter and similar processes so that they will have a
 * MyProc value that's real enough to let them wait for LWLocks.  The PGPROC
385
 * and sema that are assigned are one of the extra ones created during
386
 * InitProcGlobal.
387
 *
388
 * Auxiliary processes are presently not expected to wait for real (lockmgr)
389
 * locks, so we need not set up the deadlock checker.  They are never added
B
Bruce Momjian 已提交
390
 * to the ProcArray or the sinval messaging mechanism, either.	They also
391 392
 * don't get a VXID assigned, since this is only useful when we actually
 * hold lockmgr locks.
393 394 395 396 397
 *
 * Startup process however uses locks but never waits for them in the
 * normal backend sense. Startup process also takes part in sinval messaging
 * as a sendOnly process, so never reads messages from sinval queue. So
 * Startup process does have a VXID and does show up in pg_locks.
398 399
 */
void
400
InitAuxiliaryProcess(void)
401
{
402
	PGPROC	   *auxproc;
403
	int			proctype;
404
	int			i;
J
Jan Wieck 已提交
405

406
	/*
407 408
	 * ProcGlobal should be set up already (if we are a backend, we inherit
	 * this by fork() or EXEC_BACKEND mechanism from the postmaster).
409
	 */
410
	if (ProcGlobal == NULL || AuxiliaryProcs == NULL)
411
		elog(PANIC, "proc header uninitialized");
412 413

	if (MyProc != NULL)
414
		elog(ERROR, "you already exist");
415

416
	/*
417
	 * We use the ProcStructLock to protect assignment and releasing of
418
	 * AuxiliaryProcs entries.
419
	 *
B
Bruce Momjian 已提交
420 421
	 * While we are holding the ProcStructLock, also copy the current shared
	 * estimate of spins_per_delay to local storage.
422 423 424 425 426
	 */
	SpinLockAcquire(ProcStructLock);

	set_spins_per_delay(ProcGlobal->spins_per_delay);

427
	/*
428
	 * Find a free auxproc ... *big* trouble if there isn't one ...
429
	 */
430
	for (proctype = 0; proctype < NUM_AUXILIARY_PROCS; proctype++)
431
	{
432 433
		auxproc = &AuxiliaryProcs[proctype];
		if (auxproc->pid == 0)
434 435
			break;
	}
436
	if (proctype >= NUM_AUXILIARY_PROCS)
437 438
	{
		SpinLockRelease(ProcStructLock);
439
		elog(FATAL, "all AuxiliaryProcs are in use");
440
	}
441

442
	/* Mark auxiliary proc as in use by me */
443
	/* use volatile pointer to prevent code rearrangement */
444
	((volatile PGPROC *) auxproc)->pid = MyProcPid;
445

446
	MyProc = auxproc;
447 448 449

	SpinLockRelease(ProcStructLock);

450
	/*
451 452
	 * Initialize all fields of MyProc, except for the semaphore which was
	 * prepared for us by InitProcGlobal.
453 454
	 */
	SHMQueueElemInit(&(MyProc->links));
455
	MyProc->waitStatus = STATUS_OK;
456
	MyProc->lxid = InvalidLocalTransactionId;
457 458
	MyProc->xid = InvalidTransactionId;
	MyProc->xmin = InvalidTransactionId;
459
	MyProc->backendId = InvalidBackendId;
460
	MyProc->databaseId = InvalidOid;
461
	MyProc->roleId = InvalidOid;
462
	MyProc->inCommit = false;
463
	MyProc->vacuumFlags = 0;
464 465 466 467
	MyProc->lwWaiting = false;
	MyProc->lwExclusive = false;
	MyProc->lwWaitLink = NULL;
	MyProc->waitLock = NULL;
468
	MyProc->waitProcLock = NULL;
469 470
	for (i = 0; i < NUM_LOCK_PARTITIONS; i++)
		SHMQueueInit(&(MyProc->myProcLocks[i]));
471 472

	/*
B
Bruce Momjian 已提交
473
	 * We might be reusing a semaphore that belonged to a failed process. So
B
Bruce Momjian 已提交
474
	 * be careful and reinitialize its value here.	(This is not strictly
475
	 * necessary anymore, but seems like a good idea for cleanliness.)
476
	 */
477
	PGSemaphoreReset(&MyProc->sem);
478 479 480 481

	/*
	 * Arrange to clean up at process exit.
	 */
482
	on_shmem_exit(AuxiliaryProcKill, Int32GetDatum(proctype));
483 484
}

485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502
/*
 * Record the PID and PGPROC structures for the Startup process, for use in
 * ProcSendSignal().  See comments there for further explanation.
 */
void
PublishStartupProcessInformation(void)
{
	/* use volatile pointer to prevent code rearrangement */
	volatile PROC_HDR *procglobal = ProcGlobal;

	SpinLockAcquire(ProcStructLock);

	procglobal->startupProc = MyProc;
	procglobal->startupProcPid = MyProcPid;

	SpinLockRelease(ProcStructLock);
}

503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527
/*
 * Used from bufgr to share the value of the buffer that Startup waits on,
 * or to reset the value to "not waiting" (-1). This allows processing
 * of recovery conflicts for buffer pins. Set is made before backends look
 * at this value, so locking not required, especially since the set is
 * an atomic integer set operation.
 */
void
SetStartupBufferPinWaitBufId(int bufid)
{
	/* use volatile pointer to prevent code rearrangement */
	volatile PROC_HDR *procglobal = ProcGlobal;

	procglobal->startupBufferPinWaitBufId = bufid;
}

/*
 * Used by backends when they receive a request to check for buffer pin waits.
 */
int
GetStartupBufferPinWaitBufId(void)
{
	/* use volatile pointer to prevent code rearrangement */
	volatile PROC_HDR *procglobal = ProcGlobal;

528
	return procglobal->startupBufferPinWaitBufId;
529 530
}

531 532 533 534 535 536 537 538 539
/*
 * Check whether there are at least N free PGPROC objects.
 *
 * Note: this is designed on the assumption that N will generally be small.
 */
bool
HaveNFreeProcs(int n)
{
	PGPROC	   *proc;
B
Bruce Momjian 已提交
540

541 542 543 544 545
	/* use volatile pointer to prevent code rearrangement */
	volatile PROC_HDR *procglobal = ProcGlobal;

	SpinLockAcquire(ProcStructLock);

546
	proc = procglobal->freeProcs;
547

548
	while (n > 0 && proc != NULL)
549
	{
550
		proc = (PGPROC *) proc->links.next;
551 552 553 554 555 556 557 558
		n--;
	}

	SpinLockRelease(ProcStructLock);

	return (n <= 0);
}

559 560 561 562 563 564 565 566 567
bool
IsWaitingForLock(void)
{
	if (lockAwaited == NULL)
		return false;

	return true;
}

568 569 570 571
/*
 * Cancel any pending wait for lock, when aborting a transaction.
 *
 * (Normally, this would only happen if we accept a cancel/die
572
 * interrupt while waiting; but an ereport(ERROR) while waiting is
573 574
 * within the realm of possibility, too.)
 */
575
void
576 577
LockWaitCancel(void)
{
578 579
	LWLockId	partitionLock;

580
	/* Nothing to do if we weren't waiting for a lock */
581
	if (lockAwaited == NULL)
582
		return;
583

584
	/* Turn off the deadlock timer, if it's still running (see ProcSleep) */
585
	disable_sig_alarm(false);
586 587

	/* Unlink myself from the wait queue, if on it (might not be anymore!) */
588
	partitionLock = LockHashPartitionLock(lockAwaited->hashcode);
589
	LWLockAcquire(partitionLock, LW_EXCLUSIVE);
590

591
	if (MyProc->links.next != NULL)
592 593
	{
		/* We could not have been granted the lock yet */
594
		RemoveFromWaitQueue(MyProc, lockAwaited->hashcode);
595 596 597 598 599
	}
	else
	{
		/*
		 * Somebody kicked us off the lock queue already.  Perhaps they
B
Bruce Momjian 已提交
600 601 602
		 * granted us the lock, or perhaps they detected a deadlock. If they
		 * did grant us the lock, we'd better remember it in our local lock
		 * table.
603
		 */
604 605
		if (MyProc->waitStatus == STATUS_OK)
			GrantAwaitedLock();
606 607
	}

608
	lockAwaited = NULL;
609

610
	LWLockRelease(partitionLock);
H
Hiroshi Inoue 已提交
611

612
	/*
613
	 * We used to do PGSemaphoreReset() here to ensure that our proc's wait
B
Bruce Momjian 已提交
614 615 616 617 618 619
	 * semaphore is reset to zero.	This prevented a leftover wakeup signal
	 * from remaining in the semaphore if someone else had granted us the lock
	 * we wanted before we were able to remove ourselves from the wait-list.
	 * However, now that ProcSleep loops until waitStatus changes, a leftover
	 * wakeup signal isn't harmful, and it seems not worth expending cycles to
	 * get rid of a signal that most likely isn't there.
620
	 */
H
Hiroshi Inoue 已提交
621
}
622

623

624
/*
625
 * ProcReleaseLocks() -- release locks associated with current transaction
626
 *			at main transaction commit or abort
627 628
 *
 * At main transaction commit, we release all locks except session locks.
629
 * At main transaction abort, we release all locks including session locks.
630 631
 *
 * At subtransaction commit, we don't release any locks (so this func is not
632
 * needed at all); we will defer the releasing to the parent transaction.
633
 * At subtransaction abort, we release all locks held by the subtransaction;
634 635
 * this is implemented by retail releasing of the locks under control of
 * the ResourceOwner mechanism.
636 637
 */
void
638
ProcReleaseLocks(bool isCommit)
639
{
640 641
	if (!MyProc)
		return;
642 643 644
	/* If waiting, get off wait queue (should only be needed after error) */
	LockWaitCancel();
	/* Release locks */
645
	LockReleaseAll(DEFAULT_LOCKMETHOD, !isCommit);
646 647 648

	/* Release transaction level advisory locks */
	LockReleaseAll(USER_LOCKMETHOD, false);
649 650 651
}


652 653 654 655 656 657 658
/*
 * RemoveProcFromArray() -- Remove this process from the shared ProcArray.
 */
static void
RemoveProcFromArray(int code, Datum arg)
{
	Assert(MyProc != NULL);
659
	ProcArrayRemove(MyProc, InvalidTransactionId);
660 661
}

662 663
/*
 * ProcKill() -- Destroy the per-proc data structure for
664
 *		this process. Release any of its held LW locks.
665 666
 */
static void
667
ProcKill(int code, Datum arg)
668
{
669 670 671
	/* use volatile pointer to prevent code rearrangement */
	volatile PROC_HDR *procglobal = ProcGlobal;

672
	Assert(MyProc != NULL);
673

674
	/*
B
Bruce Momjian 已提交
675 676
	 * Release any LW locks I am holding.  There really shouldn't be any, but
	 * it's cheap to check again before we cut the knees off the LWLock
677
	 * facility by releasing our PGPROC ...
678
	 */
679
	LWLockReleaseAll();
680

681
	SpinLockAcquire(ProcStructLock);
682

683 684
	/* Return PGPROC structure (and semaphore) to appropriate freelist */
	if (IsAnyAutoVacuumProcess())
685
	{
686 687
		MyProc->links.next = (SHM_QUEUE *) procglobal->autovacFreeProcs;
		procglobal->autovacFreeProcs = MyProc;
688 689 690
	}
	else
	{
691 692
		MyProc->links.next = (SHM_QUEUE *) procglobal->freeProcs;
		procglobal->freeProcs = MyProc;
693
	}
694

J
Jan Wieck 已提交
695
	/* PGPROC struct isn't mine anymore */
696
	MyProc = NULL;
697

698 699 700
	/* Update shared estimate of spins_per_delay */
	procglobal->spins_per_delay = update_spins_per_delay(procglobal->spins_per_delay);

701
	SpinLockRelease(ProcStructLock);
702

703 704
	/*
	 * This process is no longer present in shared memory in any meaningful
B
Bruce Momjian 已提交
705 706
	 * way, so tell the postmaster we've cleaned up acceptably well. (XXX
	 * autovac launcher should be included here someday)
707
	 */
708
	if (IsUnderPostmaster && !IsAutoVacuumLauncherProcess())
709 710
		MarkPostmasterChildInactive();

711 712
	/* wake autovac launcher if needed -- see comments in FreeWorkerInfo */
	if (AutovacuumLauncherPid != 0)
713
		kill(AutovacuumLauncherPid, SIGUSR2);
714 715 716
}

/*
717 718 719
 * AuxiliaryProcKill() -- Cut-down version of ProcKill for auxiliary
 *		processes (bgwriter, etc).	The PGPROC and sema are not released, only
 *		marked as not-in-use.
720 721
 */
static void
722
AuxiliaryProcKill(int code, Datum arg)
723
{
B
Bruce Momjian 已提交
724
	int			proctype = DatumGetInt32(arg);
725
	PGPROC	   *auxproc;
J
Jan Wieck 已提交
726

727
	Assert(proctype >= 0 && proctype < NUM_AUXILIARY_PROCS);
J
Jan Wieck 已提交
728

729
	auxproc = &AuxiliaryProcs[proctype];
J
Jan Wieck 已提交
730

731
	Assert(MyProc == auxproc);
732

733
	/* Release any LW locks I am holding (see notes above) */
734 735
	LWLockReleaseAll();

736 737
	SpinLockAcquire(ProcStructLock);

738
	/* Mark auxiliary proc no longer in use */
739 740
	MyProc->pid = 0;

J
Jan Wieck 已提交
741
	/* PGPROC struct isn't mine anymore */
742
	MyProc = NULL;
743 744 745 746 747

	/* Update shared estimate of spins_per_delay */
	ProcGlobal->spins_per_delay = update_spins_per_delay(ProcGlobal->spins_per_delay);

	SpinLockRelease(ProcStructLock);
748 749
}

750

751 752
/*
 * ProcQueue package: routines for putting processes to sleep
753
 *		and  waking them up
754 755 756 757 758
 */

/*
 * ProcQueueAlloc -- alloc/attach to a shared memory process queue
 *
759 760
 * Returns: a pointer to the queue
 * Side Effects: Initializes the queue if it wasn't there before
761
 */
762
#ifdef NOT_USED
763
PROC_QUEUE *
764
ProcQueueAlloc(const char *name)
765
{
766
	PROC_QUEUE *queue;
767
	bool		found;
768

769 770 771
	queue = (PROC_QUEUE *)
		ShmemInitStruct(name, sizeof(PROC_QUEUE), &found);

772 773
	if (!found)
		ProcQueueInit(queue);
774

775
	return queue;
776
}
777
#endif
778 779 780 781 782

/*
 * ProcQueueInit -- initialize a shared memory process queue
 */
void
783
ProcQueueInit(PROC_QUEUE *queue)
784
{
785 786
	SHMQueueInit(&(queue->links));
	queue->size = 0;
787 788 789 790
}


/*
791
 * ProcSleep -- put a process to sleep on the specified lock
792
 *
793 794
 * Caller must have set MyProc->heldLocks to reflect locks already held
 * on the lockable object by this process (under all XIDs).
795
 *
796
 * The lock table's partition lock must be held at entry, and will be held
797
 * at exit.
798
 *
799
 * Result: STATUS_OK if we acquired the lock, STATUS_ERROR if not (deadlock).
800
 *
801
 * ASSUME: that no one will fiddle with the queue until after
802
 *		we release the partition lock.
803 804
 *
 * NOTES: The process queue is now a priority queue for locking.
805 806 807
 *
 * P() on the semaphore should put us to sleep.  The process
 * semaphore is normally zero, so when we try to acquire it, we sleep.
808 809
 */
int
810
ProcSleep(LOCALLOCK *locallock, LockMethod lockMethodTable)
811
{
812 813 814
	LOCKMODE	lockmode = locallock->tag.mode;
	LOCK	   *lock = locallock->lock;
	PROCLOCK   *proclock = locallock->proclock;
815 816
	uint32		hashcode = locallock->hashcode;
	LWLockId	partitionLock = LockHashPartitionLock(hashcode);
817
	PROC_QUEUE *waitQueue = &(lock->waitProcs);
818
	LOCKMASK	myHeldLocks = MyProc->heldLocks;
819
	bool		early_deadlock = false;
B
Bruce Momjian 已提交
820
	bool		allow_autovacuum_cancel = true;
821
	int			myWaitStatus;
J
Jan Wieck 已提交
822
	PGPROC	   *proc;
823
	int			i;
824

825
	/*
826 827
	 * Determine where to add myself in the wait queue.
	 *
828 829 830 831
	 * Normally I should go at the end of the queue.  However, if I already
	 * hold locks that conflict with the request of any previous waiter, put
	 * myself in the queue just in front of the first such waiter. This is not
	 * a necessary step, since deadlock detection would move me to before that
B
Bruce Momjian 已提交
832 833
	 * waiter anyway; but it's relatively cheap to detect such a conflict
	 * immediately, and avoid delaying till deadlock timeout.
834
	 *
835 836
	 * Special case: if I find I should go in front of some waiter, check to
	 * see if I conflict with already-held locks or the requests before that
B
Bruce Momjian 已提交
837 838 839 840
	 * waiter.	If not, then just grant myself the requested lock immediately.
	 * This is the same as the test for immediate grant in LockAcquire, except
	 * we are only considering the part of the wait queue before my insertion
	 * point.
841 842
	 */
	if (myHeldLocks != 0)
V
Vadim B. Mikheev 已提交
843
	{
844
		LOCKMASK	aheadRequests = 0;
845

846
		proc = (PGPROC *) waitQueue->links.next;
847
		for (i = 0; i < waitQueue->size; i++)
V
Vadim B. Mikheev 已提交
848
		{
849
			/* Must he wait for me? */
B
Bruce Momjian 已提交
850
			if (lockMethodTable->conflictTab[proc->waitLockMode] & myHeldLocks)
V
Vadim B. Mikheev 已提交
851
			{
852
				/* Must I wait for him ? */
B
Bruce Momjian 已提交
853
				if (lockMethodTable->conflictTab[lockmode] & proc->heldLocks)
854
				{
855
					/*
B
Bruce Momjian 已提交
856 857 858 859 860
					 * Yes, so we have a deadlock.	Easiest way to clean up
					 * correctly is to call RemoveFromWaitQueue(), but we
					 * can't do that until we are *on* the wait queue. So, set
					 * a flag to check below, and break out of loop.  Also,
					 * record deadlock info for later message.
861
					 */
862
					RememberSimpleDeadLock(MyProc, lockmode, lock, proc);
863 864
					early_deadlock = true;
					break;
865
				}
866
				/* I must go before this waiter.  Check special case. */
B
Bruce Momjian 已提交
867
				if ((lockMethodTable->conflictTab[lockmode] & aheadRequests) == 0 &&
868 869 870
					LockCheckConflicts(lockMethodTable,
									   lockmode,
									   lock,
871
									   proclock,
872
									   MyProc) == STATUS_OK)
873
				{
874
					/* Skip the wait and just grant myself the lock. */
875
					GrantLock(lock, proclock, lockmode);
876
					GrantAwaitedLock();
877
					return STATUS_OK;
878 879
				}
				/* Break out of loop to put myself before him */
V
Vadim B. Mikheev 已提交
880
				break;
881
			}
882
			/* Nope, so advance to next waiter */
883
			aheadRequests |= LOCKBIT_ON(proc->waitLockMode);
884
			proc = (PGPROC *) proc->links.next;
V
Vadim B. Mikheev 已提交
885
		}
B
Bruce Momjian 已提交
886

887
		/*
B
Bruce Momjian 已提交
888 889
		 * If we fall out of loop normally, proc points to waitQueue head, so
		 * we will insert at tail of queue as desired.
890
		 */
891 892 893 894
	}
	else
	{
		/* I hold no locks, so I can't push in front of anyone. */
J
Jan Wieck 已提交
895
		proc = (PGPROC *) &(waitQueue->links);
V
Vadim B. Mikheev 已提交
896
	}
897

898
	/*
B
Bruce Momjian 已提交
899
	 * Insert self into queue, ahead of the given proc (or at tail of queue).
900
	 */
901
	SHMQueueInsertBefore(&(proc->links), &(MyProc->links));
B
Bruce Momjian 已提交
902
	waitQueue->size++;
903

904
	lock->waitMask |= LOCKBIT_ON(lockmode);
905

J
Jan Wieck 已提交
906
	/* Set up wait information in PGPROC object, too */
907
	MyProc->waitLock = lock;
908
	MyProc->waitProcLock = proclock;
909 910
	MyProc->waitLockMode = lockmode;

911
	MyProc->waitStatus = STATUS_WAITING;
912 913

	/*
B
Bruce Momjian 已提交
914 915 916
	 * If we detected deadlock, give up without waiting.  This must agree with
	 * CheckDeadLock's recovery code, except that we shouldn't release the
	 * semaphore since we haven't tried to lock it yet.
917 918 919
	 */
	if (early_deadlock)
	{
920
		RemoveFromWaitQueue(MyProc, hashcode);
921 922
		return STATUS_ERROR;
	}
923

924
	/* mark that we are waiting for a lock */
925
	lockAwaited = locallock;
926

927
	/*
928
	 * Release the lock table's partition lock.
929
	 *
930
	 * NOTE: this may also cause us to exit critical-section state, possibly
B
Bruce Momjian 已提交
931 932
	 * allowing a cancel/die interrupt to be accepted. This is OK because we
	 * have recorded the fact that we are waiting for a lock, and so
933
	 * LockWaitCancel will clean up if cancel/die happens.
934
	 */
935
	LWLockRelease(partitionLock);
936

937 938 939 940 941 942 943 944 945
	/*
	 * Also, now that we will successfully clean up after an ereport, it's
	 * safe to check to see if there's a buffer pin deadlock against the
	 * Startup process.  Of course, that's only necessary if we're doing
	 * Hot Standby and are not the Startup process ourselves.
	 */
	if (RecoveryInProgress() && !InRecovery)
		CheckRecoveryConflictDeadlock();

946 947 948
	/* Reset deadlock_state before enabling the signal handler */
	deadlock_state = DS_NOT_YET_CHECKED;

949
	/*
B
Bruce Momjian 已提交
950 951 952 953
	 * Set timer so we can wake up after awhile and check for a deadlock. If a
	 * deadlock is detected, the handler releases the process's semaphore and
	 * sets MyProc->waitStatus = STATUS_ERROR, allowing us to know that we
	 * must report failure rather than success.
954
	 *
955 956
	 * By delaying the check until we've waited for a bit, we can avoid
	 * running the rather expensive deadlock-check code in most cases.
957
	 */
958
	if (!enable_sig_alarm(DeadlockTimeout, false))
959
		elog(FATAL, "could not set timer for process wakeup");
960

961
	/*
962
	 * If someone wakes us between LWLockRelease and PGSemaphoreLock,
B
Bruce Momjian 已提交
963
	 * PGSemaphoreLock will not block.	The wakeup is "saved" by the semaphore
B
Bruce Momjian 已提交
964 965 966 967 968
	 * implementation.	While this is normally good, there are cases where a
	 * saved wakeup might be leftover from a previous operation (for example,
	 * we aborted ProcWaitForSignal just before someone did ProcSendSignal).
	 * So, loop to wait again if the waitStatus shows we haven't been granted
	 * nor denied the lock yet.
969
	 *
970 971 972 973 974 975 976
	 * We pass interruptOK = true, which eliminates a window in which
	 * cancel/die interrupts would be held off undesirably.  This is a promise
	 * that we don't mind losing control to a cancel/die interrupt here.  We
	 * don't, because we have no shared-state-change work to do after being
	 * granted the lock (the grantor did it all).  We do have to worry about
	 * updating the locallock table, but if we lose control to an error,
	 * LockWaitCancel will fix that up.
977
	 */
B
Bruce Momjian 已提交
978 979
	do
	{
980
		PGSemaphoreLock(&MyProc->sem, true);
981

982 983
		/*
		 * waitStatus could change from STATUS_WAITING to something else
B
Bruce Momjian 已提交
984
		 * asynchronously.	Read it just once per loop to prevent surprising
985 986 987 988
		 * behavior (such as missing log messages).
		 */
		myWaitStatus = MyProc->waitStatus;

989 990
		/*
		 * If we are not deadlocked, but are waiting on an autovacuum-induced
B
Bruce Momjian 已提交
991
		 * task, send a signal to interrupt it.
992 993 994
		 */
		if (deadlock_state == DS_BLOCKED_BY_AUTOVACUUM && allow_autovacuum_cancel)
		{
B
Bruce Momjian 已提交
995
			PGPROC	   *autovac = GetBlockingAutoVacuumPgproc();
996 997 998 999 1000 1001 1002 1003 1004 1005 1006

			LWLockAcquire(ProcArrayLock, LW_EXCLUSIVE);

			/*
			 * Only do it if the worker is not working to protect against Xid
			 * wraparound.
			 */
			if ((autovac != NULL) &&
				(autovac->vacuumFlags & PROC_IS_AUTOVACUUM) &&
				!(autovac->vacuumFlags & PROC_VACUUM_FOR_WRAPAROUND))
			{
B
Bruce Momjian 已提交
1007
				int			pid = autovac->pid;
1008

P
Peter Eisentraut 已提交
1009
				elog(DEBUG2, "sending cancel to blocking autovacuum PID %d",
1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030
					 pid);

				/* don't hold the lock across the kill() syscall */
				LWLockRelease(ProcArrayLock);

				/* send the autovacuum worker Back to Old Kent Road */
				if (kill(pid, SIGINT) < 0)
				{
					/* Just a warning to allow multiple callers */
					ereport(WARNING,
							(errmsg("could not send signal to process %d: %m",
									pid)));
				}
			}
			else
				LWLockRelease(ProcArrayLock);

			/* prevent signal from being resent more than once */
			allow_autovacuum_cancel = false;
		}

1031 1032 1033 1034
		/*
		 * If awoken after the deadlock check interrupt has run, and
		 * log_lock_waits is on, then report about the wait.
		 */
1035
		if (log_lock_waits && deadlock_state != DS_NOT_YET_CHECKED)
1036
		{
1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054
			StringInfoData buf;
			const char *modename;
			long		secs;
			int			usecs;
			long		msecs;

			initStringInfo(&buf);
			DescribeLockTag(&buf, &locallock->tag.lock);
			modename = GetLockmodeName(locallock->tag.lock.locktag_lockmethodid,
									   lockmode);
			TimestampDifference(timeout_start_time, GetCurrentTimestamp(),
								&secs, &usecs);
			msecs = secs * 1000 + usecs / 1000;
			usecs = usecs % 1000;

			if (deadlock_state == DS_SOFT_DEADLOCK)
				ereport(LOG,
						(errmsg("process %d avoided deadlock for %s on %s by rearranging queue order after %ld.%03d ms",
B
Bruce Momjian 已提交
1055
							  MyProcPid, modename, buf.data, msecs, usecs)));
1056
			else if (deadlock_state == DS_HARD_DEADLOCK)
1057
			{
1058
				/*
B
Bruce Momjian 已提交
1059 1060 1061 1062
				 * This message is a bit redundant with the error that will be
				 * reported subsequently, but in some cases the error report
				 * might not make it to the log (eg, if it's caught by an
				 * exception handler), and we want to ensure all long-wait
1063 1064 1065 1066
				 * events get logged.
				 */
				ereport(LOG,
						(errmsg("process %d detected deadlock while waiting for %s on %s after %ld.%03d ms",
B
Bruce Momjian 已提交
1067
							  MyProcPid, modename, buf.data, msecs, usecs)));
1068
			}
1069 1070 1071 1072

			if (myWaitStatus == STATUS_WAITING)
				ereport(LOG,
						(errmsg("process %d still waiting for %s on %s after %ld.%03d ms",
B
Bruce Momjian 已提交
1073
							  MyProcPid, modename, buf.data, msecs, usecs)));
1074 1075
			else if (myWaitStatus == STATUS_OK)
				ereport(LOG,
B
Bruce Momjian 已提交
1076 1077
					(errmsg("process %d acquired %s on %s after %ld.%03d ms",
							MyProcPid, modename, buf.data, msecs, usecs)));
1078 1079 1080
			else
			{
				Assert(myWaitStatus == STATUS_ERROR);
B
Bruce Momjian 已提交
1081

1082 1083
				/*
				 * Currently, the deadlock checker always kicks its own
B
Bruce Momjian 已提交
1084 1085 1086 1087 1088
				 * process, which means that we'll only see STATUS_ERROR when
				 * deadlock_state == DS_HARD_DEADLOCK, and there's no need to
				 * print redundant messages.  But for completeness and
				 * future-proofing, print a message if it looks like someone
				 * else kicked us off the lock.
1089 1090 1091 1092
				 */
				if (deadlock_state != DS_HARD_DEADLOCK)
					ereport(LOG,
							(errmsg("process %d failed to acquire %s on %s after %ld.%03d ms",
B
Bruce Momjian 已提交
1093
							  MyProcPid, modename, buf.data, msecs, usecs)));
1094 1095 1096
			}

			/*
B
Bruce Momjian 已提交
1097 1098
			 * At this point we might still need to wait for the lock. Reset
			 * state so we don't print the above messages again.
1099 1100 1101 1102
			 */
			deadlock_state = DS_NO_DEADLOCK;

			pfree(buf.data);
1103
		}
1104
	} while (myWaitStatus == STATUS_WAITING);
1105

1106
	/*
1107
	 * Disable the timer, if it's still running
B
Bruce Momjian 已提交
1108
	 */
1109
	if (!disable_sig_alarm(false))
1110
		elog(FATAL, "could not disable timer for process wakeup");
B
Bruce Momjian 已提交
1111

1112
	/*
B
Bruce Momjian 已提交
1113 1114 1115
	 * Re-acquire the lock table's partition lock.  We have to do this to hold
	 * off cancel/die interrupts before we can mess with lockAwaited (else we
	 * might have a missed or duplicated locallock update).
1116
	 */
1117
	LWLockAcquire(partitionLock, LW_EXCLUSIVE);
1118 1119 1120

	/*
	 * We no longer want LockWaitCancel to do anything.
1121
	 */
1122
	lockAwaited = NULL;
1123

1124
	/*
1125
	 * If we got the lock, be sure to remember it in the locallock table.
1126
	 */
1127
	if (MyProc->waitStatus == STATUS_OK)
1128
		GrantAwaitedLock();
1129

1130 1131 1132 1133
	/*
	 * We don't have to do anything else, because the awaker did all the
	 * necessary update of the lock table and MyProc.
	 */
1134
	return MyProc->waitStatus;
1135 1136 1137 1138 1139 1140
}


/*
 * ProcWakeup -- wake up a process by releasing its private semaphore.
 *
1141
 *	 Also remove the process from the wait queue and set its links invalid.
1142
 *	 RETURN: the next process in the wait queue.
1143
 *
1144 1145
 * The appropriate lock partition lock must be held by caller.
 *
1146 1147 1148
 * XXX: presently, this code is only used for the "success" case, and only
 * works correctly for that case.  To clean up in failure case, would need
 * to twiddle the lock's request counts too --- see RemoveFromWaitQueue.
1149
 * Hence, in practice the waitStatus parameter must be STATUS_OK.
1150
 */
J
Jan Wieck 已提交
1151
PGPROC *
1152
ProcWakeup(PGPROC *proc, int waitStatus)
1153
{
J
Jan Wieck 已提交
1154
	PGPROC	   *retProc;
1155

1156
	/* Proc should be sleeping ... */
1157 1158
	if (proc->links.prev == NULL ||
		proc->links.next == NULL)
1159
		return NULL;
1160
	Assert(proc->waitStatus == STATUS_WAITING);
1161

1162
	/* Save next process before we zap the list link */
1163
	retProc = (PGPROC *) proc->links.next;
1164

1165
	/* Remove process from wait queue */
1166
	SHMQueueDelete(&(proc->links));
1167
	(proc->waitLock->waitProcs.size)--;
1168

1169 1170
	/* Clean up process' state and pass it the ok/fail signal */
	proc->waitLock = NULL;
1171
	proc->waitProcLock = NULL;
1172
	proc->waitStatus = waitStatus;
1173

1174
	/* And awaken it */
1175
	PGSemaphoreUnlock(&proc->sem);
1176 1177

	return retProc;
1178 1179 1180 1181
}

/*
 * ProcLockWakeup -- routine for waking up processes when a lock is
1182 1183
 *		released (or a prior waiter is aborted).  Scan all waiters
 *		for lock, waken any that are no longer blocked.
1184 1185
 *
 * The appropriate lock partition lock must be held by caller.
1186
 */
1187
void
1188
ProcLockWakeup(LockMethod lockMethodTable, LOCK *lock)
1189
{
1190 1191
	PROC_QUEUE *waitQueue = &(lock->waitProcs);
	int			queue_size = waitQueue->size;
J
Jan Wieck 已提交
1192
	PGPROC	   *proc;
1193
	LOCKMASK	aheadRequests = 0;
M
 
Marc G. Fournier 已提交
1194

1195
	Assert(queue_size >= 0);
1196

1197 1198
	if (queue_size == 0)
		return;
1199

1200
	proc = (PGPROC *) waitQueue->links.next;
1201

1202 1203
	while (queue_size-- > 0)
	{
B
Bruce Momjian 已提交
1204
		LOCKMODE	lockmode = proc->waitLockMode;
M
 
Marc G. Fournier 已提交
1205 1206

		/*
B
Bruce Momjian 已提交
1207 1208
		 * Waken if (a) doesn't conflict with requests of earlier waiters, and
		 * (b) doesn't conflict with already-held locks.
M
 
Marc G. Fournier 已提交
1209
		 */
B
Bruce Momjian 已提交
1210
		if ((lockMethodTable->conflictTab[lockmode] & aheadRequests) == 0 &&
1211 1212 1213
			LockCheckConflicts(lockMethodTable,
							   lockmode,
							   lock,
1214
							   proc->waitProcLock,
1215
							   proc) == STATUS_OK)
M
 
Marc G. Fournier 已提交
1216
		{
1217
			/* OK to waken */
1218
			GrantLock(lock, proc->waitProcLock, lockmode);
1219
			proc = ProcWakeup(proc, STATUS_OK);
B
Bruce Momjian 已提交
1220

1221
			/*
B
Bruce Momjian 已提交
1222 1223 1224
			 * ProcWakeup removes proc from the lock's waiting process queue
			 * and returns the next proc in chain; don't use proc's next-link,
			 * because it's been cleared.
1225
			 */
M
 
Marc G. Fournier 已提交
1226
		}
1227
		else
1228
		{
B
Bruce Momjian 已提交
1229
			/*
B
Bruce Momjian 已提交
1230
			 * Cannot wake this guy. Remember his request for later checks.
B
Bruce Momjian 已提交
1231
			 */
1232
			aheadRequests |= LOCKBIT_ON(lockmode);
1233
			proc = (PGPROC *) proc->links.next;
1234
		}
M
 
Marc G. Fournier 已提交
1235
	}
1236 1237

	Assert(waitQueue->size >= 0);
1238 1239
}

1240 1241 1242
/*
 * CheckDeadLock
 *
1243
 * We only get to this routine if we got SIGALRM after DeadlockTimeout
1244 1245
 * while waiting for a lock to be released by some other process.  Look
 * to see if there's a deadlock; if not, just return and continue waiting.
1246
 * (But signal ProcSleep to log a message, if log_lock_waits is true.)
1247 1248
 * If we have a real deadlock, remove ourselves from the lock's wait queue
 * and signal an error to ProcSleep.
1249 1250 1251
 *
 * NB: this is run inside a signal handler, so be very wary about what is done
 * here or in called routines.
1252
 */
1253
static void
1254
CheckDeadLock(void)
1255
{
1256 1257
	int			i;

1258
	/*
B
Bruce Momjian 已提交
1259 1260
	 * Acquire exclusive lock on the entire shared lock data structures. Must
	 * grab LWLocks in partition-number order to avoid LWLock deadlock.
1261 1262 1263 1264 1265 1266
	 *
	 * Note that the deadlock check interrupt had better not be enabled
	 * anywhere that this process itself holds lock partition locks, else this
	 * will wait forever.  Also note that LWLockAcquire creates a critical
	 * section, so that this routine cannot be interrupted by cancel/die
	 * interrupts.
1267
	 */
1268 1269
	for (i = 0; i < NUM_LOCK_PARTITIONS; i++)
		LWLockAcquire(FirstLockMgrLock + i, LW_EXCLUSIVE);
1270

1271
	/*
1272 1273
	 * Check to see if we've been awoken by anyone in the interim.
	 *
1274
	 * If we have, we can return and resume our transaction -- happy day.
1275 1276
	 * Before we are awoken the process releasing the lock grants it to us so
	 * we know that we don't have to wait anymore.
1277
	 *
1278
	 * We check by looking to see if we've been unlinked from the wait queue.
B
Bruce Momjian 已提交
1279
	 * This is quicker than checking our semaphore's state, since no kernel
1280
	 * call is needed, and it is safe because we hold the lock partition lock.
1281
	 */
1282 1283
	if (MyProc->links.prev == NULL ||
		MyProc->links.next == NULL)
1284 1285 1286 1287 1288 1289 1290 1291 1292 1293
		goto check_done;

#ifdef LOCK_DEBUG
	if (Debug_deadlocks)
		DumpAllLocks();
#endif

	/* Run the deadlock check, and set deadlock_state for use by ProcSleep */
	deadlock_state = DeadLockCheck(MyProc);

1294
	if (deadlock_state == DS_HARD_DEADLOCK)
B
Bruce Momjian 已提交
1295
	{
1296 1297 1298
		/*
		 * Oops.  We have a deadlock.
		 *
1299 1300 1301 1302
		 * Get this process out of wait state. (Note: we could do this more
		 * efficiently by relying on lockAwaited, but use this coding to
		 * preserve the flexibility to kill some other transaction than the
		 * one detecting the deadlock.)
1303 1304
		 *
		 * RemoveFromWaitQueue sets MyProc->waitStatus to STATUS_ERROR, so
1305 1306
		 * ProcSleep will report an error after we return from the signal
		 * handler.
1307 1308 1309
		 */
		Assert(MyProc->waitLock != NULL);
		RemoveFromWaitQueue(MyProc, LockTagHashCode(&(MyProc->waitLock->tag)));
1310

1311 1312 1313 1314 1315
		/*
		 * Unlock my semaphore so that the interrupted ProcSleep() call can
		 * finish.
		 */
		PGSemaphoreUnlock(&MyProc->sem);
1316

1317
		/*
1318 1319 1320 1321 1322 1323 1324 1325
		 * We're done here.  Transaction abort caused by the error that
		 * ProcSleep will raise will cause any other locks we hold to be
		 * released, thus allowing other processes to wake up; we don't need
		 * to do that here.  NOTE: an exception is that releasing locks we
		 * hold doesn't consider the possibility of waiters that were blocked
		 * behind us on the lock we just failed to get, and might now be
		 * wakable because we're not in front of them anymore.  However,
		 * RemoveFromWaitQueue took care of waking up any such processes.
1326 1327
		 */
	}
1328
	else if (log_lock_waits || deadlock_state == DS_BLOCKED_BY_AUTOVACUUM)
1329 1330 1331 1332
	{
		/*
		 * Unlock my semaphore so that the interrupted ProcSleep() call can
		 * print the log message (we daren't do it here because we are inside
B
Bruce Momjian 已提交
1333 1334
		 * a signal handler).  It will then sleep again until someone releases
		 * the lock.
1335 1336
		 *
		 * If blocked by autovacuum, this wakeup will enable ProcSleep to send
1337
		 * the canceling signal to the autovacuum worker.
1338 1339 1340
		 */
		PGSemaphoreUnlock(&MyProc->sem);
	}
1341 1342

	/*
B
Bruce Momjian 已提交
1343 1344 1345 1346 1347
	 * And release locks.  We do this in reverse order for two reasons: (1)
	 * Anyone else who needs more than one of the locks will be trying to lock
	 * them in increasing order; we don't want to release the other process
	 * until it can get all the locks it needs. (2) This avoids O(N^2)
	 * behavior inside LWLockRelease.
1348
	 */
1349
check_done:
B
Bruce Momjian 已提交
1350
	for (i = NUM_LOCK_PARTITIONS; --i >= 0;)
1351
		LWLockRelease(FirstLockMgrLock + i);
1352 1353 1354
}


1355 1356 1357 1358 1359 1360
/*
 * ProcWaitForSignal - wait for a signal from another backend.
 *
 * This can share the semaphore normally used for waiting for locks,
 * since a backend could never be waiting for a lock and a signal at
 * the same time.  As with locks, it's OK if the signal arrives just
B
Bruce Momjian 已提交
1361
 * before we actually reach the waiting state.	Also as with locks,
1362 1363
 * it's necessary that the caller be robust against bogus wakeups:
 * always check that the desired state has occurred, and wait again
B
Bruce Momjian 已提交
1364
 * if not.	This copes with possible "leftover" wakeups.
1365 1366 1367 1368
 */
void
ProcWaitForSignal(void)
{
1369
	PGSemaphoreLock(&MyProc->sem, true);
1370 1371 1372
}

/*
1373
 * ProcSendSignal - send a signal to a backend identified by PID
1374 1375
 */
void
1376
ProcSendSignal(int pid)
1377
{
1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388
	PGPROC	   *proc = NULL;

	if (RecoveryInProgress())
	{
		/* use volatile pointer to prevent code rearrangement */
		volatile PROC_HDR *procglobal = ProcGlobal;

		SpinLockAcquire(ProcStructLock);

		/*
		 * Check to see whether it is the Startup process we wish to signal.
B
Bruce Momjian 已提交
1389 1390
		 * This call is made by the buffer manager when it wishes to wake up a
		 * process that has been waiting for a pin in so it can obtain a
1391
		 * cleanup lock using LockBufferForCleanup(). Startup is not a normal
B
Bruce Momjian 已提交
1392 1393
		 * backend, so BackendPidGetProc() will not return any pid at all. So
		 * we remember the information for this special case.
1394 1395 1396 1397 1398 1399 1400 1401 1402
		 */
		if (pid == procglobal->startupProcPid)
			proc = procglobal->startupProc;

		SpinLockRelease(ProcStructLock);
	}

	if (proc == NULL)
		proc = BackendPidGetProc(pid);
1403 1404

	if (proc != NULL)
1405
		PGSemaphoreUnlock(&proc->sem);
1406 1407 1408
}


1409 1410 1411 1412 1413 1414 1415 1416 1417
/*****************************************************************************
 * SIGALRM interrupt support
 *
 * Maybe these should be in pqsignal.c?
 *****************************************************************************/

/*
 * Enable the SIGALRM interrupt to fire after the specified delay
 *
1418
 * Delay is given in milliseconds.	Caller should be sure a SIGALRM
1419 1420
 * signal handler is installed before this is called.
 *
1421 1422
 * This code properly handles nesting of deadlock timeout alarms within
 * statement timeout alarms.
1423
 *
1424 1425 1426
 * Returns TRUE if okay, FALSE on failure.
 */
bool
1427
enable_sig_alarm(int delayms, bool is_statement_timeout)
1428
{
1429
	TimestampTz fin_time;
1430
	struct itimerval timeval;
1431

1432 1433
	if (is_statement_timeout)
	{
1434 1435 1436 1437 1438 1439 1440 1441 1442 1443
		/*
		 * Begin statement-level timeout
		 *
		 * Note that we compute statement_fin_time with reference to the
		 * statement_timestamp, but apply the specified delay without any
		 * correction; that is, we ignore whatever time has elapsed since
		 * statement_timestamp was set.  In the normal case only a small
		 * interval will have elapsed and so this doesn't matter, but there
		 * are corner cases (involving multi-statement query strings with
		 * embedded COMMIT or ROLLBACK) where we might re-initialize the
B
Bruce Momjian 已提交
1444 1445 1446 1447
		 * statement timeout long after initial receipt of the message. In
		 * such cases the enforcement of the statement timeout will be a bit
		 * inconsistent.  This annoyance is judged not worth the cost of
		 * performing an additional gettimeofday() here.
1448
		 */
1449
		Assert(!deadlock_timeout_active);
1450 1451
		fin_time = GetCurrentStatementStartTimestamp();
		fin_time = TimestampTzPlusMilliseconds(fin_time, delayms);
1452
		statement_fin_time = fin_time;
1453
		cancel_from_timeout = false;
1454
		statement_timeout_active = true;
1455 1456 1457 1458 1459 1460
	}
	else if (statement_timeout_active)
	{
		/*
		 * Begin deadlock timeout with statement-level timeout active
		 *
1461 1462 1463 1464
		 * Here, we want to interrupt at the closer of the two timeout times.
		 * If fin_time >= statement_fin_time then we need not touch the
		 * existing timer setting; else set up to interrupt at the deadlock
		 * timeout time.
1465 1466 1467
		 *
		 * NOTE: in this case it is possible that this routine will be
		 * interrupted by the previously-set timer alarm.  This is okay
B
Bruce Momjian 已提交
1468 1469 1470
		 * because the signal handler will do only what it should do according
		 * to the state variables.	The deadlock checker may get run earlier
		 * than normal, but that does no harm.
1471
		 */
1472 1473
		timeout_start_time = GetCurrentTimestamp();
		fin_time = TimestampTzPlusMilliseconds(timeout_start_time, delayms);
1474
		deadlock_timeout_active = true;
1475
		if (fin_time >= statement_fin_time)
1476 1477 1478 1479 1480 1481
			return true;
	}
	else
	{
		/* Begin deadlock timeout with no statement-level timeout */
		deadlock_timeout_active = true;
1482 1483 1484
		/* GetCurrentTimestamp can be expensive, so only do it if we must */
		if (log_lock_waits)
			timeout_start_time = GetCurrentTimestamp();
1485
	}
1486

1487
	/* If we reach here, okay to set the timer interrupt */
1488
	MemSet(&timeval, 0, sizeof(struct itimerval));
1489 1490
	timeval.it_value.tv_sec = delayms / 1000;
	timeval.it_value.tv_usec = (delayms % 1000) * 1000;
1491
	if (setitimer(ITIMER_REAL, &timeval, NULL))
1492
		return false;
1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513
	return true;
}

/*
 * Cancel the SIGALRM timer, either for a deadlock timeout or a statement
 * timeout.  If a deadlock timeout is canceled, any active statement timeout
 * remains in force.
 *
 * Returns TRUE if okay, FALSE on failure.
 */
bool
disable_sig_alarm(bool is_statement_timeout)
{
	/*
	 * Always disable the interrupt if it is active; this avoids being
	 * interrupted by the signal handler and thereby possibly getting
	 * confused.
	 *
	 * We will re-enable the interrupt if necessary in CheckStatementTimeout.
	 */
	if (statement_timeout_active || deadlock_timeout_active)
1514
	{
1515
		struct itimerval timeval;
1516

1517
		MemSet(&timeval, 0, sizeof(struct itimerval));
1518
		if (setitimer(ITIMER_REAL, &timeval, NULL))
1519
		{
1520 1521 1522
			statement_timeout_active = false;
			cancel_from_timeout = false;
			deadlock_timeout_active = false;
1523 1524
			return false;
		}
1525 1526
	}

1527 1528 1529 1530
	/* Always cancel deadlock timeout, in case this is error cleanup */
	deadlock_timeout_active = false;

	/* Cancel or reschedule statement timeout */
1531
	if (is_statement_timeout)
1532
	{
1533
		statement_timeout_active = false;
1534 1535
		cancel_from_timeout = false;
	}
1536 1537 1538 1539 1540
	else if (statement_timeout_active)
	{
		if (!CheckStatementTimeout())
			return false;
	}
1541 1542 1543
	return true;
}

1544

1545
/*
1546 1547 1548
 * Check for statement timeout.  If the timeout time has come,
 * trigger a query-cancel interrupt; if not, reschedule the SIGALRM
 * interrupt to occur at the right time.
1549
 *
1550
 * Returns true if okay, false if failed to set the interrupt.
1551
 */
1552 1553
static bool
CheckStatementTimeout(void)
1554
{
1555
	TimestampTz now;
B
Bruce Momjian 已提交
1556

1557 1558 1559
	if (!statement_timeout_active)
		return true;			/* do nothing if not active */

1560
	now = GetCurrentTimestamp();
1561

1562
	if (now >= statement_fin_time)
1563
	{
1564 1565
		/* Time to die */
		statement_timeout_active = false;
1566
		cancel_from_timeout = true;
1567 1568 1569 1570
#ifdef HAVE_SETSID
		/* try to signal whole process group */
		kill(-MyProcPid, SIGINT);
#endif
1571
		kill(MyProcPid, SIGINT);
1572 1573 1574 1575
	}
	else
	{
		/* Not time yet, so (re)schedule the interrupt */
1576 1577
		long		secs;
		int			usecs;
1578 1579
		struct itimerval timeval;

1580 1581
		TimestampDifference(now, statement_fin_time,
							&secs, &usecs);
B
Bruce Momjian 已提交
1582

1583 1584 1585 1586 1587 1588
		/*
		 * It's possible that the difference is less than a microsecond;
		 * ensure we don't cancel, rather than set, the interrupt.
		 */
		if (secs == 0 && usecs == 0)
			usecs = 1;
1589
		MemSet(&timeval, 0, sizeof(struct itimerval));
1590 1591
		timeval.it_value.tv_sec = secs;
		timeval.it_value.tv_usec = usecs;
1592
		if (setitimer(ITIMER_REAL, &timeval, NULL))
1593 1594 1595
			return false;
	}

1596 1597
	return true;
}
1598 1599 1600


/*
1601
 * Signal handler for SIGALRM for normal user backends
1602 1603 1604 1605 1606
 *
 * Process deadlock check and/or statement timeout check, as needed.
 * To avoid various edge cases, we must be careful to do nothing
 * when there is nothing to be done.  We also need to be able to
 * reschedule the timer interrupt if called before end of statement.
1607 1608 1609 1610
 */
void
handle_sig_alarm(SIGNAL_ARGS)
{
1611 1612 1613
	int			save_errno = errno;

	if (deadlock_timeout_active)
1614
	{
1615
		deadlock_timeout_active = false;
1616 1617
		CheckDeadLock();
	}
1618 1619 1620 1621 1622

	if (statement_timeout_active)
		(void) CheckStatementTimeout();

	errno = save_errno;
1623
}
1624 1625 1626 1627 1628 1629 1630

/*
 * Signal handler for SIGALRM in Startup process
 *
 * To avoid various edge cases, we must be careful to do nothing
 * when there is nothing to be done.  We also need to be able to
 * reschedule the timer interrupt if called before end of statement.
1631 1632 1633
 *
 * We set either deadlock_timeout_active or statement_timeout_active
 * or both. Interrupts are enabled if standby_timeout_active.
1634 1635
 */
bool
1636
enable_standby_sig_alarm(TimestampTz now, TimestampTz fin_time, bool deadlock_only)
1637
{
1638 1639
	TimestampTz deadlock_time = TimestampTzPlusMilliseconds(now,
															DeadlockTimeout);
1640

1641 1642 1643
	if (deadlock_only)
	{
		/*
1644
		 * Wake up at deadlock_time only, then wait forever
1645 1646 1647 1648 1649 1650 1651 1652
		 */
		statement_fin_time = deadlock_time;
		deadlock_timeout_active = true;
		statement_timeout_active = false;
	}
	else if (fin_time > deadlock_time)
	{
		/*
1653
		 * Wake up at deadlock_time, then again at fin_time
1654 1655 1656 1657 1658 1659 1660 1661 1662
		 */
		statement_fin_time = deadlock_time;
		statement_fin_time2 = fin_time;
		deadlock_timeout_active = true;
		statement_timeout_active = true;
	}
	else
	{
		/*
1663
		 * Wake only at fin_time because its fairly soon
1664 1665 1666 1667 1668
		 */
		statement_fin_time = fin_time;
		deadlock_timeout_active = false;
		statement_timeout_active = true;
	}
1669

1670 1671 1672 1673 1674
	if (deadlock_timeout_active || statement_timeout_active)
	{
		long		secs;
		int			usecs;
		struct itimerval timeval;
B
Bruce Momjian 已提交
1675

1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686
		TimestampDifference(now, statement_fin_time,
							&secs, &usecs);
		if (secs == 0 && usecs == 0)
			usecs = 1;
		MemSet(&timeval, 0, sizeof(struct itimerval));
		timeval.it_value.tv_sec = secs;
		timeval.it_value.tv_usec = usecs;
		if (setitimer(ITIMER_REAL, &timeval, NULL))
			return false;
		standby_timeout_active = true;
	}
1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726

	return true;
}

bool
disable_standby_sig_alarm(void)
{
	/*
	 * Always disable the interrupt if it is active; this avoids being
	 * interrupted by the signal handler and thereby possibly getting
	 * confused.
	 *
	 * We will re-enable the interrupt if necessary in CheckStandbyTimeout.
	 */
	if (standby_timeout_active)
	{
		struct itimerval timeval;

		MemSet(&timeval, 0, sizeof(struct itimerval));
		if (setitimer(ITIMER_REAL, &timeval, NULL))
		{
			standby_timeout_active = false;
			return false;
		}
	}

	standby_timeout_active = false;

	return true;
}

/*
 * CheckStandbyTimeout() runs unconditionally in the Startup process
 * SIGALRM handler. Timers will only be set when InHotStandby.
 * We simply ignore any signals unless the timer has been set.
 */
static bool
CheckStandbyTimeout(void)
{
	TimestampTz now;
B
Bruce Momjian 已提交
1727
	bool		reschedule = false;
1728 1729 1730 1731 1732

	standby_timeout_active = false;

	now = GetCurrentTimestamp();

1733
	/*
B
Bruce Momjian 已提交
1734 1735
	 * Reschedule the timer if its not time to wake yet, or if we have both
	 * timers set and the first one has just been reached.
1736
	 */
1737
	if (now >= statement_fin_time)
1738 1739 1740 1741
	{
		if (deadlock_timeout_active)
		{
			/*
1742
			 * We're still waiting when we reach deadlock timeout, so send out
B
Bruce Momjian 已提交
1743 1744
			 * a request to have other backends check themselves for deadlock.
			 * Then continue waiting until statement_fin_time, if that's set.
1745 1746 1747 1748 1749
			 */
			SendRecoveryConflictWithBufferPin(PROCSIG_RECOVERY_CONFLICT_STARTUP_DEADLOCK);
			deadlock_timeout_active = false;

			/*
1750
			 * Begin second waiting period if required.
1751 1752 1753 1754 1755 1756 1757 1758 1759 1760
			 */
			if (statement_timeout_active)
			{
				reschedule = true;
				statement_fin_time = statement_fin_time2;
			}
		}
		else
		{
			/*
1761 1762
			 * We've now reached statement_fin_time, so ask all conflicts to
			 * leave, so we can press ahead with applying changes in recovery.
1763 1764 1765 1766
			 */
			SendRecoveryConflictWithBufferPin(PROCSIG_RECOVERY_CONFLICT_BUFFERPIN);
		}
	}
1767
	else
1768 1769 1770
		reschedule = true;

	if (reschedule)
1771 1772 1773 1774
	{
		long		secs;
		int			usecs;
		struct itimerval timeval;
B
Bruce Momjian 已提交
1775

1776 1777 1778 1779 1780 1781 1782 1783 1784
		TimestampDifference(now, statement_fin_time,
							&secs, &usecs);
		if (secs == 0 && usecs == 0)
			usecs = 1;
		MemSet(&timeval, 0, sizeof(struct itimerval));
		timeval.it_value.tv_sec = secs;
		timeval.it_value.tv_usec = usecs;
		if (setitimer(ITIMER_REAL, &timeval, NULL))
			return false;
1785
		standby_timeout_active = true;
1786 1787 1788 1789 1790 1791 1792 1793
	}

	return true;
}

void
handle_standby_sig_alarm(SIGNAL_ARGS)
{
B
Bruce Momjian 已提交
1794
	int			save_errno = errno;
1795 1796 1797 1798 1799 1800

	if (standby_timeout_active)
		(void) CheckStandbyTimeout();

	errno = save_errno;
}