proc.c 32.7 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
 *	  $PostgreSQL: pgsql/src/backend/storage/lmgr/proc.c,v 1.142 2003/12/21 00:33:33 tgl 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
NON_EXEC_STATIC slock_t *ProcStructLock = NULL;
70 71 72

static PROC_HDR *ProcGlobal = NULL;

J
Jan Wieck 已提交
73
static PGPROC *DummyProc = NULL;
J
Jan Wieck 已提交
74
static int	dummy_proc_type = -1;
75

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

79 80 81
/* 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 已提交
82

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


87 88
static void ProcKill(int code, Datum arg);
static void DummyProcKill(int code, Datum arg);
89
static bool CheckStatementTimeout(void);
90

V
Vadim B. Mikheev 已提交
91

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

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

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

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

141
		ProcGlobal->freeProcs = INVALID_OFFSET;
142

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

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

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

		/* Create ProcStructLock spinlock, too */
		ProcStructLock = (slock_t *) ShmemAlloc(sizeof(slock_t));
		SpinLockInit(ProcStructLock);
182 183 184
	}
}

185
/*
186
 * InitProcess -- initialize a per-process data structure for this backend
187 188
 */
void
189
InitProcess(void)
190
{
191
	SHMEM_OFFSET myOffset;
B
Bruce Momjian 已提交
192

193 194
	/* use volatile pointer to prevent code rearrangement */
	volatile PROC_HDR *procglobal = ProcGlobal;
195 196

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

	if (MyProc != NULL)
204
		elog(ERROR, "you already exist");
205

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

212
	myOffset = procglobal->freeProcs;
213 214

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

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

251

252
	/*
253
	 * Arrange to clean up at backend exit.
254
	 */
255
	on_shmem_exit(ProcKill, 0);
256

257
	/*
258
	 * We might be reusing a semaphore that belonged to a failed process.
259 260
	 * So be careful and reinitialize its value here.
	 */
261
	PGSemaphoreReset(&MyProc->sem);
262

263
	/*
J
Jan Wieck 已提交
264
	 * Now that we have a PGPROC, we could try to acquire locks, so
B
Bruce Momjian 已提交
265
	 * initialize the deadlock checker.
266 267
	 */
	InitDeadLockChecking();
268 269
}

270 271 272 273
/*
 * InitDummyProcess -- create a dummy per-process data structure
 *
 * This is called by checkpoint processes so that they will have a MyProc
J
Jan Wieck 已提交
274
 * value that's real enough to let them wait for LWLocks.  The PGPROC and
275 276 277
 * sema that are assigned are the extra ones created during InitProcGlobal.
 */
