heapam.c 42.9 KB
Newer Older
1 2
/*-------------------------------------------------------------------------
 *
3
 * heapam.c
4
 *	  heap access method code
5 6 7 8 9
 *
 * Copyright (c) 1994, Regents of the University of California
 *
 *
 * IDENTIFICATION
10
 *	  $Header: /cvsroot/pgsql/src/backend/access/heap/heapam.c,v 1.56 1999/10/11 06:28:27 inoue Exp $
11 12 13
 *
 *
 * INTERFACE ROUTINES
14 15 16 17 18 19 20 21 22 23 24 25 26 27 28
 *		heapgettup		- fetch next heap tuple from a scan
 *		heap_open		- open a heap relation by relationId
 *		heap_openr		- open a heap relation by name
 *		heap_close		- close a heap relation
 *		heap_beginscan	- begin relation scan
 *		heap_rescan		- restart a relation scan
 *		heap_endscan	- end relation scan
 *		heap_getnext	- retrieve next tuple in scan
 *		heap_fetch		- retrive tuple with tid
 *		heap_insert		- insert tuple into a relation
 *		heap_delete		- delete a tuple from a relation
 *		heap_replace	- replace a tuple in a relation with another tuple
 *		heap_markpos	- mark scan position
 *		heap_restrpos	- restore position to marked location
 *
29
 * NOTES
30 31 32
 *	  This file contains the heap_ routines which implement
 *	  the POSTGRES heap access method used for all POSTGRES
 *	  relations.
33 34
 *
 * OLD COMMENTS
35
 *		struct relscan hints:  (struct should be made AM independent?)
36
 *
37 38 39 40
 *		rs_ctid is the tid of the last tuple returned by getnext.
 *		rs_ptid and rs_ntid are the tids of the previous and next tuples
 *		returned by getnext, respectively.	NULL indicates an end of
 *		scan (either direction); NON indicates an unknow value.
41
 *
42 43 44 45 46 47 48 49 50 51 52 53 54 55 56
 *		possible combinations:
 *		rs_p	rs_c	rs_n			interpretation
 *		NULL	NULL	NULL			empty scan
 *		NULL	NULL	NON				at begining of scan
 *		NULL	NULL	t1				at begining of scan (with cached tid)
 *		NON		NULL	NULL			at end of scan
 *		t1		NULL	NULL			at end of scan (with cached tid)
 *		NULL	t1		NULL			just returned only tuple
 *		NULL	t1		NON				just returned first tuple
 *		NULL	t1		t2				returned first tuple (with cached tid)
 *		NON		t1		NULL			just returned last tuple
 *		t2		t1		NULL			returned last tuple (with cached tid)
 *		t1		t2		NON				in the middle of a forward scan
 *		NON		t2		t1				in the middle of a reverse scan
 *		ti		tj		tk				in the middle of a scan (w cached tid)
57
 *
58 59
 *		Here NULL is ...tup == NULL && ...buf == InvalidBuffer,
 *		and NON is ...tup == NULL && ...buf == UnknownBuffer.
60
 *
61 62 63
 *		Currently, the NONTID values are not cached with their actual
 *		values by getnext.	Values may be cached by markpos since it stores
 *		all three tids.
64
 *
65 66
 *		NOTE:  the calls to elog() must stop.  Should decide on an interface
 *		between the general and specific AM calls.
67
 *
68 69 70 71
 *		XXX probably do not need a free tuple routine for heaps.
 *		Huh?  Free tuple is not necessary for tuples returned by scans, but
 *		is necessary for tuples which are returned by
 *		RelationGetTupleByItemPointer. -hirohama
72 73 74 75
 *
 *-------------------------------------------------------------------------
 */

76
#include "postgres.h"
77

78 79
#include "access/heapam.h"
#include "access/hio.h"
B
Bruce Momjian 已提交
80
#include "access/valid.h"
81
#include "catalog/catalog.h"
B
Bruce Momjian 已提交
82 83
#include "miscadmin.h"
#include "storage/smgr.h"
84
#include "utils/builtins.h"
B
Bruce Momjian 已提交
85 86
#include "utils/inval.h"
#include "utils/relcache.h"
87

M
-Wall'd  
Marc G. Fournier 已提交
88

89
/* ----------------------------------------------------------------
90
 *						 heap support routines
91 92 93 94
 * ----------------------------------------------------------------
 */

/* ----------------
95
 *		initscan - scan code common to heap_beginscan and heap_rescan
96 97 98
 * ----------------
 */
static void
99
initscan(HeapScanDesc scan,
100 101 102 103
		 Relation relation,
		 int atend,
		 unsigned nkeys,
		 ScanKey key)
104
{
105 106 107 108 109 110
	if (!RelationGetNumberOfBlocks(relation))
	{
		/* ----------------
		 *	relation is empty
		 * ----------------
		 */
B
Bruce Momjian 已提交
111
		scan->rs_ntup.t_data = scan->rs_ctup.t_data =
112
		scan->rs_ptup.t_data = NULL;
113
		scan->rs_nbuf = scan->rs_cbuf = scan->rs_pbuf = InvalidBuffer;
114 115 116 117 118 119 120
	}
	else if (atend)
	{
		/* ----------------
		 *	reverse scan
		 * ----------------
		 */
121
		scan->rs_ntup.t_data = scan->rs_ctup.t_data = NULL;
122
		scan->rs_nbuf = scan->rs_cbuf = InvalidBuffer;
123
		scan->rs_ptup.t_data = NULL;
124
		scan->rs_pbuf = UnknownBuffer;
125 126 127 128 129 130 131
	}
	else
	{
		/* ----------------
		 *	forward scan
		 * ----------------
		 */
132
		scan->rs_ctup.t_data = scan->rs_ptup.t_data = NULL;
133
		scan->rs_cbuf = scan->rs_pbuf = InvalidBuffer;
134
		scan->rs_ntup.t_data = NULL;
135
		scan->rs_nbuf = UnknownBuffer;
136 137 138
	}							/* invalid too */

	/* we don't have a marked position... */
139 140 141 142
	ItemPointerSetInvalid(&(scan->rs_mptid));
	ItemPointerSetInvalid(&(scan->rs_mctid));
	ItemPointerSetInvalid(&(scan->rs_mntid));
	ItemPointerSetInvalid(&(scan->rs_mcd));
143

144
	/* ----------------
145
	 *	copy the scan key, if appropriate
146 147
	 * ----------------
	 */
148
	if (key != NULL)
149
		memmove(scan->rs_key, key, nkeys * sizeof(ScanKeyData));
150 151 152
}

/* ----------------
153
 *		unpinscan - code common to heap_rescan and heap_endscan
154 155 156
 * ----------------
 */
static void
157
unpinscan(HeapScanDesc scan)
158
{
159 160
	if (BufferIsValid(scan->rs_pbuf))
		ReleaseBuffer(scan->rs_pbuf);
161 162

	/* ------------------------------------
163
	 *	Scan will pin buffer once for each non-NULL tuple pointer
164 165 166 167
	 *	(ptup, ctup, ntup), so they have to be unpinned multiple
	 *	times.
	 * ------------------------------------
	 */
168 169
	if (BufferIsValid(scan->rs_cbuf))
		ReleaseBuffer(scan->rs_cbuf);
170

171 172
	if (BufferIsValid(scan->rs_nbuf))
		ReleaseBuffer(scan->rs_nbuf);
173 174 175 176

	/* we don't bother to clear rs_pbuf etc --- caller must
	 * reinitialize them if scan descriptor is not being deleted.
	 */
177 178 179
}

/* ------------------------------------------
180
 *		nextpage
181
 *
182 183 184
 *		figure out the next page to scan after the current page
 *		taking into account of possible adjustment of degrees of
 *		parallelism
185 186 187 188 189
 * ------------------------------------------
 */
static int
nextpage(int page, int dir)
{
190
	return (dir < 0) ? page - 1 : page + 1;
191 192 193
}

/* ----------------
194
 *		heapgettup - fetch next heap tuple
195
 *
196 197
 *		routine used by heap_getnext() which does most of the
 *		real work in scanning tuples.
198 199 200 201 202
 *
 *		The scan routines handle their own buffer lock/unlocking, so
 *		there is no reason to request the buffer number unless
 *		to want to perform some other operation with the result,
 *		like pass it to another function.
203 204
 * ----------------
 */
205
static void
206
heapgettup(Relation relation,
207
		   HeapTuple tuple,
208
		   int dir,
V
Vadim B. Mikheev 已提交
209
		   Buffer *buffer,
210
		   Snapshot snapshot,
211 212
		   int nkeys,
		   ScanKey key)
