proc.c 24.6 KB
Newer Older
1 2
/*-------------------------------------------------------------------------
 *
3
 * proc.c
4
 *	  routines to manage per-process shared memory data structure
5 6 7 8 9
 *
 * Copyright (c) 1994, Regents of the University of California
 *
 *
 * IDENTIFICATION
B
Bruce Momjian 已提交
10
 *	  $Header: /cvsroot/pgsql/src/backend/storage/lmgr/proc.c,v 1.56 1999/05/25 16:11:23 momjian Exp $
11 12 13 14
 *
 *-------------------------------------------------------------------------
 */
/*
15 16
 *	Each postgres backend gets one of these.  We'll use it to
 *	clean up after the process should the process suddenly die.
17 18 19
 *
 *
 * Interface (a):
20 21 22
 *		ProcSleep(), ProcWakeup(), ProcWakeupNext(),
 *		ProcQueueAlloc() -- create a shm queue for sleeping processes
 *		ProcQueueInit() -- create a queue without allocing memory
23 24 25 26 27 28 29 30 31 32
 *
 * 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):
 *
 * ProcReleaseLocks -- frees the locks associated with this process,
 * ProcKill -- destroys the shared memory state (and locks)
33
 *		associated with the process.
34 35
 *
 * 5/15/91 -- removed the buffer pool based lock chain in favor
36 37 38 39 40 41
 *		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.
42 43
 *
 * 4/7/95 -- instead of allocating a set of 1 semaphore per process, we
44 45 46 47
 *		allocate a semaphore from a set of PROC_NSEMS_PER_SET semaphores
 *		shared among backends (we keep a few sets of semaphores around).
 *		This is so that we can support more backends. (system-wide semaphore
 *		sets run out pretty fast.)				  -ay 4/95
48
 *
B
Bruce Momjian 已提交
49
 * $Header: /cvsroot/pgsql/src/backend/storage/lmgr/proc.c,v 1.56 1999/05/25 16:11:23 momjian Exp $
50 51 52 53
 */
#include <sys/time.h>
#include <unistd.h>
#include <string.h>
54
#include <signal.h>
55
#include <sys/types.h>
M
Marc G. Fournier 已提交
56

B
Bruce Momjian 已提交
57
#if defined(solaris_sparc)
58 59 60 61
#include <sys/ipc.h>
#include <sys/sem.h>
#endif

M
Marc G. Fournier 已提交
62
#include "postgres.h"
63
#include "miscadmin.h"
64
#include "libpq/pqsignal.h"
65 66 67 68

#include "access/xact.h"
#include "utils/hsearch.h"

69 70 71
#include "storage/ipc.h"
/* In Ultrix, sem.h must be included after ipc.h */
#include <sys/sem.h>
72
#include "storage/buf.h"
73
#include "storage/lock.h"
B
Bruce Momjian 已提交
74
#include "storage/lmgr.h"
75 76 77
#include "storage/shmem.h"
#include "storage/spin.h"
#include "storage/proc.h"
M
 
Marc G. Fournier 已提交
78
#include "utils/trace.h"
79

B
Bruce Momjian 已提交
80
static void HandleDeadLock(int sig);
81
static void ProcFreeAllSemaphores(void);
82

M
 
Marc G. Fournier 已提交
83 84
#define DeadlockCheckTimer pg_options[OPT_DEADLOCKTIMEOUT]

85 86 87 88 89 90 91
/* --------------------
 * Spin lock for manipulating the shared process data structure:
 * ProcGlobal.... Adding an extra spin lock seemed like the smallest
 * hack to get around reading and updating this structure in shared
 * memory. -mer 17 July 1991
 * --------------------
 */
92
SPINLOCK	ProcStructLock;
93 94 95 96 97

/*
 * For cleanup routines.  Don't cleanup if the initialization
 * has not happened.
 */
98
static bool ProcInitialized = FALSE;
99 100 101

static PROC_HDR *ProcGlobal = NULL;

102
PROC	   *MyProc = NULL;
103

104
static void ProcKill(int exitStatus, int pid);
105
static void ProcGetNewSemKeyAndNum(IPCKey *key, int *semNum);
106
static void ProcFreeSem(IpcSemaphoreKey semKey, int semNum);
107

V
Vadim B. Mikheev 已提交
108 109
static char *DeadLockMessage = "Deadlock detected -- See the lock(l) manual page for a possible cause.";

