RepoMirrors/libabigail
1
0
Fork 0
mirror of git://sourceware.org/git/libabigail.git synced 2024-12-16 23:14:36 +00:00
Code Issues Packages Projects Releases Wiki Activity
8f994b5e29
libabigail/tests/test-diff-suppr.cc
Dodji Seketeli 8f994b5e29 Temporarily disable redundant diff report elimination 
So, this is all about problem report
https://sourceware.org/bugzilla/show_bug.cgi?id=17693.

When redundant diff node reporting is enabled and when a diff node
appears twice in a diff tree, we detect that and the second occurrence
of the diff node is flagged as being redundant.  Later at diff tree
node reporting time, the redundant diff node is not reported.

The problem is that diff nodes are canonicalized.  That is, when the
same change is present twice in a diff, the same diff node is going to
be present twice.  So flagging the second occurrence as being
redundant amounts as flagging the first occurrence as being redundant
too!  So at reporting time, the diff tree visitor that walks the diff
tree nodes will avoid reporting the two occurrences of diff tree nodes
altogether.  This is what happens in the example of the bug above.  I
am reproducing the example here for convenience:

So suppose we have a first version of a library named lib-v0.so which
is made of this C code:

    int add(int a, int b)
    {
    }

Then suppose that code was changed in a subsequent version of the
library named lib-v1.so, leading to the following code:

    int add(float a, float b)
    {
    }

So, the diff tree node for the 'add' function is going to have several
child diff tree nodes, among which, one that carries the change for
the first parameter (int a becoming float a) and the one carrying the
change for the second parameter (int b becoming float b).

The diff tree node for the second parameter is going to be same diff
tree node as the one for the first parameter because what counts is
the change in the *type* of the parameter.  Thus, the diff tree node
for the second parameter is going to be marked as being redundant; and
so is the first parameter.

So abidiff lib-v0.so lib-v1.so yields:

    Functions changes summary: 0 Removed, 0 Changed (1 filtered out), 0 Added
    function
    Variables changes summary: 0 Removed, 0 Changed, 0 Added variable

You can see that even the function 'add' is not mentioned in the
report.  This is because it has also been considered as being
redundant because of a phenomenon named 'propagation'.  The
redundant-ness of the children nodes of the diff tree node of the
'add' function is propagated to the diff tree node of the add function
itself because that add function diff tree node has no child but
redundant diff children nodes.  This categorization behaviour is
correct.

What is not correct is that only the second child node of the add
function diff tree node should have been marked redundant.

I am going to tackle this issue a bit later.  For now, I am
temporarily disabling redundancy categorization for diff tree nodes by
default.  Hence this patch.

With this patch, abidiff lib-v0.so lib-v1.so yields:

    Functions changes summary: 0 Removed, 1 Changed, 0 Added function
    Variables changes summary: 0 Removed, 0 Changed, 0 Added variable

    1 function with some indirect sub-type change:

      [C]'function int add(int, int)' has some indirect sub-type changes:
	parameter 0 of type 'int' changed:
	  name changed from 'int' to 'float'
	parameter 1 of type 'int' changed:
	  name changed from 'int' to 'float'

Note how the change on the second parameter appears equal to the
change on the first.

	* src/abg-comparison.cc
	(diff_context::priv::priv): Show redundant changes by default.
	(categorize_redundancy): Do not categorize redundancy if the
	diff_context says that we shouldn't.
	* tools/abicompat.cc (options::show_redundant): New data member.
	(options::options): Initialize to true.
	(display_usage): Add new help string for new --no-redundant and
	--redundant options.
	(parse_command_line): Parse new --no-redundant and --redundant
	command line options.
	(main): Initialize the diff context with respect to the
	options::show_redundant property.
	* tools/abidiff.cc (options::options): Initialize the
	show_redundant_changes data member to true.
	(display_usage): Show new help string for the new --no-redundant
	command line option.
	(parse_command_line): Parse the new --no-redundant command line
	option.
	* tests/data/test-diff-filter/libtest23-redundant-fn-parm-change-v0.so:
	New test data input.
	* tests/data/test-diff-filter/libtest23-redundant-fn-parm-change-v1.so:
	Likewise.
	* tests/data/test-diff-filter/test23-redundant-fn-parm-change-report-0.txt:
	Likewise.
	* tests/data/test-diff-filter/test23-redundant-fn-parm-change-v0.c:
	Source code for the first binary above.
	* tests/data/test-diff-filter/test23-redundant-fn-parm-change-v1.c:
	Source code for the second binary above.
	* tests/data/Makefile.am: Add the new test data input to source
	distribution.
	* tests/test-abicompat.cc (in_out_specs): Add --no-redundant to
	abicompat when we don't want it to show redundant diff reports.
	* test-diff-filter.cc (in_out_specs): Likewise for abidiff.
	* test-diff-suppr.cc (in_out_specs): Likewise.

