OSDN Git Service

2010-10-01 Benjamin Kosnik <bkoz@redhat.com>
[pf3gnuchains/gcc-fork.git] / libstdc++-v3 / testsuite / util / testsuite_abi.cc
1 // -*- C++ -*-
2
3 // Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009, 2010
4 // Free Software Foundation, Inc.
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
8 // published by the Free Software Foundation; either version 3, or (at
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
17 // along with this library; see the file COPYING3.  If not see
18 // <http://www.gnu.org/licenses/>.
19
20
21 // Benjamin Kosnik  <bkoz@redhat.com>
22
23 #include "testsuite_abi.h"
24 #include <cstdlib>
25 #include <sstream>
26 #include <fstream>
27 #include <iostream>
28 #include <vector>
29 #include <algorithm>
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;
46   else if (data.find("TLS") == 0)
47     type = symbol::tls;
48
49   n = data.find_first_of(delim);
50   if (n != npos)
51     data.erase(data.begin(), data.begin() + n + 1);
52
53   // Iff object or TLS, get size info.
54   if (type == symbol::object || type == symbol::tls)
55     {
56       n = data.find_first_of(delim);
57       if (n != npos)
58         {
59           string objectsize(data.begin(), data.begin() + n);
60           istringstream iss(objectsize);
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
69   // Set the name and raw_name.
70   raw_name = string(data.begin(), data.end());
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());
86       version_status = symbol::none;
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';
97   cout << name << endl;
98
99   if (demangled_name != name)
100     cout << demangled_name << endl;
101
102   string vers;
103   switch (version_status)
104     {
105     case none:
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";
116       break;
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     {
129     case function:
130       type_string = "function";
131       break;
132     case object:
133       type_string = "object";
134       break;
135     case tls:
136       type_string = "tls";
137       break;
138     case uncategorized:
139       type_string = "uncategorized";
140       break;
141     default:
142       type_string = "<default>";
143     }
144   cout << "type: " << type_string << endl;
145   
146   if (type == object || type == tls)
147     cout << "type size: " << size << endl;
148
149   string status_string;
150   switch (status)
151     {
152     case added:
153       status_string = "added";
154       break;
155     case subtracted:
156       status_string = "subtracted";
157       break;
158     case undesignated:
159       status_string = "undesignated";
160       break;
161     default:
162       status_string = "<default>";
163     }
164   cout << "status: " << status_string << endl;
165
166   cout << endl;
167 }
168
169
170 bool
171 check_version(symbol& test, bool added)
172 {
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())
177     {
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");
206     }
207   compat_list::iterator begin = known_versions.begin();
208   compat_list::iterator end = known_versions.end();
209
210   // Check for compatible version.
211   if (test.version_name.size())
212     {
213       compat_list::iterator it1 = find(begin, end, test.version_name);
214       compat_list::iterator it2 = find(begin, end, test.name);
215       if (it1 != end)
216         test.version_status = symbol::compatible;
217       else
218         test.version_status = symbol::incompatible;
219       
220       // Check that added symbols aren't added in the base version.
221       if (added && test.version_name == known_versions[0])
222         test.version_status = symbol::incompatible;
223       
224       // Check that long double compatibility symbols demangled as
225       // __float128 are put into some _LDBL_ version name.
226       if (added && test.demangled_name.find("__float128") != std::string::npos)
227         {
228           // Has to be in _LDBL_ version name.
229           if (test.version_name.find("_LDBL_") == std::string::npos)
230             test.version_status = symbol::incompatible;
231         }
232
233       // Check for weak label.
234       if (it1 == end && it2 == end)
235         test.version_status = symbol::incompatible;
236       
237       // Check that 
238       // GLIBCXX_3.4
239       // GLIBCXX_3.4.5
240       // version as compatible
241       // XXX
242     }
243   else
244     {
245       if (added)
246         {
247           // New version labels are ok. The rest are not.
248           compat_list::iterator it2 = find(begin, end, test.name);
249           if (it2 != end)
250             test.version_status = symbol::compatible;
251           else
252             test.version_status = symbol::incompatible;
253         }
254     }
255   return test.version_status == symbol::compatible;
256 }
257
258 bool 
259 check_compatible(symbol& lhs, symbol& rhs, bool verbose)
260 {
261   bool ret = true;
262   const char tab = '\t';
263
264   // Check to see if symbol_objects are compatible.
265   if (lhs.type != rhs.type)
266     {
267       ret = false;
268       if (verbose)
269         cout << tab << "incompatible types" << endl;
270     }
271   
272   if (lhs.name != rhs.name)
273     {
274       ret = false;
275       if (verbose)
276         cout << tab << "incompatible names" << endl;
277     }
278
279   if (lhs.size != rhs.size)
280     {
281       ret = false;
282       if (verbose)
283         {
284           cout << tab << "incompatible sizes" << endl;
285           cout << tab << lhs.size << endl;
286           cout << tab << rhs.size << endl;
287         }
288     }
289
290   if (lhs.version_name != rhs.version_name 
291       && !check_version(lhs) && !check_version(rhs))
292     {
293       ret = false;
294       if (verbose)
295         {
296           cout << tab << "incompatible versions" << endl;
297           cout << tab << lhs.version_name << endl;
298           cout << tab << rhs.version_name << endl;
299         }
300     }
301
302   if (verbose)
303     cout << endl;
304
305   return ret;
306 }
307
308
309 inline bool
310 has_symbol(const string& name, const symbols& s) throw()
311 { return s.find(name) != s.end(); }
312
313 const symbol&
314 get_symbol(const string& name, const symbols& s)
315 {
316   symbols::const_iterator i = s.find(name);
317   if (i != s.end())
318     {
319       return i->second;
320     }
321   else
322     {
323       ostringstream os;
324       os << "get_symbol failed for symbol " << name;
325       __throw_logic_error(os.str().c_str());
326     }
327 }
328
329 void 
330 examine_symbol(const char* name, const char* file)
331 {
332   try
333     {
334       symbols s = create_symbols(file);
335       const symbol& sym = get_symbol(name, s);
336       sym.print();
337     }
338   catch(...)
339     { __throw_exception_again; }
340 }
341
342 int
343 compare_symbols(const char* baseline_file, const char* test_file, 
344                 bool verbose)
345 {
346   // Input both lists of symbols into container.
347   symbols baseline = create_symbols(baseline_file);
348   symbols test = create_symbols(test_file);
349
350   //  Sanity check results.
351   if (!baseline.size() || !test.size())
352     {
353       cerr << "Problems parsing the list of exported symbols." << endl;
354       exit(2);
355     }
356
357   // Check to see if any long double compatibility symbols are produced.
358   bool ld_version_found(false);
359   symbols::iterator li(test.begin());
360   while (!ld_version_found && li != test.end())
361     {
362       if (li->second.version_name.find("_LDBL_") != std::string::npos)
363         ld_version_found = true;
364       ++li;
365     }
366
367   // Sort out names.
368   // Assuming all baseline names and test names are both unique w/ no
369   // duplicates.
370   //
371   // The names added to missing_names are baseline names not found in
372   // test names 
373   // -> symbols that have been deleted.
374   //
375   // The names added to added_names are test names not in
376   // baseline names
377   // -> symbols that have been added.
378   typedef std::vector<std::string> symbol_names;
379   symbol_names shared_names;
380   symbol_names missing_names;
381   symbol_names added_names;
382   for (li = test.begin(); li != test.end(); ++li)
383     added_names.push_back(li->first);
384
385   for (symbols::iterator i = baseline.begin(); i != baseline.end(); ++i)
386     {
387       string name(i->first);
388       symbol_names::iterator end = added_names.end();
389       symbol_names::iterator it = find(added_names.begin(), end, name);
390       if (it != end)
391         {
392           // Found.
393           shared_names.push_back(name);
394           added_names.erase(it);
395         }
396        else
397         {
398           // Iff no test long double compatibility symbols at all and the symbol
399           // missing is a baseline long double compatibility symbol, skip.
400           string version_name(i->second.version_name);
401           bool base_ld(version_name.find("_LDBL_") != std::string::npos);
402           if (!base_ld || base_ld && ld_version_found)
403             missing_names.push_back(name);
404         }
405     }
406
407   // Fill out list of incompatible symbols.
408   typedef pair<symbol, symbol> symbol_pair;
409   vector<symbol_pair> incompatible;
410
411   // Check missing names for compatibility.
412   for (size_t j = 0; j < missing_names.size(); ++j)
413     {
414       symbol& sbase = baseline[missing_names[j]];
415       sbase.status = symbol::subtracted;
416       incompatible.push_back(symbol_pair(sbase, sbase));
417     }
418
419   // Check shared names for compatibility.
420   const symbol_names::size_type shared_size = shared_names.size();
421   for (size_t k = 0; k < shared_size; ++k)
422     {
423       symbol& sbase = baseline[shared_names[k]];
424       symbol& stest = test[shared_names[k]];
425       stest.status = symbol::existing;
426       if (!check_compatible(sbase, stest))
427         incompatible.push_back(symbol_pair(sbase, stest));
428     }
429
430   // Check added names for compatibility.
431   const symbol_names::size_type added_size = added_names.size();
432   for (size_t l = 0; l < added_size; ++l)
433     {
434       symbol& stest = test[added_names[l]];
435       stest.status = symbol::added;
436       if (!check_version(stest, true))
437         incompatible.push_back(symbol_pair(stest, stest));
438     }
439
440   // Report results.
441   if (verbose && added_names.size())
442     {
443       cout << endl << added_names.size() << " added symbols " << endl;
444       for (size_t j = 0; j < added_names.size() ; ++j)
445         {
446           cout << j << endl;
447           test[added_names[j]].print();
448         }
449     }
450   
451   if (verbose && missing_names.size())
452     {
453       cout << endl << missing_names.size() << " missing symbols " << endl;
454       for (size_t j = 0; j < missing_names.size() ; ++j)
455         {
456           cout << j << endl;
457           baseline[missing_names[j]].print();
458         }
459     }
460   
461   if (verbose && incompatible.size())
462     {
463       cout << endl << incompatible.size() << " incompatible symbols " << endl;
464       for (size_t j = 0; j < incompatible.size() ; ++j)
465         {
466           // First, print index.
467           cout << j << endl;
468
469           // Second, report name.
470           symbol& sbase = incompatible[j].first;
471           symbol& stest = incompatible[j].second;
472           stest.print();
473           
474           // Second, report reason or reasons incompatible.
475           check_compatible(sbase, stest, true);
476         }
477     }
478   
479   cout << "\n\t\t=== libstdc++-v3 check-abi Summary ===" << endl;
480   cout << endl;
481   cout << "# of added symbols:\t\t " << added_names.size() << endl;
482   cout << "# of missing symbols:\t\t " << missing_names.size() << endl;
483   cout << "# of incompatible symbols:\t " << incompatible.size() << endl;
484   cout << endl;
485   cout << "using: " << baseline_file << endl;
486
487   return !(missing_names.size() || incompatible.size());
488 }
489
490
491 symbols
492 create_symbols(const char* file)
493 {
494   symbols s;
495   ifstream ifs(file);
496   if (ifs.is_open())
497     {
498       // Organize file data into an associated container (symbols) of symbol
499       // objects mapped to mangled names without versioning
500       // information.
501       const string empty;
502       string line = empty;
503       while (getline(ifs, line).good())
504         {
505           symbol tmp;
506           tmp.init(line);
507           s[tmp.name] = tmp;
508           line = empty;
509         }
510     }
511   else
512     {
513       ostringstream os;
514       os << "create_symbols failed for file " << file;
515       __throw_runtime_error(os.str().c_str());
516     }
517   return s;
518 }
519
520
521 const char*
522 demangle(const std::string& mangled)
523 {
524   const char* name;
525   if (mangled[0] != '_' || mangled[1] != 'Z')
526     {
527       // This is not a mangled symbol, thus has "C" linkage.
528       name = mangled.c_str();
529     }
530   else
531     {
532       // Use __cxa_demangle to demangle.
533       int status = 0;
534       name = abi::__cxa_demangle(mangled.c_str(), 0, 0, &status);
535       if (!name)
536         {
537           switch (status)
538             {
539             case 0:
540               name = "error code = 0: success";
541               break;
542             case -1:
543               name = "error code = -1: memory allocation failure";
544               break;
545             case -2:
546               name = "error code = -2: invalid mangled name";
547               break;
548             case -3:
549               name = "error code = -3: invalid arguments";
550               break;
551             default:
552               name = "error code unknown - who knows what happened";
553             }
554         }
555     }
556   return name;
557 }
558