Replace calls to pg_qsort() with the qsort() macro.

nathan-bossart · nathan-bossart · commit 5497daf3aa2a · 2024-02-16T11:37:50.000-06:00
Calls to this function might give the impression that pg_qsort() is somehow different than qsort(), when in fact there is a qsort() macro in port.h that expands all in-tree uses to pg_qsort(). Reviewed-by: Mats Kindahl Discussion: https://postgr.es/m/CA%2B14426g2Wa9QuUpmakwPxXFWG_1FaY0AsApkvcTBy-YfS6uaw%40mail.gmail.com
diff --git a/contrib/pg_prewarm/autoprewarm.c b/contrib/pg_prewarm/autoprewarm.c
@@ -346,8 +346,8 @@ apw_load_buffers(void)
 	FreeFile(file);
 
 	/* Sort the blocks to be loaded. */
-	pg_qsort(blkinfo, num_elements, sizeof(BlockInfoRecord),
-			 apw_compare_blockinfo);
+	qsort(blkinfo, num_elements, sizeof(BlockInfoRecord),
+		  apw_compare_blockinfo);
 
 	/* Populate shared memory state. */
 	apw_state->block_info_handle = dsm_segment_handle(seg);
diff --git a/src/backend/access/brin/brin_minmax_multi.c b/src/backend/access/brin/brin_minmax_multi.c
@@ -1369,7 +1369,7 @@ build_distances(FmgrInfo *distanceFn, Oid colloid,
 	 * Sort the distances in descending order, so that the longest gaps are at
 	 * the front.
 	 */
-	pg_qsort(distances, ndistances, sizeof(DistanceValue), compare_distances);
+	qsort(distances, ndistances, sizeof(DistanceValue), compare_distances);
 
 	return distances;
 }
diff --git a/src/backend/optimizer/plan/analyzejoins.c b/src/backend/optimizer/plan/analyzejoins.c
@@ -2307,8 +2307,8 @@ remove_self_joins_recurse(PlannerInfo *root, List *joinlist, Relids toRemove)
 		j++;
 	}
 
-	pg_qsort(candidates, numRels, sizeof(SelfJoinCandidate),
-			 self_join_candidates_cmp);
+	qsort(candidates, numRels, sizeof(SelfJoinCandidate),
+		  self_join_candidates_cmp);
 
 	/*
 	 * Iteratively form a group of relation indexes with the same oid and
diff --git a/src/backend/storage/buffer/bufmgr.c b/src/backend/storage/buffer/bufmgr.c
@@ -3915,7 +3915,7 @@ DropRelationsAllBuffers(SMgrRelation *smgr_reln, int nlocators)
 
 	/* sort the list of rlocators if necessary */
 	if (use_bsearch)