void
J
Jan Wieck 已提交
278
InitDummyProcess(int proctype)
279
{
J
Jan Wieck 已提交
280 281
	PGPROC	*dummyproc;

282
	/*
283 284
	 * ProcGlobal should be set by a previous call to InitProcGlobal (we
	 * inherit this by fork() from the postmaster).
285 286
	 */
	if (ProcGlobal == NULL || DummyProc == NULL)
287
		elog(PANIC, "proc header uninitialized");
288 289

	if (MyProc != NULL)
290
		elog(ERROR, "you already exist");
291

J
Jan Wieck 已提交
292 293 294 295
	Assert(dummy_proc_type < 0);
	dummy_proc_type = proctype;
	dummyproc = &DummyProc[proctype];

296
	/*
J
Jan Wieck 已提交
297
	 * dummyproc should not presently be in use by anyone else
298
	 */
J
Jan Wieck 已提交
299 300 301 302
	if (dummyproc->pid != 0)
		elog(FATAL, "DummyProc[%d] is in use by PID %d",
				proctype, dummyproc->pid);
	MyProc = dummyproc;
303 304

	/*
305 306
	 * Initialize all fields of MyProc, except MyProc->sem which was set
	 * up by InitProcGlobal.
307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324
	 */
	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.
	 */
J
Jan Wieck 已提交
325
	on_shmem_exit(DummyProcKill, proctype);
326 327 328 329 330

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

334 335 336
/*
 * Cancel any pending wait for lock, when aborting a transaction.
 *
337 338
 * Returns true if we had been waiting for a lock, else false.
 *
339
 * (Normally, this would only happen if we accept a cancel/die
340
 * interrupt while waiting; but an ereport(ERROR) while waiting is
341 342
 * within the realm of possibility, too.)
 */
343
bool
344 345 346 347
LockWaitCancel(void)
{
	/* Nothing to do if we weren't waiting for a lock */
	if (!waitingForLock)
348 349
		return false;

350 351 352
	waitingForLock = false;

	/* Turn off the deadlock timer, if it's still running (see ProcSleep) */
353
	disable_sig_alarm(false);
354 355

	/* Unlink myself from the wait queue, if on it (might not be anymore!) */
356
	LWLockAcquire(LockMgrLock, LW_EXCLUSIVE);
357 358
	if (MyProc->links.next != INVALID_OFFSET)
		RemoveFromWaitQueue(MyProc);
359
	LWLockRelease(LockMgrLock);
H
Hiroshi Inoue 已提交
360

361 362 363
	/*
	 * 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 已提交
364 365 366 367 368
	 * 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.
369
	 */
370
	PGSemaphoreReset(&MyProc->sem);
371 372

	/*
B
Bruce Momjian 已提交
373 374
	 * Return true even if we were kicked off the lock before we were able
	 * to remove ourselves.
375 376
	 */
	return true;
H
Hiroshi Inoue 已提交
377
}
378

379

380
/*
381 382 383 384 385 386 387 388
 * 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.
389
 *
390
 * Note that user locks are not released in either case.
391 392
 */
void
393
ProcReleaseLocks(bool isCommit)
394
{
395 396
	if (!MyProc)
		return;
397 398 399
	/* If waiting, get off wait queue (should only be needed after error) */
	LockWaitCancel();
	/* Release locks */
400 401
	LockReleaseAll(DEFAULT_LOCKMETHOD, MyProc,
				   !isCommit, GetCurrentTransactionId());
402 403 404 405 406
}


/*
 * ProcKill() -- Destroy the per-proc data structure for
407
 *		this process. Release any of its held LW locks.
408 409
 */
static void
410
ProcKill(int code, Datum arg)
411
{
412 413 414
	/* use volatile pointer to prevent code rearrangement */
	volatile PROC_HDR *procglobal = ProcGlobal;

415
	Assert(MyProc != NULL);
416

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

420 421 422 423 424 425
	/*
	 * 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.
	 */
426
	AbortBufferIO();
427 428
	UnlockBuffers();
	AtEOXact_Buffers(false);
429

430 431
	/* Get off any wait queue I might be on */
	LockWaitCancel();
432

433
	/* Remove from the standard lock table */
434
	LockReleaseAll(DEFAULT_LOCKMETHOD, MyProc, true, InvalidTransactionId);
435

436 437
#ifdef USER_LOCKS
	/* Remove from the user lock table */
438
	LockReleaseAll(USER_LOCKMETHOD, MyProc, true, InvalidTransactionId);
439
#endif
440

441
	SpinLockAcquire(ProcStructLock);
442

J
Jan Wieck 已提交
443
	/* Return PGPROC structure (and semaphore) to freelist */
444 445
	MyProc->links.next = procglobal->freeProcs;
	procglobal->freeProcs = MAKE_OFFSET(MyProc);
446

J
Jan Wieck 已提交
447
	/* PGPROC struct isn't mine anymore */
448
	MyProc = NULL;
449

450 451 452 453 454
	SpinLockRelease(ProcStructLock);
}

/*
 * DummyProcKill() -- Cut-down version of ProcKill for dummy (checkpoint)
J
Jan Wieck 已提交
455
 *		processes.	The PGPROC and sema are not released, only marked
456 457 458
 *		as not-in-use.
 */
static void
459
DummyProcKill(int code, Datum arg)
460
{
J
Jan Wieck 已提交
461 462 463 464 465 466 467
	PGPROC	*dummyproc;

	Assert(dummy_proc_type >= 0 && dummy_proc_type < NUM_DUMMY_PROCS);

	dummyproc = &DummyProc[dummy_proc_type];

	Assert(MyProc != NULL && MyProc == dummyproc);
468 469 470 471

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

472
	/* Release buffer locks and pins, too */
473
	AbortBufferIO();
474 475
	UnlockBuffers();
	AtEOXact_Buffers(false);
476 477 478 479 480 481

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

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

J
Jan Wieck 已提交
482
	/* PGPROC struct isn't mine anymore */
483
	MyProc = NULL;
J
Jan Wieck 已提交
484 485

	dummy_proc_type = -1;
486 487
}

488

489 490
/*
 * ProcQueue package: routines for putting processes to sleep
491
 *		and  waking them up
492 493 494 495 496 497 498 499
 */

/*
 * 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
 */
500
#ifdef NOT_USED
501
PROC_QUEUE *
502 503
ProcQueueAlloc(char *name)
{
504 505
	bool		found;
	PROC_QUEUE *queue = (PROC_QUEUE *)
B
Bruce Momjian 已提交
506
	ShmemInitStruct(name, sizeof(PROC_QUEUE), &found);
507 508

	if (!queue)
509
		return NULL;
510 511
	if (!found)
		ProcQueueInit(queue);
512
	return queue;
513
}
514
#endif
515 516 517 518 519

/*
 * ProcQueueInit -- initialize a shared memory process queue
 */
void
520
ProcQueueInit(PROC_QUEUE *queue)
521
{
522 523
	SHMQueueInit(&(queue->links));
	queue->size = 0;
524 525 526 527 528 529
}


/*
 * ProcSleep -- put a process to sleep
 *
530 531
 * Caller must have set MyProc->heldLocks to reflect locks already held
 * on the lockable object by this process (under all XIDs).
532
 *
533
 * Locktable's masterLock must be held at entry, and will be held
534
 * at exit.
535
 *
536
 * Result: STATUS_OK if we acquired the lock, STATUS_ERROR if not (deadlock).
537
 *
538
 * ASSUME: that no one will fiddle with the queue until after
539
 *		we release the masterLock.
540 541
 *
 * NOTES: The process queue is now a priority queue for locking.
542 543 544
 *
 * P() on the semaphore should put us to sleep.  The process
 * semaphore is normally zero, so when we try to acquire it, we sleep.
545 546
 */
int
547
ProcSleep(LockMethod lockMethodTable,
548 549
		  LOCKMODE lockmode,
		  LOCK *lock,
550
		  PROCLOCK *proclock)
551
{
B
Bruce Momjian 已提交
552
	LWLockId	masterLock = lockMethodTable->masterLock;
553
	PROC_QUEUE *waitQueue = &(lock->waitProcs);
554
	LOCKMASK	myHeldLocks = MyProc->heldLocks;
555
	bool		early_deadlock = false;
J
Jan Wieck 已提交
556
	PGPROC	   *proc;
557
	int			i;
558

559
	/*
560 561 562 563 564 565
	 * 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
566 567 568
	 * me to before that waiter anyway; but it's relatively cheap to
	 * detect such a conflict immediately, and avoid delaying till
	 * deadlock timeout.
569
	 *
570 571
	 * 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
572 573
	 * that waiter.  If not, then just grant myself the requested lock
	 * immediately.  This is the same as the test for immediate grant in
574 575
	 * LockAcquire, except we are only considering the part of the wait
	 * queue before my insertion point.
576 577
	 */
	if (myHeldLocks != 0)
V
Vadim B. Mikheev 已提交
578
	{
579
		LOCKMASK	aheadRequests = 0;
580

J
Jan Wieck 已提交
581
		proc = (PGPROC *) MAKE_PTR(waitQueue->links.next);
582
		for (i = 0; i < waitQueue->size; i++)
V
Vadim B. Mikheev 已提交
583
		{
584
			/* Must he wait for me? */
B
Bruce Momjian 已提交
585
			if (lockMethodTable->conflictTab[proc->waitLockMode] & myHeldLocks)
V
Vadim B. Mikheev 已提交
586
			{
587
				/* Must I wait for him ? */
B
Bruce Momjian 已提交
588
				if (lockMethodTable->conflictTab[lockmode] & proc->heldLocks)
589
				{
590
					/*
591 592 593 594
					 * 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 已提交
595 596
					 * loop.  Also, record deadlock info for later
					 * message.
597
					 */
598
					RememberSimpleDeadLock(MyProc, lockmode, lock, proc);
599 600
					early_deadlock = true;
					break;
601
				}
602
				/* I must go before this waiter.  Check special case. */
B
Bruce Momjian 已提交
603
				if ((lockMethodTable->conflictTab[lockmode] & aheadRequests) == 0 &&
604 605 606
					LockCheckConflicts(lockMethodTable,
									   lockmode,
									   lock,
607
									   proclock,
608 609
									   MyProc,
									   NULL) == STATUS_OK)
610
				{
611
					/* Skip the wait and just grant myself the lock. */
612
					GrantLock(lock, proclock, lockmode);
613
					return STATUS_OK;
614 615
				}
				/* Break out of loop to put myself before him */
V
Vadim B. Mikheev 已提交
616
				break;
617
			}
618
			/* Nope, so advance to next waiter */
619
			aheadRequests |= LOCKBIT_ON(proc->waitLockMode);
J
Jan Wieck 已提交
620
			proc = (PGPROC *) MAKE_PTR(proc->links.next);
V
Vadim B. Mikheev 已提交
621
		}
B
Bruce Momjian 已提交
622

623 624 625 626
		/*
		 * If we fall out of loop normally, proc points to waitQueue head,
		 * so we will insert at tail of queue as desired.
		 */
627 628 629 630
	}
	else
	{
		/* I hold no locks, so I can't push in front of anyone. */
J
Jan Wieck 已提交
631
		proc = (PGPROC *) &(waitQueue->links);
V
Vadim B. Mikheev 已提交
632
	}
633

634 635 636
	/*
	 * Insert self into queue, ahead of the given proc (or at tail of
	 * queue).
637
	 */
638
	SHMQueueInsertBefore(&(proc->links), &(MyProc->links));
B
Bruce Momjian 已提交
639
	waitQueue->size++;
640

641
	lock->waitMask |= LOCKBIT_ON(lockmode);
642

J
Jan Wieck 已提交
643
	/* Set up wait information in PGPROC object, too */
644
	MyProc->waitLock = lock;
645
	MyProc->waitHolder = proclock;
646 647
	MyProc->waitLockMode = lockmode;

648
	MyProc->errType = STATUS_OK;	/* initialize result for success */
649 650 651

	/*
	 * If we detected deadlock, give up without waiting.  This must agree
652
	 * with CheckDeadLock's recovery code, except that we shouldn't
653
	 * release the semaphore since we haven't tried to lock it yet.
654 655 656 657 658 659 660
	 */
	if (early_deadlock)
	{
		RemoveFromWaitQueue(MyProc);
		MyProc->errType = STATUS_ERROR;
		return STATUS_ERROR;
	}
661

662 663 664
	/* mark that we are waiting for a lock */
	waitingForLock = true;

665
	/*
666
	 * Release the locktable's masterLock.
667
	 *
668 669 670 671
	 * 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.
672
	 */
673
	LWLockRelease(masterLock);
674

675
	/*
676 677 678 679 680 681 682
	 * 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.
683
	 */
684
	if (!enable_sig_alarm(DeadlockTimeout, false))
685
		elog(FATAL, "could not set timer for process wakeup");
686

687
	/*
688
	 * If someone wakes us between LWLockRelease and PGSemaphoreLock,
B
Bruce Momjian 已提交
689
	 * PGSemaphoreLock will not block.	The wakeup is "saved" by the
690
	 * semaphore implementation.  Note also that if CheckDeadLock is
691
	 * invoked but does not detect a deadlock, PGSemaphoreLock() will
692 693
	 * continue to wait.  There used to be a loop here, but it was useless
	 * code...
694 695 696 697 698 699
	 *
	 * 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).
700
	 */
701
	PGSemaphoreLock(&MyProc->sem, true);
702

703
	/*
704
	 * Disable the timer, if it's still running
B
Bruce Momjian 已提交
705
	 */
706
	if (!disable_sig_alarm(false))
707
		elog(FATAL, "could not disable timer for process wakeup");
B
Bruce Momjian 已提交
708

709 710 711 712 713
	/*
	 * Now there is nothing for LockWaitCancel to do.
	 */
	waitingForLock = false;

714
	/*
715
	 * Re-acquire the locktable's masterLock.
716
	 */
717
	LWLockAcquire(masterLock, LW_EXCLUSIVE);
718

719 720 721 722
	/*
	 * We don't have to do anything else, because the awaker did all the
	 * necessary update of the lock table and MyProc.
	 */
723
	return MyProc->errType;
724 725 726 727 728 729
}


/*
 * ProcWakeup -- wake up a process by releasing its private semaphore.
 *
730
 *	 Also remove the process from the wait queue and set its links invalid.
731
 *	 RETURN: the next process in the wait queue.
732 733 734 735
 *
 * 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.
736
 */
J
Jan Wieck 已提交
737 738
PGPROC *
ProcWakeup(PGPROC *proc, int errType)
739
{
J
Jan Wieck 已提交
740
	PGPROC	   *retProc;
741

742
	/* assume that masterLock has been acquired */
743

744
	/* Proc should be sleeping ... */
745 746
	if (proc->links.prev == INVALID_OFFSET ||
		proc->links.next == INVALID_OFFSET)
J
Jan Wieck 已提交
747
		return (PGPROC *) NULL;
748

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

752
	/* Remove process from wait queue */
753
	SHMQueueDelete(&(proc->links));
754
	(proc->waitLock->waitProcs.size)--;
755

756 757 758
	/* Clean up process' state and pass it the ok/fail signal */
	proc->waitLock = NULL;
	proc->waitHolder = NULL;
759 760
	proc->errType = errType;

761
	/* And awaken it */
762
	PGSemaphoreUnlock(&proc->sem);
763 764

	return retProc;
765 766 767 768
}

/*
 * ProcLockWakeup -- routine for waking up processes when a lock is
769 770
 *		released (or a prior waiter is aborted).  Scan all waiters
 *		for lock, waken any that are no longer blocked.
771
 */
772
void
773
ProcLockWakeup(LockMethod lockMethodTable, LOCK *lock)
774
{
775 776
	PROC_QUEUE *waitQueue = &(lock->waitProcs);
	int			queue_size = waitQueue->size;
J
Jan Wieck 已提交
777
	PGPROC	   *proc;
778
	LOCKMASK	aheadRequests = 0;
M
 
Marc G. Fournier 已提交
779

780
	Assert(queue_size >= 0);
781

782 783
	if (queue_size == 0)
		return;
784

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

787 788
	while (queue_size-- > 0)
	{
B
Bruce Momjian 已提交
789
		LOCKMODE	lockmode = proc->waitLockMode;
M
 
Marc G. Fournier 已提交
790 791

		/*
792 793
		 * Waken if (a) doesn't conflict with requests of earlier waiters,
		 * and (b) doesn't conflict with already-held locks.
M
 
Marc G. Fournier 已提交
794
		 */
B
Bruce Momjian 已提交
795
		if ((lockMethodTable->conflictTab[lockmode] & aheadRequests) == 0 &&
796 797 798 799 800 801
			LockCheckConflicts(lockMethodTable,
							   lockmode,
							   lock,
							   proc->waitHolder,
							   proc,
							   NULL) == STATUS_OK)
M
 
Marc G. Fournier 已提交
802
		{
803 804 805
			/* OK to waken */
			GrantLock(lock, proc->waitHolder, lockmode);
			proc = ProcWakeup(proc, STATUS_OK);
B
Bruce Momjian 已提交
806

807
			/*
B
Bruce Momjian 已提交
808 809 810
			 * 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.
811
			 */
M
 
Marc G. Fournier 已提交
812
		}
813
		else
814
		{
B
Bruce Momjian 已提交
815 816 817 818
			/*
			 * Cannot wake this guy. Remember his request for later
			 * checks.
			 */
819
			aheadRequests |= LOCKBIT_ON(lockmode);
J
Jan Wieck 已提交
820
			proc = (PGPROC *) MAKE_PTR(proc->links.next);
821
		}
M
 
Marc G. Fournier 已提交
822
	}
823 824

	Assert(waitQueue->size >= 0);
825 826 827
}

/* --------------------
828
 * We only get to this routine if we got SIGALRM after DeadlockTimeout
829 830 831 832
 * 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.
833 834
 * --------------------
 */
835
static void
836
CheckDeadLock(void)
837
{
838
	/*
839 840
	 * Acquire locktable lock.	Note that the deadlock check interrupt had
	 * better not be enabled anywhere that this process itself holds the
841
	 * locktable lock, else this will wait forever.  Also note that
842 843
	 * LWLockAcquire creates a critical section, so that this routine
	 * cannot be interrupted by cancel/die interrupts.
844
	 */
845
	LWLockAcquire(LockMgrLock, LW_EXCLUSIVE);
846

847
	/*
848 849 850
	 * 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.
851 852
	 * Before we are awoken the process releasing the lock grants it to us
	 * so we know that we don't have to wait anymore.
853
	 *
854
	 * We check by looking to see if we've been unlinked from the wait queue.
855 856 857
	 * 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.
858 859 860 861
	 */
	if (MyProc->links.prev == INVALID_OFFSET ||
		MyProc->links.next == INVALID_OFFSET)
	{
862
		LWLockRelease(LockMgrLock);
863 864 865
		return;
	}

866
#ifdef LOCK_DEBUG
B
Bruce Momjian 已提交
867 868
	if (Debug_deadlocks)
		DumpAllLocks();
869 870
#endif

871
	if (!DeadLockCheck(MyProc))
B
Bruce Momjian 已提交
872
	{
873
		/* No deadlock, so keep waiting */
874
		LWLockRelease(LockMgrLock);
B
Bruce Momjian 已提交
875 876 877
		return;
	}

878
	/*
879 880 881
	 * Oops.  We have a deadlock.
	 *
	 * Get this process out of wait state.
882
	 */
883 884
	RemoveFromWaitQueue(MyProc);

885 886
	/*
	 * Set MyProc->errType to STATUS_ERROR so that ProcSleep will report
887
	 * an error after we return from the signal handler.
888 889
	 */
	MyProc->errType = STATUS_ERROR;
890

891 892 893
	/*
	 * Unlock my semaphore so that the interrupted ProcSleep() call can
	 * finish.
894
	 */
895
	PGSemaphoreUnlock(&MyProc->sem);
896

897 898 899 900 901 902 903 904 905
	/*
	 * 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.
906
	 */
907
	LWLockRelease(LockMgrLock);
908 909 910
}


911 912 913 914 915 916 917 918 919 920 921 922
/*
 * 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;
923
	PGSemaphoreLock(&MyProc->sem, true);
924 925 926 927 928 929 930 931 932 933 934 935 936
	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)
{
937
	PGSemaphoreReset(&MyProc->sem);
938 939 940 941 942 943 944 945 946
	waitingForSignal = false;
}

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

	if (proc != NULL)
950
		PGSemaphoreUnlock(&proc->sem);
951 952 953
}


954 955 956 957 958 959 960 961 962
/*****************************************************************************
 * SIGALRM interrupt support
 *
 * Maybe these should be in pqsignal.c?
 *****************************************************************************/

/*
 * Enable the SIGALRM interrupt to fire after the specified delay
 *
963
 * Delay is given in milliseconds.	Caller should be sure a SIGALRM
964 965
 * signal handler is installed before this is called.
 *
966 967
 * This code properly handles nesting of deadlock timeout alarms within
 * statement timeout alarms.
968
 *
969 970 971
 * Returns TRUE if okay, FALSE on failure.
 */
bool
972
enable_sig_alarm(int delayms, bool is_statement_timeout)
973
{
974
#ifdef WIN32
B
Bruce Momjian 已提交
975
#warning add Win32 timer
976
#else
977
	struct timeval fin_time;
B
Bruce Momjian 已提交
978

979
#ifndef __BEOS__
980
	struct itimerval timeval;
B
Bruce Momjian 已提交
981

982
#else
983
	bigtime_t	time_interval;
984
#endif
985

986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010
	/* 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 已提交
1011 1012 1013 1014
		 * 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.
1015 1016 1017
		 *
		 * 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 已提交
1018 1019 1020
		 * 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.
1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032
		 */
		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;
	}
1033

1034
	/* If we reach here, okay to set the timer interrupt */
1035
#ifndef __BEOS__
1036
	MemSet(&timeval, 0, sizeof(struct itimerval));
1037 1038
	timeval.it_value.tv_sec = delayms / 1000;
	timeval.it_value.tv_usec = (delayms % 1000) * 1000;
1039
	if (setitimer(ITIMER_REAL, &timeval, NULL))
1040 1041 1042
		return false;
#else
	/* BeOS doesn't have setitimer, but has set_alarm */
1043
	time_interval = delayms * 1000;		/* usecs */
1044
	if (set_alarm(time_interval, B_ONE_SHOT_RELATIVE_ALARM) < 0)
1045 1046
		return false;
#endif
1047
#endif
1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060
	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)
{
1061 1062 1063
#ifdef WIN32
#warning add Win32 timer
#else
B
Bruce Momjian 已提交
1064

1065 1066 1067 1068 1069 1070 1071 1072
	/*
	 * 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)
1073 1074
	{
#ifndef __BEOS__
1075
		struct itimerval timeval;
1076

1077
		MemSet(&timeval, 0, sizeof(struct itimerval));
1078
		if (setitimer(ITIMER_REAL, &timeval, NULL))
1079
		{
1080 1081 1082
			statement_timeout_active = deadlock_timeout_active = false;
			return false;
		}
1083
#else
1084 1085 1086 1087 1088
		/* 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;
1089
		}
1090
#endif
1091 1092
	}

1093 1094 1095 1096
	/* Always cancel deadlock timeout, in case this is error cleanup */
	deadlock_timeout_active = false;

	/* Cancel or reschedule statement timeout */
1097
	if (is_statement_timeout)
1098 1099 1100 1101 1102 1103
		statement_timeout_active = false;
	else if (statement_timeout_active)
	{
		if (!CheckStatementTimeout())
			return false;
	}
1104
#endif
1105 1106 1107
	return true;
}

