OSDN Git Service

ea100b6817fb1b4740bfdb253b12cadbacbd7330
[pf3gnuchains/gcc-fork.git] / libstdc++-v3 / testsuite / util / testsuite_abi.cc
1 // -*- C++ -*-
2
3 // Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011
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_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");
207     }
208   compat_list::iterator begin = known_versions.begin();
209   compat_list::iterator end = known_versions.end();
210
211   // Check for compatible version.
212   if (test.version_name.size())
213     {
214       compat_list::iterator it1 = find(begin, end, test.version_name);
215       compat_list::iterator it2 = find(begin, end, test.name);
216       if (it1 != end)
217         test.version_status = symbol::compatible;
218       else
219         test.version_status = symbol::incompatible;
220       
221       // Check that added symbols aren't added in the base versions.
222       if (added
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;
228
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)
232         {
233           // Has to be in _LDBL_ version name.
234           if (test.version_name.find("_LDBL_") == std::string::npos)
235             test.version_status = symbol::incompatible;
236         }
237
238       // Check for weak label.
239       if (it1 == end && it2 == end)
240         test.version_status = symbol::incompatible;
241       
242       // Check that 
243       // GLIBCXX_3.4
244       // GLIBCXX_3.4.5
245       // version as compatible
246       // XXX
247     }
248   else
249     {
250       if (added)
251         {
252           // New version labels are ok. The rest are not.
253           compat_list::iterator it2 = find(begin, end, test.name);
254           if (it2 != end)
255             test.version_status = symbol::compatible;
256           else
257             test.version_status = symbol::incompatible;
258         }
259     }
260   return test.version_status == symbol::compatible;
261 }
262
263 bool 
264 check_compatible(symbol& lhs, symbol& rhs, bool verbose)
265 {
266   bool ret = true;
267   const char tab = '\t';
268
269   // Check to see if symbol_objects are compatible.
270   if (lhs.type != rhs.type)
271     {
272       ret = false;
273       if (verbose)
274         cout << tab << "incompatible types" << endl;
275     }
276   
277   if (lhs.name != rhs.name)
278     {
279       ret = false;
280       if (verbose)
281         cout << tab << "incompatible names" << endl;
282     }
283
284   if (lhs.size != rhs.size)
285     {
286       ret = false;
287       if (verbose)
288         {
289           cout << tab << "incompatible sizes" << endl;
290           cout << tab << lhs.size << endl;
291           cout << tab << rhs.size << endl;
292         }
293     }
294
295   if (lhs.version_name != rhs.version_name 
296       && !check_version(lhs) && !check_version(rhs))
297     {
298       ret = false;
299       if (verbose)
300         {
301           cout << tab << "incompatible versions" << endl;
302           cout << tab << lhs.version_name << endl;
303           cout << tab << rhs.version_name << endl;
304         }
305     }
306
307   if (verbose)
308     cout << endl;
309
310   return ret;
311 }
312
313
314 inline bool
315 has_symbol(const string& name, const symbols& s) throw()
316 { return s.find(name) != s.end(); }
317
318 const symbol&
319 get_symbol(const string& name, const symbols& s)
320 {
321   symbols::const_iterator i = s.find(name);
322   if (i != s.end())
323     {
324       return i->second;
325     }
326   else
327     {
328       ostringstream os;
329       os << "get_symbol failed for symbol " << name;
330       __throw_logic_error(os.str().c_str());
331     }
332 }
333
334 void 
335 examine_symbol(const char* name, const char* file)
336 {
337   try
338     {
339       symbols s = create_symbols(file);
340       const symbol& sym = get_symbol(name, s);
341       sym.print();
342     }
343   catch(...)
344     { __throw_exception_again; }
345 }
346
347 int
348 compare_symbols(const char* baseline_file, const char* test_file, 
349                 bool verbose)
350 {
351   // Input both lists of symbols into container.
352   symbols baseline = create_symbols(baseline_file);
353   symbols test = create_symbols(test_file);
354
355   //  Sanity check results.
356   if (!baseline.size() || !test.size())
357     {
358       cerr << "Problems parsing the list of exported symbols." << endl;
359       exit(2);
360     }
361
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())
366     {
367       if (li->second.version_name.find("_LDBL_") != std::string::npos)
368         ld_version_found = true;
369       ++li;
370     }
371
372   // Sort out names.
373   // Assuming all baseline names and test names are both unique w/ no
374   // duplicates.
375   //
376   // The names added to missing_names are baseline names not found in
377   // test names 
378   // -> symbols that have been deleted.
379   //
380   // The names added to added_names are test names not in
381   // baseline names
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);
389
390   for (symbols::iterator i = baseline.begin(); i != baseline.end(); ++i)
391     {
392       string name(i->first);
393       symbol_names::iterator end = added_names.end();
394       symbol_names::iterator it = find(added_names.begin(), end, name);
395       if (it != end)
396         {
397           // Found.
398           shared_names.push_back(name);
399           added_names.erase(it);
400         }
401        else
402         {
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);
409         }
410     }
411
412   // Fill out list of incompatible symbols.
413   typedef pair<symbol, symbol> symbol_pair;
414   vector<symbol_pair> incompatible;
415
416   // Check missing names for compatibility.
417   for (size_t j = 0; j < missing_names.size(); ++j)
418     {
419       symbol& sbase = baseline[missing_names[j]];
420       sbase.status = symbol::subtracted;
421       incompatible.push_back(symbol_pair(sbase, sbase));
422     }
423
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)
427     {
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));
433     }
434
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)
438     {
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));
443     }
444
445   // Report results.
446   if (verbose && added_names.size())
447     {
448       cout << endl << added_names.size() << " added symbols " << endl;
449       for (size_t j = 0; j < added_names.size() ; ++j)
450         {
451           cout << j << endl;
452           test[added_names[j]].print();
453         }
454     }
455   
456   if (verbose && missing_names.size())
457     {
458       cout << endl << missing_names.size() << " missing symbols " << endl;
459       for (size_t j = 0; j < missing_names.size() ; ++j)
460         {
461           cout << j << endl;
462           baseline[missing_names[j]].print();
463         }
464     }
465   
466   if (verbose && incompatible.size())
467     {
468       cout << endl << incompatible.size() << " incompatible symbols " << endl;
469       for (size_t j = 0; j < incompatible.size() ; ++j)
470         {
471           // First, print index.
472           cout << j << endl;
473
474           // Second, report name.
475           symbol& sbase = incompatible[j].first;
476           symbol& stest = incompatible[j].second;
477           stest.print();
478           
479           // Second, report reason or reasons incompatible.
480           check_compatible(sbase, stest, true);
481         }
482     }
483   
484   cout << "\n\t\t=== libstdc++-v3 check-abi Summary ===" << endl;
485   cout << 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;
489   cout << endl;
490   cout << "using: " << baseline_file << endl;
491
492   return !(missing_names.size() || incompatible.size());
493 }
494
495
496 symbols
497 create_symbols(const char* file)
498 {
499   symbols s;
500   ifstream ifs(file);
501   if (ifs.is_open())
502     {
503       // Organize file data into an associated container (symbols) of symbol
504       // objects mapped to mangled names without versioning
505       // information.
506       const string empty;
507       string line = empty;
508       while (getline(ifs, line).good())
509         {
510           symbol tmp;
511           tmp.init(line);
512           s[tmp.name] = tmp;
513           line = empty;
514         }
515     }
516   else
517     {
518       ostringstream os;
519       os << "create_symbols failed for file " << file;
520       __throw_runtime_error(os.str().c_str());
521     }
522   return s;
523 }
524
525
526 const char*
527 demangle(const std::string& mangled)
528 {
529   const char* name;
530   if (mangled[0] != '_' || mangled[1] != 'Z')
531     {
532       // This is not a mangled symbol, thus has "C" linkage.
533       name = mangled.c_str();
534     }
535   else
536     {
537       // Use __cxa_demangle to demangle.
538       int status = 0;
539       name = abi::__cxa_demangle(mangled.c_str(), 0, 0, &status);
540       if (!name)
541         {
542           switch (status)
543             {
544             case 0:
545               name = "error code = 0: success";
546               break;
547             case -1:
548               name = "error code = -1: memory allocation failure";
549               break;
550             case -2:
551               name = "error code = -2: invalid mangled name";
552               break;
553             case -3:
554               name = "error code = -3: invalid arguments";
555               break;
556             default:
557               name = "error code unknown - who knows what happened";
558             }
559         }
560     }
561   return name;
562 }
563