Remove all traces of tuplestore_donestoring() in the C code

michaelpq · michaelpq · commit d61a361d1aef · 2022-02-17T09:52:02.000+09:00
This routine is a no-op since dd04e95 from 2003, with a macro kept around for compatibility purposes. This has led to the same code patterns being copy-pasted around for no effect, sometimes in confusing ways like in pg_logical_slot_get_changes_guts() from logical.c where the code was actually incorrect. This issue has been discussed on two different threads recently, so rather than living with this legacy, remove any uses of this routine in the C code to simplify things. The compatibility macro is kept to avoid breaking any out-of-core modules that depend on it. Reported-by: Tatsuhito Kasahara, Justin Pryzby Author: Tatsuhito Kasahara Discussion: https://postgr.es/m/20211217200419.GQ17618@telsasoft.com Discussion: https://postgr.es/m/CAP0=ZVJeeYfAeRfmzqAF2Lumdiv4S4FewyBnZd4DPTrsSQKJKw@mail.gmail.com
diff --git a/contrib/dblink/dblink.c b/contrib/dblink/dblink.c
@@ -1005,8 +1005,6 @@ materializeResult(FunctionCallInfo fcinfo, PGconn *conn, PGresult *res)
 			/* clean up GUC settings, if we changed any */
 			restoreLocalGucs(nestlevel);
 
-			/* clean up and return the tuplestore */
-			tuplestore_donestoring(tupstore);
 		}
 	}
 	PG_FINALLY();
@@ -1988,9 +1986,6 @@ dblink_get_notify(PG_FUNCTION_ARGS)
 		PQconsumeInput(conn);
 	}
 
-	/* clean up and return the tuplestore */
-	tuplestore_donestoring(tupstore);
-
 	return (Datum) 0;
 }
 
diff --git a/contrib/pageinspect/brinfuncs.c b/contrib/pageinspect/brinfuncs.c
@@ -325,9 +325,7 @@ brin_page_items(PG_FUNCTION_ARGS)
 			break;
 	}
 
-	/* clean up and return the tuplestore */
 	brin_free_desc(bdesc);
-	tuplestore_donestoring(tupstore);
 	index_close(indexRel, AccessShareLock);
 
 	return (Datum) 0;
diff --git a/contrib/pg_stat_statements/pg_stat_statements.c b/contrib/pg_stat_statements/pg_stat_statements.c
@@ -1803,13 +1803,11 @@ pg_stat_statements_internal(FunctionCallInfo fcinfo,
 		tuplestore_putvalues(tupstore, tupdesc, values, nulls);
 	}
 
-	/* clean up and return the tuplestore */
 	LWLockRelease(pgss->lock);
 
 	if (qbuffer)
 		free(qbuffer);
 
-	tuplestore_donestoring(tupstore);
 }
 
 /* Number of output arguments (columns) for pg_stat_statements_info */
diff --git a/contrib/postgres_fdw/connection.c b/contrib/postgres_fdw/connection.c
@@ -1508,12 +1508,7 @@ postgres_fdw_get_connections(PG_FUNCTION_ARGS)
 
 	/* If cache doesn't exist, we return no records */
 	if (!ConnectionHash)
-	{
-		/* clean up and return the tuplestore */
-		tuplestore_donestoring(tupstore);
-
 		PG_RETURN_VOID();
-	}
 
 	hash_seq_init(&scan, ConnectionHash);
 	while ((entry = (ConnCacheEntry *) hash_seq_search(&scan)))
@@ -1578,8 +1573,6 @@ postgres_fdw_get_connections(PG_FUNCTION_ARGS)
 		tuplestore_putvalues(tupstore, tupdesc, values, nulls);
 	}
 
-	/* clean up and return the tuplestore */
-	tuplestore_donestoring(tupstore);
 
 	PG_RETURN_VOID();
 }
diff --git a/contrib/tablefunc/tablefunc.c b/contrib/tablefunc/tablefunc.c
@@ -943,8 +943,6 @@ get_crosstab_tuplestore(char *sql,
 		/* internal error */
 		elog(ERROR, "get_crosstab_tuplestore: SPI_finish() failed");
 
-	tuplestore_donestoring(tupstore);
-
 	return tupstore;
 }
 