213
{
B
Bruce Momjian 已提交
214 215 216 217 218 219 220 221 222
	ItemId		lpp;
	Page		dp;
	int			page;
	int			pages;
	int			lines;
	OffsetNumber lineoff;
	int			linesleft;
	ItemPointer tid = (tuple->t_data == NULL) ?
	(ItemPointer) NULL : &(tuple->t_self);
223

224
	/* ----------------
225
	 *	increment access statistics
226 227
	 * ----------------
	 */
228 229 230
	IncrHeapAccessStat(local_heapgettup);
	IncrHeapAccessStat(global_heapgettup);

231
	/* ----------------
232 233 234 235
	 *	debugging stuff
	 *
	 * check validity of arguments, here and for other functions too
	 * Note: no locking manipulations needed--this is a local function
236 237
	 * ----------------
	 */
238 239 240
#ifdef	HEAPDEBUGALL
	if (ItemPointerIsValid(tid))
	{
241
		elog(DEBUG, "heapgettup(%s, tid=0x%x[%d,%d], dir=%d, ...)",
242 243
			 RelationGetRelationName(relation), tid, tid->ip_blkid,
			 tid->ip_posid, dir);
244
	}
245 246
	else
	{
247
		elog(DEBUG, "heapgettup(%s, tid=0x%x, dir=%d, ...)",
248
			 RelationGetRelationName(relation), tid, dir);
249
	}
V
Vadim B. Mikheev 已提交
250
	elog(DEBUG, "heapgettup(..., b=0x%x, nkeys=%d, key=0x%x", buffer, nkeys, key);
251

252
	elog(DEBUG, "heapgettup: relation(%c)=`%s', %p",
253
		 relation->rd_rel->relkind, &relation->rd_rel->relname,
254
		 snapshot);
255
#endif	 /* !defined(HEAPDEBUGALL) */
256 257 258

	if (!ItemPointerIsValid(tid))
		Assert(!PointerIsValid(tid));
259 260

	/* ----------------
261
	 *	return null immediately if relation is empty
262 263
	 * ----------------
	 */
264
	if (!(pages = relation->rd_nblocks))
265 266 267 268
	{
		tuple->t_data = NULL;
		return;
	}
269 270 271 272 273 274 275 276 277 278 279 280 281 282

	/* ----------------
	 *	calculate next starting lineoff, given scan direction
	 * ----------------
	 */
	if (!dir)
	{
		/* ----------------
		 * ``no movement'' scan direction
		 * ----------------
		 */
		/* assume it is a valid TID XXX */
		if (ItemPointerIsValid(tid) == false)
		{
V
Vadim B. Mikheev 已提交
283
			*buffer = InvalidBuffer;
284 285
			tuple->t_data = NULL;
			return;
286
		}
V
Vadim B. Mikheev 已提交
287
		*buffer = RelationGetBufferWithBuffer(relation,
B
Bruce Momjian 已提交
288 289
										  ItemPointerGetBlockNumber(tid),
											  *buffer);
290

V
Vadim B. Mikheev 已提交
291
		if (!BufferIsValid(*buffer))
292
			elog(ERROR, "heapgettup: failed ReadBuffer");
293

V
Vadim B. Mikheev 已提交
294 295 296
		LockBuffer(*buffer, BUFFER_LOCK_SHARE);

		dp = (Page) BufferGetPage(*buffer);
297 298 299
		lineoff = ItemPointerGetOffsetNumber(tid);
		lpp = PageGetItemId(dp, lineoff);

300 301
		tuple->t_data = (HeapTupleHeader) PageGetItem((Page) dp, lpp);
		tuple->t_len = ItemIdGetLength(lpp);
V
Vadim B. Mikheev 已提交
302
		LockBuffer(*buffer, BUFFER_LOCK_UNLOCK);
303
		return;
304

305
	}
306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323
	else if (dir < 0)
	{
		/* ----------------
		 *	reverse scan direction
		 * ----------------
		 */
		if (ItemPointerIsValid(tid) == false)
			tid = NULL;
		if (tid == NULL)
		{
			page = pages - 1;	/* final page */
		}
		else
		{
			page = ItemPointerGetBlockNumber(tid);		/* current page */
		}
		if (page < 0)
		{
V
Vadim B. Mikheev 已提交
324
			*buffer = InvalidBuffer;
325 326
			tuple->t_data = NULL;
			return;
327 328
		}

V
Vadim B. Mikheev 已提交
329 330
		*buffer = RelationGetBufferWithBuffer(relation, page, *buffer);
		if (!BufferIsValid(*buffer))
331
			elog(ERROR, "heapgettup: failed ReadBuffer");
332

V
Vadim B. Mikheev 已提交
333 334 335
		LockBuffer(*buffer, BUFFER_LOCK_SHARE);

		dp = (Page) BufferGetPage(*buffer);
336 337 338 339
		lines = PageGetMaxOffsetNumber(dp);
		if (tid == NULL)
		{
			lineoff = lines;	/* final offnum */
340
		}
341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368
		else
		{
			lineoff =			/* previous offnum */
				OffsetNumberPrev(ItemPointerGetOffsetNumber(tid));
		}
		/* page and lineoff now reference the physically previous tid */

	}
	else
	{
		/* ----------------
		 *	forward scan direction
		 * ----------------
		 */
		if (ItemPointerIsValid(tid) == false)
		{
			page = 0;			/* first page */
			lineoff = FirstOffsetNumber;		/* first offnum */
		}
		else
		{
			page = ItemPointerGetBlockNumber(tid);		/* current page */
			lineoff =			/* next offnum */
				OffsetNumberNext(ItemPointerGetOffsetNumber(tid));
		}

		if (page >= pages)
		{
V
Vadim B. Mikheev 已提交
369
			*buffer = InvalidBuffer;
370 371
			tuple->t_data = NULL;
			return;
372 373 374
		}
		/* page and lineoff now reference the physically next tid */

V
Vadim B. Mikheev 已提交
375 376
		*buffer = RelationGetBufferWithBuffer(relation, page, *buffer);
		if (!BufferIsValid(*buffer))
377
			elog(ERROR, "heapgettup: failed ReadBuffer");
378

V
Vadim B. Mikheev 已提交
379 380 381
		LockBuffer(*buffer, BUFFER_LOCK_SHARE);

		dp = (Page) BufferGetPage(*buffer);
382
		lines = PageGetMaxOffsetNumber(dp);
383
	}
384 385 386

	/* 'dir' is now non-zero */

387
	/* ----------------
388 389
	 *	calculate line pointer and number of remaining items
	 *	to check on this page.
390 391
	 * ----------------
	 */
392 393 394 395 396 397
	lpp = PageGetItemId(dp, lineoff);
	if (dir < 0)
		linesleft = lineoff - 1;
	else
		linesleft = lines - lineoff;

398
	/* ----------------
399 400
	 *	advance the scan until we find a qualifying tuple or
	 *	run out of stuff to scan
401 402
	 * ----------------
	 */
403 404 405 406
	for (;;)
	{
		while (linesleft >= 0)
		{
407
			if (ItemIdIsUsed(lpp))
408
			{
409 410 411 412 413 414 415
				tuple->t_data = (HeapTupleHeader) PageGetItem((Page) dp, lpp);
				tuple->t_len = ItemIdGetLength(lpp);
				ItemPointerSet(&(tuple->t_self), page, lineoff);
				/* ----------------
				 *	if current tuple qualifies, return it.
				 * ----------------
				 */
V
Vadim B. Mikheev 已提交
416
				HeapTupleSatisfies(tuple, relation, *buffer, (PageHeader) dp,
417 418
								   snapshot, nkeys, key);
				if (tuple->t_data != NULL)
V
Vadim B. Mikheev 已提交
419 420
				{
					LockBuffer(*buffer, BUFFER_LOCK_UNLOCK);
421
					return;
V
Vadim B. Mikheev 已提交
422
				}
423 424 425 426 427 428 429 430 431 432
			}

			/* ----------------
			 *	otherwise move to the next item on the page
			 * ----------------
			 */
			--linesleft;
			if (dir < 0)
			{
				--lpp;			/* move back in this page's ItemId array */
433
				--lineoff;
434 435 436
			}
			else
			{
B
Bruce Momjian 已提交
437 438
				++lpp;			/* move forward in this page's ItemId
								 * array */
439
				++lineoff;
440 441 442 443 444 445 446 447
			}
		}

		/* ----------------
		 *	if we get here, it means we've exhausted the items on
		 *	this page and it's time to move to the next..
		 * ----------------
		 */
V
Vadim B. Mikheev 已提交
448
		LockBuffer(*buffer, BUFFER_LOCK_UNLOCK);
449 450 451 452 453 454 455 456
		page = nextpage(page, dir);

		/* ----------------
		 *	return NULL if we've exhausted all the pages..
		 * ----------------
		 */
		if (page < 0 || page >= pages)
		{
V
Vadim B. Mikheev 已提交
457 458 459
			if (BufferIsValid(*buffer))
				ReleaseBuffer(*buffer);
			*buffer = InvalidBuffer;
460 461
			tuple->t_data = NULL;
			return;
462 463
		}

V
Vadim B. Mikheev 已提交
464
		*buffer = ReleaseAndReadBuffer(*buffer, relation, page);
465

V
Vadim B. Mikheev 已提交
466
		if (!BufferIsValid(*buffer))
467
			elog(ERROR, "heapgettup: failed ReadBuffer");
V
Vadim B. Mikheev 已提交
468 469
		LockBuffer(*buffer, BUFFER_LOCK_SHARE);
		dp = (Page) BufferGetPage(*buffer);
470
		lines = PageGetMaxOffsetNumber((Page) dp);
471 472
		linesleft = lines - 1;
		if (dir < 0)
473 474 475 476
		{
			lineoff = lines;
			lpp = PageGetItemId(dp, lines);
		}
477
		else
478 479
		{
			lineoff = FirstOffsetNumber;
480
			lpp = PageGetItemId(dp, FirstOffsetNumber);
481
		}
482 483 484 485 486
	}
}


