/*
 * Copyright (c) 2020, 2023, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 *
 */

#ifndef SHARE_JFR_UTILITIES_JFRLINKEDLIST_HPP
#define SHARE_JFR_UTILITIES_JFRLINKEDLIST_HPP

#include "jfr/utilities/jfrAllocation.hpp"

/*
 * This linked-list is thread-safe only for add,
 * not for remove, iterate, excise and in_list.
 * For multiple producers, single consumer.
 */

template <typename NodeType, typename AllocPolicy = JfrCHeapObj>
class JfrLinkedList : public AllocPolicy {
 public:
  typedef NodeType Node;
  typedef NodeType* NodePtr;
  JfrLinkedList();
  bool initialize();
  bool is_empty() const;
  bool is_nonempty() const;
  void add(NodePtr node);
  void add_list(NodePtr first);
  NodePtr remove();
  template <typename Callback>
  void iterate(Callback& cb);
  NodePtr head() const;
  NodePtr excise(NodePtr prev, NodePtr node);
  bool in_list(const NodeType* node) const;
  NodePtr cut();
  void clear();
 private:
  NodePtr _head;
};

#endif // SHARE_JFR_UTILITIES_JFRLINKEDLIST_HPP