base/task/thread_pool/worker_thread_stack.h

// Copyright 2016 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef BASE_TASK_THREAD_POOL_WORKER_THREAD_STACK_H_
#define BASE_TASK_THREAD_POOL_WORKER_THREAD_STACK_H_

#include <stddef.h>

#include <vector>

#include "base/base_export.h"
#include "base/macros.h"

namespace base {
namespace internal {

class WorkerThread;

// A stack of WorkerThreads which has custom logic to treat the worker on top
// of the stack as being "in-use" (so its time in that position doesn't count
// towards being inactive / reclaimable). Supports removal of arbitrary
// WorkerThreads. DCHECKs when a WorkerThread is inserted multiple times.
// WorkerThreads are not owned by the stack. Push() is amortized O(1). Pop(),
// Peek(), Size() and Empty() are O(1). Contains() and Remove() are O(n). This
// class is NOT thread-safe.
class BASE_EXPORT WorkerThreadStack {
 public:
  WorkerThreadStack();
  ~WorkerThreadStack();

  // Inserts |worker| at the top of the stack. |worker| must not already be on
  // the stack. Flags the WorkerThread previously on top of the stack, if
  // any, as unused.
  void Push(WorkerThread* worker);

  // Removes the top WorkerThread from the stack and returns it. Returns
  // nullptr if the stack is empty. Flags the WorkerThread now on top of the
  // stack, if any, as being in-use.
  WorkerThread* Pop();

  // Returns the top WorkerThread from the stack, nullptr if empty.
  WorkerThread* Peek() const;

  // Returns true if |worker| is already on the stack.
  bool Contains(const WorkerThread* worker) const;

  // Removes |worker| from the stack. Must not be invoked for the first worker
  // on the stack.
  void Remove(const WorkerThread* worker);

  // Returns the number of WorkerThreads on the stack.
  size_t Size() const { return stack_.size(); }

  // Returns true if the stack is empty.
  bool IsEmpty() const { return stack_.empty(); }

 private:
  std::vector<WorkerThread*> stack_;

  DISALLOW_COPY_AND_ASSIGN(WorkerThreadStack);
};

}  // namespace internal
}  // namespace base

#endif  // BASE_TASK_THREAD_POOL_WORKER_THREAD_STACK_H_