ABI Compliance Checker Module #38

MankiratSingh1315 · 2025-06-11T15:04:40Z

Introducing a new build farm module, ABICompCheck,
designed to perform Application Binary Interface (ABI) compliance checking
for PostgreSQL builds using libabigail tools abidiff and abidw.

The module helps detect unintended ABI changes in stable branches
by comparing the latest commit against the most recent tag on that branch or the most recent entry in .abi-complaince-history if present in the source.
This is crucial for maintaining compatibility
for the PostgreSQL ABI stability guidelines for minor releases.

PGBuild/Modules/ABICompCheck.pm

MankiratSingh1315 · 2025-06-16T21:53:29Z

will be working on the minor bugs like the abidw flags, binaries to compliance check and the postgres cflags take them from config,
last_commit_hash_file thing is still not working, will fix it as well

this is the output directory structure as of now

MankiratSingh1315 · 2025-06-16T21:57:33Z

Output Logs as of now

Tue Jun 17 02:59:13 2025: buildfarm run for df4c2566:HEAD starting
df4c2566:HEAD          [02:59:14] checking out source ...
df4c2566:HEAD          [02:59:17] checking if build run needed ...
df4c2566:HEAD          [02:59:17] checking if run needed by PGBuild::Modules::ABICompCheck
df4c2566:HEAD          [02:59:17] ABICompCheck: Stored PostgreSQL commit hash file ('/home/pgbuildfarm/client-code/buildroot/abicheck.df4c2566/HEAD/last_pg_commit_hash.txt') not found. Run needed.
df4c2566:HEAD          [02:59:17] copying source to pgsql.build ...
df4c2566:HEAD          [02:59:23] building PGBuild::Modules::ABICompCheck
running git clone -q  "/home/pgbuildfarm/client-code/buildroot/pgmirror.git" "pgsql"
df4c2566:HEAD          [02:59:26] ABICompCheck: Cloned PostgreSQL source to /home/pgbuildfarm/client-code/buildroot/abicheck.df4c2566/pgsql
df4c2566:HEAD          [02:59:27] ABICompCheck: Checked out branch 'HEAD' in /home/pgbuildfarm/client-code/buildroot/abicheck.df4c2566/pgsql
df4c2566:HEAD          [02:59:27] ABICompCheck: No previous commit hash found, comparing last 2 commits only.
Two commit hashes: ee685c9baf987984dbd2194d74576422996d95f4 f24fdf985561e7166d7d54459b764daae8efda44
df4c2566:HEAD          [02:59:27] Processing commits list in PGBuild::Modules::ABICompCheck
df4c2566:HEAD          [02:59:27] Checking out commit ee685c9baf987984dbd2194d74576422996d95f4 in PGBuild::Modules::ABICompCheck
df4c2566:HEAD          [02:59:27] Configuring, making, and installing for commit ee685c9baf987984dbd2194d74576422996d95f4 in PGBuild::Modules::ABICompCheck
df4c2566:HEAD          [02:59:27] Executing: configure
df4c2566:HEAD          [02:59:46] Successfully executed configure
df4c2566:HEAD          [02:59:46] Configuration complete for commit ee685c9baf987984dbd2194d74576422996d95f4.
df4c2566:HEAD          [02:59:46] Executing: make
df4c2566:HEAD          [03:05:52] Successfully executed make
df4c2566:HEAD          [03:05:52] Executing: makeinstall
df4c2566:HEAD          [03:05:55] Successfully executed makeinstall
df4c2566:HEAD          [03:05:55] Generating ABIDW XML for commit ee685c9baf987984dbd2194d74576422996d95f4 in PGBuild::Modules::ABICompCheck
df4c2566:HEAD          [03:05:55] Executing: abidw --out-file "/home/pgbuildfarm/client-code/buildroot/abicheck.df4c2566/xmls/ee685c9baf987984dbd2194d74576422996d95f4/postgres.abi" "/home/pgbuildfarm/client-code/buildroot/abicheck.df4c2566/install/bin/postgres" --drop-undefined-syms --no-architecture --no-comp-dir-path --no-elf-needed --no-show-locs --type-id-style hash
df4c2566:HEAD          [03:06:10] Successfully generated ABI XML for postgres to /home/pgbuildfarm/client-code/buildroot/abicheck.df4c2566/xmls/ee685c9baf987984dbd2194d74576422996d95f4/postgres.abi
df4c2566:HEAD          [03:06:10] Executing: abidw --out-file "/home/pgbuildfarm/client-code/buildroot/abicheck.df4c2566/xmls/ee685c9baf987984dbd2194d74576422996d95f4/ecpg.abi" "/home/pgbuildfarm/client-code/buildroot/abicheck.df4c2566/install/bin/ecpg" --drop-undefined-syms --no-architecture --no-comp-dir-path --no-elf-needed --no-show-locs --type-id-style hash
df4c2566:HEAD          [03:06:11] Successfully generated ABI XML for ecpg to /home/pgbuildfarm/client-code/buildroot/abicheck.df4c2566/xmls/ee685c9baf987984dbd2194d74576422996d95f4/ecpg.abi
df4c2566:HEAD          [03:06:11] Executing: abidw --out-file "/home/pgbuildfarm/client-code/buildroot/abicheck.df4c2566/xmls/ee685c9baf987984dbd2194d74576422996d95f4/libpq.so.abi" "/home/pgbuildfarm/client-code/buildroot/abicheck.df4c2566/install/lib/libpq.so" --drop-undefined-syms --no-architecture --no-comp-dir-path --no-elf-needed --no-show-locs --type-id-style hash
df4c2566:HEAD          [03:06:11] Successfully generated ABI XML for libpq.so to /home/pgbuildfarm/client-code/buildroot/abicheck.df4c2566/xmls/ee685c9baf987984dbd2194d74576422996d95f4/libpq.so.abi
df4c2566:HEAD          [03:06:11] Checking out commit f24fdf985561e7166d7d54459b764daae8efda44 in PGBuild::Modules::ABICompCheck
df4c2566:HEAD          [03:06:11] Configuring, making, and installing for commit f24fdf985561e7166d7d54459b764daae8efda44 in PGBuild::Modules::ABICompCheck
df4c2566:HEAD          [03:06:11] Executing: configure
df4c2566:HEAD          [03:06:29] Successfully executed configure
df4c2566:HEAD          [03:06:29] Configuration complete for commit f24fdf985561e7166d7d54459b764daae8efda44.
df4c2566:HEAD          [03:06:29] Executing: make
df4c2566:HEAD          [03:06:37] Successfully executed make
df4c2566:HEAD          [03:06:37] Executing: makeinstall
df4c2566:HEAD          [03:06:41] Successfully executed makeinstall
df4c2566:HEAD          [03:06:41] Generating ABIDW XML for commit f24fdf985561e7166d7d54459b764daae8efda44 in PGBuild::Modules::ABICompCheck
df4c2566:HEAD          [03:06:41] Executing: abidw --out-file "/home/pgbuildfarm/client-code/buildroot/abicheck.df4c2566/xmls/f24fdf985561e7166d7d54459b764daae8efda44/postgres.abi" "/home/pgbuildfarm/client-code/buildroot/abicheck.df4c2566/install/bin/postgres" --drop-undefined-syms --no-architecture --no-comp-dir-path --no-elf-needed --no-show-locs --type-id-style hash
df4c2566:HEAD          [03:06:55] Successfully generated ABI XML for postgres to /home/pgbuildfarm/client-code/buildroot/abicheck.df4c2566/xmls/f24fdf985561e7166d7d54459b764daae8efda44/postgres.abi
df4c2566:HEAD          [03:06:55] Executing: abidw --out-file "/home/pgbuildfarm/client-code/buildroot/abicheck.df4c2566/xmls/f24fdf985561e7166d7d54459b764daae8efda44/ecpg.abi" "/home/pgbuildfarm/client-code/buildroot/abicheck.df4c2566/install/bin/ecpg" --drop-undefined-syms --no-architecture --no-comp-dir-path --no-elf-needed --no-show-locs --type-id-style hash
df4c2566:HEAD          [03:06:55] Successfully generated ABI XML for ecpg to /home/pgbuildfarm/client-code/buildroot/abicheck.df4c2566/xmls/f24fdf985561e7166d7d54459b764daae8efda44/ecpg.abi
df4c2566:HEAD          [03:06:55] Executing: abidw --out-file "/home/pgbuildfarm/client-code/buildroot/abicheck.df4c2566/xmls/f24fdf985561e7166d7d54459b764daae8efda44/libpq.so.abi" "/home/pgbuildfarm/client-code/buildroot/abicheck.df4c2566/install/lib/libpq.so" --drop-undefined-syms --no-architecture --no-comp-dir-path --no-elf-needed --no-show-locs --type-id-style hash
df4c2566:HEAD          [03:06:55] Successfully generated ABI XML for libpq.so to /home/pgbuildfarm/client-code/buildroot/abicheck.df4c2566/xmls/f24fdf985561e7166d7d54459b764daae8efda44/libpq.so.abi
df4c2566:HEAD          [03:06:55] OK
Branch: HEAD
All stages succeeded