diff --git a/contrib/xml2/xpath.c b/contrib/xml2/xpath.c
@@ -783,8 +783,6 @@ xpath_table(PG_FUNCTION_ARGS)
 
 	pg_xml_done(xmlerrcxt, false);
 
-	tuplestore_donestoring(tupstore);
-
 	SPI_finish();
 
 	rsinfo->setResult = tupstore;
diff --git a/src/backend/access/transam/xlogfuncs.c b/src/backend/access/transam/xlogfuncs.c
@@ -252,7 +252,6 @@ pg_stop_backup_v2(PG_FUNCTION_ARGS)
 	values[0] = LSNGetDatum(stoppoint);
 
 	tuplestore_putvalues(tupstore, tupdesc, values, nulls);
-	tuplestore_donestoring(tupstore);
 
 	return (Datum) 0;
 }
diff --git a/src/backend/commands/event_trigger.c b/src/backend/commands/event_trigger.c
@@ -1401,9 +1401,6 @@ pg_event_trigger_dropped_objects(PG_FUNCTION_ARGS)
 		tuplestore_putvalues(tupstore, tupdesc, values, nulls);
 	}
 
-	/* clean up and return the tuplestore */
-	tuplestore_donestoring(tupstore);
-
 	return (Datum) 0;
 }
 
@@ -2061,9 +2058,6 @@ pg_event_trigger_ddl_commands(PG_FUNCTION_ARGS)
 		tuplestore_putvalues(tupstore, tupdesc, values, nulls);
 	}
 
-	/* clean up and return the tuplestore */
-	tuplestore_donestoring(tupstore);
-
 	PG_RETURN_VOID();
 }
 
diff --git a/src/backend/commands/extension.c b/src/backend/commands/extension.c
@@ -2021,9 +2021,6 @@ pg_available_extensions(PG_FUNCTION_ARGS)
 		FreeDir(dir);
 	}
 
-	/* clean up and return the tuplestore */
-	tuplestore_donestoring(tupstore);
-
 	return (Datum) 0;
 }
 
@@ -2112,9 +2109,6 @@ pg_available_extension_versions(PG_FUNCTION_ARGS)
 		FreeDir(dir);
 	}
 
-	/* clean up and return the tuplestore */
-	tuplestore_donestoring(tupstore);
-
 	return (Datum) 0;
 }
 
@@ -2417,9 +2411,6 @@ pg_extension_update_paths(PG_FUNCTION_ARGS)
 		}
 	}
 
-	/* clean up and return the tuplestore */
-	tuplestore_donestoring(tupstore);
-
 	return (Datum) 0;
 }
 
diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c
@@ -778,9 +778,6 @@ pg_prepared_statement(PG_FUNCTION_ARGS)
 		}
 	}
 
-	/* clean up and return the tuplestore */
-	tuplestore_donestoring(tupstore);
-
 	rsinfo->returnMode = SFRM_Materialize;
 	rsinfo->setResult = tupstore;
 	rsinfo->setDesc = tupdesc;
diff --git a/src/backend/foreign/foreign.c b/src/backend/foreign/foreign.c
@@ -555,9 +555,6 @@ deflist_to_tuplestore(ReturnSetInfo *rsinfo, List *options)
 		tuplestore_putvalues(tupstore, tupdesc, values, nulls);
 	}
 
-	/* clean up and return the tuplestore */
-	tuplestore_donestoring(tupstore);
-
 	MemoryContextSwitchTo(oldcontext);
 }
 
diff --git a/src/backend/replication/logical/launcher.c b/src/backend/replication/logical/launcher.c
@@ -1022,8 +1022,5 @@ pg_stat_get_subscription(PG_FUNCTION_ARGS)
 
 	LWLockRelease(LogicalRepWorkerLock);
 
-	/* clean up and return the tuplestore */
-	tuplestore_donestoring(tupstore);
-
 	return (Datum) 0;
 }
diff --git a/src/backend/replication/logical/logicalfuncs.c b/src/backend/replication/logical/logicalfuncs.c
@@ -296,8 +296,6 @@ pg_logical_slot_get_changes_guts(FunctionCallInfo fcinfo, bool confirm, bool bin
 			CHECK_FOR_INTERRUPTS();
 		}
 
