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

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