/* ----------------------------------------------------------------
487
 *					 heap access method interface
488 489 490
 * ----------------------------------------------------------------
 */
/* ----------------
491
 *		heap_open - open a heap relation by relationId
492
 *
493 494 495 496 497
 *		If lockmode is "NoLock", no lock is obtained on the relation,
 *		and the caller must check for a NULL return value indicating
 *		that no such relation exists.
 *		Otherwise, an error is raised if the relation does not exist,
 *		and the specified kind of lock is obtained on the relation.
498 499 500
 * ----------------
 */
Relation
501
heap_open(Oid relationId, LOCKMODE lockmode)
502
{
503
	Relation	r;
504

505 506
	Assert(lockmode >= NoLock && lockmode < MAX_LOCKMODES);

507 508 509 510 511 512 513
	/* ----------------
	 *	increment access statistics
	 * ----------------
	 */
	IncrHeapAccessStat(local_open);
	IncrHeapAccessStat(global_open);

514 515
	/* The relcache does all the real work... */
	r = RelationIdGetRelation(relationId);
516

517
	/* Under no circumstances will we return an index as a relation. */
518
	if (RelationIsValid(r) && r->rd_rel->relkind == RELKIND_INDEX)
519
		elog(ERROR, "%s is an index relation", r->rd_rel->relname.data);
520

521 522 523 524 525 526 527 528
	if (lockmode == NoLock)
		return r;				/* caller must check RelationIsValid! */

	if (! RelationIsValid(r))
		elog(ERROR, "Relation %u does not exist", relationId);

	LockRelation(r, lockmode);

529
	return r;
530 531 532
}

/* ----------------
533
 *		heap_openr - open a heap relation by name
534
 *
535 536 537 538 539
 *		If lockmode is "NoLock", no lock is obtained on the relation,
 *		and the caller must check for a NULL return value indicating
 *		that no such relation exists.
 *		Otherwise, an error is raised if the relation does not exist,
 *		and the specified kind of lock is obtained on the relation.
540 541 542
 * ----------------
 */
Relation
543
heap_openr(char *relationName, LOCKMODE lockmode)
544
{
545
	Relation	r;
546

547 548
	Assert(lockmode >= NoLock && lockmode < MAX_LOCKMODES);

549 550 551 552 553 554 555
	/* ----------------
	 *	increment access statistics
	 * ----------------
	 */
	IncrHeapAccessStat(local_openr);
	IncrHeapAccessStat(global_openr);

556
	/* The relcache does all the real work... */
557 558
	r = RelationNameGetRelation(relationName);

559
	/* Under no circumstances will we return an index as a relation. */
560
	if (RelationIsValid(r) && r->rd_rel->relkind == RELKIND_INDEX)
561
		elog(ERROR, "%s is an index relation", r->rd_rel->relname.data);
562

563 564 565 566 567 568 569 570
	if (lockmode == NoLock)
		return r;				/* caller must check RelationIsValid! */

	if (! RelationIsValid(r))
		elog(ERROR, "Relation '%s' does not exist", relationName);

	LockRelation(r, lockmode);

571
	return r;
572 573 574
}

/* ----------------
575
 *		heap_close - close a heap relation
576
 *
577 578 579
 *		If lockmode is not "NoLock", we first release the specified lock.
 *		Note that it is often sensible to hold a lock beyond heap_close;
 *		in that case, the lock is released automatically at xact end.
580 581 582
 * ----------------
 */
void
583
heap_close(Relation relation, LOCKMODE lockmode)
584
{
585 586
	Assert(lockmode >= NoLock && lockmode < MAX_LOCKMODES);

587 588 589 590 591 592 593
	/* ----------------
	 *	increment access statistics
	 * ----------------
	 */
	IncrHeapAccessStat(local_close);
	IncrHeapAccessStat(global_close);

594 595 596 597
	if (lockmode != NoLock)
		UnlockRelation(relation, lockmode);

	/* The relcache does the real work... */
598
	RelationClose(relation);
599 600 601 602
}


/* ----------------
603
 *		heap_beginscan	- begin relation scan
604 605 606 607
 * ----------------
 */
HeapScanDesc
heap_beginscan(Relation relation,
608
			   int atend,
609
			   Snapshot snapshot,
610 611
			   unsigned nkeys,
			   ScanKey key)
612
{
613
	HeapScanDesc scan;
614 615 616 617 618 619 620 621 622 623 624

	/* ----------------
	 *	increment access statistics
	 * ----------------
	 */
	IncrHeapAccessStat(local_beginscan);
	IncrHeapAccessStat(global_beginscan);

	/* ----------------
	 *	sanity checks
	 * ----------------
625
	 */
626
	if (! RelationIsValid(relation))
627
		elog(ERROR, "heap_beginscan: !RelationIsValid(relation)");
628 629 630 631 632 633 634

	/* ----------------
	 *	increment relation ref count while scanning relation
	 * ----------------
	 */
	RelationIncrementReferenceCount(relation);

635 636 637 638 639 640 641 642 643 644 645 646 647 648
	/* ----------------
	 *	Acquire AccessShareLock for the duration of the scan
	 *
	 *	Note: we could get an SI inval message here and consequently have
	 *	to rebuild the relcache entry.  The refcount increment above
	 *	ensures that we will rebuild it and not just flush it...
	 * ----------------
	 */
	LockRelation(relation, AccessShareLock);

	/* XXX someday assert SelfTimeQual if relkind == RELKIND_UNCATALOGED */
	if (relation->rd_rel->relkind == RELKIND_UNCATALOGED)
		snapshot = SnapshotSelf;

649 650 651 652
	/* ----------------
	 *	allocate and initialize scan descriptor
	 * ----------------
	 */
653
	scan = (HeapScanDesc) palloc(sizeof(HeapScanDescData));
654

B
Bruce Momjian 已提交
655
	relation->rd_nblocks = smgrnblocks(DEFAULT_SMGR, relation);
656
	scan->rs_rd = relation;
657 658

	if (nkeys)
659

660
		/*
661 662
		 * we do this here instead of in initscan() because heap_rescan
		 * also calls initscan() and we don't want to allocate memory
663 664
		 * again
		 */
665
		scan->rs_key = (ScanKey) palloc(sizeof(ScanKeyData) * nkeys);
666
	else
667
		scan->rs_key = NULL;
668

669
	initscan(scan, relation, atend, nkeys, key);
670

671 672 673
	scan->rs_atend = atend;
	scan->rs_snapshot = snapshot;
	scan->rs_nkeys = (short) nkeys;
674

675
	return scan;
676 677 678
}

/* ----------------
679
 *		heap_rescan		- restart a relation scan
680 681 682
 * ----------------
 */
void
683
heap_rescan(HeapScanDesc scan,
684 685
			bool scanFromEnd,
			ScanKey key)
