Merge into devel : abigail : Code : unity-scopes-api

Status:	Merged
Approved by:	James Henstridge on 2016-02-22
Approved revision:	683
Merged at revision:	655
Proposed branch:	lp:~michihenning/unity-scopes-api/abigail
Merge into:	lp:unity-scopes-api/devel
Diff against target:	368 lines (+124/-96) 10 files modified HACKING (+4/-7) debian/VERSION (+1/-1) debian/changelog (+24/-0) debian/control.in (+2/-1) test/CMakeLists.txt (+1/-1) test/abi-compliance/CMakeLists.txt (+10/-6) test/abi-compliance/abi.xml.in (+0/-57) test/abi-compliance/check-abi-compliance.sh.in (+59/-21) test/abi-compliance/gen-abi-dump.sh.in (+2/-2) test/abi-compliance/suppressions (+21/-0)
To merge this branch:	bzr merge lp:~michihenning/unity-scopes-api/abigail
Related bugs:	Link a bug report

Reviewer	Review Type	Date Requested	Status
James Henstridge		2016-02-10	Approve on 2016-02-22
PS Jenkins bot (community)	continuous-integration		Approve on 2016-02-15
Review via email: mp+285551@code.launchpad.net

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2016-02-10:

#

FAILED: Continuous integration, rev:659
http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-ci/1608/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-vivid-amd64-ci/217/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-vivid-armhf-ci/217/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-vivid-i386-ci/217/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-xenial-amd64-ci/40/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-xenial-armhf-ci/40/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-xenial-i386-ci/40/console

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity-scopes-api-devel-ci/1608/rebuild

review: Needs Fixing (continuous-integration)

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2016-02-10:

#

FAILED: Continuous integration, rev:660
http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-ci/1609/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-vivid-amd64-ci/218/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-vivid-armhf-ci/218/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-vivid-i386-ci/218/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-xenial-amd64-ci/41/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-xenial-armhf-ci/41/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-xenial-i386-ci/41/console

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity-scopes-api-devel-ci/1609/rebuild

review: Needs Fixing (continuous-integration)

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2016-02-10:

#

FAILED: Continuous integration, rev:661
http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-ci/1610/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-vivid-amd64-ci/219
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-vivid-armhf-ci/219/console
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-vivid-i386-ci/219
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-xenial-amd64-ci/42/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-xenial-armhf-ci/42/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-xenial-i386-ci/42/console

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity-scopes-api-devel-ci/1610/rebuild

review: Needs Fixing (continuous-integration)

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2016-02-10:

#

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity-scopes-api-devel-ci/1611/rebuild

review: Approve (continuous-integration)

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2016-02-12:

#

FAILED: Continuous integration, rev:673
http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-ci/1612/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-vivid-amd64-ci/221
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-vivid-armhf-ci/221/console
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-vivid-i386-ci/221
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-xenial-amd64-ci/44
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-xenial-armhf-ci/44/console
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-xenial-i386-ci/44

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity-scopes-api-devel-ci/1612/rebuild

review: Needs Fixing (continuous-integration)

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2016-02-12:

#

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity-scopes-api-devel-ci/1613/rebuild

review: Approve (continuous-integration)

lp:~michihenning/unity-scopes-api/abigail updated on 2016-02-12

677. By Michi Henning on 2016-02-12: Added test go guard against compilations without -g.

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2016-02-12:

#

FAILED: Continuous integration, rev:677
http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-ci/1614/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-vivid-amd64-ci/223/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-vivid-armhf-ci/223/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-vivid-i386-ci/223/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-xenial-amd64-ci/46/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-xenial-armhf-ci/46/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-xenial-i386-ci/46/console

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity-scopes-api-devel-ci/1614/rebuild

review: Needs Fixing (continuous-integration)

lp:~michihenning/unity-scopes-api/abigail updated on 2016-02-12

678. By Michi Henning on 2016-02-12: Test was broken.

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2016-02-12:

#

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity-scopes-api-devel-ci/1615/rebuild

review: Approve (continuous-integration)

Revision history for this message

James Henstridge (jamesh) wrote on 2016-02-12:

#

This looks pretty good. I've left a few inline comments about possible simplifications/improvements, but this is definitely on the right track.

review: Needs Fixing

Revision history for this message

Michi Henning (michihenning) wrote on 2016-02-12:

#

> This looks pretty good. I've left a few inline comments about possible
> simplifications/improvements, but this is definitely on the right track.

Thanks for the review!

I've fixed the gunzip issue and added back a comment in HACKING about where to find the report

With the cmake thing, I stuffed around with that for quite a while. The custom command to dump the abi is necessary because it needs to be dumped whenever it isn't there yet, or after the library has been rebuilt.

For the check-abi step, I want to make sure that the test runs every time, whether the abi dump is new or not. With a naive approach, using add_custom_target/add_custom_command, the problem was that, after the test was run once, running it again wouldn't do anything, even when the ABI was broken (because the report file was up-to-date).

But, to force re-generation of the abi dump if necessary, I *have* to use a a custom command that depends on the dump file. In the end, the only reliable way I managed to come up with was to use the dummy output file. If there is a simpler way of doing this, I'd like to find out though. Every time I use add_custom_target/add_custom_command, my mind turns into a pretzel. I find this uniquely awkward to use, much worse than a makefile, as a matter of fact :-(

