mirror of
git://sourceware.org/git/libabigail.git
synced 2024-12-21 01:09:59 +00:00
fc55e7f343
As per https://sourceware.org/bugzilla/show_bug.cgi?id=18146, abidiff the exit code of abidiff and abicompat is now a bit field that can be inspected to know if the ABI change reported is incompatible for sure, or if it needs user review of the output to decide. This patch also updates the documentation. * doc/manuals/abicompat.rst: Update documentation for abicompat exit codes. * doc/manuals/abidiff.rst: Likewise for abidiff exit codes. * include/abg-tools-utils.h (enum abidiff_status): Declare new enum. (operator{|,&,|=}): Declare new operators for the new enum abidiff_status. (abidiff_status_has_error, abidiff_status_has_abi_change) (abidiff_status_has_incompatible_abi_change): Declare new functions. * src/abg-tools-utils.cc (operator{|,&,|=}): Define these new operators. (abidiff_status_has_error, abidiff_status_has_abi_change) (abidiff_status_has_incompatible_abi_change): Define new functions. * tests/test-diff-filter.cc (main): Adjust for the new exit code of abidiff. * tests/test-diff-suppr.cc (main): Likewise. * tests/test-abicompat.cc (main): Likewise. * tools/abicompat.cc (enum abicompat_status): Remove. (operator{|,&,|=}): Remove these operators for enum abicompat_status. (perform_compat_check_in_normal_mode) (perform_compat_check_in_weak_mode): Return abidiff_status instead of abicompat_status. Adjust therefore. (main): Adjust to return abidiff_status now, instead of a just zero for all non-error cases. * tools/abidiff.cc (main): Likewise. Signed-off-by: Dodji Seketeli <dodji@redhat.com>
127 lines
3.3 KiB
C++
127 lines
3.3 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/>.
|
|
|
|
///@file
|
|
|
|
#include <tr1/memory>
|
|
#include <string>
|
|
#include <ostream>
|
|
#include <istream>
|
|
|
|
namespace abigail
|
|
{
|
|
|
|
namespace tools_utils
|
|
{
|
|
|
|
using std::ostream;
|
|
using std::istream;
|
|
using std::ifstream;
|
|
using std::string;
|
|
|
|
bool file_exists(const string&);
|
|
bool is_regular_file(const string&);
|
|
bool is_dir(const string&);
|
|
bool base_name(string const& path,
|
|
string& file_name);
|
|
bool ensure_dir_path_created(const string&);
|
|
bool ensure_parent_dir_created(const string&);
|
|
bool check_file(const string& path, ostream& out);
|
|
|
|
/// The different types of files understood the bi* suite of tools.
|
|
enum file_type
|
|
{
|
|
/// A file type we don't know about.
|
|
FILE_TYPE_UNKNOWN,
|
|
/// The native xml file format representing a translation unit.
|
|
FILE_TYPE_NATIVE_BI,
|
|
/// An elf file. Read this kind of file should yield an
|
|
/// abigail::corpus type.
|
|
FILE_TYPE_ELF,
|
|
/// An archive (AR) file.
|
|
FILE_TYPE_AR,
|
|
// A native xml file format representing a corpus of one or several
|
|
// translation units.
|
|
FILE_TYPE_XML_CORPUS,
|
|
// A zip file, possibly containing a corpus of one of several
|
|
// translation units.
|
|
FILE_TYPE_ZIP_CORPUS,
|
|
};
|
|
|
|
/// Exit status for abidiff and abicompat tools.
|
|
///
|
|
/// It's actually a bit mask. The valu of each enumerator is a power
|
|
/// of two.
|
|
enum abidiff_status
|
|
{
|
|
/// This is for when the compared ABIs are equal.
|
|
///
|
|
/// Its numerical value is 0.
|
|
ABIDIFF_OK = 0,
|
|
|
|
/// This bit is set if there an application error.
|
|
///
|
|
/// Its numerical value is 1.
|
|
ABIDIFF_ERROR = 1,
|
|
|
|
/// This bit is set if the tool is invoked in an non appropriate
|
|
/// manner.
|
|
///
|
|
/// Its numerical value is 2.
|
|
ABIDIFF_USAGE_ERROR = 1 << 1,
|
|
|
|
/// This bit is set if the ABIs being compared are different.
|
|
///
|
|
/// Its numerical value is 4.
|
|
ABIDIFF_ABI_CHANGE = 1 << 2,
|
|
|
|
/// This bit is set if the ABIs being compared are different *and*
|
|
/// are incompatible.
|
|
///
|
|
/// Its numerical value is 8.
|
|
ABIDIFF_ABI_INCOMPATIBLE_CHANGE = 1 << 3
|
|
};
|
|
|
|
abidiff_status
|
|
operator|(abidiff_status, abidiff_status);
|
|
|
|
abidiff_status
|
|
operator&(abidiff_status, abidiff_status);
|
|
|
|
abidiff_status&
|
|
operator|=(abidiff_status&l, abidiff_status r);
|
|
bool
|
|
abidiff_status_has_error(abidiff_status s);
|
|
|
|
bool
|
|
abidiff_status_has_abi_change(abidiff_status s);
|
|
|
|
bool
|
|
abidiff_status_has_incompatible_abi_change(abidiff_status s);
|
|
|
|
file_type guess_file_type(istream& in);
|
|
file_type guess_file_type(const string& file_path);
|
|
|
|
std::tr1::shared_ptr<char>
|
|
make_path_absolute(const char*p);
|
|
|
|
}// end namespace tools_utils
|
|
}//end namespace abigail
|