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