toolkit/crashreporter/google-breakpad/src/processor/range_map.h@b8a032363ba2 (annotated)
toolkit/crashreporter/google-breakpad/src/processor/range_map.h
Thu, 22 Jan 2015 13:21:57 +0100
- author
- Michael Schloh von Bennewitz <michael@schloh.com>
- date
- Thu, 22 Jan 2015 13:21:57 +0100
- branch
- TOR_BUG_9701
- changeset 15
- b8a032363ba2
- permissions
- -rw-r--r--
Incorporate requested changes from Mozilla in review:
https://bugzilla.mozilla.org/show_bug.cgi?id=1123480#c6
| michael@0 | 1 | // Copyright (c) 2006, 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 | // range_map.h: Range maps. |
| michael@0 | 31 | // |
| michael@0 | 32 | // A range map associates a range of addresses with a specific object. This |
| michael@0 | 33 | // is useful when certain objects of variable size are located within an |
| michael@0 | 34 | // address space. The range map makes it simple to determine which object is |
| michael@0 | 35 | // associated with a specific address, which may be any address within the |
| michael@0 | 36 | // range associated with an object. |
| michael@0 | 37 | // |
| michael@0 | 38 | // Author: Mark Mentovai |
| michael@0 | 39 | |
| michael@0 | 40 | #ifndef PROCESSOR_RANGE_MAP_H__ |
| michael@0 | 41 | #define PROCESSOR_RANGE_MAP_H__ |
| michael@0 | 42 | |
| michael@0 | 43 | |
| michael@0 | 44 | #include <map> |
| michael@0 | 45 | |
| michael@0 | 46 | |
| michael@0 | 47 | namespace google_breakpad { |
| michael@0 | 48 | |
| michael@0 | 49 | // Forward declarations (for later friend declarations of specialized template). |
| michael@0 | 50 | template<class, class> class RangeMapSerializer; |
| michael@0 | 51 | |
| michael@0 | 52 | template<typename AddressType, typename EntryType> |
| michael@0 | 53 | class RangeMap { |
| michael@0 | 54 | public: |
| michael@0 | 55 | RangeMap() : map_() {} |
| michael@0 | 56 | |
| michael@0 | 57 | // Inserts a range into the map. Returns false for a parameter error, |
| michael@0 | 58 | // or if the location of the range would conflict with a range already |
| michael@0 | 59 | // stored in the map. |
| michael@0 | 60 | bool StoreRange(const AddressType &base, |
| michael@0 | 61 | const AddressType &size, |
| michael@0 | 62 | const EntryType &entry); |
| michael@0 | 63 | |
| michael@0 | 64 | // Locates the range encompassing the supplied address. If there is |
| michael@0 | 65 | // no such range, returns false. entry_base and entry_size, if non-NULL, |
| michael@0 | 66 | // are set to the base and size of the entry's range. |
| michael@0 | 67 | bool RetrieveRange(const AddressType &address, EntryType *entry, |
| michael@0 | 68 | AddressType *entry_base, AddressType *entry_size) const; |
| michael@0 | 69 | |
| michael@0 | 70 | // Locates the range encompassing the supplied address, if one exists. |
| michael@0 | 71 | // If no range encompasses the supplied address, locates the nearest range |
| michael@0 | 72 | // to the supplied address that is lower than the address. Returns false |
| michael@0 | 73 | // if no range meets these criteria. entry_base and entry_size, if |
| michael@0 | 74 | // non-NULL, are set to the base and size of the entry's range. |
| michael@0 | 75 | bool RetrieveNearestRange(const AddressType &address, EntryType *entry, |
| michael@0 | 76 | AddressType *entry_base, AddressType *entry_size) |
| michael@0 | 77 | const; |
| michael@0 | 78 | |
| michael@0 | 79 | // Treating all ranges as a list ordered by the address spaces that they |
| michael@0 | 80 | // occupy, locates the range at the index specified by index. Returns |
| michael@0 | 81 | // false if index is larger than the number of ranges stored. entry_base |
| michael@0 | 82 | // and entry_size, if non-NULL, are set to the base and size of the entry's |
| michael@0 | 83 | // range. |
| michael@0 | 84 | // |
| michael@0 | 85 | // RetrieveRangeAtIndex is not optimized for speedy operation. |
| michael@0 | 86 | bool RetrieveRangeAtIndex(int index, EntryType *entry, |
| michael@0 | 87 | AddressType *entry_base, AddressType *entry_size) |
| michael@0 | 88 | const; |
| michael@0 | 89 | |
| michael@0 | 90 | // Returns the number of ranges stored in the RangeMap. |
| michael@0 | 91 | int GetCount() const; |
| michael@0 | 92 | |
| michael@0 | 93 | // Empties the range map, restoring it to the state it was when it was |
| michael@0 | 94 | // initially created. |
| michael@0 | 95 | void Clear(); |
| michael@0 | 96 | |
| michael@0 | 97 | private: |
| michael@0 | 98 | // Friend declarations. |
| michael@0 | 99 | friend class ModuleComparer; |
| michael@0 | 100 | friend class RangeMapSerializer<AddressType, EntryType>; |
| michael@0 | 101 | |
| michael@0 | 102 | class Range { |
| michael@0 | 103 | public: |
| michael@0 | 104 | Range(const AddressType &base, const EntryType &entry) |
| michael@0 | 105 | : base_(base), entry_(entry) {} |
| michael@0 | 106 | |
| michael@0 | 107 | AddressType base() const { return base_; } |
| michael@0 | 108 | EntryType entry() const { return entry_; } |
| michael@0 | 109 | |
| michael@0 | 110 | private: |
| michael@0 | 111 | // The base address of the range. The high address does not need to |
| michael@0 | 112 | // be stored, because RangeMap uses it as the key to the map. |
| michael@0 | 113 | const AddressType base_; |
| michael@0 | 114 | |
| michael@0 | 115 | // The entry corresponding to a range. |
| michael@0 | 116 | const EntryType entry_; |
| michael@0 | 117 | }; |
| michael@0 | 118 | |
| michael@0 | 119 | // Convenience types. |
| michael@0 | 120 | typedef std::map<AddressType, Range> AddressToRangeMap; |
| michael@0 | 121 | typedef typename AddressToRangeMap::const_iterator MapConstIterator; |
| michael@0 | 122 | typedef typename AddressToRangeMap::value_type MapValue; |
| michael@0 | 123 | |
| michael@0 | 124 | // Maps the high address of each range to a EntryType. |
| michael@0 | 125 | AddressToRangeMap map_; |
| michael@0 | 126 | }; |
| michael@0 | 127 | |
| michael@0 | 128 | |
| michael@0 | 129 | } // namespace google_breakpad |
| michael@0 | 130 | |
| michael@0 | 131 | |
| michael@0 | 132 | #endif // PROCESSOR_RANGE_MAP_H__ |