With the suppressions, things are in progress. There *is* a bug, but in a slightly different shape than I thought. Dodji has come up with a work-around the deals with the problem I was seeing though. So, on Monday, I think I'll be able to turn suppressions on and do things properly (with a slight hack in the suppressions file). I'll push another branch then with a link to the bug tracker as appropriate.

If there is any cargo-culting, it'll at least be cleaner cargo after that :-)

PS: Have you ever read "Dream Park--The California Voodoo Game"? If not, do. You will probably enjoy it :-)

Revision history for this message

James Henstridge (jamesh) wrote on 2016-02-12:

#

Okay, so I guess there are two options here:

1. If you want to generate a new dump as part of the vbuild process, why not just have a custom_command that depends on the libunity-scopes target and outputs the ABI dump, rather than dealing with the "run_always" bits?

2. Do you even need to dump the current ABI to an XML file as part of the test? Might it be quicker to just have abidiff compare the reference XML dump against the just-built .so file? That would reduce the number of moving parts in the test, and would likely be even faster.

I can understand having a helper script to generate a dump based on the just-built library, but it doesn't seem like a prerequisite for running the tests.

lp:~michihenning/unity-scopes-api/abigail updated on 2016-02-13

679. By Michi Henning on 2016-02-13

Some review comments from James.

Changed script to use suppressions file after getting a work-around for the partial
suppressions from Dodji.

Revision history for this message

Michi Henning (michihenning) wrote on 2016-02-13:

#

> Okay, so I guess there are two options here:
>
> 1. If you want to generate a new dump as part of the vbuild process, why not
> just have a custom_command that depends on the libunity-scopes target and
> outputs the ABI dump, rather than dealing with the "run_always" bits?

Now I'm confused. I already have this command:

add_custom_command(
    OUTPUT ${abi_dump_file}
    COMMAND ${abi_dump_cmd}
    DEPENDS ${UNITY_SCOPES_LIB})

add_custom_target(gen-abi-dump DEPENDS ${abi_dump_file})

This generates the dump if the dump doesn't exist yet or is out of date with respect to the library.

The run always hack is necessary because, without it, a "make test" will correctly complain the first time but, if I have a failure the first time and then do "make test" again, I end up with nothing being done at all, because nothing is out of date, and the second run then incorrectly reports success when, in fact, the failure is still there.

> 2. Do you even need to dump the current ABI to an XML file as part of the
> test? Might it be quicker to just have abidiff compare the reference XML dump
> against the just-built .so file? That would reduce the number of moving parts
> in the test, and would likely be even faster.

I considered doing this, but decided not to. Any speed difference is completely unnoticeable because analysing the dump takes many times longer than uncompressing it. That's for a large dump. For a small dump, the difference is also unnoticeable because a small dump will uncompress very quickly.

And I figured it would be useful to leave the dump behind. When something goes wrong, and people want to dig into it, they don't have to copy and uncompress it manually, making sure that they use the correct arch subdirectory.

The dump file is also useful for reporting issues with abidiff, because I have everything I need (both dumps and the suppressions file) right there.

I've updated the clean target though to get rid of the base dump, so a "make clean" actually reclaims the disk space.

> I can understand having a helper script to generate a dump based on the just-
> built library, but it doesn't seem like a prerequisite for running the tests.

The helper script to create the dump is useful for generating the dump by hand (say, for debugging). It also avoids a needless dump on Vivid. Doing that sort of thing directly in cmake rapidly gets cumbersome. Using the helper script is cleaner, I think?

> Okay, so I guess there are two options here:
> 
> 1. If you want to generate a new dump as part of the vbuild process, why not
> just have a custom_command that depends on the libunity-scopes target and
> outputs the ABI dump, rather than dealing with the "run_always" bits?

Now I'm confused. I already have this command:

add_custom_command(
    OUTPUT ${abi_dump_file}
    COMMAND ${abi_dump_cmd}
    DEPENDS ${UNITY_SCOPES_LIB})

add_custom_target(gen-abi-dump DEPENDS ${abi_dump_file})

This generates the dump if the dump doesn't exist yet or is out of date with respect to the library.

The run always hack is necessary because, without it, a "make test" will correctly complain the first time but, if I have a failure the first time and then do "make test" again, I end up with nothing being done at all, because nothing is out of date, and the second run then incorrectly reports success when, in fact, the failure is still there.

> 2. Do you even need to dump the current ABI to an XML file as part of the
> test?  Might it be quicker to just have abidiff compare the reference XML dump
> against the just-built .so file?  That would reduce the number of moving parts
> in the test, and would likely be even faster.

I considered doing this, but decided not to. Any speed difference is completely unnoticeable because analysing the dump takes many times longer than uncompressing it. That's for a large dump. For a small dump, the difference is also unnoticeable because a small dump will uncompress very quickly.

And I figured it would be useful to leave the dump behind. When something goes wrong, and people want to dig into it, they don't have to copy and uncompress it manually, making sure that they use the correct arch subdirectory.

The dump file is also useful for reporting issues with abidiff, because I have everything I need (both dumps and the suppressions file) right there.

I've updated the clean target though to get rid of the base dump, so a "make clean" actually reclaims the disk space.

> I can understand having a helper script to generate a dump based on the just-
> built library, but it doesn't seem like a prerequisite for running the tests.