686
{
687 688 689 690 691 692 693 694 695 696 697 698 699
	/* ----------------
	 *	increment access statistics
	 * ----------------
	 */
	IncrHeapAccessStat(local_rescan);
	IncrHeapAccessStat(global_rescan);

	/* Note: set relation level read lock is still set */

	/* ----------------
	 *	unpin scan buffers
	 * ----------------
	 */
700
	unpinscan(scan);
701 702 703 704 705

	/* ----------------
	 *	reinitialize scan descriptor
	 * ----------------
	 */
706 707
	initscan(scan, scan->rs_rd, scanFromEnd, scan->rs_nkeys, key);
	scan->rs_atend = (bool) scanFromEnd;
708 709 710
}

/* ----------------
711
 *		heap_endscan	- end relation scan
712
 *
713 714
 *		See how to integrate with index scans.
 *		Check handling if reldesc caching.
715 716 717
 * ----------------
 */
void
718
heap_endscan(HeapScanDesc scan)
719
{
720 721 722 723 724 725 726 727 728 729 730 731 732
	/* ----------------
	 *	increment access statistics
	 * ----------------
	 */
	IncrHeapAccessStat(local_endscan);
	IncrHeapAccessStat(global_endscan);

	/* Note: no locking manipulations needed */

	/* ----------------
	 *	unpin scan buffers
	 * ----------------
	 */
733
	unpinscan(scan);
734

735 736 737 738 739 740
	/* ----------------
	 *	Release AccessShareLock acquired by heap_beginscan()
	 * ----------------
	 */
	UnlockRelation(scan->rs_rd, AccessShareLock);

741 742 743 744
	/* ----------------
	 *	decrement relation reference count and free scan descriptor storage
	 * ----------------
	 */
745
	RelationDecrementReferenceCount(scan->rs_rd);
746

747
	pfree(scan);
748 749 750
}

/* ----------------
751
 *		heap_getnext	- retrieve next tuple in scan
752
 *
753
 *		Fix to work with index relations.
754 755
 *		We don't return the buffer anymore, but you can get it from the
 *		returned HeapTuple.
756 757 758 759 760
 * ----------------
 */

#ifdef HEAPDEBUGALL
#define HEAPDEBUG_1 \
761 762
elog(DEBUG, "heap_getnext([%s,nkeys=%d],backw=%d) called", \
	 scan->rs_rd->rd_rel->relname.data, scan->rs_nkeys, backw)
763

764
#define HEAPDEBUG_2 \
765 766
	 elog(DEBUG, "heap_getnext called with backw (no tracing yet)")

767
#define HEAPDEBUG_3 \
768 769
	 elog(DEBUG, "heap_getnext returns NULL at end")

770
#define HEAPDEBUG_4 \
771 772
	 elog(DEBUG, "heap_getnext valid buffer UNPIN'd")

773
#define HEAPDEBUG_5 \
774 775
	 elog(DEBUG, "heap_getnext next tuple was cached")

776
#define HEAPDEBUG_6 \
777 778
	 elog(DEBUG, "heap_getnext returning EOS")

779
#define HEAPDEBUG_7 \
780
	 elog(DEBUG, "heap_getnext returning tuple");
781 782 783 784 785 786 787 788
#else
#define HEAPDEBUG_1
#define HEAPDEBUG_2
#define HEAPDEBUG_3
#define HEAPDEBUG_4
#define HEAPDEBUG_5
#define HEAPDEBUG_6
#define HEAPDEBUG_7
789
#endif	 /* !defined(HEAPDEBUGALL) */
790 791


792
HeapTuple
793
heap_getnext(HeapScanDesc scandesc, int backw)
794
{
795
	HeapScanDesc scan = scandesc;
796

797
	/* ----------------
798
	 *	increment access statistics
799 800
	 * ----------------
	 */
801 802 803 804 805 806 807 808
	IncrHeapAccessStat(local_getnext);
	IncrHeapAccessStat(global_getnext);

	/* Note: no locking manipulations needed */

	/* ----------------
	 *	argument checks
	 * ----------------
809
	 */
810
	if (scan == NULL)
811
		elog(ERROR, "heap_getnext: NULL relscan");
812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827

	/* ----------------
	 *	initialize return buffer to InvalidBuffer
	 * ----------------
	 */

	HEAPDEBUG_1;				/* heap_getnext( info ) */

	if (backw)
	{
		/* ----------------
		 *	handle reverse scan
		 * ----------------
		 */
		HEAPDEBUG_2;			/* heap_getnext called with backw */

828
		if (scan->rs_ptup.t_data == scan->rs_ctup.t_data &&
829
			BufferIsInvalid(scan->rs_pbuf))
830
		{
831 832
			if (BufferIsValid(scan->rs_nbuf))
				ReleaseBuffer(scan->rs_nbuf);
833 834
			scan->rs_ntup.t_data = NULL;
			scan->rs_nbuf = UnknownBuffer;
835
			return NULL;
836 837 838 839 840 841
		}

		/*
		 * Copy the "current" tuple/buffer to "next". Pin/unpin the
		 * buffers accordingly
		 */
842
		if (scan->rs_nbuf != scan->rs_cbuf)
843
		{
844 845 846 847
			if (BufferIsValid(scan->rs_nbuf))
				ReleaseBuffer(scan->rs_nbuf);
			if (BufferIsValid(scan->rs_cbuf))
				IncrBufferRefCount(scan->rs_cbuf);
848
		}
849 850
		scan->rs_ntup = scan->rs_ctup;
		scan->rs_nbuf = scan->rs_cbuf;
851

852
		if (scan->rs_ptup.t_data != NULL)
853
		{
854
			if (scan->rs_cbuf != scan->rs_pbuf)
855
			{
856 857 858 859
				if (BufferIsValid(scan->rs_cbuf))
					ReleaseBuffer(scan->rs_cbuf);
				if (BufferIsValid(scan->rs_pbuf))
					IncrBufferRefCount(scan->rs_pbuf);
860
			}
861 862
			scan->rs_ctup = scan->rs_ptup;
			scan->rs_cbuf = scan->rs_pbuf;
863 864 865
		}
		else
		{						/* NONTUP */
B
Bruce Momjian 已提交
866

867
			/*
868
			 * Don't release scan->rs_cbuf at this point, because
869 870 871 872 873 874 875
			 * heapgettup doesn't increase PrivateRefCount if it is
			 * already set. On a backward scan, both rs_ctup and rs_ntup
			 * usually point to the same buffer page, so
			 * PrivateRefCount[rs_cbuf] should be 2 (or more, if for
			 * instance ctup is stored in a TupleTableSlot).  - 01/09/94
			 */

876 877 878 879 880 881 882
			heapgettup(scan->rs_rd,
					   &(scan->rs_ctup),
					   -1,
					   &(scan->rs_cbuf),
					   scan->rs_snapshot,
					   scan->rs_nkeys,
					   scan->rs_key);
883 884
		}

885
		if (scan->rs_ctup.t_data == NULL && !BufferIsValid(scan->rs_cbuf))
886
		{
887 888
			if (BufferIsValid(scan->rs_pbuf))
				ReleaseBuffer(scan->rs_pbuf);
889
			scan->rs_ptup.t_data = NULL;
890 891 892
			scan->rs_pbuf = InvalidBuffer;
			if (BufferIsValid(scan->rs_nbuf))
				ReleaseBuffer(scan->rs_nbuf);
893
			scan->rs_ntup.t_data = NULL;
894
			scan->rs_nbuf = InvalidBuffer;
895
			return NULL;
896 897
		}

898 899
		if (BufferIsValid(scan->rs_pbuf))
			ReleaseBuffer(scan->rs_pbuf);
900
		scan->rs_ptup.t_data = NULL;
901
		scan->rs_pbuf = UnknownBuffer;
902 903 904 905 906 907 908 909

	}
	else
	{
		/* ----------------
		 *	handle forward scan
		 * ----------------
		 */
910
		if (scan->rs_ctup.t_data == scan->rs_ntup.t_data &&
911
			BufferIsInvalid(scan->rs_nbuf))
912
		{
913 914
			if (BufferIsValid(scan->rs_pbuf))
				ReleaseBuffer(scan->rs_pbuf);
915 916
			scan->rs_ptup.t_data = NULL;
			scan->rs_pbuf = UnknownBuffer;
917
			HEAPDEBUG_3;		/* heap_getnext returns NULL at end */
918
			return NULL;
919 920 921 922 923 924
		}

		/*
		 * Copy the "current" tuple/buffer to "previous". Pin/unpin the
		 * buffers accordingly
		 */
925
		if (scan->rs_pbuf != scan->rs_cbuf)
926
		{
927 928 929 930
			if (BufferIsValid(scan->rs_pbuf))
				ReleaseBuffer(scan->rs_pbuf);
			if (BufferIsValid(scan->rs_cbuf))
				IncrBufferRefCount(scan->rs_cbuf);
931
		}
932 933
		scan->rs_ptup = scan->rs_ctup;
		scan->rs_pbuf = scan->rs_cbuf;
934

935
		if (scan->rs_ntup.t_data != NULL)
936
		{
937
			if (scan->rs_cbuf != scan->rs_nbuf)
938
			{
939 940 941 942
				if (BufferIsValid(scan->rs_cbuf))
					ReleaseBuffer(scan->rs_cbuf);
				if (BufferIsValid(scan->rs_nbuf))
					IncrBufferRefCount(scan->rs_nbuf);
943
			}
944 945
			scan->rs_ctup = scan->rs_ntup;
			scan->rs_cbuf = scan->rs_nbuf;
946 947 948 949
			HEAPDEBUG_5;		/* heap_getnext next tuple was cached */
		}
		else
		{						/* NONTUP */
B
Bruce Momjian 已提交
950

951
			/*
952
			 * Don't release scan->rs_cbuf at this point, because
953 954 955 956 957 958 959
			 * heapgettup doesn't increase PrivateRefCount if it is
			 * already set. On a forward scan, both rs_ctup and rs_ptup
			 * usually point to the same buffer page, so
			 * PrivateRefCount[rs_cbuf] should be 2 (or more, if for
			 * instance ctup is stored in a TupleTableSlot).  - 01/09/93
			 */

960 961 962 963 964 965 966
			heapgettup(scan->rs_rd,
					   &(scan->rs_ctup),
					   1,
					   &scan->rs_cbuf,
					   scan->rs_snapshot,
					   scan->rs_nkeys,
					   scan->rs_key);
967 968
		}

969
		if (scan->rs_ctup.t_data == NULL && !BufferIsValid(scan->rs_cbuf))
970
		{
971 972
			if (BufferIsValid(scan->rs_nbuf))
				ReleaseBuffer(scan->rs_nbuf);
973
			scan->rs_ntup.t_data = NULL;
974 975 976
			scan->rs_nbuf = InvalidBuffer;
			if (BufferIsValid(scan->rs_pbuf))
				ReleaseBuffer(scan->rs_pbuf);
977
			scan->rs_ptup.t_data = NULL;
978
			scan->rs_pbuf = InvalidBuffer;
979
			HEAPDEBUG_6;		/* heap_getnext returning EOS */
980
			return NULL;
981 982
		}

983 984
		if (BufferIsValid(scan->rs_nbuf))
			ReleaseBuffer(scan->rs_nbuf);
985
		scan->rs_ntup.t_data = NULL;
986
		scan->rs_nbuf = UnknownBuffer;
987 988
	}

989
	/* ----------------
990 991
	 *	if we get here it means we have a new current scan tuple, so
	 *	point to the proper return buffer and return the tuple.
992 993
	 * ----------------
	 */
994 995 996

	HEAPDEBUG_7;				/* heap_getnext returning tuple */

997
	return ((scan->rs_ctup.t_data == NULL) ? NULL : &(scan->rs_ctup));
998 999 1000
}

