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

   1 // -*- C++ -*-
   2
   3 // Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009 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
  46   n = data.find_first_of(delim);
  47   if (n != npos)
  48     data.erase(data.begin(), data.begin() + n + 1);
  49
  50   // Iff object, get size info.
  51   if (type == symbol::object)
  52     {
  53       n = data.find_first_of(delim);
  54       if (n != npos)
  55         {
  56           string objectsize(data.begin(), data.begin() + n);
  57           istringstream iss(objectsize);
  58           int x;
  59           iss >> x;
  60           if (!iss.fail())
  61             size = x;
  62           data.erase(data.begin(), data.begin() + n + 1);
  63         }
  64     }
  65
  66   // Set the name and raw_name.
  67   raw_name = string(data.begin(), data.end());
  68   n = data.find_first_of(version_delim);
  69   if (n != npos)
  70     {
  71       // Found version string.
  72       name = string(data.begin(), data.begin() + n);
  73       n = data.find_last_of(version_delim);
  74       data.erase(data.begin(), data.begin() + n + 1);
  75
  76       // Set version name.
  77       version_name = data;
  78     }
  79   else
  80     {
  81       // No versioning info.
  82       name = string(data.begin(), data.end());
  83       version_status = symbol::none;
  84     }
  85
  86   // Set the demangled name.
  87   demangled_name = demangle(name);
  88 }
  89
  90 void
  91 symbol::print() const
  92 {
  93   const char tab = '\t';
  94   cout << name << endl;
  95
  96   if (demangled_name != name)
  97     cout << demangled_name << endl;
  98
  99   string vers;
 100   switch (version_status)
 101     {
 102     case none:
 103       vers = "none";
 104       break;
 105     case compatible:
 106       vers = "compatible";
 107       break;
 108     case incompatible:
 109       vers = "incompatible";
 110       break;
 111      case unversioned:
 112       vers = "unversioned";
 113       break;
 114    default:
 115       vers = "<default>";
 116     }
 117   cout << "version status: " << vers << endl;
 118
 119   if (version_name.size()
 120       && (version_status == compatible || version_status == incompatible))
 121     cout << version_name << endl;
 122
 123   string type_string;
 124   switch (type)
 125     {
 126     case function:
 127       type_string = "function";
 128       break;
 129     case object:
 130       type_string = "object";
 131       break;
 132     case uncategorized:
 133       type_string = "uncategorized";
 134       break;
 135     default:
 136       type_string = "<default>";
 137     }
 138   cout << "type: " << type_string << endl;
 139
 140   if (type == object)
 141     cout << "type size: " << size << endl;
 142
 143   string status_string;
 144   switch (status)
 145     {
 146     case added:
 147       status_string = "added";
 148       break;
 149     case subtracted:
 150       status_string = "subtracted";
 151       break;
 152     case undesignated:
 153       status_string = "undesignated";
 154       break;
 155     default:
 156       status_string = "<default>";
 157     }
 158   cout << "status: " << status_string << endl;
 159
 160   cout << endl;
 161 }
 162
 163
 164 bool
 165 check_version(symbol& test, bool added)
 166 {
 167   // Construct list of compatible versions.
 168   typedef std::vector<std::string> compat_list;
 169   static compat_list known_versions;
 170   if (known_versions.empty())
 171     {
 172       // NB: First version here must be the default version for this
 173       // version of DT_SONAME.
 174       known_versions.push_back("GLIBCXX_3.4");
 175       known_versions.push_back("GLIBCXX_3.4.1");
 176       known_versions.push_back("GLIBCXX_3.4.2");
 177       known_versions.push_back("GLIBCXX_3.4.3");
 178       known_versions.push_back("GLIBCXX_3.4.4");
 179       known_versions.push_back("GLIBCXX_3.4.5");
 180       known_versions.push_back("GLIBCXX_3.4.6");
 181       known_versions.push_back("GLIBCXX_3.4.7");
 182       known_versions.push_back("GLIBCXX_3.4.8");
 183       known_versions.push_back("GLIBCXX_3.4.9");
 184       known_versions.push_back("GLIBCXX_3.4.10");
 185       known_versions.push_back("GLIBCXX_3.4.11");
 186       known_versions.push_back("GLIBCXX_3.4.12");
 187       known_versions.push_back("GLIBCXX_3.4.13");
 188       known_versions.push_back("GLIBCXX_3.4.14");
 189       known_versions.push_back("GLIBCXX_LDBL_3.4");
 190       known_versions.push_back("GLIBCXX_LDBL_3.4.7");
 191       known_versions.push_back("GLIBCXX_LDBL_3.4.10");
 192       known_versions.push_back("CXXABI_1.3");
 193       known_versions.push_back("CXXABI_1.3.1");
 194       known_versions.push_back("CXXABI_1.3.2");
 195       known_versions.push_back("CXXABI_1.3.3");
 196       known_versions.push_back("CXXABI_1.3.4");
 197       known_versions.push_back("CXXABI_1.3.5");
 198       known_versions.push_back("CXXABI_LDBL_1.3");
 199     }
 200   compat_list::iterator begin = known_versions.begin();
 201   compat_list::iterator end = known_versions.end();
 202
 203   // Check for compatible version.
 204   if (test.version_name.size())
 205     {
 206       compat_list::iterator it1 = find(begin, end, test.version_name);
 207       compat_list::iterator it2 = find(begin, end, test.name);
 208       if (it1 != end)
 209         test.version_status = symbol::compatible;
 210       else
 211         test.version_status = symbol::incompatible;
 212
 213       // Check that added symbols aren't added in the base version.
 214       if (added && test.version_name == known_versions[0])
 215         test.version_status = symbol::incompatible;
 216
 217       // Check that long double compatibility symbols demangled as
 218       // __float128 are put into some _LDBL_ version name.
 219       if (added && test.demangled_name.find("__float128") != std::string::npos)
 220         {
 221           // Has to be in _LDBL_ version name.
 222           if (test.version_name.find("_LDBL_") == std::string::npos)
 223             test.version_status = symbol::incompatible;
 224         }
 225
 226       // Check for weak label.
 227       if (it1 == end && it2 == end)
 228         test.version_status = symbol::incompatible;
 229
 230       // Check that
 231       // GLIBCXX_3.4
 232       // GLIBCXX_3.4.5
 233       // version as compatible
 234       // XXX
 235     }
 236   else
 237     {
 238       if (added)
 239         {
 240           // New version labels are ok. The rest are not.
 241           compat_list::iterator it2 = find(begin, end, test.name);
 242           if (it2 != end)
 243             test.version_status = symbol::compatible;
 244           else
 245             test.version_status = symbol::incompatible;
 246         }
 247     }
 248   return test.version_status == symbol::compatible;
 249 }
 250
 251 bool
 252 check_compatible(symbol& lhs, symbol& rhs, bool verbose)
 253 {
 254   bool ret = true;
 255   const char tab = '\t';
 256
 257   // Check to see if symbol_objects are compatible.
 258   if (lhs.type != rhs.type)
 259     {
 260       ret = false;
 261       if (verbose)
 262         cout << tab << "incompatible types" << endl;
 263     }
 264
 265   if (lhs.name != rhs.name)
 266     {
 267       ret = false;
 268       if (verbose)
 269         cout << tab << "incompatible names" << endl;
 270     }
 271
 272   if (lhs.size != rhs.size)
 273     {
 274       ret = false;
 275       if (verbose)
 276         {
 277           cout << tab << "incompatible sizes" << endl;
 278           cout << tab << lhs.size << endl;
 279           cout << tab << rhs.size << endl;
 280         }
 281     }
 282
 283   if (lhs.version_name != rhs.version_name
 284       && !check_version(lhs) && !check_version(rhs))
 285     {
 286       ret = false;
 287       if (verbose)
 288         {
 289           cout << tab << "incompatible versions" << endl;
 290           cout << tab << lhs.version_name << endl;
 291           cout << tab << rhs.version_name << endl;
 292         }
 293     }
 294
 295   if (verbose)
 296     cout << endl;
 297
 298   return ret;
 299 }
 300
 301
 302 inline bool
 303 has_symbol(const string& name, const symbols& s) throw()
 304 { return s.find(name) != s.end(); }
 305
 306 const symbol&
 307 get_symbol(const string& name, const symbols& s)
 308 {
 309   symbols::const_iterator i = s.find(name);
 310   if (i != s.end())
 311     {
 312       return i->second;
 313     }
 314   else
 315     {
 316       ostringstream os;
 317       os << "get_symbol failed for symbol " << name;
 318       __throw_logic_error(os.str().c_str());
 319     }
 320 }
 321
 322 void
 323 examine_symbol(const char* name, const char* file)
 324 {
 325   try
 326     {
 327       symbols s = create_symbols(file);
 328       const symbol& sym = get_symbol(name, s);
 329       sym.print();
 330     }
 331   catch(...)
 332     { __throw_exception_again; }
 333 }
 334
 335 int
 336 compare_symbols(const char* baseline_file, const char* test_file,
 337                 bool verbose)
 338 {
 339   // Input both lists of symbols into container.
 340   symbols baseline = create_symbols(baseline_file);
 341   symbols test = create_symbols(test_file);
 342
 343   //  Sanity check results.
 344   if (!baseline.size() || !test.size())
 345     {
 346       cerr << "Problems parsing the list of exported symbols." << endl;
 347       exit(2);
 348     }
 349
 350   // Check to see if any long double compatibility symbols are produced.
 351   bool ld_version_found(false);
 352   symbols::iterator li(test.begin());
 353   while (!ld_version_found && li != test.end())
 354     {
 355       if (li->second.version_name.find("_LDBL_") != std::string::npos)
 356         ld_version_found = true;
 357       ++li;
 358     }
 359
 360   // Sort out names.
 361   // Assuming all baseline names and test names are both unique w/ no
 362   // duplicates.
 363   //
 364   // The names added to missing_names are baseline names not found in
 365   // test names
 366   // -> symbols that have been deleted.
 367   //
 368   // The names added to added_names are test names not in
 369   // baseline names
 370   // -> symbols that have been added.
 371   typedef std::vector<std::string> symbol_names;
 372   symbol_names shared_names;
 373   symbol_names missing_names;
 374   symbol_names added_names;
 375   for (li = test.begin(); li != test.end(); ++li)
 376     added_names.push_back(li->first);
 377
 378   for (symbols::iterator i = baseline.begin(); i != baseline.end(); ++i)
 379     {
 380       string name(i->first);
 381       symbol_names::iterator end = added_names.end();
 382       symbol_names::iterator it = find(added_names.begin(), end, name);
 383       if (it != end)
 384         {
 385           // Found.
 386           shared_names.push_back(name);
 387           added_names.erase(it);
 388         }
 389        else
 390         {
 391           // Iff no test long double compatibility symbols at all and the symbol
 392           // missing is a baseline long double compatibility symbol, skip.
 393           string version_name(i->second.version_name);
 394           bool base_ld(version_name.find("_LDBL_") != std::string::npos);
 395           if (!base_ld || base_ld && ld_version_found)
 396             missing_names.push_back(name);
 397         }
 398     }
 399
 400   // Fill out list of incompatible symbols.
 401   typedef pair<symbol, symbol> symbol_pair;
 402   vector<symbol_pair> incompatible;
 403
 404   // Check missing names for compatibility.
 405   for (size_t j = 0; j < missing_names.size(); ++j)
 406     {
 407       symbol& sbase = baseline[missing_names[j]];
 408       sbase.status = symbol::subtracted;
 409       incompatible.push_back(symbol_pair(sbase, sbase));
 410     }
 411
 412   // Check shared names for compatibility.
 413   const symbol_names::size_type shared_size = shared_names.size();
 414   for (size_t k = 0; k < shared_size; ++k)
 415     {
 416       symbol& sbase = baseline[shared_names[k]];
 417       symbol& stest = test[shared_names[k]];
 418       stest.status = symbol::existing;
 419       if (!check_compatible(sbase, stest))
 420         incompatible.push_back(symbol_pair(sbase, stest));
 421     }
 422
 423   // Check added names for compatibility.
 424   const symbol_names::size_type added_size = added_names.size();
 425   for (size_t l = 0; l < added_size; ++l)
 426     {
 427       symbol& stest = test[added_names[l]];
 428       stest.status = symbol::added;
 429       if (!check_version(stest, true))
 430         incompatible.push_back(symbol_pair(stest, stest));
 431     }
 432
 433   // Report results.
 434   if (verbose && added_names.size())
 435     {
 436       cout << endl << added_names.size() << " added symbols " << endl;
 437       for (size_t j = 0; j < added_names.size() ; ++j)
 438         {
 439           cout << j << endl;
 440           test[added_names[j]].print();
 441         }
 442     }
 443
 444   if (verbose && missing_names.size())
 445     {
 446       cout << endl << missing_names.size() << " missing symbols " << endl;
 447       for (size_t j = 0; j < missing_names.size() ; ++j)
 448         {
 449           cout << j << endl;
 450           baseline[missing_names[j]].print();
 451         }
 452     }
 453
 454   if (verbose && incompatible.size())
 455     {
 456       cout << endl << incompatible.size() << " incompatible symbols " << endl;
 457       for (size_t j = 0; j < incompatible.size() ; ++j)
 458         {
 459           // First, print index.
 460           cout << j << endl;
 461
 462           // Second, report name.
 463           symbol& sbase = incompatible[j].first;
 464           symbol& stest = incompatible[j].second;
 465           stest.print();
 466
 467           // Second, report reason or reasons incompatible.
 468           check_compatible(sbase, stest, true);
 469         }
 470     }
 471
 472   cout << "\n\t\t=== libstdc++-v3 check-abi Summary ===" << endl;
 473   cout << endl;
 474   cout << "# of added symbols:\t\t " << added_names.size() << endl;
 475   cout << "# of missing symbols:\t\t " << missing_names.size() << endl;
 476   cout << "# of incompatible symbols:\t " << incompatible.size() << endl;
 477   cout << endl;
 478   cout << "using: " << baseline_file << endl;
 479
 480   return !(missing_names.size() || incompatible.size());
 481 }
 482
 483
 484 symbols
 485 create_symbols(const char* file)
 486 {
 487   symbols s;
 488   ifstream ifs(file);
 489   if (ifs.is_open())
 490     {
 491       // Organize file data into an associated container (symbols) of symbol
 492       // objects mapped to mangled names without versioning
 493       // information.
 494       const string empty;
 495       string line = empty;
 496       while (getline(ifs, line).good())
 497         {
 498           symbol tmp;
 499           tmp.init(line);
 500           s[tmp.name] = tmp;
 501           line = empty;
 502         }
 503     }
 504   else
 505     {
 506       ostringstream os;
 507       os << "create_symbols failed for file " << file;
 508       __throw_runtime_error(os.str().c_str());
 509     }
 510   return s;
 511 }
 512
 513
 514 const char*
 515 demangle(const std::string& mangled)
 516 {
 517   const char* name;
 518   if (mangled[0] != '_' || mangled[1] != 'Z')
 519     {
 520       // This is not a mangled symbol, thus has "C" linkage.
 521       name = mangled.c_str();
 522     }
 523   else
 524     {
 525       // Use __cxa_demangle to demangle.
 526       int status = 0;
 527       name = abi::__cxa_demangle(mangled.c_str(), 0, 0, &status);
 528       if (!name)
 529         {
 530           switch (status)
 531             {
 532             case 0:
 533               name = "error code = 0: success";
 534               break;
 535             case -1:
 536               name = "error code = -1: memory allocation failure";
 537               break;
 538             case -2:
 539               name = "error code = -2: invalid mangled name";
 540               break;
 541             case -3:
 542               name = "error code = -3: invalid arguments";
 543               break;
 544             default:
 545               name = "error code unknown - who knows what happened";
 546             }
 547         }
 548     }
 549   return name;
 550 }
 551