proc.c 32.0 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-2002, PostgreSQL Global Development Group
B
Add:  
Bruce Momjian 已提交
7
 * Portions Copyright (c) 1994, Regents of the University of California
8 9 10
 *
 *
 * IDENTIFICATION
11
 *	  $Header: /cvsroot/pgsql/src/backend/storage/lmgr/proc.c,v 1.129 2003/02/18 02:13:24 momjian Exp $
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 23 24 25 26 27
 *
 * Locking and waiting for buffers can cause the backend to be
 * put to sleep.  Whoever releases the lock, etc. wakes the
 * process up again (and gives it an error code so it knows
 * whether it was awoken on an error condition).
 *
 * Interface (b):
 *
28 29
 * ProcReleaseLocks -- frees the locks associated with current transaction
 *
30
 * ProcKill -- destroys the shared memory state (and locks)
31
 *		associated with the process.
32 33
 *
 * 5/15/91 -- removed the buffer pool based lock chain in favor
34 35 36 37 38 39
 *		of a shared memory lock chain.	The write-protection is
 *		more expensive if the lock chain is in the buffer pool.
 *		The only reason I kept the lock chain in the buffer pool
 *		in the first place was to allow the lock table to grow larger
 *		than available shared memory and that isn't going to work
 *		without a lot of unimplemented support anyway.
40
 */
41 42
#include "postgres.h"

43
#include <errno.h>
44
#include <signal.h>
45 46
#include <unistd.h>
#include <sys/time.h>
M
Marc G. Fournier 已提交
47

48
#include "miscadmin.h"
49
#include "access/xact.h"
50
#include "storage/ipc.h"
51
#include "storage/proc.h"
52
#include "storage/sinval.h"
53
#include "storage/spin.h"
54

55
/* GUC variables */
B
Bruce Momjian 已提交
56
int			DeadlockTimeout = 1000;
57
int			StatementTimeout = 0;
M
 
Marc G. Fournier 已提交
58

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

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

static PROC_HDR *ProcGlobal = NULL;

J
Jan Wieck 已提交
73
static PGPROC *DummyProc = NULL;
74

75
static bool waitingForLock = false;
76
static bool waitingForSignal = false;
77

78 79 80 81 82 83 84
/* Mark these volatile because they can be changed by signal handler */
static volatile bool statement_timeout_active = false;
static volatile bool deadlock_timeout_active = false;
/* statement_fin_time is valid only if statement_timeout_active is true */
static struct timeval statement_fin_time;


85
static void ProcKill(void);
86
static void DummyProcKill(void);
87
static bool CheckStatementTimeout(void);
88

V
Vadim B. Mikheev 已提交
89

90 91 92 93 94 95 96 97 98 99
/*
 * Report number of semaphores needed by InitProcGlobal.
 */
int
ProcGlobalSemas(int maxBackends)
{
	/* We need a sema per backend, plus one for the dummy process. */
	return maxBackends + 1;
}

100 101
/*
 * InitProcGlobal -
102
 *	  initializes the global process table. We put it here so that
103
 *	  the postmaster can do this initialization.
104
 *
105
 *	  We also create all the per-process semaphores we will need to support
106 107 108 109 110 111 112 113 114
 *	  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
 *	  MaxBackends higher than his kernel will support, he'll find out sooner
 *	  rather than later.
115 116 117 118
 *
 *	  Another reason for creating semaphores here is that the semaphore
 *	  implementation typically requires us to create semaphores in the
 *	  postmaster, not in backends.
119 120
 */
void
121
InitProcGlobal(int maxBackends)
122
{
123
	bool		found = false;
124

125
	/* Create or attach to the ProcGlobal shared structure */
126
	ProcGlobal = (PROC_HDR *)
127
		ShmemInitStruct("Proc Header", sizeof(PROC_HDR), &found);
128

129 130
	/* --------------------
	 * We're the first - initialize.
131 132
	 * XXX if found should ever be true, it is a sign of impending doom ...
	 * ought to complain if so?
133 134 135
	 * --------------------
	 */
	if (!found)
136
	{
137
		int			i;
138

139
		ProcGlobal->freeProcs = INVALID_OFFSET;
140

B
Bruce Momjian 已提交
141
		/*
B
Bruce Momjian 已提交
142 143
		 * Pre-create the PGPROC structures and create a semaphore for
		 * each.
144
		 */
145
		for (i = 0; i < maxBackends; i++)
146
		{
B
Bruce Momjian 已提交
147
			PGPROC	   *proc;
148

J
Jan Wieck 已提交
149
			proc = (PGPROC *) ShmemAlloc(sizeof(PGPROC));
150 151
			if (!proc)
				elog(FATAL, "cannot create new proc: out of memory");
J
Jan Wieck 已提交
152
			MemSet(proc, 0, sizeof(PGPROC));
153 154 155
			PGSemaphoreCreate(&proc->sem);
			proc->links.next = ProcGlobal->freeProcs;
			ProcGlobal->freeProcs = MAKE_OFFSET(proc);
156
		}
157 158

		/*
B
Bruce Momjian 已提交
159 160 161
		 * Pre-allocate a PGPROC structure for dummy (checkpoint)
		 * processes, too.	This does not get linked into the freeProcs
		 * list.
162
		 */
J
Jan Wieck 已提交
163
		DummyProc = (PGPROC *) ShmemAlloc(sizeof(PGPROC));
164 165
		if (!DummyProc)
			elog(FATAL, "cannot create new proc: out of memory");
J
Jan Wieck 已提交
166
		MemSet(DummyProc, 0, sizeof(PGPROC));
167
		DummyProc->pid = 0;		/* marks DummyProc as not in use */
168
		PGSemaphoreCreate(&DummyProc->sem);
169 170 171 172

		/* Create ProcStructLock spinlock, too */
		ProcStructLock = (slock_t *) ShmemAlloc(sizeof(slock_t));
		SpinLockInit(ProcStructLock);
173 174 175
	}
}