/* ----------------
1001
 *		heap_fetch		- retrive tuple with tid
1002
 *
1003
 *		Currently ignores LP_IVALID during processing!
1004 1005 1006 1007
 *
 *		Because this is not part of a scan, there is no way to
 *		automatically lock/unlock the shared buffers.
 *		For this reason, we require that the user retrieve the buffer
1008
 *		value, and they are required to BufferRelease() it when they
1009 1010
 *		are done.  If they want to make a copy of it before releasing it,
 *		they can call heap_copytyple().
1011 1012
 * ----------------
 */
1013
void
1014
heap_fetch(Relation relation,
1015
		   Snapshot snapshot,
1016
		   HeapTuple tuple,
1017
		   Buffer *userbuf)
1018
{
B
Bruce Momjian 已提交
1019 1020 1021 1022 1023
	ItemId		lp;
	Buffer		buffer;
	PageHeader	dp;
	ItemPointer tid = &(tuple->t_self);
	OffsetNumber offnum;
1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040

	/* ----------------
	 *	increment access statistics
	 * ----------------
	 */
	IncrHeapAccessStat(local_fetch);
	IncrHeapAccessStat(global_fetch);

	/* ----------------
	 *	get the buffer from the relation descriptor
	 *	Note that this does a buffer pin.
	 * ----------------
	 */

	buffer = ReadBuffer(relation, ItemPointerGetBlockNumber(tid));

	if (!BufferIsValid(buffer))
1041
		elog(ERROR, "heap_fetch: %s relation: ReadBuffer(%lx) failed",
1042
			 &relation->rd_rel->relname, (long) tid);
V
Vadim B. Mikheev 已提交
1043 1044

	LockBuffer(buffer, BUFFER_LOCK_SHARE);
1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060

	/* ----------------
	 *	get the item line pointer corresponding to the requested tid
	 * ----------------
	 */
	dp = (PageHeader) BufferGetPage(buffer);
	offnum = ItemPointerGetOffsetNumber(tid);
	lp = PageGetItemId(dp, offnum);

	/* ----------------
	 *	more sanity checks
	 * ----------------
	 */

	Assert(ItemIdIsUsed(lp));

1061 1062 1063
	tuple->t_data = (HeapTupleHeader) PageGetItem((Page) dp, lp);
	tuple->t_len = ItemIdGetLength(lp);

1064 1065 1066 1067 1068
	/* ----------------
	 *	check time qualification of tid
	 * ----------------
	 */

1069 1070
	HeapTupleSatisfies(tuple, relation, buffer, dp,
					   snapshot, 0, (ScanKey) NULL);
1071

V
Vadim B. Mikheev 已提交
1072 1073
	LockBuffer(buffer, BUFFER_LOCK_UNLOCK);

1074
	if (tuple->t_data == NULL)
1075
	{
1076
		/* Tuple failed time check, so we can release now. */
1077
		ReleaseBuffer(buffer);
1078 1079 1080 1081 1082 1083 1084 1085
		*userbuf = InvalidBuffer;
	}
	else
	{
		/* All checks passed, so return the tuple as valid.
		 * Caller is now responsible for releasing the buffer.
		 */
		*userbuf = buffer;
1086 1087 1088
	}
}

1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177
/* ----------------
 *	heap_get_latest_tid -  get the latest tid of a specified tuple
 *
 * ----------------
 */
ItemPointer
heap_get_latest_tid(Relation relation,
		   Snapshot snapshot,
		   ItemPointer tid)
{
	ItemId		lp;
	Buffer		buffer;
	PageHeader	dp;
	OffsetNumber	offnum;
	HeapTupleData	tp;
	HeapTupleHeader	t_data;
	ItemPointerData	ctid;
	bool		invalidBlock,linkend;

	/* ----------------
	 *	get the buffer from the relation descriptor
	 *	Note that this does a buffer pin.
	 * ----------------
	 */

	buffer = ReadBuffer(relation, ItemPointerGetBlockNumber(tid));

	if (!BufferIsValid(buffer))
		elog(ERROR, "heap_get_latest_tid: %s relation: ReadBuffer(%lx) failed",
			 &relation->rd_rel->relname, (long) tid);

	LockBuffer(buffer, BUFFER_LOCK_SHARE);

	/* ----------------
	 *	get the item line pointer corresponding to the requested tid
	 * ----------------
	 */
	dp = (PageHeader) BufferGetPage(buffer);
	offnum = ItemPointerGetOffsetNumber(tid);
	invalidBlock = true;
	if (!PageIsNew(dp))
	{
		lp = PageGetItemId(dp, offnum);
		if (ItemIdIsUsed(lp))
			invalidBlock = false;
	}
	if (invalidBlock)
	{	
		LockBuffer(buffer, BUFFER_LOCK_UNLOCK);
		ReleaseBuffer(buffer);
		return NULL;
	} 

	/* ----------------
	 *	more sanity checks
	 * ----------------
	 */

	t_data = tp.t_data = (HeapTupleHeader) PageGetItem((Page) dp, lp);
	tp.t_len = ItemIdGetLength(lp);
	tp.t_self = *tid;
	ctid = tp.t_data->t_ctid;

	/* ----------------
	 *	check time qualification of tid
	 * ----------------
	 */

	HeapTupleSatisfies(&tp, relation, buffer, dp,
					   snapshot, 0, (ScanKey) NULL);

	linkend = true;
	if ((t_data->t_infomask & HEAP_XMAX_COMMITTED) && 
		!ItemPointerEquals(tid, &ctid))
		linkend = false;

	LockBuffer(buffer, BUFFER_LOCK_UNLOCK);
	ReleaseBuffer(buffer);

	if (tp.t_data == NULL)
	{
		if (linkend)
			return NULL;
		return heap_get_latest_tid(relation, snapshot, &ctid); 
	}

	return tid;
}