The helper script to create the dump is useful for generating the dump by hand (say, for debugging). It also avoids a needless dump on Vivid. Doing that sort of thing directly in cmake rapidly gets cumbersome. Using the helper script is cleaner, I think?

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2016-02-13:

#

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity-scopes-api-devel-ci/1616/rebuild

review: Approve (continuous-integration)

lp:~michihenning/unity-scopes-api/abigail updated on 2016-02-13

680. By Michi Henning on 2016-02-13: Fix exit status in currently unused code.

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2016-02-13:

#

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity-scopes-api-devel-ci/1617/rebuild

review: Approve (continuous-integration)

lp:~michihenning/unity-scopes-api/abigail updated on 2016-02-14

681. By Michi Henning on 2016-02-14: Added comment.

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2016-02-14:

#

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity-scopes-api-devel-ci/1618/rebuild

review: Approve (continuous-integration)

lp:~michihenning/unity-scopes-api/abigail updated on 2016-02-14

682. By Michi Henning on 2016-02-14: Merged devel.

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2016-02-14:

#

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity-scopes-api-devel-ci/1620/rebuild

review: Approve (continuous-integration)

Revision history for this message

James Henstridge (jamesh) wrote on 2016-02-15:

#

> > 2. Do you even need to dump the current ABI to an XML file as part of the
> > test? Might it be quicker to just have abidiff compare the reference XML
> dump
> > against the just-built .so file? That would reduce the number of moving
> parts
> > in the test, and would likely be even faster.
>
> I considered doing this, but decided not to. Any speed difference is
> completely unnoticeable because analysing the dump takes many times longer
> than uncompressing it. That's for a large dump. For a small dump, the
> difference is also unnoticeable because a small dump will uncompress very
> quickly.
>
> And I figured it would be useful to leave the dump behind. When something goes
> wrong, and people want to dig into it, they don't have to copy and uncompress
> it manually, making sure that they use the correct arch subdirectory.
>
> The dump file is also useful for reporting issues with abidiff, because I have
> everything I need (both dumps and the suppressions file) right there.
>
> I've updated the clean target though to get rid of the base dump, so a "make
> clean" actually reclaims the disk space.

