Skip to content

Commit

Permalink
Refactor vacuum cutoffs compatibility functions
Browse files Browse the repository at this point in the history 
The compatibility layer in TimescaleDB consolidates the API
differences around getting the vacuum cutoffs (used by, e.g.,
TimescaleDB's reorder) based on an old API. Since PostgreSQL 17
introduced a new function API to get the vacuum cutoffs, this change
refactors the compitability layer to provide the new API for older
PostgreSQL versions.
  • Loading branch information
@erimatnor
erimatnor committed Jan 15, 2025
1 parent 85437c0 commit 04009b1
Show file tree
Hide file tree
Showing 2 changed files with 69 additions and 76 deletions.
108 changes: 45 additions & 63 deletions src/compat/compat.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
#include <commands/defrem.h>
#include <commands/explain.h>
#include <commands/trigger.h>
#include <commands/vacuum.h>
#include <executor/executor.h>
#include <executor/tuptable.h>
#include <nodes/execnodes.h>
Expand Down Expand Up @@ -417,74 +418,54 @@ pg_strtoint64(const char *str)
check_index_is_clusterable(rel, indexOid, true, lock)
#endif

#if PG16_LT
/*
* PG15 consolidate VACUUM xid cutoff logic.
*
* https://github.com/postgres/postgres/commit/efa4a946
*
* PG16 introduced VacuumCutoffs so define here for previous PG versions.
*/
#if PG15_LT
#define vacuum_set_xid_limits_compat(rel, \
freeze_min_age, \
freeze_table_age, \
multixact_freeze_min_age, \
multixact_freeze_table_age, \
oldestXmin, \
freezeLimit, \
multiXactCutoff) \
vacuum_set_xid_limits(rel, \
freeze_min_age, \
freeze_table_age, \
multixact_freeze_min_age, \
multixact_freeze_table_age, \
oldestXmin, \
freezeLimit, \
NULL, \
multiXactCutoff, \
NULL)
#elif PG16_LT
#define vacuum_set_xid_limits_compat(rel, \
freeze_min_age, \
freeze_table_age, \
multixact_freeze_min_age, \
multixact_freeze_table_age, \
oldestXmin, \
freezeLimit, \
multiXactCutoff) \
do \
{ \
MultiXactId oldestMxact; \
vacuum_set_xid_limits(rel, \
freeze_min_age, \
freeze_table_age, \
multixact_freeze_min_age, \
multixact_freeze_table_age, \
oldestXmin, \
&oldestMxact, \
freezeLimit, \
multiXactCutoff); \
} while (0)
#else
#define vacuum_set_xid_limits_compat(rel, \
freezeMinAge, \
freezeTableAge, \
multixactFreezeMinAge, \
multixactFreezeTableAge, \
oldestXmin, \
freezeLimit, \
multiXactCutoff) \
do \
{ \
struct VacuumCutoffs cutoffs; \
/* vacuum_get_cutoffs uses only the *_age members of the VacuumParams object */ \
VacuumParams params = { .freeze_min_age = freezeMinAge, \
.freeze_table_age = freezeTableAge, \
.multixact_freeze_min_age = multixactFreezeMinAge, \
.multixact_freeze_table_age = multixactFreezeTableAge }; \
vacuum_get_cutoffs(rel, &params, &cutoffs); \
*(oldestXmin) = cutoffs.OldestXmin; \
*(freezeLimit) = cutoffs.FreezeLimit; \
*(multiXactCutoff) = cutoffs.MultiXactCutoff; \
} while (0)
struct VacuumCutoffs
{
TransactionId relfrozenxid;
MultiXactId relminmxid;
TransactionId OldestXmin;
MultiXactId OldestMxact;
TransactionId FreezeLimit;
MultiXactId MultiXactCutoff;
};

