cache

type Cache interface {
	// GetState returns the current state of the cache line at the given address.
	// Returns StateInvalid if the line is not present.
	GetState(addr uint64) State

	// SetState updates the state of the cache line at the given address.
	SetState(addr uint64, state State)

	// GetData retrieves the data stored in the cache line at the given address.
	// Returns nil if the line is invalid or not present.
	GetData(addr uint64) []byte

	// SetData updates the data stored in the cache line at the given address.
	// This may also implicitly set the state to Modified if the line exists.
	SetData(addr uint64, data []byte)

	// Invalidate marks the cache line at the given address as invalid.
	Invalidate(addr uint64)

	// IsPresent checks if a cache line exists for the given address (regardless of state).
	IsPresent(addr uint64) bool

	// SetEvictCallback sets the callback function to be called when a cache line is evicted.
	SetEvictCallback(callback EvictCallback)

	// HandleSnoop handles a snoop request from another cache/directory.
	// Protocol-agnostic: opcode interpretation depends on implementation.
	// Parameters:
	//   - snoopOpcode: Protocol-specific snoop opcode
	//   - addr: Target address
	// Returns:
	//   - *SnoopResponse: Response including data if needed
	//   - error: Any error encountered
	HandleSnoop(snoopOpcode int, addr uint64) (*SnoopResponse, error)

	// CanForward checks if this cache can forward data for the given address.
	// Used in protocols that support direct cache-to-cache transfer (DMT).
	// Returns true if the cache has the data in a state that allows forwarding.
	CanForward(addr uint64) bool
}

type CacheLine struct {
	Addr  uint64
	State State
	Data  []byte
}

type EvictCallback func(addr uint64, state State, data []byte)

type FullyAssociativeCache struct {
	// contains filtered or unexported fields
}

type SnoopResponse struct {
	ResponseOpcode int    // Protocol-specific response opcode
	Data           []byte // Data if forwarding
	HasData        bool   // Whether data is included
}

type State string