110 111
/*
 * InitProcGlobal -
112
 *	  initializes the global process table. We put it here so that
113
 *	  the postmaster can do this initialization. (ProcFreeAllSemaphores needs
114 115 116
 *	  to read this table on exiting the postmaster. If we have the first
 *	  backend do this, starting up and killing the postmaster without
 *	  starting any backends will be a problem.)
117 118 119 120 121 122 123 124 125 126 127
 *
 *	  We also allocate all the per-process semaphores we will need to support
 *	  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.
128 129
 */
void
130
InitProcGlobal(IPCKey key, int maxBackends)
131
{
132
	bool		found = false;
133

134 135 136
	/* attach to the free list */
	ProcGlobal = (PROC_HDR *)
		ShmemInitStruct("Proc Header", (unsigned) sizeof(PROC_HDR), &found);
137

138 139
	/* --------------------
	 * We're the first - initialize.
140 141
	 * XXX if found should ever be true, it is a sign of impending doom ...
	 * ought to complain if so?
142 143 144
	 * --------------------
	 */
	if (!found)
145
	{
146
		int			i;
147

148 149 150 151
		ProcGlobal->freeProcs = INVALID_OFFSET;
		ProcGlobal->currKey = IPCGetProcessSemaphoreInitKey(key);
		for (i = 0; i < MAX_PROC_SEMS / PROC_NSEMS_PER_SET; i++)
			ProcGlobal->freeSemMap[i] = 0;
152

B
Bruce Momjian 已提交
153 154 155
		/*
		 * Arrange to delete semas on exit --- set this up now so that we
		 * will clean up if pre-allocation fails...
156 157 158
		 */
		on_shmem_exit(ProcFreeAllSemaphores, NULL);

B
Bruce Momjian 已提交
159 160
		/*
		 * Pre-create the semaphores for the first maxBackends processes,
161 162 163
		 * unless we are running as a standalone backend.
		 */
		if (key != PrivateIPCKey)
164
		{
165
			for (i = 0;
B
Bruce Momjian 已提交
166
				 i < (maxBackends + PROC_NSEMS_PER_SET - 1) / PROC_NSEMS_PER_SET;
167 168 169 170 171 172 173 174 175 176 177 178 179 180 181
				 i++)
			{
				IPCKey		semKey = ProcGlobal->currKey + i;
				int			semId;
				int			semstat;

				semId = IpcSemaphoreCreate(semKey,
										   PROC_NSEMS_PER_SET,
										   IPCProtection,
										   IpcSemaphoreDefaultStartValue,
										   0,
										   &semstat);
				/* mark this sema set allocated */
				ProcGlobal->freeSemMap[i] = (1 << PROC_NSEMS_PER_SET);
			}
182
		}
183 184 185 186 187 188 189 190 191 192 193
	}
}

/* ------------------------
 * InitProc -- create a per-process data structure for this process
 * used by the lock manager on semaphore queues.
 * ------------------------
 */