static inline bool
vacuum_get_cutoffs(Relation rel, const VacuumParams *params, struct VacuumCutoffs *cutoffs)
{
#if PG15
return vacuum_set_xid_limits(rel,
0,
0,
0,
0,
&cutoffs->OldestXmin,
&cutoffs->OldestMxact,
&cutoffs->FreezeLimit,
&cutoffs->MultiXactCutoff);
#elif PG14
vacuum_set_xid_limits(rel,
0,
0,
0,
0,
&cutoffs->OldestXmin,
&cutoffs->FreezeLimit,
NULL,
&cutoffs->MultiXactCutoff,
NULL);

/* Should aggressive vacuum be done? PG14 doesn't support the return value
* so return false. */
return false;
#endif
}
#endif

/*
Expand Down Expand Up @@ -977,3 +958,4 @@ RestrictSearchPath(void)
is_internal, \
constraintId)
#endif

37 changes: 24 additions & 13 deletions tsl/src/reorder.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -534,9 +534,6 @@ copy_heap_data(Oid OIDNewHeap, Oid OIDOldHeap, Oid OIDOldIndex, bool verbose,
int natts;
Datum *values;
bool *isnull;
TransactionId OldestXmin;
TransactionId FreezeXid;
MultiXactId MultiXactCutoff;
bool use_sort;
double num_tuples = 0, tups_vacuumed = 0, tups_recently_dead = 0;
BlockNumber num_pages;
Expand Down Expand Up @@ -626,24 +623,38 @@ copy_heap_data(Oid OIDNewHeap, Oid OIDOldHeap, Oid OIDOldIndex, bool verbose,
* Since we're going to rewrite the whole table anyway, there's no reason
* not to be aggressive about this.
*/
vacuum_set_xid_limits_compat(OldHeap, 0, 0, 0, 0, &OldestXmin, &FreezeXid, &MultiXactCutoff);
struct VacuumCutoffs cutoffs;
VacuumParams params;

memset(&params, 0, sizeof(VacuumParams));
vacuum_get_cutoffs(OldHeap, &params, &cutoffs);

/*
* FreezeXid will become the table's new relfrozenxid, and that mustn't go
* backwards, so take the max.
*/
if (TransactionIdPrecedes(FreezeXid, OldHeap->rd_rel->relfrozenxid))
FreezeXid = OldHeap->rd_rel->relfrozenxid;
{
TransactionId relfrozenxid = OldHeap->rd_rel->relfrozenxid;

if (TransactionIdIsValid(relfrozenxid) &&
TransactionIdPrecedes(cutoffs.FreezeLimit, relfrozenxid))
cutoffs.FreezeLimit = relfrozenxid;
}

/*
* MultiXactCutoff, similarly, shouldn't go backwards either.
*/
if (MultiXactIdPrecedes(MultiXactCutoff, OldHeap->rd_rel->relminmxid))
MultiXactCutoff = OldHeap->rd_rel->relminmxid;
{
MultiXactId relminmxid = OldHeap->rd_rel->relminmxid;

if (MultiXactIdIsValid(relminmxid) &&
MultiXactIdPrecedes(cutoffs.MultiXactCutoff, relminmxid))
cutoffs.MultiXactCutoff = relminmxid;
}

/* return selected values to caller */
*pFreezeXid = FreezeXid;
*pCutoffMulti = MultiXactCutoff;
*pFreezeXid = cutoffs.FreezeLimit;
*pCutoffMulti = cutoffs.MultiXactCutoff;

/*
* We know how to use a sort to duplicate the ordering of a btree index,
Expand Down Expand Up @@ -677,9 +688,9 @@ copy_heap_data(Oid OIDNewHeap, Oid OIDOldHeap, Oid OIDOldIndex, bool verbose,
NewHeap,
OldIndex,
use_sort,
OldestXmin,
&FreezeXid,
&MultiXactCutoff,
cutoffs.OldestXmin,
&cutoffs.FreezeLimit,
&cutoffs.MultiXactCutoff,
&num_tuples,
&tups_vacuumed,
&tups_recently_dead);
Expand Down

0 comments on commit 04009b1

Please sign in to comment.