176
/*
177
 * InitProcess -- initialize a per-process data structure for this backend
178 179
 */
void
180
InitProcess(void)
181
{
182
	SHMEM_OFFSET myOffset;
B
Bruce Momjian 已提交
183

184 185
	/* use volatile pointer to prevent code rearrangement */
	volatile PROC_HDR *procglobal = ProcGlobal;
186 187

	/*
188 189
	 * ProcGlobal should be set by a previous call to InitProcGlobal (if
	 * we are a backend, we inherit this by fork() from the postmaster).
190
	 */
191
	if (procglobal == NULL)
192
		elog(PANIC, "InitProcess: Proc Header uninitialized");
193 194 195

	if (MyProc != NULL)
		elog(ERROR, "InitProcess: you already exist");
196

197
	/*
B
Bruce Momjian 已提交
198 199
	 * Try to get a proc struct from the free list.  If this fails, we
	 * must be out of PGPROC structures (not to mention semaphores).
200
	 */
201
	SpinLockAcquire(ProcStructLock);
202

203
	myOffset = procglobal->freeProcs;
204 205

	if (myOffset != INVALID_OFFSET)
206
	{
J
Jan Wieck 已提交
207
		MyProc = (PGPROC *) MAKE_PTR(myOffset);
208
		procglobal->freeProcs = MyProc->links.next;
209
		SpinLockRelease(ProcStructLock);
210 211 212 213
	}
	else
	{
		/*
J
Jan Wieck 已提交
214
		 * If we reach here, all the PGPROCs are in use.  This is one of
215 216
		 * the possible places to detect "too many backends", so give the
		 * standard error message.
217
		 */
218
		SpinLockRelease(ProcStructLock);
219
		elog(FATAL, "Sorry, too many clients already");
220
	}
221

222
	/*
B
Bruce Momjian 已提交
223 224
	 * Initialize all fields of MyProc, except for the semaphore which was
	 * prepared for us by InitProcGlobal.
225
	 */
226
	SHMQueueElemInit(&(MyProc->links));
227
	MyProc->errType = STATUS_OK;
228
	MyProc->xid = InvalidTransactionId;
229
	MyProc->xmin = InvalidTransactionId;
230 231
	MyProc->pid = MyProcPid;
	MyProc->databaseId = MyDatabaseId;
232
	MyProc->logRec.xrecoff = 0;
233 234 235
	MyProc->lwWaiting = false;
	MyProc->lwExclusive = false;
	MyProc->lwWaitLink = NULL;
236 237 238
	MyProc->waitLock = NULL;
	MyProc->waitHolder = NULL;
	SHMQueueInit(&(MyProc->procHolders));
239

240
	/*
241
	 * Arrange to clean up at backend exit.
242
	 */
243
	on_shmem_exit(ProcKill, 0);
244

245
	/*
246
	 * We might be reusing a semaphore that belonged to a failed process.
247 248
	 * So be careful and reinitialize its value here.
	 */
249
	PGSemaphoreReset(&MyProc->sem);
250

251
	/*
J
Jan Wieck 已提交
252
	 * Now that we have a PGPROC, we could try to acquire locks, so
B
Bruce Momjian 已提交
253
	 * initialize the deadlock checker.
254 255
	 */
	InitDeadLockChecking();
256 257
}

258 259 260 261
/*
 * InitDummyProcess -- create a dummy per-process data structure
 *
 * This is called by checkpoint processes so that they will have a MyProc
J
Jan Wieck 已提交
262
 * value that's real enough to let them wait for LWLocks.  The PGPROC and
263 264 265 266 267 268
 * sema that are assigned are the extra ones created during InitProcGlobal.
 */