Signed-off-by: Dodji Seketeli <dodji@redhat.com>
2014-12-10 19:19:57 +01:00

385 lines
13 KiB
C++
Raw Blame History

// -*- Mode: C++ -*-
//
// Copyright (C) 2013-2014 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 test harness program runs a diff between input ELF files
/// containing DWARF debugging information, exercising the
/// suppressions features of the "bidiff" command line program.
///
/// So it runs the diff diff between the two input files, using a
/// suppression file and compares the resulting diff with a reference
/// one.
#include <cstring>
#include <string>
#include <fstream>
#include <iostream>
#include <cstdlib>
#include "abg-tools-utils.h"
#include "test-utils.h"
using std::string;
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_suppr_path;
const char* bidiff_options;
const char* in_report_path;
const char* out_report_path;
}; // end struct InOutSpec;
InOutSpec in_out_specs[] =
{
{
"data/test-diff-suppr/test0-type-suppr-v0.o",
"data/test-diff-suppr/test0-type-suppr-v1.o",
NULL,
"--no-redundant",
"data/test-diff-suppr/test0-type-suppr-report-0.txt",
"output/test-diff-suppr/test0-type-suppr-report-0.txt",
},
{
"data/test-diff-suppr/test0-type-suppr-v0.o",
"data/test-diff-suppr/test0-type-suppr-v1.o",
"data/test-diff-suppr/test0-type-suppr-0.suppr",
"--no-redundant",
"data/test-diff-suppr/test0-type-suppr-report-1.txt",
"output/test-diff-suppr/test0-type-suppr-report-1.txt",
},
{
"data/test-diff-suppr/test0-type-suppr-v0.o",
"data/test-diff-suppr/test0-type-suppr-v1.o",
"data/test-diff-suppr/test0-type-suppr-1.suppr",
"--no-redundant",
"data/test-diff-suppr/test0-type-suppr-report-2.txt",
"output/test-diff-suppr/test0-type-suppr-report-2.txt",
},
{
"data/test-diff-suppr/test0-type-suppr-v0.o",
"data/test-diff-suppr/test0-type-suppr-v1.o",
"data/test-diff-suppr/test0-type-suppr-2.suppr",
"--no-redundant",
"data/test-diff-suppr/test0-type-suppr-report-3.txt",
"output/test-diff-suppr/test0-type-suppr-report-3.txt",
},
{
"data/test-diff-suppr/test1-typedef-suppr-v0.o",
"data/test-diff-suppr/test1-typedef-suppr-v1.o",
"",
"--no-redundant",
"data/test-diff-suppr/test1-typedef-suppr-report-0.txt",
"output/test-diff-suppr/test1-typedef-suppr-report-0.txt",
},
{
"data/test-diff-suppr/test1-typedef-suppr-v0.o",
"data/test-diff-suppr/test1-typedef-suppr-v1.o",
"data/test-diff-suppr/test1-typedef-suppr-0.suppr",
"--no-redundant",
"data/test-diff-suppr/test1-typedef-suppr-report-1.txt",
"output/test-diff-suppr/test1-typedef-suppr-report-1.txt",
},
{
"data/test-diff-suppr/test1-typedef-suppr-v0.o",
"data/test-diff-suppr/test1-typedef-suppr-v1.o",
"data/test-diff-suppr/test1-typedef-suppr-1.suppr",
"--no-redundant",
"data/test-diff-suppr/test1-typedef-suppr-report-2.txt",
"output/test-diff-suppr/test1-typedef-suppr-report-2.txt",
},
{
"data/test-diff-suppr/test2-struct-suppr-v0.o",
"data/test-diff-suppr/test2-struct-suppr-v1.o",
"data/test-diff-suppr/test2-struct-suppr-0.suppr",
"--no-redundant",
"data/test-diff-suppr/test2-struct-suppr-report-0.txt",
"output/test-diff-suppr/test2-struct-suppr-report-0.txt",
},
{
"data/test-diff-suppr/test2-struct-suppr-v0.o",
"data/test-diff-suppr/test2-struct-suppr-v1.o",
"data/test-diff-suppr/test2-struct-suppr-1.suppr",
"--no-redundant",
"data/test-diff-suppr/test2-struct-suppr-report-1.txt",
"output/test-diff-suppr/test2-struct-suppr-report-1.txt",
},
{
"data/test-diff-suppr/test3-struct-suppr-v0.o",
"data/test-diff-suppr/test3-struct-suppr-v1.o",
NULL,
"--no-redundant",
"data/test-diff-suppr/test3-struct-suppr-report-0.txt",
"output/test-diff-suppr/test3-struct-suppr-report-0.txt",
},
{
"data/test-diff-suppr/test3-struct-suppr-v0.o",
"data/test-diff-suppr/test3-struct-suppr-v1.o",
"data/test-diff-suppr/test3-struct-suppr-0.suppr",
"--no-redundant",
"data/test-diff-suppr/test3-struct-suppr-report-1.txt",
"output/test-diff-suppr/test3-struct-suppr-report-1.txt",
},
{
"data/test-diff-suppr/test3-struct-suppr-v0.o",
"data/test-diff-suppr/test3-struct-suppr-v1.o",
"data/test-diff-suppr/test3-struct-suppr-1.suppr",
"--no-redundant",
"data/test-diff-suppr/test3-struct-suppr-report-2.txt",
"output/test-diff-suppr/test3-struct-suppr-report-2.txt",
},
{
"data/test-diff-suppr/libtest4-local-suppr-v0.so",
"data/test-diff-suppr/libtest4-local-suppr-v1.so",
"data/test-diff-suppr/test4-local-suppr-0.suppr",
"--no-redundant",
"data/test-diff-suppr/test4-local-suppr-report-1.txt",
"output/test-diff-suppr/test4-local-suppr-report-1.txt",
},
{
"data/test-diff-suppr/libtest4-local-suppr-v0.so",
"data/test-diff-suppr/libtest4-local-suppr-v1.so",
"",
"",
"data/test-diff-suppr/test4-local-suppr-report-0.txt",
"output/test-diff-suppr/test4-local-suppr-report-0.txt",
},
{
"data/test-diff-suppr/libtest5-fn-suppr-v0.so",
"data/test-diff-suppr/libtest5-fn-suppr-v1.so",
"",
"--no-redundant",
"data/test-diff-suppr/test5-fn-suppr-report-0.txt",
"output/test-diff-suppr/test5-fn-suppr-report-0.txt",
},
{
"data/test-diff-suppr/libtest5-fn-suppr-v0.so",
"data/test-diff-suppr/libtest5-fn-suppr-v1.so",
"data/test-diff-suppr/test5-fn-suppr-0.suppr",
"--no-redundant",
"data/test-diff-suppr/test5-fn-suppr-report-1.txt",
"output/test-diff-suppr/test5-fn-suppr-report-1.txt",
},
{
"data/test-diff-suppr/libtest5-fn-suppr-v0.so",
"data/test-diff-suppr/libtest5-fn-suppr-v1.so",
"data/test-diff-suppr/test5-fn-suppr-1.suppr",
"--no-redundant",
"data/test-diff-suppr/test5-fn-suppr-report-2.txt",
"output/test-diff-suppr/test5-fn-suppr-report-2.txt",
},
{
"data/test-diff-suppr/libtest5-fn-suppr-v0.so",
"data/test-diff-suppr/libtest5-fn-suppr-v1.so",
"data/test-diff-suppr/test5-fn-suppr-2.suppr",
"--no-redundant",
"data/test-diff-suppr/test5-fn-suppr-report-3.txt",
"output/test-diff-suppr/test5-fn-suppr-report-3.txt",
},
{
"data/test-diff-suppr/libtest5-fn-suppr-v0.so",
"data/test-diff-suppr/libtest5-fn-suppr-v1.so",
"data/test-diff-suppr/test5-fn-suppr-3.suppr",
"--no-redundant",
"data/test-diff-suppr/test5-fn-suppr-report-4.txt",
"output/test-diff-suppr/test5-fn-suppr-report-4.txt",
},
{
"data/test-diff-suppr/libtest5-fn-suppr-v0.so",
"data/test-diff-suppr/libtest5-fn-suppr-v1.so",
"data/test-diff-suppr/test5-fn-suppr-4.suppr",
"--no-redundant",
"data/test-diff-suppr/test5-fn-suppr-report-5.txt",
"output/test-diff-suppr/test5-fn-suppr-report-5.txt",
},
{
"data/test-diff-suppr/libtest6-fn-suppr-v0.so",
"data/test-diff-suppr/libtest6-fn-suppr-v1.so",
"",
"--no-redundant",
"data/test-diff-suppr/test6-fn-suppr-report-0.txt",
"output/test-diff-suppr/test6-fn-suppr-report-0.txt",
},
{
"data/test-diff-suppr/libtest6-fn-suppr-v0.so",
"data/test-diff-suppr/libtest6-fn-suppr-v1.so",
"data/test-diff-suppr/test6-fn-suppr-0.suppr",
"--no-redundant",
"data/test-diff-suppr/test6-fn-suppr-report-1.txt",
"output/test-diff-suppr/test6-fn-suppr-report-1.txt",
},
{
"data/test-diff-suppr/libtest6-fn-suppr-v0.so",
"data/test-diff-suppr/libtest6-fn-suppr-v1.so",
"data/test-diff-suppr/test6-fn-suppr-1.suppr",
"--no-redundant",
"data/test-diff-suppr/test6-fn-suppr-report-2.txt",
"output/test-diff-suppr/test6-fn-suppr-report-2.txt",
},
{
"data/test-diff-suppr/libtest6-fn-suppr-v0.so",
"data/test-diff-suppr/libtest6-fn-suppr-v1.so",
"data/test-diff-suppr/test6-fn-suppr-2.suppr",
"--no-redundant",
"data/test-diff-suppr/test6-fn-suppr-report-3.txt",
"output/test-diff-suppr/test6-fn-suppr-report-3.txt",
},
{
"data/test-diff-suppr/libtest7-var-suppr-v0.so",
"data/test-diff-suppr/libtest7-var-suppr-v1.so",
"",
"--no-redundant",
"data/test-diff-suppr/test7-var-suppr-report-0.txt",
"output/test-diff-suppr/test7-var-suppr-report-0.txt"
},
{
"data/test-diff-suppr/libtest7-var-suppr-v0.so",
"data/test-diff-suppr/libtest7-var-suppr-v1.so",
"data/test-diff-suppr/test7-var-suppr-1.suppr",
"--no-redundant",
"data/test-diff-suppr/test7-var-suppr-report-1.txt",
"output/test-diff-suppr/test7-var-suppr-report-1.txt"
},
{
"data/test-diff-suppr/libtest7-var-suppr-v0.so",
"data/test-diff-suppr/libtest7-var-suppr-v1.so",
"data/test-diff-suppr/test7-var-suppr-2.suppr",
"--no-redundant",
"data/test-diff-suppr/test7-var-suppr-report-2.txt",
"output/test-diff-suppr/test7-var-suppr-report-2.txt"
},
{
"data/test-diff-suppr/libtest7-var-suppr-v0.so",
"data/test-diff-suppr/libtest7-var-suppr-v1.so",
"data/test-diff-suppr/test7-var-suppr-3.suppr",
"--no-redundant",
"data/test-diff-suppr/test7-var-suppr-report-3.txt",
"output/test-diff-suppr/test7-var-suppr-report-3.txt"
},
{
"data/test-diff-suppr/libtest7-var-suppr-v0.so",
"data/test-diff-suppr/libtest7-var-suppr-v1.so",
"data/test-diff-suppr/test7-var-suppr-4.suppr",
"--no-redundant",
"data/test-diff-suppr/test7-var-suppr-report-4.txt",
"output/test-diff-suppr/test7-var-suppr-report-4.txt"
},
{
"data/test-diff-suppr/libtest7-var-suppr-v0.so",
"data/test-diff-suppr/libtest7-var-suppr-v1.so",
"data/test-diff-suppr/test7-var-suppr-5.suppr",
"--no-redundant",
"data/test-diff-suppr/test7-var-suppr-report-5.txt",
"output/test-diff-suppr/test7-var-suppr-report-5.txt"
},
{
"data/test-diff-suppr/libtest7-var-suppr-v0.so",
"data/test-diff-suppr/libtest7-var-suppr-v1.so",
"data/test-diff-suppr/test7-var-suppr-6.suppr",
"--no-redundant",
"data/test-diff-suppr/test7-var-suppr-report-6.txt",
"output/test-diff-suppr/test7-var-suppr-report-6.txt"
},
{
"data/test-diff-suppr/libtest7-var-suppr-v0.so",
"data/test-diff-suppr/libtest7-var-suppr-v1.so",
"data/test-diff-suppr/test7-var-suppr-7.suppr",
"--no-redundant",
"data/test-diff-suppr/test7-var-suppr-report-7.txt",
"output/test-diff-suppr/test7-var-suppr-report-7.txt"
},
{
"data/test-diff-suppr/libtest7-var-suppr-v0.so",
"data/test-diff-suppr/libtest7-var-suppr-v1.so",
"data/test-diff-suppr/test7-var-suppr-8.suppr",
"--no-redundant",
"data/test-diff-suppr/test7-var-suppr-report-8.txt",
"output/test-diff-suppr/test7-var-suppr-report-8.txt"
},
// This should be the last entry
{NULL, NULL, NULL, NULL, NULL, NULL}
};
int
main()
{
using abigail::tests::get_src_dir;
using abigail::tests::get_build_dir;
using abigail::tools::ensure_parent_dir_created;
bool is_ok = true;
string in_elfv0_path, in_elfv1_path,
in_suppression_path, bidiff_options, bidiff, cmd,
ref_diff_report_path, out_diff_report_path;
for (InOutSpec* s = in_out_specs; s->in_elfv0_path; ++s)
{
in_elfv0_path = get_src_dir() + "/tests/" + s->in_elfv0_path;
in_elfv1_path = get_src_dir() + "/tests/" + s->in_elfv1_path;
if (s->in_suppr_path && strcmp(s->in_suppr_path, ""))
in_suppression_path = get_src_dir() + "/tests/" + s->in_suppr_path;
else
in_suppression_path.clear();
bidiff_options = s->bidiff_options;
ref_diff_report_path = get_src_dir() + "/tests/" + s->in_report_path;
out_diff_report_path = 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;
}
bidiff = get_build_dir() + "/tools/abidiff";
bidiff += " " + bidiff_options;
if (!in_suppression_path.empty())
bidiff += " --suppressions " + in_suppression_path;
cmd = bidiff + " " + in_elfv0_path + " " + in_elfv1_path;
cmd += " > " + out_diff_report_path;
bool bidiff_ok = true;
if (system(cmd.c_str()))
bidiff_ok = false;
if (bidiff_ok)
{
cmd = "diff -u " + ref_diff_report_path
+ " " + out_diff_report_path;
if (system(cmd.c_str()))
is_ok = false;
}
else
is_ok = false;
}
return !is_ok;
}
Reference in New Issue View Git Blame Copy Permalink