3 // Copyright (C) 2004 Free Software Foundation, Inc.
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.
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.
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.
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
30 // Benjamin Kosnik <bkoz@redhat.com>
32 #include "testsuite_abi.h"
40 symbol::init(string& data)
42 const char delim = ':';
43 const char version_delim = '@';
44 const string::size_type npos = string::npos;
45 string::size_type n = 0;
48 if (data.find("FUNC") == 0)
49 type = symbol::function;
50 else if (data.find("OBJECT") == 0)
51 type = symbol::object;
54 n = data.find_first_of(delim);
56 data.erase(data.begin(), data.begin() + n + 1);
58 // Iff object, get size info.
59 if (type == symbol::object)
61 n = data.find_first_of(delim);
64 string size(data.begin(), data.begin() + n);
65 istringstream iss(size);
70 data.erase(data.begin(), data.begin() + n + 1);
75 n = data.find_first_of(version_delim);
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);
88 // No versioning info.
89 name = string(data.begin(), data.end());
90 data.erase(data.begin(), data.end());
93 // Set the demangled name.
94 demangled_name = demangle(name);
100 const char tab = '\t';
101 cout << tab << name << endl;
102 cout << tab << demangled_name << endl;
103 cout << tab << version_name << endl;
109 type_string = "none";
112 type_string = "function";
115 type_string = "object";
118 type_string = "error";
121 type_string = "<default>";
123 cout << tab << type_string << endl;
126 cout << tab << size << endl;
128 string status_string;
132 status_string = "unknown";
135 status_string = "added";
138 status_string = "subtracted";
141 status_string = "compatible";
144 status_string = "incompatible";
147 status_string = "<default>";
149 cout << tab << status_string << endl;
154 check_version(const symbol& test, bool added)
156 typedef std::vector<std::string> compat_list;
157 static compat_list known_versions;
158 if (known_versions.empty())
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");
169 compat_list::iterator begin = known_versions.begin();
170 compat_list::iterator end = known_versions.end();
172 // Check version names for compatibility...
173 compat_list::iterator it1 = find(begin, end, test.version_name);
175 // Check for weak label.
176 compat_list::iterator it2 = find(begin, end, test.name);
178 // Check that added symbols aren't added in the base version.
180 if (added && test.version_name == known_versions[0])
183 if (it1 == end && it2 == end)
190 check_compatible(const symbol& lhs, const symbol& rhs, bool verbose)
193 const char tab = '\t';
195 // Check to see if symbol_objects are compatible.
196 if (lhs.type != rhs.type)
200 cout << tab << "incompatible types" << endl;
203 if (lhs.name != rhs.name)
207 cout << tab << "incompatible names" << endl;
210 if (lhs.size != rhs.size)
215 cout << tab << "incompatible sizes" << endl;
216 cout << tab << lhs.size << endl;
217 cout << tab << rhs.size << endl;
221 if (lhs.version_name != rhs.version_name
222 && !check_version(lhs) && !check_version(rhs))
227 cout << tab << "incompatible versions" << endl;
228 cout << tab << lhs.version_name << endl;
229 cout << tab << rhs.version_name << endl;
241 has_symbol(const string& mangled, const symbols& s) throw()
243 const symbol_names& names = s.first;
244 symbol_names::const_iterator i = find(names.begin(), names.end(), mangled);
245 return i != names.end();
249 get_symbol(const string& mangled, const symbols& s)
251 const symbol_names& names = s.first;
252 symbol_names::const_iterator i = find(names.begin(), names.end(), mangled);
253 if (i != names.end())
255 symbol_objects objects = s.second;
256 return objects[mangled];
261 os << "get_symbol failed for symbol " << mangled;
262 throw symbol_error(os.str());
267 examine_symbol(const char* name, const char* file)
271 symbols s = create_symbols(file);
272 symbol& sym = get_symbol(name, s);
280 compare_symbols(const char* baseline_file, const char* test_file,
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;
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)
296 cerr << "Problems parsing the list of exported symbols." << endl;
301 // Assuming baseline_names, test_names are both unique w/ no duplicates.
303 // The names added to missing_names are baseline_names not found in
305 // -> symbols that have been deleted.
307 // The names added to added_names are test_names are names not in
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)
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);
321 shared_names.push_back(what);
322 added_names.erase(it);
325 missing_names.push_back(what);
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)
333 symbol base = baseline_objects[missing_names[i]];
334 incompatible.push_back(symbol_pair(base, base));
337 // Check shared names for compatibility.
338 for (size_t i = 0; i < shared_names.size(); ++i)
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));
346 // Check added names for compatibility.
347 for (size_t i = 0; i < added_names.size(); ++i)
349 symbol test = test_objects[added_names[i]];
350 if (!check_version(test, true))
351 incompatible.push_back(symbol_pair(test, test));
355 if (verbose && added_names.size())
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();
362 if (verbose && missing_names.size())
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();
369 if (verbose && incompatible.size())
371 cout << incompatible.size() << " incompatible symbols " << endl;
372 for (size_t j = 0; j < incompatible.size() ; ++j)
374 // First, report name.
375 const symbol& base = incompatible[j].first;
376 const symbol& test = incompatible[j].second;
379 // Second, report reason or reasons incompatible.
380 check_compatible(base, test, true);
384 cout << "\n\t\t=== libstdc++-v3 check-abi Summary ===" << 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;
390 cout << "using: " << baseline_file << endl;
395 create_symbols(const char* file)
401 // Organize file data into container of symbol objects.
402 symbol_names& names = s.first;
403 symbol_objects& objects = s.second;
406 while (getline(ifs, line).good())
410 objects[tmp.name] = tmp;
411 names.push_back(tmp.name);
418 os << "create_symbols failed for file " << file;
419 throw runtime_error(os.str());
426 demangle(const std::string& mangled)
429 if (mangled[0] != '_' || mangled[1] != 'Z')
431 // This is not a mangled symbol, thus has "C" linkage.
432 name = mangled.c_str();
436 // Use __cxa_demangle to demangle.
438 name = abi::__cxa_demangle(mangled.c_str(), 0, 0, &status);
444 name = "error code = 0: success";
447 name = "error code = -1: memory allocation failure";
450 name = "error code = -2: invalid mangled name";
453 name = "error code = -3: invalid arguments";
456 name = "error code unknown - who knows what happened";