libstdc++-v3/testsuite/abi_check.cc

   1 // Utility for libstdc++ ABI analysis -*- C++ -*-
   2
   3 // Copyright (C) 2002, 2003 Free Software Foundation, Inc.
   4 //
   5 // This file is part of the GNU ISO C++ Library.  This library is free
   6 // software; you can redistribute it and/or modify it under the
   7 // terms of the GNU General Public License as published by the
   8 // Free Software Foundation; either version 2, or (at your option)
   9 // any later version.
  10
  11 // This library is distributed in the hope that it will be useful,
  12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 // GNU General Public License for more details.
  15
  16 // You should have received a copy of the GNU General Public License along
  17 // with this library; see the file COPYING.  If not, write to the Free
  18 // Software Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307,
  19 // USA.
  20
  21 // As a special exception, you may use this file as part of a free software
  22 // library without restriction.  Specifically, if other files instantiate
  23 // templates or use macros or inline functions from this file, or you compile
  24 // this file and link it with other files to produce an executable, this
  25 // file does not by itself cause the resulting executable to be covered by
  26 // the GNU General Public License.  This exception does not however
  27 // invalidate any other reasons why the executable file might be covered by
  28 // the GNU General Public License.
  29
  30 // Benjamin Kosnik  <bkoz@redhat.com>
  31 // Blame subsequent hacks on Loren J. Rittle <ljrittle@acm.org>, Phil
  32 // Edwards <pme@gcc.gnu.org>, and a cast of dozens at libstdc++@gcc.gnu.org.
  33
  34 #include <string>
  35 #include <ext/hash_map>
  36 #include <deque>
  37 #include <sstream>
  38 #include <fstream>
  39 #include <iostream>
  40 #include <cxxabi.h>
  41 #include <stdlib.h>    // for system(3)
  42 #include <unistd.h>    // for access(2)
  43
  44 struct symbol_info
  45 {
  46   enum category { none, function, object, error };
  47   category      type;
  48   std::string   name;
  49   std::string   demangled_name;
  50   int           size;
  51   std::string   version_name;
  52
  53   symbol_info() : type(none), size(0) { }
  54
  55   symbol_info(const symbol_info& other)
  56   : type(other.type), name(other.name), demangled_name(other.demangled_name),
  57    size(other.size), version_name(other.version_name) { }
  58 };
  59
  60 namespace __gnu_cxx
  61 {
  62   using namespace std;
  63
  64   template<>
  65     struct hash<string>
  66     {
  67       size_t operator()(const string& s) const
  68       {
  69         const collate<char>& c = use_facet<collate<char> >(locale::classic());
  70         return c.hash(s.c_str(), s.c_str() + s.size());
  71       }
  72     };
  73 }
  74
  75 typedef std::deque<std::string>                         symbol_names;
  76 typedef __gnu_cxx::hash_map<std::string, symbol_info>   symbol_infos;
  77
  78
  79 bool
  80 check_version(const symbol_info& test)
  81 {
  82   bool ret = true;
  83
  84   typedef std::vector<std::string> compat_list;
  85   static compat_list known;
  86   if (known.empty())
  87     {
  88       known.push_back("GLIBCPP_3.2");
  89       known.push_back("GLIBCPP_3.2.1");
  90       known.push_back("GLIBCPP_3.2.2");
  91       known.push_back("GLIBCPP_3.4");
  92       known.push_back("CXXABI_1.2");
  93       known.push_back("CXXABI_1.2.1");
  94       known.push_back("CXXABI_1.3");
  95     }
  96
  97   compat_list::iterator end = known.end();
  98
  99   // Check version names for compatibility...
 100   compat_list::iterator it1 = find(known.begin(), end, test.version_name);
 101
 102   // Check for weak label.
 103   compat_list::iterator it2 = find(known.begin(), end, test.name);
 104   if (it1 != end || it2 != end)
 105     ret = true;
 106
 107   return ret;
 108 }
 109
 110 bool
 111 check_compatible(const symbol_info& lhs, const symbol_info& rhs,
 112                  bool verbose = false)
 113 {
 114   using namespace std;
 115   bool ret = true;
 116   const char tab = '\t';
 117
 118   // Check to see if symbol_infos are compatible.
 119   if (lhs.type != rhs.type)
 120     {
 121       ret = false;
 122       if (verbose)
 123         {
 124           cout << tab << "incompatible types" << endl;
 125         }
 126     }
 127
 128   if (lhs.name != rhs.name)
 129     {
 130       ret = false;
 131       if (verbose)
 132         {
 133           cout << tab << "incompatible names" << endl;
 134         }
 135     }
 136
 137   if (lhs.size != rhs.size)
 138     {
 139       ret = false;
 140       if (verbose)
 141         {
 142           cout << tab << "incompatible sizes" << endl;
 143           cout << tab << lhs.size << endl;
 144           cout << tab << rhs.size << endl;
 145         }
 146     }
 147
 148   if (lhs.version_name != rhs.version_name
 149       && !check_version(lhs) && !check_version(rhs))
 150     {
 151       ret = false;
 152       if (verbose)
 153         {
 154           cout << tab << "incompatible versions" << endl;
 155           cout << tab << lhs.version_name << endl;
 156           cout << tab << rhs.version_name << endl;
 157         }
 158     }
 159
 160   if (verbose)
 161     cout << endl;
 162
 163   return ret;
 164 }
 165
 166 const char*
 167 demangle(const std::string& mangled)
 168 {
 169   const char* name;
 170   if (mangled[0] != '_' || mangled[1] != 'Z')
 171     {
 172       // This is not a mangled symbol, thus has "C" linkage.
 173       name = mangled.c_str();
 174     }
 175   else
 176     {
 177       // Use __cxa_demangle to demangle.
 178       int status = 0;
 179       name = abi::__cxa_demangle(mangled.c_str(), 0, 0, &status);
 180       if (!name)
 181         {
 182           switch (status)
 183             {
 184             case 0:
 185               name = "error code = 0: success";
 186               break;
 187             case -1:
 188               name = "error code = -1: memory allocation failure";
 189               break;
 190             case -2:
 191               name = "error code = -2: invalid mangled name";
 192               break;
 193             case -3:
 194               name = "error code = -3: invalid arguments";
 195               break;
 196             default:
 197               name = "error code unknown - who knows what happened";
 198             }
 199         }
 200     }
 201   return name;
 202 }
 203
 204 void
 205 line_to_symbol_info(std::string& input, symbol_info& output)
 206 {
 207   using namespace std;
 208   const char delim = ':';
 209   const char version_delim = '@';
 210   const string::size_type npos = string::npos;
 211   string::size_type n = 0;
 212
 213   // Set the type.
 214   if (input.find("FUNC") == 0)
 215     output.type = symbol_info::function;
 216   else if (input.find("OBJECT") == 0)
 217     output.type = symbol_info::object;
 218   else
 219     output.type = symbol_info::error;
 220   n = input.find_first_of(delim);
 221   if (n != npos)
 222     input.erase(input.begin(), input.begin() + n + 1);
 223
 224   // Iff object, get size info.
 225   if (output.type == symbol_info::object)
 226     {
 227       n = input.find_first_of(delim);
 228       if (n != npos)
 229         {
 230           string size(input.begin(), input.begin() + n);
 231           istringstream iss(size);
 232           int x;
 233           iss >> x;
 234           if (!iss.fail())
 235             output.size = x;
 236           input.erase(input.begin(), input.begin() + n + 1);
 237         }
 238     }
 239
 240   // Set the name.
 241   n = input.find_first_of(version_delim);
 242   if (n != npos)
 243     {
 244       // Found version string.
 245       output.name = string(input.begin(), input.begin() + n);
 246       n = input.find_last_of(version_delim);
 247       input.erase(input.begin(), input.begin() + n + 1);
 248
 249       // Set version name.
 250       output.version_name = input;
 251     }
 252   else
 253     {
 254       // No versioning info.
 255       output.name = string(input.begin(), input.end());
 256       input.erase(input.begin(), input.end());
 257     }
 258
 259   // Set the demangled name.
 260   output.demangled_name = demangle(output.name);
 261 }
 262
 263 void
 264 create_symbol_data(const char* file, symbol_infos& symbols,
 265                    symbol_names& names)
 266 {
 267   // Parse list of symbols in file into vectors of symbol_info.
 268   // For 3.2.0 on x86/linux, this usually is
 269   // 947 non-weak symbols
 270   // 2084 weak symbols
 271   using namespace std;
 272   ifstream ifs(file);
 273   if (ifs.is_open())
 274     {
 275       // Organize input into container of symbol_info objects.
 276       const string empty;
 277       string line = empty;
 278       while (getline(ifs, line).good())
 279         {
 280           symbol_info symbol;
 281           line_to_symbol_info(line, symbol);
 282           symbols[symbol.name] = symbol;
 283           names.push_back(symbol.name);
 284           line = empty;
 285         }
 286     }
 287 }
 288
 289 void
 290 report_symbol_info(const symbol_info& symbol, std::size_t n, bool ret = true)
 291 {
 292   using namespace std;
 293   const char tab = '\t';
 294   cout << tab << n << endl;
 295   cout << tab << "symbol"<< endl;
 296   cout << tab << symbol.name << endl;
 297
 298   // Add any other information to display here.
 299   cout << tab << "demangled symbol"<< endl;
 300   cout << tab << symbol.demangled_name << endl;
 301
 302   if (ret)
 303     cout << endl;
 304 }
 305
 306
 307 int
 308 main(int argc, char** argv)
 309 {
 310   using namespace std;
 311
 312   // Get arguments.  (Heading towards getopt_long, I can feel it.)
 313   string argv1;
 314   if (argc < 4 || (string("--help") == (argv1 = argv[1])))
 315     {
 316       cerr << "Usage:  abi_check --check    cur baseline\n"
 317               "                  --help\n\n"
 318               "Where CUR is a file containing the current results from\n"
 319               "extract_symvers, and BASELINE is one from config/abi.\n"
 320            << endl;
 321       exit(1);
 322     }
 323
 324
 325   // Quick sanity/setup check for arguments.
 326   const char* test_file = argv[2];
 327   const char* baseline_file = argv[3];
 328   if (access(test_file, R_OK) != 0)
 329     {
 330       cerr << "Cannot read symbols file " << test_file
 331            << ", did you forget to build first?" << endl;
 332       exit(1);
 333     }
 334   if (access(baseline_file, R_OK) != 0)
 335     {
 336       cerr << "Cannot read baseline file " << baseline_file << endl;
 337       exit(1);
 338     }
 339
 340   // Input both lists of symbols into container.
 341   symbol_infos  baseline_symbols;
 342   symbol_names  baseline_names;
 343   symbol_infos  test_symbols;
 344   symbol_names  test_names;
 345   create_symbol_data(baseline_file, baseline_symbols, baseline_names);
 346   create_symbol_data(test_file, test_symbols, test_names);
 347
 348   //  Sanity check results.
 349   const symbol_names::size_type baseline_size = baseline_names.size();
 350   const symbol_names::size_type test_size = test_names.size();
 351   if (!baseline_size || !test_size)
 352     {
 353       cerr << "Problems parsing the list of exported symbols." << endl;
 354       exit(2);
 355     }
 356
 357   // Sort out names.
 358   // Assuming baseline_names, test_names are both unique w/ no duplicates.
 359   //
 360   // The names added to missing_names are baseline_names not found in
 361   // test_names
 362   // -> symbols that have been deleted.
 363   //
 364   // The names added to added_names are test_names are names not in
 365   // baseline_names
 366   // -> symbols that have been added.
 367   symbol_names shared_names;
 368   symbol_names missing_names;
 369   symbol_names added_names = test_names;
 370   for (size_t i = 0; i < baseline_size; ++i)
 371     {
 372       string what(baseline_names[i]);
 373       symbol_names::iterator end = added_names.end();
 374       symbol_names::iterator it = find(added_names.begin(), end, what);
 375       if (it != end)
 376         {
 377           // Found.
 378           shared_names.push_back(what);
 379           added_names.erase(it);
 380         }
 381       else
 382         missing_names.push_back(what);
 383     }
 384
 385   // Check shared names for compatibility.
 386   typedef pair<symbol_info, symbol_info> symbol_pair;
 387   vector<symbol_pair> incompatible;
 388   for (size_t i = 0; i < shared_names.size(); ++i)
 389     {
 390       symbol_info base = baseline_symbols[shared_names[i]];
 391       symbol_info test = test_symbols[shared_names[i]];
 392       if (!check_compatible(base, test))
 393         incompatible.push_back(symbol_pair(base, test));
 394     }
 395
 396   // Check added names for compatibility.
 397   for (size_t i = 0; i < added_names.size(); ++i)
 398     {
 399       symbol_info test = test_symbols[added_names[i]];
 400       if (!check_version(test))
 401         {
 402           incompatible.push_back(symbol_pair(test, test));
 403           cout << test.version_name << endl;
 404         }
 405     }
 406
 407   // Report results.
 408   cout << added_names.size() << " added symbols " << endl;
 409   for (size_t j = 0; j < added_names.size() ; ++j)
 410     report_symbol_info(test_symbols[added_names[j]], j + 1);
 411
 412   cout << missing_names.size() << " missing symbols " << endl;
 413   for (size_t j = 0; j < missing_names.size() ; ++j)
 414     report_symbol_info(baseline_symbols[missing_names[j]], j + 1);
 415
 416   cout << incompatible.size() << " incompatible symbols " << endl;
 417   for (size_t j = 0; j < incompatible.size() ; ++j)
 418     {
 419       // First, report name.
 420       const symbol_info& base = incompatible[j].first;
 421       const symbol_info& test = incompatible[j].second;
 422       report_symbol_info(test, j + 1, false);
 423
 424       // Second, report reason or reasons incompatible.
 425       check_compatible(base, test, true);
 426     }
 427
 428   return 0;
 429 }