1 // Copyright 2006 Google LLC 2 // 3 // Redistribution and use in source and binary forms, with or without 4 // modification, are permitted provided that the following conditions are 5 // met: 6 // 7 // * Redistributions of source code must retain the above copyright 8 // notice, this list of conditions and the following disclaimer. 9 // * Redistributions in binary form must reproduce the above 10 // copyright notice, this list of conditions and the following disclaimer 11 // in the documentation and/or other materials provided with the 12 // distribution. 13 // * Neither the name of Google LLC nor the names of its 14 // contributors may be used to endorse or promote products derived from 15 // this software without specific prior written permission. 16 // 17 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 18 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 19 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 20 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 21 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 22 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 23 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 24 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 25 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 26 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 27 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 28 29 // address_map.h: Address maps. 30 // 31 // An address map contains a set of objects keyed by address. Objects are 32 // retrieved from the map by returning the object with the highest key less 33 // than or equal to the lookup key. 34 // 35 // Author: Mark Mentovai 36 37 #ifndef PROCESSOR_ADDRESS_MAP_H__ 38 #define PROCESSOR_ADDRESS_MAP_H__ 39 40 #include <map> 41 42 namespace google_breakpad { 43 44 // Forward declarations (for later friend declarations). 45 template<class, class> class AddressMapSerializer; 46 47 template<typename AddressType, typename EntryType> 48 class AddressMap { 49 public: AddressMap()50 AddressMap() : map_() {} 51 52 // Inserts an entry into the map. Returns false without storing the entry 53 // if an entry is already stored in the map at the same address as specified 54 // by the address argument. 55 bool Store(const AddressType& address, const EntryType& entry); 56 57 // Locates the entry stored at the highest address less than or equal to 58 // the address argument. If there is no such range, returns false. The 59 // entry is returned in entry, which is a required argument. If 60 // entry_address is not NULL, it will be set to the address that the entry 61 // was stored at. 62 bool Retrieve(const AddressType& address, 63 EntryType* entry, AddressType* entry_address) const; 64 65 // Empties the address map, restoring it to the same state as when it was 66 // initially created. 67 void Clear(); 68 69 private: 70 friend class AddressMapSerializer<AddressType, EntryType>; 71 friend class ModuleComparer; 72 73 // Convenience types. 74 typedef std::map<AddressType, EntryType> AddressToEntryMap; 75 typedef typename AddressToEntryMap::const_iterator MapConstIterator; 76 typedef typename AddressToEntryMap::value_type MapValue; 77 78 // Maps the address of each entry to an EntryType. 79 AddressToEntryMap map_; 80 }; 81 82 } // namespace google_breakpad 83 84 #endif // PROCESSOR_ADDRESS_MAP_H__ 85