1// Copyright (c) 2006, 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// address_map-inl.h: Address map implementation.
31//
32// See address_map.h for documentation.
33//
34// Author: Mark Mentovai
35
36#ifndef PROCESSOR_ADDRESS_MAP_INL_H__
37#define PROCESSOR_ADDRESS_MAP_INL_H__
38
39#include "processor/address_map.h"
40
41#include <assert.h>
42
43#include "processor/logging.h"
44
45namespace google_breakpad {
46
47template<typename AddressType, typename EntryType>
48bool AddressMap<AddressType, EntryType>::Store(const AddressType &address,
49                                               const EntryType &entry) {
50  // Ensure that the specified address doesn't conflict with something already
51  // in the map.
52  if (map_.find(address) != map_.end()) {
53    BPLOG(INFO) << "Store failed, address " << HexString(address) <<
54                   " is already present";
55    return false;
56  }
57
58  map_.insert(MapValue(address, entry));
59  return true;
60}
61
62template<typename AddressType, typename EntryType>
63bool AddressMap<AddressType, EntryType>::Retrieve(
64    const AddressType &address,
65    EntryType *entry, AddressType *entry_address) const {
66  BPLOG_IF(ERROR, !entry) << "AddressMap::Retrieve requires |entry|";
67  assert(entry);
68
69  // upper_bound gives the first element whose key is greater than address,
70  // but we want the first element whose key is less than or equal to address.
71  // Decrement the iterator to get there, but not if the upper_bound already
72  // points to the beginning of the map - in that case, address is lower than
73  // the lowest stored key, so return false.
74  MapConstIterator iterator = map_.upper_bound(address);
75  if (iterator == map_.begin())
76    return false;
77  --iterator;
78
79  *entry = iterator->second;
80  if (entry_address)
81    *entry_address = iterator->first;
82
83  return true;
84}
85
86template<typename AddressType, typename EntryType>
87void AddressMap<AddressType, EntryType>::Clear() {
88  map_.clear();
89}
90
91}  // namespace google_breakpad
92
93#endif  // PROCESSOR_ADDRESS_MAP_INL_H__
94