1 // Copyright (c) 2010 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 // fast_source_line_resolver.h: FastSourceLineResolver is derived from 31 // SourceLineResolverBase, and is a concrete implementation of 32 // SourceLineResolverInterface. 33 // 34 // FastSourceLineResolver is a sibling class of BasicSourceLineResolver. The 35 // difference is FastSourceLineResolver loads a serialized memory chunk of data 36 // which can be used directly a Module without parsing or copying of underlying 37 // data. Therefore loading a symbol in FastSourceLineResolver is much faster 38 // and more memory-efficient than BasicSourceLineResolver. 39 // 40 // See "source_line_resolver_base.h" and 41 // "google_breakpad/source_line_resolver_interface.h" for more reference. 42 // 43 // Author: Siyang Xie (lambxsy@google.com) 44 45 #ifndef GOOGLE_BREAKPAD_PROCESSOR_FAST_SOURCE_LINE_RESOLVER_H__ 46 #define GOOGLE_BREAKPAD_PROCESSOR_FAST_SOURCE_LINE_RESOLVER_H__ 47 48 #include <map> 49 #include <string> 50 51 #include "google_breakpad/processor/source_line_resolver_base.h" 52 53 namespace google_breakpad { 54 55 using std::map; 56 57 class FastSourceLineResolver : public SourceLineResolverBase { 58 public: 59 FastSourceLineResolver(); ~FastSourceLineResolver()60 virtual ~FastSourceLineResolver() { } 61 62 using SourceLineResolverBase::FillSourceLineInfo; 63 using SourceLineResolverBase::FindCFIFrameInfo; 64 using SourceLineResolverBase::FindWindowsFrameInfo; 65 using SourceLineResolverBase::HasModule; 66 using SourceLineResolverBase::IsModuleCorrupt; 67 using SourceLineResolverBase::LoadModule; 68 using SourceLineResolverBase::LoadModuleUsingMapBuffer; 69 using SourceLineResolverBase::LoadModuleUsingMemoryBuffer; 70 using SourceLineResolverBase::UnloadModule; 71 72 private: 73 // Friend declarations. 74 friend class ModuleComparer; 75 friend class ModuleSerializer; 76 friend class FastModuleFactory; 77 78 // Nested types that will derive from corresponding nested types defined in 79 // SourceLineResolverBase. 80 struct Line; 81 struct Function; 82 struct PublicSymbol; 83 class Module; 84 85 // Deserialize raw memory data to construct a WindowsFrameInfo object. 86 static WindowsFrameInfo CopyWFI(const char *raw_memory); 87 88 // FastSourceLineResolver requires the memory buffer stays alive during the 89 // lifetime of a corresponding module, therefore it needs to redefine this 90 // virtual method. 91 virtual bool ShouldDeleteMemoryBufferAfterLoadModule(); 92 93 // Disallow unwanted copy ctor and assignment operator 94 FastSourceLineResolver(const FastSourceLineResolver&); 95 void operator=(const FastSourceLineResolver&); 96 }; 97 98 } // namespace google_breakpad 99 100 #endif // GOOGLE_BREAKPAD_PROCESSOR_FAST_SOURCE_LINE_RESOLVER_H__ 101