proc.c 32.6 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.145 2004/01/27 00:45:26 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
#include "libpq/pqsignal.h"
55

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

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

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

static PROC_HDR *ProcGlobal = NULL;

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

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

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

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


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

V
Vadim B. Mikheev 已提交
92

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

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

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

132 133 134 135
	/*
	 * Create or attach to the PGPROC structures for dummy (checkpoint)
	 * processes, too.	This does not get linked into the freeProcs
	 * list.
136
	 */
137 138 139 140 141 142 143 144 145 146
	DummyProc = (PGPROC *)
		ShmemInitStruct("DummyProc",sizeof(PGPROC) * NUM_DUMMY_PROCS, &foundDummy);

	if (foundProcGlobal || foundDummy)
	{
		/* both should be present or neither */
		Assert(foundProcGlobal && foundDummy);
		return;
	}
	else
147
	{
148 149 150
		/*
		 * We're the first - initialize.
		 */
151
		int			i;
152

153
		ProcGlobal->freeProcs = INVALID_OFFSET;
154

B
Bruce Momjian 已提交
155
		/*
B
Bruce Momjian 已提交
156 157
		 * Pre-create the PGPROC structures and create a semaphore for
		 * each.
158
		 */
159
		for (i = 0; i < maxBackends; i++)
160
		{
B
Bruce Momjian 已提交
161
			PGPROC	   *proc;
162

J
Jan Wieck 已提交
163
			proc = (PGPROC *) ShmemAlloc(sizeof(PGPROC));
164
			if (!proc)
165 166
				ereport(FATAL,
						(errcode(ERRCODE_OUT_OF_MEMORY),
167
						 errmsg("out of shared memory")));
J
Jan Wieck 已提交
168
			MemSet(proc, 0, sizeof(PGPROC));
169 170 171
			PGSemaphoreCreate(&proc->sem);
			proc->links.next = ProcGlobal->freeProcs;
			ProcGlobal->freeProcs = MAKE_OFFSET(proc);
172
		}
173

J
Jan Wieck 已提交
174 175 176 177 178 179
		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));
		}
180 181 182 183

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

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

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

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

	if (MyProc != NULL)
206
		elog(ERROR, "you already exist");
207

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

214
	myOffset = procglobal->freeProcs;
215 216

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

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

253

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

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

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

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

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

	if (MyProc != NULL)
292
		elog(ERROR, "you already exist");
293

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

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

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

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

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

352 353 354
	waitingForLock = false;

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

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

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

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

381

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


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

417
	Assert(MyProc != NULL);
418

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

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

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

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

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

443
	SpinLockAcquire(ProcStructLock);
444

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

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

452 453 454 455 456
	SpinLockRelease(ProcStructLock);
}

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

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

	dummyproc = &DummyProc[dummy_proc_type];

	Assert(MyProc != NULL && MyProc == dummyproc);
470 471 472 473

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

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

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

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

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

	dummy_proc_type = -1;
488 489
}

490

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

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

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

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


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

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

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

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

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

643
	lock->waitMask |= LOCKBIT_ON(lockmode);
644

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

650
	MyProc->errType = STATUS_OK;	/* initialize result for success */
651 652 653

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

664 665 666
	/* mark that we are waiting for a lock */
	waitingForLock = true;

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

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

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

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

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

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

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


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

744
	/* assume that masterLock has been acquired */
745

746
	/* Proc should be sleeping ... */
747 748
	if (proc->links.prev == INVALID_OFFSET ||
		proc->links.next == INVALID_OFFSET)
749
		return NULL;
750

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

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

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

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

	return retProc;
767 768 769 770
}

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

782
	Assert(queue_size >= 0);
783

784 785
	if (queue_size == 0)
		return;
786

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

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

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

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

	Assert(waitQueue->size >= 0);
827 828 829
}

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

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

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

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

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

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

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

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


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

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

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


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

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

981
#ifndef __BEOS__
982
	struct itimerval timeval;
B
Bruce Momjian 已提交
983

984
#else
985
	bigtime_t	time_interval;
986
#endif
987

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

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

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

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

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

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

1110

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

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

	gettimeofday(&now, NULL);
1127

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

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

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

1168 1169
	return true;
}
1170 1171 1172


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

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

	if (statement_timeout_active)
		(void) CheckStatementTimeout();

	errno = save_errno;
1195
}