1178
/* ----------------
1179
 *		heap_insert		- insert tuple
1180
 *
1181 1182
 *		The assignment of t_min (and thus the others) should be
 *		removed eventually.
1183
 *
1184 1185 1186 1187
 *		Currently places the tuple onto the last page.	If there is no room,
 *		it is placed on new pages.	(Heap relations)
 *		Note that concurrent inserts during a scan will probably have
 *		unexpected results, though this will be fixed eventually.
1188
 *
1189
 *		Fix to work with indexes.
1190 1191 1192 1193 1194
 * ----------------
 */
Oid
heap_insert(Relation relation, HeapTuple tup)
{
1195 1196 1197 1198 1199 1200
	/* ----------------
	 *	increment access statistics
	 * ----------------
	 */
	IncrHeapAccessStat(local_insert);
	IncrHeapAccessStat(global_insert);
1201

1202 1203 1204 1205 1206 1207 1208 1209 1210 1211
	/* ----------------
	 *	If the object id of this tuple has already been assigned, trust
	 *	the caller.  There are a couple of ways this can happen.  At initial
	 *	db creation, the backend program sets oids for tuples.	When we
	 *	define an index, we set the oid.  Finally, in the future, we may
	 *	allow users to set their own object ids in order to support a
	 *	persistent object store (objects need to contain pointers to one
	 *	another).
	 * ----------------
	 */
1212
	if (!OidIsValid(tup->t_data->t_oid))
1213
	{
1214 1215
		tup->t_data->t_oid = newoid();
		LastOidProcessed = tup->t_data->t_oid;
1216 1217
	}
	else
1218
		CheckMaxObjectId(tup->t_data->t_oid);
1219

1220 1221 1222 1223 1224
	TransactionIdStore(GetCurrentTransactionId(), &(tup->t_data->t_xmin));
	tup->t_data->t_cmin = GetCurrentCommandId();
	StoreInvalidTransactionId(&(tup->t_data->t_xmax));
	tup->t_data->t_infomask &= ~(HEAP_XACT_MASK);
	tup->t_data->t_infomask |= HEAP_XMAX_INVALID;
1225

V
Vadim B. Mikheev 已提交
1226
	RelationPutHeapTupleAtEnd(relation, tup);
1227 1228 1229 1230

	if (IsSystemRelationName(RelationGetRelationName(relation)->data))
		RelationInvalidateHeapTuple(relation, tup);

1231
	return tup->t_data->t_oid;
1232 1233
}

V
Vadim B. Mikheev 已提交
1234 1235
/*
 *	heap_delete		- delete a tuple
1236
 */
1237
int
V
Vadim B. Mikheev 已提交
1238
heap_delete(Relation relation, ItemPointer tid, ItemPointer ctid)
1239
{
B
Bruce Momjian 已提交
1240 1241 1242 1243 1244
	ItemId		lp;
	HeapTupleData tp;
	PageHeader	dp;
	Buffer		buffer;
	int			result;
1245

V
Vadim B. Mikheev 已提交
1246
	/* increment access statistics */
1247 1248 1249 1250 1251
	IncrHeapAccessStat(local_delete);
	IncrHeapAccessStat(global_delete);

	Assert(ItemPointerIsValid(tid));

V
Vadim B. Mikheev 已提交
1252
	buffer = ReadBuffer(relation, ItemPointerGetBlockNumber(tid));
1253

V
Vadim B. Mikheev 已提交
1254
	if (!BufferIsValid(buffer))
1255
		elog(ERROR, "heap_delete: failed ReadBuffer");
1256

V
Vadim B. Mikheev 已提交
1257
	LockBuffer(buffer, BUFFER_LOCK_EXCLUSIVE);
1258

V
Vadim B. Mikheev 已提交
1259 1260
	dp = (PageHeader) BufferGetPage(buffer);
	lp = PageGetItemId(dp, ItemPointerGetOffsetNumber(tid));
1261 1262 1263
	tp.t_data = (HeapTupleHeader) PageGetItem((Page) dp, lp);
	tp.t_len = ItemIdGetLength(lp);
	tp.t_self = *tid;
B
Bruce Momjian 已提交
1264

V
Vadim B. Mikheev 已提交
1265 1266
l1:
	result = HeapTupleSatisfiesUpdate(&tp);
B
Bruce Momjian 已提交
1267

V
Vadim B. Mikheev 已提交
1268
	if (result == HeapTupleInvisible)
1269
	{
V
Vadim B. Mikheev 已提交
1270 1271 1272
		LockBuffer(buffer, BUFFER_LOCK_UNLOCK);
		ReleaseBuffer(buffer);
		elog(ERROR, "heap_delete: (am)invalid tid");
1273
	}
V
Vadim B. Mikheev 已提交
1274
	else if (result == HeapTupleBeingUpdated)
1275
	{
B
Bruce Momjian 已提交
1276
		TransactionId xwait = tp.t_data->t_xmax;
V
Vadim B. Mikheev 已提交
1277

B
Bruce Momjian 已提交
1278
		/* sleep until concurrent transaction ends */
V
Vadim B. Mikheev 已提交
1279 1280 1281 1282 1283 1284
		LockBuffer(buffer, BUFFER_LOCK_UNLOCK);
		XactLockTableWait(xwait);

		LockBuffer(buffer, BUFFER_LOCK_EXCLUSIVE);
		if (TransactionIdDidAbort(xwait))
			goto l1;
1285 1286 1287 1288 1289 1290 1291
		/* 
		 * xwait is committed but if xwait had just marked
		 * the tuple for update then some other xaction could 
		 * update this tuple before we got to this point.
		 */
		if (tp.t_data->t_xmax != xwait)
			goto l1;
V
Vadim B. Mikheev 已提交
1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310
		if (!(tp.t_data->t_infomask & HEAP_XMAX_COMMITTED))
		{
			tp.t_data->t_infomask |= HEAP_XMAX_COMMITTED;
			SetBufferCommitInfoNeedsSave(buffer);
		}
		/* if tuple was marked for update but not updated... */
		if (tp.t_data->t_infomask & HEAP_MARKED_FOR_UPDATE)
			result = HeapTupleMayBeUpdated;
		else
			result = HeapTupleUpdated;
	}
	if (result != HeapTupleMayBeUpdated)
	{
		Assert(result == HeapTupleSelfUpdated || result == HeapTupleUpdated);
		if (ctid != NULL)
			*ctid = tp.t_data->t_ctid;
		LockBuffer(buffer, BUFFER_LOCK_UNLOCK);
		ReleaseBuffer(buffer);
		return result;
1311 1312
	}

V
Vadim B. Mikheev 已提交
1313
	/* store transaction information of xact deleting the tuple */
1314 1315
	TransactionIdStore(GetCurrentTransactionId(), &(tp.t_data->t_xmax));
	tp.t_data->t_cmax = GetCurrentCommandId();
B
Bruce Momjian 已提交
1316 1317
	tp.t_data->t_infomask &= ~(HEAP_XMAX_COMMITTED |
							 HEAP_XMAX_INVALID | HEAP_MARKED_FOR_UPDATE);
1318

V
Vadim B. Mikheev 已提交
1319 1320 1321
	LockBuffer(buffer, BUFFER_LOCK_UNLOCK);

	/* invalidate caches */
1322
	RelationInvalidateHeapTuple(relation, &tp);
1323

V
Vadim B. Mikheev 已提交
1324
	WriteBuffer(buffer);
1325

V
Vadim B. Mikheev 已提交
1326
	return HeapTupleMayBeUpdated;
1327 1328
}

V
Vadim B. Mikheev 已提交
1329 1330
/*
 *	heap_replace	- replace a tuple
1331 1332
 */
int
B
Bruce Momjian 已提交
1333 1334
heap_replace(Relation relation, ItemPointer otid, HeapTuple newtup,
			 ItemPointer ctid)