PGBuild/Modules/ABICompCheck.pm

theory

Finally made a careful read and made some suggestions. Seems like the basic functionality is fine, though we may want to do some refactoring later. In fact, I think it would be nice to factor a bunch of the configure and make code from run_build.pl into a module that could then be called from here, so that the ABI Check gets the benefit of the full configuration (e.g., builds with libxml, LDAP, ICU, Perl, Python, etc.).

After a run, I see this directory layout:

.
|-- diffs
|   |-- ecpg-fe07100e82b096d3c848cace790d4b4daf0c4131-9ca30a0b04d751c58d4efa0a2b3073cb285b1bd2.log
|   `-- postgres-fe07100e82b096d3c848cace790d4b4daf0c4131-9ca30a0b04d751c58d4efa0a2b3073cb285b1bd2.log
|-- githead.log
|-- logs
|   |-- 9ca30a0b04d751c58d4efa0a2b3073cb285b1bd2
|   |   |-- configure.log
|   |   |-- make.log
|   |   `-- makeinstall.log
|   `-- fe07100e82b096d3c848cace790d4b4daf0c4131
|       |-- configure.log
|       |-- make.log
|       `-- makeinstall.log
`-- xmls
    |-- 9ca30a0b04d751c58d4efa0a2b3073cb285b1bd2
    |   |-- ecpg.abi
    |   |-- libpq.so.abi
    |   `-- postgres.abi
    `-- fe07100e82b096d3c848cace790d4b4daf0c4131
        |-- ecpg.abi
        |-- libpq.so.abi
        `-- postgres.abi

