michael@0: // Copyright (c) 2006, Google Inc.
michael@0: // All rights reserved.
michael@0: //
michael@0: // Redistribution and use in source and binary forms, with or without
michael@0: // modification, are permitted provided that the following conditions are
michael@0: // met:
michael@0: //
michael@0: //     * Redistributions of source code must retain the above copyright
michael@0: // notice, this list of conditions and the following disclaimer.
michael@0: //     * Redistributions in binary form must reproduce the above
michael@0: // copyright notice, this list of conditions and the following disclaimer
michael@0: // in the documentation and/or other materials provided with the
michael@0: // distribution.
michael@0: //     * Neither the name of Google Inc. nor the names of its
michael@0: // contributors may be used to endorse or promote products derived from
michael@0: // this software without specific prior written permission.
michael@0: //
michael@0: // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
michael@0: // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
michael@0: // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
michael@0: // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
michael@0: // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
michael@0: // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
michael@0: // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
michael@0: // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
michael@0: // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
michael@0: // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
michael@0: // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
michael@0: 
michael@0: // range_map.h: Range maps.
michael@0: //
michael@0: // A range map associates a range of addresses with a specific object.  This
michael@0: // is useful when certain objects of variable size are located within an
michael@0: // address space.  The range map makes it simple to determine which object is
michael@0: // associated with a specific address, which may be any address within the
michael@0: // range associated with an object.
michael@0: //
michael@0: // Author: Mark Mentovai
michael@0: 
michael@0: #ifndef PROCESSOR_RANGE_MAP_H__
michael@0: #define PROCESSOR_RANGE_MAP_H__
michael@0: 
michael@0: 
michael@0: #include <map>
michael@0: 
michael@0: 
michael@0: namespace google_breakpad {
michael@0: 
michael@0: // Forward declarations (for later friend declarations of specialized template).
michael@0: template<class, class> class RangeMapSerializer;
michael@0: 
michael@0: template<typename AddressType, typename EntryType>
michael@0: class RangeMap {
michael@0:  public:
michael@0:   RangeMap() : map_() {}
michael@0: 
michael@0:   // Inserts a range into the map.  Returns false for a parameter error,
michael@0:   // or if the location of the range would conflict with a range already
michael@0:   // stored in the map.
michael@0:   bool StoreRange(const AddressType &base,
michael@0:                   const AddressType &size,
michael@0:                   const EntryType &entry);
michael@0: 
michael@0:   // Locates the range encompassing the supplied address.  If there is
michael@0:   // no such range, returns false.  entry_base and entry_size, if non-NULL,
michael@0:   // are set to the base and size of the entry's range.
michael@0:   bool RetrieveRange(const AddressType &address, EntryType *entry,
michael@0:                      AddressType *entry_base, AddressType *entry_size) const;
michael@0: 
michael@0:   // Locates the range encompassing the supplied address, if one exists.
michael@0:   // If no range encompasses the supplied address, locates the nearest range
michael@0:   // to the supplied address that is lower than the address.  Returns false
michael@0:   // if no range meets these criteria.  entry_base and entry_size, if
michael@0:   // non-NULL, are set to the base and size of the entry's range.
michael@0:   bool RetrieveNearestRange(const AddressType &address, EntryType *entry,
michael@0:                             AddressType *entry_base, AddressType *entry_size)
michael@0:                             const;
michael@0: 
michael@0:   // Treating all ranges as a list ordered by the address spaces that they
michael@0:   // occupy, locates the range at the index specified by index.  Returns
michael@0:   // false if index is larger than the number of ranges stored.  entry_base
michael@0:   // and entry_size, if non-NULL, are set to the base and size of the entry's
michael@0:   // range.
michael@0:   //
michael@0:   // RetrieveRangeAtIndex is not optimized for speedy operation.
michael@0:   bool RetrieveRangeAtIndex(int index, EntryType *entry,
michael@0:                             AddressType *entry_base, AddressType *entry_size)
michael@0:                             const;
michael@0: 
michael@0:   // Returns the number of ranges stored in the RangeMap.
michael@0:   int GetCount() const;
michael@0: 
michael@0:   // Empties the range map, restoring it to the state it was when it was
michael@0:   // initially created.
michael@0:   void Clear();
michael@0: 
michael@0:  private:
michael@0:   // Friend declarations.
michael@0:   friend class ModuleComparer;
michael@0:   friend class RangeMapSerializer<AddressType, EntryType>;
michael@0: 
michael@0:   class Range {
michael@0:    public:
michael@0:     Range(const AddressType &base, const EntryType &entry)
michael@0:         : base_(base), entry_(entry) {}
michael@0: 
michael@0:     AddressType base() const { return base_; }
michael@0:     EntryType entry() const { return entry_; }
michael@0: 
michael@0:    private:
michael@0:     // The base address of the range.  The high address does not need to
michael@0:     // be stored, because RangeMap uses it as the key to the map.
michael@0:     const AddressType base_;
michael@0: 
michael@0:     // The entry corresponding to a range.
michael@0:     const EntryType entry_;
michael@0:   };
michael@0: 
michael@0:   // Convenience types.
michael@0:   typedef std::map<AddressType, Range> AddressToRangeMap;
michael@0:   typedef typename AddressToRangeMap::const_iterator MapConstIterator;
michael@0:   typedef typename AddressToRangeMap::value_type MapValue;
michael@0: 
michael@0:   // Maps the high address of each range to a EntryType.
michael@0:   AddressToRangeMap map_;
michael@0: };
michael@0: 
michael@0: 
michael@0: }  // namespace google_breakpad
michael@0: 
michael@0: 
michael@0: #endif  // PROCESSOR_RANGE_MAP_H__