mirror of
git://sourceware.org/git/libabigail.git
synced 2025-01-05 16:59:41 +00:00
7e18fc8ad8
Bug 28954 - add Linux Kernel symbol namespace support Each Linux kernel symbol can be exported to a specified named namespace or left in the global (nameless) namespace. One complexity is that the symbol values which identify a string in the __ksymtab_strings section must be interpretated differently for vmlinux and .ko loadable modules as the former has a fixed load address but the latter are relocatable. For vmlinux, the section base address needs to be subtracted to obtain a section-relative offset. The global namespace is explicitly represented as the empty string, at least when it comes to the value of __kstrtabns_FOO symbols, but the common interpretation is that such symbols lack an export namespace. I would rather not have to make use of "empty implies missing" in many places, so the code here represents namespace as optional<string> and only the symtab reader cares about empty strings in __ksymtab_strings. * include/abg-ir.h (elf_symbol::elf_symbol): Add ns argument. (elf_symbol::create): Add ns argument. (elf_symbol::get_namespace): Declare new function. (elf_symbol::set_namespace): Declare new function. and set_namespace. * src/abg-comp-filter.cc (namespace_changed): Define new helper functions. (categorize_harmful_diff_node): Also call namespace_changed(). * src/abg-ir.cc (elf_symbol::priv): Add namespace_ member. (elf_symbol::priv::priv): Add namespace_ to initialisers. (elf_symbol::elf_symbol): Take new ns argument and pass it to priv constructor. (elf_symbol::create): Take new ns argument and pass it to elf_symbol constructor. (elf_symbol::get_namespace): Define new function. (elf_symbol::set_namespace): Define new function. * src/abg-reader.cc (build_elf_symbol): If namespace attribute is present, set symbol namespace. * src/abg-reporter-priv.cc (maybe_report_diff_for_symbol): If symbol namespaces differ, report this. * src/abg-symtab-reader.cc (symtab::load): Get ELF header to distinguish vmlinux from .ko. Try to get __ksymtab_strings metadata and data. Use these to look up __kstrtabns_FOO namespace entries. Set symbol namespace where found. * src/abg-writer.cc (write_elf_symbol): Emit namespace attribute, if symbol has a namespace. * tests/data/Makefile.am: Add new test files. * tests/data/test-abidiff/test-namespace-0.xml: New test file. * tests/data/test-abidiff/test-namespace-1.xml: Likewise * tests/data/test-abidiff/test-namespace-report.txt: Likewise. * tests/test-abidiff.cc: Add new test case. Reviewed-by: Matthias Maennich <maennich@google.com> Signed-off-by: Giuliano Procida <gprocida@google.com>
283 lines
8.6 KiB
C++
283 lines
8.6 KiB
C++
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
|
|
// -*- Mode: C++ -*-
|
|
//
|
|
// Copyright (C) 2013-2022 Red Hat, Inc.
|
|
//
|
|
// Author: Dodji Seketeli
|
|
|
|
/// @file
|
|
///
|
|
/// This program runs a diff between input files and compares the
|
|
/// resulting report with a reference report. If the resulting report
|
|
/// is different from the reference report, the test has failed.
|
|
///
|
|
/// 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 "abg-reader.h"
|
|
#include "test-utils.h"
|
|
#include "abg-comparison.h"
|
|
#include "abg-corpus.h"
|
|
|
|
using std::string;
|
|
using std::ofstream;
|
|
using std::cerr;
|
|
|
|
struct InOutSpec
|
|
{
|
|
const char* first_in_path;
|
|
const char* second_in_path;
|
|
const char* ref_diff_path;
|
|
const char* out_path;
|
|
};// end struct InOutSpec
|
|
|
|
static InOutSpec specs[] =
|
|
{
|
|
{
|
|
"data/test-abidiff/test-enum0-v0.cc.bi",
|
|
"data/test-abidiff/test-enum0-v1.cc.bi",
|
|
"data/test-abidiff/test-enum0-report.txt",
|
|
"output/test-abidiff/test-enum0-report.txt"
|
|
},
|
|
{
|
|
"data/test-abidiff/test-enum1-v0.cc.bi",
|
|
"data/test-abidiff/test-enum1-v1.cc.bi",
|
|
"data/test-abidiff/test-enum1-report.txt",
|
|
"output/test-abidiff/test-enum1-report.txt"
|
|
},
|
|
{
|
|
"data/test-abidiff/test-qual-type0-v0.cc.bi",
|
|
"data/test-abidiff/test-qual-type0-v1.cc.bi",
|
|
"data/test-abidiff/test-qual-type0-report.txt",
|
|
"output/test-abidiff/test-qual-type0-report.txt"
|
|
},
|
|
{
|
|
"data/test-abidiff/test-struct0-v0.cc.bi",
|
|
"data/test-abidiff/test-struct0-v1.cc.bi",
|
|
"data/test-abidiff/test-struct0-report.txt",
|
|
"output/test-abidiff/test-struct0-report.txt"
|
|
},
|
|
{
|
|
"data/test-abidiff/test-struct1-v0.cc.bi",
|
|
"data/test-abidiff/test-struct1-v1.cc.bi",
|
|
"data/test-abidiff/test-struct1-report.txt",
|
|
"output/test-abidiff/test-struct1-report.txt"
|
|
},
|
|
{
|
|
"data/test-abidiff/test-var0-v0.cc.bi",
|
|
"data/test-abidiff/test-var0-v1.cc.bi",
|
|
"data/test-abidiff/test-var0-report.txt",
|
|
"output/test-abidiff/test-var0-report.txt"
|
|
},
|
|
{
|
|
"data/test-abidiff/test-PR18166-libtirpc.so.abi",
|
|
"data/test-abidiff/test-PR18166-libtirpc.so.abi",
|
|
"data/test-abidiff/empty-report.txt",
|
|
"output/test-abidiff/test-PR18166-libtirpc.so.report.txt"
|
|
},
|
|
{
|
|
"data/test-abidiff/test-PR18791-v0.so.abi",
|
|
"data/test-abidiff/test-PR18791-v1.so.abi",
|
|
"data/test-abidiff/test-PR18791-report0.txt",
|
|
"output/test-abidiff/test-PR18791-report0.txt"
|
|
},
|
|
{
|
|
"data/test-abidiff/test-PR24552-v0.abi",
|
|
"data/test-abidiff/test-PR24552-v1.abi",
|
|
"data/test-abidiff/empty-report.txt",
|
|
"output/test-abidiff/test-PR24552-report0.txt"
|
|
},
|
|
{
|
|
"data/test-abidiff/test-empty-corpus-0.xml",
|
|
"data/test-abidiff/test-empty-corpus-0.xml",
|
|
"data/test-abidiff/empty-report.txt",
|
|
"output/test-abidiff/test-empty-corpus-report-0.txt"
|
|
},
|
|
{
|
|
"data/test-abidiff/test-empty-corpus-1.xml",
|
|
"data/test-abidiff/test-empty-corpus-1.xml",
|
|
"data/test-abidiff/empty-report.txt",
|
|
"output/test-abidiff/test-empty-corpus-report-1.txt"
|
|
},
|
|
{
|
|
"data/test-abidiff/test-empty-corpus-2.xml",
|
|
"data/test-abidiff/test-empty-corpus-2.xml",
|
|
"data/test-abidiff/empty-report.txt",
|
|
"output/test-abidiff/test-empty-corpus-report-1.txt"
|
|
},
|
|
{
|
|
"data/test-abidiff/test-crc-0.xml",
|
|
"data/test-abidiff/test-crc-1.xml",
|
|
"data/test-abidiff/test-crc-report-0-1.txt",
|
|
"output/test-abidiff/test-crc-report-0-1.txt"
|
|
},
|
|
{
|
|
"data/test-abidiff/test-crc-1.xml",
|
|
"data/test-abidiff/test-crc-0.xml",
|
|
"data/test-abidiff/test-crc-report-1-0.txt",
|
|
"output/test-abidiff/test-crc-report-1-0.txt"
|
|
},
|
|
{
|
|
"data/test-abidiff/test-crc-1.xml",
|
|
"data/test-abidiff/test-crc-2.xml",
|
|
"data/test-abidiff/test-crc-report-1-2.txt",
|
|
"output/test-abidiff/test-crc-report-1-2.txt"
|
|
},
|
|
{
|
|
"data/test-abidiff/test-namespace-0.xml",
|
|
"data/test-abidiff/test-namespace-1.xml",
|
|
"data/test-abidiff/test-namespace-report.txt",
|
|
"output/test-abidiff/test-namespace-report-0-1.txt"
|
|
},
|
|
{
|
|
"data/test-abidiff/test-PR27616-v0.xml",
|
|
"data/test-abidiff/test-PR27616-v1.xml",
|
|
"data/test-abidiff/empty-report.txt",
|
|
"output/test-abidiff/empty-report.txt"
|
|
},
|
|
{
|
|
"data/test-abidiff/test-PR27616-squished-v0.abi",
|
|
"data/test-abidiff/test-PR27616-squished-v1.abi",
|
|
"data/test-abidiff/empty-report.txt",
|
|
"output/test-abidiff/empty-report.txt"
|
|
},
|
|
{
|
|
"data/test-abidiff/test-PR27985-v0.o.abi",
|
|
"data/test-abidiff/test-PR27985-v1.o.abi",
|
|
"data/test-abidiff/test-PR27985-report.txt",
|
|
"output/test-abidiff/test-PR27985-report.txt"
|
|
},
|
|
// This should be the last entry.
|
|
{0, 0, 0, 0}
|
|
};
|
|
|
|
#define NUM_SPEC_ELEMS \
|
|
((sizeof(specs) / sizeof(InOutSpec)) - 1)
|
|
|
|
using std::string;
|
|
using std::cerr;
|
|
using std::ofstream;
|
|
using abigail::tools_utils::file_type;
|
|
using abigail::tools_utils::check_file;
|
|
using abigail::tools_utils::guess_file_type;
|
|
using abigail::ir::environment;
|
|
using abigail::ir::environment_sptr;
|
|
using abigail::corpus_sptr;
|
|
using abigail::corpus_group_sptr;
|
|
using abigail::translation_unit;
|
|
using abigail::translation_unit_sptr;
|
|
using abigail::xml_reader::read_translation_unit_from_file;
|
|
using abigail::xml_reader::read_corpus_from_native_xml_file;
|
|
using abigail::xml_reader::read_corpus_group_from_native_xml_file;
|
|
using abigail::comparison::corpus_diff_sptr;
|
|
using abigail::comparison::translation_unit_diff_sptr;
|
|
using abigail::comparison::compute_diff;
|
|
using abigail::comparison::diff_context_sptr;
|
|
using abigail::comparison::diff_context;
|
|
|
|
int
|
|
main(int, char*[])
|
|
{
|
|
bool is_ok = true;
|
|
|
|
string out_path =
|
|
string(abigail::tests::get_build_dir()) + "/tests/" + specs->out_path;
|
|
if (!abigail::tools_utils::ensure_parent_dir_created(out_path))
|
|
{
|
|
cerr << "Could not create parent director for " << out_path;
|
|
return 1;
|
|
}
|
|
|
|
string first_in_path, second_in_path, ref_diff_path;
|
|
for (InOutSpec *s = specs; s->first_in_path; ++s)
|
|
{
|
|
first_in_path =
|
|
string(abigail::tests::get_src_dir()) + "/tests/" + s->first_in_path;
|
|
second_in_path =
|
|
string(abigail::tests::get_src_dir()) + "/tests/" + s->second_in_path;
|
|
ref_diff_path =
|
|
string(abigail::tests::get_src_dir()) + "/tests/" + s->ref_diff_path;
|
|
out_path =
|
|
string(abigail::tests::get_build_dir()) + "/tests/" + s->out_path;
|
|
|
|
if (!abigail::tools_utils::ensure_parent_dir_created(out_path))
|
|
{
|
|
cerr << "Could not create parent directory for " << out_path;
|
|
continue;
|
|
}
|
|
|
|
environment_sptr env(new environment);
|
|
translation_unit_sptr tu1, tu2;
|
|
corpus_sptr corpus1, corpus2;
|
|
corpus_group_sptr corpus_group1, corpus_group2;
|
|
file_type t = guess_file_type(first_in_path);
|
|
if (t == abigail::tools_utils::FILE_TYPE_NATIVE_BI)
|
|
tu1 = read_translation_unit_from_file(first_in_path, env.get());
|
|
else if (t == abigail::tools_utils::FILE_TYPE_XML_CORPUS)
|
|
corpus1 = read_corpus_from_native_xml_file(first_in_path, env.get());
|
|
else if (t == abigail::tools_utils::FILE_TYPE_XML_CORPUS_GROUP)
|
|
corpus_group1 = read_corpus_group_from_native_xml_file(first_in_path,
|
|
env.get());
|
|
else
|
|
abort();
|
|
if (!tu1 && !corpus1 && !corpus_group1)
|
|
{
|
|
cerr << "failed to read " << first_in_path << "\n";
|
|
is_ok = false;
|
|
continue;
|
|
}
|
|
|
|
t = guess_file_type(second_in_path);
|
|
if (t == abigail::tools_utils::FILE_TYPE_NATIVE_BI)
|
|
tu2 = read_translation_unit_from_file(second_in_path, env.get());
|
|
else if (t == abigail::tools_utils::FILE_TYPE_XML_CORPUS)
|
|
corpus2 = read_corpus_from_native_xml_file(second_in_path, env.get());
|
|
else if (t == abigail::tools_utils::FILE_TYPE_XML_CORPUS_GROUP)
|
|
corpus_group2 = read_corpus_group_from_native_xml_file(first_in_path,
|
|
env.get());
|
|
else
|
|
abort();
|
|
if (!tu2 && !corpus2 && !corpus_group2)
|
|
{
|
|
cerr << "failed to read " << second_in_path << "\n";
|
|
is_ok = false;
|
|
continue;
|
|
}
|
|
|
|
translation_unit_diff_sptr d1;
|
|
corpus_diff_sptr d2;
|
|
diff_context_sptr ctxt(new diff_context);
|
|
ctxt->show_locs(false);
|
|
if (tu1)
|
|
d1= compute_diff(tu1, tu2, ctxt);
|
|
else if (corpus1)
|
|
d2 = compute_diff(corpus1, corpus2, ctxt);
|
|
else if (corpus_group1)
|
|
d2 = compute_diff(corpus_group1, corpus_group2, ctxt);
|
|
ofstream of(out_path.c_str(), std::ios_base::trunc);
|
|
if (!of.is_open())
|
|
{
|
|
cerr << "failed to read " << s->out_path << "\n";
|
|
is_ok = false;
|
|
continue;
|
|
}
|
|
|
|
if (d1)
|
|
d1->report(of);
|
|
else
|
|
d2->report(of);
|
|
of.close();
|
|
|
|
string cmd = "diff -u " + ref_diff_path + " " + out_path;
|
|
if (system(cmd.c_str()))
|
|
is_ok = false;
|
|
}
|
|
|
|
return !is_ok;
|
|
}
|