RepoMirrors/libabigail
1
0
Fork 0
mirror of git://sourceware.org/git/libabigail.git synced 2025-01-17 06:41:18 +00:00
Code Issues Packages Projects Releases Wiki Activity
474cf47cd1
libabigail/tests/test-diff-dwarf.cc
Dodji Seketeli 059c86ec0b Bug 20476 - Compare virtual member functions when comparing classes 
There are cases where a virtual member function doesn't have an
implementation that is defined and publicly exported.  This is the
cases for virtual pure classes.

Even in those cases, users might want to detect vtable changes on
virtual member pure classes (interfaces).

Now that, for C++ binaries, all the partial representations of a class
are merged into one class (in a given binary), we can envision to
compare virtual member functions of classes as part of comparing two
classes.

This is what this patch does.  While comparing two classes, the
virtual member functions are compared too.

Note that as there can be several virtual member functions that have
the same vtable offset (think about a virtual destructor that might
have several generated functions that 'conceptually' share the same
vtable offset), comparing the virtual functions can be a little bit
non-trivial.

The approach taken is to check that in the first set of virtual
functions, each virtual function actually matches at least one virtual
function in the second set.  And the match is a "loose" one.  That is,
it doesn't take into account the symbol name or the mangled name.

The patch also fixes the "less than" operator used to sort virtual
member functions.

There is also a buglet in the way we compute the highest vtable offset
number today.  This patch provides a new function named
class_decl::get_biggest_vtable_offset that is used in the change reports.

The patch also fixes a related bug in where we were forgetting to
report about added and removed virtual member functions without an
associated elf symbol.  This patch fixes that.

	* include/abg-ir.h (class_decl::get_biggest_vtable_offset):
	Declare new member function.
	* src/abg-ir.cc (virtual_member_function_less_than::operator()):
	Either compare the symbol id strings if the functions have
	symbols or just compare their pretty representations.
	(class_decl::get_biggest_vtable_offset): Define new member
	function.
	(methods_equal_modulo_elf_symbol)
	(method_matches_at_least_one_in_vector): New static methods.
	(equals): In the overload for classes, compare the virtual member
	functions while comparing classes.
	* src/abg-comparison.cc (represent): In the overload for
	method_decl_sptr, fix the way we compute the highest vtable offset
	number for a give class_decl.
	(class_decl::ensure_lookup_tables_populated): Don't forget added
	and removed virtual member functions in the report for changed
	classes.
	* tests/data/test-diff-dwarf/libtest41-PR20476-hidden-old.so: New
	test binary input file.
	* tests/data/test-diff-dwarf/libtest41-PR20476-hidden-new.so: Likewise.
	* tests/data/test-diff-dwarf/test41-PR20476-hidden-report-0.txt:
	New reference output.
	* tests/data/Makefile.am: Add the new test material above to the
	source distribution.
	* tests/test-diff-dwarf.cc (in_out_spec): Add the new tests
	here.
	* tests/data/test-annotate/test10-pr18818-gcc.so.abi: Adjust.
	* tests/data/test-annotate/test11-pr18828.so.abi: Adjust.
	* tests/data/test-annotate/test18-pr19037-libvtkRenderingLIC-6.1.so.abi: Adjust.
	* tests/data/test-annotate/test20-pr19025-libvtkParallelCore-6.1.so.abi: Adjust.
	* tests/data/test-annotate/test22-pr19097-libstdc++.so.6.0.17.so.abi: Adjust.
	* tests/data/test-read-dwarf/test10-pr18818-gcc.so.abi: Adjust.
	* tests/data/test-read-dwarf/test11-pr18828.so.abi: Adjust.
	* tests/data/test-read-dwarf/test13-pr18894.so.abi: Adjust.
	* tests/data/test-read-dwarf/test14-pr18893.so.abi: Adjust.
	* tests/data/test-read-dwarf/test15-pr18892.so.abi: Adjust.
	* tests/data/test-read-dwarf/test18-pr19037-libvtkRenderingLIC-6.1.so.abi:
	Adjust.
	* tests/data/test-read-dwarf/test20-pr19025-libvtkParallelCore-6.1.so.abi:
	Adjust.
	* tests/data/test-read-dwarf/test21-pr19092.so.abi: Adjust.
	* tests/data/test-read-dwarf/test22-pr19097-libstdc++.so.6.0.17.so.abi:
	Adjust.
