range_map-inl.h revision 1ef60aaa6cf36afa877967bf05eedd5ea512d593
17daf246e4baf0837e25429668cc23e92b6afe3b3mmentovai// Copyright (c) 2006, Google Inc. 27daf246e4baf0837e25429668cc23e92b6afe3b3mmentovai// All rights reserved. 38c2a4def4ecfbf6293b27eff4359a274e9774b4emmentovai// 47daf246e4baf0837e25429668cc23e92b6afe3b3mmentovai// Redistribution and use in source and binary forms, with or without 57daf246e4baf0837e25429668cc23e92b6afe3b3mmentovai// modification, are permitted provided that the following conditions are 67daf246e4baf0837e25429668cc23e92b6afe3b3mmentovai// met: 78c2a4def4ecfbf6293b27eff4359a274e9774b4emmentovai// 87daf246e4baf0837e25429668cc23e92b6afe3b3mmentovai// * Redistributions of source code must retain the above copyright 97daf246e4baf0837e25429668cc23e92b6afe3b3mmentovai// notice, this list of conditions and the following disclaimer. 107daf246e4baf0837e25429668cc23e92b6afe3b3mmentovai// * Redistributions in binary form must reproduce the above 117daf246e4baf0837e25429668cc23e92b6afe3b3mmentovai// copyright notice, this list of conditions and the following disclaimer 127daf246e4baf0837e25429668cc23e92b6afe3b3mmentovai// in the documentation and/or other materials provided with the 137daf246e4baf0837e25429668cc23e92b6afe3b3mmentovai// distribution. 147daf246e4baf0837e25429668cc23e92b6afe3b3mmentovai// * Neither the name of Google Inc. nor the names of its 157daf246e4baf0837e25429668cc23e92b6afe3b3mmentovai// contributors may be used to endorse or promote products derived from 167daf246e4baf0837e25429668cc23e92b6afe3b3mmentovai// this software without specific prior written permission. 178c2a4def4ecfbf6293b27eff4359a274e9774b4emmentovai// 187daf246e4baf0837e25429668cc23e92b6afe3b3mmentovai// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 197daf246e4baf0837e25429668cc23e92b6afe3b3mmentovai// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 207daf246e4baf0837e25429668cc23e92b6afe3b3mmentovai// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 217daf246e4baf0837e25429668cc23e92b6afe3b3mmentovai// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 227daf246e4baf0837e25429668cc23e92b6afe3b3mmentovai// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 237daf246e4baf0837e25429668cc23e92b6afe3b3mmentovai// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 247daf246e4baf0837e25429668cc23e92b6afe3b3mmentovai// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 257daf246e4baf0837e25429668cc23e92b6afe3b3mmentovai// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 267daf246e4baf0837e25429668cc23e92b6afe3b3mmentovai// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 277daf246e4baf0837e25429668cc23e92b6afe3b3mmentovai// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 287daf246e4baf0837e25429668cc23e92b6afe3b3mmentovai// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 298c2a4def4ecfbf6293b27eff4359a274e9774b4emmentovai 308c2a4def4ecfbf6293b27eff4359a274e9774b4emmentovai// range_map-inl.h: Range map implementation. 318c2a4def4ecfbf6293b27eff4359a274e9774b4emmentovai// 328c2a4def4ecfbf6293b27eff4359a274e9774b4emmentovai// See range_map.h for documentation. 338c2a4def4ecfbf6293b27eff4359a274e9774b4emmentovai// 348c2a4def4ecfbf6293b27eff4359a274e9774b4emmentovai// Author: Mark Mentovai 358c2a4def4ecfbf6293b27eff4359a274e9774b4emmentovai 368c2a4def4ecfbf6293b27eff4359a274e9774b4emmentovai#ifndef PROCESSOR_RANGE_MAP_INL_H__ 378c2a4def4ecfbf6293b27eff4359a274e9774b4emmentovai#define PROCESSOR_RANGE_MAP_INL_H__ 388c2a4def4ecfbf6293b27eff4359a274e9774b4emmentovai 398c2a4def4ecfbf6293b27eff4359a274e9774b4emmentovai 401ef60aaa6cf36afa877967bf05eedd5ea512d593mmentovai#include <cassert> 411ef60aaa6cf36afa877967bf05eedd5ea512d593mmentovai 428c2a4def4ecfbf6293b27eff4359a274e9774b4emmentovai#include "processor/range_map.h" 4365571f17edb82d122b5f6dc741bd7d4b9e315e1bmmentovai#include "processor/logging.h" 448c2a4def4ecfbf6293b27eff4359a274e9774b4emmentovai 458c2a4def4ecfbf6293b27eff4359a274e9774b4emmentovai 46e5dc60822e5938fea2ae892ccddb906641ba174emmentovainamespace google_breakpad { 478c2a4def4ecfbf6293b27eff4359a274e9774b4emmentovai 488c2a4def4ecfbf6293b27eff4359a274e9774b4emmentovai 498c2a4def4ecfbf6293b27eff4359a274e9774b4emmentovaitemplate<typename AddressType, typename EntryType> 508c2a4def4ecfbf6293b27eff4359a274e9774b4emmentovaibool RangeMap<AddressType, EntryType>::StoreRange(const AddressType &base, 518c2a4def4ecfbf6293b27eff4359a274e9774b4emmentovai const AddressType &size, 528c2a4def4ecfbf6293b27eff4359a274e9774b4emmentovai const EntryType &entry) { 538c2a4def4ecfbf6293b27eff4359a274e9774b4emmentovai AddressType high = base + size - 1; 548c2a4def4ecfbf6293b27eff4359a274e9774b4emmentovai 558c2a4def4ecfbf6293b27eff4359a274e9774b4emmentovai // Check for undersize or overflow. 5665571f17edb82d122b5f6dc741bd7d4b9e315e1bmmentovai if (size <= 0 || high < base) { 5765571f17edb82d122b5f6dc741bd7d4b9e315e1bmmentovai // The processor will hit this case too frequently with common symbol 5865571f17edb82d122b5f6dc741bd7d4b9e315e1bmmentovai // files in the size == 0 case, which is more suited to a DEBUG channel. 5965571f17edb82d122b5f6dc741bd7d4b9e315e1bmmentovai // Filter those out since there's no DEBUG channel at the moment. 6065571f17edb82d122b5f6dc741bd7d4b9e315e1bmmentovai BPLOG_IF(INFO, size != 0) << "StoreRange failed, " << HexString(base) << 6165571f17edb82d122b5f6dc741bd7d4b9e315e1bmmentovai "+" << HexString(size) << ", " << 6265571f17edb82d122b5f6dc741bd7d4b9e315e1bmmentovai HexString(high); 638c2a4def4ecfbf6293b27eff4359a274e9774b4emmentovai return false; 6465571f17edb82d122b5f6dc741bd7d4b9e315e1bmmentovai } 658c2a4def4ecfbf6293b27eff4359a274e9774b4emmentovai 668c2a4def4ecfbf6293b27eff4359a274e9774b4emmentovai // Ensure that this range does not overlap with another one already in the 678c2a4def4ecfbf6293b27eff4359a274e9774b4emmentovai // map. 688c2a4def4ecfbf6293b27eff4359a274e9774b4emmentovai MapConstIterator iterator_base = map_.lower_bound(base); 698c2a4def4ecfbf6293b27eff4359a274e9774b4emmentovai MapConstIterator iterator_high = map_.lower_bound(high); 708c2a4def4ecfbf6293b27eff4359a274e9774b4emmentovai 718c2a4def4ecfbf6293b27eff4359a274e9774b4emmentovai if (iterator_base != iterator_high) { 728c2a4def4ecfbf6293b27eff4359a274e9774b4emmentovai // Some other range begins in the space used by this range. It may be 738c2a4def4ecfbf6293b27eff4359a274e9774b4emmentovai // contained within the space used by this range, or it may extend lower. 748c2a4def4ecfbf6293b27eff4359a274e9774b4emmentovai // Regardless, it is an error. 7565571f17edb82d122b5f6dc741bd7d4b9e315e1bmmentovai AddressType other_base = iterator_base->second.base(); 7665571f17edb82d122b5f6dc741bd7d4b9e315e1bmmentovai AddressType other_size = iterator_base->first - other_base + 1; 7765571f17edb82d122b5f6dc741bd7d4b9e315e1bmmentovai BPLOG(INFO) << "StoreRange failed, an existing range is contained by or " 7865571f17edb82d122b5f6dc741bd7d4b9e315e1bmmentovai "extends lower than the new range: new " << 7965571f17edb82d122b5f6dc741bd7d4b9e315e1bmmentovai HexString(base) << "+" << HexString(size) << ", existing " << 8065571f17edb82d122b5f6dc741bd7d4b9e315e1bmmentovai HexString(other_base) << "+" << HexString(other_size); 818c2a4def4ecfbf6293b27eff4359a274e9774b4emmentovai return false; 828c2a4def4ecfbf6293b27eff4359a274e9774b4emmentovai } 838c2a4def4ecfbf6293b27eff4359a274e9774b4emmentovai 848c2a4def4ecfbf6293b27eff4359a274e9774b4emmentovai if (iterator_high != map_.end()) { 858c2a4def4ecfbf6293b27eff4359a274e9774b4emmentovai if (iterator_high->second.base() <= high) { 868c2a4def4ecfbf6293b27eff4359a274e9774b4emmentovai // The range above this one overlaps with this one. It may fully 8765571f17edb82d122b5f6dc741bd7d4b9e315e1bmmentovai // contain this range, or it may begin within this range and extend 888c2a4def4ecfbf6293b27eff4359a274e9774b4emmentovai // higher. Regardless, it's an error. 8965571f17edb82d122b5f6dc741bd7d4b9e315e1bmmentovai AddressType other_base = iterator_high->second.base(); 9065571f17edb82d122b5f6dc741bd7d4b9e315e1bmmentovai AddressType other_size = iterator_high->first - other_base + 1; 9165571f17edb82d122b5f6dc741bd7d4b9e315e1bmmentovai BPLOG(INFO) << "StoreRange failed, an existing range contains or " 9265571f17edb82d122b5f6dc741bd7d4b9e315e1bmmentovai "extends higher than the new range: new " << 9365571f17edb82d122b5f6dc741bd7d4b9e315e1bmmentovai HexString(base) << "+" << HexString(size) << 9465571f17edb82d122b5f6dc741bd7d4b9e315e1bmmentovai ", existing " << 9565571f17edb82d122b5f6dc741bd7d4b9e315e1bmmentovai HexString(other_base) << "+" << HexString(other_size); 968c2a4def4ecfbf6293b27eff4359a274e9774b4emmentovai return false; 978c2a4def4ecfbf6293b27eff4359a274e9774b4emmentovai } 988c2a4def4ecfbf6293b27eff4359a274e9774b4emmentovai } 998c2a4def4ecfbf6293b27eff4359a274e9774b4emmentovai 1008c2a4def4ecfbf6293b27eff4359a274e9774b4emmentovai // Store the range in the map by its high address, so that lower_bound can 1018c2a4def4ecfbf6293b27eff4359a274e9774b4emmentovai // be used to quickly locate a range by address. 1028c2a4def4ecfbf6293b27eff4359a274e9774b4emmentovai map_.insert(MapValue(high, Range(base, entry))); 1038c2a4def4ecfbf6293b27eff4359a274e9774b4emmentovai return true; 1048c2a4def4ecfbf6293b27eff4359a274e9774b4emmentovai} 1058c2a4def4ecfbf6293b27eff4359a274e9774b4emmentovai 1068c2a4def4ecfbf6293b27eff4359a274e9774b4emmentovai 1078c2a4def4ecfbf6293b27eff4359a274e9774b4emmentovaitemplate<typename AddressType, typename EntryType> 1088c2a4def4ecfbf6293b27eff4359a274e9774b4emmentovaibool RangeMap<AddressType, EntryType>::RetrieveRange( 1092fc823f5794737391e231c1dce6c2b0793213e53mmentovai const AddressType &address, EntryType *entry, 1102fc823f5794737391e231c1dce6c2b0793213e53mmentovai AddressType *entry_base, AddressType *entry_size) const { 11165571f17edb82d122b5f6dc741bd7d4b9e315e1bmmentovai BPLOG_IF(ERROR, !entry) << "RangeMap::RetrieveRange requires |entry|"; 11265571f17edb82d122b5f6dc741bd7d4b9e315e1bmmentovai assert(entry); 1138c2a4def4ecfbf6293b27eff4359a274e9774b4emmentovai 1148c2a4def4ecfbf6293b27eff4359a274e9774b4emmentovai MapConstIterator iterator = map_.lower_bound(address); 1158c2a4def4ecfbf6293b27eff4359a274e9774b4emmentovai if (iterator == map_.end()) 1168c2a4def4ecfbf6293b27eff4359a274e9774b4emmentovai return false; 1178c2a4def4ecfbf6293b27eff4359a274e9774b4emmentovai 1188c2a4def4ecfbf6293b27eff4359a274e9774b4emmentovai // The map is keyed by the high address of each range, so |address| is 1198c2a4def4ecfbf6293b27eff4359a274e9774b4emmentovai // guaranteed to be lower than the range's high address. If |range| is 1208c2a4def4ecfbf6293b27eff4359a274e9774b4emmentovai // not directly preceded by another range, it's possible for address to 1218c2a4def4ecfbf6293b27eff4359a274e9774b4emmentovai // be below the range's low address, though. When that happens, address 1228c2a4def4ecfbf6293b27eff4359a274e9774b4emmentovai // references something not within any range, so return false. 1238c2a4def4ecfbf6293b27eff4359a274e9774b4emmentovai if (address < iterator->second.base()) 1248c2a4def4ecfbf6293b27eff4359a274e9774b4emmentovai return false; 1258c2a4def4ecfbf6293b27eff4359a274e9774b4emmentovai 1268c2a4def4ecfbf6293b27eff4359a274e9774b4emmentovai *entry = iterator->second.entry(); 1272fc823f5794737391e231c1dce6c2b0793213e53mmentovai if (entry_base) 1282fc823f5794737391e231c1dce6c2b0793213e53mmentovai *entry_base = iterator->second.base(); 1292fc823f5794737391e231c1dce6c2b0793213e53mmentovai if (entry_size) 1302fc823f5794737391e231c1dce6c2b0793213e53mmentovai *entry_size = iterator->first - iterator->second.base() + 1; 1312fc823f5794737391e231c1dce6c2b0793213e53mmentovai 1322fc823f5794737391e231c1dce6c2b0793213e53mmentovai return true; 1332fc823f5794737391e231c1dce6c2b0793213e53mmentovai} 1342fc823f5794737391e231c1dce6c2b0793213e53mmentovai 1352fc823f5794737391e231c1dce6c2b0793213e53mmentovai 1362fc823f5794737391e231c1dce6c2b0793213e53mmentovaitemplate<typename AddressType, typename EntryType> 1372fc823f5794737391e231c1dce6c2b0793213e53mmentovaibool RangeMap<AddressType, EntryType>::RetrieveNearestRange( 1382fc823f5794737391e231c1dce6c2b0793213e53mmentovai const AddressType &address, EntryType *entry, 1392fc823f5794737391e231c1dce6c2b0793213e53mmentovai AddressType *entry_base, AddressType *entry_size) const { 14065571f17edb82d122b5f6dc741bd7d4b9e315e1bmmentovai BPLOG_IF(ERROR, !entry) << "RangeMap::RetrieveNearestRange requires |entry|"; 14165571f17edb82d122b5f6dc741bd7d4b9e315e1bmmentovai assert(entry); 1422fc823f5794737391e231c1dce6c2b0793213e53mmentovai 1432fc823f5794737391e231c1dce6c2b0793213e53mmentovai // If address is within a range, RetrieveRange can handle it. 1442fc823f5794737391e231c1dce6c2b0793213e53mmentovai if (RetrieveRange(address, entry, entry_base, entry_size)) 1452fc823f5794737391e231c1dce6c2b0793213e53mmentovai return true; 1462fc823f5794737391e231c1dce6c2b0793213e53mmentovai 1472fc823f5794737391e231c1dce6c2b0793213e53mmentovai // upper_bound gives the first element whose key is greater than address, 1482fc823f5794737391e231c1dce6c2b0793213e53mmentovai // but we want the first element whose key is less than or equal to address. 1492fc823f5794737391e231c1dce6c2b0793213e53mmentovai // Decrement the iterator to get there, but not if the upper_bound already 1502fc823f5794737391e231c1dce6c2b0793213e53mmentovai // points to the beginning of the map - in that case, address is lower than 1512fc823f5794737391e231c1dce6c2b0793213e53mmentovai // the lowest stored key, so return false. 1522fc823f5794737391e231c1dce6c2b0793213e53mmentovai MapConstIterator iterator = map_.upper_bound(address); 1532fc823f5794737391e231c1dce6c2b0793213e53mmentovai if (iterator == map_.begin()) 1542fc823f5794737391e231c1dce6c2b0793213e53mmentovai return false; 1552fc823f5794737391e231c1dce6c2b0793213e53mmentovai --iterator; 1562fc823f5794737391e231c1dce6c2b0793213e53mmentovai 1572fc823f5794737391e231c1dce6c2b0793213e53mmentovai *entry = iterator->second.entry(); 1582fc823f5794737391e231c1dce6c2b0793213e53mmentovai if (entry_base) 1592fc823f5794737391e231c1dce6c2b0793213e53mmentovai *entry_base = iterator->first; 1602fc823f5794737391e231c1dce6c2b0793213e53mmentovai if (entry_size) 1612fc823f5794737391e231c1dce6c2b0793213e53mmentovai *entry_size = iterator->first - iterator->second.base() + 1; 1622fc823f5794737391e231c1dce6c2b0793213e53mmentovai 1638c2a4def4ecfbf6293b27eff4359a274e9774b4emmentovai return true; 1648c2a4def4ecfbf6293b27eff4359a274e9774b4emmentovai} 1658c2a4def4ecfbf6293b27eff4359a274e9774b4emmentovai 1668c2a4def4ecfbf6293b27eff4359a274e9774b4emmentovai 1678c2a4def4ecfbf6293b27eff4359a274e9774b4emmentovaitemplate<typename AddressType, typename EntryType> 168db3342a10ec30902aa9018b80e1d9a40bd01c487mmentovaibool RangeMap<AddressType, EntryType>::RetrieveRangeAtIndex( 169db3342a10ec30902aa9018b80e1d9a40bd01c487mmentovai int index, EntryType *entry, 170db3342a10ec30902aa9018b80e1d9a40bd01c487mmentovai AddressType *entry_base, AddressType *entry_size) const { 17165571f17edb82d122b5f6dc741bd7d4b9e315e1bmmentovai BPLOG_IF(ERROR, !entry) << "RangeMap::RetrieveRangeAtIndex requires |entry|"; 17265571f17edb82d122b5f6dc741bd7d4b9e315e1bmmentovai assert(entry); 17365571f17edb82d122b5f6dc741bd7d4b9e315e1bmmentovai 17465571f17edb82d122b5f6dc741bd7d4b9e315e1bmmentovai if (index >= GetCount()) { 17565571f17edb82d122b5f6dc741bd7d4b9e315e1bmmentovai BPLOG(ERROR) << "Index out of range: " << index << "/" << GetCount(); 176db3342a10ec30902aa9018b80e1d9a40bd01c487mmentovai return false; 17765571f17edb82d122b5f6dc741bd7d4b9e315e1bmmentovai } 178db3342a10ec30902aa9018b80e1d9a40bd01c487mmentovai 179db3342a10ec30902aa9018b80e1d9a40bd01c487mmentovai // Walk through the map. Although it's ordered, it's not a vector, so it 180db3342a10ec30902aa9018b80e1d9a40bd01c487mmentovai // can't be addressed directly by index. 181db3342a10ec30902aa9018b80e1d9a40bd01c487mmentovai MapConstIterator iterator = map_.begin(); 182db3342a10ec30902aa9018b80e1d9a40bd01c487mmentovai for (int this_index = 0; this_index < index; ++this_index) 183db3342a10ec30902aa9018b80e1d9a40bd01c487mmentovai ++iterator; 184db3342a10ec30902aa9018b80e1d9a40bd01c487mmentovai 185db3342a10ec30902aa9018b80e1d9a40bd01c487mmentovai *entry = iterator->second.entry(); 186db3342a10ec30902aa9018b80e1d9a40bd01c487mmentovai if (entry_base) 187db3342a10ec30902aa9018b80e1d9a40bd01c487mmentovai *entry_base = iterator->first; 188db3342a10ec30902aa9018b80e1d9a40bd01c487mmentovai if (entry_size) 189db3342a10ec30902aa9018b80e1d9a40bd01c487mmentovai *entry_size = iterator->first - iterator->second.base() + 1; 190db3342a10ec30902aa9018b80e1d9a40bd01c487mmentovai 191db3342a10ec30902aa9018b80e1d9a40bd01c487mmentovai return true; 192db3342a10ec30902aa9018b80e1d9a40bd01c487mmentovai} 193db3342a10ec30902aa9018b80e1d9a40bd01c487mmentovai 194db3342a10ec30902aa9018b80e1d9a40bd01c487mmentovai 195db3342a10ec30902aa9018b80e1d9a40bd01c487mmentovaitemplate<typename AddressType, typename EntryType> 196db3342a10ec30902aa9018b80e1d9a40bd01c487mmentovaiint RangeMap<AddressType, EntryType>::GetCount() const { 197db3342a10ec30902aa9018b80e1d9a40bd01c487mmentovai return map_.size(); 198db3342a10ec30902aa9018b80e1d9a40bd01c487mmentovai} 199db3342a10ec30902aa9018b80e1d9a40bd01c487mmentovai 200db3342a10ec30902aa9018b80e1d9a40bd01c487mmentovai 201db3342a10ec30902aa9018b80e1d9a40bd01c487mmentovaitemplate<typename AddressType, typename EntryType> 2028c2a4def4ecfbf6293b27eff4359a274e9774b4emmentovaivoid RangeMap<AddressType, EntryType>::Clear() { 2038c2a4def4ecfbf6293b27eff4359a274e9774b4emmentovai map_.clear(); 2048c2a4def4ecfbf6293b27eff4359a274e9774b4emmentovai} 2058c2a4def4ecfbf6293b27eff4359a274e9774b4emmentovai 2068c2a4def4ecfbf6293b27eff4359a274e9774b4emmentovai 207e5dc60822e5938fea2ae892ccddb906641ba174emmentovai} // namespace google_breakpad 2088c2a4def4ecfbf6293b27eff4359a274e9774b4emmentovai 2098c2a4def4ecfbf6293b27eff4359a274e9774b4emmentovai 2108c2a4def4ecfbf6293b27eff4359a274e9774b4emmentovai#endif // PROCESSOR_RANGE_MAP_INL_H__ 211