-		pg_qsort(locators, n, sizeof(RelFileLocator), rlocator_comparator);
+		qsort(locators, n, sizeof(RelFileLocator), rlocator_comparator);
 
 	for (i = 0; i < NBuffers; i++)
 	{
@@ -4269,7 +4269,7 @@ FlushRelationsAllBuffers(SMgrRelation *smgrs, int nrels)
 
 	/* sort the list of SMgrRelations if necessary */
 	if (use_bsearch)
-		pg_qsort(srels, nrels, sizeof(SMgrSortArray), rlocator_comparator);
+		qsort(srels, nrels, sizeof(SMgrSortArray), rlocator_comparator);
 
 	for (i = 0; i < NBuffers; i++)
 	{
diff --git a/src/backend/utils/cache/syscache.c b/src/backend/utils/cache/syscache.c
@@ -146,14 +146,14 @@ InitCatalogCache(void)
 	Assert(SysCacheSupportingRelOidSize <= lengthof(SysCacheSupportingRelOid));
 
 	/* Sort and de-dup OID arrays, so we can use binary search. */
-	pg_qsort(SysCacheRelationOid, SysCacheRelationOidSize,
-			 sizeof(Oid), oid_compare);
+	qsort(SysCacheRelationOid, SysCacheRelationOidSize,
+		  sizeof(Oid), oid_compare);
 	SysCacheRelationOidSize =
 		qunique(SysCacheRelationOid, SysCacheRelationOidSize, sizeof(Oid),
 				oid_compare);
 
-	pg_qsort(SysCacheSupportingRelOid, SysCacheSupportingRelOidSize,
-			 sizeof(Oid), oid_compare);
+	qsort(SysCacheSupportingRelOid, SysCacheSupportingRelOidSize,
+		  sizeof(Oid), oid_compare);
 	SysCacheSupportingRelOidSize =
 		qunique(SysCacheSupportingRelOid, SysCacheSupportingRelOidSize,
 				sizeof(Oid), oid_compare);
@@ -668,7 +668,7 @@ RelationSupportsSysCache(Oid relid)
 
 
 /*
- * OID comparator for pg_qsort
+ * OID comparator for qsort
  */
 static int
 oid_compare(const void *a, const void *b)
diff --git a/src/include/port.h b/src/include/port.h
@@ -438,6 +438,10 @@ extern bool pg_get_user_name(uid_t user_id, char *buffer, size_t buflen);
 extern bool pg_get_user_home_dir(uid_t user_id, char *buffer, size_t buflen);
 #endif
 
+/*
+ * Callers should use the qsort() macro defined below instead of calling
+ * pg_qsort() directly.
+ */
 extern void pg_qsort(void *base, size_t nel, size_t elsize,
 					 int (*cmp) (const void *, const void *));
 extern int	pg_qsort_strcmp(const void *a, const void *b);

Original file line number	Diff line number	Diff line change
`@@ -1369,7 +1369,7 @@ build_distances(FmgrInfo *distanceFn, Oid colloid,`
`1369`	`1369`	`* Sort the distances in descending order, so that the longest gaps are at`
`1370`	`1370`	`* the front.`
`1371`	`1371`	`*/`
`1372`		`- pg_qsort(distances, ndistances, sizeof(DistanceValue), compare_distances);`
	`1372`	`+ qsort(distances, ndistances, sizeof(DistanceValue), compare_distances);`
`1373`	`1373`
`1374`	`1374`	`return distances;`
`1375`	`1375`	`}`
Original file line number	Diff line number	Diff line change
`@@ -2307,8 +2307,8 @@ remove_self_joins_recurse(PlannerInfo root, List joinlist, Relids toRemove)`
`2307`	`2307`	`j++;`
`2308`	`2308`	`}`
`2309`	`2309`
`2310`		`- pg_qsort(candidates, numRels, sizeof(SelfJoinCandidate),`
`2311`		`- self_join_candidates_cmp);`
	`2310`	`+ qsort(candidates, numRels, sizeof(SelfJoinCandidate),`
	`2311`	`+ self_join_candidates_cmp);`
`2312`	`2312`
`2313`	`2313`	`/*`
`2314`	`2314`	`* Iteratively form a group of relation indexes with the same oid and`
Original file line number	Diff line number	Diff line change
`@@ -3915,7 +3915,7 @@ DropRelationsAllBuffers(SMgrRelation *smgr_reln, int nlocators)`
`3915`	`3915`
`3916`	`3916`	`/* sort the list of rlocators if necessary */`
`3917`	`3917`	`if (use_bsearch)`
`3918`		`- pg_qsort(locators, n, sizeof(RelFileLocator), rlocator_comparator);`
	`3918`	`+ qsort(locators, n, sizeof(RelFileLocator), rlocator_comparator);`
`3919`	`3919`
`3920`	`3920`	`for (i = 0; i < NBuffers; i++)`
`3921`	`3921`	`{`
`@@ -4269,7 +4269,7 @@ FlushRelationsAllBuffers(SMgrRelation *smgrs, int nrels)`
`4269`	`4269`
`4270`	`4270`	`/* sort the list of SMgrRelations if necessary */`
`4271`	`4271`	`if (use_bsearch)`
`4272`		`- pg_qsort(srels, nrels, sizeof(SMgrSortArray), rlocator_comparator);`
	`4272`	`+ qsort(srels, nrels, sizeof(SMgrSortArray), rlocator_comparator);`
`4273`	`4273`
`4274`	`4274`	`for (i = 0; i < NBuffers; i++)`
`4275`	`4275`	`{`