proc.c 32.2 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-2003, 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.134 2003/10/11 16:30:55 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
/* 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;
B
Bruce Momjian 已提交
81

82 83 84 85
/* statement_fin_time is valid only if statement_timeout_active is true */
static struct timeval statement_fin_time;


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

V
Vadim B. Mikheev 已提交
90

91 92 93 94 95 96 97 98 99 100
/*
 * 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;
}

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

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

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

140
		ProcGlobal->freeProcs = INVALID_OFFSET;
141

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

J
Jan Wieck 已提交
150
			proc = (PGPROC *) ShmemAlloc(sizeof(PGPROC));
151
			if (!proc)
152 153 154
				ereport(FATAL,
						(errcode(ERRCODE_OUT_OF_MEMORY),
						 errmsg("out of memory")));
J
Jan Wieck 已提交
155
			MemSet(proc, 0, sizeof(PGPROC));
156 157 158
			PGSemaphoreCreate(&proc->sem);
			proc->links.next = ProcGlobal->freeProcs;
			ProcGlobal->freeProcs = MAKE_OFFSET(proc);
159
		}
160 161

		/*
B
Bruce Momjian 已提交
162 163 164
		 * Pre-allocate a PGPROC structure for dummy (checkpoint)
		 * processes, too.	This does not get linked into the freeProcs
		 * list.
165
		 */
J
Jan Wieck 已提交
166
		DummyProc = (PGPROC *) ShmemAlloc(sizeof(PGPROC));
167
		if (!DummyProc)
168 169 170
			ereport(FATAL,
					(errcode(ERRCODE_OUT_OF_MEMORY),
					 errmsg("out of memory")));
J
Jan Wieck 已提交
171
		MemSet(DummyProc, 0, sizeof(PGPROC));
172
		DummyProc->pid = 0;		/* marks DummyProc as not in use */
173
		PGSemaphoreCreate(&DummyProc->sem);
174 175 176 177

		/* Create ProcStructLock spinlock, too */
		ProcStructLock = (slock_t *) ShmemAlloc(sizeof(slock_t));
		SpinLockInit(ProcStructLock);
178 179 180
	}
}

181
/*
182
 * InitProcess -- initialize a per-process data structure for this backend
183 184
 */
void
185
InitProcess(void)
186
{
187
	SHMEM_OFFSET myOffset;
B
Bruce Momjian 已提交
188

189 190
	/* use volatile pointer to prevent code rearrangement */
	volatile PROC_HDR *procglobal = ProcGlobal;
191 192

	/*
193 194
	 * ProcGlobal should be set by a previous call to InitProcGlobal (if
	 * we are a backend, we inherit this by fork() from the postmaster).
195
	 */
196
	if (procglobal == NULL)
197
		elog(PANIC, "proc header uninitialized");
198 199

	if (MyProc != NULL)
200
		elog(ERROR, "you already exist");
201

202
	/*
B
Bruce Momjian 已提交
203 204
	 * Try to get a proc struct from the free list.  If this fails, we
	 * must be out of PGPROC structures (not to mention semaphores).
205
	 */
206
	SpinLockAcquire(ProcStructLock);
207

208
	myOffset = procglobal->freeProcs;
209 210

	if (myOffset != INVALID_OFFSET)
211
	{
J
Jan Wieck 已提交
212
		MyProc = (PGPROC *) MAKE_PTR(myOffset);
213
		procglobal->freeProcs = MyProc->links.next;
214
		SpinLockRelease(ProcStructLock);
215 216 217 218
	}
	else
	{
		/*
J
Jan Wieck 已提交
219
		 * If we reach here, all the PGPROCs are in use.  This is one of
220 221
		 * the possible places to detect "too many backends", so give the
		 * standard error message.
222
		 */
223
		SpinLockRelease(ProcStructLock);
224 225 226
		ereport(FATAL,
				(errcode(ERRCODE_TOO_MANY_CONNECTIONS),
				 errmsg("sorry, too many clients already")));
227
	}
228

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

247
	/*
248
	 * Arrange to clean up at backend exit.
249
	 */
250
	on_shmem_exit(ProcKill, 0);
251

252
	/*
253
	 * We might be reusing a semaphore that belonged to a failed process.
254 255
	 * So be careful and reinitialize its value here.
	 */
256
	PGSemaphoreReset(&MyProc->sem);
257

258
	/*
J
Jan Wieck 已提交
259
	 * Now that we have a PGPROC, we could try to acquire locks, so
B
Bruce Momjian 已提交
260
	 * initialize the deadlock checker.
261 262
	 */
	InitDeadLockChecking();
263 264
}

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

	if (MyProc != NULL)
