Turn HeapKeyTest macro into inline function

petere · petere · commit 4eb3b1120001 · 2022-11-16T13:26:48.000+01:00
It is easier to read as a function. Author: Melanie Plageman <melanieplageman@gmail.com> Reviewed-by: Andres Freund <andres@anarazel.de> Discussion: https://www.postgresql.org/message-id/flat/CAAKRu_YSOnhKsDyFcqJsKtBSrd32DP-jjXmv7hL0BPD-z0TGXQ@mail.gmail.com
diff --git a/src/backend/access/heap/heapam.c b/src/backend/access/heap/heapam.c
@@ -719,8 +719,8 @@ heapgettup(HeapScanDesc scan,
 													snapshot);
 
 				if (valid && key != NULL)
-					HeapKeyTest(tuple, RelationGetDescr(scan->rs_base.rs_rd),
-								nkeys, key, valid);
+					valid = HeapKeyTest(tuple, RelationGetDescr(scan->rs_base.rs_rd),
+										nkeys, key);
 
 				if (valid)
 				{
@@ -1035,8 +1035,8 @@ heapgettup_pagemode(HeapScanDesc scan,
 			{
 				bool		valid;
 
-				HeapKeyTest(tuple, RelationGetDescr(scan->rs_base.rs_rd),
-							nkeys, key, valid);
+				valid = HeapKeyTest(tuple, RelationGetDescr(scan->rs_base.rs_rd),
+									nkeys, key);
 				if (valid)
 				{
 					scan->rs_cindex = lineindex;
diff --git a/src/include/access/valid.h b/src/include/access/valid.h
@@ -14,56 +14,45 @@
 #ifndef VALID_H
 #define VALID_H
 
+#include "access/htup.h"
+#include "access/htup_details.h"
+#include "access/skey.h"
+#include "access/tupdesc.h"
+
 /*
  *		HeapKeyTest
  *
  *		Test a heap tuple to see if it satisfies a scan key.
  */
-#define HeapKeyTest(tuple, \
-					tupdesc, \
-					nkeys, \
-					keys, \
-					result) \
-do \
-{ \
-	/* Use underscores to protect the variables passed in as parameters */ \
-	int			__cur_nkeys = (nkeys); \
-	ScanKey		__cur_keys = (keys); \
- \
-	(result) = true; /* may change */ \
-	for (; __cur_nkeys--; __cur_keys++) \
-	{ \
-		Datum	__atp; \
-		bool	__isnull; \
-		Datum	__test; \
- \
-		if (__cur_keys->sk_flags & SK_ISNULL) \
-		{ \
-			(result) = false; \
-			break; \
-		} \
- \
-		__atp = heap_getattr((tuple), \
-							 __cur_keys->sk_attno, \
-							 (tupdesc), \
-							 &__isnull); \
- \
-		if (__isnull) \
-		{ \
-			(result) = false; \
-			break; \
-		} \
- \
-		__test = FunctionCall2Coll(&__cur_keys->sk_func, \
-								   __cur_keys->sk_collation, \
-								   __atp, __cur_keys->sk_argument); \
- \
-		if (!DatumGetBool(__test)) \
-		{ \
-			(result) = false; \
-			break; \
-		} \
-	} \
-} while (0)
+static inline bool
+HeapKeyTest(HeapTuple tuple, TupleDesc tupdesc, int nkeys, ScanKey keys)
+{
+	int			cur_nkeys = nkeys;
+	ScanKey		cur_key = keys;
+
+	for (; cur_nkeys--; cur_key++)
+	{
+		Datum		atp;
+		bool		isnull;
+		Datum		test;
+
+		if (cur_key->sk_flags & SK_ISNULL)
+			return false;
+
+		atp = heap_getattr(tuple, cur_key->sk_attno, tupdesc, &isnull);
+
+		if (isnull)
+			return false;
+
+		test = FunctionCall2Coll(&cur_key->sk_func,
+								 cur_key->sk_collation,
+								 atp, cur_key->sk_argument);
+
+		if (!DatumGetBool(test))
+			return false;
+	}
+
+	return true;
+}
 
 #endif							/* VALID_H */

Original file line number	Diff line number	Diff line change
`@@ -719,8 +719,8 @@ heapgettup(HeapScanDesc scan,`
`719`	`719`	`snapshot);`
`720`	`720`
`721`	`721`	`if (valid && key != NULL)`
`722`		`- HeapKeyTest(tuple, RelationGetDescr(scan->rs_base.rs_rd),`
`723`		`- nkeys, key, valid);`
	`722`	`+ valid = HeapKeyTest(tuple, RelationGetDescr(scan->rs_base.rs_rd),`
	`723`	`+ nkeys, key);`
`724`	`724`
`725`	`725`	`if (valid)`
`726`	`726`	`{`
`@@ -1035,8 +1035,8 @@ heapgettup_pagemode(HeapScanDesc scan,`
`1035`	`1035`	`{`
`1036`	`1036`	`bool valid;`
`1037`	`1037`
`1038`		`- HeapKeyTest(tuple, RelationGetDescr(scan->rs_base.rs_rd),`
`1039`		`- nkeys, key, valid);`
	`1038`	`+ valid = HeapKeyTest(tuple, RelationGetDescr(scan->rs_base.rs_rd),`
	`1039`	`+ nkeys, key);`
`1040`	`1040`	`if (valid)`
`1041`	`1041`	`{`
`1042`	`1042`	`scan->rs_cindex = lineindex;`