3 // Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011
4 // Free Software Foundation, Inc.
6 // This library is free software; you can redistribute it and/or
7 // modify it under the terms of the GNU General Public License as
8 // published by the Free Software Foundation; either version 3, or (at
9 // your option) any later version.
11 // This library is distributed in the hope that it will be useful, but
12 // WITHOUT ANY WARRANTY; without even the implied warranty of
13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 // General Public License for more details.
16 // You should have received a copy of the GNU General Public License
17 // along with this library; see the file COPYING3. If not see
18 // <http://www.gnu.org/licenses/>.
21 // Benjamin Kosnik <bkoz@redhat.com>
23 #include "testsuite_abi.h"
34 symbol::init(string& data)
36 const char delim = ':';
37 const char version_delim = '@';
38 const string::size_type npos = string::npos;
39 string::size_type n = 0;
42 if (data.find("FUNC") == 0)
43 type = symbol::function;
44 else if (data.find("OBJECT") == 0)
45 type = symbol::object;
46 else if (data.find("TLS") == 0)
49 n = data.find_first_of(delim);
51 data.erase(data.begin(), data.begin() + n + 1);
53 // Iff object or TLS, get size info.
54 if (type == symbol::object || type == symbol::tls)
56 n = data.find_first_of(delim);
59 string objectsize(data.begin(), data.begin() + n);
60 istringstream iss(objectsize);
65 data.erase(data.begin(), data.begin() + n + 1);
69 // Set the name and raw_name.
70 raw_name = string(data.begin(), data.end());
71 n = data.find_first_of(version_delim);
74 // Found version string.
75 name = string(data.begin(), data.begin() + n);
76 n = data.find_last_of(version_delim);
77 data.erase(data.begin(), data.begin() + n + 1);
84 // No versioning info.
85 name = string(data.begin(), data.end());
86 version_status = symbol::none;
89 // Set the demangled name.
90 demangled_name = demangle(name);
96 const char tab = '\t';
99 if (demangled_name != name)
100 cout << demangled_name << endl;
103 switch (version_status)
112 vers = "incompatible";
115 vers = "unversioned";
120 cout << "version status: " << vers << endl;
122 if (version_name.size()
123 && (version_status == compatible || version_status == incompatible))
124 cout << version_name << endl;
130 type_string = "function";
133 type_string = "object";
139 type_string = "uncategorized";
142 type_string = "<default>";
144 cout << "type: " << type_string << endl;
146 if (type == object || type == tls)
147 cout << "type size: " << size << endl;
149 string status_string;
153 status_string = "added";
156 status_string = "subtracted";
159 status_string = "undesignated";
162 status_string = "<default>";
164 cout << "status: " << status_string << endl;
171 check_version(symbol& test, bool added)
173 // Construct list of compatible versions.
174 typedef std::vector<std::string> compat_list;
175 static compat_list known_versions;
176 if (known_versions.empty())
178 // NB: First version here must be the default version for this
179 // version of DT_SONAME.
180 known_versions.push_back("GLIBCXX_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_3.4.8");
189 known_versions.push_back("GLIBCXX_3.4.9");
190 known_versions.push_back("GLIBCXX_3.4.10");
191 known_versions.push_back("GLIBCXX_3.4.11");
192 known_versions.push_back("GLIBCXX_3.4.12");
193 known_versions.push_back("GLIBCXX_3.4.13");
194 known_versions.push_back("GLIBCXX_3.4.14");
195 known_versions.push_back("GLIBCXX_3.4.15");
196 known_versions.push_back("GLIBCXX_LDBL_3.4");
197 known_versions.push_back("GLIBCXX_LDBL_3.4.7");
198 known_versions.push_back("GLIBCXX_LDBL_3.4.10");
199 known_versions.push_back("CXXABI_1.3");
200 known_versions.push_back("CXXABI_1.3.1");
201 known_versions.push_back("CXXABI_1.3.2");
202 known_versions.push_back("CXXABI_1.3.3");
203 known_versions.push_back("CXXABI_1.3.4");
204 known_versions.push_back("CXXABI_1.3.5");
205 known_versions.push_back("CXXABI_LDBL_1.3");
207 compat_list::iterator begin = known_versions.begin();
208 compat_list::iterator end = known_versions.end();
210 // Check for compatible version.
211 if (test.version_name.size())
213 compat_list::iterator it1 = find(begin, end, test.version_name);
214 compat_list::iterator it2 = find(begin, end, test.name);
216 test.version_status = symbol::compatible;
218 test.version_status = symbol::incompatible;
220 // Check that added symbols aren't added in the base versions.
222 && (test.version_name == known_versions[0]
223 || test.version_name == "CXXABI_1.3"
224 || test.version_name == "GLIBCXX_LDBL_3.4"
225 || test.version_name == "CXXABI_LDBL_1.3"))
226 test.version_status = symbol::incompatible;
228 // Check that long double compatibility symbols demangled as
229 // __float128 are put into some _LDBL_ version name.
230 if (added && test.demangled_name.find("__float128") != std::string::npos)
232 // Has to be in _LDBL_ version name.
233 if (test.version_name.find("_LDBL_") == std::string::npos)
234 test.version_status = symbol::incompatible;
237 // Check for weak label.
238 if (it1 == end && it2 == end)
239 test.version_status = symbol::incompatible;
244 // version as compatible
251 // New version labels are ok. The rest are not.
252 compat_list::iterator it2 = find(begin, end, test.name);
254 test.version_status = symbol::compatible;
256 test.version_status = symbol::incompatible;
259 return test.version_status == symbol::compatible;
263 check_compatible(symbol& lhs, symbol& rhs, bool verbose)
266 const char tab = '\t';
268 // Check to see if symbol_objects are compatible.
269 if (lhs.type != rhs.type)
273 cout << tab << "incompatible types" << endl;
276 if (lhs.name != rhs.name)
280 cout << tab << "incompatible names" << endl;
283 if (lhs.size != rhs.size)
288 cout << tab << "incompatible sizes" << endl;
289 cout << tab << lhs.size << endl;
290 cout << tab << rhs.size << endl;
294 if (lhs.version_name != rhs.version_name
295 && !check_version(lhs) && !check_version(rhs))
300 cout << tab << "incompatible versions" << endl;
301 cout << tab << lhs.version_name << endl;
302 cout << tab << rhs.version_name << endl;
314 has_symbol(const string& name, const symbols& s) throw()
315 { return s.find(name) != s.end(); }
318 get_symbol(const string& name, const symbols& s)
320 symbols::const_iterator i = s.find(name);
328 os << "get_symbol failed for symbol " << name;
329 __throw_logic_error(os.str().c_str());
334 examine_symbol(const char* name, const char* file)
338 symbols s = create_symbols(file);
339 const symbol& sym = get_symbol(name, s);
343 { __throw_exception_again; }
347 compare_symbols(const char* baseline_file, const char* test_file,
350 // Input both lists of symbols into container.
351 symbols baseline = create_symbols(baseline_file);
352 symbols test = create_symbols(test_file);
354 // Sanity check results.
355 if (!baseline.size() || !test.size())
357 cerr << "Problems parsing the list of exported symbols." << endl;
361 // Check to see if any long double compatibility symbols are produced.
362 bool ld_version_found(false);
363 symbols::iterator li(test.begin());
364 while (!ld_version_found && li != test.end())
366 if (li->second.version_name.find("_LDBL_") != std::string::npos)
367 ld_version_found = true;
372 // Assuming all baseline names and test names are both unique w/ no
375 // The names added to missing_names are baseline names not found in
377 // -> symbols that have been deleted.
379 // The names added to added_names are test names not in
381 // -> symbols that have been added.
382 typedef std::vector<std::string> symbol_names;
383 symbol_names shared_names;
384 symbol_names missing_names;
385 symbol_names added_names;
386 for (li = test.begin(); li != test.end(); ++li)
387 added_names.push_back(li->first);
389 for (symbols::iterator i = baseline.begin(); i != baseline.end(); ++i)
391 string name(i->first);
392 symbol_names::iterator end = added_names.end();
393 symbol_names::iterator it = find(added_names.begin(), end, name);
397 shared_names.push_back(name);
398 added_names.erase(it);
402 // Iff no test long double compatibility symbols at all and the symbol
403 // missing is a baseline long double compatibility symbol, skip.
404 string version_name(i->second.version_name);
405 bool base_ld(version_name.find("_LDBL_") != std::string::npos);
406 if (!base_ld || base_ld && ld_version_found)
407 missing_names.push_back(name);
411 // Fill out list of incompatible symbols.
412 typedef pair<symbol, symbol> symbol_pair;
413 vector<symbol_pair> incompatible;
415 // Check missing names for compatibility.
416 for (size_t j = 0; j < missing_names.size(); ++j)
418 symbol& sbase = baseline[missing_names[j]];
419 sbase.status = symbol::subtracted;
420 incompatible.push_back(symbol_pair(sbase, sbase));
423 // Check shared names for compatibility.
424 const symbol_names::size_type shared_size = shared_names.size();
425 for (size_t k = 0; k < shared_size; ++k)
427 symbol& sbase = baseline[shared_names[k]];
428 symbol& stest = test[shared_names[k]];
429 stest.status = symbol::existing;
430 if (!check_compatible(sbase, stest))
431 incompatible.push_back(symbol_pair(sbase, stest));
434 // Check added names for compatibility.
435 const symbol_names::size_type added_size = added_names.size();
436 for (size_t l = 0; l < added_size; ++l)
438 symbol& stest = test[added_names[l]];
439 stest.status = symbol::added;
440 if (!check_version(stest, true))
441 incompatible.push_back(symbol_pair(stest, stest));
445 if (verbose && added_names.size())
447 cout << endl << added_names.size() << " added symbols " << endl;
448 for (size_t j = 0; j < added_names.size() ; ++j)
451 test[added_names[j]].print();
455 if (verbose && missing_names.size())
457 cout << endl << missing_names.size() << " missing symbols " << endl;
458 for (size_t j = 0; j < missing_names.size() ; ++j)
461 baseline[missing_names[j]].print();
465 if (verbose && incompatible.size())
467 cout << endl << incompatible.size() << " incompatible symbols " << endl;
468 for (size_t j = 0; j < incompatible.size() ; ++j)
470 // First, print index.
473 // Second, report name.
474 symbol& sbase = incompatible[j].first;
475 symbol& stest = incompatible[j].second;
478 // Second, report reason or reasons incompatible.
479 check_compatible(sbase, stest, true);
483 cout << "\n\t\t=== libstdc++-v3 check-abi Summary ===" << endl;
485 cout << "# of added symbols:\t\t " << added_names.size() << endl;
486 cout << "# of missing symbols:\t\t " << missing_names.size() << endl;
487 cout << "# of incompatible symbols:\t " << incompatible.size() << endl;
489 cout << "using: " << baseline_file << endl;
491 return !(missing_names.size() || incompatible.size());
496 create_symbols(const char* file)
502 // Organize file data into an associated container (symbols) of symbol
503 // objects mapped to mangled names without versioning
507 while (getline(ifs, line).good())
518 os << "create_symbols failed for file " << file;
519 __throw_runtime_error(os.str().c_str());
526 demangle(const std::string& mangled)
529 if (mangled[0] != '_' || mangled[1] != 'Z')
531 // This is not a mangled symbol, thus has "C" linkage.
532 name = mangled.c_str();
536 // Use __cxa_demangle to demangle.
538 name = abi::__cxa_demangle(mangled.c_str(), 0, 0, &status);
544 name = "error code = 0: success";
547 name = "error code = -1: memory allocation failure";
550 name = "error code = -2: invalid mangled name";
553 name = "error code = -3: invalid arguments";
556 name = "error code unknown - who knows what happened";