void
InitDummyProcess(void)
{
	/*
269 270
	 * ProcGlobal should be set by a previous call to InitProcGlobal (we
	 * inherit this by fork() from the postmaster).
271 272
	 */
	if (ProcGlobal == NULL || DummyProc == NULL)
273
		elog(PANIC, "InitDummyProcess: Proc Header uninitialized");
274 275 276 277 278 279 280 281 282 283 284 285 286

	if (MyProc != NULL)
		elog(ERROR, "InitDummyProcess: you already exist");

	/*
	 * DummyProc should not presently be in use by anyone else
	 */
	if (DummyProc->pid != 0)
		elog(FATAL, "InitDummyProcess: DummyProc is in use by PID %d",
			 DummyProc->pid);
	MyProc = DummyProc;

	/*
287 288
	 * Initialize all fields of MyProc, except MyProc->sem which was set
	 * up by InitProcGlobal.
289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312
	 */
	MyProc->pid = MyProcPid;	/* marks DummyProc as in use by me */
	SHMQueueElemInit(&(MyProc->links));
	MyProc->errType = STATUS_OK;
	MyProc->xid = InvalidTransactionId;
	MyProc->xmin = InvalidTransactionId;
	MyProc->databaseId = MyDatabaseId;
	MyProc->logRec.xrecoff = 0;
	MyProc->lwWaiting = false;
	MyProc->lwExclusive = false;
	MyProc->lwWaitLink = NULL;
	MyProc->waitLock = NULL;
	MyProc->waitHolder = NULL;
	SHMQueueInit(&(MyProc->procHolders));

	/*
	 * Arrange to clean up at process exit.
	 */
	on_shmem_exit(DummyProcKill, 0);

	/*
	 * We might be reusing a semaphore that belonged to a failed process.
	 * So be careful and reinitialize its value here.
	 */
313
	PGSemaphoreReset(&MyProc->sem);
314 315
}

316 317 318
/*
 * Cancel any pending wait for lock, when aborting a transaction.
 *
319 320
 * Returns true if we had been waiting for a lock, else false.
 *
321 322 323 324
 * (Normally, this would only happen if we accept a cancel/die
 * interrupt while waiting; but an elog(ERROR) while waiting is
 * within the realm of possibility, too.)
 */
325
bool
326 327 328 329
LockWaitCancel(void)
{
	/* Nothing to do if we weren't waiting for a lock */
	if (!waitingForLock)
330 331
		return false;

332 333 334
	waitingForLock = false;

	/* Turn off the deadlock timer, if it's still running (see ProcSleep) */
335
	disable_sig_alarm(false);
336 337

	/* Unlink myself from the wait queue, if on it (might not be anymore!) */
338
	LWLockAcquire(LockMgrLock, LW_EXCLUSIVE);
339 340
	if (MyProc->links.next != INVALID_OFFSET)
		RemoveFromWaitQueue(MyProc);
341
	LWLockRelease(LockMgrLock);
H
Hiroshi Inoue 已提交
342

343 344 345
	/*
	 * Reset the proc wait semaphore to zero.  This is necessary in the
	 * scenario where someone else granted us the lock we wanted before we
B
Bruce Momjian 已提交
346 347 348 349 350
	 * were able to remove ourselves from the wait-list.  The semaphore
	 * will have been bumped to 1 by the would-be grantor, and since we
	 * are no longer going to wait on the sema, we have to force it back
	 * to zero. Otherwise, our next attempt to wait for a lock will fall
	 * through prematurely.
351
	 */
352
	PGSemaphoreReset(&MyProc->sem);
353 354

	/*
B
Bruce Momjian 已提交
355 356
	 * Return true even if we were kicked off the lock before we were able
	 * to remove ourselves.
357 358
	 */
	return true;
H
Hiroshi Inoue 已提交
359
}
360

361

362
/*
363 364 365 366 367 368 369 370
 * ProcReleaseLocks() -- release locks associated with current transaction
 *			at transaction commit or abort
 *
 * At commit, we release only locks tagged with the current transaction's XID,
 * leaving those marked with XID 0 (ie, session locks) undisturbed.  At abort,
 * we release all locks including XID 0, because we need to clean up after
 * a failure.  This logic will need extension if we ever support nested
 * transactions.
371
 *
372
 * Note that user locks are not released in either case.
373 374
 */
void
375
ProcReleaseLocks(bool isCommit)
376
{
377 378
	if (!MyProc)
		return;
379 380 381
	/* If waiting, get off wait queue (should only be needed after error) */
	LockWaitCancel();
	/* Release locks */
382 383
	LockReleaseAll(DEFAULT_LOCKMETHOD, MyProc,
				   !isCommit, GetCurrentTransactionId());
384 385 386 387 388
}


/*
 * ProcKill() -- Destroy the per-proc data structure for
389
 *		this process. Release any of its held LW locks.
390 391
 */