void
InitProcess(IPCKey key)
{
194 195 196 197
	bool		found = false;
	int			semstat;
	unsigned long location,
				myOffset;
198 199 200 201 202

	/* ------------------
	 * Routine called if deadlock timer goes off. See ProcSleep()
	 * ------------------
	 */
B
Bruce Momjian 已提交
203 204
	pqsignal(SIGALRM, HandleDeadLock);

205 206 207 208 209 210
	SpinAcquire(ProcStructLock);

	/* attach to the free list */
	ProcGlobal = (PROC_HDR *)
		ShmemInitStruct("Proc Header", (unsigned) sizeof(PROC_HDR), &found);
	if (!found)
211
	{
212
		/* this should not happen. InitProcGlobal() is called before this. */
213
		elog(ERROR, "InitProcess: Proc Header uninitialized");
214
	}
215 216

	if (MyProc != NULL)
217
	{
218
		SpinRelease(ProcStructLock);
219
		elog(ERROR, "ProcInit: you already exist");
220
		return;
221
	}
222 223 224 225 226 227

	/* try to get a proc from the free list first */

	myOffset = ProcGlobal->freeProcs;

	if (myOffset != INVALID_OFFSET)
228
	{
229 230 231 232 233 234 235
		MyProc = (PROC *) MAKE_PTR(myOffset);
		ProcGlobal->freeProcs = MyProc->links.next;
	}
	else
	{

		/*
236 237 238 239
		 * have to allocate one.  We can't use the normal shmem index
		 * table mechanism because the proc structure is stored by PID
		 * instead of by a global name (need to look it up by PID when we
		 * cleanup dead processes).
240 241 242 243
		 */

		MyProc = (PROC *) ShmemAlloc((unsigned) sizeof(PROC));
		if (!MyProc)
244
		{
245 246
			SpinRelease(ProcStructLock);
			elog(FATAL, "cannot create new proc: out of memory");
247
		}
248 249 250

		/* this cannot be initialized until after the buffer pool */
		SHMQueueInit(&(MyProc->lockQueue));
251
	}
252

253
	/*
254 255 256
	 * zero out the spin lock counts and set the sLocks field for
	 * ProcStructLock to 1 as we have acquired this spinlock above but
	 * didn't record it since we didn't have MyProc until now.
257
	 */
B
Bruce Momjian 已提交
258
	MemSet(MyProc->sLocks, 0, sizeof(MyProc->sLocks));
259 260 261 262 263
	MyProc->sLocks[ProcStructLock] = 1;


	if (IsUnderPostmaster)
	{
264 265 266 267
		IPCKey		semKey;
		int			semNum;
		int			semId;
		union semun semun;
268 269 270

		ProcGetNewSemKeyAndNum(&semKey, &semNum);

B
Bruce Momjian 已提交
271 272 273 274 275
		/*
		 * Note: because of the pre-allocation done in InitProcGlobal,
		 * this call should always attach to an existing semaphore. It
		 * will (try to) create a new group of semaphores only if the
		 * postmaster tries to start more backends than it said it would.
276
		 */
277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304
		semId = IpcSemaphoreCreate(semKey,
								   PROC_NSEMS_PER_SET,
								   IPCProtection,
								   IpcSemaphoreDefaultStartValue,
								   0,
								   &semstat);

		/*
		 * we might be reusing a semaphore that belongs to a dead backend.
		 * So be careful and reinitialize its value here.
		 */
		semun.val = IpcSemaphoreDefaultStartValue;
		semctl(semId, semNum, SETVAL, semun);

		IpcSemaphoreLock(semId, semNum, IpcExclusiveLock);
		MyProc->sem.semId = semId;
		MyProc->sem.semNum = semNum;
		MyProc->sem.semKey = semKey;
	}
	else
		MyProc->sem.semId = -1;

	/* ----------------------
	 * Release the lock.
	 * ----------------------
	 */
	SpinRelease(ProcStructLock);

B
Bruce Momjian 已提交
305
	MyProc->pid = MyProcPid;
306
	MyProc->xid = InvalidTransactionId;
307
	MyProc->xmin = InvalidTransactionId;
308 309 310 311 312 313

	/* ----------------
	 * Start keeping spin lock stats from here on.	Any botch before
	 * this initialization is forever botched
	 * ----------------
	 */
B
Bruce Momjian 已提交
314
	MemSet(MyProc->sLocks, 0, MAX_SPINS * sizeof(*MyProc->sLocks));
315 316

	/* -------------------------
317
	 * Install ourselves in the shmem index table.	The name to
318 319 320 321 322 323
	 * use is determined by the OS-assigned process id.  That
	 * allows the cleanup process to find us after any untimely
	 * exit.
	 * -------------------------
	 */
	location = MAKE_OFFSET(MyProc);
B
Bruce Momjian 已提交
324
	if ((!ShmemPIDLookup(MyProcPid, &location)) || (location != MAKE_OFFSET(MyProc)))
325 326 327 328 329
		elog(FATAL, "InitProc: ShmemPID table broken");

	MyProc->errType = NO_ERROR;
	SHMQueueElemInit(&(MyProc->links));

330
	on_shmem_exit(ProcKill, (caddr_t) MyProcPid);
331 332

	ProcInitialized = TRUE;
333 334 335 336 337 338 339 340 341
}

/*
 * ProcReleaseLocks() -- release all locks associated with this process
 *
 */
void
ProcReleaseLocks()
{
342 343 344
	if (!MyProc)
		return;
	LockReleaseAll(1, &MyProc->lockQueue);
345 346 347 348
}

/*
 * ProcRemove -
349 350 351 352 353
 *	  used by the postmaster to clean up the global tables. This also frees
 *	  up the semaphore used for the lmgr of the process. (We have to do
 *	  this is the postmaster instead of doing a IpcSemaphoreKill on exiting
 *	  the process because the semaphore set is shared among backends and
 *	  we don't want to remove other's semaphores on exit.)
354 355 356 357
 */
bool
ProcRemove(int pid)
{
358 359
	SHMEM_OFFSET location;
	PROC	   *proc;
360 361 362 363 364

	location = INVALID_OFFSET;

	location = ShmemPIDDestroy(pid);
	if (location == INVALID_OFFSET)
365
		return FALSE;
366 367 368 369 370 371 372 373 374 375 376
	proc = (PROC *) MAKE_PTR(location);

	SpinAcquire(ProcStructLock);

	ProcFreeSem(proc->sem.semKey, proc->sem.semNum);

	proc->links.next = ProcGlobal->freeProcs;
	ProcGlobal->freeProcs = MAKE_OFFSET(proc);

	SpinRelease(ProcStructLock);

377
	return TRUE;
378 379 380 381
}

