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

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