static void
392
ProcKill(void)
393
{
394 395 396
	/* use volatile pointer to prevent code rearrangement */
	volatile PROC_HDR *procglobal = ProcGlobal;

397
	Assert(MyProc != NULL);
398

399 400 401
	/* Release any LW locks I am holding */
	LWLockReleaseAll();

402 403 404 405 406 407
	/*
	 * Make real sure we release any buffer locks and pins we might be
	 * holding, too.  It is pretty ugly to do this here and not in a
	 * shutdown callback registered by the bufmgr ... but we must do this
	 * *after* LWLockReleaseAll and *before* zapping MyProc.
	 */
408
	AbortBufferIO();
409 410
	UnlockBuffers();
	AtEOXact_Buffers(false);
411

412 413
	/* Get off any wait queue I might be on */
	LockWaitCancel();
414

415
	/* Remove from the standard lock table */
416
	LockReleaseAll(DEFAULT_LOCKMETHOD, MyProc, true, InvalidTransactionId);
417

418 419
#ifdef USER_LOCKS
	/* Remove from the user lock table */
420
	LockReleaseAll(USER_LOCKMETHOD, MyProc, true, InvalidTransactionId);
421
#endif
422

423
	SpinLockAcquire(ProcStructLock);
424

J
Jan Wieck 已提交
425
	/* Return PGPROC structure (and semaphore) to freelist */
426 427
	MyProc->links.next = procglobal->freeProcs;
	procglobal->freeProcs = MAKE_OFFSET(MyProc);
428

J
Jan Wieck 已提交
429
	/* PGPROC struct isn't mine anymore */
430
	MyProc = NULL;
431

432 433 434 435 436
	SpinLockRelease(ProcStructLock);
}

/*
 * DummyProcKill() -- Cut-down version of ProcKill for dummy (checkpoint)
J
Jan Wieck 已提交
437
 *		processes.	The PGPROC and sema are not released, only marked
438 439 440 441 442 443 444 445 446 447
 *		as not-in-use.
 */
static void
DummyProcKill(void)
{
	Assert(MyProc != NULL && MyProc == DummyProc);

	/* Release any LW locks I am holding */
	LWLockReleaseAll();

448
	/* Release buffer locks and pins, too */
449
	AbortBufferIO();
450 451
	UnlockBuffers();
	AtEOXact_Buffers(false);
452 453 454 455 456 457

	/* I can't be on regular lock queues, so needn't check */

	/* Mark DummyProc no longer in use */
	MyProc->pid = 0;

J
Jan Wieck 已提交
458
	/* PGPROC struct isn't mine anymore */
459
	MyProc = NULL;
460 461
}

462

463 464
/*
 * ProcQueue package: routines for putting processes to sleep
465
 *		and  waking them up
466 467 468 469 470 471 472 473
 */

/*
 * ProcQueueAlloc -- alloc/attach to a shared memory process queue
 *
 * Returns: a pointer to the queue or NULL
 * Side Effects: Initializes the queue if we allocated one
 */
474
#ifdef NOT_USED
475
PROC_QUEUE *
476 477
ProcQueueAlloc(char *name)
{
478 479
	bool		found;
	PROC_QUEUE *queue = (PROC_QUEUE *)
B
Bruce Momjian 已提交
480
	ShmemInitStruct(name, sizeof(PROC_QUEUE), &found);
481 482

	if (!queue)
483
		return NULL;
484 485
	if (!found)
		ProcQueueInit(queue);
486
	return queue;
487
}
488
#endif
489 490 491 492 493

/*
 * ProcQueueInit -- initialize a shared memory process queue
 */
void
494
ProcQueueInit(PROC_QUEUE *queue)
495
{
496 497
	SHMQueueInit(&(queue->links));
	queue->size = 0;
498 499 500 501 502 503
}


/*
 * ProcSleep -- put a process to sleep
 *
504 505
 * Caller must have set MyProc->heldLocks to reflect locks already held
 * on the lockable object by this process (under all XIDs).
506
 *
507
 * Locktable's masterLock must be held at entry, and will be held
508
 * at exit.
509
 *
510
 * Result: STATUS_OK if we acquired the lock, STATUS_ERROR if not (deadlock).
511
 *
512
 * ASSUME: that no one will fiddle with the queue until after
513
 *		we release the masterLock.
514 515
 *
 * NOTES: The process queue is now a priority queue for locking.
516 517 518
 *
 * P() on the semaphore should put us to sleep.  The process
 * semaphore is normally zero, so when we try to acquire it, we sleep.
519 520
 */
int
521
ProcSleep(LOCKMETHODTABLE *lockMethodTable,
522 523
		  LOCKMODE lockmode,
		  LOCK *lock,
524
		  PROCLOCK *proclock)
