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

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