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("GLIBCXX_3.4.1");
 166       known_versions.push_back("GLIBCXX_3.4.2");
 167       known_versions.push_back("GLIBCXX_3.4.3");
 168       known_versions.push_back("CXXABI_1.2");
 169       known_versions.push_back("CXXABI_1.2.1");
 170       known_versions.push_back("CXXABI_1.3");
 171     }
 172   compat_list::iterator begin = known_versions.begin();
 173   compat_list::iterator end = known_versions.end();
 174
 175   // Check version names for compatibility...
 176   compat_list::iterator it1 = find(begin, end, test.version_name);
 177
 178   // Check for weak label.
 179   compat_list::iterator it2 = find(begin, end, test.name);
 180
 181   // Check that added symbols aren't added in the base version.
 182   bool compat = true;
 183   if (added && test.version_name == known_versions[0])
 184     compat = false;
 185
 186   if (it1 == end && it2 == end)
 187     compat = false;
 188
 189   return compat;
 190 }
 191
 192 bool
 193 check_compatible(const symbol& lhs, const symbol& rhs, bool verbose)
 194 {
 195   bool ret = true;
 196   const char tab = '\t';
 197
 198   // Check to see if symbol_objects are compatible.
 199   if (lhs.type != rhs.type)
 200     {
 201       ret = false;
 202       if (verbose)
 203         cout << tab << "incompatible types" << endl;
 204     }
 205
 206   if (lhs.name != rhs.name)
 207     {
 208       ret = false;
 209       if (verbose)
 210         cout << tab << "incompatible names" << endl;
 211     }
 212
 213   if (lhs.size != rhs.size)
 214     {
 215       ret = false;
 216       if (verbose)
 217         {
 218           cout << tab << "incompatible sizes" << endl;
 219           cout << tab << lhs.size << endl;
 220           cout << tab << rhs.size << endl;
 221         }
 222     }
 223
 224   if (lhs.version_name != rhs.version_name
 225       && !check_version(lhs) && !check_version(rhs))
 226     {
 227       ret = false;
 228       if (verbose)
 229         {
 230           cout << tab << "incompatible versions" << endl;
 231           cout << tab << lhs.version_name << endl;
 232           cout << tab << rhs.version_name << endl;
 233         }
 234     }
 235
 236   if (verbose)
 237     cout << endl;
 238
 239   return ret;
 240 }
 241
 242
 243 bool
 244 has_symbol(const string& mangled, const symbols& s) throw()
 245 {
 246   const symbol_names& names = s.first;
 247   symbol_names::const_iterator i = find(names.begin(), names.end(), mangled);
 248   return i != names.end();
 249 }
 250
 251 symbol&
 252 get_symbol(const string& mangled, const symbols& s)
 253 {
 254   const symbol_names& names = s.first;
 255   symbol_names::const_iterator i = find(names.begin(), names.end(), mangled);
 256   if (i != names.end())
 257     {
 258       symbol_objects objects = s.second;
 259       return objects[mangled];
 260     }
 261   else
 262     {
 263       ostringstream os;
 264       os << "get_symbol failed for symbol " << mangled;
 265       throw symbol_error(os.str());
 266     }
 267 }
 268
 269 void
 270 examine_symbol(const char* name, const char* file)
 271 {
 272   try
 273     {
 274       symbols s = create_symbols(file);
 275       symbol& sym = get_symbol(name, s);
 276       sym.print();
 277     }
 278   catch(...)
 279     { throw; }
 280 }
 281
 282 void
 283 compare_symbols(const char* baseline_file, const char* test_file,
 284                 bool verbose)
 285 {
 286   // Input both lists of symbols into container.
 287   symbols baseline = create_symbols(baseline_file);
 288   symbols test = create_symbols(test_file);
 289   symbol_names& baseline_names = baseline.first;
 290   symbol_objects& baseline_objects = baseline.second;
 291   symbol_names& test_names = test.first;
 292   symbol_objects& test_objects = test.second;
 293
 294   //  Sanity check results.
 295   const symbol_names::size_type baseline_size = baseline_names.size();
 296   const symbol_names::size_type test_size = test_names.size();
 297   if (!baseline_size || !test_size)
 298     {
 299       cerr << "Problems parsing the list of exported symbols." << endl;
 300       exit(2);
 301     }
 302
 303   // Sort out names.
 304   // Assuming baseline_names, test_names are both unique w/ no duplicates.
 305   //
 306   // The names added to missing_names are baseline_names not found in
 307   // test_names
 308   // -> symbols that have been deleted.
 309   //
 310   // The names added to added_names are test_names are names not in
 311   // baseline_names
 312   // -> symbols that have been added.
 313   symbol_names shared_names;
 314   symbol_names missing_names;
 315   symbol_names added_names = test_names;
 316   for (size_t i = 0; i < baseline_size; ++i)
 317     {
 318       string what(baseline_names[i]);
 319       symbol_names::iterator end = added_names.end();
 320       symbol_names::iterator it = find(added_names.begin(), end, what);
 321       if (it != end)
 322         {
 323           // Found.
 324           shared_names.push_back(what);
 325           added_names.erase(it);
 326         }
 327       else
 328           missing_names.push_back(what);
 329     }
 330
 331   // Check missing names for compatibility.
 332   typedef pair<symbol, symbol> symbol_pair;
 333   vector<symbol_pair> incompatible;
 334   for (size_t j = 0; j < missing_names.size(); ++j)
 335     {
 336       symbol base = baseline_objects[missing_names[j]];
 337       incompatible.push_back(symbol_pair(base, base));
 338     }
 339
 340   // Check shared names for compatibility.
 341   for (size_t k = 0; k < shared_names.size(); ++k)
 342     {
 343       symbol base = baseline_objects[shared_names[k]];
 344       symbol test = test_objects[shared_names[k]];
 345       if (!check_compatible(base, test))
 346         incompatible.push_back(symbol_pair(base, test));
 347     }
 348
 349   // Check added names for compatibility.
 350   for (size_t l = 0; l < added_names.size(); ++l)
 351     {
 352       symbol test = test_objects[added_names[l]];
 353       if (!check_version(test, true))
 354         incompatible.push_back(symbol_pair(test, test));
 355     }
 356
 357   // Report results.
 358   if (verbose && added_names.size())
 359     {
 360       cout << added_names.size() << " added symbols " << endl;
 361       for (size_t j = 0; j < added_names.size() ; ++j)
 362         test_objects[added_names[j]].print();
 363     }
 364
 365   if (verbose && missing_names.size())
 366     {
 367       cout << missing_names.size() << " missing symbols " << endl;
 368       for (size_t j = 0; j < missing_names.size() ; ++j)
 369         baseline_objects[missing_names[j]].print();
 370     }
 371
 372   if (verbose && incompatible.size())
 373     {
 374       cout << incompatible.size() << " incompatible symbols " << endl;
 375       for (size_t j = 0; j < incompatible.size() ; ++j)
 376         {
 377           // First, report name.
 378           const symbol& base = incompatible[j].first;
 379           const symbol& test = incompatible[j].second;
 380           test.print();
 381
 382           // Second, report reason or reasons incompatible.
 383           check_compatible(base, test, true);
 384         }
 385     }
 386
 387   cout << "\n\t\t=== libstdc++-v3 check-abi Summary ===" << endl;
 388   cout << endl;
 389   cout << "# of added symbols:\t\t " << added_names.size() << endl;
 390   cout << "# of missing symbols:\t\t " << missing_names.size() << endl;
 391   cout << "# of incompatible symbols:\t " << incompatible.size() << endl;
 392   cout << endl;
 393   cout << "using: " << baseline_file << endl;
 394 }
 395
 396
 397 symbols
 398 create_symbols(const char* file)
 399 {
 400   symbols s;
 401   ifstream ifs(file);
 402   if (ifs.is_open())
 403     {
 404       // Organize file data into container of symbol objects.
 405       symbol_names& names = s.first;
 406       symbol_objects& objects = s.second;
 407       const string empty;
 408       string line = empty;
 409       while (getline(ifs, line).good())
 410         {
 411           symbol tmp;
 412           tmp.init(line);
 413           objects[tmp.name] = tmp;
 414           names.push_back(tmp.name);
 415           line = empty;
 416         }
 417     }
 418   else
 419     {
 420       ostringstream os;
 421       os << "create_symbols failed for file " << file;
 422       throw runtime_error(os.str());
 423     }
 424   return s;
 425 }
 426
 427
 428 const char*
 429 demangle(const std::string& mangled)
 430 {
 431   const char* name;
 432   if (mangled[0] != '_' || mangled[1] != 'Z')
 433     {
 434       // This is not a mangled symbol, thus has "C" linkage.
 435       name = mangled.c_str();
 436     }
 437   else
 438     {
 439       // Use __cxa_demangle to demangle.
 440       int status = 0;
 441       name = abi::__cxa_demangle(mangled.c_str(), 0, 0, &status);
 442       if (!name)
 443         {
 444           switch (status)
 445             {
 446             case 0:
 447               name = "error code = 0: success";
 448               break;
 449             case -1:
 450               name = "error code = -1: memory allocation failure";
 451               break;
 452             case -2:
 453               name = "error code = -2: invalid mangled name";
 454               break;
 455             case -3:
 456               name = "error code = -3: invalid arguments";
 457               break;
 458             default:
 459               name = "error code unknown - who knows what happened";
 460             }
 461         }
 462     }
 463   return name;
 464 }
 465