525
{
B
Bruce Momjian 已提交
526
	LWLockId	masterLock = lockMethodTable->masterLock;
527 528
	PROC_QUEUE *waitQueue = &(lock->waitProcs);
	int			myHeldLocks = MyProc->heldLocks;
529
	bool		early_deadlock = false;
J
Jan Wieck 已提交
530
	PGPROC	   *proc;
531
	int			i;
532

533
	/*
534 535 536 537 538 539
	 * Determine where to add myself in the wait queue.
	 *
	 * 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
540 541 542
	 * me to before that waiter anyway; but it's relatively cheap to
	 * detect such a conflict immediately, and avoid delaying till
	 * deadlock timeout.
543
	 *
544 545
	 * 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
546 547
	 * that waiter.  If not, then just grant myself the requested lock
	 * immediately.  This is the same as the test for immediate grant in
548 549
	 * LockAcquire, except we are only considering the part of the wait
	 * queue before my insertion point.
550 551
	 */
	if (myHeldLocks != 0)
V
Vadim B. Mikheev 已提交
552
	{
553 554
		int			aheadRequests = 0;

J
Jan Wieck 已提交
555
		proc = (PGPROC *) MAKE_PTR(waitQueue->links.next);
556
		for (i = 0; i < waitQueue->size; i++)
V
Vadim B. Mikheev 已提交
557
		{
558
			/* Must he wait for me? */
B
Bruce Momjian 已提交
559
			if (lockMethodTable->conflictTab[proc->waitLockMode] & myHeldLocks)
V
Vadim B. Mikheev 已提交
560
			{
561
				/* Must I wait for him ? */
B
Bruce Momjian 已提交
562
				if (lockMethodTable->conflictTab[lockmode] & proc->heldLocks)
563
				{
564
					/*
565 566 567 568
					 * 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
569
					 * loop.  Also, record deadlock info for later message.
570
					 */
571
					RememberSimpleDeadLock(MyProc, lockmode, lock, proc);
572 573
					early_deadlock = true;
					break;
574
				}
575
				/* I must go before this waiter.  Check special case. */
B
Bruce Momjian 已提交
576
				if ((lockMethodTable->conflictTab[lockmode] & aheadRequests) == 0 &&
577 578 579
					LockCheckConflicts(lockMethodTable,
									   lockmode,
									   lock,
580
									   proclock,
581 582
									   MyProc,
									   NULL) == STATUS_OK)
583
				{
584
					/* Skip the wait and just grant myself the lock. */
585
					GrantLock(lock, proclock, lockmode);
586
					return STATUS_OK;
587 588
				}
				/* Break out of loop to put myself before him */
V
Vadim B. Mikheev 已提交
589
				break;
590
			}
591 592
			/* Nope, so advance to next waiter */
			aheadRequests |= (1 << proc->waitLockMode);
J
Jan Wieck 已提交
593
			proc = (PGPROC *) MAKE_PTR(proc->links.next);
V
Vadim B. Mikheev 已提交
594
		}
B
Bruce Momjian 已提交
595

596 597 598 599
		/*
		 * If we fall out of loop normally, proc points to waitQueue head,
		 * so we will insert at tail of queue as desired.
		 */
600 601 602 603
	}
	else
	{
		/* I hold no locks, so I can't push in front of anyone. */
J
Jan Wieck 已提交
604
		proc = (PGPROC *) &(waitQueue->links);
V
Vadim B. Mikheev 已提交
605
	}
606

607 608 609
	/*
	 * Insert self into queue, ahead of the given proc (or at tail of
	 * queue).
610
	 */
611
	SHMQueueInsertBefore(&(proc->links), &(MyProc->links));
B
Bruce Momjian 已提交
612
	waitQueue->size++;
613

614
	lock->waitMask |= (1 << lockmode);
615

J
Jan Wieck 已提交
616
	/* Set up wait information in PGPROC object, too */
617
	MyProc->waitLock = lock;
618
	MyProc->waitHolder = proclock;
619 620
	MyProc->waitLockMode = lockmode;

621
	MyProc->errType = STATUS_OK;	/* initialize result for success */
622 623 624

	/*
	 * If we detected deadlock, give up without waiting.  This must agree
625
	 * with CheckDeadLock's recovery code, except that we shouldn't
626
	 * release the semaphore since we haven't tried to lock it yet.
627 628 629 630 631 632 633
	 */
	if (early_deadlock)
	{
		RemoveFromWaitQueue(MyProc);
		MyProc->errType = STATUS_ERROR;
		return STATUS_ERROR;
	}
634

635 636 637
	/* mark that we are waiting for a lock */
	waitingForLock = true;

638
	/*
639
	 * Release the locktable's masterLock.
640
	 *
641 642 643 644
	 * NOTE: this may also cause us to exit critical-section state, possibly
	 * 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
	 * LockWaitCancel will clean up if cancel/die happens.
645
	 */
646
	LWLockRelease(masterLock);
647

648
	/*
649 650 651 652 653 654 655
	 * 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->errType = STATUS_ERROR, allowing us to
	 * know that we must report failure rather than success.
	 *
	 * By delaying the check until we've waited for a bit, we can avoid
	 * running the rather expensive deadlock-check code in most cases.
656
	 */
657
	if (!enable_sig_alarm(DeadlockTimeout, false))
658
		elog(FATAL, "ProcSleep: Unable to set timer for process wakeup");
659

660
	/*
661
	 * If someone wakes us between LWLockRelease and PGSemaphoreLock,
B
Bruce Momjian 已提交
662
	 * PGSemaphoreLock will not block.	The wakeup is "saved" by the
663
	 * semaphore implementation.  Note also that if CheckDeadLock is
664
	 * invoked but does not detect a deadlock, PGSemaphoreLock() will
665 666
	 * continue to wait.  There used to be a loop here, but it was useless
	 * code...
667 668 669 670 671 672
	 *
	 * 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 state-change work to do after
	 * being granted the lock (the grantor did it all).
673
	 */
674
	PGSemaphoreLock(&MyProc->sem, true);
675

676
	/*
677
	 * Disable the timer, if it's still running
B
Bruce Momjian 已提交
678
	 */
679
	if (!disable_sig_alarm(false))
680
		elog(FATAL, "ProcSleep: Unable to disable timer for process wakeup");
B
Bruce Momjian 已提交
681

682 683 684 685 686
	/*
	 * Now there is nothing for LockWaitCancel to do.
	 */
	waitingForLock = false;

687
	/*
688
	 * Re-acquire the locktable's masterLock.
689
	 */
690
	LWLockAcquire(masterLock, LW_EXCLUSIVE);
691

692 693 694 695
	/*
	 * We don't have to do anything else, because the awaker did all the
	 * necessary update of the lock table and MyProc.
	 */
696
	return MyProc->errType;
697 698 699 700 701 702
}