/*
 * ProcKill() -- Destroy the per-proc data structure for
382
 *		this process. Release any of its held spin locks.
383 384 385 386
 */
static void
ProcKill(int exitStatus, int pid)
{
387 388
	PROC	   *proc;
	SHMEM_OFFSET location;
389 390 391 392 393 394 395 396 397 398

	/* --------------------
	 * If this is a FATAL exit the postmaster will have to kill all the
	 * existing backends and reinitialize shared memory.  So all we don't
	 * need to do anything here.
	 * --------------------
	 */
	if (exitStatus != 0)
		return;

B
Bruce Momjian 已提交
399
	ShmemPIDLookup(MyProcPid, &location);
400 401 402 403 404
	if (location == INVALID_OFFSET)
		return;

	proc = (PROC *) MAKE_PTR(location);

405 406 407
	Assert(proc == MyProc || pid != MyProcPid);

	MyProc = NULL;
408 409 410 411 412 413

	/* ---------------
	 * Assume one lock table.
	 * ---------------
	 */
	ProcReleaseSpins(proc);
M
 
Marc G. Fournier 已提交
414
	LockReleaseAll(DEFAULT_LOCKMETHOD, &proc->lockQueue);
415

416
#ifdef USER_LOCKS
417

M
 
Marc G. Fournier 已提交
418 419 420 421
	/*
	 * Assume we have a second lock table.
	 */
	LockReleaseAll(USER_LOCKMETHOD, &proc->lockQueue);
422 423
#endif

424 425 426 427 428 429 430 431 432 433 434 435 436 437 438
	/* ----------------
	 * get off the wait queue
	 * ----------------
	 */
	LockLockTable();
	if (proc->links.next != INVALID_OFFSET)
	{
		Assert(proc->waitLock->waitProcs.size > 0);
		SHMQueueDelete(&(proc->links));
		--proc->waitLock->waitProcs.size;
	}
	SHMQueueElemInit(&(proc->links));
	UnlockLockTable();

	return;
439 440 441 442
}

/*
 * ProcQueue package: routines for putting processes to sleep
443
 *		and  waking them up
444 445 446 447 448 449 450 451
 */

/*
 * 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
 */
452
#ifdef NOT_USED
453
PROC_QUEUE *
454 455
ProcQueueAlloc(char *name)
{
456 457
	bool		found;
	PROC_QUEUE *queue = (PROC_QUEUE *)
458 459 460
	ShmemInitStruct(name, (unsigned) sizeof(PROC_QUEUE), &found);

	if (!queue)
461
		return NULL;
462 463
	if (!found)
		ProcQueueInit(queue);
464
	return queue;
465
}
466

467
#endif
468 469 470 471 472

/*
 * ProcQueueInit -- initialize a shared memory process queue
 */
void
473
ProcQueueInit(PROC_QUEUE *queue)
474
{
475 476
	SHMQueueInit(&(queue->links));
	queue->size = 0;
477 478 479 480 481 482 483 484 485 486 487 488
}



/*
 * ProcSleep -- put a process to sleep
 *
 * P() on the semaphore should put us to sleep.  The process
 * semaphore is cleared by default, so the first time we try
 * to acquire it, we sleep.
 *
 * ASSUME: that no one will fiddle with the queue until after
489
 *		we release the spin lock.
490 491 492 493
 *
 * NOTES: The process queue is now a priority queue for locking.
 */
int
494
ProcSleep(PROC_QUEUE *waitQueue,/* lock->waitProcs */
B
Bruce Momjian 已提交
495
		  LOCKMETHODCTL * lockctl,
496
		  int token,			/* lockmode */
V
Vadim B. Mikheev 已提交
497
		  LOCK *lock)
