libstdc++-v3/testsuite/util/testsuite_abi.cc

   1 // -*- C++ -*-
   2
   3 // Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011
   4 // Free Software Foundation, Inc.
   5
   6 // This library is free software; you can redistribute it and/or
   7 // modify it under the terms of the GNU General Public License as
   8 // published by the Free Software Foundation; either version 3, or (at
   9 // your option) any later version.
  10
  11 // This library is distributed in the hope that it will be useful, but
  12 // WITHOUT ANY WARRANTY; without even the implied warranty of
  13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 // General Public License for more details.
  15
  16 // You should have received a copy of the GNU General Public License
  17 // along with this library; see the file COPYING3.  If not see
  18 // <http://www.gnu.org/licenses/>.
  19
  20
  21 // Benjamin Kosnik  <bkoz@redhat.com>
  22
  23 #include "testsuite_abi.h"
  24 #include <cstdlib>
  25 #include <sstream>
  26 #include <fstream>
  27 #include <iostream>
  28 #include <vector>
  29 #include <algorithm>
  30
  31 using namespace std;
  32
  33 void
  34 symbol::init(string& data)
  35 {
  36   const char delim = ':';
  37   const char version_delim = '@';
  38   const string::size_type npos = string::npos;
  39   string::size_type n = 0;
  40
  41   // Set the type.
  42   if (data.find("FUNC") == 0)
  43     type = symbol::function;
  44   else if (data.find("OBJECT") == 0)
  45     type = symbol::object;
  46   else if (data.find("TLS") == 0)
  47     type = symbol::tls;
  48
  49   n = data.find_first_of(delim);
  50   if (n != npos)
  51     data.erase(data.begin(), data.begin() + n + 1);
  52
  53   // Iff object or TLS, get size info.
  54   if (type == symbol::object || type == symbol::tls)
  55     {
  56       n = data.find_first_of(delim);
  57       if (n != npos)
  58         {
  59           string objectsize(data.begin(), data.begin() + n);
  60           istringstream iss(objectsize);
  61           int x;
  62           iss >> x;
  63           if (!iss.fail())
  64             size = x;
  65           data.erase(data.begin(), data.begin() + n + 1);
  66         }
  67     }
  68
  69   // Set the name and raw_name.
  70   raw_name = string(data.begin(), data.end());
  71   n = data.find_first_of(version_delim);
  72   if (n != npos)
  73     {
  74       // Found version string.
  75       name = string(data.begin(), data.begin() + n);
  76       n = data.find_last_of(version_delim);
  77       data.erase(data.begin(), data.begin() + n + 1);
  78
  79       // Set version name.
  80       version_name = data;
  81     }
  82   else
  83     {
  84       // No versioning info.
  85       name = string(data.begin(), data.end());
  86       version_status = symbol::none;
  87     }
  88
  89   // Set the demangled name.
  90   demangled_name = demangle(name);
  91 }
  92
  93 void
  94 symbol::print() const
  95 {
  96   const char tab = '\t';
  97   cout << name << endl;
  98
  99   if (demangled_name != name)
 100     cout << demangled_name << endl;
 101
 102   string vers;
 103   switch (version_status)
 104     {
 105     case none:
 106       vers = "none";
 107       break;
 108     case compatible:
 109       vers = "compatible";
 110       break;
 111     case incompatible:
 112       vers = "incompatible";
 113       break;
 114      case unversioned:
 115       vers = "unversioned";
 116       break;
 117    default:
 118       vers = "<default>";
 119     }
 120   cout << "version status: " << vers << endl;
 121
 122   if (version_name.size()
 123       && (version_status == compatible || version_status == incompatible))
 124     cout << version_name << endl;
 125
 126   string type_string;
 127   switch (type)
 128     {
 129     case function:
 130       type_string = "function";
 131       break;
 132     case object:
 133       type_string = "object";
 134       break;
 135     case tls:
 136       type_string = "tls";
 137       break;
 138     case uncategorized:
 139       type_string = "uncategorized";
 140       break;
 141     default:
 142       type_string = "<default>";
 143     }
 144   cout << "type: " << type_string << endl;
 145
 146   if (type == object || type == tls)
 147     cout << "type size: " << size << endl;
 148
 149   string status_string;
 150   switch (status)
 151     {
 152     case added:
 153       status_string = "added";
 154       break;
 155     case subtracted:
 156       status_string = "subtracted";
 157       break;
 158     case undesignated:
 159       status_string = "undesignated";
 160       break;
 161     default:
 162       status_string = "<default>";
 163     }
 164   cout << "status: " << status_string << endl;
 165
 166   cout << endl;
 167 }
 168
 169
 170 bool
 171 check_version(symbol& test, bool added)
 172 {
 173   // Construct list of compatible versions.
 174   typedef std::vector<std::string> compat_list;
 175   static compat_list known_versions;
 176   if (known_versions.empty())
 177     {
 178       // NB: First version here must be the default version for this
 179       // version of DT_SONAME.
 180       known_versions.push_back("GLIBCXX_3.4");
 181       known_versions.push_back("GLIBCXX_3.4.1");
 182       known_versions.push_back("GLIBCXX_3.4.2");
 183       known_versions.push_back("GLIBCXX_3.4.3");
 184       known_versions.push_back("GLIBCXX_3.4.4");
 185       known_versions.push_back("GLIBCXX_3.4.5");
 186       known_versions.push_back("GLIBCXX_3.4.6");
 187       known_versions.push_back("GLIBCXX_3.4.7");
 188       known_versions.push_back("GLIBCXX_3.4.8");
 189       known_versions.push_back("GLIBCXX_3.4.9");
 190       known_versions.push_back("GLIBCXX_3.4.10");
 191       known_versions.push_back("GLIBCXX_3.4.11");
 192       known_versions.push_back("GLIBCXX_3.4.12");
 193       known_versions.push_back("GLIBCXX_3.4.13");
 194       known_versions.push_back("GLIBCXX_3.4.14");
 195       known_versions.push_back("GLIBCXX_3.4.15");
 196       known_versions.push_back("GLIBCXX_3.4.16");
 197       known_versions.push_back("GLIBCXX_3.4.17");
 198       known_versions.push_back("GLIBCXX_LDBL_3.4");
 199       known_versions.push_back("GLIBCXX_LDBL_3.4.7");
 200       known_versions.push_back("GLIBCXX_LDBL_3.4.10");
 201       known_versions.push_back("CXXABI_1.3");
 202       known_versions.push_back("CXXABI_1.3.1");
 203       known_versions.push_back("CXXABI_1.3.2");
 204       known_versions.push_back("CXXABI_1.3.3");
 205       known_versions.push_back("CXXABI_1.3.4");
 206       known_versions.push_back("CXXABI_1.3.5");
 207       known_versions.push_back("CXXABI_1.3.6");
 208       known_versions.push_back("CXXABI_LDBL_1.3");
 209     }
 210   compat_list::iterator begin = known_versions.begin();
 211   compat_list::iterator end = known_versions.end();
 212
 213   // Check for compatible version.
 214   if (test.version_name.size())
 215     {
 216       compat_list::iterator it1 = find(begin, end, test.version_name);
 217       compat_list::iterator it2 = find(begin, end, test.name);
 218       if (it1 != end)
 219         test.version_status = symbol::compatible;
 220       else
 221         test.version_status = symbol::incompatible;
 222
 223       // Check that added symbols aren't added in the base versions.
 224       if (added
 225           && (test.version_name == known_versions[0]
 226               || test.version_name == "CXXABI_1.3"
 227               || test.version_name == "GLIBCXX_LDBL_3.4"
 228               || test.version_name == "CXXABI_LDBL_1.3"))
 229         test.version_status = symbol::incompatible;
 230
 231       // Check that long double compatibility symbols demangled as
 232       // __float128 are put into some _LDBL_ version name.
 233       if (added && test.demangled_name.find("__float128") != std::string::npos)
 234         {
 235           // Has to be in _LDBL_ version name.
 236           if (test.version_name.find("_LDBL_") == std::string::npos)
 237             test.version_status = symbol::incompatible;
 238         }
 239
 240       // Check for weak label.
 241       if (it1 == end && it2 == end)
 242         test.version_status = symbol::incompatible;
 243
 244       // Check that
 245       // GLIBCXX_3.4
 246       // GLIBCXX_3.4.5
 247       // version as compatible
 248       // XXX
 249     }
 250   else
 251     {
 252       if (added)
 253         {
 254           // New version labels are ok. The rest are not.
 255           compat_list::iterator it2 = find(begin, end, test.name);
 256           if (it2 != end)
 257             test.version_status = symbol::compatible;
 258           else
 259             test.version_status = symbol::incompatible;
 260         }
 261     }
 262   return test.version_status == symbol::compatible;
 263 }
 264
 265 bool
 266 check_compatible(symbol& lhs, symbol& rhs, bool verbose)
 267 {
 268   bool ret = true;
 269   const char tab = '\t';
 270
 271   // Check to see if symbol_objects are compatible.
 272   if (lhs.type != rhs.type)
 273     {
 274       ret = false;
 275       if (verbose)
 276         cout << tab << "incompatible types" << endl;
 277     }
 278
 279   if (lhs.name != rhs.name)
 280     {
 281       ret = false;
 282       if (verbose)
 283         cout << tab << "incompatible names" << endl;
 284     }
 285
 286   if (lhs.size != rhs.size)
 287     {
 288       ret = false;
 289       if (verbose)
 290         {
 291           cout << tab << "incompatible sizes" << endl;
 292           cout << tab << lhs.size << endl;
 293           cout << tab << rhs.size << endl;
 294         }
 295     }
 296
 297   if (lhs.version_name != rhs.version_name
 298       && !check_version(lhs) && !check_version(rhs))
 299     {
 300       ret = false;
 301       if (verbose)
 302         {
 303           cout << tab << "incompatible versions" << endl;
 304           cout << tab << lhs.version_name << endl;
 305           cout << tab << rhs.version_name << endl;
 306         }
 307     }
 308
 309   if (verbose)
 310     cout << endl;
 311
 312   return ret;
 313 }
 314
 315
 316 inline bool
 317 has_symbol(const string& name, const symbols& s) throw()
 318 { return s.find(name) != s.end(); }
 319
 320 const symbol&
 321 get_symbol(const string& name, const symbols& s)
 322 {
 323   symbols::const_iterator i = s.find(name);
 324   if (i != s.end())
 325     {
 326       return i->second;
 327     }
 328   else
 329     {
 330       ostringstream os;
 331       os << "get_symbol failed for symbol " << name;
 332       __throw_logic_error(os.str().c_str());
 333     }
 334 }
 335
 336 void
 337 examine_symbol(const char* name, const char* file)
 338 {
 339   try
 340     {
 341       symbols s = create_symbols(file);
 342       const symbol& sym = get_symbol(name, s);
 343       sym.print();
 344     }
 345   catch(...)
 346     { __throw_exception_again; }
 347 }
 348
 349 int
 350 compare_symbols(const char* baseline_file, const char* test_file,
 351                 bool verbose)
 352 {
 353   // Input both lists of symbols into container.
 354   symbols baseline = create_symbols(baseline_file);
 355   symbols test = create_symbols(test_file);
 356
 357   //  Sanity check results.
 358   if (!baseline.size() || !test.size())
 359     {
 360       cerr << "Problems parsing the list of exported symbols." << endl;
 361       exit(2);
 362     }
 363
 364   // Check to see if any long double compatibility symbols are produced.
 365   bool ld_version_found(false);
 366   symbols::iterator li(test.begin());
 367   while (!ld_version_found && li != test.end())
 368     {
 369       if (li->second.version_name.find("_LDBL_") != std::string::npos)
 370         ld_version_found = true;
 371       ++li;
 372     }
 373
 374   // Sort out names.
 375   // Assuming all baseline names and test names are both unique w/ no
 376   // duplicates.
 377   //
 378   // The names added to missing_names are baseline names not found in
 379   // test names
 380   // -> symbols that have been deleted.
 381   //
 382   // The names added to added_names are test names not in
 383   // baseline names
 384   // -> symbols that have been added.
 385   typedef std::vector<std::string> symbol_names;
 386   symbol_names shared_names;
 387   symbol_names missing_names;
 388   symbol_names added_names;
 389   for (li = test.begin(); li != test.end(); ++li)
 390     added_names.push_back(li->first);
 391
 392   for (symbols::iterator i = baseline.begin(); i != baseline.end(); ++i)
 393     {
 394       string name(i->first);
 395       symbol_names::iterator end = added_names.end();
 396       symbol_names::iterator it = find(added_names.begin(), end, name);
 397       if (it != end)
 398         {
 399           // Found.
 400           shared_names.push_back(name);
 401           added_names.erase(it);
 402         }
 403        else
 404         {
 405           // Iff no test long double compatibility symbols at all and the symbol
 406           // missing is a baseline long double compatibility symbol, skip.
 407           string version_name(i->second.version_name);
 408           bool base_ld(version_name.find("_LDBL_") != std::string::npos);
 409           if (!base_ld || base_ld && ld_version_found)
 410             missing_names.push_back(name);
 411         }
 412     }
 413
 414   // Fill out list of incompatible symbols.
 415   typedef pair<symbol, symbol> symbol_pair;
 416   vector<symbol_pair> incompatible;
 417
 418   // Check missing names for compatibility.
 419   for (size_t j = 0; j < missing_names.size(); ++j)
 420     {
 421       symbol& sbase = baseline[missing_names[j]];
 422       sbase.status = symbol::subtracted;
 423       incompatible.push_back(symbol_pair(sbase, sbase));
 424     }
 425
 426   // Check shared names for compatibility.
 427   const symbol_names::size_type shared_size = shared_names.size();
 428   for (size_t k = 0; k < shared_size; ++k)
 429     {
 430       symbol& sbase = baseline[shared_names[k]];
 431       symbol& stest = test[shared_names[k]];
 432       stest.status = symbol::existing;
 433       if (!check_compatible(sbase, stest))
 434         incompatible.push_back(symbol_pair(sbase, stest));
 435     }
 436
 437   // Check added names for compatibility.
 438   const symbol_names::size_type added_size = added_names.size();
 439   for (size_t l = 0; l < added_size; ++l)
 440     {
 441       symbol& stest = test[added_names[l]];
 442       stest.status = symbol::added;
 443       if (!check_version(stest, true))
 444         incompatible.push_back(symbol_pair(stest, stest));
 445     }
 446
 447   // Report results.
 448   if (verbose && added_names.size())
 449     {
 450       cout << endl << added_names.size() << " added symbols " << endl;
 451       for (size_t j = 0; j < added_names.size() ; ++j)
 452         {
 453           cout << j << endl;
 454           test[added_names[j]].print();
 455         }
 456     }
 457
 458   if (verbose && missing_names.size())
 459     {
 460       cout << endl << missing_names.size() << " missing symbols " << endl;
 461       for (size_t j = 0; j < missing_names.size() ; ++j)
 462         {
 463           cout << j << endl;
 464           baseline[missing_names[j]].print();
 465         }
 466     }
 467
 468   if (verbose && incompatible.size())
 469     {
 470       cout << endl << incompatible.size() << " incompatible symbols " << endl;
 471       for (size_t j = 0; j < incompatible.size() ; ++j)
 472         {
 473           // First, print index.
 474           cout << j << endl;
 475
 476           // Second, report name.
 477           symbol& sbase = incompatible[j].first;
 478           symbol& stest = incompatible[j].second;
 479           stest.print();
 480
 481           // Second, report reason or reasons incompatible.
 482           check_compatible(sbase, stest, true);
 483         }
 484     }
 485
 486   cout << "\n\t\t=== libstdc++-v3 check-abi Summary ===" << endl;
 487   cout << endl;
 488   cout << "# of added symbols:\t\t " << added_names.size() << endl;
 489   cout << "# of missing symbols:\t\t " << missing_names.size() << endl;
 490   cout << "# of incompatible symbols:\t " << incompatible.size() << endl;
 491   cout << endl;
 492   cout << "using: " << baseline_file << endl;
 493
 494   return !(missing_names.size() || incompatible.size());
 495 }
 496
 497
 498 symbols
 499 create_symbols(const char* file)
 500 {
 501   symbols s;
 502   ifstream ifs(file);
 503   if (ifs.is_open())
 504     {
 505       // Organize file data into an associated container (symbols) of symbol
 506       // objects mapped to mangled names without versioning
 507       // information.
 508       const string empty;
 509       string line = empty;
 510       while (getline(ifs, line).good())
 511         {
 512           symbol tmp;
 513           tmp.init(line);
 514           s[tmp.name] = tmp;
 515           line = empty;
 516         }
 517     }
 518   else
 519     {
 520       ostringstream os;
 521       os << "create_symbols failed for file " << file;
 522       __throw_runtime_error(os.str().c_str());
 523     }
 524   return s;
 525 }
 526
 527
 528 const char*
 529 demangle(const std::string& mangled)
 530 {
 531   const char* name;
 532   if (mangled[0] != '_' || mangled[1] != 'Z')
 533     {
 534       // This is not a mangled symbol, thus has "C" linkage.
 535       name = mangled.c_str();
 536     }
 537   else
 538     {
 539       // Use __cxa_demangle to demangle.
 540       int status = 0;
 541       name = abi::__cxa_demangle(mangled.c_str(), 0, 0, &status);
 542       if (!name)
 543         {
 544           switch (status)
 545             {
 546             case 0:
 547               name = "error code = 0: success";
 548               break;
 549             case -1:
 550               name = "error code = -1: memory allocation failure";
 551               break;
 552             case -2:
 553               name = "error code = -2: invalid mangled name";
 554               break;
 555             case -3:
 556               name = "error code = -3: invalid arguments";
 557               break;
 558             default:
 559               name = "error code unknown - who knows what happened";
 560             }
 561         }
 562     }
 563   return name;
 564 }
 565