/*
 * ProcWakeup -- wake up a process by releasing its private semaphore.
 *
703
 *	 Also remove the process from the wait queue and set its links invalid.
704
 *	 RETURN: the next process in the wait queue.
705 706 707 708
 *
 * 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.
709
 */
J
Jan Wieck 已提交
710 711
PGPROC *
ProcWakeup(PGPROC *proc, int errType)
712
{
J
Jan Wieck 已提交
713
	PGPROC	   *retProc;
714

715
	/* assume that masterLock has been acquired */
716

717
	/* Proc should be sleeping ... */
718 719
	if (proc->links.prev == INVALID_OFFSET ||
		proc->links.next == INVALID_OFFSET)
J
Jan Wieck 已提交
720
		return (PGPROC *) NULL;
721

722
	/* Save next process before we zap the list link */
J
Jan Wieck 已提交
723
	retProc = (PGPROC *) MAKE_PTR(proc->links.next);
724

725
	/* Remove process from wait queue */
726
	SHMQueueDelete(&(proc->links));
727
	(proc->waitLock->waitProcs.size)--;
728

729 730 731
	/* Clean up process' state and pass it the ok/fail signal */
	proc->waitLock = NULL;
	proc->waitHolder = NULL;
732 733
	proc->errType = errType;

734
	/* And awaken it */
735
	PGSemaphoreUnlock(&proc->sem);
736 737

	return retProc;
738 739 740 741
}

/*
 * ProcLockWakeup -- routine for waking up processes when a lock is
742 743
 *		released (or a prior waiter is aborted).  Scan all waiters
 *		for lock, waken any that are no longer blocked.
744
 */
745 746
void
ProcLockWakeup(LOCKMETHODTABLE *lockMethodTable, LOCK *lock)
747
{
748 749
	PROC_QUEUE *waitQueue = &(lock->waitProcs);
	int			queue_size = waitQueue->size;
J
Jan Wieck 已提交
750
	PGPROC	   *proc;
751
	int			aheadRequests = 0;
M
 
Marc G. Fournier 已提交
752

753
	Assert(queue_size >= 0);
754

755 756
	if (queue_size == 0)
		return;
757

J
Jan Wieck 已提交
758
	proc = (PGPROC *) MAKE_PTR(waitQueue->links.next);
759

760 761
	while (queue_size-- > 0)
	{
B
Bruce Momjian 已提交
762
		LOCKMODE	lockmode = proc->waitLockMode;
M
 
Marc G. Fournier 已提交
763 764

		/*
765 766
		 * Waken if (a) doesn't conflict with requests of earlier waiters,
		 * and (b) doesn't conflict with already-held locks.
M
 
Marc G. Fournier 已提交
767
		 */
B
Bruce Momjian 已提交
768
		if ((lockMethodTable->conflictTab[lockmode] & aheadRequests) == 0 &&
769 770 771 772 773 774
			LockCheckConflicts(lockMethodTable,
							   lockmode,
							   lock,
							   proc->waitHolder,
							   proc,
							   NULL) == STATUS_OK)
M
 
Marc G. Fournier 已提交
775
		{
776 777 778
			/* OK to waken */
			GrantLock(lock, proc->waitHolder, lockmode);
			proc = ProcWakeup(proc, STATUS_OK);
B
Bruce Momjian 已提交
779

780
			/*
B
Bruce Momjian 已提交
781 782 783
			 * 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.
784
			 */
M
 
Marc G. Fournier 已提交
785
		}
786
		else
787
		{
B
Bruce Momjian 已提交
788 789 790 791
			/*
			 * Cannot wake this guy. Remember his request for later
			 * checks.
			 */
792
			aheadRequests |= (1 << lockmode);
J
Jan Wieck 已提交
793
			proc = (PGPROC *) MAKE_PTR(proc->links.next);
794
		}
M
 
Marc G. Fournier 已提交
795
	}
796 797

	Assert(waitQueue->size >= 0);
798 799 800
}

/* --------------------
801
 * We only get to this routine if we got SIGALRM after DeadlockTimeout
802 803 804 805
 * 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.
 * If we have a real deadlock, remove ourselves from the lock's wait queue
 * and signal an error to ProcSleep.
806 807
 * --------------------
 */