-		tuplestore_donestoring(tupstore);
-
 		/*
 		 * Logical decoding could have clobbered CurrentResourceOwner during
 		 * transaction management, so restore the executor's value.  (This is
diff --git a/src/backend/replication/logical/origin.c b/src/backend/replication/logical/origin.c
@@ -1568,8 +1568,6 @@ pg_show_replication_origin_status(PG_FUNCTION_ARGS)
 		tuplestore_putvalues(tupstore, tupdesc, values, nulls);
 	}
 
-	tuplestore_donestoring(tupstore);
-
 	LWLockRelease(ReplicationOriginLock);
 
 #undef REPLICATION_ORIGIN_PROGRESS_COLS
diff --git a/src/backend/replication/slotfuncs.c b/src/backend/replication/slotfuncs.c
@@ -436,8 +436,6 @@ pg_get_replication_slots(PG_FUNCTION_ARGS)
 
 	LWLockRelease(ReplicationSlotControlLock);
 
-	tuplestore_donestoring(tupstore);
-
 	return (Datum) 0;
 }
 
diff --git a/src/backend/replication/walsender.c b/src/backend/replication/walsender.c
@@ -3580,9 +3580,6 @@ pg_stat_get_wal_senders(PG_FUNCTION_ARGS)
 		tuplestore_putvalues(tupstore, tupdesc, values, nulls);
 	}
 
-	/* clean up and return the tuplestore */
-	tuplestore_donestoring(tupstore);
-
 	return (Datum) 0;
 }
 
diff --git a/src/backend/storage/ipc/shmem.c b/src/backend/storage/ipc/shmem.c
@@ -605,7 +605,5 @@ pg_get_shmem_allocations(PG_FUNCTION_ARGS)
 
 	LWLockRelease(ShmemIndexLock);
 
-	tuplestore_donestoring(tupstore);
-
 	return (Datum) 0;
 }
diff --git a/src/backend/utils/adt/mcxtfuncs.c b/src/backend/utils/adt/mcxtfuncs.c
@@ -152,9 +152,6 @@ pg_get_backend_memory_contexts(PG_FUNCTION_ARGS)
 	PutMemoryContextsStatsTupleStore(tupstore, tupdesc,
 									 TopMemoryContext, NULL, 0);
 
-	/* clean up and return the tuplestore */
-	tuplestore_donestoring(tupstore);
-
 	return (Datum) 0;
 }
 
diff --git a/src/backend/utils/adt/pgstatfuncs.c b/src/backend/utils/adt/pgstatfuncs.c
@@ -555,9 +555,6 @@ pg_stat_get_progress_info(PG_FUNCTION_ARGS)
 		tuplestore_putvalues(tupstore, tupdesc, values, nulls);
 	}
 
-	/* clean up and return the tuplestore */
-	tuplestore_donestoring(tupstore);
-
 	return (Datum) 0;
 }
 
@@ -953,9 +950,6 @@ pg_stat_get_activity(PG_FUNCTION_ARGS)
 			break;
 	}
 
-	/* clean up and return the tuplestore */
-	tuplestore_donestoring(tupstore);
-
 	return (Datum) 0;
 }
 
@@ -1936,9 +1930,6 @@ pg_stat_get_slru(PG_FUNCTION_ARGS)
 		tuplestore_putvalues(tupstore, tupdesc, values, nulls);
 	}
 
-	/* clean up and return the tuplestore */
-	tuplestore_donestoring(tupstore);
-
 	return (Datum) 0;
 }
 
diff --git a/src/backend/utils/adt/varlena.c b/src/backend/utils/adt/varlena.c
@@ -4855,8 +4855,6 @@ text_to_table(PG_FUNCTION_ARGS)
 
 	(void) split_text(fcinfo, &tstate);
 
-	tuplestore_donestoring(tstate.tupstore);
-
 	rsi->returnMode = SFRM_Materialize;
 	rsi->setResult = tstate.tupstore;
 	rsi->setDesc = tstate.tupdesc;
diff --git a/src/backend/utils/misc/guc.c b/src/backend/utils/misc/guc.c
@@ -10206,8 +10206,6 @@ show_all_file_settings(PG_FUNCTION_ARGS)
 		tuplestore_putvalues(tupstore, tupdesc, values, nulls);
 	}
 