498
{
499
	int			i;
V
Vadim B. Mikheev 已提交
500
	SPINLOCK	spinlock = lockctl->masterLock;
501
	PROC	   *proc;
V
Vadim B. Mikheev 已提交
502 503 504 505 506
	int			myMask = (1 << token);
	int			waitMask = lock->waitMask;
	int			aheadHolders[MAX_LOCKMODES];
	bool		selfConflict = (lockctl->conflictTab[token] & myMask),
				prevSame = false;
B
Bruce Momjian 已提交
507 508 509
	bool		deadlock_checked = false;
	struct itimerval timeval,
				dummy;
510

V
Vadim B. Mikheev 已提交
511 512 513
	MyProc->token = token;
	MyProc->waitLock = lock;

B
Bruce Momjian 已提交
514
	proc = (PROC *) MAKE_PTR(waitQueue->links.prev);
515

V
Vadim B. Mikheev 已提交
516 517 518
	/* if we don't conflict with any waiter - be first in queue */
	if (!(lockctl->conflictTab[token] & waitMask))
		goto ins;
519

V
Vadim B. Mikheev 已提交
520 521 522
	for (i = 1; i < MAX_LOCKMODES; i++)
		aheadHolders[i] = lock->activeHolders[i];
	(aheadHolders[token])++;
523

V
Vadim B. Mikheev 已提交
524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543
	for (i = 0; i < waitQueue->size; i++)
	{
		/* am I waiting for him ? */
		if (lockctl->conflictTab[token] & proc->holdLock)
		{
			/* is he waiting for me ? */
			if (lockctl->conflictTab[proc->token] & MyProc->holdLock)
			{
				MyProc->errType = STATUS_ERROR;
				elog(NOTICE, DeadLockMessage);
				goto rt;
			}
			/* being waiting for him - go past */
		}
		/* if he waits for me */
		else if (lockctl->conflictTab[proc->token] & MyProc->holdLock)
			break;
		/* if conflicting locks requested */
		else if (lockctl->conflictTab[proc->token] & myMask)
		{
B
Bruce Momjian 已提交
544

V
Vadim B. Mikheev 已提交
545
			/*
B
Bruce Momjian 已提交
546 547
			 * If I request non self-conflicting lock and there are others
			 * requesting the same lock just before me - stay here.
V
Vadim B. Mikheev 已提交
548 549 550 551
			 */
			if (!selfConflict && prevSame)
				break;
		}
B
Bruce Momjian 已提交
552

V
Vadim B. Mikheev 已提交
553
		/*
B
Bruce Momjian 已提交
554 555
		 * Last attempt to don't move any more: if we don't conflict with
		 * rest waiters in queue.
V
Vadim B. Mikheev 已提交
556 557 558
		 */
		else if (!(lockctl->conflictTab[token] & waitMask))
			break;
559

V
Vadim B. Mikheev 已提交
560 561 562
		prevSame = (proc->token == token);
		(aheadHolders[proc->token])++;
		if (aheadHolders[proc->token] == lock->holders[proc->token])
B
Bruce Momjian 已提交
563
			waitMask &= ~(1 << proc->token);
V
Vadim B. Mikheev 已提交
564 565
		proc = (PROC *) MAKE_PTR(proc->links.prev);
	}
566

V
Vadim B. Mikheev 已提交
567
ins:;
568 569 570 571 572 573
	/* -------------------
	 * assume that these two operations are atomic (because
	 * of the spinlock).
	 * -------------------
	 */
	SHMQueueInsertTL(&(proc->links), &(MyProc->links));
B
Bruce Momjian 已提交
574
	waitQueue->size++;
575

V
Vadim B. Mikheev 已提交
576
	lock->waitMask |= myMask;
577 578 579
	SpinRelease(spinlock);

	/* --------------
B
Bruce Momjian 已提交
580
	 * We set this so we can wake up periodically and check for a deadlock.
B
Bruce Momjian 已提交
581 582
	 * If a deadlock is detected, the handler releases the processes
	 * semaphore and aborts the current transaction.
B
Bruce Momjian 已提交
583 584 585
	 *
	 * Need to zero out struct to set the interval and the micro seconds fields
	 * to 0.
586 587
	 * --------------
	 */
B
Bruce Momjian 已提交
588 589 590
	MemSet(&timeval, 0, sizeof(struct itimerval));
	timeval.it_value.tv_sec = \
		(DeadlockCheckTimer ? DeadlockCheckTimer : DEADLOCK_CHECK_TIMER);
591

B
Bruce Momjian 已提交
592 593
	do
	{
594
		MyProc->errType = NO_ERROR;		/* reset flag after deadlock check */
595

B
Bruce Momjian 已提交
596 597 598 599 600
		if (!deadlock_checked)
			if (setitimer(ITIMER_REAL, &timeval, &dummy))
				elog(FATAL, "ProcSleep: Unable to set timer for process wakeup");
		deadlock_checked = true;

B
Bruce Momjian 已提交
601 602 603 604 605 606
		/* --------------
		 * if someone wakes us between SpinRelease and IpcSemaphoreLock,
		 * IpcSemaphoreLock will not block.  The wakeup is "saved" by
		 * the semaphore implementation.
		 * --------------
		 */
M
 
Marc G. Fournier 已提交
607 608
		IpcSemaphoreLock(MyProc->sem.semId, MyProc->sem.semNum,
						 IpcExclusiveLock);
609 610 611
	} while (MyProc->errType == STATUS_NOT_FOUND);		/* sleep after deadlock
														 * check */

B
Bruce Momjian 已提交
612 613 614 615 616 617 618 619
	/* ---------------
	 * We were awoken before a timeout - now disable the timer
	 * ---------------
	 */
	timeval.it_value.tv_sec = 0;
	if (setitimer(ITIMER_REAL, &timeval, &dummy))
		elog(FATAL, "ProcSleep: Unable to diable timer for process wakeup");

620 621 622 623 624 625 626
	/* ----------------
	 * We were assumed to be in a critical section when we went
	 * to sleep.
	 * ----------------
	 */
	SpinAcquire(spinlock);

V
Vadim B. Mikheev 已提交
627 628
rt:;

M
 
Marc G. Fournier 已提交
629 630
#ifdef LOCK_MGR_DEBUG
	/* Just to get meaningful debug messages from DumpLocks() */
631
	MyProc->waitLock = (LOCK *) NULL;
M
 
Marc G. Fournier 已提交
632 633
#endif

634
	return MyProc->errType;
635 636 637 638 639 640
}


