src/demangle_unittest.cc

   1 // Copyright (c) 2006, Google Inc.
   2 // All rights reserved.
   3 //
   4 // Redistribution and use in source and binary forms, with or without
   5 // modification, are permitted provided that the following conditions are
   6 // met:
   7 //
   8 //     * Redistributions of source code must retain the above copyright
   9 // notice, this list of conditions and the following disclaimer.
  10 //     * Redistributions in binary form must reproduce the above
  11 // copyright notice, this list of conditions and the following disclaimer
  12 // in the documentation and/or other materials provided with the
  13 // distribution.
  14 //     * Neither the name of Google Inc. nor the names of its
  15 // contributors may be used to endorse or promote products derived from
  16 // this software without specific prior written permission.
  17 //
  18 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  19 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  20 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  21 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  22 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  23 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  24 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  25 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  26 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  28 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29 //
  30 // Author: Satoru Takabayashi
  31 //
  32 // Unit tests for functions in demangle.c.
  33
  34 #include "utilities.h"
  35
  36 #include <iostream>
  37 #include <fstream>
  38 #include <string>
  39 #include "glog/logging.h"
  40 #include "demangle.h"
  41 #include "googletest.h"
  42 #include "config.h"
  43
  44 #ifdef HAVE_LIB_GFLAGS
  45 #include <gflags/gflags.h>
  46 using namespace GFLAGS_NAMESPACE;
  47 #endif
  48
  49 GLOG_DEFINE_bool(demangle_filter, false,
  50                  "Run demangle_unittest in filter mode");
  51
  52 using namespace std;
  53 using namespace GOOGLE_NAMESPACE;
  54
  55 // A wrapper function for Demangle() to make the unit test simple.
  56 static const char *DemangleIt(const char * const mangled) {
  57   static char demangled[4096];
  58   if (Demangle(mangled, demangled, sizeof(demangled))) {
  59     return demangled;
  60   } else {
  61     return mangled;
  62   }
  63 }
  64
  65 #if defined(OS_WINDOWS)
  66
  67 TEST(Demangle, Windows) {
  68   EXPECT_STREQ(
  69     "public: static void __cdecl Foo::func(int)",
  70     DemangleIt("?func@Foo@@SAXH@Z"));
  71   EXPECT_STREQ(
  72     "public: static void __cdecl Foo::func(int)",
  73     DemangleIt("@ILT+1105(?func@Foo@@SAXH@Z)"));
  74   EXPECT_STREQ(
  75     "int __cdecl foobarArray(int * const)",
  76     DemangleIt("?foobarArray@@YAHQAH@Z"));
  77 }
  78
  79 #else
  80
  81 // Test corner cases of bounary conditions.
  82 TEST(Demangle, CornerCases) {
  83   const size_t size = 10;
  84   char tmp[size] = { 0 };
  85   const char *demangled = "foobar()";
  86   const char *mangled = "_Z6foobarv";
  87   EXPECT_TRUE(Demangle(mangled, tmp, sizeof(tmp)));
  88   // sizeof("foobar()") == size - 1
  89   EXPECT_STREQ(demangled, tmp);
  90   EXPECT_TRUE(Demangle(mangled, tmp, size - 1));
  91   EXPECT_STREQ(demangled, tmp);
  92   EXPECT_FALSE(Demangle(mangled, tmp, size - 2));  // Not enough.
  93   EXPECT_FALSE(Demangle(mangled, tmp, 1));
  94   EXPECT_FALSE(Demangle(mangled, tmp, 0));
  95   EXPECT_FALSE(Demangle(mangled, NULL, 0));  // Should not cause SEGV.
  96 }
  97
  98 // Test handling of functions suffixed with .clone.N, which is used by GCC
  99 // 4.5.x, and .constprop.N and .isra.N, which are used by GCC 4.6.x.  These
 100 // suffixes are used to indicate functions which have been cloned during
 101 // optimization.  We ignore these suffixes.
 102 TEST(Demangle, Clones) {
 103   char tmp[20];
 104   EXPECT_TRUE(Demangle("_ZL3Foov", tmp, sizeof(tmp)));
 105   EXPECT_STREQ("Foo()", tmp);
 106   EXPECT_TRUE(Demangle("_ZL3Foov.clone.3", tmp, sizeof(tmp)));
 107   EXPECT_STREQ("Foo()", tmp);
 108   EXPECT_TRUE(Demangle("_ZL3Foov.constprop.80", tmp, sizeof(tmp)));
 109   EXPECT_STREQ("Foo()", tmp);
 110   EXPECT_TRUE(Demangle("_ZL3Foov.isra.18", tmp, sizeof(tmp)));
 111   EXPECT_STREQ("Foo()", tmp);
 112   EXPECT_TRUE(Demangle("_ZL3Foov.isra.2.constprop.18", tmp, sizeof(tmp)));
 113   EXPECT_STREQ("Foo()", tmp);
 114   // Invalid (truncated), should not demangle.
 115   EXPECT_FALSE(Demangle("_ZL3Foov.clo", tmp, sizeof(tmp)));
 116   // Invalid (.clone. not followed by number), should not demangle.
 117   EXPECT_FALSE(Demangle("_ZL3Foov.clone.", tmp, sizeof(tmp)));
 118   // Invalid (.clone. followed by non-number), should not demangle.
 119   EXPECT_FALSE(Demangle("_ZL3Foov.clone.foo", tmp, sizeof(tmp)));
 120   // Invalid (.constprop. not followed by number), should not demangle.
 121   EXPECT_FALSE(Demangle("_ZL3Foov.isra.2.constprop.", tmp, sizeof(tmp)));
 122 }
 123
 124 TEST(Demangle, FromFile) {
 125   string test_file = FLAGS_test_srcdir + "/src/demangle_unittest.txt";
 126   ifstream f(test_file.c_str());  // The file should exist.
 127   EXPECT_FALSE(f.fail());
 128
 129   string line;
 130   while (getline(f, line)) {
 131     // Lines start with '#' are considered as comments.
 132     if (line.empty() || line[0] == '#') {
 133       continue;
 134     }
 135     // Each line should contain a mangled name and a demangled name
 136     // separated by '\t'.  Example: "_Z3foo\tfoo"
 137     string::size_type tab_pos = line.find('\t');
 138     EXPECT_NE(string::npos, tab_pos);
 139     string mangled = line.substr(0, tab_pos);
 140     string demangled = line.substr(tab_pos + 1);
 141     EXPECT_EQ(demangled, DemangleIt(mangled.c_str()));
 142   }
 143 }
 144
 145 #endif
 146
 147 int main(int argc, char **argv) {
 148 #ifdef HAVE_LIB_GFLAGS
 149   ParseCommandLineFlags(&argc, &argv, true);
 150 #endif
 151   InitGoogleTest(&argc, argv);
 152
 153   FLAGS_logtostderr = true;
 154   InitGoogleLogging(argv[0]);
 155   if (FLAGS_demangle_filter) {
 156     // Read from cin and write to cout.
 157     string line;
 158     while (getline(cin, line, '\n')) {
 159       cout << DemangleIt(line.c_str()) << endl;
 160     }
 161     return 0;
 162   } else if (argc > 1) {
 163     cout << DemangleIt(argv[1]) << endl;
 164     return 0;
 165   } else {
 166     return RUN_ALL_TESTS();
 167   }
 168 }