mirror of
git://sourceware.org/git/libabigail.git
synced 2024-12-20 17:00:36 +00:00
5b09ea77e2
While working on something else, it turned out that we need to cleanup (de-allocate) the map of canonical types when all the translation units that own types are de-allocated. Otherwise, when new translation units are created later, the types in the canonical types map become unrelated to the types in these new translation units, leading to memory management issues. This patch introduces a "usage watchdog" which detects when no translation unit uses the type system anymore. That usage watchdog is then used in the destructor of the translation_unit type to de-allocate the global data that is logically owned by by the type system. The patch also changes the API to read translation units and corpora in a way that forces users to get a handle on the resulting shared pointer. * include/abg-ir.h (type_base::canonical_types_map_type): Move this typedef into abg-ir.cc and out of the type_base namespace. (type_base::get_canonical_types_map): Likewise. * src/abg-ir.cc (canonical_types_map_type): New typedef that got moved here from type_base::canonical_types_map_type. (get_canonical_types_map): Likewise got moved here from type_base::get_canonical_types_map. Made static in the process. (class usage_watchdog): New type. (usage_watchdog_sptr, usage_watchdog_wptr): New typedefs. (get_usage_watchdog, get_usage_watchdog_wptr, ref_usage_watchdog) (maybe_cleanup_type_system_data): New static functions. (translation_unit::priv::usage_watchdog_): Add new data member. (translation_unit::priv::priv): Get a reference on the usage watchdog. (translation_unit::priv::~priv): If the usage watchdog says that the type system is not used, then cleanup the global data logically owned by the type system. * include/abg-dwarf-reader.h (read_corpus_from_elf): Make this return a corpus and set the status by reference using a parameter. * src/abg-dwarf-reader.cc (read_corpus_from_elf): Implement the above. * include/abg-reader.h (read_translation_unit_from_file) (read_translation_unit_from_buffer) (read_translation_unit_from_istream): Remove the overloads that do not return a translation_unit_sptr and that pass it as a parameter. Only keep the overloads that return a translation_unit_sptr, forcing users of the API to own a proper reference on the resulting translation_unit pointer. That is important to handle the life time of the global data of the type system that need to be cleared when the last translation unit is de-allocated. * src/abg-reader.cc (read_translation_unit_from_input): Make this return a translation_unit_sptr. (read_translation_unit_from_file) (read_translation_unit_from_buffer) (read_translation_unit_from_istream): Remove the overloads that do not return a translation_unit_sptr and that pass it as a parameter. Only keep the overloads that return a translation_unit_sptr. (read_to_translation_unit): Make this return a translation_unit_sptr. * tests/print-diff-tree.cc (main): Adjust. * tests/test-diff-dwarf.cc (main): Likewise. * tests/test-ir-walker.cc (main): Likewise. * tests/test-read-dwarf.cc (main): Likewise. * tests/test-read-write.cc (main): Likewise. * tools/abicompat.cc (main): Likewise. * tools/abidiff.cc (main): Likewise. * tools/abidw.cc (main): Likewise. * tools/abilint.cc (main): Likewise. Signed-off-by: Dodji Seketeli <dodji@redhat.com>
334 lines
10 KiB
C++
334 lines
10 KiB
C++
// -*- Mode: C++ -*-
|
|
//
|
|
// Copyright (C) 2013-2015 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"
|
|
},
|
|
// 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;
|
|
|
|
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 = get_src_dir() + "/tests/" + s->in_elfv0_path;
|
|
in_elfv1_path = get_src_dir() + "/tests/" + s->in_elfv1_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;
|
|
}
|
|
|
|
abigail::dwarf_reader::status status =
|
|
abigail::dwarf_reader::STATUS_UNKNOWN;
|
|
|
|
abigail::corpus_sptr corp0 =
|
|
read_corpus_from_elf(in_elfv0_path,
|
|
/*debug_info_root_path=*/0,
|
|
/*load_all_types=*/false,
|
|
status);
|
|
|
|
abigail::corpus_sptr corp1 =
|
|
read_corpus_from_elf(in_elfv1_path,
|
|
/*debug_info_root_path=*/0,
|
|
/*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);
|
|
|
|
corpus_diff_sptr d = compute_diff(corp0, corp1);
|
|
if (!d)
|
|
{
|
|
cerr << "failed to compute diff\n";
|
|
is_ok = false;
|
|
continue;
|
|
}
|
|
|
|
ref_diff_report_path = get_src_dir() + "/tests/" + s->in_report_path;
|
|
out_diff_report_path = 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;
|
|
}
|