michael@0: // Copyright (c) 2010, Google Inc.
michael@0: // All rights reserved.
michael@0: //
michael@0: // Redistribution and use in source and binary forms, with or without
michael@0: // modification, are permitted provided that the following conditions are
michael@0: // met:
michael@0: //
michael@0: //     * Redistributions of source code must retain the above copyright
michael@0: // notice, this list of conditions and the following disclaimer.
michael@0: //     * Redistributions in binary form must reproduce the above
michael@0: // copyright notice, this list of conditions and the following disclaimer
michael@0: // in the documentation and/or other materials provided with the
michael@0: // distribution.
michael@0: //     * Neither the name of Google Inc. nor the names of its
michael@0: // contributors may be used to endorse or promote products derived from
michael@0: // this software without specific prior written permission.
michael@0: //
michael@0: // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
michael@0: // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
michael@0: // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
michael@0: // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
michael@0: // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
michael@0: // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
michael@0: // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
michael@0: // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
michael@0: // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
michael@0: // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
michael@0: // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
michael@0: 
michael@0: // Original author: Jim Blandy <jimb@mozilla.com> <jimb@red-bean.com>
michael@0: 
michael@0: // stackwalker_arm_unittest.cc: Unit tests for StackwalkerARM class.
michael@0: 
michael@0: #include <string.h>
michael@0: #include <string>
michael@0: #include <vector>
michael@0: 
michael@0: #include "breakpad_googletest_includes.h"
michael@0: #include "common/test_assembler.h"
michael@0: #include "common/using_std_string.h"
michael@0: #include "google_breakpad/common/minidump_format.h"
michael@0: #include "google_breakpad/processor/basic_source_line_resolver.h"
michael@0: #include "google_breakpad/processor/call_stack.h"
michael@0: #include "google_breakpad/processor/code_module.h"
michael@0: #include "google_breakpad/processor/source_line_resolver_interface.h"
michael@0: #include "google_breakpad/processor/stack_frame_cpu.h"
michael@0: #include "processor/stackwalker_unittest_utils.h"
michael@0: #include "processor/stackwalker_arm.h"
michael@0: #include "processor/windows_frame_info.h"
michael@0: 
michael@0: using google_breakpad::BasicSourceLineResolver;
michael@0: using google_breakpad::CallStack;
michael@0: using google_breakpad::CodeModule;
michael@0: using google_breakpad::StackFrameSymbolizer;
michael@0: using google_breakpad::StackFrame;
michael@0: using google_breakpad::StackFrameARM;
michael@0: using google_breakpad::StackwalkerARM;
michael@0: using google_breakpad::SystemInfo;
michael@0: using google_breakpad::WindowsFrameInfo;
michael@0: using google_breakpad::test_assembler::kLittleEndian;
michael@0: using google_breakpad::test_assembler::Label;
michael@0: using google_breakpad::test_assembler::Section;
michael@0: using std::vector;
michael@0: using testing::_;
michael@0: using testing::Return;
michael@0: using testing::SetArgumentPointee;
michael@0: using testing::Test;
michael@0: 
michael@0: class StackwalkerARMFixture {
michael@0:  public:
michael@0:   StackwalkerARMFixture()
michael@0:     : stack_section(kLittleEndian),
michael@0:       // Give the two modules reasonable standard locations and names
michael@0:       // for tests to play with.
michael@0:       module1(0x40000000, 0x10000, "module1", "version1"),
michael@0:       module2(0x50000000, 0x10000, "module2", "version2") {
michael@0:     // Identify the system as a Linux system.
michael@0:     system_info.os = "Linux";
michael@0:     system_info.os_short = "linux";
michael@0:     system_info.os_version = "Lugubrious Labrador";
michael@0:     system_info.cpu = "arm";
michael@0:     system_info.cpu_info = "";
michael@0: 
michael@0:     // Put distinctive values in the raw CPU context.
michael@0:     BrandContext(&raw_context);
michael@0: 
michael@0:     // Create some modules with some stock debugging information.
michael@0:     modules.Add(&module1);
michael@0:     modules.Add(&module2);
michael@0: 
michael@0:     // By default, none of the modules have symbol info; call
michael@0:     // SetModuleSymbols to override this.
michael@0:     EXPECT_CALL(supplier, GetCStringSymbolData(_, _, _, _))
michael@0:       .WillRepeatedly(Return(MockSymbolSupplier::NOT_FOUND));
michael@0:   }
michael@0: 
michael@0:   // Set the Breakpad symbol information that supplier should return for
michael@0:   // MODULE to INFO.
michael@0:   void SetModuleSymbols(MockCodeModule *module, const string &info) {
michael@0:     char *buffer = supplier.CopySymbolDataAndOwnTheCopy(info);
michael@0:     EXPECT_CALL(supplier, GetCStringSymbolData(module, &system_info, _, _))
michael@0:       .WillRepeatedly(DoAll(SetArgumentPointee<3>(buffer),
michael@0:                             Return(MockSymbolSupplier::FOUND)));
michael@0:   }
michael@0: 
michael@0:   // Populate stack_region with the contents of stack_section. Use
michael@0:   // stack_section.start() as the region's starting address.
michael@0:   void RegionFromSection() {
michael@0:     string contents;
michael@0:     ASSERT_TRUE(stack_section.GetContents(&contents));
michael@0:     stack_region.Init(stack_section.start().Value(), contents);
michael@0:   }
michael@0: 
michael@0:   // Fill RAW_CONTEXT with pseudo-random data, for round-trip checking.
michael@0:   void BrandContext(MDRawContextARM *raw_context) {
michael@0:     uint8_t x = 173;
michael@0:     for (size_t i = 0; i < sizeof(*raw_context); i++)
michael@0:       reinterpret_cast<uint8_t *>(raw_context)[i] = (x += 17);
michael@0:   }
michael@0: 
michael@0:   SystemInfo system_info;
michael@0:   MDRawContextARM raw_context;
michael@0:   Section stack_section;
michael@0:   MockMemoryRegion stack_region;
michael@0:   MockCodeModule module1;
michael@0:   MockCodeModule module2;
michael@0:   MockCodeModules modules;
michael@0:   MockSymbolSupplier supplier;
michael@0:   BasicSourceLineResolver resolver;
michael@0:   CallStack call_stack;
michael@0:   const vector<StackFrame *> *frames;
michael@0: };
michael@0: 
michael@0: class SanityCheck: public StackwalkerARMFixture, public Test { };
michael@0: 
michael@0: TEST_F(SanityCheck, NoResolver) {
michael@0:   // Since we have no call frame information, and all unwinding
michael@0:   // requires call frame information, the stack walk will end after
michael@0:   // the first frame.
michael@0:   StackFrameSymbolizer frame_symbolizer(NULL, NULL);
michael@0:   StackwalkerARM walker(&system_info, &raw_context, -1, &stack_region, &modules,
michael@0:                         &frame_symbolizer);
michael@0:   // This should succeed even without a resolver or supplier.
michael@0:   vector<const CodeModule*> modules_without_symbols;
michael@0:   ASSERT_TRUE(walker.Walk(&call_stack, &modules_without_symbols));
michael@0:   ASSERT_EQ(0U, modules_without_symbols.size());
michael@0:   frames = call_stack.frames();
michael@0:   ASSERT_EQ(1U, frames->size());
michael@0:   StackFrameARM *frame = static_cast<StackFrameARM *>(frames->at(0));
michael@0:   // Check that the values from the original raw context made it
michael@0:   // through to the context in the stack frame.
michael@0:   EXPECT_EQ(0, memcmp(&raw_context, &frame->context, sizeof(raw_context)));
michael@0: }
michael@0: 
michael@0: class GetContextFrame: public StackwalkerARMFixture, public Test { };
michael@0: 
michael@0: TEST_F(GetContextFrame, Simple) {
michael@0:   // Since we have no call frame information, and all unwinding
michael@0:   // requires call frame information, the stack walk will end after
michael@0:   // the first frame.
michael@0:   StackFrameSymbolizer frame_symbolizer(&supplier, &resolver);
michael@0:   StackwalkerARM walker(&system_info, &raw_context, -1, &stack_region, &modules,
michael@0:                         &frame_symbolizer);
michael@0:   vector<const CodeModule*> modules_without_symbols;
michael@0:   ASSERT_TRUE(walker.Walk(&call_stack, &modules_without_symbols));
michael@0:   ASSERT_EQ(0U, modules_without_symbols.size());
michael@0:   frames = call_stack.frames();
michael@0:   ASSERT_EQ(1U, frames->size());
michael@0:   StackFrameARM *frame = static_cast<StackFrameARM *>(frames->at(0));
michael@0:   // Check that the values from the original raw context made it
michael@0:   // through to the context in the stack frame.
michael@0:   EXPECT_EQ(0, memcmp(&raw_context, &frame->context, sizeof(raw_context)));
michael@0: }
michael@0: 
michael@0: // The stackwalker should be able to produce the context frame even
michael@0: // without stack memory present.
michael@0: TEST_F(GetContextFrame, NoStackMemory) {
michael@0:   StackFrameSymbolizer frame_symbolizer(&supplier, &resolver);
michael@0:   StackwalkerARM walker(&system_info, &raw_context, -1, NULL, &modules,
michael@0:                         &frame_symbolizer);
michael@0:   vector<const CodeModule*> modules_without_symbols;
michael@0:   ASSERT_TRUE(walker.Walk(&call_stack, &modules_without_symbols));
michael@0:   ASSERT_EQ(0U, modules_without_symbols.size());
michael@0:   frames = call_stack.frames();
michael@0:   ASSERT_EQ(1U, frames->size());
michael@0:   StackFrameARM *frame = static_cast<StackFrameARM *>(frames->at(0));
michael@0:   // Check that the values from the original raw context made it
michael@0:   // through to the context in the stack frame.
michael@0:   EXPECT_EQ(0, memcmp(&raw_context, &frame->context, sizeof(raw_context)));
michael@0: }
michael@0: 
michael@0: class GetCallerFrame: public StackwalkerARMFixture, public Test { };
michael@0: 
michael@0: TEST_F(GetCallerFrame, ScanWithoutSymbols) {
michael@0:   // When the stack walker resorts to scanning the stack,
michael@0:   // only addresses located within loaded modules are
michael@0:   // considered valid return addresses.
michael@0:   // Force scanning through three frames to ensure that the
michael@0:   // stack pointer is set properly in scan-recovered frames.
michael@0:   stack_section.start() = 0x80000000;
michael@0:   uint32_t return_address1 = 0x50000100;
michael@0:   uint32_t return_address2 = 0x50000900;
michael@0:   Label frame1_sp, frame2_sp;
michael@0:   stack_section
michael@0:     // frame 0
michael@0:     .Append(16, 0)                      // space
michael@0: 
michael@0:     .D32(0x40090000)                    // junk that's not
michael@0:     .D32(0x60000000)                    // a return address
michael@0: 
michael@0:     .D32(return_address1)               // actual return address
michael@0:     // frame 1
michael@0:     .Mark(&frame1_sp)
michael@0:     .Append(16, 0)                      // space
michael@0: 
michael@0:     .D32(0xF0000000)                    // more junk
michael@0:     .D32(0x0000000D)
michael@0: 
michael@0:     .D32(return_address2)               // actual return address
michael@0:     // frame 2
michael@0:     .Mark(&frame2_sp)
michael@0:     .Append(32, 0);                     // end of stack
michael@0:   RegionFromSection();
michael@0: 
michael@0:   raw_context.iregs[MD_CONTEXT_ARM_REG_PC] = 0x40005510;
michael@0:   raw_context.iregs[MD_CONTEXT_ARM_REG_SP] = stack_section.start().Value();
michael@0: 
michael@0:   StackFrameSymbolizer frame_symbolizer(&supplier, &resolver);
michael@0:   StackwalkerARM walker(&system_info, &raw_context, -1, &stack_region, &modules,
michael@0:                         &frame_symbolizer);
michael@0:   vector<const CodeModule*> modules_without_symbols;
michael@0:   ASSERT_TRUE(walker.Walk(&call_stack, &modules_without_symbols));
michael@0:   ASSERT_EQ(2U, modules_without_symbols.size());
michael@0:   ASSERT_EQ("module1", modules_without_symbols[0]->debug_file());
michael@0:   ASSERT_EQ("module2", modules_without_symbols[1]->debug_file());
michael@0:   frames = call_stack.frames();
michael@0:   ASSERT_EQ(3U, frames->size());
michael@0: 
michael@0:   StackFrameARM *frame0 = static_cast<StackFrameARM *>(frames->at(0));
michael@0:   EXPECT_EQ(StackFrame::FRAME_TRUST_CONTEXT, frame0->trust);
michael@0:   ASSERT_EQ(StackFrameARM::CONTEXT_VALID_ALL, frame0->context_validity);
michael@0:   EXPECT_EQ(0, memcmp(&raw_context, &frame0->context, sizeof(raw_context)));
michael@0: 
michael@0:   StackFrameARM *frame1 = static_cast<StackFrameARM *>(frames->at(1));
michael@0:   EXPECT_EQ(StackFrame::FRAME_TRUST_SCAN, frame1->trust);
michael@0:   ASSERT_EQ((StackFrameARM::CONTEXT_VALID_PC |
michael@0:              StackFrameARM::CONTEXT_VALID_SP),
michael@0:             frame1->context_validity);
michael@0:   EXPECT_EQ(return_address1, frame1->context.iregs[MD_CONTEXT_ARM_REG_PC]);
michael@0:   EXPECT_EQ(frame1_sp.Value(), frame1->context.iregs[MD_CONTEXT_ARM_REG_SP]);
michael@0: 
michael@0:   StackFrameARM *frame2 = static_cast<StackFrameARM *>(frames->at(2));
michael@0:   EXPECT_EQ(StackFrame::FRAME_TRUST_SCAN, frame2->trust);
michael@0:   ASSERT_EQ((StackFrameARM::CONTEXT_VALID_PC |
michael@0:              StackFrameARM::CONTEXT_VALID_SP),
michael@0:             frame2->context_validity);
michael@0:   EXPECT_EQ(return_address2, frame2->context.iregs[MD_CONTEXT_ARM_REG_PC]);
michael@0:   EXPECT_EQ(frame2_sp.Value(), frame2->context.iregs[MD_CONTEXT_ARM_REG_SP]);
michael@0: }
michael@0: 
michael@0: TEST_F(GetCallerFrame, ScanWithFunctionSymbols) {
michael@0:   // During stack scanning, if a potential return address
michael@0:   // is located within a loaded module that has symbols,
michael@0:   // it is only considered a valid return address if it
michael@0:   // lies within a function's bounds.
michael@0:   stack_section.start() = 0x80000000;
michael@0:   uint32_t return_address = 0x50000200;
michael@0:   Label frame1_sp;
michael@0: 
michael@0:   stack_section
michael@0:     // frame 0
michael@0:     .Append(16, 0)                      // space
michael@0: 
michael@0:     .D32(0x40090000)                    // junk that's not
michael@0:     .D32(0x60000000)                    // a return address
michael@0: 
michael@0:     .D32(0x40001000)                    // a couple of plausible addresses
michael@0:     .D32(0x5000F000)                    // that are not within functions
michael@0: 
michael@0:     .D32(return_address)                // actual return address
michael@0:     // frame 1
michael@0:     .Mark(&frame1_sp)
michael@0:     .Append(32, 0);                     // end of stack
michael@0:   RegionFromSection();
michael@0: 
michael@0:   raw_context.iregs[MD_CONTEXT_ARM_REG_PC] = 0x40000200;
michael@0:   raw_context.iregs[MD_CONTEXT_ARM_REG_SP] = stack_section.start().Value();
michael@0: 
michael@0:   SetModuleSymbols(&module1,
michael@0:                    // The youngest frame's function.
michael@0:                    "FUNC 100 400 10 monotreme\n");
michael@0:   SetModuleSymbols(&module2,
michael@0:                    // The calling frame's function.
michael@0:                    "FUNC 100 400 10 marsupial\n");
michael@0: 
michael@0:   StackFrameSymbolizer frame_symbolizer(&supplier, &resolver);
michael@0:   StackwalkerARM walker(&system_info, &raw_context, -1, &stack_region, &modules,
michael@0:                         &frame_symbolizer);
michael@0:   vector<const CodeModule*> modules_without_symbols;
michael@0:   ASSERT_TRUE(walker.Walk(&call_stack, &modules_without_symbols));
michael@0:   ASSERT_EQ(0U, modules_without_symbols.size());
michael@0:   frames = call_stack.frames();
michael@0:   ASSERT_EQ(2U, frames->size());
michael@0: 
michael@0:   StackFrameARM *frame0 = static_cast<StackFrameARM *>(frames->at(0));
michael@0:   EXPECT_EQ(StackFrame::FRAME_TRUST_CONTEXT, frame0->trust);
michael@0:   ASSERT_EQ(StackFrameARM::CONTEXT_VALID_ALL, frame0->context_validity);
michael@0:   EXPECT_EQ(0, memcmp(&raw_context, &frame0->context, sizeof(raw_context)));
michael@0:   EXPECT_EQ("monotreme", frame0->function_name);
michael@0:   EXPECT_EQ(0x40000100U, frame0->function_base);
michael@0: 
michael@0:   StackFrameARM *frame1 = static_cast<StackFrameARM *>(frames->at(1));
michael@0:   EXPECT_EQ(StackFrame::FRAME_TRUST_SCAN, frame1->trust);
michael@0:   ASSERT_EQ((StackFrameARM::CONTEXT_VALID_PC |
michael@0:              StackFrameARM::CONTEXT_VALID_SP),
michael@0:             frame1->context_validity);
michael@0:   EXPECT_EQ(return_address, frame1->context.iregs[MD_CONTEXT_ARM_REG_PC]);
michael@0:   EXPECT_EQ(frame1_sp.Value(), frame1->context.iregs[MD_CONTEXT_ARM_REG_SP]);
michael@0:   EXPECT_EQ("marsupial", frame1->function_name);
michael@0:   EXPECT_EQ(0x50000100U, frame1->function_base);
michael@0: }
michael@0: 
michael@0: TEST_F(GetCallerFrame, ScanFirstFrame) {
michael@0:   // If the stackwalker resorts to stack scanning, it will scan much
michael@0:   // farther to find the caller of the context frame.
michael@0:   stack_section.start() = 0x80000000;
michael@0:   uint32_t return_address1 = 0x50000100;
michael@0:   uint32_t return_address2 = 0x50000900;
michael@0:   Label frame1_sp, frame2_sp;
michael@0:   stack_section
michael@0:     // frame 0
michael@0:     .Append(32, 0)                      // space
michael@0: 
michael@0:     .D32(0x40090000)                    // junk that's not
michael@0:     .D32(0x60000000)                    // a return address
michael@0: 
michael@0:     .Append(96, 0)                      // more space
michael@0: 
michael@0:     .D32(return_address1)               // actual return address
michael@0:     // frame 1
michael@0:     .Mark(&frame1_sp)
michael@0:     .Append(32, 0)                      // space
michael@0: 
michael@0:     .D32(0xF0000000)                    // more junk
michael@0:     .D32(0x0000000D)
michael@0: 
michael@0:     .Append(96, 0)                      // more space
michael@0: 
michael@0:     .D32(return_address2)               // actual return address
michael@0:                                         // (won't be found)
michael@0:     // frame 2
michael@0:     .Mark(&frame2_sp)
michael@0:     .Append(32, 0);                     // end of stack
michael@0:   RegionFromSection();
michael@0: 
michael@0:   raw_context.iregs[MD_CONTEXT_ARM_REG_PC] = 0x40005510;
michael@0:   raw_context.iregs[MD_CONTEXT_ARM_REG_SP] = stack_section.start().Value();
michael@0: 
michael@0:   StackFrameSymbolizer frame_symbolizer(&supplier, &resolver);
michael@0:   StackwalkerARM walker(&system_info, &raw_context, -1, &stack_region, &modules,
michael@0:                         &frame_symbolizer);
michael@0:   vector<const CodeModule*> modules_without_symbols;
michael@0:   ASSERT_TRUE(walker.Walk(&call_stack, &modules_without_symbols));
michael@0:   ASSERT_EQ(2U, modules_without_symbols.size());
michael@0:   ASSERT_EQ("module1", modules_without_symbols[0]->debug_file());
michael@0:   ASSERT_EQ("module2", modules_without_symbols[1]->debug_file());
michael@0:   frames = call_stack.frames();
michael@0:   ASSERT_EQ(2U, frames->size());
michael@0: 
michael@0:   StackFrameARM *frame0 = static_cast<StackFrameARM *>(frames->at(0));
michael@0:   EXPECT_EQ(StackFrame::FRAME_TRUST_CONTEXT, frame0->trust);
michael@0:   ASSERT_EQ(StackFrameARM::CONTEXT_VALID_ALL, frame0->context_validity);
michael@0:   EXPECT_EQ(0, memcmp(&raw_context, &frame0->context, sizeof(raw_context)));
michael@0: 
michael@0:   StackFrameARM *frame1 = static_cast<StackFrameARM *>(frames->at(1));
michael@0:   EXPECT_EQ(StackFrame::FRAME_TRUST_SCAN, frame1->trust);
michael@0:   ASSERT_EQ((StackFrameARM::CONTEXT_VALID_PC |
michael@0:              StackFrameARM::CONTEXT_VALID_SP),
michael@0:             frame1->context_validity);
michael@0:   EXPECT_EQ(return_address1, frame1->context.iregs[MD_CONTEXT_ARM_REG_PC]);
michael@0:   EXPECT_EQ(frame1_sp.Value(), frame1->context.iregs[MD_CONTEXT_ARM_REG_SP]);
michael@0: }
michael@0: 
michael@0: struct CFIFixture: public StackwalkerARMFixture {
michael@0:   CFIFixture() {
michael@0:     // Provide a bunch of STACK CFI records; we'll walk to the caller
michael@0:     // from every point in this series, expecting to find the same set
michael@0:     // of register values.
michael@0:     SetModuleSymbols(&module1,
michael@0:                      // The youngest frame's function.
michael@0:                      "FUNC 4000 1000 10 enchiridion\n"
michael@0:                      // Initially, nothing has been pushed on the stack,
michael@0:                      // and the return address is still in the link register.
michael@0:                      "STACK CFI INIT 4000 100 .cfa: sp .ra: lr\n"
michael@0:                      // Push r4, the frame pointer, and the link register.
michael@0:                      "STACK CFI 4001 .cfa: sp 12 + r4: .cfa 12 - ^"
michael@0:                      " r11: .cfa 8 - ^ .ra: .cfa 4 - ^\n"
michael@0:                      // Save r4..r7 in r0..r3: verify that we populate
michael@0:                      // the youngest frame with all the values we have.
michael@0:                      "STACK CFI 4002 r4: r0 r5: r1 r6: r2 r7: r3\n"
michael@0:                      // Restore r4..r7. Save the non-callee-saves register r1.
michael@0:                      "STACK CFI 4003 .cfa: sp 16 + r1: .cfa 16 - ^"
michael@0:                      " r4: r4 r5: r5 r6: r6 r7: r7\n"
michael@0:                      // Move the .cfa back four bytes, to point at the return
michael@0:                      // address, and restore the sp explicitly.
michael@0:                      "STACK CFI 4005 .cfa: sp 12 + r1: .cfa 12 - ^"
michael@0:                      " r11: .cfa 4 - ^ .ra: .cfa ^ sp: .cfa 4 +\n"
michael@0:                      // Recover the PC explicitly from a new stack slot;
michael@0:                      // provide garbage for the .ra.
michael@0:                      "STACK CFI 4006 .cfa: sp 16 + pc: .cfa 16 - ^\n"
michael@0: 
michael@0:                      // The calling function.
michael@0:                      "FUNC 5000 1000 10 epictetus\n"
michael@0:                      // Mark it as end of stack.
michael@0:                      "STACK CFI INIT 5000 1000 .cfa: 0 .ra: 0\n"
michael@0: 
michael@0:                      // A function whose CFI makes the stack pointer
michael@0:                      // go backwards.
michael@0:                      "FUNC 6000 1000 20 palinal\n"
michael@0:                      "STACK CFI INIT 6000 1000 .cfa: sp 4 - .ra: lr\n"
michael@0: 
michael@0:                      // A function with CFI expressions that can't be
michael@0:                      // evaluated.
michael@0:                      "FUNC 7000 1000 20 rhetorical\n"
michael@0:                      "STACK CFI INIT 7000 1000 .cfa: moot .ra: ambiguous\n");
michael@0: 
michael@0:     // Provide some distinctive values for the caller's registers.
michael@0:     expected.iregs[MD_CONTEXT_ARM_REG_PC] = 0x40005510;
michael@0:     expected.iregs[MD_CONTEXT_ARM_REG_SP] = 0x80000000;
michael@0:     expected.iregs[4] = 0xb5d55e68;
michael@0:     expected.iregs[5] = 0xebd134f3;
michael@0:     expected.iregs[6] = 0xa31e74bc;
michael@0:     expected.iregs[7] = 0x2dcb16b3;
michael@0:     expected.iregs[8] = 0x2ada2137;
michael@0:     expected.iregs[9] = 0xbbbb557d;
michael@0:     expected.iregs[10] = 0x48bf8ca7;
michael@0:     expected.iregs[MD_CONTEXT_ARM_REG_FP] = 0x8112e110;
michael@0: 
michael@0:     // Expect CFI to recover all callee-saves registers. Since CFI is the
michael@0:     // only stack frame construction technique we have, aside from the
michael@0:     // context frame itself, there's no way for us to have a set of valid
michael@0:     // registers smaller than this.
michael@0:     expected_validity = (StackFrameARM::CONTEXT_VALID_PC |
michael@0:                          StackFrameARM::CONTEXT_VALID_SP |
michael@0:                          StackFrameARM::CONTEXT_VALID_R4 |
michael@0:                          StackFrameARM::CONTEXT_VALID_R5 |
michael@0:                          StackFrameARM::CONTEXT_VALID_R6 |
michael@0:                          StackFrameARM::CONTEXT_VALID_R7 |
michael@0:                          StackFrameARM::CONTEXT_VALID_R8 |
michael@0:                          StackFrameARM::CONTEXT_VALID_R9 |
michael@0:                          StackFrameARM::CONTEXT_VALID_R10 |
michael@0:                          StackFrameARM::CONTEXT_VALID_FP);
michael@0: 
michael@0:     // By default, context frames provide all registers, as normal.
michael@0:     context_frame_validity = StackFrameARM::CONTEXT_VALID_ALL;
michael@0: 
michael@0:     // By default, registers are unchanged.
michael@0:     raw_context = expected;
michael@0:   }
michael@0: 
michael@0:   // Walk the stack, using stack_section as the contents of the stack
michael@0:   // and raw_context as the current register values. (Set the stack
michael@0:   // pointer to the stack's starting address.) Expect two stack
michael@0:   // frames; in the older frame, expect the callee-saves registers to
michael@0:   // have values matching those in 'expected'.
michael@0:   void CheckWalk() {
michael@0:     RegionFromSection();
michael@0:     raw_context.iregs[MD_CONTEXT_ARM_REG_SP] = stack_section.start().Value();
michael@0: 
michael@0:     StackFrameSymbolizer frame_symbolizer(&supplier, &resolver);
michael@0:     StackwalkerARM walker(&system_info, &raw_context, -1, &stack_region,
michael@0:                           &modules, &frame_symbolizer);
michael@0:     walker.SetContextFrameValidity(context_frame_validity);
michael@0:     vector<const CodeModule*> modules_without_symbols;
michael@0:     ASSERT_TRUE(walker.Walk(&call_stack, &modules_without_symbols));
michael@0:     ASSERT_EQ(0U, modules_without_symbols.size());
michael@0:     frames = call_stack.frames();
michael@0:     ASSERT_EQ(2U, frames->size());
michael@0: 
michael@0:     StackFrameARM *frame0 = static_cast<StackFrameARM *>(frames->at(0));
michael@0:     EXPECT_EQ(StackFrame::FRAME_TRUST_CONTEXT, frame0->trust);
michael@0:     ASSERT_EQ(context_frame_validity, frame0->context_validity);
michael@0:     EXPECT_EQ("enchiridion", frame0->function_name);
michael@0:     EXPECT_EQ(0x40004000U, frame0->function_base);
michael@0: 
michael@0:     StackFrameARM *frame1 = static_cast<StackFrameARM *>(frames->at(1));
michael@0:     EXPECT_EQ(StackFrame::FRAME_TRUST_CFI, frame1->trust);
michael@0:     ASSERT_EQ(expected_validity, frame1->context_validity);
michael@0:     if (expected_validity & StackFrameARM::CONTEXT_VALID_R1)
michael@0:       EXPECT_EQ(expected.iregs[1], frame1->context.iregs[1]);
michael@0:     if (expected_validity & StackFrameARM::CONTEXT_VALID_R4)
michael@0:       EXPECT_EQ(expected.iregs[4], frame1->context.iregs[4]);
michael@0:     if (expected_validity & StackFrameARM::CONTEXT_VALID_R5)
michael@0:       EXPECT_EQ(expected.iregs[5], frame1->context.iregs[5]);
michael@0:     if (expected_validity & StackFrameARM::CONTEXT_VALID_R6)
michael@0:       EXPECT_EQ(expected.iregs[6], frame1->context.iregs[6]);
michael@0:     if (expected_validity & StackFrameARM::CONTEXT_VALID_R7)
michael@0:       EXPECT_EQ(expected.iregs[7], frame1->context.iregs[7]);
michael@0:     if (expected_validity & StackFrameARM::CONTEXT_VALID_R8)
michael@0:       EXPECT_EQ(expected.iregs[8], frame1->context.iregs[8]);
michael@0:     if (expected_validity & StackFrameARM::CONTEXT_VALID_R9)
michael@0:       EXPECT_EQ(expected.iregs[9], frame1->context.iregs[9]);
michael@0:     if (expected_validity & StackFrameARM::CONTEXT_VALID_R10)
michael@0:       EXPECT_EQ(expected.iregs[10], frame1->context.iregs[10]);
michael@0:     if (expected_validity & StackFrameARM::CONTEXT_VALID_FP)
michael@0:       EXPECT_EQ(expected.iregs[MD_CONTEXT_ARM_REG_FP],
michael@0:                 frame1->context.iregs[MD_CONTEXT_ARM_REG_FP]);
michael@0: 
michael@0:     // We would never have gotten a frame in the first place if the SP
michael@0:     // and PC weren't valid or ->instruction weren't set.
michael@0:     EXPECT_EQ(expected.iregs[MD_CONTEXT_ARM_REG_SP],
michael@0:               frame1->context.iregs[MD_CONTEXT_ARM_REG_SP]);
michael@0:     EXPECT_EQ(expected.iregs[MD_CONTEXT_ARM_REG_PC],
michael@0:               frame1->context.iregs[MD_CONTEXT_ARM_REG_PC]);
michael@0:     EXPECT_EQ(expected.iregs[MD_CONTEXT_ARM_REG_PC],
michael@0:               frame1->instruction + 2);
michael@0:     EXPECT_EQ("epictetus", frame1->function_name);
michael@0:   }
michael@0: 
michael@0:   // The values we expect to find for the caller's registers.
michael@0:   MDRawContextARM expected;
michael@0: 
michael@0:   // The validity mask for expected.
michael@0:   int expected_validity;
michael@0: 
michael@0:   // The validity mask to impose on the context frame.
michael@0:   int context_frame_validity;
michael@0: };
michael@0: 
michael@0: class CFI: public CFIFixture, public Test { };
michael@0: 
michael@0: TEST_F(CFI, At4000) {
michael@0:   stack_section.start() = expected.iregs[MD_CONTEXT_ARM_REG_SP];
michael@0:   raw_context.iregs[MD_CONTEXT_ARM_REG_PC] = 0x40004000;
michael@0:   raw_context.iregs[MD_CONTEXT_ARM_REG_LR] = 0x40005510;
michael@0:   CheckWalk();
michael@0: }
michael@0: 
michael@0: TEST_F(CFI, At4001) {
michael@0:   Label frame1_sp = expected.iregs[MD_CONTEXT_ARM_REG_SP];
michael@0:   stack_section
michael@0:     .D32(0xb5d55e68)            // saved r4
michael@0:     .D32(0x8112e110)            // saved fp
michael@0:     .D32(0x40005510)            // return address
michael@0:     .Mark(&frame1_sp);          // This effectively sets stack_section.start().
michael@0:   raw_context.iregs[MD_CONTEXT_ARM_REG_PC] = 0x40004001;
michael@0:   raw_context.iregs[4] = 0x635adc9f;                     // distinct callee r4
michael@0:   raw_context.iregs[MD_CONTEXT_ARM_REG_FP] = 0xbe145fc4; // distinct callee fp
michael@0:   CheckWalk();
michael@0: }
michael@0: 
michael@0: // As above, but unwind from a context that has only the PC and SP.
michael@0: TEST_F(CFI, At4001LimitedValidity) {
michael@0:   context_frame_validity =
michael@0:     StackFrameARM::CONTEXT_VALID_PC | StackFrameARM::CONTEXT_VALID_SP;
michael@0:   raw_context.iregs[MD_CONTEXT_ARM_REG_PC] = 0x40004001;
michael@0:   raw_context.iregs[MD_CONTEXT_ARM_REG_FP] = 0xbe145fc4; // distinct callee fp
michael@0:   Label frame1_sp = expected.iregs[MD_CONTEXT_ARM_REG_SP];
michael@0:   stack_section
michael@0:     .D32(0xb5d55e68)            // saved r4
michael@0:     .D32(0x8112e110)            // saved fp
michael@0:     .D32(0x40005510)            // return address
michael@0:     .Mark(&frame1_sp);          // This effectively sets stack_section.start().
michael@0:   expected_validity = (StackFrameARM::CONTEXT_VALID_PC
michael@0:                        | StackFrameARM::CONTEXT_VALID_SP
michael@0:                        | StackFrameARM::CONTEXT_VALID_FP
michael@0:                        | StackFrameARM::CONTEXT_VALID_R4);
michael@0:   CheckWalk();
michael@0: }
michael@0: 
michael@0: TEST_F(CFI, At4002) {
michael@0:   Label frame1_sp = expected.iregs[MD_CONTEXT_ARM_REG_SP];
michael@0:   stack_section
michael@0:     .D32(0xfb81ff3d)            // no longer saved r4
michael@0:     .D32(0x8112e110)            // saved fp
michael@0:     .D32(0x40005510)            // return address
michael@0:     .Mark(&frame1_sp);          // This effectively sets stack_section.start().
michael@0:   raw_context.iregs[MD_CONTEXT_ARM_REG_PC] = 0x40004002;
michael@0:   raw_context.iregs[0] = 0xb5d55e68;  // saved r4
michael@0:   raw_context.iregs[1] = 0xebd134f3;  // saved r5
michael@0:   raw_context.iregs[2] = 0xa31e74bc;  // saved r6
michael@0:   raw_context.iregs[3] = 0x2dcb16b3;  // saved r7
michael@0:   raw_context.iregs[4] = 0xfdd35466;  // distinct callee r4
michael@0:   raw_context.iregs[5] = 0xf18c946c;  // distinct callee r5
michael@0:   raw_context.iregs[6] = 0xac2079e8;  // distinct callee r6
michael@0:   raw_context.iregs[7] = 0xa449829f;  // distinct callee r7
michael@0:   raw_context.iregs[MD_CONTEXT_ARM_REG_FP] = 0xbe145fc4; // distinct callee fp
michael@0:   CheckWalk();
michael@0: }
michael@0: 
michael@0: TEST_F(CFI, At4003) {
michael@0:   Label frame1_sp = expected.iregs[MD_CONTEXT_ARM_REG_SP];
michael@0:   stack_section
michael@0:     .D32(0x48c8dd5a)            // saved r1 (even though it's not callee-saves)
michael@0:     .D32(0xcb78040e)            // no longer saved r4
michael@0:     .D32(0x8112e110)            // saved fp
michael@0:     .D32(0x40005510)            // return address
michael@0:     .Mark(&frame1_sp);          // This effectively sets stack_section.start().
michael@0:   raw_context.iregs[MD_CONTEXT_ARM_REG_PC] = 0x40004003;
michael@0:   raw_context.iregs[1] = 0xfb756319;                     // distinct callee r1
michael@0:   raw_context.iregs[MD_CONTEXT_ARM_REG_FP] = 0x0a2857ea; // distinct callee fp
michael@0:   expected.iregs[1] = 0x48c8dd5a;    // caller's r1
michael@0:   expected_validity |= StackFrameARM::CONTEXT_VALID_R1;
michael@0:   CheckWalk();
michael@0: }
michael@0: 
michael@0: // We have no new rule at module offset 0x4004, so the results here should
michael@0: // be the same as those at module offset 0x4003.
michael@0: TEST_F(CFI, At4004) {
michael@0:   Label frame1_sp = expected.iregs[MD_CONTEXT_ARM_REG_SP];
michael@0:   stack_section
michael@0:     .D32(0x48c8dd5a)            // saved r1 (even though it's not callee-saves)
michael@0:     .D32(0xcb78040e)            // no longer saved r4
michael@0:     .D32(0x8112e110)            // saved fp
michael@0:     .D32(0x40005510)            // return address
michael@0:     .Mark(&frame1_sp);          // This effectively sets stack_section.start().
michael@0:   raw_context.iregs[MD_CONTEXT_ARM_REG_PC] = 0x40004004;
michael@0:   raw_context.iregs[1] = 0xfb756319; // distinct callee r1
michael@0:   expected.iregs[1] = 0x48c8dd5a; // caller's r1
michael@0:   expected_validity |= StackFrameARM::CONTEXT_VALID_R1;
michael@0:   CheckWalk();
michael@0: }
michael@0: 
michael@0: // Here we move the .cfa, but provide an explicit rule to recover the SP,
michael@0: // so again there should be no change in the registers recovered.
michael@0: TEST_F(CFI, At4005) {
michael@0:   Label frame1_sp = expected.iregs[MD_CONTEXT_ARM_REG_SP];
michael@0:   stack_section
michael@0:     .D32(0x48c8dd5a)            // saved r1 (even though it's not callee-saves)
michael@0:     .D32(0xf013f841)            // no longer saved r4
michael@0:     .D32(0x8112e110)            // saved fp
michael@0:     .D32(0x40005510)            // return address
michael@0:     .Mark(&frame1_sp);          // This effectively sets stack_section.start().
michael@0:   raw_context.iregs[MD_CONTEXT_ARM_REG_PC] = 0x40004005;
michael@0:   raw_context.iregs[1] = 0xfb756319; // distinct callee r1
michael@0:   expected.iregs[1] = 0x48c8dd5a; // caller's r1
michael@0:   expected_validity |= StackFrameARM::CONTEXT_VALID_R1;
michael@0:   CheckWalk();
michael@0: }
michael@0: 
michael@0: // Here we provide an explicit rule for the PC, and have the saved .ra be
michael@0: // bogus.
michael@0: TEST_F(CFI, At4006) {
michael@0:   Label frame1_sp = expected.iregs[MD_CONTEXT_ARM_REG_SP];
michael@0:   stack_section
michael@0:     .D32(0x40005510)            // saved pc
michael@0:     .D32(0x48c8dd5a)            // saved r1 (even though it's not callee-saves)
michael@0:     .D32(0xf013f841)            // no longer saved r4
michael@0:     .D32(0x8112e110)            // saved fp
michael@0:     .D32(0xf8d15783)            // .ra rule recovers this, which is garbage
michael@0:     .Mark(&frame1_sp);          // This effectively sets stack_section.start().
michael@0:   raw_context.iregs[MD_CONTEXT_ARM_REG_PC] = 0x40004006;
michael@0:   raw_context.iregs[1] = 0xfb756319; // callee's r1, different from caller's
michael@0:   expected.iregs[1] = 0x48c8dd5a; // caller's r1
michael@0:   expected_validity |= StackFrameARM::CONTEXT_VALID_R1;
michael@0:   CheckWalk();
michael@0: }
michael@0: 
michael@0: // Check that we reject rules that would cause the stack pointer to
michael@0: // move in the wrong direction.
michael@0: TEST_F(CFI, RejectBackwards) {
michael@0:   raw_context.iregs[MD_CONTEXT_ARM_REG_PC] = 0x40006000;
michael@0:   raw_context.iregs[MD_CONTEXT_ARM_REG_SP] = 0x80000000;
michael@0:   raw_context.iregs[MD_CONTEXT_ARM_REG_LR] = 0x40005510;
michael@0:   StackFrameSymbolizer frame_symbolizer(&supplier, &resolver);
michael@0:   StackwalkerARM walker(&system_info, &raw_context, -1, &stack_region, &modules,
michael@0:                         &frame_symbolizer);
michael@0:   vector<const CodeModule*> modules_without_symbols;
michael@0:   ASSERT_TRUE(walker.Walk(&call_stack, &modules_without_symbols));
michael@0:   ASSERT_EQ(0U, modules_without_symbols.size());
michael@0:   frames = call_stack.frames();
michael@0:   ASSERT_EQ(1U, frames->size());
michael@0: }
michael@0: 
michael@0: // Check that we reject rules whose expressions' evaluation fails.
michael@0: TEST_F(CFI, RejectBadExpressions) {
michael@0:   raw_context.iregs[MD_CONTEXT_ARM_REG_PC] = 0x40007000;
michael@0:   raw_context.iregs[MD_CONTEXT_ARM_REG_SP] = 0x80000000;
michael@0:   StackFrameSymbolizer frame_symbolizer(&supplier, &resolver);
michael@0:   StackwalkerARM walker(&system_info, &raw_context, -1, &stack_region, &modules,
michael@0:                         &frame_symbolizer);
michael@0:   vector<const CodeModule*> modules_without_symbols;
michael@0:   ASSERT_TRUE(walker.Walk(&call_stack, &modules_without_symbols));
michael@0:   ASSERT_EQ(0U, modules_without_symbols.size());
michael@0:   frames = call_stack.frames();
michael@0:   ASSERT_EQ(1U, frames->size());
michael@0: }
michael@0: 
michael@0: class StackwalkerARMFixtureIOS : public StackwalkerARMFixture {
michael@0:  public:
michael@0:   StackwalkerARMFixtureIOS() {
michael@0:     system_info.os = "iOS";
michael@0:     system_info.os_short = "ios";
michael@0:   }
michael@0: };
michael@0: 
michael@0: class GetFramesByFramePointer: public StackwalkerARMFixtureIOS, public Test { };
michael@0: 
michael@0: TEST_F(GetFramesByFramePointer, OnlyFramePointer) {
michael@0:   stack_section.start() = 0x80000000;
michael@0:   uint32_t return_address1 = 0x50000100;
michael@0:   uint32_t return_address2 = 0x50000900;
michael@0:   Label frame1_sp, frame2_sp;
michael@0:   Label frame1_fp, frame2_fp;
michael@0:   stack_section
michael@0:     // frame 0
michael@0:     .Append(32, 0)           // Whatever values on the stack.
michael@0:     .D32(0x0000000D)         // junk that's not
michael@0:     .D32(0xF0000000)         // a return address.
michael@0: 
michael@0:     .Mark(&frame1_fp)        // Next fp will point to the next value.
michael@0:     .D32(frame2_fp)          // Save current frame pointer.
michael@0:     .D32(return_address2)    // Save current link register.
michael@0:     .Mark(&frame1_sp)
michael@0: 
michael@0:     // frame 1
michael@0:     .Append(32, 0)           // Whatever values on the stack.
michael@0:     .D32(0x0000000D)         // junk that's not
michael@0:     .D32(0xF0000000)         // a return address.
michael@0: 
michael@0:     .Mark(&frame2_fp)
michael@0:     .D32(0)
michael@0:     .D32(0)
michael@0:     .Mark(&frame2_sp)
michael@0: 
michael@0:     // frame 2
michael@0:     .Append(32, 0)           // Whatever values on the stack.
michael@0:     .D32(0x0000000D)         // junk that's not
michael@0:     .D32(0xF0000000);        // a return address.
michael@0:   RegionFromSection();
michael@0: 
michael@0: 
michael@0:   raw_context.iregs[MD_CONTEXT_ARM_REG_PC] = 0x40005510;
michael@0:   raw_context.iregs[MD_CONTEXT_ARM_REG_LR] = return_address1;
michael@0:   raw_context.iregs[MD_CONTEXT_ARM_REG_IOS_FP] = frame1_fp.Value();
michael@0:   raw_context.iregs[MD_CONTEXT_ARM_REG_SP] = stack_section.start().Value();
michael@0: 
michael@0:   StackFrameSymbolizer frame_symbolizer(&supplier, &resolver);
michael@0:   StackwalkerARM walker(&system_info, &raw_context, MD_CONTEXT_ARM_REG_IOS_FP,
michael@0:                         &stack_region, &modules, &frame_symbolizer);
michael@0: 
michael@0:   vector<const CodeModule*> modules_without_symbols;
michael@0:   ASSERT_TRUE(walker.Walk(&call_stack, &modules_without_symbols));
michael@0:   ASSERT_EQ(2U, modules_without_symbols.size());
michael@0:   ASSERT_EQ("module1", modules_without_symbols[0]->debug_file());
michael@0:   ASSERT_EQ("module2", modules_without_symbols[1]->debug_file());
michael@0:   frames = call_stack.frames();
michael@0:   ASSERT_EQ(3U, frames->size());
michael@0: 
michael@0:   StackFrameARM *frame0 = static_cast<StackFrameARM *>(frames->at(0));
michael@0:   EXPECT_EQ(StackFrame::FRAME_TRUST_CONTEXT, frame0->trust);
michael@0:   ASSERT_EQ(StackFrameARM::CONTEXT_VALID_ALL, frame0->context_validity);
michael@0:   EXPECT_EQ(0, memcmp(&raw_context, &frame0->context, sizeof(raw_context)));
michael@0: 
michael@0:   StackFrameARM *frame1 = static_cast<StackFrameARM *>(frames->at(1));
michael@0:   EXPECT_EQ(StackFrame::FRAME_TRUST_FP, frame1->trust);
michael@0:   ASSERT_EQ((StackFrameARM::CONTEXT_VALID_PC |
michael@0:              StackFrameARM::CONTEXT_VALID_LR |
michael@0:              StackFrameARM::RegisterValidFlag(MD_CONTEXT_ARM_REG_IOS_FP) |
michael@0:              StackFrameARM::CONTEXT_VALID_SP),
michael@0:             frame1->context_validity);
michael@0:   EXPECT_EQ(return_address1, frame1->context.iregs[MD_CONTEXT_ARM_REG_PC]);
michael@0:   EXPECT_EQ(return_address2, frame1->context.iregs[MD_CONTEXT_ARM_REG_LR]);
michael@0:   EXPECT_EQ(frame1_sp.Value(), frame1->context.iregs[MD_CONTEXT_ARM_REG_SP]);
michael@0:   EXPECT_EQ(frame2_fp.Value(),
michael@0:             frame1->context.iregs[MD_CONTEXT_ARM_REG_IOS_FP]);
michael@0: 
michael@0:   StackFrameARM *frame2 = static_cast<StackFrameARM *>(frames->at(2));
michael@0:   EXPECT_EQ(StackFrame::FRAME_TRUST_FP, frame2->trust);
michael@0:   ASSERT_EQ((StackFrameARM::CONTEXT_VALID_PC |
michael@0:              StackFrameARM::CONTEXT_VALID_LR |
michael@0:              StackFrameARM::RegisterValidFlag(MD_CONTEXT_ARM_REG_IOS_FP) |
michael@0:              StackFrameARM::CONTEXT_VALID_SP),
michael@0:             frame2->context_validity);
michael@0:   EXPECT_EQ(return_address2, frame2->context.iregs[MD_CONTEXT_ARM_REG_PC]);
michael@0:   EXPECT_EQ(0U, frame2->context.iregs[MD_CONTEXT_ARM_REG_LR]);
michael@0:   EXPECT_EQ(frame2_sp.Value(), frame2->context.iregs[MD_CONTEXT_ARM_REG_SP]);
michael@0:   EXPECT_EQ(0U, frame2->context.iregs[MD_CONTEXT_ARM_REG_IOS_FP]);
michael@0: }
michael@0: 
michael@0: TEST_F(GetFramesByFramePointer, FramePointerAndCFI) {
michael@0:   // Provide the standatd STACK CFI records that is obtained when exmining an
michael@0:   // executable produced by XCode.
michael@0:   SetModuleSymbols(&module1,
michael@0:                      // Adding a function in CFI.
michael@0:                      "FUNC 4000 1000 10 enchiridion\n"
michael@0: 
michael@0:                      "STACK CFI INIT 4000 100 .cfa: sp 0 + .ra: lr\n"
michael@0:                      "STACK CFI 4001 .cfa: sp 8 + .ra: .cfa -4 + ^"
michael@0:                      " r7: .cfa -8 + ^\n"
michael@0:                      "STACK CFI 4002 .cfa: r7 8 +\n"
michael@0:                   );
michael@0: 
michael@0:   stack_section.start() = 0x80000000;
michael@0:   uint32_t return_address1 = 0x40004010;
michael@0:   uint32_t return_address2 = 0x50000900;
michael@0:   Label frame1_sp, frame2_sp;
michael@0:   Label frame1_fp, frame2_fp;
michael@0:   stack_section
michael@0:     // frame 0
michael@0:     .Append(32, 0)           // Whatever values on the stack.
michael@0:     .D32(0x0000000D)         // junk that's not
michael@0:     .D32(0xF0000000)         // a return address.
michael@0: 
michael@0:     .Mark(&frame1_fp)        // Next fp will point to the next value.
michael@0:     .D32(frame2_fp)          // Save current frame pointer.
michael@0:     .D32(return_address2)    // Save current link register.
michael@0:     .Mark(&frame1_sp)
michael@0: 
michael@0:     // frame 1
michael@0:     .Append(32, 0)           // Whatever values on the stack.
michael@0:     .D32(0x0000000D)         // junk that's not
michael@0:     .D32(0xF0000000)         // a return address.
michael@0: 
michael@0:     .Mark(&frame2_fp)
michael@0:     .D32(0)
michael@0:     .D32(0)
michael@0:     .Mark(&frame2_sp)
michael@0: 
michael@0:     // frame 2
michael@0:     .Append(32, 0)           // Whatever values on the stack.
michael@0:     .D32(0x0000000D)         // junk that's not
michael@0:     .D32(0xF0000000);        // a return address.
michael@0:   RegionFromSection();
michael@0: 
michael@0: 
michael@0:   raw_context.iregs[MD_CONTEXT_ARM_REG_PC] = 0x50000400;
michael@0:   raw_context.iregs[MD_CONTEXT_ARM_REG_LR] = return_address1;
michael@0:   raw_context.iregs[MD_CONTEXT_ARM_REG_IOS_FP] = frame1_fp.Value();
michael@0:   raw_context.iregs[MD_CONTEXT_ARM_REG_SP] = stack_section.start().Value();
michael@0: 
michael@0:   StackFrameSymbolizer frame_symbolizer(&supplier, &resolver);
michael@0:   StackwalkerARM walker(&system_info, &raw_context, MD_CONTEXT_ARM_REG_IOS_FP,
michael@0:                         &stack_region, &modules, &frame_symbolizer);
michael@0: 
michael@0:   vector<const CodeModule*> modules_without_symbols;
michael@0:   ASSERT_TRUE(walker.Walk(&call_stack, &modules_without_symbols));
michael@0:   ASSERT_EQ(1U, modules_without_symbols.size());
michael@0:   ASSERT_EQ("module2", modules_without_symbols[0]->debug_file());
michael@0:   frames = call_stack.frames();
michael@0:   ASSERT_EQ(3U, frames->size());
michael@0: 
michael@0:   StackFrameARM *frame0 = static_cast<StackFrameARM *>(frames->at(0));
michael@0:   EXPECT_EQ(StackFrame::FRAME_TRUST_CONTEXT, frame0->trust);
michael@0:   ASSERT_EQ(StackFrameARM::CONTEXT_VALID_ALL, frame0->context_validity);
michael@0:   EXPECT_EQ(0, memcmp(&raw_context, &frame0->context, sizeof(raw_context)));
michael@0: 
michael@0:   StackFrameARM *frame1 = static_cast<StackFrameARM *>(frames->at(1));
michael@0:   EXPECT_EQ(StackFrame::FRAME_TRUST_FP, frame1->trust);
michael@0:   ASSERT_EQ((StackFrameARM::CONTEXT_VALID_PC |
michael@0:              StackFrameARM::CONTEXT_VALID_LR |
michael@0:              StackFrameARM::RegisterValidFlag(MD_CONTEXT_ARM_REG_IOS_FP) |
michael@0:              StackFrameARM::CONTEXT_VALID_SP),
michael@0:             frame1->context_validity);
michael@0:   EXPECT_EQ(return_address1, frame1->context.iregs[MD_CONTEXT_ARM_REG_PC]);
michael@0:   EXPECT_EQ(return_address2, frame1->context.iregs[MD_CONTEXT_ARM_REG_LR]);
michael@0:   EXPECT_EQ(frame1_sp.Value(), frame1->context.iregs[MD_CONTEXT_ARM_REG_SP]);
michael@0:   EXPECT_EQ(frame2_fp.Value(),
michael@0:             frame1->context.iregs[MD_CONTEXT_ARM_REG_IOS_FP]);
michael@0:   EXPECT_EQ("enchiridion", frame1->function_name);
michael@0:   EXPECT_EQ(0x40004000U, frame1->function_base);
michael@0: 
michael@0: 
michael@0:   StackFrameARM *frame2 = static_cast<StackFrameARM *>(frames->at(2));
michael@0:   EXPECT_EQ(StackFrame::FRAME_TRUST_CFI, frame2->trust);
michael@0:   ASSERT_EQ((StackFrameARM::CONTEXT_VALID_PC |
michael@0:              StackFrameARM::CONTEXT_VALID_LR |
michael@0:              StackFrameARM::RegisterValidFlag(MD_CONTEXT_ARM_REG_IOS_FP) |
michael@0:              StackFrameARM::CONTEXT_VALID_SP),
michael@0:             frame2->context_validity);
michael@0:   EXPECT_EQ(return_address2, frame2->context.iregs[MD_CONTEXT_ARM_REG_PC]);
michael@0:   EXPECT_EQ(0U, frame2->context.iregs[MD_CONTEXT_ARM_REG_LR]);
michael@0:   EXPECT_EQ(frame2_sp.Value(), frame2->context.iregs[MD_CONTEXT_ARM_REG_SP]);
michael@0:   EXPECT_EQ(0U, frame2->context.iregs[MD_CONTEXT_ARM_REG_IOS_FP]);
michael@0: }