2017-02-14 12:49:47 +01:00

431 lines
14 KiB
C++
Raw Blame History

// -*- Mode: C++ -*-
//
// Copyright (C) 2013-2016 Red Hat, Inc.
//
// This file is part of the GNU Application Binary Interface Generic
// Analysis and Instrumentation Library (libabigail). 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 3, 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
// General Lesser Public License for more details.
// You should have received a copy of the GNU Lesser General Public
// License along with this program; see the file COPYING-LGPLV3. If
// not, see <http://www.gnu.org/licenses/>.
// Author: Dodji Seketeli
/// @file
///
/// This program runs a diff between input dwarf files and compares
/// the resulting report with a reference report. If the resulting
/// report is different from the reference report, the test has
/// failed. Note that the comparison is done using the libabigail
/// library directly.
///
/// The set of input files and reference reports to consider should be
/// present in the source distribution.
#include <string>
#include <fstream>
#include <iostream>
#include <cstdlib>
#include "abg-tools-utils.h"
#include "test-utils.h"
#include "abg-dwarf-reader.h"
#include "abg-comparison.h"
using std::string;
using std::ofstream;
using std::cerr;
/// This is an aggregate that specifies where a test shall get its
/// input from and where it shall write its ouput to.
struct InOutSpec
{
const char* in_elfv0_path;
const char* in_elfv1_path;
const char* in_report_path;
const char* out_report_path;
};// end struct InOutSpec
InOutSpec in_out_specs[] =
{
{
"data/test-diff-dwarf/test0-v0.o",
"data/test-diff-dwarf/test0-v1.o",
"data/test-diff-dwarf/test0-report.txt",
"output/test-diff-dwarf/test0-report.txt"
},
{
"data/test-diff-dwarf/test1-v0.o",
"data/test-diff-dwarf/test1-v1.o",
"data/test-diff-dwarf/test1-report.txt",
"output/test-diff-dwarf/test1-report.txt"
},
{
"data/test-diff-dwarf/test2-v0.o",
"data/test-diff-dwarf/test2-v1.o",
"data/test-diff-dwarf/test2-report.txt",
"output/test-diff-dwarf/test2-report.txt"
},
{
"data/test-diff-dwarf/test3-v0.o",
"data/test-diff-dwarf/test3-v1.o",
"data/test-diff-dwarf/test3-report.txt",
"output/test-diff-dwarf/test3-report.txt"
},
{
"data/test-diff-dwarf/test3-v0.o",
"data/test-diff-dwarf/test3-v1.o",
"data/test-diff-dwarf/test3-report.txt",
"output/test-diff-dwarf/test3-report.txt"
},
{
"data/test-diff-dwarf/test4-v0.o",
"data/test-diff-dwarf/test4-v1.o",
"data/test-diff-dwarf/test4-report.txt",
"output/test-diff-dwarf/test4-report.txt"
},
{
"data/test-diff-dwarf/test5-v0.o",
"data/test-diff-dwarf/test5-v1.o",
"data/test-diff-dwarf/test5-report.txt",
"output/test-diff-dwarf/test5-report.txt"
},
{
"data/test-diff-dwarf/test6-v0.o",
"data/test-diff-dwarf/test6-v1.o",
"data/test-diff-dwarf/test6-report.txt",
"output/test-diff-dwarf/test6-report.txt"
},
{
"data/test-diff-dwarf/test7-v0.o",
"data/test-diff-dwarf/test7-v1.o",
"data/test-diff-dwarf/test7-report.txt",
"output/test-diff-dwarf/test7-report.txt"
},
{
"data/test-diff-dwarf/test8-v0.o",
"data/test-diff-dwarf/test8-v1.o",
"data/test-diff-dwarf/test8-report.txt",
"output/test-diff-dwarf/test8-report.txt"
},
{
"data/test-diff-dwarf/libtest9-v0.so",
"data/test-diff-dwarf/libtest9-v1.so",
"data/test-diff-dwarf/test9-report.txt",
"output/test-diff-dwarf/test9-report.txt"
},
{
"data/test-diff-dwarf/test10-v0.o",
"data/test-diff-dwarf/test10-v1.o",
"data/test-diff-dwarf/test10-report.txt",
"output/test-diff-dwarf/test10-report.txt"
},
{
"data/test-diff-dwarf/test11-v0.o",
"data/test-diff-dwarf/test11-v1.o",
"data/test-diff-dwarf/test11-report.txt",
"output/test-diff-dwarf/test11-report.txt"
},
{
"data/test-diff-dwarf/libtest12-v0.so",
"data/test-diff-dwarf/libtest12-v1.so",
"data/test-diff-dwarf/test12-report.txt",
"output/test-diff-dwarf/test12-report.txt"
},
{
"data/test-diff-dwarf/test13-v0.o",
"data/test-diff-dwarf/test13-v1.o",
"data/test-diff-dwarf/test13-report.txt",
"output/test-diff-dwarf/test13-report.txt"
},
{
"data/test-diff-dwarf/test14-inline-v0.o",
"data/test-diff-dwarf/test14-inline-v1.o",
"data/test-diff-dwarf/test14-inline-report.txt",
"output/test-diff-dwarf/test14-inline-report.txt"
},
{
"data/test-diff-dwarf/test15-enum-v0.o",
"data/test-diff-dwarf/test15-enum-v1.o",
"data/test-diff-dwarf/test15-enum-report.txt",
"output/test-diff-dwarf/test15-enum-report.txt"
},
{
"data/test-diff-dwarf/test16-syms-only-v0.o",
"data/test-diff-dwarf/test16-syms-only-v1.o",
"data/test-diff-dwarf/test16-syms-only-report.txt",
"output/test-diff-dwarf/test16-syms-only-report.txt"
},
{
"data/test-diff-dwarf/test17-non-refed-syms-v0.o",
"data/test-diff-dwarf/test17-non-refed-syms-v1.o",
"data/test-diff-dwarf/test17-non-refed-syms-report-0.txt",
"output/test-diff-dwarf/test17-non-refed-syms-report-0.txt"
},
{
"data/test-diff-dwarf/libtest18-alias-sym-v0.so",
"data/test-diff-dwarf/libtest18-alias-sym-v1.so",
"data/test-diff-dwarf/test18-alias-sym-report-0.txt",
"output/test-diff-dwarf/test18-alias-sym-report-0.txt"
},
{
"data/test-diff-dwarf/libtest19-soname-v0.so",
"data/test-diff-dwarf/libtest19-soname-v1.so",
"data/test-diff-dwarf/test19-soname-report-0.txt",
"output/test-diff-dwarf/test19-soname-report-0.txt"
},
{
"data/test-diff-dwarf/libtest20-add-fn-parm-v0.so",
"data/test-diff-dwarf/libtest20-add-fn-parm-v1.so",
"data/test-diff-dwarf/test20-add-fn-parm-report-0.txt",
"output/test-diff-dwarf/test20-add-fn-parm-report-0.txt"
},
{
"data/test-diff-dwarf/libtest21-redundant-fn-v0.so",
"data/test-diff-dwarf/libtest21-redundant-fn-v1.so",
"data/test-diff-dwarf/test21-redundant-fn-report-0.txt",
"output/test-diff-dwarf/test21-redundant-fn-report-0.txt"
},
{
"data/test-diff-dwarf/libtest22-changed-parm-c-v0.so",
"data/test-diff-dwarf/libtest22-changed-parm-c-v1.so",
"data/test-diff-dwarf/test22-changed-parm-c-report-0.txt",
"output/test-diff-dwarf/test22-changed-parm-c-report-0.txt"
},
{
"data/test-diff-dwarf/libtest-23-diff-arch-v0-32.so",
"data/test-diff-dwarf/libtest-23-diff-arch-v0-64.so",
"data/test-diff-dwarf/test-23-diff-arch-report-0.txt",
"output/test-diff-dwarf/test-23-diff-arch-report-0.txt"
},
{
"data/test-diff-dwarf/libtest24-added-fn-parms-v0.so",
"data/test-diff-dwarf/libtest24-added-fn-parms-v1.so",
"data/test-diff-dwarf/test24-added-fn-parms-report-0.txt",
"output/test-diff-dwarf/test24-added-fn-parms-report-0.txt"
},
{
"data/test-diff-dwarf/libtest25-removed-fn-parms-v0.so",
"data/test-diff-dwarf/libtest25-removed-fn-parms-v1.so",
"data/test-diff-dwarf/test25-removed-fn-parms-report-0.txt",
"output/test-diff-dwarf/test25-removed-fn-parms-report-0.txt"
},
{
"data/test-diff-dwarf/libtest26-added-parms-before-variadic-v0.so",
"data/test-diff-dwarf/libtest26-added-parms-before-variadic-v1.so",
"data/test-diff-dwarf/test26-added-parms-before-variadic-report.txt",
"output/test-diff-dwarf/test26-added-parms-before-variadic-report.txt"
},
{
"data/test-diff-dwarf/test27-local-base-diff-v0.o",
"data/test-diff-dwarf/test27-local-base-diff-v1.o",
"data/test-diff-dwarf/test27-local-base-diff-report.txt",
"output/test-diff-dwarf/test27-local-base-diff-report.txt"
},
{
"data/test-diff-dwarf/test28-vtable-changes-v0.o",
"data/test-diff-dwarf/test28-vtable-changes-v1.o",
"data/test-diff-dwarf/test28-vtable-changes-report-0.txt",
"output/test-diff-dwarf/test28-vtable-changes-report-0.txt"
},
{
"data/test-diff-dwarf/test29-vtable-changes-v0.o",
"data/test-diff-dwarf/test29-vtable-changes-v1.o",
"data/test-diff-dwarf/test29-vtable-changes-report-0.txt",
"output/test-diff-dwarf/test29-vtable-changes-report-0.txt"
},
{
"data/test-diff-dwarf/test30-vtable-changes-v0.o",
"data/test-diff-dwarf/test30-vtable-changes-v1.o",
"data/test-diff-dwarf/test30-vtable-changes-report-0.txt",
"output/test-diff-dwarf/test30-vtable-changes-report-0.txt"
},
{
"data/test-diff-dwarf/test31-vtable-changes-v0.o",
"data/test-diff-dwarf/test31-vtable-changes-v1.o",
"data/test-diff-dwarf/test31-vtable-changes-report-0.txt",
"output/test-diff-dwarf/test31-vtable-changes-report-0.txt"
},
{
"data/test-diff-dwarf/test32-fnptr-changes-v0.o",
"data/test-diff-dwarf/test32-fnptr-changes-v1.o",
"data/test-diff-dwarf/test32-fnptr-changes-report-0.txt",
"output/test-diff-dwarf/test32-fnptr-changes-report-0.txt"
},
{
"data/test-diff-dwarf/test33-fnref-changes-v0.o",
"data/test-diff-dwarf/test33-fnref-changes-v1.o",
"data/test-diff-dwarf/test33-fnref-changes-report-0.txt",
"output/test-diff-dwarf/test33-fnref-changes-report-0.txt"
},
{
"data/test-diff-dwarf/test34-pr19173-libfoo.so",
"data/test-diff-dwarf/test34-pr19173-libfoo2.so",
"data/test-diff-dwarf/test34-pr19173-libfoo-report-0.txt",
"output/test-diff-dwarf/test34-pr19173-libfoo-report-0.txt"
},
{
"data/test-diff-dwarf/test35-pr19173-libfoo-long-gcc.so",
"data/test-diff-dwarf/test35-pr19173-libfoo-long-gcc2.so",
"data/test-diff-dwarf/test35-pr19173-libfoo-long-gcc-report-0.txt",
"output/test-diff-dwarf/test35-pr19173-libfoo-long-gcc-report-0.txt"
},
{
"data/test-diff-dwarf/test35-pr19173-libfoo-long-clang.so",
"data/test-diff-dwarf/test35-pr19173-libfoo-long-clang2.so",
"data/test-diff-dwarf/test35-pr19173-libfoo-long-clang-report-0.txt",
"output/test-diff-dwarf/test35-pr19173-libfoo-long-clang-report-0.txt"
},
{
"data/test-diff-dwarf/libtest36-ppc64-aliases-v0.so",
"data/test-diff-dwarf/libtest36-ppc64-aliases-v1.so",
"data/test-diff-dwarf/test36-ppc64-aliases-report-0.txt",
"output/test-diff-dwarf/test36-ppc64-aliases-report-0.txt"
},
{
"data/test-diff-dwarf/libtest37-union-v0.so",
"data/test-diff-dwarf/libtest37-union-v1.so",
"data/test-diff-dwarf/test37-union-report-0.txt",
"output/test-diff-dwarf/test37-union-report-0.txt"
},
{
"data/test-diff-dwarf/libtest38-union-v0.so",
"data/test-diff-dwarf/libtest38-union-v1.so",
"data/test-diff-dwarf/test38-union-report-0.txt",
"output/test-diff-dwarf/test38-union-report-0.txt"
},
{
"data/test-diff-dwarf/libtest39-union-v0.so",
"data/test-diff-dwarf/libtest39-union-v1.so",
"data/test-diff-dwarf/test39-union-report-0.txt",
"output/test-diff-dwarf/test39-union-report-0.txt"
},
{
"data/test-diff-dwarf/libtest40-v0.so",
"data/test-diff-dwarf/libtest40-v1.so",
"data/test-diff-dwarf/test40-report-0.txt",
"output/test-diff-dwarf/test40-report-0.txt"
},
{
"data/test-diff-dwarf/libtest41-PR20476-hidden-old.so",
"data/test-diff-dwarf/libtest41-PR20476-hidden-new.so",
"data/test-diff-dwarf/test41-PR20476-hidden-report-0.txt",
"output/test-diff-dwarf/test41-PR20476-hidden-report-0.txt"
},
// This should be the last entry
{NULL, NULL, NULL, NULL}
};
int
main()
{
using abigail::tests::get_src_dir;
using abigail::tests::get_build_dir;
using abigail::tools_utils::ensure_parent_dir_created;
using abigail::dwarf_reader::read_corpus_from_elf;
using abigail::comparison::compute_diff;
using abigail::comparison::corpus_diff_sptr;
using abigail::ir::environment;
using abigail::ir::environment_sptr;
using abigail::comparison::diff_context_sptr;
using abigail::comparison::diff_context;
bool is_ok = true;
string in_elfv0_path, in_elfv1_path,
ref_diff_report_path, out_diff_report_path;
for (InOutSpec* s = in_out_specs; s->in_elfv0_path; ++s)
{
in_elfv0_path = string(get_src_dir()) + "/tests/" + s->in_elfv0_path;
in_elfv1_path = string(get_src_dir()) + "/tests/" + s->in_elfv1_path;
out_diff_report_path =
string(get_build_dir()) + "/tests/" + s->out_report_path;
if (!ensure_parent_dir_created(out_diff_report_path))
{
cerr << "could not create parent directory for "
<< out_diff_report_path;
is_ok = false;
continue;
}
abigail::dwarf_reader::status status =
abigail::dwarf_reader::STATUS_UNKNOWN;
environment_sptr env(new environment);
abigail::corpus_sptr corp0 =
read_corpus_from_elf(in_elfv0_path,
/*debug_info_root_path=*/0,
env.get(),
/*load_all_types=*/false,
status);
abigail::corpus_sptr corp1 =
read_corpus_from_elf(in_elfv1_path,
/*debug_info_root_path=*/0,
env.get(),
/*load_all_types=*/false,
status);
if (!corp0)
{
cerr << "failed to read " << in_elfv0_path << "\n";
is_ok = false;
continue;
}
if (!corp1)
{
cerr << "failed to read " << in_elfv1_path << "\n";
is_ok = false;
continue;
}
corp0->set_path(s->in_elfv0_path);
corp1->set_path(s->in_elfv1_path);
diff_context_sptr ctxt(new diff_context);
ctxt->show_locs(false);
corpus_diff_sptr d = compute_diff(corp0, corp1, ctxt);
if (!d)
{
cerr << "failed to compute diff\n";
is_ok = false;
continue;
}
ref_diff_report_path =
string(get_src_dir()) + "/tests/" + s->in_report_path;
out_diff_report_path =
string(get_build_dir()) + "/tests/" + s->out_report_path;
ofstream of(out_diff_report_path.c_str(), std::ios_base::trunc);
if (!of.is_open())
{
cerr << "failed to read " << out_diff_report_path << "\n";
is_ok = false;
continue;
}
if (d->has_changes())
d->report(of);
of.close();
string cmd =
"diff -u " + ref_diff_report_path + " " + out_diff_report_path;
if (system(cmd.c_str()))
is_ok = false;
}
return !is_ok;
}
Reference in New Issue View Git Blame Copy Permalink