nodeSort.c 9.75 KB
Newer Older
1 2 3
/*-------------------------------------------------------------------------
 *
 * nodeSort.c--
4
 *	  Routines to handle sorting of relations.
5 6 7 8 9
 *
 * Copyright (c) 1994, Regents of the University of California
 *
 *
 * IDENTIFICATION
10
 *	  $Header: /cvsroot/pgsql/src/backend/executor/nodeSort.c,v 1.13 1998/02/23 06:26:56 vadim Exp $
11 12 13
 *
 *-------------------------------------------------------------------------
 */
14 15
#include "postgres.h"

16
#include "executor/executor.h"
Bruce Momjian's avatar
Bruce Momjian committed
17
#include "executor/execdebug.h"
18
#include "executor/nodeSort.h"
Bruce Momjian's avatar
Bruce Momjian committed
19
#include "access/heapam.h"
20 21 22
#include "utils/palloc.h"
#include "utils/psort.h"
#include "catalog/catalog.h"
Bruce Momjian's avatar
Bruce Momjian committed
23
#include "catalog/heap.h"
24 25 26 27
#include "storage/bufmgr.h"
#include "optimizer/internal.h" /* for _TEMP_RELATION_ID_ */

/* ----------------------------------------------------------------
28 29 30 31 32
 *		FormSortKeys(node)
 *
 *		Forms the structure containing information used to sort the relation.
 *
 *		Returns an array of ScanKeyData.
33 34
 * ----------------------------------------------------------------
 */
35
static ScanKey
36
FormSortKeys(Sort *sortnode)
37
{
38 39 40 41 42 43 44 45
	ScanKey		sortkeys;
	List	   *targetList;
	List	   *tl;
	int			keycount;
	Resdom	   *resdom;
	AttrNumber	resno;
	Index		reskey;
	Oid			reskeyop;
46 47 48 49 50 51 52 53 54 55 56 57 58

	/* ----------------
	 *	get information from the node
	 * ----------------
	 */
	targetList = sortnode->plan.targetlist;
	keycount = sortnode->keycount;

	/* ----------------
	 *	first allocate space for scan keys
	 * ----------------
	 */
	if (keycount <= 0)
59
		elog(ERROR, "FormSortKeys: keycount <= 0");
60 61 62 63 64 65 66 67
	sortkeys = (ScanKey) palloc(keycount * sizeof(ScanKeyData));

	/* ----------------
	 *	form each scan key from the resdom info in the target list
	 * ----------------
	 */
	foreach(tl, targetList)
	{
68
		TargetEntry *target = (TargetEntry *) lfirst(tl);
69 70 71 72 73 74 75 76 77 78 79 80 81 82

		resdom = target->resdom;
		resno = resdom->resno;
		reskey = resdom->reskey;
		reskeyop = resdom->reskeyop;

		if (reskey > 0)
		{
			ScanKeyEntryInitialize(&sortkeys[reskey - 1],
								   0,
								   resno,
								   (RegProcedure) DatumGetInt32(reskeyop),
								   (Datum) 0);
		}
83
	}
84 85

	return sortkeys;
86 87 88
}

/* ----------------------------------------------------------------
89
 *		ExecSort
90 91
 *
 * old comments
92 93 94 95 96 97 98 99 100 101
 *		Sorts tuples from the outer subtree of the node in psort,
 *		which saves the results in a temporary file or memory. After the
 *		initial call, returns a tuple from the file with each call.
 *		Assumes that heap access method is used.
 *
 *		Conditions:
 *		  -- none.
 *
 *		Initial States:
 *		  -- the outer child is prepared to return the first tuple.
102 103 104
 * ----------------------------------------------------------------
 */