-	tuplestore_donestoring(tupstore);
-
 	return (Datum) 0;
 }
 
diff --git a/src/backend/utils/misc/pg_config.c b/src/backend/utils/misc/pg_config.c
@@ -85,7 +85,6 @@ pg_config(PG_FUNCTION_ARGS)
 	 */
 	ReleaseTupleDesc(tupdesc);
 
-	tuplestore_donestoring(tupstore);
 	rsinfo->setResult = tupstore;
 
 	/*
diff --git a/src/backend/utils/mmgr/portalmem.c b/src/backend/utils/mmgr/portalmem.c
@@ -1204,9 +1204,6 @@ pg_cursor(PG_FUNCTION_ARGS)
 		tuplestore_putvalues(tupstore, tupdesc, values, nulls);
 	}
 
-	/* clean up and return the tuplestore */
-	tuplestore_donestoring(tupstore);
-
 	rsinfo->returnMode = SFRM_Materialize;
 	rsinfo->setResult = tupstore;
 	rsinfo->setDesc = tupdesc;
diff --git a/src/include/utils/tuplestore.h b/src/include/utils/tuplestore.h
@@ -56,7 +56,7 @@ extern void tuplestore_puttuple(Tuplestorestate *state, HeapTuple tuple);
 extern void tuplestore_putvalues(Tuplestorestate *state, TupleDesc tdesc,
 								 Datum *values, bool *isnull);
 
-/* tuplestore_donestoring() used to be required, but is no longer used */
+/* Backwards compatibility macro */
 #define tuplestore_donestoring(state)	((void) 0)
 
 extern int	tuplestore_alloc_read_pointer(Tuplestorestate *state, int eflags);