283
		elog(ERROR, "you already exist");
284 285 286 287 288

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

	/*
293 294
	 * Initialize all fields of MyProc, except MyProc->sem which was set
	 * up by InitProcGlobal.
295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318
	 */
	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.
	 */
319
	PGSemaphoreReset(&MyProc->sem);
320 321
}

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

338 339 340
	waitingForLock = false;

	/* Turn off the deadlock timer, if it's still running (see ProcSleep) */
341
	disable_sig_alarm(false);
342 343

	/* Unlink myself from the wait queue, if on it (might not be anymore!) */
344
	LWLockAcquire(LockMgrLock, LW_EXCLUSIVE);
345 346
	if (MyProc->links.next != INVALID_OFFSET)
		RemoveFromWaitQueue(MyProc);
347
	LWLockRelease(LockMgrLock);
H
Hiroshi Inoue 已提交
348

349 350 351
	/*
	 * 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 已提交
352 353 354 355 356
	 * 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.
357
	 */
358
	PGSemaphoreReset(&MyProc->sem);
359 360

	/*
B
Bruce Momjian 已提交
361 362
	 * Return true even if we were kicked off the lock before we were able
	 * to remove ourselves.
363 364
	 */
	return true;
H
Hiroshi Inoue 已提交
365
}
366

367

368
/*
369 370 371 372 373 374 375 376
 * 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.
377
 *
378
 * Note that user locks are not released in either case.
379 380
 */
void
381
ProcReleaseLocks(bool isCommit)
382
{
383 384
	if (!MyProc)
		return;
385 386 387
	/* If waiting, get off wait queue (should only be needed after error) */
	LockWaitCancel();
	/* Release locks */
388 389
	LockReleaseAll(DEFAULT_LOCKMETHOD, MyProc,
				   !isCommit, GetCurrentTransactionId());
390 391 392 393 394
}


/*
 * ProcKill() -- Destroy the per-proc data structure for
395
 *		this process. Release any of its held LW locks.
396 397
 */
static void
398
ProcKill(void)
399
{
400 401 402
	/* use volatile pointer to prevent code rearrangement */
	volatile PROC_HDR *procglobal = ProcGlobal;

403
	Assert(MyProc != NULL);
404

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

408 409 410 411 412 413
	/*
	 * 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.
	 */
414
	AbortBufferIO();
415 416
	UnlockBuffers();
	AtEOXact_Buffers(false);
417

418 419
	/* Get off any wait queue I might be on */
	LockWaitCancel();
420

421
	/* Remove from the standard lock table */
422
	LockReleaseAll(DEFAULT_LOCKMETHOD, MyProc, true, InvalidTransactionId);
423

424 425
#ifdef USER_LOCKS
	/* Remove from the user lock table */
426
	LockReleaseAll(USER_LOCKMETHOD, MyProc, true, InvalidTransactionId);
427
#endif
428

429
	SpinLockAcquire(ProcStructLock);
430

J
Jan Wieck 已提交
431
	/* Return PGPROC structure (and semaphore) to freelist */
432 433
	MyProc->links.next = procglobal->freeProcs;
	procglobal->freeProcs = MAKE_OFFSET(MyProc);
434

J
Jan Wieck 已提交
435
	/* PGPROC struct isn't mine anymore */
436
	MyProc = NULL;
437

438 439 440 441 442
	SpinLockRelease(ProcStructLock);
}

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

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

454
	/* Release buffer locks and pins, too */
455
	AbortBufferIO();
456 457
	UnlockBuffers();
	AtEOXact_Buffers(false);
458 459 460 461 462 463

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

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

J
Jan Wieck 已提交
464
	/* PGPROC struct isn't mine anymore */
465
	MyProc = NULL;
466 467
}

468

469 470
/*
 * ProcQueue package: routines for putting processes to sleep
471
 *		and  waking them up
472 473 474 475 476 477 478 479
 */

/*
 * 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
 */