1108

1109
/*
1110 1111 1112
 * 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.
1113
 *
1114
 * Returns true if okay, false if failed to set the interrupt.
1115
 */
1116 1117
static bool
CheckStatementTimeout(void)
1118
{
1119
	struct timeval now;
B
Bruce Momjian 已提交
1120

1121 1122 1123 1124
	if (!statement_timeout_active)
		return true;			/* do nothing if not active */

	gettimeofday(&now, NULL);
1125

1126 1127 1128
	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))
1129
	{
1130 1131 1132 1133 1134 1135 1136
		/* Time to die */
		statement_timeout_active = false;
		kill(MyProcPid, SIGINT);
	}
	else
	{
		/* Not time yet, so (re)schedule the interrupt */
1137 1138 1139
#ifdef WIN32
#warning add win32 timer
#else
1140
#ifndef __BEOS__
1141 1142
		struct itimerval timeval;

1143
		MemSet(&timeval, 0, sizeof(struct itimerval));
1144 1145 1146 1147 1148 1149 1150 1151
		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))
1152 1153 1154
			return false;
#else
		/* BeOS doesn't have setitimer, but has set_alarm */
1155
		bigtime_t	time_interval;
B
Bruce Momjian 已提交
1156

1157 1158 1159 1160
		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)
1161
			return false;
1162
#endif
1163 1164 1165
#endif
	}

1166 1167
	return true;
}
1168 1169 1170


/*
1171 1172 1173 1174 1175 1176
 * 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.
1177 1178 1179 1180
 */
void
handle_sig_alarm(SIGNAL_ARGS)
{
1181 1182 1183
	int			save_errno = errno;

	if (deadlock_timeout_active)
1184
	{
1185
		deadlock_timeout_active = false;
1186 1187
		CheckDeadLock();
	}
1188 1189 1190 1191 1192

	if (statement_timeout_active)
		(void) CheckStatementTimeout();

	errno = save_errno;
1193
}