// Copyright 2020 the V8 project 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 V8_HEAP_WEAK_OBJECT_WORKLISTS_H_
#define V8_HEAP_WEAK_OBJECT_WORKLISTS_H_

#include "src/common/globals.h"
#include "src/heap/base/worklist.h"
#include "src/objects/heap-object.h"
#include "src/objects/js-weak-refs.h"

namespace v8 {
namespace internal {

struct Ephemeron {
  Tagged<HeapObject> key;
  Tagged<HeapObject> value;
};

namespace detail {
// SlotType will be HeapObjectSlot, which is defined in "globals.h" as an
// incomplete type. Its definition depends on whether pointer compression
// is used. It needs to be defined before this type is used.
template <typename TSlotType>
struct HeapObjectAndSlotPOD {
  using SlotType = TSlotType;
  Tagged<HeapObject> heap_object;
  SlotType slot;
};
}  // namespace detail

using HeapObjectAndSlot = detail::HeapObjectAndSlotPOD<HeapObjectSlot>;
using TrustedObjectAndSlot =
    detail::HeapObjectAndSlotPOD<ProtectedMaybeObjectSlot>;

struct HeapObjectAndCode {
  Tagged<HeapObject> heap_object;
  Tagged<Code> code;
};

class EphemeronHashTable;
class JSFunction;
class SharedFunctionInfo;
class TransitionArray;

// Weak objects and weak references discovered during incremental/concurrent
// marking. They are processed in ClearNonLiveReferences after marking.
// Each entry in this list specifies:
// 1) Type of the worklist entry.
// 2) Lower-case name of the worklsit.
// 3) Capitalized name of the worklist.
#define WEAK_OBJECT_WORKLISTS_GENERIC(F)                                      \
  F(Tagged<TransitionArray>, transition_arrays, TransitionArrays)             \
  /* Keep track of all EphemeronHashTables in the heap to process             \
     them in the atomic pause. */                                             \
  F(Tagged<EphemeronHashTable>, ephemeron_hash_tables, EphemeronHashTables)   \
  /* Keep track of all ephemerons for concurrent marking tasks. Only store    \
     ephemerons in these worklists if both (key, value) are unreachable at    \
     the moment.                                                              \
     MarkCompactCollector::MarkTransitiveClosureUntilFixpoint drains/fills    \
     these worklists. current_ephemerons is used as draining worklist in      \
     the current fixpoint iteration. */                                       \
  F(Ephemeron, current_ephemerons, CurrentEphemerons)                         \
  /* Stores ephemerons to visit in the next fixpoint iteration. */            \
  F(Ephemeron, next_ephemerons, NextEphemerons)                               \
  /* TODO(marja): For old space, we only need the slot, not the host object.  \
     Optimize this by adding a different storage for old space. */            \
  F(HeapObjectAndSlot, weak_references_trivial, WeakReferencesTrivial)        \
  F(HeapObjectAndSlot, weak_references_non_trivial, WeakReferencesNonTrivial) \
  F(HeapObjectAndSlot, weak_references_non_trivial_unmarked,                  \
    WeakReferencesNonTrivialUnmarked)                                         \
  F(TrustedObjectAndSlot, weak_references_trusted, WeakReferencesTrusted)     \
  F(HeapObjectAndCode, weak_objects_in_code, WeakObjectsInCode)               \
  F(Tagged<JSWeakRef>, js_weak_refs, JSWeakRefs)                              \
  F(Tagged<WeakCell>, weak_cells, WeakCells)                                  \
  F(Tagged<SharedFunctionInfo>, code_flushing_candidates,                     \
    CodeFlushingCandidates)                                                   \
  F(Tagged<JSFunction>, flushed_js_functions, FlushedJSFunctions)

#ifdef V8_ENABLE_LEAPTIERING
// Baseline code flushing for JSFunctions with leaptiering works by sweeping the
// JSDispatchTable and does not need any additional tracking.
#define WEAK_OBJECT_WORKLISTS(F) WEAK_OBJECT_WORKLISTS_GENERIC(F)
#else
#define WEAK_OBJECT_WORKLISTS(F)                      \
  WEAK_OBJECT_WORKLISTS_GENERIC(F)                    \
  F(Tagged<JSFunction>, baseline_flushing_candidates, \
    BaselineFlushingCandidates)
#endif  // V8_ENABLE_LEAPTIERING

class WeakObjects final {
 private:
  class UnusedBase {};  // Base class to allow using macro in initializer list.

 public:
  template <typename Type>
  using WeakObjectWorklist = ::heap::base::Worklist<Type, 64>;

  class Local final : public UnusedBase {
   public:
    explicit Local(WeakObjects* weak_objects);

    V8_EXPORT_PRIVATE void Publish();

#define DECLARE_WORKLIST(Type, name, _) \
  WeakObjectWorklist<Type>::Local name##_local;
    WEAK_OBJECT_WORKLISTS(DECLARE_WORKLIST)
#undef DECLARE_WORKLIST
  };

#define DECLARE_WORKLIST(Type, name, _) WeakObjectWorklist<Type> name;
  WEAK_OBJECT_WORKLISTS(DECLARE_WORKLIST)
#undef DECLARE_WORKLIST

  void Clear();
};

}  // namespace internal
}  // namespace v8

#endif  // V8_HEAP_WEAK_OBJECT_WORKLISTS_H_
