toolkit/crashreporter/google-breakpad/src/processor/module_serializer.h@6474c204b198 (annotated)
toolkit/crashreporter/google-breakpad/src/processor/module_serializer.h
Wed, 31 Dec 2014 06:09:35 +0100
- author
- Michael Schloh von Bennewitz <michael@schloh.com>
- date
- Wed, 31 Dec 2014 06:09:35 +0100
- changeset 0
- 6474c204b198
- permissions
- -rw-r--r--
Cloned upstream origin tor-browser at tor-browser-31.3.0esr-4.5-1-build1
revision ID fc1c9ff7c1b2defdbc039f12214767608f46423f for hacking purpose.
| michael@0 | 1 | // Copyright (c) 2010, Google Inc. |
| michael@0 | 2 | // All rights reserved. |
| michael@0 | 3 | // |
| michael@0 | 4 | // Redistribution and use in source and binary forms, with or without |
| michael@0 | 5 | // modification, are permitted provided that the following conditions are |
| michael@0 | 6 | // met: |
| michael@0 | 7 | // |
| michael@0 | 8 | // * Redistributions of source code must retain the above copyright |
| michael@0 | 9 | // notice, this list of conditions and the following disclaimer. |
| michael@0 | 10 | // * Redistributions in binary form must reproduce the above |
| michael@0 | 11 | // copyright notice, this list of conditions and the following disclaimer |
| michael@0 | 12 | // in the documentation and/or other materials provided with the |
| michael@0 | 13 | // distribution. |
| michael@0 | 14 | // * Neither the name of Google Inc. nor the names of its |
| michael@0 | 15 | // contributors may be used to endorse or promote products derived from |
| michael@0 | 16 | // this software without specific prior written permission. |
| michael@0 | 17 | // |
| michael@0 | 18 | // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
| michael@0 | 19 | // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
| michael@0 | 20 | // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
| michael@0 | 21 | // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
| michael@0 | 22 | // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
| michael@0 | 23 | // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
| michael@0 | 24 | // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
| michael@0 | 25 | // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
| michael@0 | 26 | // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
| michael@0 | 27 | // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
| michael@0 | 28 | // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| michael@0 | 29 | // |
| michael@0 | 30 | // module_serializer.h: ModuleSerializer serializes a loaded symbol, |
| michael@0 | 31 | // i.e., a loaded BasicSouceLineResolver::Module instance, into a memory |
| michael@0 | 32 | // chunk of data. The serialized data can be read and loaded by |
| michael@0 | 33 | // FastSourceLineResolver without CPU & memory-intensive parsing. |
| michael@0 | 34 | // |
| michael@0 | 35 | // Author: Siyang Xie (lambxsy@google.com) |
| michael@0 | 36 | |
| michael@0 | 37 | #ifndef PROCESSOR_MODULE_SERIALIZER_H__ |
| michael@0 | 38 | #define PROCESSOR_MODULE_SERIALIZER_H__ |
| michael@0 | 39 | |
| michael@0 | 40 | #include <map> |
| michael@0 | 41 | #include <string> |
| michael@0 | 42 | |
| michael@0 | 43 | #include "google_breakpad/processor/basic_source_line_resolver.h" |
| michael@0 | 44 | #include "google_breakpad/processor/fast_source_line_resolver.h" |
| michael@0 | 45 | #include "processor/basic_source_line_resolver_types.h" |
| michael@0 | 46 | #include "processor/fast_source_line_resolver_types.h" |
| michael@0 | 47 | #include "processor/linked_ptr.h" |
| michael@0 | 48 | #include "processor/map_serializers-inl.h" |
| michael@0 | 49 | #include "processor/simple_serializer-inl.h" |
| michael@0 | 50 | #include "processor/windows_frame_info.h" |
| michael@0 | 51 | |
| michael@0 | 52 | namespace google_breakpad { |
| michael@0 | 53 | |
| michael@0 | 54 | // ModuleSerializer serializes a loaded BasicSourceLineResolver::Module into a |
| michael@0 | 55 | // chunk of memory data. ModuleSerializer also provides interface to compute |
| michael@0 | 56 | // memory size of the serialized data, write serialized data directly into |
| michael@0 | 57 | // memory, convert ASCII format symbol data into serialized binary data, and |
| michael@0 | 58 | // convert loaded BasicSourceLineResolver::Module into |
| michael@0 | 59 | // FastSourceLineResolver::Module. |
| michael@0 | 60 | class ModuleSerializer { |
| michael@0 | 61 | public: |
| michael@0 | 62 | // Compute the size of memory required to serialize a module. Return the |
| michael@0 | 63 | // total size needed for serialization. |
| michael@0 | 64 | size_t SizeOf(const BasicSourceLineResolver::Module &module); |
| michael@0 | 65 | |
| michael@0 | 66 | // Write a module into an allocated memory chunk with required size. |
| michael@0 | 67 | // Return the "end" of data, i.e., the address after the final byte of data. |
| michael@0 | 68 | char* Write(const BasicSourceLineResolver::Module &module, char *dest); |
| michael@0 | 69 | |
| michael@0 | 70 | // Serializes a loaded Module object into a chunk of memory data and returns |
| michael@0 | 71 | // the address of memory chunk. If size != NULL, *size is set to the memory |
| michael@0 | 72 | // size allocated for the serialized data. |
| michael@0 | 73 | // Caller takes the ownership of the memory chunk (allocated on heap), and |
| michael@0 | 74 | // owner should call delete [] to free the memory after use. |
| michael@0 | 75 | char* Serialize(const BasicSourceLineResolver::Module &module, |
| michael@0 | 76 | unsigned int *size = NULL); |
| michael@0 | 77 | |
| michael@0 | 78 | // Given the string format symbol_data, produces a chunk of serialized data. |
| michael@0 | 79 | // Caller takes ownership of the serialized data (on heap), and owner should |
| michael@0 | 80 | // call delete [] to free the memory after use. |
| michael@0 | 81 | char* SerializeSymbolFileData(const string &symbol_data, |
| michael@0 | 82 | unsigned int *size = NULL); |
| michael@0 | 83 | |
| michael@0 | 84 | // Serializes one loaded module with given moduleid in the basic source line |
| michael@0 | 85 | // resolver, and loads the serialized data into the fast source line resolver. |
| michael@0 | 86 | // Return false if the basic source line doesn't have a module with the given |
| michael@0 | 87 | // moduleid. |
| michael@0 | 88 | bool ConvertOneModule(const string &moduleid, |
| michael@0 | 89 | const BasicSourceLineResolver *basic_resolver, |
| michael@0 | 90 | FastSourceLineResolver *fast_resolver); |
| michael@0 | 91 | |
| michael@0 | 92 | // Serializes all the loaded modules in a basic source line resolver, and |
| michael@0 | 93 | // loads the serialized data into a fast source line resolver. |
| michael@0 | 94 | void ConvertAllModules(const BasicSourceLineResolver *basic_resolver, |
| michael@0 | 95 | FastSourceLineResolver *fast_resolver); |
| michael@0 | 96 | |
| michael@0 | 97 | private: |
| michael@0 | 98 | // Convenient type names. |
| michael@0 | 99 | typedef BasicSourceLineResolver::Line Line; |
| michael@0 | 100 | typedef BasicSourceLineResolver::Function Function; |
| michael@0 | 101 | typedef BasicSourceLineResolver::PublicSymbol PublicSymbol; |
| michael@0 | 102 | |
| michael@0 | 103 | // Internal implementation for ConvertOneModule and ConvertAllModules methods. |
| michael@0 | 104 | bool SerializeModuleAndLoadIntoFastResolver( |
| michael@0 | 105 | const BasicSourceLineResolver::ModuleMap::const_iterator &iter, |
| michael@0 | 106 | FastSourceLineResolver *fast_resolver); |
| michael@0 | 107 | |
| michael@0 | 108 | // Number of Maps that Module class contains. |
| michael@0 | 109 | static const int32_t kNumberMaps_ = |
| michael@0 | 110 | FastSourceLineResolver::Module::kNumberMaps_; |
| michael@0 | 111 | |
| michael@0 | 112 | // Memory sizes required to serialize map components in Module. |
| michael@0 | 113 | uint32_t map_sizes_[kNumberMaps_]; |
| michael@0 | 114 | |
| michael@0 | 115 | // Serializers for each individual map component in Module class. |
| michael@0 | 116 | StdMapSerializer<int, string> files_serializer_; |
| michael@0 | 117 | RangeMapSerializer<MemAddr, linked_ptr<Function> > functions_serializer_; |
| michael@0 | 118 | AddressMapSerializer<MemAddr, linked_ptr<PublicSymbol> > pubsym_serializer_; |
| michael@0 | 119 | ContainedRangeMapSerializer<MemAddr, |
| michael@0 | 120 | linked_ptr<WindowsFrameInfo> > wfi_serializer_; |
| michael@0 | 121 | RangeMapSerializer<MemAddr, string> cfi_init_rules_serializer_; |
| michael@0 | 122 | StdMapSerializer<MemAddr, string> cfi_delta_rules_serializer_; |
| michael@0 | 123 | }; |
| michael@0 | 124 | |
| michael@0 | 125 | } // namespace google_breakpad |
| michael@0 | 126 | |
| michael@0 | 127 | #endif // PROCESSOR_MODULE_SERIALIZER_H__ |