1335
{
B
Bruce Momjian 已提交
1336 1337 1338 1339 1340
	ItemId		lp;
	HeapTupleData oldtup;
	PageHeader	dp;
	Buffer		buffer;
	int			result;
1341

V
Vadim B. Mikheev 已提交
1342
	/* increment access statistics */
1343 1344 1345 1346 1347 1348 1349
	IncrHeapAccessStat(local_replace);
	IncrHeapAccessStat(global_replace);

	Assert(ItemPointerIsValid(otid));

	buffer = ReadBuffer(relation, ItemPointerGetBlockNumber(otid));
	if (!BufferIsValid(buffer))
1350
		elog(ERROR, "amreplace: failed ReadBuffer");
V
Vadim B. Mikheev 已提交
1351
	LockBuffer(buffer, BUFFER_LOCK_EXCLUSIVE);
1352

V
Vadim B. Mikheev 已提交
1353
	dp = (PageHeader) BufferGetPage(buffer);
1354 1355
	lp = PageGetItemId(dp, ItemPointerGetOffsetNumber(otid));

1356 1357 1358
	oldtup.t_data = (HeapTupleHeader) PageGetItem(dp, lp);
	oldtup.t_len = ItemIdGetLength(lp);
	oldtup.t_self = *otid;
1359

V
Vadim B. Mikheev 已提交
1360 1361
l2:
	result = HeapTupleSatisfiesUpdate(&oldtup);
B
Bruce Momjian 已提交
1362

V
Vadim B. Mikheev 已提交
1363
	if (result == HeapTupleInvisible)
1364
	{
V
Vadim B. Mikheev 已提交
1365
		LockBuffer(buffer, BUFFER_LOCK_UNLOCK);
1366
		ReleaseBuffer(buffer);
V
Vadim B. Mikheev 已提交
1367
		elog(ERROR, "heap_replace: (am)invalid tid");
1368
	}
V
Vadim B. Mikheev 已提交
1369
	else if (result == HeapTupleBeingUpdated)
1370
	{
B
Bruce Momjian 已提交
1371
		TransactionId xwait = oldtup.t_data->t_xmax;
V
Vadim B. Mikheev 已提交
1372 1373 1374 1375 1376 1377 1378 1379

		/* sleep untill concurrent transaction ends */
		LockBuffer(buffer, BUFFER_LOCK_UNLOCK);
		XactLockTableWait(xwait);

		LockBuffer(buffer, BUFFER_LOCK_EXCLUSIVE);
		if (TransactionIdDidAbort(xwait))
			goto l2;
1380 1381 1382 1383 1384 1385 1386
		/* 
		 * xwait is committed but if xwait had just marked
		 * the tuple for update then some other xaction could 
		 * update this tuple before we got to this point.
		 */
		if (oldtup.t_data->t_xmax != xwait)
			goto l2;
V
Vadim B. Mikheev 已提交
1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403
		if (!(oldtup.t_data->t_infomask & HEAP_XMAX_COMMITTED))
		{
			oldtup.t_data->t_infomask |= HEAP_XMAX_COMMITTED;
			SetBufferCommitInfoNeedsSave(buffer);
		}
		/* if tuple was marked for update but not updated... */
		if (oldtup.t_data->t_infomask & HEAP_MARKED_FOR_UPDATE)
			result = HeapTupleMayBeUpdated;
		else
			result = HeapTupleUpdated;
	}
	if (result != HeapTupleMayBeUpdated)
	{
		Assert(result == HeapTupleSelfUpdated || result == HeapTupleUpdated);
		if (ctid != NULL)
			*ctid = oldtup.t_data->t_ctid;
		LockBuffer(buffer, BUFFER_LOCK_UNLOCK);
1404
		ReleaseBuffer(buffer);
V
Vadim B. Mikheev 已提交
1405
		return result;
1406 1407 1408
	}

	/* XXX order problems if not atomic assignment ??? */
1409 1410 1411 1412 1413
	newtup->t_data->t_oid = oldtup.t_data->t_oid;
	TransactionIdStore(GetCurrentTransactionId(), &(newtup->t_data->t_xmin));
	newtup->t_data->t_cmin = GetCurrentCommandId();
	StoreInvalidTransactionId(&(newtup->t_data->t_xmax));
	newtup->t_data->t_infomask &= ~(HEAP_XACT_MASK);
1414
	newtup->t_data->t_infomask |= (HEAP_XMAX_INVALID | HEAP_UPDATED);
1415

V
Vadim B. Mikheev 已提交
1416 1417 1418
	/* logically delete old item */
	TransactionIdStore(GetCurrentTransactionId(), &(oldtup.t_data->t_xmax));
	oldtup.t_data->t_cmax = GetCurrentCommandId();
B
Bruce Momjian 已提交
1419 1420
	oldtup.t_data->t_infomask &= ~(HEAP_XMAX_COMMITTED |
							 HEAP_XMAX_INVALID | HEAP_MARKED_FOR_UPDATE);
V
Vadim B. Mikheev 已提交
1421 1422

	/* insert new item */
1423
	if ((unsigned) MAXALIGN(newtup->t_len) <= PageGetFreeSpace((Page) dp))
V
Vadim B. Mikheev 已提交
1424
		RelationPutHeapTuple(relation, buffer, newtup);
1425 1426
	else
	{
B
Bruce Momjian 已提交
1427

V
Vadim B. Mikheev 已提交
1428
		/*
B
Bruce Momjian 已提交
1429 1430 1431 1432
		 * New item won't fit on same page as old item, have to look for a
		 * new place to put it. Note that we have to unlock current buffer
		 * context - not good but RelationPutHeapTupleAtEnd uses extend
		 * lock.
1433
		 */
V
Vadim B. Mikheev 已提交
1434 1435 1436
		LockBuffer(buffer, BUFFER_LOCK_UNLOCK);
		RelationPutHeapTupleAtEnd(relation, newtup);
		LockBuffer(buffer, BUFFER_LOCK_EXCLUSIVE);
1437 1438
	}

V
Vadim B. Mikheev 已提交
1439
	/*
B
Bruce Momjian 已提交
1440 1441
	 * New item in place, now record address of new tuple in t_ctid of old
	 * one.
1442
	 */
V
Vadim B. Mikheev 已提交
1443
	oldtup.t_data->t_ctid = newtup->t_self;
1444

V
Vadim B. Mikheev 已提交
1445 1446 1447
	LockBuffer(buffer, BUFFER_LOCK_UNLOCK);

	/* invalidate caches */
1448
	RelationInvalidateHeapTuple(relation, &oldtup);
1449 1450 1451

	WriteBuffer(buffer);

V
Vadim B. Mikheev 已提交
1452 1453 1454 1455 1456 1457 1458 1459 1460
	return HeapTupleMayBeUpdated;
}

/*
 *	heap_mark4update		- mark a tuple for update
 */
