OSDN Git Service

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