480
#ifdef NOT_USED
481
PROC_QUEUE *
482 483
ProcQueueAlloc(char *name)
{
484 485
	bool		found;
	PROC_QUEUE *queue = (PROC_QUEUE *)
B
Bruce Momjian 已提交
486
	ShmemInitStruct(name, sizeof(PROC_QUEUE), &found);
487 488

	if (!queue)
489
		return NULL;
490 491
	if (!found)
		ProcQueueInit(queue);
492
	return queue;
493
}
494
#endif
495 496 497 498 499

/*
 * ProcQueueInit -- initialize a shared memory process queue
 */
void
500
ProcQueueInit(PROC_QUEUE *queue)
501
{
502 503
	SHMQueueInit(&(queue->links));
	queue->size = 0;
504 505 506 507 508 509
}


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

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

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

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

614 615 616
	/*
	 * Insert self into queue, ahead of the given proc (or at tail of
	 * queue).
617
	 */
618
	SHMQueueInsertBefore(&(proc->links), &(MyProc->links));
B
Bruce Momjian 已提交
619
	waitQueue->size++;
620

621
	lock->waitMask |= (1 << lockmode);
622

J
Jan Wieck 已提交
623
	/* Set up wait information in PGPROC object, too */
624
	MyProc->waitLock = lock;
625
	MyProc->waitHolder = proclock;
626 627
	MyProc->waitLockMode = lockmode;

628
	MyProc->errType = STATUS_OK;	/* initialize result for success */
629 630 631

	/*
	 * If we detected deadlock, give up without waiting.  This must agree
632
	 * with CheckDeadLock's recovery code, except that we shouldn't
633
	 * release the semaphore since we haven't tried to lock it yet.
634 635 636 637 638 639 640
	 */
	if (early_deadlock)
	{
		RemoveFromWaitQueue(MyProc);
		MyProc->errType = STATUS_ERROR;
		return STATUS_ERROR;
	}
641

642 643 644
	/* mark that we are waiting for a lock */
	waitingForLock = true;

645
	/*
646
	 * Release the locktable's masterLock.
647
	 *
648 649 650 651
	 * 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.
652
	 */
653
	LWLockRelease(masterLock);
654

655
	/*
656 657 658 659 660 661 662
	 * 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.
663
	 */
664
	if (!enable_sig_alarm(DeadlockTimeout, false))
665
		elog(FATAL, "could not set timer for process wakeup");
666

667
	/*
668
	 * If someone wakes us between LWLockRelease and PGSemaphoreLock,
B
Bruce Momjian 已提交
669
	 * PGSemaphoreLock will not block.	The wakeup is "saved" by the
670
	 * semaphore implementation.  Note also that if CheckDeadLock is
671
	 * invoked but does not detect a deadlock, PGSemaphoreLock() will
672 673
	 * continue to wait.  There used to be a loop here, but it was useless
	 * code...
674 675 676 677 678 679
	 *
	 * 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).
680
	 */
681
	PGSemaphoreLock(&MyProc->sem, true);
682

683
	/*
684
	 * Disable the timer, if it's still running
B
Bruce Momjian 已提交
685
	 */
686
	if (!disable_sig_alarm(false))
687
		elog(FATAL, "could not disable timer for process wakeup");
B
Bruce Momjian 已提交
688

689 690 691 692 693
	/*
	 * Now there is nothing for LockWaitCancel to do.
	 */
	waitingForLock = false;

694
	/*
695
	 * Re-acquire the locktable's masterLock.
696
	 */
697
	LWLockAcquire(masterLock, LW_EXCLUSIVE);
698

699 700 701 702
	/*
	 * We don't have to do anything else, because the awaker did all the
	 * necessary update of the lock table and MyProc.
	 */
703
	return MyProc->errType;
704 705 706 707 708 709
}


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

722
	/* assume that masterLock has been acquired */
723

724
	/* Proc should be sleeping ... */
725 726
	if (proc->links.prev == INVALID_OFFSET ||
		proc->links.next == INVALID_OFFSET)
J
Jan Wieck 已提交
727
		return (PGPROC *) NULL;
728

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

732
	/* Remove process from wait queue */
733
	SHMQueueDelete(&(proc->links));
734
	(proc->waitLock->waitProcs.size)--;
735

736 737 738
	/* Clean up process' state and pass it the ok/fail signal */
	proc->waitLock = NULL;
	proc->waitHolder = NULL;
739 740
	proc->errType = errType;