TupleTableSlot *
105
ExecSort(Sort *node)
106
{
107 108 109 110 111 112 113
	EState	   *estate;
	SortState  *sortstate;
	Plan	   *outerNode;
	ScanDirection dir;
	int			keycount;
	ScanKey		sortkeys;
	HeapTuple	heapTuple;
114
	TupleTableSlot *slot;
Vadim B. Mikheev's avatar
Vadim B. Mikheev committed
115
	bool should_free;
116

117
	/* ----------------
118
	 *	get state info from node
119 120
	 * ----------------
	 */
121 122 123 124 125 126
	SO1_printf("ExecSort: %s\n",
			   "entering routine");

	sortstate = node->sortstate;
	estate = node->plan.state;
	dir = estate->es_direction;
127

128
	/* ----------------
129 130
	 *	the first time we call this, psort sorts this into a file.
	 *	Subsequent calls return tuples from psort.
131 132
	 * ----------------
	 */
133

134
	if (sortstate->sort_Flag == false)
135
	{
136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168
		SO1_printf("ExecSort: %s\n",
				   "sortstate == false -> sorting subplan");
		/* ----------------
		 *	set all relations to be scanned in the forward direction
		 *	while creating the temporary relation.
		 * ----------------
		 */
		estate->es_direction = ForwardScanDirection;

		/* ----------------
		 *	 prepare information for psort_begin()
		 * ----------------
		 */
		outerNode = outerPlan((Plan *) node);

		keycount = node->keycount;
		sortkeys = (ScanKey) sortstate->sort_Keys;
		SO1_printf("ExecSort: %s\n",
				   "calling psort_begin");

		if (!psort_begin(node,	/* this node */
						 keycount,		/* number keys */
						 sortkeys))		/* keys */
		{
			/* Psort says, there are no tuples to be sorted */
			return NULL;
		}

		/* ----------------
		 *	 restore to user specified direction
		 * ----------------
		 */
		estate->es_direction = dir;
169

170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190
		/* ----------------
		 *	make sure the tuple descriptor is up to date
		 * ----------------
		 */
		slot = (TupleTableSlot *) sortstate->csstate.cstate.cs_ResultTupleSlot;
		slot->ttc_tupleDescriptor = ExecGetTupType(outerNode);
		/* ----------------
		 *	finally set the sorted flag to true
		 * ----------------
		 */
		sortstate->sort_Flag = true;
		SO1_printf(stderr, "ExecSort: sorting done.\n");
	}
	else
	{
		slot = (TupleTableSlot *) sortstate->csstate.cstate.cs_ResultTupleSlot;
	}

	SO1_printf("ExecSort: %s\n",
			   "retrieving tuple from sorted relation");

191
	/* ----------------
192
	 *	at this point we grab a tuple from psort
193 194
	 * ----------------
	 */
Vadim B. Mikheev's avatar
Vadim B. Mikheev committed
195
	heapTuple = psort_grabtuple(node, &should_free);
196

Vadim B. Mikheev's avatar
Vadim B. Mikheev committed
197
	return (ExecStoreTuple(heapTuple, slot, InvalidBuffer, should_free));
198 199 200
}

/* ----------------------------------------------------------------
201
 *		ExecInitSort
202 203
 *
 * old comments
204 205
 *		Creates the run-time state information for the sort node
 *		produced by the planner and initailizes its outer subtree.
206 207 208
 * ----------------------------------------------------------------
 */
bool
209
ExecInitSort(Sort *node, EState *estate, Plan *parent)
210
{
211 212 213
	SortState  *sortstate;
	Plan	   *outerPlan;
	ScanKey		sortkeys;
214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246

	SO1_printf("ExecInitSort: %s\n",
			   "initializing sort node");

	/* ----------------
	 *	assign the node's execution state
	 * ----------------
	 */
	node->plan.state = estate;

	/* ----------------
	 * create state structure
	 * ----------------
	 */
	sortstate = makeNode(SortState);
	sortstate->sort_Flag = 0;
	sortstate->sort_Keys = NULL;
	node->cleaned = FALSE;

	node->sortstate = sortstate;

	/* ----------------
	 *	Miscellanious initialization
	 *
	 *		 +	assign node's base_id
	 *		 +	assign debugging hooks
	 *
	 *	Sort nodes don't initialize their ExprContexts because
	 *	they never call ExecQual or ExecTargetList.
	 * ----------------
	 */
	ExecAssignNodeBaseInfo(estate, &sortstate->csstate.cstate, parent);

247
#define SORT_NSLOTS 1
248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290
	/* ----------------
	 *	tuple table initialization
	 *
	 *	sort nodes only return scan tuples from their sorted
	 *	relation.
	 * ----------------
	 */
	ExecInitResultTupleSlot(estate, &sortstate->csstate.cstate);
	ExecInitScanTupleSlot(estate, &sortstate->csstate);

	/* ----------------
	 * initializes child nodes
	 * ----------------
	 */
	outerPlan = outerPlan((Plan *) node);
	ExecInitNode(outerPlan, estate, (Plan *) node);

	/* ----------------
	 *	initialize sortstate information
	 * ----------------
	 */
	sortkeys = FormSortKeys(node);
	sortstate->sort_Keys = sortkeys;
	sortstate->sort_Flag = false;

	/* ----------------
	 *	initialize tuple type.	no need to initialize projection
	 *	info because this node doesn't do projections.
	 * ----------------
	 */
	ExecAssignResultTypeFromOuterPlan((Plan *) node, &sortstate->csstate.cstate);
	ExecAssignScanTypeFromOuterPlan((Plan *) node, &sortstate->csstate);
	sortstate->csstate.cstate.cs_ProjInfo = NULL;

	SO1_printf("ExecInitSort: %s\n",
			   "sort node initialized");

	/* ----------------
	 *	return relation oid of temporary sort relation in a list
	 *	(someday -- for now we return LispTrue... cim 10/12/89)
	 * ----------------
	 */
	return TRUE;
291 292 293
}

