ctmap

type CTMaps interface {
	// ActiveMaps returns a slice of global CT maps that are used, depending
	// on whether IPv4 and/or IPv6 is configured.
	ActiveMaps() []*Map
}

type CtEntry struct {
	Union0   [2]uint64 `align:"$union0"`
	Packets  uint64    `align:"packets"`
	Bytes    uint64    `align:"bytes"`
	Lifetime uint32    `align:"lifetime"`
	Flags    uint16    `align:"rx_closing"`
	// RevNAT is in network byte order
	RevNAT uint16 `align:"rev_nat_index"`
	// NatPort is in network byte order
	NatPort          uint16 `align:"nat_port"`
	TxFlagsSeen      uint8  `align:"tx_flags_seen"`
	RxFlagsSeen      uint8  `align:"rx_flags_seen"`
	SourceSecurityID uint32 `align:"src_sec_id"`
	LastTxReport     uint32 `align:"last_tx_report"`
	LastRxReport     uint32 `align:"last_rx_report"`
}

type CtKey interface {
	bpf.MapKey

	// ToNetwork converts fields to network byte order.
	ToNetwork() CtKey

	// ToHost converts fields to host byte order.
	ToHost() CtKey

	// Dump contents of key to sb. Returns true if successful.
	Dump(sb *strings.Builder, reverse bool) bool

	// GetFlags flags containing the direction of the CtKey.
	GetFlags() uint8

	GetTupleKey() tuple.TupleKey
}

type CtKey4Global struct {
	tuple.TupleKey4Global
}

type CtKey6Global struct {
	tuple.TupleKey6Global
}

type CtMap interface {
	Open() error
	Close() error
	Path() (string, error)
	DumpEntriesWithTimeDiff(clockSource *models.ClockSource) (string, error)
	DumpWithCallback(bpf.DumpCallback) error
	Count(context.Context) (int, error)
	Update(key bpf.MapKey, value bpf.MapValue) error
}

type CtMapRecord struct {
	Key   CtKey
	Value CtEntry
}

type EmitCTEntryCBFunc func(srcIP, dstIP netip.Addr, srcPort, dstPort uint16, nextHdr, flags uint8, entry *CtEntry)

type GCEvent struct {
	Key    CtKey
	Entry  *CtEntry
	NatMap *nat.Map
}

type GCFilter struct {
	// RemoveExpired enables removal of all entries that have expired
	RemoveExpired bool

	// Time is the reference timestamp to remove expired entries. If
	// RemoveExpired is true and lifetime is lesser than Time, the entry is
	// removed
	Time uint32

	// MatchIPs is the list of IPs to remove from the conntrack table
	MatchIPs map[netip.Addr]struct{}

	// EmitCTEntry is called, when non-nil, if filtering by ValidIPs and MatchIPs
	// passes. It has no impact on CT GC, but can be used to iterate over valid
	// CT entries.
	EmitCTEntryCB EmitCTEntryCBFunc
}

type GCRunner interface {
	// Run runs the oneshot connection tracking garbage collection.
	Run(filter GCFilter) (int, error)

	// Observe4 allows external consumers to observe ongoing GC iterations over CT maps for IPv4 entries.
	Observe4() stream.Observable[GCEvent]

	// Observe6 allows external consumers to observe ongoing GC iterations over CT maps for IPv6 entries.
	Observe6() stream.Observable[GCEvent]
}

type Map struct {
	bpf.Map
	// contains filtered or unexported fields
}

type NatGCStats struct {
	*bpf.DumpStats

	// family is the address family
	Family    gcFamily
	ClusterID uint32

	IngressAlive   uint32
	IngressDeleted uint32
	EgressDeleted  uint32
	EgressAlive    uint32
}

type PerClusterCTMap struct {
	*bpf.Map
	// contains filtered or unexported fields
}

type PerClusterCTMapKey struct {
	ClusterID uint32
}

type PerClusterCTMapVal struct {
	Fd uint32
}

type PerClusterCTMapper interface {
	// Create enforces the presence of the outer per-cluster CT maps.
	OpenOrCreate() error
	// Close closes the outer per-cluster CT maps handlers.
	Close() error

	// CreateClusterNATMaps enforces the presence of the inner maps for
	// the given cluster ID. It must be called after that OpenOrCreate()
	// has returned successfully.
	CreateClusterCTMaps(clusterID uint32) error
	// DeleteClusterNATMaps deletes the inner maps for the given cluster ID.
	// It must be called after that OpenOrCreate() has returned successfully.
	DeleteClusterCTMaps(clusterID uint32) error

	// GetClusterCTMaps returns the per-cluster maps for each known cluster ID.
	// The returned maps need to be opened by the caller.
	GetAllClusterCTMaps() []*Map
}

type PurgeHook interface {
	CountFailed4(uint16, uint32)
	CountFailed6(uint16, uint32)
}