741
	/* And awaken it */
742
	PGSemaphoreUnlock(&proc->sem);
743 744

	return retProc;
745 746 747 748
}

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

760
	Assert(queue_size >= 0);
761

762 763
	if (queue_size == 0)
		return;
764

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

767 768
	while (queue_size-- > 0)
	{
B
Bruce Momjian 已提交
769
		LOCKMODE	lockmode = proc->waitLockMode;
M
 
Marc G. Fournier 已提交
770 771

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

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

	Assert(waitQueue->size >= 0);
805 806 807
}

/* --------------------
808
 * We only get to this routine if we got SIGALRM after DeadlockTimeout
809 810 811 812
 * 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.
813 814
 * --------------------
 */
815
static void
816
CheckDeadLock(void)
817
{
818
	/*
819 820
	 * Acquire locktable lock.	Note that the deadlock check interrupt had
	 * better not be enabled anywhere that this process itself holds the
821
	 * locktable lock, else this will wait forever.  Also note that
822 823
	 * LWLockAcquire creates a critical section, so that this routine
	 * cannot be interrupted by cancel/die interrupts.
824
	 */
825
	LWLockAcquire(LockMgrLock, LW_EXCLUSIVE);
826

827
	/*
828 829 830
	 * 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.
831 832
	 * Before we are awoken the process releasing the lock grants it to us
	 * so we know that we don't have to wait anymore.
833
	 *
834
	 * We check by looking to see if we've been unlinked from the wait queue.
835 836 837
	 * 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.
838 839 840 841
	 */
	if (MyProc->links.prev == INVALID_OFFSET ||
		MyProc->links.next == INVALID_OFFSET)
	{
842
		LWLockRelease(LockMgrLock);
843 844 845
		return;
	}

846
#ifdef LOCK_DEBUG
B
Bruce Momjian 已提交
847 848
	if (Debug_deadlocks)
		DumpAllLocks();
849 850
#endif

851
	if (!DeadLockCheck(MyProc))
B
Bruce Momjian 已提交
852
	{
853
		/* No deadlock, so keep waiting */
854
		LWLockRelease(LockMgrLock);
B
Bruce Momjian 已提交
855 856 857
		return;
	}

858
	/*
859 860 861
	 * Oops.  We have a deadlock.
	 *
	 * Get this process out of wait state.
862
	 */
863 864
	RemoveFromWaitQueue(MyProc);

865 866
	/*
	 * Set MyProc->errType to STATUS_ERROR so that ProcSleep will report
867
	 * an error after we return from the signal handler.
868 869
	 */
	MyProc->errType = STATUS_ERROR;
870

871 872 873
	/*
	 * Unlock my semaphore so that the interrupted ProcSleep() call can
	 * finish.
874
	 */
875
	PGSemaphoreUnlock(&MyProc->sem);
876

877 878 879 880 881 882 883 884 885
	/*
	 * 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.
886
	 */
887
	LWLockRelease(LockMgrLock);
888 889 890
}


891 892 893 894 895 896 897 898 899 900 901 902
/*
 * 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;
903
	PGSemaphoreLock(&MyProc->sem, true);
904 905 906 907 908 909 910 911 912 913 914 915 916
	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)
{
917
	PGSemaphoreReset(&MyProc->sem);
918 919 920 921 922 923 924 925 926
	waitingForSignal = false;
}

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

	if (proc != NULL)
930
		PGSemaphoreUnlock(&proc->sem);
931 932 933
}


934 935 936 937 938 939 940 941 942
/*****************************************************************************
 * SIGALRM interrupt support
 *
 * Maybe these should be in pqsignal.c?
 *****************************************************************************/

/*
 * Enable the SIGALRM interrupt to fire after the specified delay
 *
943
 * Delay is given in milliseconds.	Caller should be sure a SIGALRM
944 945
 * signal handler is installed before this is called.
 *
946 947
 * This code properly handles nesting of deadlock timeout alarms within
 * statement timeout alarms.
948
 *
949 950 951
 * Returns TRUE if okay, FALSE on failure.
 */