Which of those files do you plan to upload to the server?

PGBuild/Modules/ABICompCheck.pm

MankiratSingh1315 · 2025-07-04T14:16:20Z

Which of those files do you plan to upload to the server?

As Peter said here "no news is good news" I do think we can just send the diffs outputs if there are any to the server. Sending the XML files will only increase the payload I believe. If there will be some issue in configure make and build, in that case I think the run build script is itself responsible report the error...

PGBuild/Modules/ABICompCheck.pm

theory · 2025-08-10T17:58:43Z

PGBuild/Modules/ABICompCheck.pm

+	return;
+}
+
+sub configure


Sure seems like there's a lot of code here duped from elsewhere. Is it all from run_build.pl? I wonder if it should be put into a module.

I was also thinking the same but left these here currently as no other modules needed them as of now and also just for some convenience 😅

PGBuild/Modules/ABICompCheck.pm

designed to perform Application Binary Interface (ABI) compliance checking for PostgreSQL builds using libabigail tools abidiff and abidw. The module helps detect unintended ABI changes in stable branches by comparing the latest commit against the most recent tag on that branch. This is crucial for maintaining compatibility for the PostgreSQL ABI stability guidelines for minor releases.

theory

Just a few minor nits. Looks great thank you!

theory · 2025-09-03T14:52:38Z

PGBuild/Modules/ABICompCheck.pm