/*
 * ProcWakeup -- wake up a process by releasing its private semaphore.
 *
641 642
 *	 remove the process from the wait queue and set its links invalid.
 *	 RETURN: the next process in the wait queue.
643
 */
B
Bruce Momjian 已提交
644
PROC *
645
ProcWakeup(PROC *proc, int errType)
646
{
647
	PROC	   *retProc;
648 649 650 651 652

	/* assume that spinlock has been acquired */

	if (proc->links.prev == INVALID_OFFSET ||
		proc->links.next == INVALID_OFFSET)
653
		return (PROC *) NULL;
654 655 656 657 658 659 660 661 662 663 664 665

	retProc = (PROC *) MAKE_PTR(proc->links.prev);

	/* you have to update waitLock->waitProcs.size yourself */
	SHMQueueDelete(&(proc->links));
	SHMQueueElemInit(&(proc->links));

	proc->errType = errType;

	IpcSemaphoreUnlock(proc->sem.semId, proc->sem.semNum, IpcExclusiveLock);

	return retProc;
666 667 668 669
}

/*
 * ProcLockWakeup -- routine for waking up processes when a lock is
670
 *		released.
671 672
 */
int
673
ProcLockWakeup(PROC_QUEUE *queue, LOCKMETHOD lockmethod, LOCK *lock)
674
{
675
	PROC	   *proc;
V
Vadim B. Mikheev 已提交
676
	int			count = 0;
M
 
Marc G. Fournier 已提交
677
	int			trace_flag;
V
Vadim B. Mikheev 已提交
678
	int			last_locktype = 0;
M
 
Marc G. Fournier 已提交
679 680 681
	int			queue_size = queue->size;

	Assert(queue->size >= 0);
682 683

	if (!queue->size)
684
		return STATUS_NOT_FOUND;
685 686

	proc = (PROC *) MAKE_PTR(queue->links.prev);
M
 
Marc G. Fournier 已提交
687 688
	while ((queue_size--) && (proc))
	{
689

M
 
Marc G. Fournier 已提交
690
		/*
691 692
		 * This proc will conflict as the previous one did, don't even
		 * try.
M
 
Marc G. Fournier 已提交
693 694 695 696 697
		 */
		if (proc->token == last_locktype)
			continue;

		/*
V
Vadim B. Mikheev 已提交
698
		 * Does this proc conflict with locks held by others ?
M
 
Marc G. Fournier 已提交
699 700
		 */
		if (LockResolveConflicts(lockmethod,
701
								 lock,
702
								 proc->token,
M
 
Marc G. Fournier 已提交
703 704 705
								 proc->xid,
								 (XIDLookupEnt *) NULL) != STATUS_OK)
		{
V
Vadim B. Mikheev 已提交
706 707
			if (count != 0)
				break;
M
 
Marc G. Fournier 已提交
708 709 710
			last_locktype = proc->token;
			continue;
		}
711 712 713 714 715 716 717

		/*
		 * there was a waiting process, grant it the lock before waking it
		 * up.	This will prevent another process from seizing the lock
		 * between the time we release the lock master (spinlock) and the
		 * time that the awoken process begins executing again.
		 */
718
		GrantLock(lock, proc->token);
719 720 721

		/*
		 * ProcWakeup removes proc from the lock waiting process queue and
722
		 * returns the next proc in chain.
723 724 725
		 */

		count++;
M
 
Marc G. Fournier 已提交
726 727
		queue->size--;
		proc = ProcWakeup(proc, NO_ERROR);
728
	}
729

M
 
Marc G. Fournier 已提交
730 731
	Assert(queue->size >= 0);

732
	if (count)
733
		return STATUS_OK;
734 735
	else
	{
736
		/* Something is still blocking us.	May have deadlocked. */
M
 
Marc G. Fournier 已提交
737 738 739 740 741 742 743 744 745
		trace_flag = (lock->tag.lockmethod == USER_LOCKMETHOD) ? \
			TRACE_USERLOCKS : TRACE_LOCKS;
		TPRINTF(trace_flag,
				"ProcLockWakeup: lock(%x) can't wake up any process",
				MAKE_OFFSET(lock));
#ifdef DEADLOCK_DEBUG
		if (pg_options[trace_flag] >= 2)
			DumpAllLocks();
#endif
746
		return STATUS_NOT_FOUND;
M
 
Marc G. Fournier 已提交
747
	}
748 749 750
}

