]>
Commit | Line | Data |
---|---|---|
4b260c20 BK |
1 | // -*- C++ -*- |
2 | ||
c75bd36b | 3 | // Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011 |
1e2c0906 | 4 | // Free Software Foundation, Inc. |
4b260c20 BK |
5 | |
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 | |
748086b7 | 8 | // published by the Free Software Foundation; either version 3, or (at |
4b260c20 BK |
9 | // your option) any later version. |
10 | ||
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. | |
15 | ||
16 | // You should have received a copy of the GNU General Public License | |
748086b7 JJ |
17 | // along with this library; see the file COPYING3. If not see |
18 | // <http://www.gnu.org/licenses/>. | |
4b260c20 | 19 | |
4b260c20 BK |
20 | |
21 | // Benjamin Kosnik <bkoz@redhat.com> | |
22 | ||
23 | #include "testsuite_abi.h" | |
0c3de900 | 24 | #include <cstdlib> |
4b260c20 BK |
25 | #include <sstream> |
26 | #include <fstream> | |
27 | #include <iostream> | |
0c3de900 | 28 | #include <vector> |
4f39bf5c | 29 | #include <algorithm> |
4b260c20 BK |
30 | |
31 | using namespace std; | |
32 | ||
33 | void | |
34 | symbol::init(string& data) | |
35 | { | |
36 | const char delim = ':'; | |
37 | const char version_delim = '@'; | |
38 | const string::size_type npos = string::npos; | |
39 | string::size_type n = 0; | |
40 | ||
41 | // Set the type. | |
42 | if (data.find("FUNC") == 0) | |
43 | type = symbol::function; | |
44 | else if (data.find("OBJECT") == 0) | |
45 | type = symbol::object; | |
bf718682 BK |
46 | else if (data.find("TLS") == 0) |
47 | type = symbol::tls; | |
bb2b2a24 | 48 | |
4b260c20 BK |
49 | n = data.find_first_of(delim); |
50 | if (n != npos) | |
51 | data.erase(data.begin(), data.begin() + n + 1); | |
52 | ||
bf718682 BK |
53 | // Iff object or TLS, get size info. |
54 | if (type == symbol::object || type == symbol::tls) | |
4b260c20 BK |
55 | { |
56 | n = data.find_first_of(delim); | |
57 | if (n != npos) | |
58 | { | |
69240fc2 SW |
59 | string objectsize(data.begin(), data.begin() + n); |
60 | istringstream iss(objectsize); | |
4b260c20 BK |
61 | int x; |
62 | iss >> x; | |
63 | if (!iss.fail()) | |
64 | size = x; | |
65 | data.erase(data.begin(), data.begin() + n + 1); | |
66 | } | |
67 | } | |
68 | ||
bb2b2a24 BK |
69 | // Set the name and raw_name. |
70 | raw_name = string(data.begin(), data.end()); | |
4b260c20 BK |
71 | n = data.find_first_of(version_delim); |
72 | if (n != npos) | |
73 | { | |
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); | |
78 | ||
79 | // Set version name. | |
80 | version_name = data; | |
81 | } | |
82 | else | |
83 | { | |
84 | // No versioning info. | |
85 | name = string(data.begin(), data.end()); | |
bb2b2a24 | 86 | version_status = symbol::none; |
4b260c20 BK |
87 | } |
88 | ||
89 | // Set the demangled name. | |
90 | demangled_name = demangle(name); | |
91 | } | |
92 | ||
93 | void | |
94 | symbol::print() const | |
95 | { | |
96 | const char tab = '\t'; | |
bb2b2a24 | 97 | cout << name << endl; |
4b260c20 | 98 | |
bb2b2a24 BK |
99 | if (demangled_name != name) |
100 | cout << demangled_name << endl; | |
101 | ||
102 | string vers; | |
103 | switch (version_status) | |
4b260c20 BK |
104 | { |
105 | case none: | |
bb2b2a24 BK |
106 | vers = "none"; |
107 | break; | |
108 | case compatible: | |
109 | vers = "compatible"; | |
110 | break; | |
111 | case incompatible: | |
112 | vers = "incompatible"; | |
113 | break; | |
114 | case unversioned: | |
115 | vers = "unversioned"; | |
4b260c20 | 116 | break; |
bb2b2a24 BK |
117 | default: |
118 | vers = "<default>"; | |
119 | } | |
120 | cout << "version status: " << vers << endl; | |
121 | ||
122 | if (version_name.size() | |
123 | && (version_status == compatible || version_status == incompatible)) | |
124 | cout << version_name << endl; | |
125 | ||
126 | string type_string; | |
127 | switch (type) | |
128 | { | |
4b260c20 BK |
129 | case function: |
130 | type_string = "function"; | |
131 | break; | |
132 | case object: | |
133 | type_string = "object"; | |
134 | break; | |
bf718682 BK |
135 | case tls: |
136 | type_string = "tls"; | |
137 | break; | |
bb2b2a24 BK |
138 | case uncategorized: |
139 | type_string = "uncategorized"; | |
4b260c20 BK |
140 | break; |
141 | default: | |
142 | type_string = "<default>"; | |
143 | } | |
bb2b2a24 | 144 | cout << "type: " << type_string << endl; |
4b260c20 | 145 | |
bf718682 | 146 | if (type == object || type == tls) |
bb2b2a24 | 147 | cout << "type size: " << size << endl; |
4b260c20 BK |
148 | |
149 | string status_string; | |
150 | switch (status) | |
151 | { | |
4b260c20 BK |
152 | case added: |
153 | status_string = "added"; | |
154 | break; | |
155 | case subtracted: | |
156 | status_string = "subtracted"; | |
157 | break; | |
bb2b2a24 BK |
158 | case undesignated: |
159 | status_string = "undesignated"; | |
4b260c20 BK |
160 | break; |
161 | default: | |
162 | status_string = "<default>"; | |
163 | } | |
bb2b2a24 BK |
164 | cout << "status: " << status_string << endl; |
165 | ||
166 | cout << endl; | |
4b260c20 BK |
167 | } |
168 | ||
169 | ||
170 | bool | |
bb2b2a24 | 171 | check_version(symbol& test, bool added) |
4b260c20 | 172 | { |
bb2b2a24 | 173 | // Construct list of compatible versions. |
4b260c20 BK |
174 | typedef std::vector<std::string> compat_list; |
175 | static compat_list known_versions; | |
176 | if (known_versions.empty()) | |
177 | { | |
bb2b2a24 BK |
178 | // NB: First version here must be the default version for this |
179 | // version of DT_SONAME. | |
4b260c20 | 180 | known_versions.push_back("GLIBCXX_3.4"); |
7c9fee34 | 181 | known_versions.push_back("GLIBCXX_3.4.1"); |
9e802114 | 182 | known_versions.push_back("GLIBCXX_3.4.2"); |
0e98ac62 | 183 | known_versions.push_back("GLIBCXX_3.4.3"); |
bb2b2a24 | 184 | known_versions.push_back("GLIBCXX_3.4.4"); |
36b72d8d | 185 | known_versions.push_back("GLIBCXX_3.4.5"); |
bb2b2a24 | 186 | known_versions.push_back("GLIBCXX_3.4.6"); |
18c75543 | 187 | known_versions.push_back("GLIBCXX_3.4.7"); |
45f388bb | 188 | known_versions.push_back("GLIBCXX_3.4.8"); |
0efaed01 | 189 | known_versions.push_back("GLIBCXX_3.4.9"); |
5dddb7e5 | 190 | known_versions.push_back("GLIBCXX_3.4.10"); |
31908b79 | 191 | known_versions.push_back("GLIBCXX_3.4.11"); |
efdb7347 | 192 | known_versions.push_back("GLIBCXX_3.4.12"); |
95bfca5e | 193 | known_versions.push_back("GLIBCXX_3.4.13"); |
41bc3c4a | 194 | known_versions.push_back("GLIBCXX_3.4.14"); |
1e2c0906 | 195 | known_versions.push_back("GLIBCXX_3.4.15"); |
07703a37 | 196 | known_versions.push_back("GLIBCXX_3.4.16"); |
43653c33 | 197 | known_versions.push_back("GLIBCXX_3.4.17"); |
6defecc2 JJ |
198 | known_versions.push_back("GLIBCXX_LDBL_3.4"); |
199 | known_versions.push_back("GLIBCXX_LDBL_3.4.7"); | |
7371aff8 | 200 | known_versions.push_back("GLIBCXX_LDBL_3.4.10"); |
4b260c20 | 201 | known_versions.push_back("CXXABI_1.3"); |
44dd2da2 | 202 | known_versions.push_back("CXXABI_1.3.1"); |
9b4fc32c | 203 | known_versions.push_back("CXXABI_1.3.2"); |
c466b2cd | 204 | known_versions.push_back("CXXABI_1.3.3"); |
fae927d3 | 205 | known_versions.push_back("CXXABI_1.3.4"); |
0a35513e | 206 | known_versions.push_back("CXXABI_TM_1"); |
67275575 | 207 | known_versions.push_back("CXXABI_1.3.5"); |
50da34bb | 208 | known_versions.push_back("CXXABI_1.3.6"); |
6defecc2 | 209 | known_versions.push_back("CXXABI_LDBL_1.3"); |
4b260c20 BK |
210 | } |
211 | compat_list::iterator begin = known_versions.begin(); | |
212 | compat_list::iterator end = known_versions.end(); | |
213 | ||
bb2b2a24 BK |
214 | // Check for compatible version. |
215 | if (test.version_name.size()) | |
216 | { | |
217 | compat_list::iterator it1 = find(begin, end, test.version_name); | |
218 | compat_list::iterator it2 = find(begin, end, test.name); | |
219 | if (it1 != end) | |
220 | test.version_status = symbol::compatible; | |
221 | else | |
222 | test.version_status = symbol::incompatible; | |
223 | ||
c75bd36b JJ |
224 | // Check that added symbols aren't added in the base versions. |
225 | if (added | |
226 | && (test.version_name == known_versions[0] | |
227 | || test.version_name == "CXXABI_1.3" | |
228 | || test.version_name == "GLIBCXX_LDBL_3.4" | |
229 | || test.version_name == "CXXABI_LDBL_1.3")) | |
bb2b2a24 | 230 | test.version_status = symbol::incompatible; |
c75bd36b | 231 | |
0c312c2d BK |
232 | // Check that long double compatibility symbols demangled as |
233 | // __float128 are put into some _LDBL_ version name. | |
234 | if (added && test.demangled_name.find("__float128") != std::string::npos) | |
235 | { | |
236 | // Has to be in _LDBL_ version name. | |
237 | if (test.version_name.find("_LDBL_") == std::string::npos) | |
238 | test.version_status = symbol::incompatible; | |
239 | } | |
240 | ||
bb2b2a24 BK |
241 | // Check for weak label. |
242 | if (it1 == end && it2 == end) | |
243 | test.version_status = symbol::incompatible; | |
244 | ||
245 | // Check that | |
246 | // GLIBCXX_3.4 | |
247 | // GLIBCXX_3.4.5 | |
248 | // version as compatible | |
249 | // XXX | |
250 | } | |
251 | else | |
252 | { | |
253 | if (added) | |
254 | { | |
255 | // New version labels are ok. The rest are not. | |
256 | compat_list::iterator it2 = find(begin, end, test.name); | |
257 | if (it2 != end) | |
6defecc2 | 258 | test.version_status = symbol::compatible; |
bb2b2a24 BK |
259 | else |
260 | test.version_status = symbol::incompatible; | |
261 | } | |
262 | } | |
263 | return test.version_status == symbol::compatible; | |
4b260c20 BK |
264 | } |
265 | ||
266 | bool | |
bb2b2a24 | 267 | check_compatible(symbol& lhs, symbol& rhs, bool verbose) |
4b260c20 BK |
268 | { |
269 | bool ret = true; | |
270 | const char tab = '\t'; | |
271 | ||
272 | // Check to see if symbol_objects are compatible. | |
273 | if (lhs.type != rhs.type) | |
274 | { | |
275 | ret = false; | |
276 | if (verbose) | |
277 | cout << tab << "incompatible types" << endl; | |
278 | } | |
279 | ||
280 | if (lhs.name != rhs.name) | |
281 | { | |
282 | ret = false; | |
283 | if (verbose) | |
284 | cout << tab << "incompatible names" << endl; | |
285 | } | |
286 | ||
287 | if (lhs.size != rhs.size) | |
288 | { | |
289 | ret = false; | |
290 | if (verbose) | |
291 | { | |
292 | cout << tab << "incompatible sizes" << endl; | |
293 | cout << tab << lhs.size << endl; | |
294 | cout << tab << rhs.size << endl; | |
295 | } | |
296 | } | |
297 | ||
298 | if (lhs.version_name != rhs.version_name | |
299 | && !check_version(lhs) && !check_version(rhs)) | |
300 | { | |
301 | ret = false; | |
302 | if (verbose) | |
303 | { | |
304 | cout << tab << "incompatible versions" << endl; | |
305 | cout << tab << lhs.version_name << endl; | |
306 | cout << tab << rhs.version_name << endl; | |
307 | } | |
308 | } | |
309 | ||
310 | if (verbose) | |
311 | cout << endl; | |
312 | ||
313 | return ret; | |
314 | } | |
315 | ||
316 | ||
0c312c2d BK |
317 | inline bool |
318 | has_symbol(const string& name, const symbols& s) throw() | |
319 | { return s.find(name) != s.end(); } | |
4b260c20 | 320 | |
0c312c2d BK |
321 | const symbol& |
322 | get_symbol(const string& name, const symbols& s) | |
4b260c20 | 323 | { |
0c312c2d BK |
324 | symbols::const_iterator i = s.find(name); |
325 | if (i != s.end()) | |
4b260c20 | 326 | { |
0c312c2d | 327 | return i->second; |
4b260c20 BK |
328 | } |
329 | else | |
330 | { | |
331 | ostringstream os; | |
0c312c2d | 332 | os << "get_symbol failed for symbol " << name; |
56ffd9b3 | 333 | __throw_logic_error(os.str().c_str()); |
4b260c20 BK |
334 | } |
335 | } | |
336 | ||
337 | void | |
338 | examine_symbol(const char* name, const char* file) | |
339 | { | |
340 | try | |
341 | { | |
342 | symbols s = create_symbols(file); | |
0c312c2d | 343 | const symbol& sym = get_symbol(name, s); |
4b260c20 BK |
344 | sym.print(); |
345 | } | |
346 | catch(...) | |
d98fd134 | 347 | { __throw_exception_again; } |
4b260c20 BK |
348 | } |
349 | ||
fdbba6bc | 350 | int |
4b260c20 BK |
351 | compare_symbols(const char* baseline_file, const char* test_file, |
352 | bool verbose) | |
353 | { | |
354 | // Input both lists of symbols into container. | |
355 | symbols baseline = create_symbols(baseline_file); | |
356 | symbols test = create_symbols(test_file); | |
4b260c20 BK |
357 | |
358 | // Sanity check results. | |
0c312c2d | 359 | if (!baseline.size() || !test.size()) |
4b260c20 BK |
360 | { |
361 | cerr << "Problems parsing the list of exported symbols." << endl; | |
362 | exit(2); | |
363 | } | |
364 | ||
4a49c70b BK |
365 | // Check to see if any long double compatibility symbols are produced. |
366 | bool ld_version_found(false); | |
0c312c2d BK |
367 | symbols::iterator li(test.begin()); |
368 | while (!ld_version_found && li != test.end()) | |
4a49c70b | 369 | { |
0c312c2d | 370 | if (li->second.version_name.find("_LDBL_") != std::string::npos) |
4a49c70b BK |
371 | ld_version_found = true; |
372 | ++li; | |
373 | } | |
374 | ||
4b260c20 | 375 | // Sort out names. |
0c312c2d BK |
376 | // Assuming all baseline names and test names are both unique w/ no |
377 | // duplicates. | |
4b260c20 | 378 | // |
0c312c2d BK |
379 | // The names added to missing_names are baseline names not found in |
380 | // test names | |
4b260c20 BK |
381 | // -> symbols that have been deleted. |
382 | // | |
0c312c2d BK |
383 | // The names added to added_names are test names not in |
384 | // baseline names | |
4b260c20 | 385 | // -> symbols that have been added. |
0c312c2d | 386 | typedef std::vector<std::string> symbol_names; |
4b260c20 BK |
387 | symbol_names shared_names; |
388 | symbol_names missing_names; | |
0c312c2d BK |
389 | symbol_names added_names; |
390 | for (li = test.begin(); li != test.end(); ++li) | |
391 | added_names.push_back(li->first); | |
392 | ||
393 | for (symbols::iterator i = baseline.begin(); i != baseline.end(); ++i) | |
4b260c20 | 394 | { |
0c312c2d | 395 | string name(i->first); |
4b260c20 | 396 | symbol_names::iterator end = added_names.end(); |
0c312c2d | 397 | symbol_names::iterator it = find(added_names.begin(), end, name); |
4b260c20 BK |
398 | if (it != end) |
399 | { | |
400 | // Found. | |
0c312c2d | 401 | shared_names.push_back(name); |
4b260c20 BK |
402 | added_names.erase(it); |
403 | } | |
0c312c2d BK |
404 | else |
405 | { | |
406 | // Iff no test long double compatibility symbols at all and the symbol | |
407 | // missing is a baseline long double compatibility symbol, skip. | |
408 | string version_name(i->second.version_name); | |
409 | bool base_ld(version_name.find("_LDBL_") != std::string::npos); | |
410 | if (!base_ld || base_ld && ld_version_found) | |
411 | missing_names.push_back(name); | |
412 | } | |
4b260c20 BK |
413 | } |
414 | ||
0c312c2d | 415 | // Fill out list of incompatible symbols. |
4b260c20 BK |
416 | typedef pair<symbol, symbol> symbol_pair; |
417 | vector<symbol_pair> incompatible; | |
0c312c2d BK |
418 | |
419 | // Check missing names for compatibility. | |
420 | for (size_t j = 0; j < missing_names.size(); ++j) | |
4b260c20 | 421 | { |
0c312c2d BK |
422 | symbol& sbase = baseline[missing_names[j]]; |
423 | sbase.status = symbol::subtracted; | |
424 | incompatible.push_back(symbol_pair(sbase, sbase)); | |
4b260c20 BK |
425 | } |
426 | ||
427 | // Check shared names for compatibility. | |
6defecc2 JJ |
428 | const symbol_names::size_type shared_size = shared_names.size(); |
429 | for (size_t k = 0; k < shared_size; ++k) | |
4b260c20 | 430 | { |
0c312c2d BK |
431 | symbol& sbase = baseline[shared_names[k]]; |
432 | symbol& stest = test[shared_names[k]]; | |
433 | stest.status = symbol::existing; | |
434 | if (!check_compatible(sbase, stest)) | |
435 | incompatible.push_back(symbol_pair(sbase, stest)); | |
4b260c20 BK |
436 | } |
437 | ||
438 | // Check added names for compatibility. | |
6defecc2 JJ |
439 | const symbol_names::size_type added_size = added_names.size(); |
440 | for (size_t l = 0; l < added_size; ++l) | |
4b260c20 | 441 | { |
0c312c2d BK |
442 | symbol& stest = test[added_names[l]]; |
443 | stest.status = symbol::added; | |
444 | if (!check_version(stest, true)) | |
445 | incompatible.push_back(symbol_pair(stest, stest)); | |
4b260c20 BK |
446 | } |
447 | ||
448 | // Report results. | |
449 | if (verbose && added_names.size()) | |
450 | { | |
bb2b2a24 | 451 | cout << endl << added_names.size() << " added symbols " << endl; |
4b260c20 | 452 | for (size_t j = 0; j < added_names.size() ; ++j) |
bb2b2a24 BK |
453 | { |
454 | cout << j << endl; | |
0c312c2d | 455 | test[added_names[j]].print(); |
bb2b2a24 | 456 | } |
4b260c20 BK |
457 | } |
458 | ||
459 | if (verbose && missing_names.size()) | |
460 | { | |
bb2b2a24 | 461 | cout << endl << missing_names.size() << " missing symbols " << endl; |
4b260c20 | 462 | for (size_t j = 0; j < missing_names.size() ; ++j) |
bb2b2a24 BK |
463 | { |
464 | cout << j << endl; | |
0c312c2d | 465 | baseline[missing_names[j]].print(); |
bb2b2a24 | 466 | } |
4b260c20 BK |
467 | } |
468 | ||
469 | if (verbose && incompatible.size()) | |
470 | { | |
bb2b2a24 | 471 | cout << endl << incompatible.size() << " incompatible symbols " << endl; |
4b260c20 BK |
472 | for (size_t j = 0; j < incompatible.size() ; ++j) |
473 | { | |
bb2b2a24 BK |
474 | // First, print index. |
475 | cout << j << endl; | |
476 | ||
477 | // Second, report name. | |
0c312c2d BK |
478 | symbol& sbase = incompatible[j].first; |
479 | symbol& stest = incompatible[j].second; | |
480 | stest.print(); | |
4b260c20 BK |
481 | |
482 | // Second, report reason or reasons incompatible. | |
0c312c2d | 483 | check_compatible(sbase, stest, true); |
4b260c20 BK |
484 | } |
485 | } | |
486 | ||
487 | cout << "\n\t\t=== libstdc++-v3 check-abi Summary ===" << endl; | |
488 | cout << endl; | |
489 | cout << "# of added symbols:\t\t " << added_names.size() << endl; | |
490 | cout << "# of missing symbols:\t\t " << missing_names.size() << endl; | |
491 | cout << "# of incompatible symbols:\t " << incompatible.size() << endl; | |
492 | cout << endl; | |
493 | cout << "using: " << baseline_file << endl; | |
fdbba6bc MM |
494 | |
495 | return !(missing_names.size() || incompatible.size()); | |
4b260c20 BK |
496 | } |
497 | ||
498 | ||
499 | symbols | |
500 | create_symbols(const char* file) | |
501 | { | |
502 | symbols s; | |
503 | ifstream ifs(file); | |
504 | if (ifs.is_open()) | |
505 | { | |
0c312c2d BK |
506 | // Organize file data into an associated container (symbols) of symbol |
507 | // objects mapped to mangled names without versioning | |
508 | // information. | |
4b260c20 BK |
509 | const string empty; |
510 | string line = empty; | |
511 | while (getline(ifs, line).good()) | |
512 | { | |
513 | symbol tmp; | |
514 | tmp.init(line); | |
0c312c2d | 515 | s[tmp.name] = tmp; |
4b260c20 BK |
516 | line = empty; |
517 | } | |
518 | } | |
519 | else | |
520 | { | |
521 | ostringstream os; | |
522 | os << "create_symbols failed for file " << file; | |
56ffd9b3 | 523 | __throw_runtime_error(os.str().c_str()); |
4b260c20 BK |
524 | } |
525 | return s; | |
526 | } | |
527 | ||
528 | ||
529 | const char* | |
530 | demangle(const std::string& mangled) | |
531 | { | |
532 | const char* name; | |
533 | if (mangled[0] != '_' || mangled[1] != 'Z') | |
534 | { | |
535 | // This is not a mangled symbol, thus has "C" linkage. | |
536 | name = mangled.c_str(); | |
537 | } | |
538 | else | |
539 | { | |
540 | // Use __cxa_demangle to demangle. | |
541 | int status = 0; | |
542 | name = abi::__cxa_demangle(mangled.c_str(), 0, 0, &status); | |
543 | if (!name) | |
544 | { | |
545 | switch (status) | |
546 | { | |
547 | case 0: | |
548 | name = "error code = 0: success"; | |
549 | break; | |
550 | case -1: | |
551 | name = "error code = -1: memory allocation failure"; | |
552 | break; | |
553 | case -2: | |
554 | name = "error code = -2: invalid mangled name"; | |
555 | break; | |
556 | case -3: | |
557 | name = "error code = -3: invalid arguments"; | |
558 | break; | |
559 | default: | |
560 | name = "error code unknown - who knows what happened"; | |
561 | } | |
562 | } | |
563 | } | |
564 | return name; | |
565 | } | |
566 |