| |
| <!DOCTYPE html> |
| <html lang="en" dir="ltr" class="client-nojs"> |
| <head> |
| <title>ABI Compliance Checker</title> |
| <meta charset="UTF-8" /> |
| <meta name="generator" content="MediaWiki 1.18.1" /> |
| <link rel="shortcut icon" href="/favicon.ico" /> |
| <link rel="search" type="application/opensearchdescription+xml" href="/opensearch_desc.php" title="ISP_RAS (en)" /> |
| <link rel="EditURI" type="application/rsd+xml" href="http://ispras.linuxbase.org/api.php?action=rsd" /> |
| <link rel="alternate" type="application/atom+xml" title="ISP_RAS Atom feed" href="/index.php?title=Special:RecentChanges&feed=atom" /> |
| <link rel="stylesheet" href="/load.php?debug=false&lang=en&modules=mediawiki.legacy.commonPrint%2Cshared%7Cskins.monobook&only=styles&skin=monobook&*" /> |
| <!--[if lt IE 5.5000]><link rel="stylesheet" href="/skins/monobook/IE50Fixes.css?303" media="screen" /><![endif]--> |
| <!--[if IE 5.5000]><link rel="stylesheet" href="/skins/monobook/IE55Fixes.css?303" media="screen" /><![endif]--> |
| <!--[if IE 6]><link rel="stylesheet" href="/skins/monobook/IE60Fixes.css?303" media="screen" /><![endif]--> |
| <!--[if IE 7]><link rel="stylesheet" href="/skins/monobook/IE70Fixes.css?303" media="screen" /><![endif]--><meta name="ResourceLoaderDynamicStyles" content="" /> |
| <link rel="stylesheet" href="/load.php?debug=false&lang=en&modules=site&only=styles&skin=monobook&*" /> |
| <style>a:lang(ar),a:lang(ckb),a:lang(fa),a:lang(kk-arab),a:lang(mzn),a:lang(ps),a:lang(ur){text-decoration:none}a.new,#quickbar a.new{color:#ba0000} |
| |
| /* cache key: rasispdb:resourceloader:filter:minify-css:4:c88e2bcd56513749bec09a7e29cb3ffa */ |
| </style> |
| <script src="/load.php?debug=false&lang=en&modules=startup&only=scripts&skin=monobook&*"></script> |
| <script>if(window.mw){ |
| mw.config.set({"wgCanonicalNamespace": "", "wgCanonicalSpecialPageName": false, "wgNamespaceNumber": 0, "wgPageName": "ABI_compliance_checker", "wgTitle": "ABI Compliance Checker", "wgCurRevisionId": 7730, "wgArticleId": 2292, "wgIsArticle": true, "wgAction": "view", "wgUserName": null, "wgUserGroups": ["*"], "wgCategories": ["ABI Compliance Checker"], "wgBreakFrames": false, "wgRestrictionEdit": [], "wgRestrictionMove": []}); |
| } |
| </script><script>if(window.mw){ |
| mw.loader.load(["mediawiki.page.startup"]); |
| } |
| </script> |
| </head> |
| <body class="mediawiki ltr sitedir-ltr ns-0 ns-subject page-ABI_compliance_checker action-view skin-monobook"> |
| <div id="globalWrapper"> |
| <div id="column-content"><div id="content"> |
| <a id="top"></a> |
| |
| <h1 id="firstHeading" class="firstHeading">ABI Compliance Checker</h1> |
| <div id="bodyContent"> |
| <div id="siteSub"></div> |
| <div id="contentSub"></div> |
| |
| <!-- start content --> |
| <div lang="en" dir="ltr" class="mw-content-ltr"><p><i>ABI Compliance Checker (ACC)</i> is a tool for checking backward binary and source-level compatibility of a C/C++ library. The tool checks header files and shared libraries of old and new versions and analyzes changes in API and ABI (ABI=API+compiler ABI) that may break binary and/or source compatibility: changes in calling stack, v-table changes, removed symbols, renamed fields, etc. Binary incompatibility may result in crashing or incorrect behavior of applications built with an old version of a library if they run on a new one. Source incompatibility may result in recompilation errors with a new library version. The tool is intended for developers of software libraries and maintainers of operating systems who are interested in ensuring backward compatibility, i.e. allow old applications to run or to be recompiled with newer library versions. |
| </p><p>See also: |
| </p> |
| <ul><li> <a rel="nofollow" class="external text" href="http://upstream-tracker.org/">Upstream Tracker</a> |
| </li><li> <a rel="nofollow" class="external text" href="http://pkgdiff.github.com/pkgdiff/">PkgDiff</a> |
| </li></ul> |
| <p><br /> |
| </p> |
| <table id="toc" class="toc"><tr><td><div id="toctitle"><h2>Contents</h2></div> |
| <ul> |
| <li class="toclevel-1 tocsection-1"><a href="#Downloads"><span class="tocnumber">1</span> <span class="toctext">Downloads</span></a> |
| <ul> |
| <li class="toclevel-2 tocsection-2"><a href="#Releases"><span class="tocnumber">1.1</span> <span class="toctext">Releases</span></a></li> |
| <li class="toclevel-2 tocsection-3"><a href="#Git"><span class="tocnumber">1.2</span> <span class="toctext">Git</span></a></li> |
| <li class="toclevel-2 tocsection-4"><a href="#SVN_.28obsolete.29"><span class="tocnumber">1.3</span> <span class="toctext">SVN (obsolete)</span></a></li> |
| </ul> |
| </li> |
| <li class="toclevel-1 tocsection-5"><a href="#License"><span class="tocnumber">2</span> <span class="toctext">License</span></a></li> |
| <li class="toclevel-1 tocsection-6"><a href="#Supported_Platforms"><span class="tocnumber">3</span> <span class="toctext">Supported Platforms</span></a></li> |
| <li class="toclevel-1 tocsection-7"><a href="#System_Requirements"><span class="tocnumber">4</span> <span class="toctext">System Requirements</span></a></li> |
| <li class="toclevel-1 tocsection-8"><a href="#Detectable_Compatibility_Problems"><span class="tocnumber">5</span> <span class="toctext">Detectable Compatibility Problems</span></a></li> |
| <li class="toclevel-1 tocsection-9"><a href="#Installation"><span class="tocnumber">6</span> <span class="toctext">Installation</span></a></li> |
| <li class="toclevel-1 tocsection-10"><a href="#Usage"><span class="tocnumber">7</span> <span class="toctext">Usage</span></a> |
| <ul> |
| <li class="toclevel-2 tocsection-11"><a href="#Compare_Libraries"><span class="tocnumber">7.1</span> <span class="toctext">Compare Libraries</span></a></li> |
| <li class="toclevel-2 tocsection-12"><a href="#Compare_Operating_Systems"><span class="tocnumber">7.2</span> <span class="toctext">Compare Operating Systems</span></a></li> |
| <li class="toclevel-2 tocsection-13"><a href="#Check_Applications_Portability"><span class="tocnumber">7.3</span> <span class="toctext">Check Applications Portability</span></a></li> |
| <li class="toclevel-2 tocsection-14"><a href="#Dump_Library_ABI_to_TXT_file"><span class="tocnumber">7.4</span> <span class="toctext">Dump Library ABI to TXT file</span></a></li> |
| <li class="toclevel-2 tocsection-15"><a href="#Command-Line_Options"><span class="tocnumber">7.5</span> <span class="toctext">Command-Line Options</span></a></li> |
| <li class="toclevel-2 tocsection-16"><a href="#Examples"><span class="tocnumber">7.6</span> <span class="toctext">Examples</span></a></li> |
| </ul> |
| </li> |
| <li class="toclevel-1 tocsection-17"><a href="#Tutorial"><span class="tocnumber">8</span> <span class="toctext">Tutorial</span></a></li> |
| <li class="toclevel-1 tocsection-18"><a href="#Report_Format"><span class="tocnumber">9</span> <span class="toctext">Report Format</span></a></li> |
| <li class="toclevel-1 tocsection-19"><a href="#Verdict_on_Compatibility"><span class="tocnumber">10</span> <span class="toctext">Verdict on Compatibility</span></a></li> |
| <li class="toclevel-1 tocsection-20"><a href="#Error_Codes"><span class="tocnumber">11</span> <span class="toctext">Error Codes</span></a></li> |
| <li class="toclevel-1 tocsection-21"><a href="#FAQ"><span class="tocnumber">12</span> <span class="toctext">FAQ</span></a></li> |
| <li class="toclevel-1 tocsection-22"><a href="#Similar_Tools"><span class="tocnumber">13</span> <span class="toctext">Similar Tools</span></a></li> |
| <li class="toclevel-1 tocsection-23"><a href="#Bugs"><span class="tocnumber">14</span> <span class="toctext">Bugs</span></a></li> |
| <li class="toclevel-1 tocsection-24"><a href="#Maintainers"><span class="tocnumber">15</span> <span class="toctext">Maintainers</span></a></li> |
| <li class="toclevel-1 tocsection-25"><a href="#Sponsors"><span class="tocnumber">16</span> <span class="toctext">Sponsors</span></a></li> |
| <li class="toclevel-1 tocsection-26"><a href="#Credits"><span class="tocnumber">17</span> <span class="toctext">Credits</span></a></li> |
| <li class="toclevel-1 tocsection-27"><a href="#Articles"><span class="tocnumber">18</span> <span class="toctext">Articles</span></a></li> |
| </ul> |
| </td></tr></table> |
| <h2> <span class="mw-headline" id="Downloads"> Downloads </span></h2> |
| <h3> <span class="mw-headline" id="Releases"> Releases </span></h3> |
| <p>All releases can be downloaded from <b><a href="http://ispras.linuxfoundation.org/index.php/ABI_compliance_checker_Downloads" title="ABI Compliance Checker Downloads">this page</a></b> or <b><a rel="nofollow" class="external text" href="https://github.com/lvc/abi-compliance-checker/downloads/">github.com</a></b>. |
| </p><p>Latest release: <a rel="nofollow" class="external text" href="https://github.com/lvc/abi-compliance-checker/downloads/abi-compliance-checker-1.97.1.tar.gz">1.97.1</a> |
| </p> |
| <h3> <span class="mw-headline" id="Git"> Git </span></h3> |
| <p>Read-only access to the latest development version:<br /> |
|   <code style="border: dashed 1px gray; background-color: #f0f0f0;"> git clone <a rel="nofollow" class="external text" href="https://github.com/lvc/abi-compliance-checker">git://github.com/lvc/abi-compliance-checker.git</a>  </code><br /> |
| </p> |
| <h3> <span class="mw-headline" id="SVN_.28obsolete.29"> SVN (obsolete) </span></h3> |
| <p>Read-only access to the latest development version:<br /> |
|   <code style="border: dashed 1px gray; background-color: #f0f0f0;"> svn co <a rel="nofollow" class="external free" href="http://forge.ispras.ru/svn/abi-compliance-checker">http://forge.ispras.ru/svn/abi-compliance-checker</a> </code><br /> |
| </p> |
| <h2> <span class="mw-headline" id="License"> License </span></h2> |
| <p>This program is free software. You may use, redistribute and/or modify it under the terms of either the GNU <a rel="nofollow" class="external text" href="http://www.gnu.org/licenses/">GPL</a> or <a rel="nofollow" class="external text" href="http://www.gnu.org/licenses/">LGPL</a>. |
| </p> |
| <h2> <span class="mw-headline" id="Supported_Platforms"> Supported Platforms </span></h2> |
| <p>GNU/Linux, FreeBSD, Mac OS X, MS Windows (Xp, Vista, 7), Haiku (BeOS). |
| </p> |
| <h2> <span class="mw-headline" id="System_Requirements"> System Requirements </span></h2> |
| <ul><li><b>Linux</b> |
| <ul><li> <a rel="nofollow" class="external text" href="http://gcc.gnu.org/">G++</a> (3.0-4.6.2, recommended >= 4.5) |
| </li><li> <a rel="nofollow" class="external text" href="http://www.gnu.org/software/binutils/">GNU Binutils</a> (readelf, c++filt, objdump) |
| </li><li> <a rel="nofollow" class="external text" href="http://www.perl.org/">Perl</a> (5.8-5.14) |
| </li><li> WARNING: if you are using ccache program (i.e. gcc points to /usr/lib/ccache/gcc) then it should be newer than 3.1.2 or disabled. |
| </li></ul> |
| </li></ul> |
| <ul><li><b>Mac OS X</b> |
| <ul><li> <a rel="nofollow" class="external text" href="http://developer.apple.com/technologies/tools/xcode.html">Xcode</a> (gcc, otool, c++filt) |
| </li></ul> |
| </li></ul> |
| <ul><li><b>MS Windows</b> |
| <ul><li> <a rel="nofollow" class="external text" href="http://www.mingw.org/">MinGW</a> (3.0-4.6.2, recommended >= 4.5) |
| </li><li> MS Visual C++ (dumpbin, undname, cl) |
| </li><li> <a rel="nofollow" class="external text" href="http://www.activestate.com/activeperl">Active Perl</a> (5.8-5.14) |
| </li><li> Sigcheck v1.71 or newer |
| </li><li> Info-ZIP 3.0 (zip, unzip) |
| </li><li> Add gcc.exe path (C:\MinGW\bin\) to your system PATH variable |
| </li><li> Run vsvars32.bat script (C:\Microsoft Visual Studio 9.0\Common7\Tools\) |
| </li></ul> |
| </li></ul> |
| <h2> <span class="mw-headline" id="Detectable_Compatibility_Problems"> Detectable Compatibility Problems </span></h2> |
| <p>The tool searches for the following list of changes in the API that may break binary compatibility: |
| </p> |
| <ul><li> <b>Removed Symbols</b> (functions, global data) |
| </li><li> <b>Problems with Data Types</b> |
| <ul><li> <b>Structures</b> |
| <ul><li> added/removed fields (change of structure layout) |
| </li><li> change of size |
| </li><li> changed order of fields |
| </li><li> changes in fields (recursive analysis) |
| </li></ul> |
| </li><li> <b>Classes</b> |
| <ul><li> added/removed virtual functions (change of v-table layout) |
| </li><li> change of virtual function position |
| </li><li> overridden virtual functions |
| </li><li> changes in base classes (recursive analysis) |
| </li></ul> |
| </li><li> <b>Unions</b> |
| <ul><li> added/removed fields |
| </li><li> change of size |
| </li><li> changes in fields (recursive analysis) |
| </li></ul> |
| </li><li> <b>Enumerations</b> |
| <ul><li> change of a member value |
| </li><li> removed/renamed members |
| </li></ul> |
| </li></ul> |
| </li><li> <b>Problems with Symbols</b> |
| <ul><li> <b>Stack Frame</b> |
| <ul><li> added/removed parameters |
| </li><li> change of parameter type |
| </li><li> change of default parameter value |
| </li><li> change of return value type |
| </li><li> renamed parameters |
| </li></ul> |
| </li><li> <b>Other</b> |
| <ul><li> incorrect version change |
| </li><li> changed attributes |
| </li></ul> |
| </li></ul> |
| </li><li> <b>Problems with Constants</b> (#defines) |
| <ul><li> changed value |
| </li></ul> |
| </li><li> <b>Problems with Implementation</b> |
| <ul><li> changes in disassembled binary code |
| </li></ul> |
| </li></ul> |
| <p>You can see detailed problem descriptions in the HTML ABI compliance report (see <a rel="nofollow" class="external text" href="http://upstream-tracker.org/compat_reports/mysql++/3.0.9_to_3.1.0/abi_compat_report.html">example</a>) generated by the tool. |
| </p> |
| <h2> <span class="mw-headline" id="Installation"> Installation </span></h2> |
| <p>The tool is <b>ready-to-use</b> after extracting the archive. You can also use a <b>Makefile</b> to install the tool into the system:<br /> |
| <code style="border: dashed 1px gray; background-color: #f0f0f0;"> cd abi-compliance-checker-x.y.z/ </code><br /><br /> |
| <code style="border: dashed 1px gray; background-color: #f0f0f0;"> sudo perl Makefile.pl -install --prefix=PREFIX [/usr, /usr/local, ...] </code> |
| </p><p>This command will install an <code style="border: dashed 1px gray; background-color: #f0f0f0;"> abi-compliance-checker </code> program in the <code style="border: dashed 1px gray; background-color: #f0f0f0;"> PREFIX/bin </code> system directory and private modules into the <code style="border: dashed 1px gray; background-color: #f0f0f0;"> PREFIX/share </code>. |
| </p> |
| <h2> <span class="mw-headline" id="Usage"> Usage </span></h2> |
| <p>For using the tool, you should provide the <a href="http://ispras.linuxfoundation.org/index.php/Library_Descriptor" title="Library Descriptor"><b>XML descriptors</b></a> for two library versions: <a href="http://ispras.linuxfoundation.org/index.php/Library_Descriptor" title="Library Descriptor"><b>v1.xml</b></a> and <a href="http://ispras.linuxfoundation.org/index.php/Library_Descriptor" title="Library Descriptor"><b>v2.xml</b></a> files. Library descriptor is a simple XML-file that specifies version number, paths to header files and shared libraries and other optional information. An example of the descriptor is the following (0.3.4.xml): |
| </p> |
| <pre><span style="color:Green;"><version></span> |
| 0.3.4 |
| <span style="color:Green;"></version></span> |
| |
| <span style="color:Green;"><headers></span> |
| /usr/local/libssh/0.3.4/include/ |
| <span style="color:Green;"></headers></span> |
| |
| <span style="color:Green;"><libs></span> |
| /usr/local/libssh/0.3.4/lib/ |
| <span style="color:Green;"></libs></span> |
| </pre> |
| <h3> <span class="mw-headline" id="Compare_Libraries"> Compare Libraries </span></h3> |
| <p>Command to compare two versions of a library:<br /> |
|   <code style="border: dashed 1px gray; background-color: #f0f0f0;"> abi-compliance-checker -l <i><library_name></i> -d1 <i><<a href="http://ispras.linuxfoundation.org/index.php/Library_Descriptor" title="Library Descriptor">v1.xml</a>></i> -d2 <i><<a href="http://ispras.linuxfoundation.org/index.php/Library_Descriptor" title="Library Descriptor">v2.xml</a>></i> </code><br /><br /> |
| The compatibility report will be generated to:<br /> |
|   <code style="border: dashed 1px gray; background-color: #f0f0f0;"> compat_reports/<i><library_name></i>/<i><v1></i>_to_<i><v2></i>/compat_report.html </code> |
| </p> |
| <h3> <span class="mw-headline" id="Compare_Operating_Systems"> Compare Operating Systems </span></h3> |
| <p>The detailed explanation on how to check compatibility between operating systems you can read on <b><a href="http://ispras.linuxfoundation.org/index.php/Operating_Systems_Compatibility" title="Operating Systems Compatibility">this page</a></b>. |
| </p><p>See current test results for <b>Symbian</b>, <b>Windows</b>, <b>MeeGo</b> and <b>Maemo</b> on <b><a rel="nofollow" class="external text" href="http://linuxtesting.org/compatibility/index.html">this page</a></b>. |
| </p> |
| <h3> <span class="mw-headline" id="Check_Applications_Portability"> Check Applications Portability </span></h3> |
| <p>The ACC tool can be used by ISVs for checking applications portability to new library versions by specifying of its binary using <a href="http://ispras.linuxfoundation.org/index.php/ABI_compliance_checker_Options" title="ABI Compliance Checker Options">-app</a> option:<br /> |
|   <code style="border: dashed 1px gray; background-color: #f0f0f0;"> abi-compliance-checker -l <i><library_name></i> -d1 <i><<a href="http://ispras.linuxfoundation.org/index.php/Library_Descriptor" title="Library Descriptor">v1.xml</a>></i> -d2 <i><<a href="http://ispras.linuxfoundation.org/index.php/Library_Descriptor" title="Library Descriptor">v2.xml</a>></i> -app <i><application></i> </code> |
| </p><p>Found issues can be taken into account when adapting the application to a new library version. |
| </p> |
| <h3> <span class="mw-headline" id="Dump_Library_ABI_to_TXT_file"> Dump Library ABI to TXT file </span></h3> |
| <p>To compare library versions that are not co-existed on one machine you can dump ABI to gzipped TXT format file using <a href="http://ispras.linuxfoundation.org/index.php/ABI_compliance_checker_Options#General_Options" title="ABI Compliance Checker Options">-dump</a> option:<br /> |
|   <code style="border: dashed 1px gray; background-color: #f0f0f0;"> abi-compliance-checker -l <i><library_name></i> -dump <i><<a href="http://ispras.linuxfoundation.org/index.php/Library_Descriptor" title="Library Descriptor">some_version.xml</a>></i> </code><br /><br /> |
| The ABI dump will be generated to:<br /> |
|   <code style="border: dashed 1px gray; background-color: #f0f0f0;"> abi_dumps/<i><library_name></i>/<i><library_name></i>_<i><some_version></i>.abi.tar.gz </code><br /><br /> |
| Then transfer and pass it instead of the library descriptor:<br /> |
|   <code style="border: dashed 1px gray; background-color: #f0f0f0;"> abi-compliance-checker -l <i><library_name></i> -d1 <i><v1_dump.tar.gz></i> -d2 <i><v2_dump.tar.gz></i> </code><br /> |
| </p> |
| <h3> <span class="mw-headline" id="Command-Line_Options"> Command-Line Options </span></h3> |
| <p>See the list of all options on <b><a href="http://ispras.linuxfoundation.org/index.php/ABI_compliance_checker_Options" title="ABI Compliance Checker Options">this page</a></b>. |
| </p><p>Up-to-date list of all supported options can be obtained using the following command: |
| </p><p>  <code style="border: dashed 1px gray; background-color: #f0f0f0;"> abi-compliance-checker --info </code><br /><br /> |
| </p> |
| <h3> <span class="mw-headline" id="Examples"> Examples </span></h3> |
| <p>Check the libssh library versions for ABI compatibility:<br /> |
|   <code style="border: dashed 1px gray; background-color: #f0f0f0;"> abi-compliance-checker -l libssh -d1 <a href="http://ispras.linuxfoundation.org/index.php/Library_Descriptor" title="Library Descriptor">0.3.4.xml</a> -d2 <a href="http://ispras.linuxfoundation.org/index.php/Library_Descriptor" title="Library Descriptor">0.4.0.xml</a> </code><br /><br /> |
| The compatibility report will be generated to:<br /> |
|   <code style="border: dashed 1px gray; background-color: #f0f0f0;"> compat_reports/libssh/0.3.4_to_0.4.0/compat_report.html </code><br /><br /> |
| Dump library ABI:<br /> |
|   <code style="border: dashed 1px gray; background-color: #f0f0f0;"> abi-compliance-checker -l libssh -dump <a href="http://ispras.linuxfoundation.org/index.php/Library_Descriptor" title="Library Descriptor">0.3.4.xml</a> </code><br /><br /> |
| The ABI will be dumped to:<br /> |
|   <code style="border: dashed 1px gray; background-color: #f0f0f0;"> abi_dumps/libssh/libssh_0.3.4.abi.tar.gz </code><br /><br /> |
| Use previously dumped ABI:<br /> |
|   <code style="border: dashed 1px gray; background-color: #f0f0f0;"> abi-compliance-checker -l libssh -d1 libssh_0.3.4.abi.tar.gz -d2 libssh_0.4.0.abi.tar.gz </code><br /><br /> |
| Check application (csync) portability between libssh versions:<br /> |
|   <code style="border: dashed 1px gray; background-color: #f0f0f0;"> abi-compliance-checker -l libssh -d1 <a href="http://ispras.linuxfoundation.org/index.php/Library_Descriptor" title="Library Descriptor">0.3.4.xml</a> -d2 <a href="http://ispras.linuxfoundation.org/index.php/Library_Descriptor" title="Library Descriptor">0.4.0.xml</a> -app /usr/bin/csync </code><br /><br /> |
| </p> |
| <h2> <span class="mw-headline" id="Tutorial"> Tutorial </span></h2> |
| <p>An excellent tutorial <a rel="nofollow" class="external text" href="http://blog.famillecollet.com/post/2010/06/20/ABI-%3A-stability-check">"ABI: stability check"</a> is available at <a rel="nofollow" class="external text" href="http://blog.famillecollet.com/en">Les RPM de Remi Blog</a>. |
| </p> |
| <h2> <span class="mw-headline" id="Report_Format"> Report Format </span></h2> |
| <p>The report consists of: |
| </p> |
| <ul><li> <b>Test Info</b> - The library name and compared version numbers. Environment info: GCC version and CPU architecture. |
| </li><li> <b>Test Results</b> - Verdict on binary compatibility. Number of header files, shared libraries, symbols and data types checked by the tool. |
| </li><li> <b>Problem Summary</b> - Classification of binary compatibility problems. |
| </li><li> <b>Added Symbols</b> - List of added symbols. |
| </li><li> <b>Removed Symbols</b> - List of removed symbols. |
| </li><li> <b>Problems with Data Types</b> - List of binary compatibility problems caused by changes in data types (divided by the severity level: High, Medium and Low). List of affected symbols. |
| </li><li> <b>Problems with Symbols</b> - List of binary compatibility problems caused by changes in symbol parameters or attributes (divided by the severity level). |
| </li><li> <b>Problems with Constants</b> - List of changed constants (#defines). |
| </li><li> <b>Problems with Implementation</b> - List of changes in disassembled binary code. Use <a href="http://ispras.linuxfoundation.org/index.php/ABI_compliance_checker_Options#Extra_Options" title="ABI Compliance Checker Options">-check-implementation</a> option to enable this section. |
| </li></ul> |
| <p>Examples: |
| </p> |
| <ul><li> NetCDF: 4.0.1 to 4.1.1 API compatibility <a rel="nofollow" class="external text" href="http://upstream-tracker.org/compat_reports/netcdf/4.0.1_to_4.1.1/compat_report.html">report</a> |
| </li><li> MySQL++: 3.0.9 to 3.1.0 binary compatibility <a rel="nofollow" class="external text" href="http://upstream-tracker.org/compat_reports/mysql++/3.0.9_to_3.1.0/abi_compat_report.html">report</a> |
| </li><li> libssh: 0.3.4 to 0.4.0 binary compatibility <a rel="nofollow" class="external text" href="http://upstream-tracker.org/compat_reports/libssh/0.3.4_to_0.4.0/abi_compat_report.html">report</a> |
| </li></ul> |
| <h2> <span class="mw-headline" id="Verdict_on_Compatibility"> Verdict on Compatibility </span></h2> |
| <p>If the tool detected problems with high or medium level of severity or at least one removed symbol then the compatibility verdict is <b>incompatible</b> (otherwise <b>compatible</b>). Low-severity problems can be considered as <b>warnings</b> and don't affect the compatibility verdict unless the <a href="http://ispras.linuxfoundation.org/index.php/ABI_compliance_checker_Options" title="ABI Compliance Checker Options">-strict</a> option is specified. |
| </p> |
| <h2> <span class="mw-headline" id="Error_Codes"> Error Codes </span></h2> |
| <table class="wikitable"> |
| <tr> |
| <th> Code |
| </th> |
| <th> Meaning |
| </th></tr> |
| <tr align="left"> |
| <td> 0 |
| </td> |
| <td> Compatible. The tool has run without any errors. |
| </td></tr> |
| <tr align="left"> |
| <td> 1 |
| </td> |
| <td> Incompatible. The tool has run without any errors. |
| </td></tr> |
| <tr align="left"> |
| <td> 2 |
| </td> |
| <td> Common error code (undifferentiated). |
| </td></tr> |
| <tr align="left"> |
| <td> 3 |
| </td> |
| <td> A system command is not found. |
| </td></tr> |
| <tr align="left"> |
| <td> 4 |
| </td> |
| <td> Cannot access input files. |
| </td></tr> |
| <tr align="left"> |
| <td> 5 |
| </td> |
| <td> Cannot compile header files. |
| </td></tr> |
| <tr align="left"> |
| <td> 6 |
| </td> |
| <td> Headers have been compiled with minor errors. |
| </td></tr> |
| <tr align="left"> |
| <td> 7 |
| </td> |
| <td> Invalid input ABI dump. |
| </td></tr> |
| <tr align="left"> |
| <td> 8 |
| </td> |
| <td> Unsupported version of input ABI dump. |
| </td></tr> |
| <tr align="left"> |
| <td> 9 |
| </td> |
| <td> Cannot find a module. |
| </td></tr> |
| <tr align="left"> |
| <td> 10 |
| </td> |
| <td> Empty intersection between headers and shared objects. |
| </td></tr> |
| <tr align="left"> |
| <td> 11 |
| </td> |
| <td> Empty set of symbols in headers. |
| </td></tr></table> |
| <h2> <span class="mw-headline" id="FAQ"> FAQ </span></h2> |
| <ul><li> <b>What is an ABI and how does it differ from an API?</b> |
| </li></ul> |
| <p>An Application Binary Interface (ABI) is the set of supported run-time interfaces provided by a software component or set of components for applications to use, whereas an Application Programming Interface (API) is the set of build-time interfaces. The ABI may be defined by the formula: |
| </p> |
| <pre> ABI = API + compiler ABI |
| </pre> |
| <ul><li> <b>Why does this tool need both shared libraries and header files to check ABI compliance?</b> |
| </li></ul> |
| <p>Without header files it is impossible to determine public symbols in ABI and data type definitions. Without shared libraries it is impossible to determine exported symbols in the ABI of the target library and also impossible to detect added/removed symbols. |
| </p> |
| <h2> <span class="mw-headline" id="Similar_Tools"> Similar Tools </span></h2> |
| <ol><li> <b>icheck</b> - C interface ABI/API checker, |
| </li><li> <b>BCS</b> - The Symbian Binary Compatibility Suite, |
| </li><li> <b>shlib-compat</b> - ABI compatibility checker that uses DWARF debug info, |
| </li><li> <b>qbic</b> - A tool to check for binary incompatibilities in Qt4 Toolkit, |
| </li><li> <b>chkshlib</b>, <b>cmpdylib</b>, <b>cmpshlib</b> - compare symbols presence. |
| </li></ol> |
| <h2> <span class="mw-headline" id="Bugs"> Bugs </span></h2> |
| <p>Please post your bug reports, feature requests and questions to the <a rel="nofollow" class="external text" href="http://forge.ispras.ru/projects/abi-compliance-checker">issue tracker</a> or send to <a rel="nofollow" class="external text" href="mailto:aponomarenko@rosalab.ru">this address</a>. |
| </p> |
| <h2> <span class="mw-headline" id="Maintainers"> Maintainers </span></h2> |
| <p>The tool was initially developed by the <a rel="nofollow" class="external text" href="http://linuxtesting.org">Russian Linux Verification Center</a> at <a href="http://ispras.linuxfoundation.org/index.php/ISP_RAS_Company_Profile" title="ISP RAS Company Profile">ISPRAS</a> and is now developed by <a rel="nofollow" class="external text" href="http://www.rosalab.com/">ROSA Laboratory</a> in Russia. <a rel="nofollow" class="external text" href="http://andrey-ponomarenko.myopenid.com/">Andrey Ponomarenko</a> is the leader of this project. |
| </p> |
| <h2> <span class="mw-headline" id="Sponsors"> Sponsors </span></h2> |
| <p>The development of this tool is currently sponsored by <a rel="nofollow" class="external text" href="http://www.nokia.com/">Nokia</a>.<br /><br /> |
| <a href="/index.php/File:Logo_nokia.gif" class="image"><img alt="Logo nokia.gif" src="http://ispras.linuxfoundation.org/images/e/e2/Logo_nokia.gif" width="115" height="40" /></a> |
| </p><p>If you want to be a sponsor and move the development of the tool in the way you need then please contact us at <a rel="nofollow" class="external text" href="mailto:aponomarenko@rosalab.ru">this</a> address. |
| </p> |
| <h2> <span class="mw-headline" id="Credits"> Credits </span></h2> |
| <p>We would like to thank <a href="http://ispras.linuxfoundation.org/index.php/Thanks" title="Thanks">everyone</a> who has contributed to the success of this project! |
| </p> |
| <h2> <span class="mw-headline" id="Articles"> Articles </span></h2> |
| <p>Here is the list of articles about shared libraries and binary compatibility: |
| </p> |
| <ol><li> KDE TechBase, <a rel="nofollow" class="external text" href="http://techbase.kde.org/Policies/Binary_Compatibility_Issues_With_C++"><b>“Binary Compatibility Issues With C++”</b></a> |
| </li><li> KDE TechBase, <a rel="nofollow" class="external text" href="http://techbase.kde.org/Policies/Binary_Compatibility_Examples"><b>“Binary Compatibility Examples”</b></a> |
| </li><li> codesourcery.com, <a rel="nofollow" class="external text" href="http://www.codesourcery.com/public/cxx-abi/abi.html"><b>"Itanium C++ ABI"</b></a> |
| </li><li> Josh Faust, <a rel="nofollow" class="external text" href="http://www.ros.org/reps/rep-0009.html"><b>"ABI Compatibility"</b></a> |
| </li><li> Les RPM de Remi - Blog, <a rel="nofollow" class="external text" href="http://blog.famillecollet.com/post/2010/06/20/ABI-%3A-stability-check"><b>"ABI : stability check"</b></a> |
| </li><li> Agner Fog, <a rel="nofollow" class="external text" href="http://www.agner.org/optimize/calling_conventions.pdf"><b>“Calling conventions for different C++ compilers and operating systems”</b></a> |
| </li><li> Andreas Jonsson, <a rel="nofollow" class="external text" href="http://www.angelcode.com/dev/callconv/callconv.html"><b>"Calling conventions on the x86 platform"</b></a> |
| </li><li> Thiago Macieira, <a rel="nofollow" class="external text" href="http://labs.qt.nokia.com/2009/08/12/some-thoughts-on-binary-compatibility/"><b>“Some thoughts on binary compatibility”</b></a> |
| </li><li> Pavel Shved, Denis Silakov, <a rel="nofollow" class="external text" href="http://syrcose.ispras.ru/2009/files/02_paper.pdf"><b>"Binary Compatibility of C++ shared libraries on GNU/Linux"</b></a> |
| </li><li> David J. Brown and Karl Runge, <a rel="nofollow" class="external text" href="http://www.usenix.org/publications/library/proceedings/als00/2000papers/papers/full_papers/browndavid/browndavid_html/"><b>"Library Interface Versioning in Solaris and Linux"</b></a> |
| </li><li> HP.com, <a rel="nofollow" class="external text" href="http://docs.hp.com/en/950/v4vers.pdf"><b>"Steps to Version Your Shared Library"</b></a> |
| </li><li> developer.apple.com, <a rel="nofollow" class="external text" href="http://developer.apple.com/tools/mpw-tools/compilers/docs/abi.html"><b>"Macintosh C/C++ ABI Overview"</b></a> |
| </li><li> Chad Austin, <a rel="nofollow" class="external text" href="http://chadaustin.me/cppinterface.html"><b>“Binary-compatible C++ Interfaces”</b></a> |
| </li><li> GNU.org, <a rel="nofollow" class="external text" href="http://gcc.gnu.org/onlinedocs/libstdc++/manual/abi.html"><b>"ABI Policy and Guidelines"</b></a> |
| </li><li> GNU.org, <a rel="nofollow" class="external text" href="http://gcc.gnu.org/onlinedocs/gcc/Compatibility.html"><b>"Binary Compatibility"</b></a> |
| </li><li> Stephen Clamage, <a rel="nofollow" class="external text" href="http://developers.sun.com/solaris/articles/CC_abi/CC_abi_content.html"><b>"Stability of the C++ ABI: Evolution of a Programing Language"</b></a> |
| </li><li> Debian Library Packaging guide, <a rel="nofollow" class="external text" href="http://www.netfort.gr.jp/~dancer/column/libpkg-guide/libpkg-guide.html#binarycompat"><b>"When binary compatibility breaks"</b></a> |
| </li><li> KDE TechBase, <a rel="nofollow" class="external text" href="http://techbase.kde.org/Policies/Library_Code_Policy"><b>“Library Code Policy”</b></a> |
| </li><li> Ulrich Drepper, <a rel="nofollow" class="external text" href="http://people.redhat.com/drepper/dsohowto.pdf"><b>"How To Write Shared Libraries"</b></a> |
| </li><li> Computer Desktop Encyclopedia, <a rel="nofollow" class="external text" href="http://lookup.computerlanguage.com/host_app/search?cid=C000401&term=ABI"><b>"Application Binary Interface"</b></a> |
| </li><li> Linux.org, <a rel="nofollow" class="external text" href="http://www.linux.org/docs/ldp/howto/Program-Library-HOWTO/shared-libraries.html"><b>“Program Library HOWTO”</b></a> |
| </li><li> Mike Hearn, <a rel="nofollow" class="external text" href="http://plan99.net/~mike/writing-shared-libraries.html"><b>“Writing shared libraries”</b></a> |
| </li><li> Sergey Ayukov, <a rel="nofollow" class="external text" href="http://www.ayukov.com/essays/linuxdll.html"><b>"Shared libraries in Linux: growing pains or fundamental problem?"</b></a> |
| </li><li> Peter Potrebic, <a rel="nofollow" class="external text" href="http://2f.ru/holy-wars/fbc.html"><b>“What's the Fragile Base Class (FBC) Problem?”</b></a> |
| </li><li> OoCities.org, <a rel="nofollow" class="external text" href="http://www.oocities.org/mrshrap/linker.html"><b>“The amazing world of library incompatibility”</b></a> |
| </li><li> Forum.Nokia, <a rel="nofollow" class="external text" href="http://library.forum.nokia.com/index.jsp?topic=/S60_5th_Edition_Cpp_Developers_Library/GUID-35228542-8C95-4849-A73F-2B4F082F0C44/sdk/doc_source/faqSDK/faq_0444.html"><b>“The Theory of Binary Compatibility”</b></a> |
| </li><li> Forum.Nokia, <a rel="nofollow" class="external text" href="http://library.developer.nokia.com/index.jsp?topic=/S60_5th_Edition_Cpp_Developers_Library/GUID-35228542-8C95-4849-A73F-2B4F082F0C44/sdk/doc_source/ToolsAndUtilities94/BuildTools/bc.guide.html"><b>“How to control binary compatibility”</b></a> |
| </li><li> elpauer.org, <a rel="nofollow" class="external text" href="http://www.elpauer.org/?p=230"><b>“ABI compatibility in C++”</b></a> |
| </li><li> symbian.org, <a rel="nofollow" class="external text" href="http://developer.symbian.org/wiki/index.php/Preserving_Compatibility"><b>"Preserving Compatibility"</b></a> |
| </li><li> Ponomarenko A., Rubanov V., VALID 2010 <a rel="nofollow" class="external text" href="http://doi.ieeecomputersociety.org/10.1109/VALID.2010.27"><b>"Automated Verification of Shared Libraries for Backward Binary Compatibility"</b></a> |
| </li><li> FreeStandards.org, <a rel="nofollow" class="external text" href="http://refspecs.freestandards.org/elf/gabi41.pdf"><b>Generic ABI (gABI) Standard</b></a>, <a rel="nofollow" class="external text" href="http://refspecs.freestandards.org/elf/"><b>"ELF and ABI Standards"</b></a> |
| </li><li> Processor Supplement ABI (psABI) documents: <b><a rel="nofollow" class="external text" href="http://refspecs.freestandards.org/elf/abi386-4.pdf">Intel386</a></b>, <b><a rel="nofollow" class="external text" href="http://www.x86-64.org/documentation/abi.pdf">AMD64</a></b>, <b><a rel="nofollow" class="external text" href="http://refspecs.freestandards.org/elf/elfspec_ppc.pdf">PowerPC</a></b>, <b><a rel="nofollow" class="external text" href="http://download.boulder.ibm.com/ibmdl/pub/software/dw/linux390/docu/l390abi0.pdf">S/390</a></b>, <b><a rel="nofollow" class="external text" href="http://refspecs.freestandards.org/elf/IA64-SysV-psABI.pdf">Itanium</a></b>, <b><a rel="nofollow" class="external text" href="http://infocenter.arm.com/help/topic/com.arm.doc.ihi0036b/IHI0036B_bsabi.pdf">ARM</a></b>, <b><a rel="nofollow" class="external text" href="http://refspecs.freestandards.org/elf/mipsabi.pdf">MIPS</a></b>, <b><a rel="nofollow" class="external text" href="http://www.sparc.org/standards/psABI3rd.pdf">SPARC</a></b>, <b><a rel="nofollow" class="external text" href="http://refspecs.freestandards.org/elf/elf-pa.pdf">PA-RISK</a></b>, <b><a rel="nofollow" class="external text" href="http://www.linux-m32r.org/cmn/m32r/M32R-elf-abi.pdf">M32R</a></b> |
| </li></ol> |
| |
| <!-- |
| NewPP limit report |
| Preprocessor node count: 133/1000000 |
| Post-expand include size: 0/2097152 bytes |
| Template argument size: 0/2097152 bytes |
| Expensive parser function count: 0/100 |
| --> |
| |
| <!-- Saved in parser cache with key rasispdb:pcache:idhash:2292-0!*!0!!en!2!* and timestamp 20120326150727 --> |
| </div></div></div></div></div></body></html> |