int
294
ExecCountSlotsSort(Sort *node)
295
{
296 297 298
	return ExecCountSlotsNode(outerPlan((Plan *) node)) +
	ExecCountSlotsNode(innerPlan((Plan *) node)) +
	SORT_NSLOTS;
299 300 301
}

/* ----------------------------------------------------------------
302
 *		ExecEndSort(node)
303 304 305 306 307
 *
 * old comments
 * ----------------------------------------------------------------
 */
void
308
ExecEndSort(Sort *node)
309
{
310 311
	SortState  *sortstate;
	Plan	   *outerPlan;
312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340

	/* ----------------
	 *	get info from the sort state
	 * ----------------
	 */
	SO1_printf("ExecEndSort: %s\n",
			   "shutting down sort node");

	sortstate = node->sortstate;

	/* ----------------
	 *	shut down the subplan
	 * ----------------
	 */
	outerPlan = outerPlan((Plan *) node);
	ExecEndNode(outerPlan, (Plan *) node);

	/* ----------------
	 *	clean out the tuple table
	 * ----------------
	 */
	ExecClearTuple(sortstate->csstate.css_ScanTupleSlot);

	/* Clean up after psort */
	psort_end(node);

	SO1_printf("ExecEndSort: %s\n",
			   "sort node shutdown");
}
341 342

/* ----------------------------------------------------------------
343
 *		ExecSortMarkPos
344
 *
345
 *		Calls psort to save the current position in the sorted file.
346 347 348
 * ----------------------------------------------------------------
 */
void
349
ExecSortMarkPos(Sort *node)
350
{
351
	SortState  *sortstate;
352 353 354 355 356 357 358 359 360 361 362 363

	/* ----------------
	 *	if we haven't sorted yet, just return
	 * ----------------
	 */
	sortstate = node->sortstate;
	if (sortstate->sort_Flag == false)
		return;

	psort_markpos(node);

	return;
364 365 366
}

/* ----------------------------------------------------------------
367
 *		ExecSortRestrPos
368
 *
369
 *		Calls psort to restore the last saved sort file position.
370 371 372
 * ----------------------------------------------------------------
 */
void
373
ExecSortRestrPos(Sort *node)
374
{
375
	SortState  *sortstate;
376 377 378 379 380 381 382 383 384 385 386 387 388 389

	/* ----------------
	 *	if we haven't sorted yet, just return.
	 * ----------------
	 */
	sortstate = node->sortstate;
	if (sortstate->sort_Flag == false)
		return;

	/* ----------------
	 *	restore the scan to the previously marked position
	 * ----------------
	 */
	psort_restorepos(node);
390
}
391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415

void
ExecReScanSort(Sort *node, ExprContext *exprCtxt, Plan *parent)
{
	SortState  *sortstate = node->sortstate;

	/*
	 * If we haven't sorted yet, just return. If outerplan'
	 * chgParam is not NULL then it will be re-scanned by
	 * ExecProcNode, else - no reason to re-scan it at all.
	 */
	if (sortstate->sort_Flag == false)
		return;
	
	ExecClearTuple(sortstate->csstate.cstate.cs_ResultTupleSlot);
	
	psort_rescan (node);
	
	/*
	 * If subnode is to be rescanned then we aren't sorted
	 */
	if (((Plan*) node)->lefttree->chgParam != NULL)
		sortstate->sort_Flag = false;

}