void
751
ProcAddLock(SHM_QUEUE *elem)
752
{
753
	SHMQueueInsertTL(&MyProc->lockQueue, elem);
754 755 756
}

/* --------------------
B
Bruce Momjian 已提交
757 758 759
 * We only get to this routine if we got SIGALRM after DEADLOCK_CHECK_TIMER
 * while waiting for a lock to be released by some other process.  If we have
 * a real deadlock, we must also indicate that I'm no longer waiting
760
 * on a lock so that other processes don't try to wake me up and screw
761 762 763
 * up my semaphore.
 * --------------------
 */
764
static void
B
Bruce Momjian 已提交
765
HandleDeadLock(int sig)
766
{
B
Bruce Momjian 已提交
767
	LOCK	   *mywaitlock;
768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805

	LockLockTable();

	/* ---------------------
	 * 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.
	 * Before we are awoken the process releasing the lock grants it to
	 * us so we know that we don't have to wait anymore.
	 *
	 * Damn these names are LONG! -mer
	 * ---------------------
	 */
	if (IpcSemaphoreGetCount(MyProc->sem.semId, MyProc->sem.semNum) ==
		IpcSemaphoreDefaultStartValue)
	{
		UnlockLockTable();
		return;
	}

	/*
	 * you would think this would be unnecessary, but...
	 *
	 * this also means we've been removed already.  in some ports (e.g.,
	 * sparc and aix) the semop(2) implementation is such that we can
	 * actually end up in this handler after someone has removed us from
	 * the queue and bopped the semaphore *but the test above fails to
	 * detect the semaphore update* (presumably something weird having to
	 * do with the order in which the semaphore wakeup signal and SIGALRM
	 * get handled).
	 */
	if (MyProc->links.prev == INVALID_OFFSET ||
		MyProc->links.next == INVALID_OFFSET)
	{
		UnlockLockTable();
		return;
	}

806
#ifdef DEADLOCK_DEBUG
M
 
Marc G. Fournier 已提交
807
	DumpAllLocks();
808 809
#endif

B
Bruce Momjian 已提交
810 811
	MyProc->errType = STATUS_NOT_FOUND;
	if (!DeadLockCheck(MyProc, MyProc->waitLock))
B
Bruce Momjian 已提交
812 813 814 815 816 817 818
	{
		UnlockLockTable();
		return;
	}

	mywaitlock = MyProc->waitLock;

819 820 821 822
	/* ------------------------
	 * Get this process off the lock's wait queue
	 * ------------------------
	 */
B
Bruce Momjian 已提交
823 824
	Assert(mywaitlock->waitProcs.size > 0);
	--mywaitlock->waitProcs.size;
825 826 827 828 829 830 831 832
	SHMQueueDelete(&(MyProc->links));
	SHMQueueElemInit(&(MyProc->links));

	/* ------------------
	 * Unlock my semaphore so that the count is right for next time.
	 * I was awoken by a signal, not by someone unlocking my semaphore.
	 * ------------------
	 */
M
 
Marc G. Fournier 已提交
833 834
	IpcSemaphoreUnlock(MyProc->sem.semId, MyProc->sem.semNum,
					   IpcExclusiveLock);
835 836 837 838 839 840 841 842 843 844 845 846 847 848 849

	/* -------------
	 * Set MyProc->errType to STATUS_ERROR so that we abort after
	 * returning from this handler.
	 * -------------
	 */
	MyProc->errType = STATUS_ERROR;

	/*
	 * if this doesn't follow the IpcSemaphoreUnlock then we get lock
	 * table corruption ("LockReplace: xid table corrupted") due to race
	 * conditions.	i don't claim to understand this...
	 */
	UnlockLockTable();

V
Vadim B. Mikheev 已提交
850
	elog(NOTICE, DeadLockMessage);
851
	return;
852 853 854
}

