-
Notifications
You must be signed in to change notification settings - Fork 76
/
abi-compliance-checker.pl
executable file
·10689 lines (9640 loc) · 370 KB
/
abi-compliance-checker.pl
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#!/usr/bin/perl
########################################################################
# ABI Compliance Checker (ABICC) 2.3
# A tool for checking backward compatibility of a C/C++ library API
#
# Copyright (C) 2009-2011 Institute for System Programming, RAS
# Copyright (C) 2011-2012 Nokia Corporation and/or its subsidiary(-ies)
# Copyright (C) 2012-2019 Andrey Ponomarenko's ABI Laboratory
#
# Written by Andrey Ponomarenko
#
# PLATFORMS
# =========
# Linux, FreeBSD, Solaris, Mac OS X, MS Windows, Symbian, Haiku
#
# REQUIREMENTS
# ============
# Linux
# - G++ (3.0 or newer)
# - GNU Binutils (readelf, c++filt, objdump)
# - Perl 5
# - Ctags
# - ABI Dumper >= 1.1
#
# Mac OS X
# - Xcode (g++, c++filt, otool, nm)
# - Ctags
#
# MS Windows
# - MinGW (3.0 or newer)
# - MS Visual C++ (dumpbin, undname, cl)
# - Active Perl 5 (5.8 or newer)
# - Sigcheck v2.52 or newer
# - GnuWin Zip and UnZip
# - Ctags (Exuberant or Universal)
# - Add tool locations to the PATH environment variable
# - Run vcvars64.bat (C:\Microsoft Visual Studio 9.0\VC\bin\)
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2.1 of the License, or (at your option) any later version.
#
# This library is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with this library; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
# MA 02110-1301 USA
########################################################################
use Getopt::Long;
Getopt::Long::Configure ("posix_default", "no_ignore_case");
use File::Path qw(mkpath rmtree);
use File::Temp qw(tempdir);
use File::Copy qw(copy);
use File::Basename qw(dirname);
use Cwd qw(abs_path cwd);
use Data::Dumper;
my $TOOL_VERSION = "2.3";
my $ABI_DUMP_VERSION = "3.5";
my $ABI_DUMP_VERSION_MIN = "3.5";
my $XML_REPORT_VERSION = "1.2";
my $XML_ABI_DUMP_VERSION = "1.2";
# Internal modules
my $MODULES_DIR = getModules();
push(@INC, dirname($MODULES_DIR));
# Basic modules
my %LoadedModules = ();
loadModule("Basic");
loadModule("Input");
loadModule("Path");
loadModule("Logging");
loadModule("Utils");
loadModule("TypeAttr");
loadModule("Filter");
loadModule("SysFiles");
loadModule("Descriptor");
loadModule("Mangling");
# Rules DB
my %RULES_PATH = (
"Binary" => $MODULES_DIR."/RulesBin.xml",
"Source" => $MODULES_DIR."/RulesSrc.xml");
my $BYTE = 8;
my $CmdName = getFilename($0);
my %HomePage = (
"Dev"=>"https://github.com/lvc/abi-compliance-checker",
"Doc"=>"https://lvc.github.io/abi-compliance-checker/"
);
my $ShortUsage = "ABI Compliance Checker (ABICC) $TOOL_VERSION
A tool for checking backward compatibility of a C/C++ library API
Copyright (C) 2019 Andrey Ponomarenko's ABI Laboratory
License: GNU LGPL 2.1
Usage: $CmdName [options]
Example: $CmdName -l NAME -old ABI-0.dump -new ABI-1.dump
ABI-0.dump and ABI-1.dump are ABI dumps generated
by the ABI Dumper or ABICC tools.
More info: $CmdName --help\n";
if($#ARGV==-1)
{
printMsg("INFO", $ShortUsage);
exit(0);
}
GetOptions(
"h|help!" => \$In::Opt{"Help"},
"i|info!" => \$In::Opt{"InfoMsg"},
"v|version!" => \$In::Opt{"ShowVersion"},
"dumpversion!" => \$In::Opt{"DumpVersion"},
# General
"l|lib|library=s" => \$In::Opt{"TargetLib"},
"d1|old|o=s" => \$In::Desc{1}{"Path"},
"d2|new|n=s" => \$In::Desc{2}{"Path"},
"dump|dump-abi|dump_abi=s" => \$In::Opt{"DumpABI"},
"d|f|filter=s" => \$In::Opt{"FilterPath"},
# Extra
"debug!" => \$In::Opt{"Debug"},
"debug-mangling!" => \$In::Opt{"DebugMangling"},
"ext|extended!" => \$In::Opt{"ExtendedCheck"},
"static|static-libs!" => \$In::Opt{"UseStaticLibs"},
"gcc-path|cross-gcc=s" => \$In::Opt{"CrossGcc"},
"gcc-prefix|cross-prefix=s" => \$In::Opt{"CrossPrefix"},
"gcc-options=s" => \$In::Opt{"GccOptions"},
"count-symbols=s" => \$In::Opt{"CountPubSymbols"},
"count-all-symbols=s" => \$In::Opt{"CountAllSymbols"},
"use-dumps!" => \$In::Opt{"UseDumps"},
"xml!" => \$In::Opt{"UseXML"},
"app|application=s" => \$In::Opt{"AppPath"},
"headers-only!" => \$In::Opt{"CheckHeadersOnly"},
"v1|vnum1|version1=s" => \$In::Desc{1}{"TargetVersion"},
"v2|vnum2|version2=s" => \$In::Desc{2}{"TargetVersion"},
"relpath1=s" => \$In::Desc{1}{"RelativeDirectory"},
"relpath2=s" => \$In::Desc{2}{"RelativeDirectory"},
# Test
"test!" => \$In::Opt{"TestTool"},
"test-dump!" => \$In::Opt{"TestDump"},
"test-abi-dumper!" => \$In::Opt{"TestABIDumper"},
# Report
"s|strict!" => \$In::Opt{"StrictCompat"},
"binary|bin|abi!" => \$In::Opt{"BinOnly"},
"source|src|api!" => \$In::Opt{"SrcOnly"},
"warn-newsym!" => \$In::Opt{"WarnNewSym"},
# Report path
"report-path=s" => \$In::Opt{"OutputReportPath"},
"bin-report-path=s" => \$In::Opt{"BinReportPath"},
"src-report-path=s" => \$In::Opt{"SrcReportPath"},
# Report format
"show-retval!" => \$In::Opt{"ShowRetVal"},
"stdout!" => \$In::Opt{"StdOut"},
"report-format=s" => \$In::Opt{"ReportFormat"},
"old-style!" => \$In::Opt{"OldStyle"},
"title=s" => \$In::Opt{"TargetTitle"},
"component=s" => \$In::Opt{"TargetComponent"},
"p|params=s" => \$In::Opt{"ParamNamesPath"},
"limit-affected|affected-limit=s" => \$In::Opt{"AffectLimit"},
"all-affected!" => \$In::Opt{"AllAffected"},
"list-affected!" => \$In::Opt{"ListAffected"},
# ABI dump
"dump-path=s" => \$In::Opt{"OutputDumpPath"},
"dump-format=s" => \$In::Opt{"DumpFormat"},
"check!" => \$In::Opt{"CheckInfo"},
"extra-info=s" => \$In::Opt{"ExtraInfo"},
"extra-dump!" => \$In::Opt{"ExtraDump"},
"relpath=s" => \$In::Desc{1}{"RelativeDirectory"},
"vnum=s" => \$In::Desc{1}{"TargetVersion"},
"sort!" => \$In::Opt{"SortDump"},
# Filter symbols and types
"symbols-list=s" => \$In::Opt{"SymbolsListPath"},
"types-list=s" => \$In::Opt{"TypesListPath"},
"skip-symbols=s" => \$In::Opt{"SkipSymbolsListPath"},
"skip-types=s" => \$In::Opt{"SkipTypesListPath"},
"skip-internal-symbols|skip-internal=s" => \$In::Opt{"SkipInternalSymbols"},
"skip-internal-types=s" => \$In::Opt{"SkipInternalTypes"},
"keep-cxx!" => \$In::Opt{"KeepCxx"},
"keep-reserved!" => \$In::Opt{"KeepReserved"},
# Filter header files
"skip-headers=s" => \$In::Opt{"SkipHeadersPath"},
"headers-list=s" => \$In::Opt{"TargetHeadersPath"},
"header=s" => \$In::Opt{"TargetHeader"},
"nostdinc!" => \$In::Opt{"NoStdInc"},
"tolerance=s" => \$In::Opt{"Tolerance"},
"tolerant!" => \$In::Opt{"Tolerant"},
"skip-unidentified!" => \$In::Opt{"SkipUnidentified"},
# Filter rules
"skip-typedef-uncover!" => \$In::Opt{"SkipTypedefUncover"},
"check-private-abi!" => \$In::Opt{"CheckPrivateABI"},
"disable-constants-check!" => \$In::Opt{"DisableConstantsCheck"},
"skip-added-constants!" => \$In::Opt{"SkipAddedConstants"},
"skip-removed-constants!" => \$In::Opt{"SkipRemovedConstants"},
# Other
"lang=s" => \$In::Opt{"UserLang"},
"arch=s" => \$In::Opt{"TargetArch"},
"mingw-compatible!" => \$In::Opt{"MinGWCompat"},
"cxx-incompatible|cpp-incompatible!" => \$In::Opt{"CxxIncompat"},
"cpp-compatible!" => \$In::Opt{"CxxCompat"},
"quick!" => \$In::Opt{"Quick"},
"force!" => \$In::Opt{"Force"},
# OS analysis
"dump-system=s" => \$In::Opt{"DumpSystem"},
"cmp-systems!" => \$In::Opt{"CmpSystems"},
"sysroot=s" => \$In::Opt{"SystemRoot"},
"sysinfo=s" => \$In::Opt{"TargetSysInfo"},
"libs-list=s" => \$In::Opt{"TargetLibsPath"},
# Logging
"log-path=s" => \$In::Opt{"LoggingPath"},
"log1-path=s" => \$In::Desc{1}{"OutputLogPath"},
"log2-path=s" => \$In::Desc{2}{"OutputLogPath"},
"logging-mode=s" => \$In::Opt{"LogMode"},
"q|quiet!" => \$In::Opt{"Quiet"}
) or errMsg();
sub errMsg()
{
printMsg("INFO", "\n".$ShortUsage);
exit(getErrorCode("Error"));
}
# Default log path
$In::Opt{"DefaultLog"} = "logs/run.log";
my $HelpMessage = "
NAME:
ABI Compliance Checker ($CmdName)
Check backward compatibility of a C/C++ library API
DESCRIPTION:
ABI Compliance Checker (ABICC) is a tool for checking backward binary
compatibility and backward source compatibility of a C/C++ library API.
The tool analyzes changes in API and ABI (ABI=API+compiler ABI) that may
break binary compatibility 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 can create and compare ABI dumps for header files and shared
objects of a library. The ABI dump for a library can also be created by
the ABI Dumper tool (https://github.com/lvc/abi-dumper) if shared objects
include debug-info.
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.
Also the tool can be used by ISVs for checking applications portability to
new library versions. Found issues can be taken into account when adapting
the application to a new library version.
This tool is free software: you can redistribute it and/or modify it
under the terms of the GNU LGPL 2.1.
USAGE #1 (WITH ABI DUMPER):
1. Library should be compiled with \"-g -Og\" GCC options
to contain DWARF debug info
2. Create ABI dumps for both library versions
using the ABI Dumper (https://github.com/lvc/abi-dumper) tool:
abi-dumper OLD.so -o ABI-0.dump -lver 0
abi-dumper NEW.so -o ABI-1.dump -lver 1
3. You can filter public ABI with the help of
additional -public-headers option of the ABI Dumper tool.
4. Compare ABI dumps to create report:
abi-compliance-checker -l NAME -old ABI-0.dump -new ABI-1.dump
USAGE #2 (ORIGINAL):
1. Create XML-descriptors for two versions
of a library (OLD.xml and NEW.xml):
<version>
1.0
</version>
<headers>
/path/to/headers/
</headers>
<libs>
/path/to/libraries/
</libs>
2. Compare Xml-descriptors to create report:
abi-compliance-checker -lib NAME -old OLD.xml -new NEW.xml
USAGE #3 (CREATE ABI DUMPS):
1. Create XML-descriptors for two versions
of a library (OLD.xml and NEW.xml):
<version>
1.0
</version>
<headers>
/path/to/headers/
</headers>
<libs>
/path/to/libraries/
</libs>
2. Create ABI dumps:
abi-compliance-checker -lib NAME -dump OLD.xml -dump-path ./ABI-0.dump
abi-compliance-checker -lib NAME -dump NEW.xml -dump-path ./ABI-1.dump
3. Compare ABI dumps to create report:
abi-compliance-checker -l NAME -old ABI-0.dump -new ABI-1.dump
INFO OPTIONS:
-h|-help
Print this help.
-i|-info
Print complete info including all options.
-v|-version
Print version information.
-dumpversion
Print the tool version ($TOOL_VERSION) and don't do anything else.
GENERAL OPTIONS:
-l|-library NAME
Any name of the library.
-old|-d1 PATH
Descriptor of the 1st (old) library version.
It may be one of the following:
1. ABI dump generated by the ABI Dumper tool
2. XML-descriptor (*.xml file):
<version>
1.0
</version>
<headers>
/path1/to/header(s)/
/path2/to/header(s)/
...
</headers>
<libs>
/path1/to/library(ies)/
/path2/to/library(ies)/
...
</libs>
...
3. ABI dump generated by -dump option
4. Directory with headers and libraries
5. Single header file
If you are using 4-5 descriptor types then you should
specify version numbers with -v1 and -v2 options.
For more information, please see:
https://lvc.github.io/abi-compliance-checker/Xml-Descriptor.html
-new|-d2 PATH
Descriptor of the 2nd (new) library version.
-dump PATH
Create library ABI dump for the input XML descriptor. You can
transfer it anywhere and pass instead of the descriptor. Also
it can be used for debugging the tool.
-filter PATH
A path to XML descriptor with skip_* rules to filter
analyzed symbols in the report.
";
sub helpMsg() {
printMsg("INFO", $HelpMessage."
MORE OPTIONS:
$CmdName --info\n");
}
sub infoMsg()
{
printMsg("INFO", "$HelpMessage
EXTRA OPTIONS:
-debug
Debugging mode. Print debug info on the screen. Save intermediate
analysis stages in the debug directory:
debug/LIB_NAME/VERSION/
Also consider using -dump option for debugging the tool.
-ext|-extended
If your library A is supposed to be used by other library B and you
want to control the ABI of B, then you should enable this option. The
tool will check for changes in all data types, even if they are not
used by any function in the library A. Such data types are not part
of the A library ABI, but may be a part of the ABI of the B library.
The short scheme is:
app C (broken) -> lib B (broken ABI) -> lib A (stable ABI)
-static
Check static libraries instead of the shared ones. The <libs> section
of the XML-descriptor should point to static libraries location.
-gcc-path PATH
Path to the cross GCC compiler to use instead of the usual (host) GCC.
-gcc-prefix PREFIX
GCC toolchain prefix.
-gcc-options OPTS
Additional compiler options.
-count-symbols PATH
Count total public symbols in the ABI dump.
-use-dumps
Make dumps for two versions of a library and compare dumps. This should
increase the performance of the tool and decrease the system memory usage.
-xml
Alias for: --report-format=xml or --dump-format=xml
-app|-application PATH
This option allows one to specify the application that should be checked
for portability to the new library version.
-headers-only
Check header files without libraries. It is easy to run, but may
provide a low quality compatibility report with false positives and
without detecting of added/removed symbols.
-v1|-vnum1 NUM
Specify 1st library version outside the descriptor. This option is needed
if you have preferred an alternative descriptor type (see -d1 option).
In general case you should specify it in the XML-descriptor:
<version>
VERSION
</version>
-v2|-vnum2 NUM
Specify 2nd library version outside the descriptor.
-relpath1 PATH
Replace {RELPATH} macros to PATH in the 1st XML-descriptor (-d1).
-relpath2 PATH
Replace {RELPATH} macros to PATH in the 2nd XML-descriptor (-d2).
TEST OPTIONS:
-test
Run internal tests. Create two binary incompatible versions of a sample
library and run the tool to check them for compatibility. This option
allows one to check if the tool works correctly in the current environment.
-test-dump
Test ability to create, read and compare ABI dumps.
-test-abi-dumper
Compare ABI dumps created by the ABI Dumper tool.
REPORT OPTIONS:
-binary|-bin|-abi
Show binary compatibility problems only.
Generate report to:
compat_reports/LIB_NAME/V1_to_V2/abi_compat_report.html
-source|-src|-api
Show source compatibility problems only.
Generate report to:
compat_reports/LIB_NAME/V1_to_V2/src_compat_report.html
-s|-strict
Treat all compatibility warnings as problems. Add a number of \"Low\"
severity problems to the return value of the tool.
-warn-newsym
Treat new symbols as problems, because that breaks semantic versioning.
For more info please visit https://semver.org/
REPORT PATH OPTIONS:
-report-path PATH
Path to compatibility report.
Default:
compat_reports/LIB_NAME/V1_to_V2/compat_report.html
-bin-report-path PATH
Path to binary compatibility report.
Default:
compat_reports/LIB_NAME/V1_to_V2/abi_compat_report.html
-src-report-path PATH
Path to source compatibility report.
Default:
compat_reports/LIB_NAME/V1_to_V2/src_compat_report.html
REPORT FORMAT OPTIONS:
-show-retval
Show the symbol's return type in the report.
-stdout
Print analysis results (compatibility reports and ABI dumps) to stdout
instead of creating a file. This would allow piping data to other programs.
-report-format FMT
Change format of compatibility report.
Formats:
htm - HTML format (default)
xml - XML format
-old-style
Generate old-style report.
-title NAME
Change library name in the report title to NAME. By default
will be displayed a name specified by -l option.
-component NAME
The component name in the title and summary of the HTML report.
Default:
library
-p|-params PATH
Path to file with the function parameter names. It can be used
for improving report view if the library header files have no
parameter names. File format:
func1;param1;param2;param3 ...
func2;param1;param2;param3 ...
...
-limit-affected LIMIT
The maximum number of affected symbols listed under the description
of the changed type in the report.
-list-affected
Generate file with the list of incompatible
symbols beside the HTML compatibility report.
Use 'c++filt \@file' command from GNU binutils
to unmangle C++ symbols in the generated file.
Default names:
abi_affected.txt
src_affected.txt
ABI DUMP OPTIONS:
-dump-path PATH
Specify a *.dump file path where to generate an ABI dump.
Default:
abi_dumps/LIB_NAME/VERSION/ABI.dump
-dump-format FMT
Change format of ABI dump.
Formats:
perl - Data::Dumper format (default)
xml - XML format
-check
Check completeness of the ABI dump.
-extra-info DIR
Dump extra info to DIR.
-extra-dump
Create extended ABI dump containing all symbols
from the translation unit.
-relpath PATH
Replace {RELPATH} macros to PATH in the XML-descriptor used
for dumping the library ABI (see -dump option).
-vnum NUM
Specify the library version in the generated ABI dump. The <version> section
of the input XML descriptor will be overwritten in this case.
-sort
Enable sorting of data in ABI dumps.
FILTER SYMBOLS OPTIONS:
-symbols-list PATH
This option allows one to specify a file with a list of symbols (mangled
names in C++) that should be checked. Other symbols will not be checked.
-types-list PATH
This option allows one to specify a file with a list of types that should
be checked. Other types will not be checked.
-skip-symbols PATH
The list of symbols that should not be checked.
-skip-types PATH
The list of types that should not be checked.
-skip-internal-symbols PATTERN
Do not check symbols matched by the regular expression.
-skip-internal-types PATTERN
Do not check types matched by the regular expression.
It's matched against full qualified type names (e.g. 'struct xyz::Name<T>').
It has to match any part of type name.
-keep-cxx
Check _ZS*, _ZNS* and _ZNKS* symbols.
-keep-reserved
Report changes in reserved fields.
FILTER HEADERS OPTIONS:
-skip-headers PATH
The file with the list of header files, that should not be checked.
-headers-list PATH
The file with a list of headers, that should be checked/dumped.
-header NAME
Check/Dump ABI of this header only.
-nostdinc
Do not search in GCC standard system directories for header files.
-tolerance LEVEL
Apply a set of heuristics to successfully compile input
header files. You can enable several tolerance levels by
joining them into one string (e.g. 13, 124, etc.).
Levels:
1 - skip non-Linux headers (e.g. win32_*.h, etc.)
2 - skip internal headers (e.g. *_p.h, impl/*.h, etc.)
3 - skip headers that include non-Linux headers
4 - skip headers included by others
-tolerant
Enable highest tolerance level [1234].
-skip-unidentified
Skip header files in 'headers' and 'include_preamble' sections
of the XML descriptor that cannot be found. This is useful if
you are trying to use the same descriptor for different targets.
FILTER RULES OPTIONS:
-skip-typedef-uncover
Do not report a problem if type is covered or
uncovered by typedef (useful for broken debug info).
-check-private-abi
Check data types from the private part of the ABI when
comparing ABI dumps created by the ABI Dumper tool with
use of the -public-headers option.
Requires ABI Dumper >= 0.99.14
-disable-constants-check
Do not check for changes in constants.
-skip-added-constants
Do not detect added constants.
-skip-removed-constants
Do not detect removed constants.
OTHER OPTIONS:
-lang LANG
Set library language (C or C++). You can use this option if the tool
cannot auto-detect a language. This option may be useful for checking
C-library headers (--lang=C) in --headers-only or --extended modes.
-arch ARCH
Set library architecture (x86, x86_64, ia64, arm, ppc32, ppc64, s390,
etc.). The option is useful if the tool cannot detect correct architecture
of the input objects.
-mingw-compatible
If input header files are compatible with the MinGW GCC compiler,
then you can tell the tool about this and speedup the analysis.
-cxx-incompatible
Set this option if input C header files use C++ keywords. The tool
will try to replace such keywords at preprocessor stage and replace
them back in the final TU dump.
-cpp-compatible
Do nothing.
-quick
Quick analysis. Disable check of some template instances.
-force
Try to enable this option if the tool checked not all
types and symbols in header files.
OS ANALYSIS OPTIONS:
-dump-system NAME -sysroot DIR
Find all the shared libraries and header files in DIR directory,
create XML descriptors and make ABI dumps for each library. The result
set of ABI dumps can be compared (--cmp-systems) with the other one
created for other version of operating system in order to check them for
compatibility. Do not forget to specify -cross-gcc option if your target
system requires some specific version of GCC compiler (different from
the host GCC). The system ABI dump will be generated to:
sys_dumps/NAME/ARCH
-dump-system DESCRIPTOR.xml
The same as the previous option but takes an XML descriptor of the target
system as input, where you should describe it:
/* Primary sections */
<name>
/* Name of the system */
</name>
<headers>
/* The list of paths to header files and/or
directories with header files, one per line */
</headers>
<libs>
/* The list of paths to shared libraries and/or
directories with shared libraries, one per line */
</libs>
/* Optional sections */
<search_headers>
/* List of directories to be searched
for header files to automatically
generate include paths, one per line */
</search_headers>
<search_libs>
/* List of directories to be searched
for shared libraries to resolve
dependencies, one per line */
</search_libs>
<tools>
/* List of directories with tools used
for analysis (GCC toolchain), one per line */
</tools>
<cross_prefix>
/* GCC toolchain prefix.
Examples:
arm-linux-gnueabi
arm-none-symbianelf */
</cross_prefix>
<gcc_options>
/* Additional GCC options, one per line */
</gcc_options>
-cmp-systems -d1 sys_dumps/NAME1/ARCH -d2 sys_dumps/NAME2/ARCH
Compare two ABI dumps of a system. Create compatibility reports for
each system library and the common HTML report including the summary
of test results for all checked libraries.
Summary report will be generated to:
sys_compat_reports/NAME1_to_NAME2/ARCH
-sysroot DIR
Specify the alternative root directory. The tool will search for include
paths in the DIR/usr/include and DIR/usr/lib directories.
-sysinfo DIR
This option should be used with -dump-system option to dump
ABI of operating systems and configure the dumping process.
-libs-list PATH
The file with a list of libraries, that should be dumped by
the -dump-system option or should be checked by the -cmp-systems option.
LOGGING OPTIONS:
-log-path PATH
Log path for all messages.
Default:
logs/LIB_NAME/VERSION/log.txt
-log1-path PATH
Log path for 1st version of a library.
Default:
logs/LIB_NAME/V1/log.txt
-log2-path PATH
Log path for 2nd version of a library.
Default:
logs/LIB_NAME/V2/log.txt
-logging-mode MODE
Change logging mode.
Modes:
w - overwrite old logs (default)
a - append old logs
n - do not write any logs
-q|-quiet
Print all messages to the file instead of stdout and stderr.
Default path (can be changed by -log-path option):
".$In::Opt{"DefaultLog"}."
REPORT PATH:
Compatibility report will be generated to:
compat_reports/LIB_NAME/V1_to_V2/compat_report.html
LOG PATH:
Log will be generated to:
logs/LIB_NAME/V1/log.txt
logs/LIB_NAME/V2/log.txt
EXIT CODES:
0 - Compatible. The tool has run without any errors.
non-zero - Incompatible or the tool has run with errors.
MORE INFO:
".$HomePage{"Doc"}."
".$HomePage{"Dev"}."\n\n");
}
# Aliases
my (%SymbolInfo, %TypeInfo, %TName_Tid, %Constants) = ();
# Global
my %Cache;
my $TOP_REF = "<a class='top_ref' href='#Top'>to the top</a>";
my %RESULT;
# Counter
my %CheckedTypes;
my %CheckedSymbols;
# Classes
my %VirtualTable;
my %VirtualTable_Model;
my %VTableClass;
my %AllocableClass;
my %ClassMethods;
my %ClassNames;
my %OverriddenMethods;
# Symbols
my %Func_ShortName;
my %AddSymbolParams;
my %GlobalDataObject;
# Merging
my %CompSign;
my %AddedInt;
my %RemovedInt;
my %AddedInt_Virt;
my %RemovedInt_Virt;
my %VirtualReplacement;
my %ChangedTypedef;
my %CompatRules;
my %IncompleteRules;
my %UnknownRules;
my %VTableChanged_M;
my %ReturnedClass;
my %ParamClass;
my %SourceAlternative;
my %SourceAlternative_B;
my %SourceReplacement;
# Extra
my %ExtendedSymbols;
#Report
my %TypeChanges;
#Speedup
my %TypeProblemsIndex;
# Calling Conventions
my %UseConv_Real = (
1=>{ "R"=>0, "P"=>0 },
2=>{ "R"=>0, "P"=>0 }
);
# ABI Dump
my %UsedDump;
# Recursion locks
my @RecurTypes;
my @RecurTypes_Diff;
my @RecurConstant;
# Problem descriptions
my %CompatProblems;
my %CompatProblems_Constants;
my %TotalAffected;
# Reports
my $ContentID = 1;
my $ContentSpanStart = "<span class=\"section\" onclick=\"javascript:showContent(this, 'CONTENT_ID')\">\n";
my $ContentSpanStart_Affected = "<span class=\"sect_aff\" onclick=\"javascript:showContent(this, 'CONTENT_ID')\">\n";
my $ContentSpanStart_Info = "<span class=\"sect_info\" onclick=\"javascript:showContent(this, 'CONTENT_ID')\">\n";
my $ContentSpanEnd = "</span>\n";
my $ContentDivStart = "<div id=\"CONTENT_ID\" style=\"display:none;\">\n";
my $ContentDivEnd = "</div>\n";
my $Content_Counter = 0;
my %Severity_Val=(
"High"=>3,
"Medium"=>2,
"Low"=>1,
"Safe"=>-1
);
sub getModules()
{
my $TOOL_DIR = dirname($0);
if(not $TOOL_DIR)
{ # patch for MS Windows
$TOOL_DIR = ".";
}
my @SEARCH_DIRS = (
# tool's directory
abs_path($TOOL_DIR),
# relative path to modules
abs_path($TOOL_DIR)."/../share/abi-compliance-checker",
# install path
'MODULES_INSTALL_PATH'
);
foreach my $DIR (@SEARCH_DIRS)
{
if($DIR!~/\A(\/|\w+:[\/\\])/)
{ # relative path
$DIR = abs_path($TOOL_DIR)."/".$DIR;
}
if(-d $DIR."/modules") {
return $DIR."/modules";
}
}
print STDERR "ERROR: can't find modules (Did you installed the tool by 'make install' command?)\n";
exit(9); # Module_Error
}
sub loadModule($)
{
my $Name = $_[0];
if(defined $LoadedModules{$Name}) {
return;
}
my $Path = $MODULES_DIR."/Internals/$Name.pm";
if(not -f $Path)
{
print STDERR "can't access \'$Path\'\n";
exit(2);
}
require $Path;
$LoadedModules{$Name} = 1;
}
sub readModule($$)
{
my ($Module, $Name) = @_;
my $Path = $MODULES_DIR."/Internals/$Module/".$Name;
if(not -f $Path) {
exitStatus("Module_Error", "can't access \'$Path\'");
}
return readFile($Path);
}
sub selectSymbolNs($$)
{
my ($Symbol, $LVer) = @_;
my $NS = $CompSign{$LVer}{$Symbol}{"NameSpace"};
if(not $NS)
{
if(my $Class = $CompSign{$LVer}{$Symbol}{"Class"}) {
$NS = $TypeInfo{$LVer}{$Class}{"NameSpace"};
}
}
if($NS)
{