I was curious what the time difference was, so I ran a few tests on my Chromebook (since armhf always seems to be the last to finish building, and hopefully the Chromebook is similar enough). I used the vivid versions of abigail and extracted the latest Xenial builds of libunity-scopes-api (this uses detached debug info, but hopefully that doesn't influence things too much).

First of all, the timings to extract an ABI dump and compare it to itself:

    $ time abidw --debug-info-dir root/usr/lib/debug root/usr/lib/arm-linux-gnueabihf/libunity-scopes.so.1.0.3 > dump.xml
    real 1m25.146s
    user 1m21.865s
    sys 0m2.975s

    $ time abidiff dump.xml dump.xml
    real 3m4.622s
    user 3m1.870s
    sys 0m2.565s

And as the alternative I was suggesting, comparing the XML dump against the library itself:

    $ time abidiff --debug-info-dir2 root/usr/lib/debug dump.xml root/usr/lib/arm-linux-gnueabihf/libunity-scopes.so.1.0.3
    real 2m30.120s
    user 2m27.060s
    sys 0m2.605s

So in addition to saving the 1.5 minutes taken to create the XML dump, the actual comparison process took 30 seconds less. All up, that's a 45% reduction in runtime

The times with the xenial version of abigail-tools seem a bit different on my amd64 box, but I'm still seeing significantly lower overall time for abidiff against the .so vs. abidw+abidiff.

> > 2. Do you even need to dump the current ABI to an XML file as part of the
> > test?  Might it be quicker to just have abidiff compare the reference XML
> dump
> > against the just-built .so file?  That would reduce the number of moving
> parts
> > in the test, and would likely be even faster.
> 
> I considered doing this, but decided not to. Any speed difference is
> completely unnoticeable because analysing the dump takes many times longer
> than uncompressing it. That's for a large dump. For a small dump, the
> difference is also unnoticeable because a small dump will uncompress very
> quickly.
> 
> And I figured it would be useful to leave the dump behind. When something goes
> wrong, and people want to dig into it, they don't have to copy and uncompress
> it manually, making sure that they use the correct arch subdirectory.
> 
> The dump file is also useful for reporting issues with abidiff, because I have
> everything I need (both dumps and the suppressions file) right there.
> 
> I've updated the clean target though to get rid of the base dump, so a "make
> clean" actually reclaims the disk space.

I was curious what the time difference was, so I ran a few tests on my Chromebook (since armhf always seems to be the last to finish building, and hopefully the Chromebook is similar enough).  I used the vivid versions of abigail and extracted the latest Xenial builds of libunity-scopes-api (this uses detached debug info, but hopefully that doesn't influence things too much).

First of all, the timings to extract an ABI dump and compare it to itself:

$ time abidw --debug-info-dir root/usr/lib/debug root/usr/lib/arm-linux-gnueabihf/libunity-scopes.so.1.0.3 > dump.xml
    real    1m25.146s
    user    1m21.865s
    sys     0m2.975s

$ time abidiff dump.xml dump.xml 
    real    3m4.622s
    user    3m1.870s
    sys     0m2.565s

And as the alternative I was suggesting, comparing the XML dump against the library itself:

$ time abidiff --debug-info-dir2 root/usr/lib/debug dump.xml root/usr/lib/arm-linux-gnueabihf/libunity-scopes.so.1.0.3           
    real    2m30.120s
    user    2m27.060s
    sys     0m2.605s

So in addition to saving the 1.5 minutes taken to create the XML dump, the actual comparison process took 30 seconds less.  All up, that's a 45% reduction in runtime

The times with the xenial version of abigail-tools seem a bit different on my amd64 box, but I'm still seeing significantly lower overall time for abidiff against the .so vs. abidw+abidiff.

Revision history for this message

James Henstridge (jamesh) wrote on 2016-02-15:

#

Just recording part of a conversation from IRC. Michi got the following error when comparing the XML dump to the shared library on his system:

http://pastebin.ubuntu.com/15070257/

In the XML dump, these are defined here:

<elf-symbol name='_ZN5unity6scopes15ConfigExceptionC2ERKNSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEE' type='func-type' binding='global-binding' alias='_ZN5unity6scopes15ConfigExceptionC2ERKS1_' is-defined='yes'/>
<elf-symbol name='_ZN5unity6scopes15ConfigExceptionC2ERKS1_' type='func-type' binding='global-binding' is-defined='yes'/>

The "alias" attribute on the first line seems erroneous, since the first mangled name is ConfigException(std::string const&), while the second is ConfigException(ConfigException const&). These are clearly not the same symbol, so I'm not sure why they'd be listed as such here.

lp:~michihenning/unity-scopes-api/abigail updated on 2016-02-15

683. By Michi Henning on 2016-02-15: Fixed broken clean target.

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2016-02-15:

#

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity-scopes-api-devel-ci/1621/rebuild

review: Approve (continuous-integration)

Revision history for this message

Michi Henning (michihenning) wrote on 2016-02-20:

#

Dodji has fixed the issues around he different behaviour when using a dump vs comparing the base dump against the .so.

We'll have to wait until the next version of abigail makes it into archives. At that point, we'll also have to re-generate the base dumps because, as it turns out, they are currently not storing all of the relevant information.

At that point, we also should consider comparing against two dumps: the base dump, to make sure we haven't broken ABI with respect to the base, and the most recently-released version dump, to make sure that, in a later version, we haven't removed something that was added on an earlier (non-base) version, thereby breaking ABI not against the base, but against a version that was released into the wild.

Revision history for this message

James Henstridge (jamesh) wrote on 2016-02-22:

#

As discussed earlier, there is room for improvement but that will probably require a new version of abigail. This is obviously a big improvement over a-c-c, so lets merge it and improve it later.

review: Approve

unity-scopes-api

Merge lp:~michihenning/unity-scopes-api/abigail into lp:unity-scopes-api/devel

Commit message

Description of the change

Preview Diff

Subscribers

 === modified file 'HACKING'
 --- HACKING	2015-09-15 21:55:44 +0000
 +++ HACKING	2016-02-15 06:03:52 +0000
@@ -293,13 +293,13 @@
  ABI compliance test
  -------------------
--The tests include an ABI compliance test (for Wily and later). To run it:
++The tests include an ABI compliance test (for xenial and later). To run it:
      $ cd test/abi-compliance
      $ make test
  The test is also automatically run as part of the test suite.
--It takes several minutes to run . If you don't want to wait during local builds,
++It takes a while to run. If you don't want to wait during local builds,
  set the cmake "slowtests" option to OFF to skip the check.
  The baseline ABI files for the test are in test/abi-compliance/abi_dumps.
@@ -313,11 +313,8 @@
  Once all the packages are built, you can extract the ABI dump
  files and add them to the corresponding directory in the source tree.
--The abi-compliance-checker tool produces a report in
--
--    test/abi-compliance/compat_reports/libunity-scopes.so/[version]_to_[version]/compat_report.html
--
--The report provides a nicely layed-out page with all the details.
++The abi compliance test produces a report in
++libunity-scopes_<current-version>_abi-report.txt if anything unusual is detected.
  Autopkg test suite
  ------------------
 === modified file 'debian/VERSION'
 --- debian/VERSION	2015-09-21 12:30:26 +0000
 +++ debian/VERSION	2016-02-15 06:03:52 +0000
@@ -1,1 +1,1 @@
--1.0.2
++1.0.3
 === modified file 'debian/changelog'
 --- debian/changelog	2015-12-18 11:42:03 +0000
 +++ debian/changelog	2016-02-15 06:03:52 +0000
@@ -1,3 +1,27 @@
++unity-scopes-api (1.0.3+16.04.20160209-0ubuntu2) UNRELEASED; urgency=medium
++
++  [ Michi Henning ]
++  * Changed ABI compliance testing to use abigail.
++
++ -- Michi Henning <michi.henning@canonical.com>  Mon, 15 Feb 2016 07:45:13 +1000
++
++unity-scopes-api (1.0.3+16.04.20160209-0ubuntu1) xenial; urgency=medium
++
++  [ Michi Henning ]
++  * Bumped micro version.
++
++  [ CI Train Bot ]
++  * No-change rebuild.
++
++ -- Rodney Dawes <ci-train-bot@canonical.com>  Tue, 09 Feb 2016 15:15:15 +0000
++
++unity-scopes-api (1.0.3) UNRELEASED; urgency=medium
++
++  [ Michi Henning ]
++  * Changed ABI compliance check to use abigail instead of abi-compliance-checker.
++
++ -- Michi Henning <michi.henning@canonical.com>  Tue, 09 Feb 2016 17:07:10 +1000
++
  unity-scopes-api (1.0.2+16.04.20151218.2-0ubuntu1) xenial; urgency=medium
    [ Michi Henning ]
 === modified file 'debian/control.in'
 --- debian/control.in	2015-11-13 04:05:00 +0000
 +++ debian/control.in	2016-02-15 06:03:52 +0000
@@ -1,7 +1,8 @@
  Source: unity-scopes-api
  Priority: optional
  Maintainer: Ubuntu Developers <ubuntu-devel-discuss@lists.ubuntu.com>
--Build-Depends: abi-compliance-checker,
++Build-Depends: abigail-tools | libabigail-tools,
++               binutils,
                 capnproto,
                 click-dev (>= 0.2.2),
                 cmake,
 === modified file 'test/CMakeLists.txt'
 --- test/CMakeLists.txt	2015-09-09 07:37:01 +0000
 +++ test/CMakeLists.txt	2016-02-15 06:03:52 +0000
@@ -5,5 +5,5 @@
  if(${slowtests})
      add_subdirectory(headers)
--    add_subdirectory(abi-compliance)  # Keep this test last because it's really slow.
++    add_subdirectory(abi-compliance)
  endif()
 === modified file 'test/abi-compliance/CMakeLists.txt'
 --- test/abi-compliance/CMakeLists.txt	2015-09-09 07:37:01 +0000
 +++ test/abi-compliance/CMakeLists.txt	2016-02-15 06:03:52 +0000
@@ -1,11 +1,11 @@
--configure_file(abi.xml.in ${CMAKE_CURRENT_BINARY_DIR}/abi.xml)
  configure_file(check-abi-compliance.sh.in ${CMAKE_CURRENT_BINARY_DIR}/check-abi-compliance.sh @ONLY)
  configure_file(gen-abi-dump.sh.in ${CMAKE_CURRENT_BINARY_DIR}/gen-abi-dump.sh @ONLY)
  set(abi_dump_cmd /bin/sh ${CMAKE_CURRENT_BINARY_DIR}/gen-abi-dump.sh)
  set(abi_check_cmd /bin/sh ${CMAKE_CURRENT_BINARY_DIR}/check-abi-compliance.sh)
--set(abi_dump_file ${CMAKE_CURRENT_BINARY_DIR}/abi_dumps/lib${UNITY_SCOPES_LIB}/lib${UNITY_SCOPES_LIB}_${UNITY_SCOPES_FULL_VERSION}.abi.tar.gz)
--set(abi_report ${CMAKE_CURRENT_BINARY_DIR}/compat_reports/lib${UNITY_SCOPES_LIB}/lib${UNITY_SCOPES_LIB}/${UNITY_SCOPES_MAJOR_MINOR}.0_to_${UNITY_SCOPES_FULL_VERSION}/compat_report.html)
++set(abi_dump_file ${CMAKE_CURRENT_BINARY_DIR}/lib${UNITY_SCOPES_LIB}_${UNITY_SCOPES_FULL_VERSION}.abi.xml)
++set(abi_baseline_dump ${CMAKE_CURRENT_BINARY_DIR}/lib${UNITY_SCOPES_LIB}_${UNITY_SCOPES_MAJOR}.0.0.abi.xml)
++set(abi_report ${CMAKE_CURRENT_BINARY_DIR}/lib${UNITY_SCOPES_LIB}_${UNITY_SCOPES_FULL_VERSION}_abi-report.txt)
  add_custom_command(
      OUTPUT ${abi_dump_file}
@@ -15,10 +15,14 @@
  add_custom_target(gen-abi-dump DEPENDS ${abi_dump_file})
  add_custom_command(
--    OUTPUT ${abi_report}
++    OUTPUT run_always ${abi_report}
      COMMAND ${abi_check_cmd}
--    DEPENDS gen-abi-dump)
++    DEPENDS ${abi_dump_file} ${suppressions})
++set_source_files_properties(run_always
++    PROPERTIES SYMBOLIC true)
++set_directory_properties(PROPERTIES
++    ADDITIONAL_MAKE_CLEAN_FILES ${abi_baseline_dump})
--add_custom_target(check-abi DEPENDS ${abi_report})
++add_custom_target(check-abi DEPENDS run_always)
  add_test(check-abi-compliance ${CMAKE_MAKE_PROGRAM} check-abi)
 === removed file 'test/abi-compliance/abi.xml.in'
 --- test/abi-compliance/abi.xml.in	2015-08-27 06:41:36 +0000
 +++ test/abi-compliance/abi.xml.in	1970-01-01 00:00:00 +0000
@@ -1,57 +0,0 @@
--<version>
--@UNITY_SCOPES_MAJOR@.@UNITY_SCOPES_MINOR@.@UNITY_SCOPES_MICRO@
--</version>
--
--<headers>
--@CMAKE_SOURCE_DIR@/include
--@CMAKE_BINARY_DIR@/src
--@CMAKE_BINARY_DIR@/include/unity
--</headers>
--
--<!--
--We skip the internal include directories because we have separate tests
--that already ensure that no public header includes an internal one.
---->
--<skip_include_paths>
--@CMAKE_BINARY_DIR@/include/unity/scopes/internal
--@CMAKE_BINARY_DIR@/include/unity/scopes/internal/lttng
--@CMAKE_BINARY_DIR@/include/unity/scopes/internal/smartscopes
--@CMAKE_BINARY_DIR@/include/unity/scopes/internal/zmq_middleware
--@CMAKE_BINARY_DIR@/include/unity/scopes/qt/internal
--@CMAKE_BINARY_DIR@/include/unity/scopes/utility/internal
--@CMAKE_SOURCE_DIR@/src/scopes/internal
--@CMAKE_SOURCE_DIR@/src/scopes/internal/lttng
--@CMAKE_SOURCE_DIR@/src/scopes/internal/smartscopes
--@CMAKE_SOURCE_DIR@/src/scopes/qt/internal
--@CMAKE_SOURCE_DIR@/src/scopes/utility/internal
--</skip_include_paths>
--
--<libs>
--@CMAKE_BINARY_DIR@/libunity-scopes.so
--</libs>
--
--<gcc_options>
---std=c++11 -fPIC -D_ENABLE_QT_EXPERIMENTAL_ -DQT_NO_KEYWORDS
--</gcc_options>
--
--<skip_namespaces>
--unity::scopes::internal
--unity::scopes::qt::internal
--unity::scopes::utility::internal
--</skip_namespaces>
--
--<skip_headers>
--@CMAKE_BINARY_DIR@/include/unity/Makefile
--@CMAKE_BINARY_DIR@/include/unity/scopes/internal/lttng/Makefile
--@CMAKE_BINARY_DIR@/include/unity/scopes/internal/Makefile
--@CMAKE_BINARY_DIR@/include/unity/scopes/internal/smartscopes/Makefile
--@CMAKE_BINARY_DIR@/include/unity/scopes/internal/zmq_middleware/Makefile
--@CMAKE_BINARY_DIR@/include/unity/scopes/Makefile
--@CMAKE_BINARY_DIR@/include/unity/scopes/qt/internal/Makefile
--@CMAKE_BINARY_DIR@/include/unity/scopes/qt/Makefile
--@CMAKE_BINARY_DIR@/include/unity/scopes/testing/Makefile
--@CMAKE_BINARY_DIR@/include/unity/scopes/utility/internal/Makefile
--@CMAKE_BINARY_DIR@/include/unity/scopes/utility/Makefile
--@CMAKE_SOURCE_DIR@/include/unity/scopes/internal/lttng/SimpleTracepoint.h
--@CMAKE_SOURCE_DIR@/include/unity/scopes/internal/lttng/UnityScopes_tp.h
--</skip_headers>
 === removed file 'test/abi-compliance/abi_dumps/aarch64-linux-gnu/libunity-scopes_1.0.0.abi.tar.gz'
 Binary files test/abi-compliance/abi_dumps/aarch64-linux-gnu/libunity-scopes_1.0.0.abi.tar.gz	2015-09-08 02:29:27 +0000 and test/abi-compliance/abi_dumps/aarch64-linux-gnu/libunity-scopes_1.0.0.abi.tar.gz	1970-01-01 00:00:00 +0000 differ
 === added file 'test/abi-compliance/abi_dumps/aarch64-linux-gnu/libunity-scopes_1.0.0.abi.xml.gz'
 Binary files test/abi-compliance/abi_dumps/aarch64-linux-gnu/libunity-scopes_1.0.0.abi.xml.gz	1970-01-01 00:00:00 +0000 and test/abi-compliance/abi_dumps/aarch64-linux-gnu/libunity-scopes_1.0.0.abi.xml.gz	2016-02-15 06:03:52 +0000 differ
 === removed file 'test/abi-compliance/abi_dumps/arm-linux-gnueabihf/libunity-scopes_1.0.0.abi.tar.gz'
 Binary files test/abi-compliance/abi_dumps/arm-linux-gnueabihf/libunity-scopes_1.0.0.abi.tar.gz	2015-09-08 02:29:27 +0000 and test/abi-compliance/abi_dumps/arm-linux-gnueabihf/libunity-scopes_1.0.0.abi.tar.gz	1970-01-01 00:00:00 +0000 differ
 === added file 'test/abi-compliance/abi_dumps/arm-linux-gnueabihf/libunity-scopes_1.0.0.abi.xml.gz'
 Binary files test/abi-compliance/abi_dumps/arm-linux-gnueabihf/libunity-scopes_1.0.0.abi.xml.gz	1970-01-01 00:00:00 +0000 and test/abi-compliance/abi_dumps/arm-linux-gnueabihf/libunity-scopes_1.0.0.abi.xml.gz	2016-02-15 06:03:52 +0000 differ
 === removed file 'test/abi-compliance/abi_dumps/i386-linux-gnu/libunity-scopes_1.0.0.abi.tar.gz'
 Binary files test/abi-compliance/abi_dumps/i386-linux-gnu/libunity-scopes_1.0.0.abi.tar.gz	2015-09-08 02:29:27 +0000 and test/abi-compliance/abi_dumps/i386-linux-gnu/libunity-scopes_1.0.0.abi.tar.gz	1970-01-01 00:00:00 +0000 differ
 === added file 'test/abi-compliance/abi_dumps/i386-linux-gnu/libunity-scopes_1.0.0.abi.xml.gz'
 Binary files test/abi-compliance/abi_dumps/i386-linux-gnu/libunity-scopes_1.0.0.abi.xml.gz	1970-01-01 00:00:00 +0000 and test/abi-compliance/abi_dumps/i386-linux-gnu/libunity-scopes_1.0.0.abi.xml.gz	2016-02-15 06:03:52 +0000 differ
 === removed file 'test/abi-compliance/abi_dumps/powerpc-linux-gnu/libunity-scopes_1.0.0.abi.tar.gz'
 Binary files test/abi-compliance/abi_dumps/powerpc-linux-gnu/libunity-scopes_1.0.0.abi.tar.gz	2015-09-08 02:29:27 +0000 and test/abi-compliance/abi_dumps/powerpc-linux-gnu/libunity-scopes_1.0.0.abi.tar.gz	1970-01-01 00:00:00 +0000 differ
 === added file 'test/abi-compliance/abi_dumps/powerpc-linux-gnu/libunity-scopes_1.0.0.abi.xml.gz'
 Binary files test/abi-compliance/abi_dumps/powerpc-linux-gnu/libunity-scopes_1.0.0.abi.xml.gz	1970-01-01 00:00:00 +0000 and test/abi-compliance/abi_dumps/powerpc-linux-gnu/libunity-scopes_1.0.0.abi.xml.gz	2016-02-15 06:03:52 +0000 differ
 === removed file 'test/abi-compliance/abi_dumps/powerpc64le-linux-gnu/libunity-scopes_1.0.0.abi.tar.gz'
 Binary files test/abi-compliance/abi_dumps/powerpc64le-linux-gnu/libunity-scopes_1.0.0.abi.tar.gz	2015-09-08 02:29:27 +0000 and test/abi-compliance/abi_dumps/powerpc64le-linux-gnu/libunity-scopes_1.0.0.abi.tar.gz	1970-01-01 00:00:00 +0000 differ
 === added file 'test/abi-compliance/abi_dumps/powerpc64le-linux-gnu/libunity-scopes_1.0.0.abi.xml.gz'
 Binary files test/abi-compliance/abi_dumps/powerpc64le-linux-gnu/libunity-scopes_1.0.0.abi.xml.gz	1970-01-01 00:00:00 +0000 and test/abi-compliance/abi_dumps/powerpc64le-linux-gnu/libunity-scopes_1.0.0.abi.xml.gz	2016-02-15 06:03:52 +0000 differ
 === removed file 'test/abi-compliance/abi_dumps/x86_64-linux-gnu/libunity-scopes_1.0.0.abi.tar.gz'
 Binary files test/abi-compliance/abi_dumps/x86_64-linux-gnu/libunity-scopes_1.0.0.abi.tar.gz	2015-09-08 02:29:27 +0000 and test/abi-compliance/abi_dumps/x86_64-linux-gnu/libunity-scopes_1.0.0.abi.tar.gz	1970-01-01 00:00:00 +0000 differ
 === added file 'test/abi-compliance/abi_dumps/x86_64-linux-gnu/libunity-scopes_1.0.0.abi.xml.gz'
 Binary files test/abi-compliance/abi_dumps/x86_64-linux-gnu/libunity-scopes_1.0.0.abi.xml.gz	1970-01-01 00:00:00 +0000 and test/abi-compliance/abi_dumps/x86_64-linux-gnu/libunity-scopes_1.0.0.abi.xml.gz	2016-02-15 06:03:52 +0000 differ
 === modified file 'test/abi-compliance/check-abi-compliance.sh.in'
 --- test/abi-compliance/check-abi-compliance.sh.in	2015-09-15 21:59:25 +0000
 +++ test/abi-compliance/check-abi-compliance.sh.in	2016-02-15 06:03:52 +0000
@@ -20,10 +20,11 @@
  # Script to check whether the ABI is still intact.
+ #
--# The base ABI (for version <x>.<y>.0) is kept in libunity-scopes_<x>.<y>.0.abi.tar.gz.
--# If the micro version is non-zero, we run abi-compliance-checker to compare the two versions.
++# The base ABI (for version <x>.<y>.0) is kept in libunity-scopes_<x>.<y>.0.abi.xml.gz.
++# If the micro version is non-zero, we run abidiff to compare the two versions.
  # If there are any complaints, we print an error message ane return non-zero status.
++set -x
  progname=$(basename $0)
  distro=$(lsb_release -c -s)
@@ -32,26 +33,63 @@
      exit 0
+ }
++[ @UNITY_SCOPES_MICRO@ -eq 0 ] && exit 0
++
  libname=lib@UNITY_SCOPES_LIB@
--
--base_abi=@CMAKE_CURRENT_SOURCE_DIR@/abi_dumps/@CMAKE_LIBRARY_ARCHITECTURE@/${libname}_@UNITY_SCOPES_MAJOR_MINOR@.0.abi.tar.gz
--cur_abi=@CMAKE_CURRENT_BINARY_DIR@/abi_dumps/${libname}/${libname}_@UNITY_SCOPES_FULL_VERSION@.abi.tar.gz
++base_abi_dir=@CMAKE_CURRENT_SOURCE_DIR@/abi_dumps/@CMAKE_LIBRARY_ARCHITECTURE@
++base_abi=${libname}_@UNITY_SCOPES_MAJOR_MINOR@.0.abi.xml
++
++gunzip -c ${base_abi_dir}/${base_abi}.gz >${base_abi}
++
++cur_abi=${libname}_@UNITY_SCOPES_FULL_VERSION@.abi.xml
++report=${libname}_@UNITY_SCOPES_FULL_VERSION@_abi-report.txt
++
++# If the current lib doesn't contain debug info, we can't run the test.
++# TODO: See https://sourceware.org/bugzilla/show_bug.cgi?id=19621
++info_file=$(mktemp)
++readelf --debug-dump=info @CMAKE_BINARY_DIR@/${libname}.so >$info_file
++[ $? -ne 0 ] && exit 1
++[ -s $info_file ]
++no_debug_info=$?
++rm -f $info_file
++[ $no_debug_info -eq 1 ] && {
++    echo "${progname}: Skipping ABI test because ${libname}.so was compiled without -g"
++    exit 0
++}
  # Compare against the base ABI.
--abi-compliance-checker -lib ${libname} -old $base_abi -new $cur_abi
--
++abidiff --no-unreferenced-symbols --suppressions @CMAKE_CURRENT_SOURCE_DIR@/suppressions \
++    ${base_abi} ${cur_abi} >${report} 2>&1
  status=$?
--report=@CMAKE_CURRENT_BINARY_DIR@/compat_reports/${libname}/1.0.0_to_@UNITY_SCOPES_FULL_VERSION@/compat_report.html
--[ -e $report ] && {
--    echo "${progname}: Compatibility report generated to $report"
--}
--
--[ $status -ne 0 ] && {
--    [ $status -eq 1 ] && {
--        echo "${progname}: ERROR: Incompatible ABI!" >&2
--    }
--    echo "${progname}: ERROR: abi-compliance-checker returned exit status $status" >&2
--    exit 1
--}
--
--exit 0
++
++# TODO: Exit status test is not reliable with 1.0.rc2 (https://sourceware.org/bugzilla/show_bug.cgi?id=19596).
++#       We instead rely on the report size for the time being. When suppressions are used, and there are
++#       no problems, the report still contains three lines of summary, so we fail if there are more than
++#       three lines.
++num_lines=$(wc -l <${report})
++[ $num_lines -gt 3 ] && {
++    echo "${progname}: ERROR: Incompatible ABI!" >&2
++    cat ${report} >&2
++    exit 8
++}
++exit $status  # TODO
++
++# Incompatible changes found.
++[ $status -ge 8 ] && {
++    echo "${progname}: ERROR: Incompatible ABI!" >&2
++    cat ${report} >&2
++    exit $status
++}
++
++# Possibly incompatible changes found.
++[ $status -ge 4 ] && {
++    echo "${progname}: ABI has possibly incompatible changes, see $report for details."
++    exit $status
++}
++
++# All went fine.
++[ $status -eq 0 ] && exit 0
++
++# Some other error
++echo "${progname}: Unexpected error, see $report for details." >&2
++exit $status
 === modified file 'test/abi-compliance/gen-abi-dump.sh.in'
 --- test/abi-compliance/gen-abi-dump.sh.in	2015-09-10 00:39:52 +0000
 +++ test/abi-compliance/gen-abi-dump.sh.in	2016-02-15 06:03:52 +0000
@@ -21,7 +21,7 @@
  # Script to dump the current ABI.
  libname=lib@UNITY_SCOPES_LIB@
--cur_abi=@CMAKE_CURRENT_BINARY_DIR@/abi_dumps/${libname}/${libname}_@UNITY_SCOPES_FULL_VERSION@.abi.tar.gz
++cur_abi=@CMAKE_CURRENT_BINARY_DIR@/${libname}_@UNITY_SCOPES_FULL_VERSION@.abi.xml
  distro=$(lsb_release -c -s)
  [ "$distro" = "vivid" ] && {
@@ -30,6 +30,6 @@
+ }
  # Dump the current ABI.
--abi-compliance-checker -lib ${libname} -dump @CMAKE_CURRENT_BINARY_DIR@/abi.xml
++abidw --out-file ${cur_abi} @CMAKE_BINARY_DIR@/${libname}.so
  exit $?
 === added file 'test/abi-compliance/suppressions'
 --- test/abi-compliance/suppressions	1970-01-01 00:00:00 +0000
 +++ test/abi-compliance/suppressions	2016-02-15 06:03:52 +0000
@@ -0,0 +1,21 @@
++# Suppressions for template functions that are instantiated due to new
++# types that were added since the baseline.
++
++# TODO: The allows_other_aliases is currently needed due to a bug in abigail 1.0.rc2.
++#       One a newer version becomes available, they can be removed.
++#       https://sourceware.org/bugzilla/show_bug.cgi?id=19619
++
++[suppress_function]
++    name_regexp = boost::.*
++    change_kind = added-function
++    allow_other_aliases = false
++
++[suppress_function]
++    name_regexp = std::.*
++    change_kind = added-function
++    allow_other_aliases = false
++
++[suppress_function]
++    name_regexp = unity::scopes::testing::.*
++    change_kind = added-function
++    allow_other_aliases = false