libstdc++-v3/testsuite/testsuite_abi.cc

   1 // -*- C++ -*-
   2
   3 // Copyright (C) 2004 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 2, 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 COPYING.  If not, write to
  17 // the Free Software Foundation, 59 Temple Place - Suite 330, Boston,
  18 // MA 02111-1307, USA.
  19
  20 // As a special exception, you may use this file as part of a free
  21 // software library without restriction.  Specifically, if other files
  22 // instantiate templates or use macros or inline functions from this
  23 // file, or you compile this file and link it with other files to
  24 // produce an executable, this file does not by itself cause the
  25 // resulting executable to be covered by the GNU General Public
  26 // License.  This exception does not however invalidate any other
  27 // reasons why the executable file might be covered by the GNU General
  28 // Public License.
  29
  30 // Benjamin Kosnik  <bkoz@redhat.com>
  31
  32 #include "testsuite_abi.h"
  33 #include <sstream>
  34 #include <fstream>
  35 #include <iostream>
  36
  37 using namespace std;
  38
  39 void
  40 symbol::init(string& data)
  41 {
  42   const char delim = ':';
  43   const char version_delim = '@';
  44   const string::size_type npos = string::npos;
  45   string::size_type n = 0;
  46
  47   // Set the type.
  48   if (data.find("FUNC") == 0)
  49     type = symbol::function;
  50   else if (data.find("OBJECT") == 0)
  51     type = symbol::object;
  52   else
  53     type = symbol::error;
  54   n = data.find_first_of(delim);
  55   if (n != npos)
  56     data.erase(data.begin(), data.begin() + n + 1);
  57
  58   // Iff object, get size info.
  59   if (type == symbol::object)
  60     {
  61       n = data.find_first_of(delim);
  62       if (n != npos)
  63         {
  64           string size(data.begin(), data.begin() + n);
  65           istringstream iss(size);
  66           int x;
  67           iss >> x;
  68           if (!iss.fail())
  69             size = x;
  70           data.erase(data.begin(), data.begin() + n + 1);
  71         }
  72     }
  73
  74   // Set the name.
  75   n = data.find_first_of(version_delim);
  76   if (n != npos)
  77     {
  78       // Found version string.
  79       name = string(data.begin(), data.begin() + n);
  80       n = data.find_last_of(version_delim);
  81       data.erase(data.begin(), data.begin() + n + 1);
  82
  83       // Set version name.
  84       version_name = data;
  85     }
  86   else
  87     {
  88       // No versioning info.
  89       name = string(data.begin(), data.end());
  90       data.erase(data.begin(), data.end());
  91     }
  92
  93   // Set the demangled name.
  94   demangled_name = demangle(name);
  95 }
  96
  97 void
  98 symbol::print() const
  99 {
 100   const char tab = '\t';
 101   cout << tab << name << endl;
 102   cout << tab << demangled_name << endl;
 103   cout << tab << version_name << endl;
 104
 105   string type_string;
 106   switch (type)
 107     {
 108     case none:
 109       type_string = "none";
 110       break;
 111     case function:
 112       type_string = "function";
 113       break;
 114     case object:
 115       type_string = "object";
 116       break;
 117     case error:
 118       type_string = "error";
 119       break;
 120     default:
 121       type_string = "<default>";
 122     }
 123   cout << tab << type_string << endl;
 124
 125   if (type == object)
 126     cout << tab << size << endl;
 127
 128   string status_string;
 129   switch (status)
 130     {
 131     case unknown:
 132       status_string = "unknown";
 133       break;
 134     case added:
 135       status_string = "added";
 136       break;
 137     case subtracted:
 138       status_string = "subtracted";
 139       break;
 140     case compatible:
 141       status_string = "compatible";
 142       break;
 143     case incompatible:
 144       status_string = "incompatible";
 145       break;
 146     default:
 147       status_string = "<default>";
 148     }
 149   cout << tab << status_string << endl;
 150 }
 151
 152
 153 bool
 154 check_version(const symbol& test, bool added)
 155 {
 156   typedef std::vector<std::string> compat_list;
 157   static compat_list known_versions;
 158   if (known_versions.empty())
 159     {
 160       known_versions.push_back("GLIBCPP_3.2"); // base version
 161       known_versions.push_back("GLIBCPP_3.2.1");
 162       known_versions.push_back("GLIBCPP_3.2.2");
 163       known_versions.push_back("GLIBCPP_3.2.3"); // gcc-3.3.0
 164       known_versions.push_back("GLIBCXX_3.4");
 165       known_versions.push_back("CXXABI_1.2");
 166       known_versions.push_back("CXXABI_1.2.1");
 167       known_versions.push_back("CXXABI_1.3");
 168     }
 169   compat_list::iterator begin = known_versions.begin();
 170   compat_list::iterator end = known_versions.end();
 171
 172   // Check version names for compatibility...
 173   compat_list::iterator it1 = find(begin, end, test.version_name);
 174
 175   // Check for weak label.
 176   compat_list::iterator it2 = find(begin, end, test.name);
 177
 178   // Check that added symbols aren't added in the base version.
 179   bool compat = true;
 180   if (added && test.version_name == known_versions[0])
 181     compat = false;
 182
 183   if (it1 == end && it2 == end)
 184     compat = false;
 185
 186   return compat;
 187 }
 188
 189 bool
 190 check_compatible(const symbol& lhs, const symbol& rhs, bool verbose)
 191 {
 192   bool ret = true;
 193   const char tab = '\t';
 194
 195   // Check to see if symbol_objects are compatible.
 196   if (lhs.type != rhs.type)
 197     {
 198       ret = false;
 199       if (verbose)
 200         cout << tab << "incompatible types" << endl;
 201     }
 202
 203   if (lhs.name != rhs.name)
 204     {
 205       ret = false;
 206       if (verbose)
 207         cout << tab << "incompatible names" << endl;
 208     }
 209
 210   if (lhs.size != rhs.size)
 211     {
 212       ret = false;
 213       if (verbose)
 214         {
 215           cout << tab << "incompatible sizes" << endl;
 216           cout << tab << lhs.size << endl;
 217           cout << tab << rhs.size << endl;
 218         }
 219     }
 220
 221   if (lhs.version_name != rhs.version_name
 222       && !check_version(lhs) && !check_version(rhs))
 223     {
 224       ret = false;
 225       if (verbose)
 226         {
 227           cout << tab << "incompatible versions" << endl;
 228           cout << tab << lhs.version_name << endl;
 229           cout << tab << rhs.version_name << endl;
 230         }
 231     }
 232
 233   if (verbose)
 234     cout << endl;
 235
 236   return ret;
 237 }
 238
 239
 240 bool
 241 has_symbol(const string& mangled, const symbols& s) throw()
 242 {
 243   const symbol_names& names = s.first;
 244   symbol_names::const_iterator i = find(names.begin(), names.end(), mangled);
 245   return i != names.end();
 246 }
 247
 248 symbol&
 249 get_symbol(const string& mangled, const symbols& s)
 250 {
 251   const symbol_names& names = s.first;
 252   symbol_names::const_iterator i = find(names.begin(), names.end(), mangled);
 253   if (i != names.end())
 254     {
 255       symbol_objects objects = s.second;
 256       return objects[mangled];
 257     }
 258   else
 259     {
 260       ostringstream os;
 261       os << "get_symbol failed for symbol " << mangled;
 262       throw symbol_error(os.str());
 263     }
 264 }
 265
 266 void
 267 examine_symbol(const char* name, const char* file)
 268 {
 269   try
 270     {
 271       symbols s = create_symbols(file);
 272       symbol& sym = get_symbol(name, s);
 273       sym.print();
 274     }
 275   catch(...)
 276     { throw; }
 277 }
 278
 279 void
 280 compare_symbols(const char* baseline_file, const char* test_file,
 281                 bool verbose)
 282 {
 283   // Input both lists of symbols into container.
 284   symbols baseline = create_symbols(baseline_file);
 285   symbols test = create_symbols(test_file);
 286   symbol_names& baseline_names = baseline.first;
 287   symbol_objects& baseline_objects = baseline.second;
 288   symbol_names& test_names = test.first;
 289   symbol_objects& test_objects = test.second;
 290
 291   //  Sanity check results.
 292   const symbol_names::size_type baseline_size = baseline_names.size();
 293   const symbol_names::size_type test_size = test_names.size();
 294   if (!baseline_size || !test_size)
 295     {
 296       cerr << "Problems parsing the list of exported symbols." << endl;
 297       exit(2);
 298     }
 299
 300   // Sort out names.
 301   // Assuming baseline_names, test_names are both unique w/ no duplicates.
 302   //
 303   // The names added to missing_names are baseline_names not found in
 304   // test_names
 305   // -> symbols that have been deleted.
 306   //
 307   // The names added to added_names are test_names are names not in
 308   // baseline_names
 309   // -> symbols that have been added.
 310   symbol_names shared_names;
 311   symbol_names missing_names;
 312   symbol_names added_names = test_names;
 313   for (size_t i = 0; i < baseline_size; ++i)
 314     {
 315       string what(baseline_names[i]);
 316       symbol_names::iterator end = added_names.end();
 317       symbol_names::iterator it = find(added_names.begin(), end, what);
 318       if (it != end)
 319         {
 320           // Found.
 321           shared_names.push_back(what);
 322           added_names.erase(it);
 323         }
 324       else
 325           missing_names.push_back(what);
 326     }
 327
 328   // Check missing names for compatibility.
 329   typedef pair<symbol, symbol> symbol_pair;
 330   vector<symbol_pair> incompatible;
 331   for (size_t i = 0; i < missing_names.size(); ++i)
 332     {
 333       symbol base = baseline_objects[missing_names[i]];
 334       incompatible.push_back(symbol_pair(base, base));
 335     }
 336
 337   // Check shared names for compatibility.
 338   for (size_t i = 0; i < shared_names.size(); ++i)
 339     {
 340       symbol base = baseline_objects[shared_names[i]];
 341       symbol test = test_objects[shared_names[i]];
 342       if (!check_compatible(base, test))
 343         incompatible.push_back(symbol_pair(base, test));
 344     }
 345
 346   // Check added names for compatibility.
 347   for (size_t i = 0; i < added_names.size(); ++i)
 348     {
 349       symbol test = test_objects[added_names[i]];
 350       if (!check_version(test, true))
 351         incompatible.push_back(symbol_pair(test, test));
 352     }
 353
 354   // Report results.
 355   if (verbose && added_names.size())
 356     {
 357       cout << added_names.size() << " added symbols " << endl;
 358       for (size_t j = 0; j < added_names.size() ; ++j)
 359         test_objects[added_names[j]].print();
 360     }
 361
 362   if (verbose && missing_names.size())
 363     {
 364       cout << missing_names.size() << " missing symbols " << endl;
 365       for (size_t j = 0; j < missing_names.size() ; ++j)
 366         baseline_objects[missing_names[j]].print();
 367     }
 368
 369   if (verbose && incompatible.size())
 370     {
 371       cout << incompatible.size() << " incompatible symbols " << endl;
 372       for (size_t j = 0; j < incompatible.size() ; ++j)
 373         {
 374           // First, report name.
 375           const symbol& base = incompatible[j].first;
 376           const symbol& test = incompatible[j].second;
 377           test.print();
 378
 379           // Second, report reason or reasons incompatible.
 380           check_compatible(base, test, true);
 381         }
 382     }
 383
 384   cout << "\n\t\t=== libstdc++-v3 check-abi Summary ===" << endl;
 385   cout << endl;
 386   cout << "# of added symbols:\t\t " << added_names.size() << endl;
 387   cout << "# of missing symbols:\t\t " << missing_names.size() << endl;
 388   cout << "# of incompatible symbols:\t " << incompatible.size() << endl;
 389   cout << endl;
 390   cout << "using: " << baseline_file << endl;
 391 }
 392
 393
 394 symbols
 395 create_symbols(const char* file)
 396 {
 397   symbols s;
 398   ifstream ifs(file);
 399   if (ifs.is_open())
 400     {
 401       // Organize file data into container of symbol objects.
 402       symbol_names& names = s.first;
 403       symbol_objects& objects = s.second;
 404       const string empty;
 405       string line = empty;
 406       while (getline(ifs, line).good())
 407         {
 408           symbol tmp;
 409           tmp.init(line);
 410           objects[tmp.name] = tmp;
 411           names.push_back(tmp.name);
 412           line = empty;
 413         }
 414     }
 415   else
 416     {
 417       ostringstream os;
 418       os << "create_symbols failed for file " << file;
 419       throw runtime_error(os.str());
 420     }
 421   return s;
 422 }
 423
 424
 425 const char*
 426 demangle(const std::string& mangled)
 427 {
 428   const char* name;
 429   if (mangled[0] != '_' || mangled[1] != 'Z')
 430     {
 431       // This is not a mangled symbol, thus has "C" linkage.
 432       name = mangled.c_str();
 433     }
 434   else
 435     {
 436       // Use __cxa_demangle to demangle.
 437       int status = 0;
 438       name = abi::__cxa_demangle(mangled.c_str(), 0, 0, &status);
 439       if (!name)
 440         {
 441           switch (status)
 442             {
 443             case 0:
 444               name = "error code = 0: success";
 445               break;
 446             case -1:
 447               name = "error code = -1: memory allocation failure";
 448               break;
 449             case -2:
 450               name = "error code = -2: invalid mangled name";
 451               break;
 452             case -3:
 453               name = "error code = -3: invalid arguments";
 454               break;
 455             default:
 456               name = "error code unknown - who knows what happened";
 457             }
 458         }
 459     }
 460   return name;
 461 }
 462