void
855
ProcReleaseSpins(PROC *proc)
856
{
857
	int			i;
858 859 860 861 862 863 864

	if (!proc)
		proc = MyProc;

	if (!proc)
		return;
	for (i = 0; i < (int) MAX_SPINS; i++)
865
	{
866
		if (proc->sLocks[i])
867
		{
868 869
			Assert(proc->sLocks[i] == 1);
			SpinRelease(i);
870 871 872 873 874
		}
	}
}

/*****************************************************************************
875
 *
876 877 878 879
 *****************************************************************************/

/*
 * ProcGetNewSemKeyAndNum -
880 881 882 883
 *	  scan the free semaphore bitmap and allocate a single semaphore from
 *	  a semaphore set. (If the semaphore set doesn't exist yet,
 *	  IpcSemaphoreCreate will create it. Otherwise, we use the existing
 *	  semaphore set.)
884 885
 */
static void
886
ProcGetNewSemKeyAndNum(IPCKey *key, int *semNum)
887
{
888 889
	int			i;
	int32	   *freeSemMap = ProcGlobal->freeSemMap;
B
Bruce Momjian 已提交
890
	int32		fullmask = (1 << (PROC_NSEMS_PER_SET + 1)) - 1;
891

892 893 894 895
	/*
	 * we hold ProcStructLock when entering this routine. We scan through
	 * the bitmap to look for a free semaphore.
	 */
896

897 898
	for (i = 0; i < MAX_PROC_SEMS / PROC_NSEMS_PER_SET; i++)
	{
899 900
		int			mask = 1;
		int			j;
901 902

		if (freeSemMap[i] == fullmask)
903
			continue;			/* this set is fully allocated */
904 905 906 907 908 909 910

		for (j = 0; j < PROC_NSEMS_PER_SET; j++)
		{
			if ((freeSemMap[i] & mask) == 0)
			{

				/*
B
Bruce Momjian 已提交
911 912
				 * a free semaphore found. Mark it as allocated. Also set
				 * the bit indicating whole set is allocated.
913
				 */
914
				freeSemMap[i] |= mask + (1 << PROC_NSEMS_PER_SET);
915 916 917 918 919 920 921

				*key = ProcGlobal->currKey + i;
				*semNum = j;
				return;
			}
			mask <<= 1;
		}
922 923
	}

924
	/* if we reach here, all the semaphores are in use. */
925
	elog(ERROR, "InitProc: cannot allocate a free semaphore");
926 927 928 929
}

/*
 * ProcFreeSem -
930
 *	  free up our semaphore in the semaphore set.
931 932 933 934
 */
static void
ProcFreeSem(IpcSemaphoreKey semKey, int semNum)
{
935 936 937
	int			mask;
	int			i;
	int32	   *freeSemMap = ProcGlobal->freeSemMap;
938

939 940 941
	i = semKey - ProcGlobal->currKey;
	mask = ~(1 << semNum);
	freeSemMap[i] &= mask;
942

B
Bruce Momjian 已提交
943 944 945 946
	/*
	 * Formerly we'd release a semaphore set if it was now completely
	 * unused, but now we keep the semaphores to ensure we won't run out
	 * when starting new backends --- cf. InitProcGlobal.  Note that the
947 948 949
	 * PROC_NSEMS_PER_SET+1'st bit of the freeSemMap entry remains set to
	 * indicate it is still allocated; ProcFreeAllSemaphores() needs that.
	 */
950 951 952 953
}

/*
 * ProcFreeAllSemaphores -
954 955 956
 *	  called at shmem_exit time, ie when exiting the postmaster or
 *	  destroying shared state for a failed set of backends.
 *	  Free up all the semaphores allocated to the lmgrs of the backends.
957
 */
958
static void
959 960
ProcFreeAllSemaphores()
{
961 962
	int			i;
	int32	   *freeSemMap = ProcGlobal->freeSemMap;
963

964 965 966 967 968
	for (i = 0; i < MAX_PROC_SEMS / PROC_NSEMS_PER_SET; i++)
	{
		if (freeSemMap[i] != 0)
			IpcSemaphoreKill(ProcGlobal->currKey + i);
	}
969
}