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_3.4.16");
197 known_versions
.push_back("GLIBCXX_LDBL_3.4");
198 known_versions
.push_back("GLIBCXX_LDBL_3.4.7");
199 known_versions
.push_back("GLIBCXX_LDBL_3.4.10");
200 known_versions
.push_back("CXXABI_1.3");
201 known_versions
.push_back("CXXABI_1.3.1");
202 known_versions
.push_back("CXXABI_1.3.2");
203 known_versions
.push_back("CXXABI_1.3.3");
204 known_versions
.push_back("CXXABI_1.3.4");
205 known_versions
.push_back("CXXABI_1.3.5");
206 known_versions
.push_back("CXXABI_LDBL_1.3");
208 compat_list::iterator begin
= known_versions
.begin();
209 compat_list::iterator end
= known_versions
.end();
211 // Check for compatible version.
212 if (test
.version_name
.size())
214 compat_list::iterator it1
= find(begin
, end
, test
.version_name
);
215 compat_list::iterator it2
= find(begin
, end
, test
.name
);
217 test
.version_status
= symbol::compatible
;
219 test
.version_status
= symbol::incompatible
;
221 // Check that added symbols aren't added in the base versions.
223 && (test
.version_name
== known_versions
[0]
224 || test
.version_name
== "CXXABI_1.3"
225 || test
.version_name
== "GLIBCXX_LDBL_3.4"
226 || test
.version_name
== "CXXABI_LDBL_1.3"))
227 test
.version_status
= symbol::incompatible
;
229 // Check that long double compatibility symbols demangled as
230 // __float128 are put into some _LDBL_ version name.
231 if (added
&& test
.demangled_name
.find("__float128") != std::string::npos
)
233 // Has to be in _LDBL_ version name.
234 if (test
.version_name
.find("_LDBL_") == std::string::npos
)
235 test
.version_status
= symbol::incompatible
;
238 // Check for weak label.
239 if (it1
== end
&& it2
== end
)
240 test
.version_status
= symbol::incompatible
;
245 // version as compatible
252 // New version labels are ok. The rest are not.
253 compat_list::iterator it2
= find(begin
, end
, test
.name
);
255 test
.version_status
= symbol::compatible
;
257 test
.version_status
= symbol::incompatible
;
260 return test
.version_status
== symbol::compatible
;
264 check_compatible(symbol
& lhs
, symbol
& rhs
, bool verbose
)
267 const char tab
= '\t';
269 // Check to see if symbol_objects are compatible.
270 if (lhs
.type
!= rhs
.type
)
274 cout
<< tab
<< "incompatible types" << endl
;
277 if (lhs
.name
!= rhs
.name
)
281 cout
<< tab
<< "incompatible names" << endl
;
284 if (lhs
.size
!= rhs
.size
)
289 cout
<< tab
<< "incompatible sizes" << endl
;
290 cout
<< tab
<< lhs
.size
<< endl
;
291 cout
<< tab
<< rhs
.size
<< endl
;
295 if (lhs
.version_name
!= rhs
.version_name
296 && !check_version(lhs
) && !check_version(rhs
))
301 cout
<< tab
<< "incompatible versions" << endl
;
302 cout
<< tab
<< lhs
.version_name
<< endl
;
303 cout
<< tab
<< rhs
.version_name
<< endl
;
315 has_symbol(const string
& name
, const symbols
& s
) throw()
316 { return s
.find(name
) != s
.end(); }
319 get_symbol(const string
& name
, const symbols
& s
)
321 symbols::const_iterator i
= s
.find(name
);
329 os
<< "get_symbol failed for symbol " << name
;
330 __throw_logic_error(os
.str().c_str());
335 examine_symbol(const char* name
, const char* file
)
339 symbols s
= create_symbols(file
);
340 const symbol
& sym
= get_symbol(name
, s
);
344 { __throw_exception_again
; }
348 compare_symbols(const char* baseline_file
, const char* test_file
,
351 // Input both lists of symbols into container.
352 symbols baseline
= create_symbols(baseline_file
);
353 symbols test
= create_symbols(test_file
);
355 // Sanity check results.
356 if (!baseline
.size() || !test
.size())
358 cerr
<< "Problems parsing the list of exported symbols." << endl
;
362 // Check to see if any long double compatibility symbols are produced.
363 bool ld_version_found(false);
364 symbols::iterator
li(test
.begin());
365 while (!ld_version_found
&& li
!= test
.end())
367 if (li
->second
.version_name
.find("_LDBL_") != std::string::npos
)
368 ld_version_found
= true;
373 // Assuming all baseline names and test names are both unique w/ no
376 // The names added to missing_names are baseline names not found in
378 // -> symbols that have been deleted.
380 // The names added to added_names are test names not in
382 // -> symbols that have been added.
383 typedef std::vector
<std::string
> symbol_names
;
384 symbol_names shared_names
;
385 symbol_names missing_names
;
386 symbol_names added_names
;
387 for (li
= test
.begin(); li
!= test
.end(); ++li
)
388 added_names
.push_back(li
->first
);
390 for (symbols::iterator i
= baseline
.begin(); i
!= baseline
.end(); ++i
)
392 string
name(i
->first
);
393 symbol_names::iterator end
= added_names
.end();
394 symbol_names::iterator it
= find(added_names
.begin(), end
, name
);
398 shared_names
.push_back(name
);
399 added_names
.erase(it
);
403 // Iff no test long double compatibility symbols at all and the symbol
404 // missing is a baseline long double compatibility symbol, skip.
405 string
version_name(i
->second
.version_name
);
406 bool base_ld(version_name
.find("_LDBL_") != std::string::npos
);
407 if (!base_ld
|| base_ld
&& ld_version_found
)
408 missing_names
.push_back(name
);
412 // Fill out list of incompatible symbols.
413 typedef pair
<symbol
, symbol
> symbol_pair
;
414 vector
<symbol_pair
> incompatible
;
416 // Check missing names for compatibility.
417 for (size_t j
= 0; j
< missing_names
.size(); ++j
)
419 symbol
& sbase
= baseline
[missing_names
[j
]];
420 sbase
.status
= symbol::subtracted
;
421 incompatible
.push_back(symbol_pair(sbase
, sbase
));
424 // Check shared names for compatibility.
425 const symbol_names::size_type shared_size
= shared_names
.size();
426 for (size_t k
= 0; k
< shared_size
; ++k
)
428 symbol
& sbase
= baseline
[shared_names
[k
]];
429 symbol
& stest
= test
[shared_names
[k
]];
430 stest
.status
= symbol::existing
;
431 if (!check_compatible(sbase
, stest
))
432 incompatible
.push_back(symbol_pair(sbase
, stest
));
435 // Check added names for compatibility.
436 const symbol_names::size_type added_size
= added_names
.size();
437 for (size_t l
= 0; l
< added_size
; ++l
)
439 symbol
& stest
= test
[added_names
[l
]];
440 stest
.status
= symbol::added
;
441 if (!check_version(stest
, true))
442 incompatible
.push_back(symbol_pair(stest
, stest
));
446 if (verbose
&& added_names
.size())
448 cout
<< endl
<< added_names
.size() << " added symbols " << endl
;
449 for (size_t j
= 0; j
< added_names
.size() ; ++j
)
452 test
[added_names
[j
]].print();
456 if (verbose
&& missing_names
.size())
458 cout
<< endl
<< missing_names
.size() << " missing symbols " << endl
;
459 for (size_t j
= 0; j
< missing_names
.size() ; ++j
)
462 baseline
[missing_names
[j
]].print();
466 if (verbose
&& incompatible
.size())
468 cout
<< endl
<< incompatible
.size() << " incompatible symbols " << endl
;
469 for (size_t j
= 0; j
< incompatible
.size() ; ++j
)
471 // First, print index.
474 // Second, report name.
475 symbol
& sbase
= incompatible
[j
].first
;
476 symbol
& stest
= incompatible
[j
].second
;
479 // Second, report reason or reasons incompatible.
480 check_compatible(sbase
, stest
, true);
484 cout
<< "\n\t\t=== libstdc++-v3 check-abi Summary ===" << endl
;
486 cout
<< "# of added symbols:\t\t " << added_names
.size() << endl
;
487 cout
<< "# of missing symbols:\t\t " << missing_names
.size() << endl
;
488 cout
<< "# of incompatible symbols:\t " << incompatible
.size() << endl
;
490 cout
<< "using: " << baseline_file
<< endl
;
492 return !(missing_names
.size() || incompatible
.size());
497 create_symbols(const char* file
)
503 // Organize file data into an associated container (symbols) of symbol
504 // objects mapped to mangled names without versioning
508 while (getline(ifs
, line
).good())
519 os
<< "create_symbols failed for file " << file
;
520 __throw_runtime_error(os
.str().c_str());
527 demangle(const std::string
& mangled
)
530 if (mangled
[0] != '_' || mangled
[1] != 'Z')
532 // This is not a mangled symbol, thus has "C" linkage.
533 name
= mangled
.c_str();
537 // Use __cxa_demangle to demangle.
539 name
= abi::__cxa_demangle(mangled
.c_str(), 0, 0, &status
);
545 name
= "error code = 0: success";
548 name
= "error code = -1: memory allocation failure";
551 name
= "error code = -2: invalid mangled name";
554 name
= "error code = -3: invalid arguments";
557 name
= "error code unknown - who knows what happened";