Home | History | Annotate | Download | only in processor
      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 // static_address_map.h: StaticAddressMap.
     31 //
     32 // StaticAddressMap is a wrapper class of StaticMap, just as AddressMap wraps
     33 // std::map.  StaticAddressMap provides read-only Retrieve() operation, similar
     34 // as AddressMap.  However, the difference between StaticAddressMap and
     35 // AddressMap is that StaticAddressMap does not support dynamic operation
     36 // Store() due to the static nature of the underlying StaticMap.
     37 //
     38 // See address_map.h for reference.
     39 //
     40 // Author: Siyang Xie (lambxsy (at) google.com)
     41 
     42 #ifndef PROCESSOR_STATIC_ADDRESS_MAP_H__
     43 #define PROCESSOR_STATIC_ADDRESS_MAP_H__
     44 
     45 #include "processor/static_map-inl.h"
     46 
     47 namespace google_breakpad {
     48 
     49 // AddressType MUST be a basic type, e.g.: integer types etc
     50 // EntryType could be a complex type, so we retrieve its pointer instead.
     51 template<typename AddressType, typename EntryType>
     52 class StaticAddressMap {
     53  public:
     54   StaticAddressMap(): map_() { }
     55   explicit StaticAddressMap(const char *map_data): map_(map_data) { }
     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                 const EntryType *&entry, AddressType *entry_address) const;
     64 
     65  private:
     66   friend class ModuleComparer;
     67   // Convenience types.
     68   typedef StaticAddressMap* SelfPtr;
     69   typedef StaticMap<AddressType, EntryType> AddressToEntryMap;
     70   typedef typename AddressToEntryMap::const_iterator MapConstIterator;
     71 
     72   AddressToEntryMap map_;
     73 };
     74 
     75 }  // namespace google_breakpad
     76 
     77 #endif  // PROCESSOR_STATIC_ADDRESS_MAP_H__
     78 
     79