DXR is a code search and navigation tool aimed at making sense of large projects. It supports full-text and regex searches as well as structural queries.

Implementation

Mercurial (ae8d2f148d7d)

VCS Links

Line Code
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

#ifndef mozilla_dom_localstorage_LSWriteOptimizer_h
#define mozilla_dom_localstorage_LSWriteOptimizer_h

#include "mozilla/CheckedInt.h"
#include "nsClassHashtable.h"

namespace mozilla {
namespace dom {

/**
 * Base class for coalescing manipulation queue.
 */
class LSWriteOptimizerBase {
  class WriteInfoComparator;

 protected:
  class WriteInfo;
  class DeleteItemInfo;
  class TruncateInfo;

  nsAutoPtr<WriteInfo> mTruncateInfo;
  nsClassHashtable<nsStringHashKey, WriteInfo> mWriteInfos;
  CheckedUint64 mLastSerialNumber;
  int64_t mTotalDelta;

  NS_DECL_OWNINGTHREAD

 public:
  LSWriteOptimizerBase() : mLastSerialNumber(0), mTotalDelta(0) {}

  LSWriteOptimizerBase(LSWriteOptimizerBase&& aWriteOptimizer)
      : mTruncateInfo(std::move(aWriteOptimizer.mTruncateInfo)) {
    AssertIsOnOwningThread();
    MOZ_ASSERT(&aWriteOptimizer != this);

    mWriteInfos.SwapElements(aWriteOptimizer.mWriteInfos);
    mTotalDelta = aWriteOptimizer.mTotalDelta;
    aWriteOptimizer.mTotalDelta = 0;
  }

  void AssertIsOnOwningThread() const {
    NS_ASSERT_OWNINGTHREAD(LSWriteOptimizerBase);
  }

  void DeleteItem(const nsAString& aKey, int64_t aDelta = 0);

  void Truncate(int64_t aDelta = 0);

  bool HasWrites() const {
    AssertIsOnOwningThread();

    return mTruncateInfo || !mWriteInfos.IsEmpty();
  }

  void Reset() {
    AssertIsOnOwningThread();

    mTruncateInfo = nullptr;
    mWriteInfos.Clear();
  }

 protected:
  uint64_t NextSerialNumber() {
    AssertIsOnOwningThread();

    mLastSerialNumber++;

    MOZ_ASSERT(mLastSerialNumber.isValid());

    return mLastSerialNumber.value();
  }

  /**
   * This method can be used by derived classes to get a sorted list of write
   * infos. Write infos are sorted by the serial number.
   */
  void GetSortedWriteInfos(nsTArray<WriteInfo*>& aWriteInfos);
};

/**
 * Base class for specific mutations.
 */
class LSWriteOptimizerBase::WriteInfo {
  uint64_t mSerialNumber;

 public:
  WriteInfo(uint64_t aSerialNumber) : mSerialNumber(aSerialNumber) {}

  virtual ~WriteInfo() = default;

  uint64_t SerialNumber() const { return mSerialNumber; }

  enum Type { InsertItem = 0, UpdateItem, DeleteItem, Truncate };

  virtual Type GetType() = 0;
};

class LSWriteOptimizerBase::DeleteItemInfo final : public WriteInfo {
  nsString mKey;

 public:
  DeleteItemInfo(uint64_t aSerialNumber, const nsAString& aKey)
      : WriteInfo(aSerialNumber), mKey(aKey) {}

  const nsAString& GetKey() const { return mKey; }

 private:
  Type GetType() override { return DeleteItem; }
};

/**
 * Truncate mutation.
 */
class LSWriteOptimizerBase::TruncateInfo final : public WriteInfo {
 public:
  explicit TruncateInfo(uint64_t aSerialNumber) : WriteInfo(aSerialNumber) {}

 private:
  Type GetType() override { return Truncate; }
};

/**
 * Coalescing manipulation queue.
 */
template <typename T, typename U = T>
class LSWriteOptimizer;

template <typename T, typename U>
class LSWriteOptimizer : public LSWriteOptimizerBase {
 protected:
  class InsertItemInfo;
  class UpdateItemInfo;

 public:
  void InsertItem(const nsAString& aKey, const T& aValue, int64_t aDelta = 0);

  void UpdateItem(const nsAString& aKey, const T& aValue, int64_t aDelta = 0);
};

/**
 * Insert mutation (the key did not previously exist).
 */
template <typename T, typename U>
class LSWriteOptimizer<T, U>::InsertItemInfo : public WriteInfo {
  nsString mKey;
  U mValue;

 public:
  InsertItemInfo(uint64_t aSerialNumber, const nsAString& aKey, const T& aValue)
      : WriteInfo(aSerialNumber), mKey(aKey), mValue(aValue) {}

  const nsAString& GetKey() const { return mKey; }

  const T& GetValue() const { return mValue; }

 private:
  WriteInfo::Type GetType() override { return InsertItem; }
};

/**
 * Update mutation (the key already existed).
 */
template <typename T, typename U>
class LSWriteOptimizer<T, U>::UpdateItemInfo final : public InsertItemInfo {
  bool mUpdateWithMove;

 public:
  UpdateItemInfo(uint64_t aSerialNumber, const nsAString& aKey, const T& aValue,
                 bool aUpdateWithMove)
      : InsertItemInfo(aSerialNumber, aKey, aValue),
        mUpdateWithMove(aUpdateWithMove) {}

  bool UpdateWithMove() const { return mUpdateWithMove; }

 private:
  WriteInfo::Type GetType() override { return WriteInfo::UpdateItem; }
};

}  // namespace dom
}  // namespace mozilla

#endif  // mozilla_dom_localstorage_LSWriteOptimizer_h