+	# Ensure debug information is available in compilation - required for libabigail tools
+	if ($conf->{using_meson})
+	{
+		# not working, can't understand why


Would be worth to ask on the list.

PGBuild/Modules/ABICompCheck.pm

Plus one little punctuation fix.

PGBuild/Modules/ABICompCheck.pm

…emove redundant logging

PGBuild/Modules/ABICompCheck.pm

…o files in inst/lib

…nes AND update docs

…pdate variable name for better code understanding

theory · 2025-11-01T15:46:10Z

only work on presence of .abi-compliance-history file, update docs, u…

Awesome, thank you, I've added this to baza.

When `rm_worktree` is enabled in animal config, the source directory is cleaned after the run, causing `.abi-compliance-history` to be missing in subsequent runs as setup runs before source checkout.

theory reviewed Jun 11, 2025

View reviewed changes

PGBuild/Modules/ABICompCheck.pm Outdated Show resolved Hide resolved

theory reviewed Jun 11, 2025

View reviewed changes

PGBuild/Modules/ABICompCheck.pm Outdated Show resolved Hide resolved

PGBuild/Modules/ABICompCheck.pm Outdated Show resolved Hide resolved

PGBuild/Modules/ABICompCheck.pm Outdated Show resolved Hide resolved

PGBuild/Modules/ABICompCheck.pm Outdated Show resolved Hide resolved

MankiratSingh1315 force-pushed the abi-comp-check branch from 52ad772 to 5cc85dd Compare June 16, 2025 21:47

theory reviewed Jun 17, 2025

View reviewed changes

PGBuild/Modules/ABICompCheck.pm Outdated Show resolved Hide resolved

PGBuild/Modules/ABICompCheck.pm Outdated Show resolved Hide resolved

theory reviewed Jun 30, 2025

View reviewed changes

theory suggested changes Jul 2, 2025

View reviewed changes

theory reviewed Jul 2, 2025

View reviewed changes

PGBuild/Modules/ABICompCheck.pm Outdated Show resolved Hide resolved

PGBuild/Modules/ABICompCheck.pm Outdated Show resolved Hide resolved

PGBuild/Modules/ABICompCheck.pm Show resolved Hide resolved

MankiratSingh1315 force-pushed the abi-comp-check branch from 53b96ac to 3843cb1 Compare July 7, 2025 19:33

theory reviewed Jul 9, 2025

View reviewed changes

PGBuild/Modules/ABICompCheck.pm Outdated Show resolved Hide resolved

MankiratSingh1315 force-pushed the abi-comp-check branch from fd201d5 to cb684a0 Compare July 9, 2025 22:13

MankiratSingh1315 marked this pull request as ready for review August 10, 2025 11:34

theory reviewed Aug 10, 2025

View reviewed changes

PGBuild/Modules/ABICompCheck.pm Outdated Show resolved Hide resolved

theory reviewed Aug 19, 2025

View reviewed changes

theory reviewed Aug 20, 2025

View reviewed changes

PGBuild/Modules/ABICompCheck.pm Show resolved Hide resolved

PGBuild/Modules/ABICompCheck.pm Outdated Show resolved Hide resolved

PGBuild/Modules/ABICompCheck.pm Outdated Show resolved Hide resolved

PGBuild/Modules/ABICompCheck.pm Outdated Show resolved Hide resolved

theory reviewed Aug 25, 2025

View reviewed changes

PGBuild/Modules/ABICompCheck.pm Outdated Show resolved Hide resolved

MankiratSingh1315 force-pushed the abi-comp-check branch from 99729c5 to bf0295e Compare August 28, 2025 14:46

MankiratSingh1315 force-pushed the abi-comp-check branch from bf0295e to 9521525 Compare August 28, 2025 14:54

theory approved these changes Sep 3, 2025

View reviewed changes

theory and others added 2 commits September 3, 2025 11:27

Some minor Pod reformatting

8be6d05

Plus one little punctuation fix.

minor fixes

d222705

petere reviewed Sep 12, 2025

View reviewed changes

PGBuild/Modules/ABICompCheck.pm Outdated Show resolved Hide resolved

MankiratSingh1315 added 2 commits September 29, 2025 23:29

Refactor ABI comparison logic to dynamically determine binaries and r…

c48eea9

…emove redundant logging

documentation update

0bf20f2

theory reviewed Sep 29, 2025

View reviewed changes

PGBuild/Modules/ABICompCheck.pm Outdated Show resolved Hide resolved

Improved logic for polulating binaries_rel_path and perltidy

a684b34

put list of binaries compared in abi comp check results

31fd0f2

theory reviewed Oct 11, 2025

View reviewed changes

PGBuild/Modules/ABICompCheck.pm Show resolved Hide resolved

MankiratSingh1315 added 3 commits October 17, 2025 22:35

Refine binary path construction in ABICompCheck to explicitly scan .s…

c692b14

…o files in inst/lib

Add support for .abi-compliance-history file for having custom baseli…

f888736

…nes AND update docs

Improve code readability and perltidy

66eed0d

MankiratSingh1315 force-pushed the abi-comp-check branch from 838cb7f to 66eed0d Compare October 19, 2025 19:40

only work on presence of .abi-compliance-history file, update docs, u…

e6929a8

…pdate variable name for better code understanding

Move .abi-compliance-history required check to installcheck

b90917b

When `rm_worktree` is enabled in animal config, the source directory is cleaned after the run, causing `.abi-compliance-history` to be missing in subsequent runs as setup runs before source checkout.

ABI Compliance Checker Module #38

Are you sure you want to change the base?

ABI Compliance Checker Module #38

Conversation

MankiratSingh1315 commented Jun 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

MankiratSingh1315 commented Jun 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

MankiratSingh1315 commented Jun 16, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

theory left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

MankiratSingh1315 commented Jul 4, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

theory Aug 10, 2025

Choose a reason for hiding this comment

Uh oh!

MankiratSingh1315 Aug 10, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

theory left a comment

Choose a reason for hiding this comment

Uh oh!

theory Sep 3, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

MankiratSingh1315 commented Jun 11, 2025 •

edited

Loading

MankiratSingh1315 commented Jun 16, 2025 •

edited

Loading