* Makefile.in (WERROR_FLAGS): Renamed from WERROR.
[official-gcc.git] / libstdc++-v3 / testsuite / testsuite_abi.cc
blobc350c81528e1cb24f17849a119d396da74294796
1 // -*- C++ -*-
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
28 // Public License.
30 // Benjamin Kosnik <bkoz@redhat.com>
32 #include "testsuite_abi.h"
33 #include <sstream>
34 #include <fstream>
35 #include <iostream>
37 using namespace std;
39 void
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;
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);
58 // Iff object, get size info.
59 if (type == symbol::object)
61 n = data.find_first_of(delim);
62 if (n != npos)
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);
74 // Set the name.
75 n = data.find_first_of(version_delim);
76 if (n != npos)
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);
83 // Set version name.
84 version_name = data;
86 else
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);
97 void
98 symbol::print() const
100 const char tab = '\t';
101 cout << tab << name << endl;
102 cout << tab << demangled_name << endl;
103 cout << tab << version_name << endl;
105 string type_string;
106 switch (type)
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>";
123 cout << tab << type_string << endl;
125 if (type == object)
126 cout << tab << size << endl;
128 string status_string;
129 switch (status)
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>";
149 cout << tab << status_string << endl;
153 bool
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("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("GLIBCXX_3.4.4");
169 known_versions.push_back("CXXABI_1.2");
170 known_versions.push_back("CXXABI_1.2.1");
171 known_versions.push_back("CXXABI_1.3");
173 compat_list::iterator begin = known_versions.begin();
174 compat_list::iterator end = known_versions.end();
176 // Check version names for compatibility...
177 compat_list::iterator it1 = find(begin, end, test.version_name);
179 // Check for weak label.
180 compat_list::iterator it2 = find(begin, end, test.name);
182 // Check that added symbols aren't added in the base version.
183 bool compat = true;
184 if (added && test.version_name == known_versions[0])
185 compat = false;
187 if (it1 == end && it2 == end)
188 compat = false;
190 return compat;
193 bool
194 check_compatible(const symbol& lhs, const symbol& rhs, bool verbose)
196 bool ret = true;
197 const char tab = '\t';
199 // Check to see if symbol_objects are compatible.
200 if (lhs.type != rhs.type)
202 ret = false;
203 if (verbose)
204 cout << tab << "incompatible types" << endl;
207 if (lhs.name != rhs.name)
209 ret = false;
210 if (verbose)
211 cout << tab << "incompatible names" << endl;
214 if (lhs.size != rhs.size)
216 ret = false;
217 if (verbose)
219 cout << tab << "incompatible sizes" << endl;
220 cout << tab << lhs.size << endl;
221 cout << tab << rhs.size << endl;
225 if (lhs.version_name != rhs.version_name
226 && !check_version(lhs) && !check_version(rhs))
228 ret = false;
229 if (verbose)
231 cout << tab << "incompatible versions" << endl;
232 cout << tab << lhs.version_name << endl;
233 cout << tab << rhs.version_name << endl;
237 if (verbose)
238 cout << endl;
240 return ret;
244 bool
245 has_symbol(const string& mangled, const symbols& s) throw()
247 const symbol_names& names = s.first;
248 symbol_names::const_iterator i = find(names.begin(), names.end(), mangled);
249 return i != names.end();
252 symbol&
253 get_symbol(const string& mangled, const symbols& s)
255 const symbol_names& names = s.first;
256 symbol_names::const_iterator i = find(names.begin(), names.end(), mangled);
257 if (i != names.end())
259 symbol_objects objects = s.second;
260 return objects[mangled];
262 else
264 ostringstream os;
265 os << "get_symbol failed for symbol " << mangled;
266 throw symbol_error(os.str());
270 void
271 examine_symbol(const char* name, const char* file)
275 symbols s = create_symbols(file);
276 symbol& sym = get_symbol(name, s);
277 sym.print();
279 catch(...)
280 { throw; }
283 void
284 compare_symbols(const char* baseline_file, const char* test_file,
285 bool verbose)
287 // Input both lists of symbols into container.
288 symbols baseline = create_symbols(baseline_file);
289 symbols test = create_symbols(test_file);
290 symbol_names& baseline_names = baseline.first;
291 symbol_objects& baseline_objects = baseline.second;
292 symbol_names& test_names = test.first;
293 symbol_objects& test_objects = test.second;
295 // Sanity check results.
296 const symbol_names::size_type baseline_size = baseline_names.size();
297 const symbol_names::size_type test_size = test_names.size();
298 if (!baseline_size || !test_size)
300 cerr << "Problems parsing the list of exported symbols." << endl;
301 exit(2);
304 // Sort out names.
305 // Assuming baseline_names, test_names are both unique w/ no duplicates.
307 // The names added to missing_names are baseline_names not found in
308 // test_names
309 // -> symbols that have been deleted.
311 // The names added to added_names are test_names are names not in
312 // baseline_names
313 // -> symbols that have been added.
314 symbol_names shared_names;
315 symbol_names missing_names;
316 symbol_names added_names = test_names;
317 for (size_t i = 0; i < baseline_size; ++i)
319 string what(baseline_names[i]);
320 symbol_names::iterator end = added_names.end();
321 symbol_names::iterator it = find(added_names.begin(), end, what);
322 if (it != end)
324 // Found.
325 shared_names.push_back(what);
326 added_names.erase(it);
328 else
329 missing_names.push_back(what);
332 // Check missing names for compatibility.
333 typedef pair<symbol, symbol> symbol_pair;
334 vector<symbol_pair> incompatible;
335 for (size_t j = 0; j < missing_names.size(); ++j)
337 symbol base = baseline_objects[missing_names[j]];
338 incompatible.push_back(symbol_pair(base, base));
341 // Check shared names for compatibility.
342 for (size_t k = 0; k < shared_names.size(); ++k)
344 symbol base = baseline_objects[shared_names[k]];
345 symbol test = test_objects[shared_names[k]];
346 if (!check_compatible(base, test))
347 incompatible.push_back(symbol_pair(base, test));
350 // Check added names for compatibility.
351 for (size_t l = 0; l < added_names.size(); ++l)
353 symbol test = test_objects[added_names[l]];
354 if (!check_version(test, true))
355 incompatible.push_back(symbol_pair(test, test));
358 // Report results.
359 if (verbose && added_names.size())
361 cout << added_names.size() << " added symbols " << endl;
362 for (size_t j = 0; j < added_names.size() ; ++j)
363 test_objects[added_names[j]].print();
366 if (verbose && missing_names.size())
368 cout << missing_names.size() << " missing symbols " << endl;
369 for (size_t j = 0; j < missing_names.size() ; ++j)
370 baseline_objects[missing_names[j]].print();
373 if (verbose && incompatible.size())
375 cout << incompatible.size() << " incompatible symbols " << endl;
376 for (size_t j = 0; j < incompatible.size() ; ++j)
378 // First, report name.
379 const symbol& base = incompatible[j].first;
380 const symbol& test = incompatible[j].second;
381 test.print();
383 // Second, report reason or reasons incompatible.
384 check_compatible(base, test, true);
388 cout << "\n\t\t=== libstdc++-v3 check-abi Summary ===" << endl;
389 cout << endl;
390 cout << "# of added symbols:\t\t " << added_names.size() << endl;
391 cout << "# of missing symbols:\t\t " << missing_names.size() << endl;
392 cout << "# of incompatible symbols:\t " << incompatible.size() << endl;
393 cout << endl;
394 cout << "using: " << baseline_file << endl;
398 symbols
399 create_symbols(const char* file)
401 symbols s;
402 ifstream ifs(file);
403 if (ifs.is_open())
405 // Organize file data into container of symbol objects.
406 symbol_names& names = s.first;
407 symbol_objects& objects = s.second;
408 const string empty;
409 string line = empty;
410 while (getline(ifs, line).good())
412 symbol tmp;
413 tmp.init(line);
414 objects[tmp.name] = tmp;
415 names.push_back(tmp.name);
416 line = empty;
419 else
421 ostringstream os;
422 os << "create_symbols failed for file " << file;
423 throw runtime_error(os.str());
425 return s;
429 const char*
430 demangle(const std::string& mangled)
432 const char* name;
433 if (mangled[0] != '_' || mangled[1] != 'Z')
435 // This is not a mangled symbol, thus has "C" linkage.
436 name = mangled.c_str();
438 else
440 // Use __cxa_demangle to demangle.
441 int status = 0;
442 name = abi::__cxa_demangle(mangled.c_str(), 0, 0, &status);
443 if (!name)
445 switch (status)
447 case 0:
448 name = "error code = 0: success";
449 break;
450 case -1:
451 name = "error code = -1: memory allocation failure";
452 break;
453 case -2:
454 name = "error code = -2: invalid mangled name";
455 break;
456 case -3:
457 name = "error code = -3: invalid arguments";
458 break;
459 default:
460 name = "error code unknown - who knows what happened";
464 return name;