bool
952
enable_sig_alarm(int delayms, bool is_statement_timeout)
953
{
954
#ifdef WIN32
B
Bruce Momjian 已提交
955
#warning add Win32 timer
956
#else
957
	struct timeval fin_time;
B
Bruce Momjian 已提交
958

959
#ifndef __BEOS__
960
	struct itimerval timeval;
B
Bruce Momjian 已提交
961

962
#else
963
	bigtime_t	time_interval;
964
#endif
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
	/* 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
		 *
B
Bruce Momjian 已提交
991 992 993 994
		 * 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.
995 996 997
		 *
		 * 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 已提交
998 999 1000
		 * 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.
1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012
		 */
		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;
	}
1013

1014
	/* If we reach here, okay to set the timer interrupt */
1015
#ifndef __BEOS__
1016
	MemSet((void *)&timeval, 0, sizeof(struct itimerval));
1017 1018
	timeval.it_value.tv_sec = delayms / 1000;
	timeval.it_value.tv_usec = (delayms % 1000) * 1000;
1019
	if (setitimer(ITIMER_REAL, &timeval, NULL))
1020 1021 1022
		return false;
#else
	/* BeOS doesn't have setitimer, but has set_alarm */
1023
	time_interval = delayms * 1000;		/* usecs */
1024
	if (set_alarm(time_interval, B_ONE_SHOT_RELATIVE_ALARM) < 0)
1025 1026
		return false;
#endif
1027
#endif
1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040
	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)
{
1041 1042 1043
#ifdef WIN32
#warning add Win32 timer
#else
B
Bruce Momjian 已提交
1044

1045 1046 1047 1048 1049 1050 1051 1052
	/*
	 * 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)
1053 1054
	{
#ifndef __BEOS__
1055
		struct itimerval timeval;
1056

1057
		MemSet((void *)&timeval, 0, sizeof(struct itimerval));
1058
		if (setitimer(ITIMER_REAL, &timeval, NULL))
1059
		{
1060 1061 1062
			statement_timeout_active = deadlock_timeout_active = false;
			return false;
		}
1063
#else
1064 1065 1066 1067 1068
		/* 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;
1069
		}
1070
#endif
1071 1072
	}

1073 1074 1075 1076
	/* Always cancel deadlock timeout, in case this is error cleanup */
	deadlock_timeout_active = false;

	/* Cancel or reschedule statement timeout */
1077
	if (is_statement_timeout)
1078 1079 1080 1081 1082 1083
		statement_timeout_active = false;
	else if (statement_timeout_active)
	{
		if (!CheckStatementTimeout())
			return false;
	}
1084
#endif
1085 1086 1087
	return true;
}

1088

1089
/*
1090 1091 1092
 * 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.
1093
 *
1094
 * Returns true if okay, false if failed to set the interrupt.
1095
 */
1096 1097
static bool
CheckStatementTimeout(void)
1098
{
1099
	struct timeval now;
B
Bruce Momjian 已提交
1100

1101 1102 1103 1104
	if (!statement_timeout_active)
		return true;			/* do nothing if not active */

	gettimeofday(&now, NULL);
1105

1106 1107 1108
	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))
1109
	{
1110 1111 1112 1113 1114 1115 1116
		/* Time to die */
		statement_timeout_active = false;
		kill(MyProcPid, SIGINT);
	}
	else
	{
		/* Not time yet, so (re)schedule the interrupt */
1117 1118 1119
#ifdef WIN32
#warning add win32 timer
#else
1120
#ifndef __BEOS__
1121 1122
		struct itimerval timeval;

1123
		MemSet((void *)&timeval, 0, sizeof(struct itimerval));
1124 1125 1126 1127 1128 1129 1130 1131
		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))
1132 1133 1134
			return false;
#else
		/* BeOS doesn't have setitimer, but has set_alarm */
1135
		bigtime_t	time_interval;
B
Bruce Momjian 已提交
1136

1137 1138 1139 1140
		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)
1141
			return false;
1142
#endif
1143 1144 1145
#endif
	}

1146 1147
	return true;
}
1148 1149 1150


/*
1151 1152 1153 1154 1155 1156
 * 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.
1157 1158 1159 1160
 */
void
handle_sig_alarm(SIGNAL_ARGS)
{
1161 1162 1163
	int			save_errno = errno;

	if (deadlock_timeout_active)
1164
	{
1165
		deadlock_timeout_active = false;
1166 1167
		CheckDeadLock();
	}
1168 1169 1170 1171 1172

	if (statement_timeout_active)
		(void) CheckStatementTimeout();

	errno = save_errno;
1173
}