Original file line number	Diff line number	Diff line change
`@@ -1005,8 +1005,6 @@ materializeResult(FunctionCallInfo fcinfo, PGconn conn, PGresult res)`
`1005`	`1005`	`/* clean up GUC settings, if we changed any */`
`1006`	`1006`	`restoreLocalGucs(nestlevel);`
`1007`	`1007`
`1008`		`- /* clean up and return the tuplestore */`
`1009`		`- tuplestore_donestoring(tupstore);`
`1010`	`1008`	`}`
`1011`	`1009`	`}`
`1012`	`1010`	`PG_FINALLY();`
`@@ -1988,9 +1986,6 @@ dblink_get_notify(PG_FUNCTION_ARGS)`
`1988`	`1986`	`PQconsumeInput(conn);`
`1989`	`1987`	`}`
`1990`	`1988`
`1991`		`- /* clean up and return the tuplestore */`
`1992`		`- tuplestore_donestoring(tupstore);`
`1993`		`-`
`1994`	`1989`	`return (Datum) 0;`
`1995`	`1990`	`}`
`1996`	`1991`
Original file line number	Diff line number	Diff line change
`@@ -325,9 +325,7 @@ brin_page_items(PG_FUNCTION_ARGS)`
`325`	`325`	`break;`
`326`	`326`	`}`
`327`	`327`
`328`		`- /* clean up and return the tuplestore */`
`329`	`328`	`brin_free_desc(bdesc);`
`330`		`- tuplestore_donestoring(tupstore);`
`331`	`329`	`index_close(indexRel, AccessShareLock);`
`332`	`330`
`333`	`331`	`return (Datum) 0;`
Original file line number	Diff line number	Diff line change
`@@ -1803,13 +1803,11 @@ pg_stat_statements_internal(FunctionCallInfo fcinfo,`
`1803`	`1803`	`tuplestore_putvalues(tupstore, tupdesc, values, nulls);`
`1804`	`1804`	`}`
`1805`	`1805`
`1806`		`- /* clean up and return the tuplestore */`
`1807`	`1806`	`LWLockRelease(pgss->lock);`
`1808`	`1807`
`1809`	`1808`	`if (qbuffer)`
`1810`	`1809`	`free(qbuffer);`
`1811`	`1810`
`1812`		`- tuplestore_donestoring(tupstore);`
`1813`	`1811`	`}`
`1814`	`1812`
`1815`	`1813`	`/* Number of output arguments (columns) for pg_stat_statements_info */`
Original file line number	Diff line number	Diff line change
`@@ -943,8 +943,6 @@ get_crosstab_tuplestore(char *sql,`
`943`	`943`	`/* internal error */`
`944`	`944`	`elog(ERROR, "get_crosstab_tuplestore: SPI_finish() failed");`
`945`	`945`
`946`		`- tuplestore_donestoring(tupstore);`
`947`		`-`
`948`	`946`	`return tupstore;`
`949`	`947`	`}`
`950`	`948`
Original file line number	Diff line number	Diff line change
`@@ -252,7 +252,6 @@ pg_stop_backup_v2(PG_FUNCTION_ARGS)`
`252`	`252`	`values[0] = LSNGetDatum(stoppoint);`
`253`	`253`
`254`	`254`	`tuplestore_putvalues(tupstore, tupdesc, values, nulls);`
`255`		`- tuplestore_donestoring(tupstore);`
`256`	`255`
`257`	`256`	`return (Datum) 0;`
`258`	`257`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1401,9 +1401,6 @@ pg_event_trigger_dropped_objects(PG_FUNCTION_ARGS)`
`1401`	`1401`	`tuplestore_putvalues(tupstore, tupdesc, values, nulls);`
`1402`	`1402`	`}`
`1403`	`1403`
`1404`		`- /* clean up and return the tuplestore */`
`1405`		`- tuplestore_donestoring(tupstore);`
`1406`		`-`
`1407`	`1404`	`return (Datum) 0;`
`1408`	`1405`	`}`
`1409`	`1406`
`@@ -2061,9 +2058,6 @@ pg_event_trigger_ddl_commands(PG_FUNCTION_ARGS)`
`2061`	`2058`	`tuplestore_putvalues(tupstore, tupdesc, values, nulls);`
`2062`	`2059`	`}`
`2063`	`2060`
`2064`		`- /* clean up and return the tuplestore */`
`2065`		`- tuplestore_donestoring(tupstore);`
`2066`		`-`
`2067`	`2061`	`PG_RETURN_VOID();`
`2068`	`2062`	`}`
`2069`	`2063`
Original file line number	Diff line number	Diff line change
`@@ -2021,9 +2021,6 @@ pg_available_extensions(PG_FUNCTION_ARGS)`
`2021`	`2021`	`FreeDir(dir);`
`2022`	`2022`	`}`
`2023`	`2023`
`2024`		`- /* clean up and return the tuplestore */`
`2025`		`- tuplestore_donestoring(tupstore);`
`2026`		`-`
`2027`	`2024`	`return (Datum) 0;`
`2028`	`2025`	`}`
`2029`	`2026`
`@@ -2112,9 +2109,6 @@ pg_available_extension_versions(PG_FUNCTION_ARGS)`
`2112`	`2109`	`FreeDir(dir);`
`2113`	`2110`	`}`
`2114`	`2111`
`2115`		`- /* clean up and return the tuplestore */`
`2116`		`- tuplestore_donestoring(tupstore);`
`2117`		`-`
`2118`	`2112`	`return (Datum) 0;`
`2119`	`2113`	`}`
`2120`	`2114`
`@@ -2417,9 +2411,6 @@ pg_extension_update_paths(PG_FUNCTION_ARGS)`
`2417`	`2411`	`}`
`2418`	`2412`	`}`
`2419`	`2413`
`2420`		`- /* clean up and return the tuplestore */`
`2421`		`- tuplestore_donestoring(tupstore);`
`2422`		`-`
`2423`	`2414`	`return (Datum) 0;`
`2424`	`2415`	`}`
`2425`	`2416`
Original file line number	Diff line number	Diff line change
`@@ -778,9 +778,6 @@ pg_prepared_statement(PG_FUNCTION_ARGS)`
`778`	`778`	`}`
`779`	`779`	`}`
`780`	`780`
`781`		`- /* clean up and return the tuplestore */`
`782`		`- tuplestore_donestoring(tupstore);`
`783`		`-`
`784`	`781`	`rsinfo->returnMode = SFRM_Materialize;`
`785`	`782`	`rsinfo->setResult = tupstore;`
`786`	`783`	`rsinfo->setDesc = tupdesc;`