bwmap

package

v1.21.0-pre.2 Latest Latest Go to latest Published: Sep 9, 2026 License: Apache-2.0 Imports: 16 Imported by: 5

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/cilium/cilium

Links

Documentation ¶

Overview ¶

Package bwmap represents the BPF map used to enforce Pod bandwidth limitations via EDT (Earliest Departure Time) + BPF. +groupName=maps

Index ¶

Constants
Variables
func NewEdtTable(db *statedb.DB) (statedb.RWTable[Edt], error)
func ThrottleMap(logger *slog.Logger) (*bpf.Map, error)
type Edt
- func NewEdt(endpointID uint16, direction uint8, bytesPerSecond uint64, prio uint32) Edt
type EdtIDKey
- func (k EdtIDKey) Key() index.Key
type EdtId
- func (k *EdtId) New() bpf.MapKey
- func (k *EdtId) String() string
type EdtInfo
- func (v *EdtInfo) New() bpf.MapValue
- func (v *EdtInfo) String() string

Constants ¶

View Source

const (
	MapName = "cilium_throttle"
	// Flow aggregate is per Pod, so same size as Endpoint map.
	MapSize = lxcmap.MaxEntries

	// DefaultDropHorizon represents maximum allowed departure
	// time delta in future. Given applications can set SO_TXTIME
	// from user space this is a limit to prevent buggy applications
	// to fill the FQ qdisc.
	DefaultDropHorizon = 2 * time.Second
)

View Source

const EdtTableName = "bandwidth-edts"

Variables ¶

View Source

var Cell = cell.Module(
	"bwmap",
	"Manages the endpoint bandwidth limit BPF map",

	cell.Provide(
		NewEdtTable,
		statedb.RWTable[Edt].ToTable,
		provide,
	),
	cell.Invoke(
		configure,
		start,
		bpf.MaybeTablePressureMetrics[Edt, *throttleMap],
	),
)

Cell manages the cilium_throttle BPF map for implementing per-endpoint bandwidth management. The cell provides RWTable[Edt] to which per endpoint bandwidth limits can be inserted. Use NewEdt to create the object. The table can be inspected with "cilium-dbg shell -- db/show bandwidth-edts". A reconciler is registered that reconciles the table with the cilium_throttle map.

View Source

var (

	// EDTByID queries the EDT table by endpoint ID and direction.
	EDTByID = edtIDIndex.Query
)

Functions ¶

func NewEdtTable ¶ added in v1.16.0

func NewEdtTable(db *statedb.DB) (statedb.RWTable[Edt], error)

func ThrottleMap ¶

func ThrottleMap(logger *slog.Logger) (*bpf.Map, error)

ThrottleMap opens an already initialized cilium_throttle map. Direct use of this outside of this package is solely for cilium-dbg.

Types ¶

type Edt ¶ added in v1.16.0

type Edt struct {
	EdtIDKey

	// BytesPerSecond is the bandwidth limit for the endpoint.
	BytesPerSecond uint64

	Prio uint32

	// TimeHorizonDrop is the maximum allowed departure time nanoseconds
	// delta in future.
	TimeHorizonDrop uint64

	// Status is the BPF map reconciliation status of this throttle entry.
	Status reconciler.Status
}

Edt is defines the "earliest departure time" pacing for a specific Cilium endpoint. This structure is stored in Table[Edt] and reconciled to the cilium_throttle BPF map.

Edt is stored by value as it's relatively tiny.

func NewEdt ¶ added in v1.16.0

func NewEdt(endpointID uint16, direction uint8, bytesPerSecond uint64, prio uint32) Edt

func (Edt) BinaryKey ¶ added in v1.16.0

func (e Edt) BinaryKey() encoding.BinaryMarshaler

func (Edt) BinaryValue ¶ added in v1.16.0

func (e Edt) BinaryValue() encoding.BinaryMarshaler

func (Edt) TableHeader ¶ added in v1.16.0

func (e Edt) TableHeader() []string

func (Edt) TableRow ¶ added in v1.16.0

func (e Edt) TableRow() []string

type EdtIDKey ¶ added in v1.18.0

type EdtIDKey struct {
	EndpointID uint16
	Direction  uint8
}

func (EdtIDKey) Key ¶ added in v1.18.0

func (k EdtIDKey) Key() index.Key

type EdtId ¶

type EdtId struct {
	Id        uint32   `align:"id"`
	Direction uint8    `align:"direction"`
	Pad       [3]uint8 `align:"pad"`
}

func (*EdtId) New ¶

func (k *EdtId) New() bpf.MapKey

func (*EdtId) String ¶

func (k *EdtId) String() string

type EdtInfo ¶

type EdtInfo struct {
	Bps                     uint64    `align:"bps"`
	TimeLast                uint64    `align:"t_last"`
	TimeHorizonDropOrTokens uint64    `align:"$union0"`
	Prio                    uint32    `align:"prio"`
	Pad32                   uint32    `align:"pad_32"`
	Pad                     [3]uint64 `align:"pad"`
}

func (*EdtInfo) New ¶

func (v *EdtInfo) New() bpf.MapValue

func (*EdtInfo) String ¶

func (v *EdtInfo) String() string

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL