/thirdparty/breakpad/google_breakpad/processor/fast_source_line_resolver.h

http://github.com/tomahawk-player/tomahawk · C Header · 99 lines · 34 code · 14 blank · 51 comment · 0 complexity · e83babd3055e3265d662b4ce229c0c5f MD5 · raw file

  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. #ifndef GOOGLE_BREAKPAD_PROCESSOR_FAST_SOURCE_LINE_RESOLVER_H__
  45. #define GOOGLE_BREAKPAD_PROCESSOR_FAST_SOURCE_LINE_RESOLVER_H__
  46. #include <map>
  47. #include <string>
  48. #include "google_breakpad/processor/source_line_resolver_base.h"
  49. namespace google_breakpad {
  50. using std::map;
  51. class FastSourceLineResolver : public SourceLineResolverBase {
  52. public:
  53. FastSourceLineResolver();
  54. virtual ~FastSourceLineResolver() { }
  55. using SourceLineResolverBase::FillSourceLineInfo;
  56. using SourceLineResolverBase::FindCFIFrameInfo;
  57. using SourceLineResolverBase::FindWindowsFrameInfo;
  58. using SourceLineResolverBase::HasModule;
  59. using SourceLineResolverBase::LoadModule;
  60. using SourceLineResolverBase::LoadModuleUsingMapBuffer;
  61. using SourceLineResolverBase::LoadModuleUsingMemoryBuffer;
  62. using SourceLineResolverBase::UnloadModule;
  63. private:
  64. // Friend declarations.
  65. friend class ModuleComparer;
  66. friend class ModuleSerializer;
  67. friend class FastModuleFactory;
  68. // Nested types that will derive from corresponding nested types defined in
  69. // SourceLineResolverBase.
  70. struct Line;
  71. struct Function;
  72. struct PublicSymbol;
  73. class Module;
  74. // Deserialize raw memory data to construct a WindowsFrameInfo object.
  75. static WindowsFrameInfo CopyWFI(const char *raw_memory);
  76. // FastSourceLineResolver requires the memory buffer stays alive during the
  77. // lifetime of a corresponding module, therefore it needs to redefine this
  78. // virtual method.
  79. virtual bool ShouldDeleteMemoryBufferAfterLoadModule();
  80. // Disallow unwanted copy ctor and assignment operator
  81. FastSourceLineResolver(const FastSourceLineResolver&);
  82. void operator=(const FastSourceLineResolver&);
  83. };
  84. } // namespace google_breakpad
  85. #endif // GOOGLE_BREAKPAD_PROCESSOR_FAST_SOURCE_LINE_RESOLVER_H__