// Copyright 2018 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_OBJECTS_FREE_SPACE_H_
#define V8_OBJECTS_FREE_SPACE_H_

#include "src/common/globals.h"
#include "src/objects/heap-object.h"
#include "src/objects/smi.h"

// Has to be the last include (doesn't have include guards):
#include "src/objects/object-macros.h"
#include "src/objects/tagged-field.h"

namespace v8 {
namespace internal {

// FreeSpace are fixed-size free memory blocks used by the heap and GC.
// They look like heap objects (are heap object tagged and have a map) so that
// the heap remains iterable.  They have a size and a next pointer.
// The next pointer is the raw address of the next FreeSpace object (or NULL)
// in the free list.
//
// When external code space is enabled next pointer is stored as Smi values
// representing a diff from current FreeSpace object address in kObjectAlignment
// chunks. Terminating FreeSpace value is represented as Smi zero.
// Such a representation has the following properties:
// a) it can hold both positive an negative diffs for full pointer compression
//    cage size (HeapObject address has only valuable 30 bits while Smis have
//    31 bits),
// b) it's independent of the pointer compression base and pointer compression
//    scheme.
V8_OBJECT class FreeSpace : public HeapObject {
  V8_IT_NO_AUTO_DISPATCH;

 public:
  static constexpr uint32_t kMaxSizeInBytes =
      uint32_t{Smi::kMaxValue} * kTaggedSize;

  // [size]: size of the free space including the header.
  inline int size(RelaxedLoadTag) const;

  static inline void SetSize(const WritableFreeSpace& writable_free_space,
                             int size, RelaxedStoreTag);
  inline int Size();

  // Accessors for the next field.
  inline Tagged<FreeSpace> next() const;
  inline void SetNext(const Heap* heap,
                      const WritableFreeSpace& writable_free_space,
                      Tagged<FreeSpace> next);

  // Dispatched behavior.
  DECL_PRINTER(FreeSpace)
  DECL_VERIFIER(FreeSpace)

  class BodyDescriptor;

 private:
  friend class Heap;

  inline bool IsValid(const Heap* isolate) const;

  TaggedMember<Smi> size_in_tagged_;
#ifdef V8_EXTERNAL_CODE_SPACE
  TaggedMember<Smi> next_;
#else
  TaggedMember<FreeSpace> next_;
#endif  // V8_EXTERNAL_CODE_SPACE
} V8_OBJECT_END;

// Filler objects (one- and two-pointer fillers) used to pad heap gaps so that
// the heap remains iterable.
V8_OBJECT class Filler : public HeapObject {
} V8_OBJECT_END;

}  // namespace internal
}  // namespace v8

#include "src/objects/object-macros-undef.h"

#endif  // V8_OBJECTS_FREE_SPACE_H_