808
static void
809
CheckDeadLock(void)
810
{
811
	/*
812 813
	 * Acquire locktable lock.	Note that the deadlock check interrupt had
	 * better not be enabled anywhere that this process itself holds the
814
	 * locktable lock, else this will wait forever.  Also note that
815 816
	 * LWLockAcquire creates a critical section, so that this routine
	 * cannot be interrupted by cancel/die interrupts.
817
	 */
818
	LWLockAcquire(LockMgrLock, LW_EXCLUSIVE);
819

820
	/*
821 822 823
	 * Check to see if we've been awoken by anyone in the interim.
	 *
	 * If we have we can return and resume our transaction -- happy day.
824 825
	 * Before we are awoken the process releasing the lock grants it to us
	 * so we know that we don't have to wait anymore.
826
	 *
827
	 * We check by looking to see if we've been unlinked from the wait queue.
828 829 830
	 * This is quicker than checking our semaphore's state, since no
	 * kernel call is needed, and it is safe because we hold the locktable
	 * lock.
831 832 833 834
	 */
	if (MyProc->links.prev == INVALID_OFFSET ||
		MyProc->links.next == INVALID_OFFSET)
	{
835
		LWLockRelease(LockMgrLock);
836 837 838
		return;
	}

839
#ifdef LOCK_DEBUG
B
Bruce Momjian 已提交
840 841
	if (Debug_deadlocks)
		DumpAllLocks();
842 843
#endif

844
	if (!DeadLockCheck(MyProc))
B
Bruce Momjian 已提交
845
	{
846
		/* No deadlock, so keep waiting */
847
		LWLockRelease(LockMgrLock);
B
Bruce Momjian 已提交
848 849 850
		return;
	}

851
	/*
852 853 854
	 * Oops.  We have a deadlock.
	 *
	 * Get this process out of wait state.
855
	 */
856 857
	RemoveFromWaitQueue(MyProc);

858 859
	/*
	 * Set MyProc->errType to STATUS_ERROR so that ProcSleep will report
860
	 * an error after we return from the signal handler.
861 862
	 */
	MyProc->errType = STATUS_ERROR;
863

864 865 866
	/*
	 * Unlock my semaphore so that the interrupted ProcSleep() call can
	 * finish.
867
	 */
868
	PGSemaphoreUnlock(&MyProc->sem);
869

870 871 872 873 874 875 876 877 878
	/*
	 * 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.
879
	 */
880
	LWLockRelease(LockMgrLock);
881 882 883
}


884 885 886 887 888 889 890 891 892 893 894 895
/*
 * 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
 * before we actually reach the waiting state.
 */
void
ProcWaitForSignal(void)
{
	waitingForSignal = true;
896
	PGSemaphoreLock(&MyProc->sem, true);
897 898 899 900 901 902 903 904 905 906 907 908 909
	waitingForSignal = false;
}

/*
 * ProcCancelWaitForSignal - clean up an aborted wait for signal
 *
 * We need this in case the signal arrived after we aborted waiting,
 * or if it arrived but we never reached ProcWaitForSignal() at all.
 * Caller should call this after resetting the signal request status.
 */
void
ProcCancelWaitForSignal(void)
{
910
	PGSemaphoreReset(&MyProc->sem);
911 912 913 914 915 916 917 918 919
	waitingForSignal = false;
}

/*
 * ProcSendSignal - send a signal to a backend identified by BackendId
 */
void
ProcSendSignal(BackendId procId)
{
J
Jan Wieck 已提交
920
	PGPROC	   *proc = BackendIdGetProc(procId);
921 922

	if (proc != NULL)
923
		PGSemaphoreUnlock(&proc->sem);
924 925 926
}


927 928 929 930 931 932 933 934 935
/*****************************************************************************
 * SIGALRM interrupt support
 *
 * Maybe these should be in pqsignal.c?
 *****************************************************************************/

/*
 * Enable the SIGALRM interrupt to fire after the specified delay
 *
936
 * Delay is given in milliseconds.	Caller should be sure a SIGALRM
937 938
 * signal handler is installed before this is called.
 *
939 940
 * This code properly handles nesting of deadlock timeout alarms within
 * statement timeout alarms.
941
 *
942 943 944
 * Returns TRUE if okay, FALSE on failure.
 */
bool
945
enable_sig_alarm(int delayms, bool is_statement_timeout)
946
{
947
	struct timeval fin_time;
948
#ifndef __BEOS__
949
	struct itimerval timeval;
950
#else
951
	bigtime_t	time_interval;
952
#endif
953

954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000
	/* Compute target timeout time if we will need it */
	if (is_statement_timeout || statement_timeout_active)
	{
		gettimeofday(&fin_time, NULL);
		fin_time.tv_sec += delayms / 1000;
		fin_time.tv_usec += (delayms % 1000) * 1000;
		if (fin_time.tv_usec >= 1000000)
		{
			fin_time.tv_sec++;
			fin_time.tv_usec -= 1000000;
		}
	}

	if (is_statement_timeout)
	{
		/* Begin statement-level timeout */
		Assert(!deadlock_timeout_active);
		statement_fin_time = fin_time;
		statement_timeout_active = true;
	}
	else if (statement_timeout_active)
	{
		/*
		 * Begin deadlock timeout with statement-level timeout active
		 *
		 * 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.
		 *
		 * NOTE: in this case it is possible that this routine will be
		 * interrupted by the previously-set timer alarm.  This is okay
		 * 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.
		 */
		deadlock_timeout_active = true;
		if (fin_time.tv_sec > statement_fin_time.tv_sec ||
			(fin_time.tv_sec == statement_fin_time.tv_sec &&
			 fin_time.tv_usec >= statement_fin_time.tv_usec))
			return true;
	}
	else
	{
		/* Begin deadlock timeout with no statement-level timeout */
		deadlock_timeout_active = true;
	}
1001

1002
	/* If we reach here, okay to set the timer interrupt */
1003
#ifndef __BEOS__
1004 1005 1006
	MemSet(&timeval, 0, sizeof(struct itimerval));
	timeval.it_value.tv_sec = delayms / 1000;
	timeval.it_value.tv_usec = (delayms % 1000) * 1000;
1007
	if (setitimer(ITIMER_REAL, &timeval, NULL))
1008 1009 1010
		return false;
#else
	/* BeOS doesn't have setitimer, but has set_alarm */
1011
	time_interval = delayms * 1000;		/* usecs */
1012
	if (set_alarm(time_interval, B_ONE_SHOT_RELATIVE_ALARM) < 0)
1013 1014 1015
		return false;
#endif

1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036
	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)
1037 1038
	{
#ifndef __BEOS__
1039
		struct itimerval timeval;
1040

1041 1042
		MemSet(&timeval, 0, sizeof(struct itimerval));
		if (setitimer(ITIMER_REAL, &timeval, NULL))
1043
		{
1044 1045 1046
			statement_timeout_active = deadlock_timeout_active = false;
			return false;
		}
1047
#else
1048 1049 1050 1051 1052
		/* BeOS doesn't have setitimer, but has set_alarm */
		if (set_alarm(B_INFINITE_TIMEOUT, B_PERIODIC_ALARM) < 0)
		{
			statement_timeout_active = deadlock_timeout_active = false;
			return false;
1053
		}
1054
#endif
1055 1056
	}

1057 1058 1059 1060
	/* Always cancel deadlock timeout, in case this is error cleanup */
	deadlock_timeout_active = false;

	/* Cancel or reschedule statement timeout */
1061
	if (is_statement_timeout)
1062 1063 1064 1065 1066 1067
		statement_timeout_active = false;
	else if (statement_timeout_active)
	{
		if (!CheckStatementTimeout())
			return false;
	}
1068

1069 1070 1071
	return true;
}

1072

1073
/*
1074 1075 1076
 * 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.
1077
 *
1078
 * Returns true if okay, false if failed to set the interrupt.
1079
 */
1080 1081
static bool
CheckStatementTimeout(void)
1082
{
1083
	struct timeval now;
B
Bruce Momjian 已提交
1084

1085 1086 1087 1088
	if (!statement_timeout_active)
		return true;			/* do nothing if not active */

	gettimeofday(&now, NULL);
1089

1090 1091 1092
	if (now.tv_sec > statement_fin_time.tv_sec ||
		(now.tv_sec == statement_fin_time.tv_sec &&
		 now.tv_usec >= statement_fin_time.tv_usec))
1093
	{
1094 1095 1096 1097 1098 1099 1100
		/* Time to die */
		statement_timeout_active = false;
		kill(MyProcPid, SIGINT);
	}
	else
	{
		/* Not time yet, so (re)schedule the interrupt */
1101
#ifndef __BEOS__
1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112
		struct itimerval timeval;

		MemSet(&timeval, 0, sizeof(struct itimerval));
		timeval.it_value.tv_sec = statement_fin_time.tv_sec - now.tv_sec;
		timeval.it_value.tv_usec = statement_fin_time.tv_usec - now.tv_usec;
		if (timeval.it_value.tv_usec < 0)
		{
			timeval.it_value.tv_sec--;
			timeval.it_value.tv_usec += 1000000;
		}
		if (setitimer(ITIMER_REAL, &timeval, NULL))
1113 1114 1115
			return false;
#else
		/* BeOS doesn't have setitimer, but has set_alarm */
1116
		bigtime_t	time_interval;
B
Bruce Momjian 已提交
1117

1118 1119 1120 1121
		time_interval =
			(statement_fin_time.tv_sec - now.tv_sec) * 1000000 +
			(statement_fin_time.tv_usec - now.tv_usec);
		if (set_alarm(time_interval, B_ONE_SHOT_RELATIVE_ALARM) < 0)
1122 1123 1124 1125
			return false;
#endif
	}

1126 1127
	return true;
}
1128 1129 1130


/*
1131 1132 1133 1134 1135 1136
 * Signal handler for SIGALRM
 *
 * 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.
1137 1138 1139 1140
 */
void
handle_sig_alarm(SIGNAL_ARGS)
{
1141 1142 1143
	int			save_errno = errno;

	if (deadlock_timeout_active)
1144
	{
1145
		deadlock_timeout_active = false;
1146 1147
		CheckDeadLock();
	}
1148 1149 1150 1151 1152

	if (statement_timeout_active)
		(void) CheckStatementTimeout();

	errno = save_errno;
1153
}