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

   1 // -*- C++ -*-
   2
   3 // Copyright (C) 2004-2017 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_LDBL_3.4.21");
 205       known_versions.push_back("GLIBCXX_3.4.22");
 206       known_versions.push_back("GLIBCXX_3.4.23");
 207       known_versions.push_back("GLIBCXX_3.4.24");
 208       known_versions.push_back("GLIBCXX_3.4.25");
 209       known_versions.push_back("CXXABI_1.3");
 210       known_versions.push_back("CXXABI_LDBL_1.3");
 211       known_versions.push_back("CXXABI_1.3.1");
 212       known_versions.push_back("CXXABI_1.3.2");
 213       known_versions.push_back("CXXABI_1.3.3");
 214       known_versions.push_back("CXXABI_1.3.4");
 215       known_versions.push_back("CXXABI_1.3.5");
 216       known_versions.push_back("CXXABI_1.3.6");
 217       known_versions.push_back("CXXABI_1.3.7");
 218       known_versions.push_back("CXXABI_1.3.8");
 219       known_versions.push_back("CXXABI_1.3.9");
 220       known_versions.push_back("CXXABI_1.3.10");
 221       known_versions.push_back("CXXABI_1.3.11");
 222       known_versions.push_back("CXXABI_TM_1");
 223       known_versions.push_back("CXXABI_FLOAT128");
 224     }
 225   compat_list::iterator begin = known_versions.begin();
 226   compat_list::iterator end = known_versions.end();
 227
 228   // Check for compatible version.
 229   if (test.version_name.size())
 230     {
 231       compat_list::iterator it1 = find(begin, end, test.version_name);
 232       compat_list::iterator it2 = find(begin, end, test.name);
 233       if (it1 != end)
 234         test.version_status = symbol::compatible;
 235       else
 236         test.version_status = symbol::incompatible;
 237
 238       // Check that added symbols are added in the latest pre-release version.
 239       bool latestp = (test.version_name == "GLIBCXX_3.4.25"
 240                      || test.version_name == "CXXABI_1.3.11"
 241                      || test.version_name == "CXXABI_FLOAT128"
 242                      || test.version_name == "CXXABI_TM_1");
 243       if (added && !latestp)
 244         test.version_status = symbol::incompatible;
 245
 246       // Check that long double compatibility symbols demangled as
 247       // __float128 and regular __float128 symbols are put into some _LDBL_
 248       // or _FLOAT128 version name.
 249       if (added && test.demangled_name.find("__float128") != std::string::npos
 250           && test.demangled_name.find("std::__cxx11::") != 0)
 251         {
 252           if (test.version_name.find("_LDBL_") == std::string::npos
 253               && test.version_name.find("_FLOAT128") == std::string::npos)
 254             test.version_status = symbol::incompatible;
 255         }
 256
 257       // Check for weak label.
 258       if (it1 == end && it2 == end)
 259         test.version_status = symbol::incompatible;
 260
 261       // Check that
 262       // GLIBCXX_3.4
 263       // GLIBCXX_3.4.5
 264       // version as compatible
 265       // XXX
 266     }
 267   else
 268     {
 269       if (added)
 270         {
 271           // New version labels are ok. The rest are not.
 272           compat_list::iterator it2 = find(begin, end, test.name);
 273           if (it2 != end)
 274             test.version_status = symbol::compatible;
 275           else
 276             test.version_status = symbol::incompatible;
 277         }
 278     }
 279   return test.version_status == symbol::compatible;
 280 }
 281
 282 bool
 283 check_compatible(symbol& lhs, symbol& rhs, bool verbose)
 284 {
 285   bool ret = true;
 286   const char tab = '\t';
 287
 288   // Check to see if symbol_objects are compatible.
 289   if (lhs.type != rhs.type)
 290     {
 291       ret = false;
 292       if (verbose)
 293         cout << tab << "incompatible types" << endl;
 294     }
 295
 296   if (lhs.name != rhs.name)
 297     {
 298       ret = false;
 299       if (verbose)
 300         cout << tab << "incompatible names" << endl;
 301     }
 302
 303   if (lhs.size != rhs.size)
 304     {
 305       ret = false;
 306       if (verbose)
 307         {
 308           cout << tab << "incompatible sizes" << endl;
 309           cout << tab << lhs.size << endl;
 310           cout << tab << rhs.size << endl;
 311         }
 312     }
 313
 314   if (lhs.version_name != rhs.version_name
 315       && !check_version(lhs) && !check_version(rhs))
 316     {
 317       ret = false;
 318       if (verbose)
 319         {
 320           cout << tab << "incompatible versions" << endl;
 321           cout << tab << lhs.version_name << endl;
 322           cout << tab << rhs.version_name << endl;
 323         }
 324     }
 325
 326   if (verbose)
 327     cout << endl;
 328
 329   return ret;
 330 }
 331
 332
 333 inline bool
 334 has_symbol(const string& name, const symbols& s) throw()
 335 { return s.find(name) != s.end(); }
 336
 337 const symbol&
 338 get_symbol(const string& name, const symbols& s)
 339 {
 340   symbols::const_iterator i = s.find(name);
 341   if (i != s.end())
 342     {
 343       return i->second;
 344     }
 345   else
 346     {
 347       ostringstream os;
 348       os << "get_symbol failed for symbol " << name;
 349       __throw_logic_error(os.str().c_str());
 350     }
 351 }
 352
 353 void
 354 examine_symbol(const char* name, const char* file)
 355 {
 356   try
 357     {
 358       symbols s = create_symbols(file);
 359       const symbol& sym = get_symbol(name, s);
 360       sym.print();
 361     }
 362   catch(...)
 363     { __throw_exception_again; }
 364 }
 365
 366 int
 367 compare_symbols(const char* baseline_file, const char* test_file,
 368                 bool verbose)
 369 {
 370   // Input both lists of symbols into container.
 371   symbols baseline = create_symbols(baseline_file);
 372   symbols test = create_symbols(test_file);
 373
 374   //  Sanity check results.
 375   if (!baseline.size() || !test.size())
 376     {
 377       cerr << "Problems parsing the list of exported symbols." << endl;
 378       exit(2);
 379     }
 380
 381   // Check to see if any long double compatibility symbols are produced.
 382   bool ld_version_found(false);
 383   symbols::iterator li(test.begin());
 384   while (!ld_version_found && li != test.end())
 385     {
 386       if (li->second.version_name.find("_LDBL_") != std::string::npos)
 387         ld_version_found = true;
 388       ++li;
 389     }
 390
 391   // Sort out names.
 392   // Assuming all baseline names and test names are both unique w/ no
 393   // duplicates.
 394   //
 395   // The names added to missing_names are baseline names not found in
 396   // test names
 397   // -> symbols that have been deleted.
 398   //
 399   // The names added to added_names are test names not in
 400   // baseline names
 401   // -> symbols that have been added.
 402   typedef std::vector<std::string> symbol_names;
 403   symbol_names shared_names;
 404   symbol_names missing_names;
 405   symbol_names added_names;
 406   for (li = test.begin(); li != test.end(); ++li)
 407     added_names.push_back(li->first);
 408
 409   for (symbols::iterator i = baseline.begin(); i != baseline.end(); ++i)
 410     {
 411       string name(i->first);
 412       symbol_names::iterator end = added_names.end();
 413       symbol_names::iterator it = find(added_names.begin(), end, name);
 414       if (it != end)
 415         {
 416           // Found.
 417           shared_names.push_back(name);
 418           added_names.erase(it);
 419         }
 420        else
 421         {
 422           // Iff no test long double compatibility symbols at all and the symbol
 423           // missing is a baseline long double compatibility symbol, skip.
 424           string version_name(i->second.version_name);
 425           bool base_ld(version_name.find("_LDBL_") != std::string::npos);
 426           if (!base_ld || base_ld && ld_version_found)
 427             missing_names.push_back(name);
 428         }
 429     }
 430
 431   // Fill out list of incompatible symbols.
 432   typedef pair<symbol, symbol> symbol_pair;
 433   vector<symbol_pair> incompatible;
 434
 435   // Fill out list of undesignated symbols.
 436   vector<symbol> undesignated;
 437
 438   // Check missing names for compatibility.
 439   for (size_t j = 0; j < missing_names.size(); ++j)
 440     {
 441       symbol& sbase = baseline[missing_names[j]];
 442       sbase.status = symbol::subtracted;
 443       incompatible.push_back(symbol_pair(sbase, sbase));
 444     }
 445
 446   // Check shared names for compatibility.
 447   const symbol_names::size_type shared_size = shared_names.size();
 448   for (size_t k = 0; k < shared_size; ++k)
 449     {
 450       symbol& sbase = baseline[shared_names[k]];
 451       symbol& stest = test[shared_names[k]];
 452       stest.status = symbol::existing;
 453       if (!check_compatible(sbase, stest))
 454         incompatible.push_back(symbol_pair(sbase, stest));
 455     }
 456
 457   // Check added names for compatibility.
 458   const symbol_names::size_type added_size = added_names.size();
 459   for (size_t l = 0; l < added_size; ++l)
 460     {
 461       symbol& stest = test[added_names[l]];
 462
 463       // Mark TLS as undesignated, remove from added.
 464       if (stest.type == symbol::tls)
 465         {
 466           stest.status = symbol::undesignated;
 467           if (!check_version(stest, false))
 468             incompatible.push_back(symbol_pair(stest, stest));
 469           else
 470             undesignated.push_back(stest);
 471         }
 472       else
 473         {
 474           stest.status = symbol::added;
 475           if (!check_version(stest, true))
 476             incompatible.push_back(symbol_pair(stest, stest));
 477         }
 478     }
 479
 480   // Normalize added names and undesignated names.
 481   const size_t undesignated_size = undesignated.size();
 482   for (size_t l = 0; l < undesignated_size; ++l)
 483     {
 484       symbol& sundes = undesignated[l];
 485       symbol_names::iterator end = added_names.end();
 486       symbol_names::iterator it = find(added_names.begin(), end, sundes.name);
 487        if (it != end)
 488         {
 489           // Found.
 490           added_names.erase(it);
 491         }
 492        else
 493          __throw_runtime_error(sundes.name.c_str());
 494     }
 495
 496
 497   // Report results.
 498   if (verbose && added_names.size())
 499     {
 500       cout << endl << added_names.size() << " added symbols " << endl;
 501       for (size_t j = 0; j < added_names.size() ; ++j)
 502         {
 503           cout << j << endl;
 504           test[added_names[j]].print();
 505         }
 506     }
 507
 508   if (verbose && missing_names.size())
 509     {
 510       cout << endl << missing_names.size() << " missing symbols " << endl;
 511       for (size_t j = 0; j < missing_names.size() ; ++j)
 512         {
 513           cout << j << endl;
 514           baseline[missing_names[j]].print();
 515         }
 516     }
 517
 518   if (verbose && undesignated.size())
 519     {
 520       cout << endl << undesignated.size() << " undesignated symbols " << endl;
 521       for (size_t j = 0; j < undesignated.size() ; ++j)
 522         {
 523           // First, print index.
 524           cout << j << endl;
 525
 526           // Second, report name.
 527           symbol& s = undesignated[j];
 528           s.print();
 529         }
 530     }
 531
 532   if (verbose && incompatible.size())
 533     {
 534       cout << endl << incompatible.size() << " incompatible symbols " << endl;
 535       for (size_t j = 0; j < incompatible.size() ; ++j)
 536         {
 537           // First, print index.
 538           cout << j << endl;
 539
 540           // Second, report name.
 541           symbol& sbase = incompatible[j].first;
 542           symbol& stest = incompatible[j].second;
 543           stest.print();
 544
 545           // Third, report reason or reasons incompatible.
 546           check_compatible(sbase, stest, true);
 547         }
 548     }
 549
 550   cout << "\n\t\t==== libstdc++-v3 check-abi Summary ====" << endl;
 551   cout << endl;
 552   cout << "# of added symbols:\t\t " << added_names.size() << endl;
 553   cout << "# of missing symbols:\t\t " << missing_names.size() << endl;
 554   cout << "# of undesignated symbols:\t " << undesignated.size() << endl;
 555   cout << "# of incompatible symbols:\t " << incompatible.size() << endl;
 556   cout << endl;
 557   cout << "using: " << baseline_file << endl;
 558
 559   return !(missing_names.size() || incompatible.size());
 560 }
 561
 562
 563 symbols
 564 create_symbols(const char* file)
 565 {
 566   symbols s;
 567   ifstream ifs(file);
 568   if (ifs.is_open())
 569     {
 570       // Organize file data into an associated container (symbols) of symbol
 571       // objects mapped to mangled names without versioning
 572       // information.
 573       const string empty;
 574       string line = empty;
 575       while (getline(ifs, line).good())
 576         {
 577           symbol tmp;
 578           tmp.init(line);
 579           s[tmp.name] = tmp;
 580           line = empty;
 581         }
 582     }
 583   else
 584     {
 585       ostringstream os;
 586       os << "create_symbols failed for file " << file;
 587       __throw_runtime_error(os.str().c_str());
 588     }
 589   return s;
 590 }
 591
 592
 593 std::string
 594 demangle(const std::string& mangled)
 595 {
 596   std::string name;
 597   if (mangled[0] != '_' || mangled[1] != 'Z')
 598     {
 599       // This is not a mangled symbol, thus has "C" linkage.
 600       name = mangled;
 601     }
 602   else
 603     {
 604       // Use __cxa_demangle to demangle.
 605       int status = 0;
 606       char* ptr = abi::__cxa_demangle(mangled.c_str(), 0, 0, &status);
 607       if (ptr)
 608         {
 609           name = ptr;
 610           free(ptr);
 611         }
 612       else
 613         {
 614           switch (status)
 615             {
 616             case 0:
 617               name = "error code = 0: success";
 618               break;
 619             case -1:
 620               name = "error code = -1: memory allocation failure";
 621               break;
 622             case -2:
 623               name = "error code = -2: invalid mangled name";
 624               break;
 625             case -3:
 626               name = "error code = -3: invalid arguments";
 627               break;
 628             default:
 629               name = "error code unknown - who knows what happened";
 630             }
 631         }
 632     }
 633   return name;
 634 }