int
heap_mark4update(Relation relation, HeapTuple tuple, Buffer *buffer)
{
B
Bruce Momjian 已提交
1461 1462 1463 1464
	ItemPointer tid = &(tuple->t_self);
	ItemId		lp;
	PageHeader	dp;
	int			result;
V
Vadim B. Mikheev 已提交
1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480

	/* increment access statistics */
	IncrHeapAccessStat(local_mark4update);
	IncrHeapAccessStat(global_mark4update);

	*buffer = ReadBuffer(relation, ItemPointerGetBlockNumber(tid));

	if (!BufferIsValid(*buffer))
		elog(ERROR, "heap_mark4update: failed ReadBuffer");

	LockBuffer(*buffer, BUFFER_LOCK_EXCLUSIVE);

	dp = (PageHeader) BufferGetPage(*buffer);
	lp = PageGetItemId(dp, ItemPointerGetOffsetNumber(tid));
	tuple->t_data = (HeapTupleHeader) PageGetItem((Page) dp, lp);
	tuple->t_len = ItemIdGetLength(lp);
B
Bruce Momjian 已提交
1481

V
Vadim B. Mikheev 已提交
1482 1483
l3:
	result = HeapTupleSatisfiesUpdate(tuple);
B
Bruce Momjian 已提交
1484

V
Vadim B. Mikheev 已提交
1485 1486 1487 1488 1489 1490 1491 1492
	if (result == HeapTupleInvisible)
	{
		LockBuffer(*buffer, BUFFER_LOCK_UNLOCK);
		ReleaseBuffer(*buffer);
		elog(ERROR, "heap_mark4update: (am)invalid tid");
	}
	else if (result == HeapTupleBeingUpdated)
	{
B
Bruce Momjian 已提交
1493
		TransactionId xwait = tuple->t_data->t_xmax;
V
Vadim B. Mikheev 已提交
1494 1495 1496 1497 1498 1499 1500 1501

		/* sleep untill concurrent transaction ends */
		LockBuffer(*buffer, BUFFER_LOCK_UNLOCK);
		XactLockTableWait(xwait);

		LockBuffer(*buffer, BUFFER_LOCK_EXCLUSIVE);
		if (TransactionIdDidAbort(xwait))
			goto l3;
1502 1503 1504 1505 1506 1507 1508
		/* 
		 * xwait is committed but if xwait had just marked
		 * the tuple for update then some other xaction could 
		 * update this tuple before we got to this point.
		 */
		if (tuple->t_data->t_xmax != xwait)
			goto l3;
V
Vadim B. Mikheev 已提交
1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522
		if (!(tuple->t_data->t_infomask & HEAP_XMAX_COMMITTED))
		{
			tuple->t_data->t_infomask |= HEAP_XMAX_COMMITTED;
			SetBufferCommitInfoNeedsSave(*buffer);
		}
		/* if tuple was marked for update but not updated... */
		if (tuple->t_data->t_infomask & HEAP_MARKED_FOR_UPDATE)
			result = HeapTupleMayBeUpdated;
		else
			result = HeapTupleUpdated;
	}
	if (result != HeapTupleMayBeUpdated)
	{
		Assert(result == HeapTupleSelfUpdated || result == HeapTupleUpdated);
1523
		tuple->t_self = tuple->t_data->t_ctid;
V
Vadim B. Mikheev 已提交
1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536
		LockBuffer(*buffer, BUFFER_LOCK_UNLOCK);
		return result;
	}

	/* store transaction information of xact marking the tuple */
	TransactionIdStore(GetCurrentTransactionId(), &(tuple->t_data->t_xmax));
	tuple->t_data->t_cmax = GetCurrentCommandId();
	tuple->t_data->t_infomask &= ~(HEAP_XMAX_COMMITTED | HEAP_XMAX_INVALID);
	tuple->t_data->t_infomask |= HEAP_MARKED_FOR_UPDATE;

	LockBuffer(*buffer, BUFFER_LOCK_UNLOCK);

	WriteNoReleaseBuffer(*buffer);
1537

V
Vadim B. Mikheev 已提交
1538
	return HeapTupleMayBeUpdated;
1539 1540 1541
}

/* ----------------
1542
 *		heap_markpos	- mark scan position
1543
 *
1544 1545 1546 1547 1548 1549
 *		Note:
 *				Should only one mark be maintained per scan at one time.
 *		Check if this can be done generally--say calls to get the
 *		next/previous tuple and NEVER pass struct scandesc to the
 *		user AM's.  Now, the mark is sent to the executor for safekeeping.
 *		Probably can store this info into a GENERAL scan structure.
1550
 *
1551 1552 1553
 *		May be best to change this call to store the marked position
 *		(up to 2?) in the scan structure itself.
 *		Fix to use the proper caching structure.
1554 1555 1556
 * ----------------
 */
void
1557
heap_markpos(HeapScanDesc scan)
1558
{
1559 1560 1561 1562 1563 1564 1565 1566 1567 1568

	/* ----------------
	 *	increment access statistics
	 * ----------------
	 */
	IncrHeapAccessStat(local_markpos);
	IncrHeapAccessStat(global_markpos);

	/* Note: no locking manipulations needed */

1569
	if (scan->rs_ptup.t_data == NULL &&
1570
		BufferIsUnknown(scan->rs_pbuf))
1571
	{							/* == NONTUP */
1572 1573 1574 1575 1576 1577 1578 1579
		scan->rs_ptup = scan->rs_ctup;
		heapgettup(scan->rs_rd,
				   &(scan->rs_ptup),
				   -1,
				   &scan->rs_pbuf,
				   scan->rs_snapshot,
				   scan->rs_nkeys,
				   scan->rs_key);
1580 1581

	}
1582
	else if (scan->rs_ntup.t_data == NULL &&
1583
			 BufferIsUnknown(scan->rs_nbuf))
1584
	{							/* == NONTUP */
1585 1586 1587 1588 1589 1590 1591 1592
		scan->rs_ntup = scan->rs_ctup;
		heapgettup(scan->rs_rd,
				   &(scan->rs_ntup),
				   1,
				   &scan->rs_nbuf,
				   scan->rs_snapshot,
				   scan->rs_nkeys,
				   scan->rs_key);
1593 1594 1595 1596 1597 1598
	}

	/* ----------------
	 * Should not unpin the buffer pages.  They may still be in use.
	 * ----------------
	 */
1599 1600
	if (scan->rs_ptup.t_data != NULL)
		scan->rs_mptid = scan->rs_ptup.t_self;
1601
	else
1602
		ItemPointerSetInvalid(&scan->rs_mptid);
1603 1604
	if (scan->rs_ctup.t_data != NULL)
		scan->rs_mctid = scan->rs_ctup.t_self;
1605
	else
1606
		ItemPointerSetInvalid(&scan->rs_mctid);
1607 1608
	if (scan->rs_ntup.t_data != NULL)
		scan->rs_mntid = scan->rs_ntup.t_self;
1609
	else
1610
		ItemPointerSetInvalid(&scan->rs_mntid);
1611 1612 1613
}

/* ----------------
1614
 *		heap_restrpos	- restore position to marked location
1615
 *
1616 1617 1618 1619 1620
 *		Note:  there are bad side effects here.  If we were past the end
 *		of a relation when heapmarkpos is called, then if the relation is
 *		extended via insert, then the next call to heaprestrpos will set
 *		cause the added tuples to be visible when the scan continues.
 *		Problems also arise if the TID's are rearranged!!!
1621
 *
1622 1623 1624
 *		Now pins buffer once for each valid tuple pointer (rs_ptup,
 *		rs_ctup, rs_ntup) referencing it.
 *		 - 01/13/94
1625 1626
 *
 * XXX	might be better to do direct access instead of
1627
 *		using the generality of heapgettup().
1628 1629 1630 1631 1632 1633 1634
 *
 * XXX It is very possible that when a scan is restored, that a tuple
 * XXX which previously qualified may fail for time range purposes, unless
 * XXX some form of locking exists (ie., portals currently can act funny.
 * ----------------
 */
void
1635
heap_restrpos(HeapScanDesc scan)
1636
{
1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647
	/* ----------------
	 *	increment access statistics
	 * ----------------
	 */
	IncrHeapAccessStat(local_restrpos);
	IncrHeapAccessStat(global_restrpos);

	/* XXX no amrestrpos checking that ammarkpos called */

	/* Note: no locking manipulations needed */

1648
	unpinscan(scan);
1649 1650

	/* force heapgettup to pin buffer for each loaded tuple */
1651 1652 1653
	scan->rs_pbuf = InvalidBuffer;
	scan->rs_cbuf = InvalidBuffer;
	scan->rs_nbuf = InvalidBuffer;
1654

1655
	if (!ItemPointerIsValid(&scan->rs_mptid))
1656
		scan->rs_ptup.t_data = NULL;
1657 1658
	else
	{
1659 1660 1661 1662 1663 1664 1665 1666 1667
		scan->rs_ptup.t_self = scan->rs_mptid;
		scan->rs_ptup.t_data = (HeapTupleHeader) 0x1;	/* for heapgettup */
		heapgettup(scan->rs_rd,
				   &(scan->rs_ptup),
				   0,
				   &(scan->rs_pbuf),
				   false,
				   0,
				   (ScanKey) NULL);
1668 1669
	}

1670
	if (!ItemPointerIsValid(&scan->rs_mctid))
1671
		scan->rs_ctup.t_data = NULL;
1672 1673
	else
	{
1674 1675 1676 1677 1678 1679 1680 1681 1682
		scan->rs_ctup.t_self = scan->rs_mctid;
		scan->rs_ctup.t_data = (HeapTupleHeader) 0x1;	/* for heapgettup */
		heapgettup(scan->rs_rd,
				   &(scan->rs_ctup),
				   0,
				   &(scan->rs_cbuf),
				   false,
				   0,
				   (ScanKey) NULL);
1683 1684
	}

1685
	if (!ItemPointerIsValid(&scan->rs_mntid))
1686
		scan->rs_ntup.t_data = NULL;
1687 1688
	else
	{
1689 1690 1691 1692 1693 1694 1695 1696 1697
		scan->rs_ntup.t_self = scan->rs_mntid;
		scan->rs_ntup.t_data = (HeapTupleHeader) 0x1;	/* for heapgettup */
		heapgettup(scan->rs_rd,
				   &(scan->rs_ntup),
				   0,
				   &scan->rs_nbuf,
				   false,
				   0,
				   (ScanKey) NULL);
1698
	}
1699
}