Add an abstract interface to SourceLineResolver, and allow any implementation

to be used with MinidumpProcessor.  The basic SourceLineResolver is now a
public interface (#89)



git-svn-id: http://google-breakpad.googlecode.com/svn/trunk@83 4c0a9323-5329-0410-9bdc-e9ce6186880e

src/processor/basic_source_line_resolver_unittest.cc

@@ -0,0 +1,202 @@
+// Copyright (c) 2006, Google Inc.
+// All rights reserved.
+//
+// Redistribution and use in source and binary forms, with or without
+// modification, are permitted provided that the following conditions are
+// met:
+//
+//     * Redistributions of source code must retain the above copyright
+// notice, this list of conditions and the following disclaimer.
+//     * Redistributions in binary form must reproduce the above
+// copyright notice, this list of conditions and the following disclaimer
+// in the documentation and/or other materials provided with the
+// distribution.
+//     * Neither the name of Google Inc. nor the names of its
+// contributors may be used to endorse or promote products derived from
+// this software without specific prior written permission.
+//
+// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+#include <cstdio>
+#include <string>
+#include "google_airbag/processor/basic_source_line_resolver.h"
+#include "google_airbag/processor/code_module.h"
+#include "google_airbag/processor/stack_frame.h"
+#include "processor/linked_ptr.h"
+#include "processor/scoped_ptr.h"
+#include "processor/stack_frame_info.h"
+
+#define ASSERT_TRUE(cond) \
+  if (!(cond)) {                                                        \
+    fprintf(stderr, "FAILED: %s at %s:%d\n", #cond, __FILE__, __LINE__); \
+    return false; \
+  }
+
+#define ASSERT_FALSE(cond) ASSERT_TRUE(!(cond))
+
+#define ASSERT_EQ(e1, e2) ASSERT_TRUE((e1) == (e2))
+
+namespace {
+
+using std::string;
+using google_airbag::BasicSourceLineResolver;
+using google_airbag::CodeModule;
+using google_airbag::linked_ptr;
+using google_airbag::scoped_ptr;
+using google_airbag::StackFrame;
+using google_airbag::StackFrameInfo;
+
+class TestCodeModule : public CodeModule {
+ public:
+  TestCodeModule(string code_file) : code_file_(code_file) {}
+  virtual ~TestCodeModule() {}
+
+  virtual u_int64_t base_address() const { return 0; }
+  virtual u_int64_t size() const { return 0x4000; }
+  virtual string code_file() const { return code_file_; }
+  virtual string code_identifier() const { return ""; }
+  virtual string debug_file() const { return ""; }
+  virtual string debug_identifier() const { return ""; }
+  virtual string version() const { return ""; }
+  virtual const CodeModule* Copy() const {
+    return new TestCodeModule(code_file_);
+  }
+
+ private:
+  string code_file_;
+};
+
+static bool VerifyEmpty(const StackFrame &frame) {
+  ASSERT_TRUE(frame.function_name.empty());
+  ASSERT_TRUE(frame.source_file_name.empty());
+  ASSERT_EQ(frame.source_line, 0);
+  return true;
+}
+
+static void ClearSourceLineInfo(StackFrame *frame) {
+  frame->function_name.clear();
+  frame->module = NULL;
+  frame->source_file_name.clear();
+  frame->source_line = 0;
+}
+
+static bool RunTests() {
+  string testdata_dir = string(getenv("srcdir") ? getenv("srcdir") : ".") +
+                        "/src/processor/testdata";
+
+  BasicSourceLineResolver resolver;
+  ASSERT_TRUE(resolver.LoadModule("module1", testdata_dir + "/module1.out"));
+  ASSERT_TRUE(resolver.HasModule("module1"));
+  ASSERT_TRUE(resolver.LoadModule("module2", testdata_dir + "/module2.out"));
+  ASSERT_TRUE(resolver.HasModule("module2"));
+
+  TestCodeModule module1("module1");
+
+  StackFrame frame;
+  frame.instruction = 0x1000;
+  frame.module = NULL;
+  scoped_ptr<StackFrameInfo> frame_info(resolver.FillSourceLineInfo(&frame));
+  ASSERT_FALSE(frame.module);
+  ASSERT_TRUE(frame.function_name.empty());
+  ASSERT_EQ(frame.function_base, 0);
+  ASSERT_TRUE(frame.source_file_name.empty());
+  ASSERT_EQ(frame.source_line, 0);
+  ASSERT_EQ(frame.source_line_base, 0);
+
+  frame.module = &module1;
+  frame_info.reset(resolver.FillSourceLineInfo(&frame));
+  ASSERT_EQ(frame.function_name, "Function1_1");
+  ASSERT_TRUE(frame.module);
+  ASSERT_EQ(frame.module->code_file(), "module1");
+  ASSERT_EQ(frame.function_base, 0x1000);
+  ASSERT_EQ(frame.source_file_name, "file1_1.cc");
+  ASSERT_EQ(frame.source_line, 44);
+  ASSERT_EQ(frame.source_line_base, 0x1000);
+  ASSERT_TRUE(frame_info.get());
+  ASSERT_FALSE(frame_info->allocates_base_pointer);
+  ASSERT_EQ(frame_info->program_string,
+            "$eip 4 + ^ = $esp $ebp 8 + = $ebp $ebp ^ =");
+
+  ClearSourceLineInfo(&frame);
+  frame.instruction = 0x800;
+  frame.module = &module1;
+  frame_info.reset(resolver.FillSourceLineInfo(&frame));
+  ASSERT_TRUE(VerifyEmpty(frame));
+  ASSERT_FALSE(frame_info.get());
+
+  frame.instruction = 0x1280;
+  frame_info.reset(resolver.FillSourceLineInfo(&frame));
+  ASSERT_EQ(frame.function_name, "Function1_3");
+  ASSERT_TRUE(frame.source_file_name.empty());
+  ASSERT_EQ(frame.source_line, 0);
+  ASSERT_TRUE(frame_info.get());
+  ASSERT_FALSE(frame_info->allocates_base_pointer);
+  ASSERT_TRUE(frame_info->program_string.empty());
+
+  frame.instruction = 0x1380;
+  frame_info.reset(resolver.FillSourceLineInfo(&frame));
+  ASSERT_EQ(frame.function_name, "Function1_4");
+  ASSERT_TRUE(frame.source_file_name.empty());
+  ASSERT_EQ(frame.source_line, 0);
+  ASSERT_TRUE(frame_info.get());
+  ASSERT_FALSE(frame_info->allocates_base_pointer);
+  ASSERT_FALSE(frame_info->program_string.empty());
+
+  TestCodeModule module2("module2");
+
+  frame.instruction = 0x2181;
+  frame.module = &module2;
+  frame_info.reset(resolver.FillSourceLineInfo(&frame));
+  ASSERT_EQ(frame.function_name, "Function2_2");
+  ASSERT_EQ(frame.function_base, 0x2170);
+  ASSERT_TRUE(frame.module);
+  ASSERT_EQ(frame.module->code_file(), "module2");
+  ASSERT_EQ(frame.source_file_name, "file2_2.cc");
+  ASSERT_EQ(frame.source_line, 21);
+  ASSERT_EQ(frame.source_line_base, 0x2180);
+  ASSERT_TRUE(frame_info.get());
+  ASSERT_EQ(frame_info->prolog_size, 1);
+
+  frame.instruction = 0x216f;
+  resolver.FillSourceLineInfo(&frame);
+  ASSERT_EQ(frame.function_name, "Public2_1");
+
+  ClearSourceLineInfo(&frame);
+  frame.instruction = 0x219f;
+  frame.module = &module2;
+  resolver.FillSourceLineInfo(&frame);
+  ASSERT_TRUE(frame.function_name.empty());
+
+  frame.instruction = 0x21a0;
+  frame.module = &module2;
+  resolver.FillSourceLineInfo(&frame);
+  ASSERT_EQ(frame.function_name, "Public2_2");
+
+  ASSERT_FALSE(resolver.LoadModule("module3",
+                                   testdata_dir + "/module3_bad.out"));
+  ASSERT_FALSE(resolver.HasModule("module3"));
+  ASSERT_FALSE(resolver.LoadModule("module4",
+                                   testdata_dir + "/invalid-filename"));
+  ASSERT_FALSE(resolver.HasModule("module4"));
+  ASSERT_FALSE(resolver.HasModule("invalid-module"));
+  return true;
+}
+
+}  // namespace
+
+int main(int argc, char **argv) {
+  if (!RunTests()) {
+    return 1;
+  }
+  return 0;
+}