Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / abi-compliance-checker / 868b1354cc4e1ebcad06358f6f6baf4a71491530 / . / doc / index.html
blob: 8eafd8a749b54e082fe313e4f134257cb27366e0 [file] [log] [blame]
Andrey Ponomarenkod48d9722015-08-13 20:14:50 +0300[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
3<head>
4 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
5 <meta name="keywords" content="C, C++, ABI, API, compatibility, checker" />
6 <meta name="description" content="A tool for checking backward API/ABI compatibility of a C/C++ library" />
7 <title>ABI Compliance Checker</title>
8
9 <style type="text/css">
10 body {
11 margin-top: 1.0em;
12 background-color: #deeef7;
13 font-family: Helvetica, Arial, FreeSans, san-serif;
14 color: #000000;
15 }
16 #container {
17 margin: 0 auto;
18 width: 700px;
19 }
20 h1 { font-size: 3.8em; color: #211108; margin-bottom: 3px;margin-top:0px;padding-top:0px;}
21 h1 .small { font-size: 0.4em; }
22 h1 a { text-decoration: none }
23 h2 { font-size: 1.5em; color: #211108; }
24 h3 { text-align: center; color: #211108; }
25 a { color: #211108; }
26 .description { font-size: 1.2em; margin-bottom: 30px; margin-top: 30px; font-style: italic;}
27 .download { float: right; }
28 pre {padding: 0px;margin: 0px;padding-left: 10px;word-wrap:break-word;white-space: pre-wrap;}
29 hr { border: 0; width: 80%; border-bottom: 1px solid #aaa}
30 .footer { text-align:center; padding-top:30px; font-style: italic; }
Andrey Ponomarenko512878d2016-05-07 18:02:58 +0300[diff] [blame]31 .code {border: dashed 1px gray; background-color: #f0f0f0; padding: 5px; padding-left: 10px; padding-right: 10px;}
Andrey Ponomarenkod48d9722015-08-13 20:14:50 +0300[diff] [blame]32 .listing {padding: 10px;border: 1px solid black;width: 70%;font-family:"DejaVu Sans Mono", "Monaco", "Courier New", monospace;font-size:14px;}
33 .summary {border:1px solid black;border-collapse:collapse;}
34 table.summary td, table.summary th {border:1px solid black;padding:2px;}
35 </style>
36
37</head>
38
39<body>
Andrey Ponomarenko26742a82016-09-27 18:27:08 +0300[diff] [blame]40 <a href="https://github.com/lvc/abi-compliance-checker"><img style="position: absolute; top: 0; right: 0; border: 0;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png" alt="Fork me on GitHub" /></a>
Andrey Ponomarenkod48d9722015-08-13 20:14:50 +0300[diff] [blame]41
42 <div id="container">
43
44 <div class="download">
45 <a href="https://github.com/lvc/abi-compliance-checker/zipball/master">
46 <img style="border: 0;" width="90" src="https://github.com/images/modules/download/zip.png" alt="" /></a>
47 <a href="https://github.com/lvc/abi-compliance-checker/tarball/master">
48 <img style="border: 0;" width="90" src="https://github.com/images/modules/download/tar.png" alt="" /></a>
49 </div>
50
51 <h1>ABI Compliance Checker</h1>
52
53 <div class="description">
54 A tool for checking backward API/ABI compatibility of a C/C++ library
55 </div>
56
57 <p/>
58 ABI Compliance Checker (ABICC) 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.
59
60 <p/>
61 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 Linux maintainers who are interested in ensuring backward compatibility, i.e. allow old applications to run or to be recompiled with newer library versions.
Andrey Ponomarenko8bfdcd82015-09-08 17:58:01 +0300[diff] [blame]62
63 <p/>
Andrey Ponomarenko26742a82016-09-27 18:27:08 +0300[diff] [blame]64 The tool is developed by Andrey Ponomarenko. You can order additional reports for visualization of the ABI structure and high detailed binary compatibility analysis here: <a href='https://abi-laboratory.pro/'>https://abi-laboratory.pro/</a>
Andrey Ponomarenkod48d9722015-08-13 20:14:50 +0300[diff] [blame]65
66<table class='summary'><tr><td>
67<div>Table of Contents</div>
68<ul>
69<li><a href="#Downloads">Downloads</a></li>
70<li><a href="#License">License</a></li>
71<li><a href="#Supported_Platforms">Supported Platforms</a></li>
72<li><a href="#Dependencies">Dependencies</a></li>
73<li><a href="#Installation">Installation</a></li>
Andrey Ponomarenkoe3419b42016-01-28 15:06:08 +0300[diff] [blame]74<li><a href="#ABI_Dumper">Usage with ABI Dumper</a></li>
Andrey Ponomarenkoa364f8a2016-04-18 21:40:51 +0300[diff] [blame]75<li><a href="#Usage">Usage (Original)</a></li>
Andrey Ponomarenkoe3419b42016-01-28 15:06:08 +0300[diff] [blame]76<li><a href="#Tutorial">Tutorial</a></li>
Andrey Ponomarenkod48d9722015-08-13 20:14:50 +0300[diff] [blame]77<li><a href="#Examples">Examples</a></li>
78<li><a href="#BinaryProblems">Detectable Binary-Compatibility Problems</a></li>
79<li><a href="#SourceProblems">Detectable Source-Compatibility Problems</a></li>
80<li><a href="#Dump">Create ABI Dumps</a></li>
Andrey Ponomarenkod48d9722015-08-13 20:14:50 +0300[diff] [blame]81<li><a href="#Report">Report Format</a></li>
82<li><a href="#Verdict">Verdict on Compatibility</a></li>
83<li><a href="#Error">Error Codes</a></li>
84<li><a href="#FAQ">FAQ</a></li>
85<li><a href="#Similar">Similar Tools</a></li>
Andrey Ponomarenkod48d9722015-08-13 20:14:50 +0300[diff] [blame]86<li><a href="#Bugs">Bugs</a></li>
87<li><a href="#Maintainers">Maintainers</a></li>
88<li><a href="#ChangeLog">Changes</a></li>
89<li><a href="#Articles">Articles</a></li>
90</ul>
91</td></tr></table>
92
93<a name="Downloads"></a>
94<h2>Downloads</h2>
Andrey Ponomarenkodd99c622016-04-26 19:10:46 +0300[diff] [blame]95<p>The latest release can be downloaded from <a href="https://github.com/lvc/abi-compliance-checker/releases">this page</a>.</p>
Andrey Ponomarenkod48d9722015-08-13 20:14:50 +0300[diff] [blame]96
97<p>Read-only access to the latest development version:</p>
98
Andrey Ponomarenko512878d2016-05-07 18:02:58 +0300[diff] [blame]99<code class='code'>git clone https://github.com/lvc/abi-compliance-checker.git</code>
Andrey Ponomarenkod48d9722015-08-13 20:14:50 +0300[diff] [blame]100
101<a name="License"></a>
102<h2>License</h2>
103<p>This program is free software. You may use, redistribute and/or modify it under the terms of the <a href="http://www.gnu.org/licenses/">GNU GPL</a> or <a href="http://www.gnu.org/licenses/">GNU LGPL</a></p>
104
105<a name="Supported_Platforms"></a>
106<h2>Supported Platforms</h2>
107GNU/Linux, FreeBSD, Mac OS X, MS Windows.
108
109<a name="Dependencies"></a>
110<h2>Dependencies</h2>
111<ul>
112<li>
Andrey Ponomarenkodd99c622016-04-26 19:10:46 +0300[diff] [blame]113 <a href="http://gcc.gnu.org/">G++</a> (3.0-4.7, 4.8.3 or newer)
Andrey Ponomarenkod48d9722015-08-13 20:14:50 +0300[diff] [blame]114</li>
115<li>
116 <a href="http://www.gnu.org/software/binutils/">GNU Binutils</a> (readelf, c++filt, objdump)
117</li>
118<li>
Andrey Ponomarenkodd99c622016-04-26 19:10:46 +0300[diff] [blame]119 <a href="http://www.perl.org/">Perl 5</a>
Andrey Ponomarenkod48d9722015-08-13 20:14:50 +0300[diff] [blame]120</li>
121<li>
Andrey Ponomarenkodd99c622016-04-26 19:10:46 +0300[diff] [blame]122 <a href="http://ctags.sourceforge.net/">Ctags</a>
Andrey Ponomarenkod48d9722015-08-13 20:14:50 +0300[diff] [blame]123</li>
124</ul>
125
126WARNING: 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.
127<p/>
128On Mac OS X the tool also requires Xcode (g++, c++filt, nm and otool).
129<p/>
130On MS Windows the tool also requires MinGW, MS Visual C++ (dumpbin, undname, cl), Active Perl 5, adding of tool locations to the PATH and execution of vsvars32.bat script (C:\Microsoft Visual Studio 9.0\Common7\Tools\).
131
132<a name="Installation"></a>
133<h2>Installation</h2>
134<p>The tool is <b>ready-to-use</b> after extracting the archive.</p>
135
136<p>You can also use a Makefile to install the tool into the system:</p>
Andrey Ponomarenko512878d2016-05-07 18:02:58 +0300[diff] [blame]137<code class='code'>sudo make install prefix=PREFIX [/usr, /usr/local]</code>
Andrey Ponomarenkod48d9722015-08-13 20:14:50 +0300[diff] [blame]138<p>This command will install the <code>abi-compliance-checker</code> program into the <code>PREFIX/bin</code> system directory and private modules into the <code>PREFIX/share</code>.</p>
139
Andrey Ponomarenkodd99c622016-04-26 19:10:46 +0300[diff] [blame]140<p>To verify that the tool is installed correctly and it works on your host run:</p>
Andrey Ponomarenko512878d2016-05-07 18:02:58 +0300[diff] [blame]141<code class='code'>cd tmp/</code>
Andrey Ponomarenkodd99c622016-04-26 19:10:46 +0300[diff] [blame]142<p>
Andrey Ponomarenko512878d2016-05-07 18:02:58 +0300[diff] [blame]143<code class='code'>abi-compliance-checker -test</code>
Andrey Ponomarenkodd99c622016-04-26 19:10:46 +0300[diff] [blame]144</p>
145
Andrey Ponomarenkoa364f8a2016-04-18 21:40:51 +0300[diff] [blame]146<a name="ABI_Dumper"></a>
147<h2>Usage with ABI Dumper</h2>
148This new way is based on the analysis of the debug-info from binary objects. It's more reliable, faster and simple way.
149<p/>
150The analyzed library should be compiled with "-g -Og" GCC options to contain DWARF debug info.
151<p/>
152Create ABI dumps for both library versions first using the <a href='https://github.com/lvc/abi-dumper'>ABI Dumper</a> tool:
153<p/>
154<code class='code'>abi-dumper OLD.so -o ABI-0.dump -lver 0</code>
155<p/>
156<code class='code'>abi-dumper NEW.so -o ABI-1.dump -lver 1</code>
157<p/>
158And then compare ABI dumps to create report:
159<p/>
160<code class='code'>abi-compliance-checker -l NAME -old ABI-0.dump -new ABI-1.dump</code>
161<p/>
162The compatibility report will be generated to:
163<p/>
164<code class='code'>compat_reports/NAME/V0_to_V1/compat_report.html</code>
165<p/>
166You can filter out private symbols from the ABI dumps by specifying of additional <code>-public-headers</code> option of the ABI Dumper tool.
167
Andrey Ponomarenkod48d9722015-08-13 20:14:50 +0300[diff] [blame]168<a name="Usage"></a>
Andrey Ponomarenkoe3419b42016-01-28 15:06:08 +0300[diff] [blame]169<h2>Usage (Original)</h2>
170The original usage is based on the analysis of header files and shared objects (without debug-info).
171<p/>
172You should provide <a href='Xml-Descriptor.html'>XML descriptors</a> for two library versions (<code>v1.xml</code> and <code>v2.xml</code> files) in order to run the analysis. 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 (<code>0.3.4.xml</code>):
Andrey Ponomarenkod48d9722015-08-13 20:14:50 +0300[diff] [blame]173<p/>
174<div class='listing'>
175<pre>
176<span style='color:Green'>&lt;version&gt;</span>
177 0.3.4
178<span style='color:Green'>&lt;/version&gt;</span>
179
180<span style='color:Green'>&lt;headers&gt;</span>
181 /usr/local/libssh/0.3.4/include/
182<span style='color:Green'>&lt;/headers&gt;</span>
183
184<span style='color:Green'>&lt;libs&gt;</span>
185 /usr/local/libssh/0.3.4/lib/
186<span style='color:Green'>&lt;/libs&gt;</span>
187</pre>
188</div>
189<p/>
190
191Command to compare two versions of a library:
192<p/>
193<code class='code'>abi-compliance-checker -lib NAME -old V1.xml -new V2.xml</code>
194<p/>
195The compatibility report will be generated to:
196<p/>
197<code class='code'>compat_reports/NAME/V1_to_V2/compat_report.html</code>
198<p/>
199
Andrey Ponomarenkoe3419b42016-01-28 15:06:08 +0300[diff] [blame]200<a name="Tutorial"></a>
201<h2>Tutorial</h2>
202An excellent tutorial <a href='http://blog.famillecollet.com/post/2010/06/20/ABI-%3A-stability-check'>"ABI: stability check"</a> is available at Les RPM de Remi Blog. See also <a href='http://sourceware.org/glibc/wiki/Testing/ABI_checker'>ABI compliance checker Notes</a> at glibc wiki.
203<p/>
204
Andrey Ponomarenkod48d9722015-08-13 20:14:50 +0300[diff] [blame]205<a name="Examples"></a>
206<h2>Examples</h2>
207<table class='summary'>
208<tr><th>Library</th><th>Versions</th><th>Report</th></tr>
209<tr>
Andrey Ponomarenkodd99c622016-04-26 19:10:46 +0300[diff] [blame]210<td>libhttpd</td>
211<td>2.2.31 vs 2.4.1</td>
212<td><a href='http://abi-laboratory.pro/tracker/compat_report/httpd/2.2.31/2.4.1/58f6a/abi_compat_report.html'>report</a></td>
Andrey Ponomarenkod48d9722015-08-13 20:14:50 +0300[diff] [blame]213</tr>
214<tr>
Andrey Ponomarenkodd99c622016-04-26 19:10:46 +0300[diff] [blame]215<td>libMagick++</td>
216<td>6.9.0-0 vs 6.9.0-10</td>
217<td><a href='http://abi-laboratory.pro/tracker/compat_report/imagemagick/6.9.0-0/6.9.0-10/c3418/abi_compat_report.html'>report</a></td>
Andrey Ponomarenkod48d9722015-08-13 20:14:50 +0300[diff] [blame]218</tr>
219<tr>
220<td>libssh</td>
Andrey Ponomarenkodd99c622016-04-26 19:10:46 +0300[diff] [blame]221<td>0.3.4 vs 0.3.91</td>
222<td><a href='http://abi-laboratory.pro/tracker/compat_report/libssh/0.3.4/0.3.91/1f31d/abi_compat_report.html'>report</a></td>
Andrey Ponomarenkod48d9722015-08-13 20:14:50 +0300[diff] [blame]223</tr>
224</table>
Andrey Ponomarenkoe3419b42016-01-28 15:06:08 +0300[diff] [blame]225<p/>
226See more report examples at <a href='http://abi-laboratory.pro/tracker/'>http://abi-laboratory.pro/tracker/</a>.
Andrey Ponomarenkod48d9722015-08-13 20:14:50 +0300[diff] [blame]227
228<a name="BinaryProblems"></a>
229<h2>Detectable Binary Compatibility Problems</h2>
230<ul>
231<li>
232
233<b>Problems with Data Types</b>
234<ul>
235 <li>
236 Structures and Classes
237 <ul>
238 <li>
239 added/removed fields (change of a memory layout)
240 </li>
241 <li>
242 change of size
243 </li>
244 <li>
245 changed order of fields
246 </li>
247 <li>
248 change of a field type
249 </li>
250 <li>
251 changes in fields (recursive analysis)
252 </li>
253 </ul>
254 </li>
255 <li>
256 Classes
257 <ul>
258 <li>
259 added/removed virtual functions (change of a v-table layout)
260 </li>
261 <li>
262 change of virtual function position
263 </li>
264 <li>
265 overridden virtual functions
266 </li>
267 <li>
268 added/removed base classes
269 </li>
270 <li>
271 changes in base classes (recursive analysis)
272 </li>
273 </ul>
274 </li>
275 <li>
276 Unions
277 <ul>
278 <li>
279 added/removed fields
280 </li>
281 <li>
282 change of size
283 </li>
284 <li>
285 change of a field type
286 </li>
287 <li>
288 changes in fields (recursive analysis)
289 </li>
290 </ul>
291 </li>
292 <li>
293 Enumerations
294 <ul>
295 <li>
296 change of a member value
297 </li>
298 <li>
299 removed/renamed members
300
301 <br/>
302 <br/>
303 </li>
304 </ul>
305 </li>
306</ul>
307
308</li>
309<li>
310
311<b>Problems with Symbols</b>
312<ul>
313 <li>
314 removed symbols (functions or global data)
315 </li>
316 <li>
317 added/removed parameters
318 </li>
319 <li>
320 change of a parameter/return value type
321 </li>
322 <li>
323 change of default parameter value
324 </li>
325 <li>
326 renamed parameters
327 </li>
328 <li>
329 incorrect version change
330 </li>
331 <li>
332 changed attributes (const, volatile, static, etc.)
333
334 <br/>
335 <br/>
336 </li>
337</ul>
338
339</li>
340<li>
341<b>Problems with Constants (#defines)</b>
342<ul>
343<li>
344 changed value
345</li>
346</ul>
347
348</li>
349</ul>
350<p/>
351
Andrey Ponomarenko26742a82016-09-27 18:27:08 +0300[diff] [blame]352See <a href='https://community.kde.org/Policies/Binary_Compatibility_Issues_With_C++'>"Binary Compatibility Issues With C++"</a> article from KDE TechBase for more info.
Andrey Ponomarenkod48d9722015-08-13 20:14:50 +0300[diff] [blame]353
354<a name="SourceProblems"></a>
355<h2>Detectable Source Compatibility Problems</h2>
356<ul>
357<li>
358
359<b>Problems with Data Types</b>
360<ul>
361 <li>
362 Structures, Classes and Unions
363 <ul>
364 <li>
365 removed/renamed fields
366 </li>
367 <li>
368 change of a field type
369 </li>
370 <li>
371 changes in fields (recursive analysis)
372 </li>
373 </ul>
374 </li>
375 <li>
376 Classes
377 <ul>
378 <li>
379 added/removed base classes
380 </li>
381 <li>
382 change access level of a field or method
383 </li>
384 <li>
385 added pure virtual methods
386 </li>
387 </ul>
388 </li>
389 <li>
390 Enumerations
391 <ul>
392 <li>
393 removed/renamed members
394
395 <br/>
396 <br/>
397 </li>
398 </ul>
399 </li>
400</ul>
401</li>
402
403<li>
404
405<b>Problems with Symbols</b>
406<ul>
407 <li>
408 removed symbols (functions or global data)
409 </li>
410 <li>
411 added/removed parameters
412 </li>
413 <li>
414 change of a parameter type
415 </li>
416 <li>
417 removed default value of parameter
418 </li>
419 <li>
420 change of return value type
421 </li>
422 <li>
423 changed attributes (const, static, etc.)
424 </li>
425</ul>
426
427</li>
428
429</ul>
430
431<a name="Dump"></a>
432<h2>Create ABI Dumps</h2>
433The library ABI is a representation of the library API at the binary level. The ABI dump is a dump of the model of the ABI used in the tool.
434<p/>
435The ABI dump consists of:
436
437<ul>
438
439<li>
440 <b>Types Information</b>
441 <ul>
442 <li>
443 Attributes (name, size, header, access, base types, etc.)
444 </li>
445 <li>
446 Fields (name, type, size, position, alignment, access, specifiers, etc.)
447 </li>
448 <li>
449 V-table structure (offsets, entries)
450 </li>
451 <li>
452 Etc.
453 </li>
454 </ul>
455</li>
456
457<li>
458 <b>Symbols Information</b>
459 <ul>
460 <li>
461 Attributes (name, mangled name, header, access, specifiers, etc.)
462 </li>
463 <li>
464 Parameters (name, type, position, alignment, etc.)
465 </li>
466 <li>
467 Etc.
468 </li>
469 </ul>
470</li>
471
472<li>
473 Etc.
474</li>
475
476</ul>
477
478The ABI dump can be used to create a snapshot of a library ABI in the particular environment and then compare it with any other state of the ABI changed due to changes in the environment (compiler version, external libraries, etc.) or changes in the library API (header files).
479
480<p/>
481The typical case is the comparing of two versions of the same library that require incompatible states of the environment (i.e. these versions cannot be installed simultaneously). In this case one can create a dump for one version of the library and then switch the environment and create ABI dump for other version of the library. Two ABI dumps can be compared by the tool to create the API compatibility report.
482<p/>
483To create an ABI dump use <code>-dump</code> option:
484<p/>
485<code class='code'>abi-compliance-checker -lib NAME -dump VER.xml</code>
486<p/>
487The ABI dump will be generated to:
488<p/>
489<code class='code'>abi_dumps/NAME/NAME_VER.abi.tar.gz</code>
490<p/>
491To compare ABI dumps pass them as the descriptors:
492<p/>
493<code class='code'>abi-compliance-checker -lib NAME -old V1.abi.tar.gz -new V2.abi.tar.gz</code>
494
Andrey Ponomarenkod48d9722015-08-13 20:14:50 +0300[diff] [blame]495<a name="Report"></a>
496<h2>Report Format</h2>
497The tool supports two formats of a compatibility report: HTML (default) and XML. To generate XML report you should specify <code>-xml</code> additional option.
498<p/>
499The report consists of:
500
501<ul>
502 <li>
503 <b>Test Info</b> - The library name and compared version numbers. Environment info: GCC version and CPU type.
504 </li>
505 <li>
506 <b>Test Results</b> - Verdict on compatibility. Number of header files, shared libraries, symbols and data types checked by the tool.
507 </li>
508 <li>
509 <b>Problem Summary</b> - Classification of compatibility problems.
510 </li>
511 <li>
512 <b>Added Symbols</b> - The list of added symbols.
513 </li>
514 <li>
515 <b>Removed Symbols</b> - The list of removed symbols.
516 </li>
517 <li>
518 <b>Problems with Data Types</b> - The list of compatibility problems caused by changes in data types (divided by the severity level: High, Medium and Low). List of affected symbols.
519 </li>
520 <li>
521 <b>Problems with Symbols</b> - The list of compatibility problems caused by changes in symbol parameters or attributes (divided by the severity level).
522 </li>
523 <li>
524 <b>Problems with Constants</b> - The list of changed constants (#defines).
525 </li>
526 <li>
527 <b>Other Changes in Data Types</b> - The list of compatible changes in data types.
528 </li>
529 <li>
530 <b>Other Changes in Symbols</b> - The list of compatible changes in symbols.
531 </li>
532</ul>
533
534<a name="Verdict"></a>
535<h2>Verdict on Compatibility</h2>
536If the tool detects 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 <code>-strict</code> option is specified.
537
538<a name="Error"></a>
539<h2>Error Codes</h2>
540<table class='summary'>
541<tr><th>Code</th><th>Meaning</th></tr>
542<tr><td>0</td><td>Compatible. The tool has run without any errors.</td></tr>
543<tr><td>1</td><td>Incompatible. The tool has run without any errors.</td></tr>
544<tr><td>2</td><td>Common error code (undifferentiated).</td></tr>
545<tr><td>3</td><td>A system command is not found.</td></tr>
546<tr><td>4</td><td>Cannot access input files.</td></tr>
547<tr><td>5</td><td>Cannot compile header files.</td></tr>
548<tr><td>6</td><td>Headers have been compiled with minor errors.</td></tr>
549<tr><td>7</td><td>Invalid input ABI dump.</td></tr>
550<tr><td>8</td><td>Unsupported version of input ABI dump.</td></tr>
551<tr><td>9</td><td>Cannot find a module.</td></tr>
552<tr><td>10</td><td>Empty intersection between headers and shared objects.</td></tr>
553<tr><td>11</td><td>Empty set of symbols in headers.</td></tr>
554</table>
555
556<a name="FAQ"></a>
557<h2>FAQ</h2>
558<ul>
559 <li>
560 <b>What is an ABI and how does it differ from an API?</b>
561 <p/>
562 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: ABI = API + compiler ABI.
563 </li>
564 <li>
565 <b>Why does this tool need both shared libraries and header files to check ABI compliance?</b>
566 <p/>
567 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.
568 </li>
569</ul>
570
571<a name="Similar"></a>
572<h2>Similar Tools </h2>
573<ul>
574 <li>
575 <b>icheck</b> - C interface ABI/API checker.
576 </li>
577 <li>
578 <b>BCS</b> - The Symbian binary compatibility suite.
579 </li>
580 <li>
581 <b>shlib-compat</b> - ABI compatibility checker that uses DWARF debug info.
582 </li>
583 <li>
584 <b>qbic</b> - A tool to check for binary incompatibilities in Qt4 Toolkit.
585 </li>
586 <li>
587 <b>libabigail</b> - A C++ library for ABI analysis.
588 </li>
589 <li>
590 <b>chkshlib, cmpdylib, cmpshlib</b> - Tools to compare binary symbols.
591 </li>
592</ul>
593
Andrey Ponomarenkod48d9722015-08-13 20:14:50 +0300[diff] [blame]594<a name="Bugs"></a>
595<h2>Bugs</h2>
596Please post bug reports, feature requests and questions to the <a href="https://github.com/lvc/abi-compliance-checker/issues">issue tracker</a>.
597<p/>
598
599<a name="Maintainers"></a>
600<h2>Maintainers</h2>
Andrey Ponomarenko26742a82016-09-27 18:27:08 +0300[diff] [blame]601The tool is developed by <a href="https://www.linkedin.com/in/andreyponomarenko">Andrey Ponomarenko</a>.
Andrey Ponomarenkod48d9722015-08-13 20:14:50 +0300[diff] [blame]602
603<a name="ChangeLog"></a>
604<h2>Changes</h2>
605You can find changelog <a href='Changelog.html'>here</a>.
606
607<a name="Articles"></a>
608<h2>Articles</h2>
609
610<ul>
611 <li>
Andrey Ponomarenko26742a82016-09-27 18:27:08 +0300[diff] [blame]612 <a href='https://community.kde.org/Policies/Binary_Compatibility_Issues_With_C++'>"Binary Compatibility Issues With C++"</a>, KDE TechBase
Andrey Ponomarenkod48d9722015-08-13 20:14:50 +0300[diff] [blame]613 </li>
614 <li>
Andrey Ponomarenko26742a82016-09-27 18:27:08 +0300[diff] [blame]615 <a href='https://community.kde.org/Policies/Binary_Compatibility_Examples'>"Binary Compatibility Examples"</a>, KDE TechBase
Andrey Ponomarenkod48d9722015-08-13 20:14:50 +0300[diff] [blame]616 </li>
617 <li>
Andrey Ponomarenko26742a82016-09-27 18:27:08 +0300[diff] [blame]618 <a href='https://www.computer.org/csdl/proceedings/valid/2010/4146/00/4146a057-abs.html'>"Automated Verification of Shared Libraries for Backward Binary Compatibility"</a>, A. Ponomarenko and V. Rubanov, VALID 2010
Andrey Ponomarenkod48d9722015-08-13 20:14:50 +0300[diff] [blame]619 </li>
620 <li>
621 <a href='http://www.springerlink.com/content/905067689q7n0166/'>"Backward compatibility of software interfaces: Steps towards automatic verification"</a>, A. Ponomarenko and V. Rubanov, Programming and Computer Software 2012
622 </li>
623 <li>
624 <a href='http://refspecs.linux-foundation.org/cxxabi-1.83.html'>"Itanium C++ ABI"</a>, linux-foundation.org
625 </li>
626 <li>
627 <a href='http://www.ros.org/reps/rep-0009.html'>"ABI Compatibility"</a>, Josh Faust
628 </li>
629 <li>
630 <a href='http://blog.famillecollet.com/post/2010/06/20/ABI-%3A-stability-check'>"ABI : stability check"</a>, Les RPM de Remi - Blog
631 </li>
632 <li>
633 <a href='http://www.agner.org/optimize/calling_conventions.pdf'>"Calling conventions for different C++ compilers and operating systems"</a>, Agner Fog
634 </li>
635 <li>
636 <a href='http://www.angelcode.com/dev/callconv/callconv.html'>"Calling conventions on the x86 platform"</a>, Andreas Jonsson
637 </li>
638 <li>
639 <a href='http://blog.qt.digia.com/blog/2009/08/12/some-thoughts-on-binary-compatibility/'>"Some thoughts on binary compatibility"</a>, Thiago Macieira
640 </li>
641 <li>
642 <a href='http://syrcose.ispras.ru/2009/files/02_paper.pdf'>"Binary Compatibility of C++ shared libraries on GNU/Linux"</a>, Pavel Shved, Denis Silakov
643 </li>
644 <li>
645 <a href='http://www.usenix.org/publications/library/proceedings/als00/2000papers/papers/full_papers/browndavid/browndavid_html/'>"Library Interface Versioning in Solaris and Linux"</a>, David J. Brown and Karl Runge
646 </li>
647 <li>
648 <a href='http://h21007.www2.hp.com/portal/download/files/prot/files/STK/pdfs/V_4version.pdf'>"Steps to Version Your Shared Library"</a>, hp.com
649 </li>
650 <li>
651 <a href='http://chadaustin.me/cppinterface.html'>"Binary-compatible C++ Interfaces"</a>, Chad Austin
652 </li>
653 <li>
654 <a href='http://gcc.gnu.org/onlinedocs/libstdc++/manual/abi.html'>"ABI Policy and Guidelines"</a>, gnu.org
655 </li>
656 <li>
657 <a href='http://gcc.gnu.org/onlinedocs/gcc/Compatibility.html'>"Binary Compatibility"</a>, gnu.org
658 </li>
659 <li>
660 <a href='http://www.oracle.com/technetwork/articles/servers-storage-dev/stablecplusplusabi-333927.html'>"Stability of the C++ ABI: Evolution of a Programing Language"</a>, Stephen Clamage
661 </li>
662 <li>
663 <a href='http://www.netfort.gr.jp/~dancer/column/libpkg-guide/libpkg-guide.html#binarycompat'>"When binary compatibility breaks"</a>, Debian Library Packaging guide
664 </li>
665 <li>
666 <a href='http://techbase.kde.org/Policies/Library_Code_Policy'>"Library Code Policy"</a>, KDE TechBase
667 </li>
668 <li>
669 <a href='http://people.redhat.com/drepper/dsohowto.pdf'>"How To Write Shared Libraries"</a>, Ulrich Drepper
670 </li>
671 <li>
672 <a href='http://tldp.org/HOWTO/Program-Library-HOWTO/'>"Program Library HOWTO"</a>, linux.org
673 </li>
674 <li>
675 <a href='http://plan99.net/~mike/writing-shared-libraries.html'>"Writing shared libraries"</a>, Mike Hearn
676 </li>
677 <li>
678 <a href='http://www.ayukov.com/essays/linuxdll.html'>"Shared libraries in Linux: growing pains or fundamental problem?"</a>, Sergey Ayukov
679 </li>
680 <li>
681 <a href='http://c2.com/cgi/wiki?FragileBinaryInterfaceProblem'>"Fragile Binary Interface Problem"</a>, Steven Newton
682 </li>
683 <li>
684 <a href='http://www.oocities.org/mrshrap/linker.html'>"The amazing world of library incompatibility"</a>, oocities.org
685 </li>
686 <li>
687 <a href='http://www.elpauer.org/?p=230'>"ABI compatibility in C++"</a>, elpauer.org
688 </li>
689 <li>
690 <a href='http://blogs.gentoo.org/mgorny/2012/08/20/the-impact-of-cxx-templates-on-library-abi/'>"The impact of C++ templates on library ABI"</a>, Michał Górny
691 </li>
692 <li>
693 <a href='http://sourceware.org/glibc/wiki/Testing/ABI_checker'>"ABI compliance checker Notes"</a>, sourceware.org
694 </li>
695 <li>
696 <a href='http://developer.symbian.org/wiki/index.php/Preserving_Compatibility'>"Preserving Compatibility"</a>, symbian.org
697 </li>
698 <li>
699 <a href='http://www.macieira.org/blog/2012/01/architectures-and-abis-detailed/'>"Architectures and ABIs detailed"</a>, Thiago Macieira's blog
700 </li>
701 <li>
702 <a href='http://accu.org/index.php/journals/1718'>"Interface Versioning in C++"</a>, ACCU
703 </li>
704 <li>
705 Processor ABI standards: <a href='http://refspecs.linuxbase.org/elf/abi386-4.pdf'>Intel386</a>, <a href='http://www.x86-64.org/documentation/abi.pdf'>AMD64</a>, <a href='http://infocenter.arm.com/help/topic/com.arm.doc.ihi0042d/IHI0042D_aapcs.pdf'>ARM</a>, <a href='http://refspecs.linuxbase.org/elf/elfspec_ppc.pdf'>PowerPC</a>, <a href='http://download.boulder.ibm.com/ibmdl/pub/software/dw/linux390/docu/l390abi0.pdf'> S/390</a>, <a href='http://refspecs.linuxbase.org/elf/IA64-SysV-psABI.pdf'>Itanium</a>, <a href='http://refspecs.linuxbase.org/elf/mipsabi.pdf'>MIPS</a>, <a href='sparc.org/wp-content/uploads/2014/01/psABI3rd.pdf.gz'>SPARC</a>, <a href='http://refspecs.linuxbase.org/elf/elf-pa.pdf'>PA-RISK</a>, <a href='http://www.linux-m32r.org/cmn/m32r/M32R-elf-abi.pdf'>M32R</a>
706 </li>
707 <li>
708 <a href='https://refspecs.linuxbase.org/elf/gabi41.pdf'>"Generic ABI Standard"</a>, <a href='http://refspecs.linuxbase.org/elf/'>"ELF and ABI Standards"</a>, freestandards.org
709 </li>
710 <li>
711 <a href='http://events.linuxfoundation.org/sites/events/files/slides/Binary_Compatibility_for_library_devs.pdf'>"Binary compatibility for library developers"</a>, <a href='https://www.youtube.com/watch?v=PHrXGHDd9no'>Video</a>, Thiago Macieira
712 </li>
713 <li>
714 <a href='http://debconf14-video.debian.net/video/286/acc-for-abi-breaks'>"ACC for abi breaks"</a>, Dimitri Ledkov
715 </li>
716</ul>
717
718<div class="footer">
719 get the source code on GitHub : <a href="https://github.com/lvc/abi-compliance-checker">lvc/abi-compliance-checker</a>
720</div>
721
722<br/>
723<br/>
724
725</div>
726</body>
727</html>