michael@0: 
michael@0: /* libunwind - a platform-independent unwind library
michael@0:    Copyright 2011 Linaro Limited
michael@0: 
michael@0: This file is part of libunwind.
michael@0: 
michael@0: Permission is hereby granted, free of charge, to any person obtaining
michael@0: a copy of this software and associated documentation files (the
michael@0: "Software"), to deal in the Software without restriction, including
michael@0: without limitation the rights to use, copy, modify, merge, publish,
michael@0: distribute, sublicense, and/or sell copies of the Software, and to
michael@0: permit persons to whom the Software is furnished to do so, subject to
michael@0: the following conditions:
michael@0: 
michael@0: The above copyright notice and this permission notice shall be
michael@0: included in all copies or substantial portions of the Software.
michael@0: 
michael@0: THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
michael@0: EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
michael@0: MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
michael@0: NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
michael@0: LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
michael@0: OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
michael@0: WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.  */
michael@0: 
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: 
michael@0: // Derived from libunwind, with extensive modifications.
michael@0: 
michael@0: #ifndef COMMON_ARM_EX_READER_H__
michael@0: #define COMMON_ARM_EX_READER_H__
michael@0: 
michael@0: #include "common/arm_ex_to_module.h"
michael@0: #include "common/memory_range.h"
michael@0: 
michael@0: namespace arm_ex_reader {
michael@0: 
michael@0: // This class is a reader for ARM unwind information
michael@0: // from .ARM.exidx and .ARM.extab sections.
michael@0: class ExceptionTableInfo {
michael@0:  public:
michael@0:   ExceptionTableInfo(const char* exidx, size_t exidx_size,
michael@0:                      const char* extab, size_t extab_size,
michael@0:                      uint32_t text_last_svma,
michael@0:                      arm_ex_to_module::ARMExToModule* handler,
michael@0:                      const char* mapping_addr,
michael@0:                      uint32_t loading_addr)
michael@0:       : mr_exidx_(google_breakpad::MemoryRange(exidx, exidx_size)),
michael@0:         mr_extab_(google_breakpad::MemoryRange(extab, extab_size)),
michael@0:         text_last_svma_(text_last_svma),
michael@0:         handler_(handler), mapping_addr_(mapping_addr),
michael@0:         loading_addr_(loading_addr) { }
michael@0: 
michael@0:   ~ExceptionTableInfo() { }
michael@0: 
michael@0:   // Parses the entries in .ARM.exidx and possibly
michael@0:   // in .ARM.extab tables, reports what we find to
michael@0:   // arm_ex_to_module::ARMExToModule.
michael@0:   void Start();
michael@0: 
michael@0:  private:
michael@0:   google_breakpad::MemoryRange mr_exidx_;
michael@0:   google_breakpad::MemoryRange mr_extab_;
michael@0:   uint32_t text_last_svma_;
michael@0:   arm_ex_to_module::ARMExToModule* handler_;
michael@0:   const char* mapping_addr_;
michael@0:   uint32_t loading_addr_;
michael@0: 
michael@0:   enum ExExtractResult {
michael@0:     ExSuccess,        // success
michael@0:     ExInBufOverflow,  // out-of-range while reading .exidx
michael@0:     ExOutBufOverflow, // output buffer is too small
michael@0:     ExCantUnwind,     // this function is marked CANT_UNWIND
michael@0:     ExCantRepresent,  // entry valid, but we can't represent it
michael@0:     ExInvalid         // entry is invalid
michael@0:   };
michael@0:   ExExtractResult
michael@0:     ExtabEntryExtract(const struct arm_ex_to_module::exidx_entry* entry,
michael@0:                       uint8_t* buf, size_t buf_size,
michael@0:                       /*OUT*/size_t* buf_used);
michael@0: 
michael@0:   int ExtabEntryDecode(const uint8_t* buf, size_t buf_size);
michael@0: };
michael@0: 
michael@0: } // namespace arm_ex_reader
michael@0: 
michael@0: #endif // COMMON_ARM_EX_READER_H__