#ifndef V8_OBJECTS_DEBUG_OBJECTS_H_

#define V8_OBJECTS_DEBUG_OBJECTS_H_

#include <memory>

#include "src/base/bit-field.h"

#include "src/objects/fixed-array.h"

#include "src/objects/objects.h"

#include "src/objects/struct.h"

#include "torque-generated/bit-fields.h"

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

namespace v8 {

namespace internal {

class BreakPoint;

class BytecodeArray;

class StructBodyDescriptor;

#include "torque-generated/src/objects/debug-objects-tq.inc"

class DebugInfo : public TorqueGeneratedDebugInfo<DebugInfo, Struct> {

public:

NEVER_READ_ONLY_SPACE

DEFINE_TORQUE_GENERATED_DEBUG_INFO_FLAGS()

// DebugInfo can be detached from the SharedFunctionInfo iff it is empty.

bool IsEmpty() const;

// --- Debug execution ---

// -----------------------

enum ExecutionMode : uint8_t {

kBreakpoints = 0,

kSideEffects = kDebugExecutionMode

};

// Returns current debug execution mode. Debug execution mode defines by

// applied to bytecode patching. False for breakpoints, true for side effect

// checks.

ExecutionMode DebugExecutionMode() const;

void SetDebugExecutionMode(ExecutionMode value);

// Specifies whether the associated function has an instrumented bytecode

// array. If so, OriginalBytecodeArray returns the non-instrumented bytecode,

// and DebugBytecodeArray returns the instrumented bytecode.

inline bool HasInstrumentedBytecodeArray();

inline Tagged<BytecodeArray> OriginalBytecodeArray(Isolate* isolate);

inline Tagged<BytecodeArray> DebugBytecodeArray(Isolate* isolate);

DECL_TRUSTED_POINTER_ACCESSORS(original_bytecode_array, BytecodeArray)

DECL_TRUSTED_POINTER_ACCESSORS(debug_bytecode_array, BytecodeArray)

// --- Break points ---

// --------------------

bool HasBreakInfo() const;

// Clears all fields related to break points.

V8_EXPORT_PRIVATE void ClearBreakInfo(Isolate* isolate);

// Accessors to flag whether to break before entering the function.

// This is used to break for functions with no source, e.g. builtins.

void SetBreakAtEntry();

void ClearBreakAtEntry();

bool BreakAtEntry() const;

// Check if there is a break point at a source position.

bool HasBreakPoint(Isolate* isolate, int source_position);

// Attempt to clear a break point. Return true if successful.

static bool ClearBreakPoint(Isolate* isolate,

DirectHandle<DebugInfo> debug_info,

DirectHandle<BreakPoint> break_point);

// Set a break point.

static void SetBreakPoint(Isolate* isolate,

DirectHandle<DebugInfo> debug_info,

int source_position,

DirectHandle<BreakPoint> break_point);

// Get the break point objects for a source position.

DirectHandle<Object> GetBreakPoints(Isolate* isolate, int source_position);

// Find the break point info holding this break point object.

static DirectHandle<Object> FindBreakPointInfo(

Isolate* isolate, DirectHandle<DebugInfo> debug_info,

DirectHandle<BreakPoint> break_point);

// Get the number of break points for this function.

int GetBreakPointCount(Isolate* isolate);

// Returns whether we should be able to break before entering the function.

// This is true for functions with no source, e.g. builtins.

bool CanBreakAtEntry() const;

// --- Debugger hint flags ---

// ---------------------------

// Indicates that the function should be skipped during stepping.

DECL_BOOLEAN_ACCESSORS(debug_is_blackboxed)

// Indicates that |debug_is_blackboxed| has been computed and set.

DECL_BOOLEAN_ACCESSORS(computed_debug_is_blackboxed)

// Indicates the side effect state.

DECL_INT_ACCESSORS(side_effect_state)

enum SideEffectState {

};

SideEffectState GetSideEffectState(Isolate* isolate);

// Id assigned to the function for debugging.

// This could also be implemented as a weak hash table.

DECL_INT_ACCESSORS(debugging_id)

// Bit positions in |debugger_hints|.

DEFINE_TORQUE_GENERATED_DEBUGGER_HINTS()

static const int kNoDebuggingId = 0;

// --- Block Coverage ---

// ----------------------

bool HasCoverageInfo() const;

// Clears all fields related to block coverage.

void ClearCoverageInfo(Isolate* isolate);

static const int kEstimatedNofBreakPointsInFunction = 4;

class BodyDescriptor;

private:

// Get the break point info object for a source position.

Tagged<Object> GetBreakPointInfo(Isolate* isolate, int source_position);

TQ_OBJECT_CONSTRUCTORS(DebugInfo)

};

class BreakPointInfo

: public TorqueGeneratedBreakPointInfo<BreakPointInfo, Struct> {

public:

// Removes a break point.

static void ClearBreakPoint(Isolate* isolate,

DirectHandle<BreakPointInfo> info,

DirectHandle<BreakPoint> break_point);

// Set a break point.

static void SetBreakPoint(Isolate* isolate, DirectHandle<BreakPointInfo> info,

DirectHandle<BreakPoint> break_point);

// Check if break point info has this break point.

static bool HasBreakPoint(Isolate* isolate, DirectHandle<BreakPointInfo> info,

DirectHandle<BreakPoint> break_point);

// Check if break point info has break point with this id.

static MaybeDirectHandle<BreakPoint> GetBreakPointById(

Isolate* isolate, DirectHandle<BreakPointInfo> info, int breakpoint_id);

// Get the number of break points for this code offset.

int GetBreakPointCount(Isolate* isolate);

int GetStatementPosition(Handle<DebugInfo> debug_info);

using BodyDescriptor = StructBodyDescriptor;

TQ_OBJECT_CONSTRUCTORS(BreakPointInfo)

};

class CoverageInfo

: public TorqueGeneratedCoverageInfo<CoverageInfo, HeapObject> {

public:

void InitializeSlot(int slot_index, int start_pos, int end_pos);

void ResetBlockCount(int slot_index);

// Computes the size for a CoverageInfo instance of a given length.

static int SizeFor(int slot_count) {

return OBJECT_POINTER_ALIGN(kHeaderSize + slot_count * Slot::kSize);

}

// Print debug info.

void CoverageInfoPrint(std::ostream& os,

std::unique_ptr<char[]> function_name = nullptr);

class BodyDescriptor; // GC visitor.

// Description of layout within each slot.

using Slot = TorqueGeneratedCoverageInfoSlotOffsets;

TQ_OBJECT_CONSTRUCTORS(CoverageInfo)

};

class BreakPoint : public TorqueGeneratedBreakPoint<BreakPoint, Struct> {

public:

using BodyDescriptor = StructBodyDescriptor;

TQ_OBJECT_CONSTRUCTORS(BreakPoint)

};

class StackFrameInfo

: public TorqueGeneratedStackFrameInfo<StackFrameInfo, Struct> {

public:

NEVER_READ_ONLY_SPACE

static int GetSourcePosition(DirectHandle<StackFrameInfo> info);

// The script for the stack frame.

inline Tagged<Script> script() const;

// The bytecode offset or source position for the stack frame.

DECL_INT_ACCESSORS(bytecode_offset_or_source_position)

// Indicates that the frame corresponds to a 'new' invocation.

DECL_BOOLEAN_ACCESSORS(is_constructor)

// Dispatched behavior.

DECL_VERIFIER(StackFrameInfo)

// Bit positions in |flags|.

DEFINE_TORQUE_GENERATED_STACK_FRAME_INFO_FLAGS()

using BodyDescriptor = StructBodyDescriptor;

private:

TQ_OBJECT_CONSTRUCTORS(StackFrameInfo)

};

class StackTraceInfo

: public TorqueGeneratedStackTraceInfo<StackTraceInfo, Struct> {

public:

NEVER_READ_ONLY_SPACE

// Access to the stack frames.

int length() const;

Tagged<StackFrameInfo> get(int index) const;

// Dispatched behavior.

DECL_VERIFIER(StackTraceInfo)

using BodyDescriptor = StructBodyDescriptor;

private:

TQ_OBJECT_CONSTRUCTORS(StackTraceInfo)

};

class ErrorStackData

} // namespace internal

} // namespace v8

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

#endif // V8_OBJECTS_DEBUG_OBJECTS_H_