veth

Documentation

Overview

Package veth provides the implementation of virtual ethernet device pair.

Index

• Constants
• func NewPair(mtu, backlogQueueSize uint32) (*Endpoint, *Endpoint)
• type Endpoint
  • func (*Endpoint) ARPHardwareType() header.ARPHardwareType
  • func (e *Endpoint) AddHeader(pkt *stack.PacketBuffer)
  • func (e *Endpoint) Attach(dispatcher stack.NetworkDispatcher)
  • func (e *Endpoint) Capabilities() stack.LinkEndpointCapabilities
  • func (e *Endpoint) Close()
  • func (*Endpoint) GSOMaxSize() uint32
  • func (e *Endpoint) InjectInbound(protocol tcpip.NetworkProtocolNumber, pkt *stack.PacketBuffer)
  • func (e *Endpoint) IsAttached() bool
  • func (e *Endpoint) LinkAddress() tcpip.LinkAddress
  • func (e *Endpoint) MTU() uint32
  • func (*Endpoint) MaxHeaderLength() uint16
  • func (e *Endpoint) ParseHeader(pkt *stack.PacketBuffer) bool
  • func (e *Endpoint) SetLinkAddress(addr tcpip.LinkAddress)
  • func (e *Endpoint) SetMTU(mtu uint32)
  • func (e *Endpoint) SetOnCloseAction(action func())
  • func (e *Endpoint) SupportedGSO() stack.SupportedGSO
  • func (*Endpoint) Wait()
  • func (e *Endpoint) WritePackets(pkts stack.PacketBufferList) (int, tcpip.Error)

Constants

const DefaultBacklogSize = 1000

DefaultBacklogSize is the default size of a veth device's buffer.

Functions

func NewPair

func NewPair(mtu, backlogQueueSize uint32) (*Endpoint, *Endpoint)

NewPair creates a new veth pair.

Types

type Endpoint

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

Endpoint is link layer endpoint that redirects packets to a pair veth endpoint.

+stateify savable

func (*Endpoint) ARPHardwareType

func (*Endpoint) ARPHardwareType() header.ARPHardwareType

ARPHardwareType implements stack.LinkEndpoint.ARPHardwareType.

func (*Endpoint) AddHeader

func (e *Endpoint) AddHeader(pkt *stack.PacketBuffer)

AddHeader implements stack.LinkEndpoint.AddHeader.

func (*Endpoint) Attach

func (e *Endpoint) Attach(dispatcher stack.NetworkDispatcher)

Attach saves the stack network-layer dispatcher for use later when packets are injected.

func (*Endpoint) Capabilities

func (e *Endpoint) Capabilities() stack.LinkEndpointCapabilities

Capabilities implements stack.LinkEndpoint.Capabilities.

func (*Endpoint) Close

func (e *Endpoint) Close()

Close closes e. Further packet injections will return an error, and all pending packets are discarded. Close may be called concurrently with WritePackets.

func (*Endpoint) GSOMaxSize

func (*Endpoint) GSOMaxSize() uint32

GSOMaxSize implements stack.GSOEndpoint.

func (*Endpoint) InjectInbound

func (e *Endpoint) InjectInbound(protocol tcpip.NetworkProtocolNumber, pkt *stack.PacketBuffer)

InjectInbound injects an inbound packet. If the endpoint is not attached, the packet is not delivered.

func (*Endpoint) IsAttached

func (e *Endpoint) IsAttached() bool

IsAttached implements stack.LinkEndpoint.IsAttached.

func (*Endpoint) LinkAddress

func (e *Endpoint) LinkAddress() tcpip.LinkAddress

LinkAddress returns the link address of this endpoint.

func (*Endpoint) MTU

func (e *Endpoint) MTU() uint32

MTU implements stack.LinkEndpoint.MTU.

func (*Endpoint) MaxHeaderLength

func (*Endpoint) MaxHeaderLength() uint16

MaxHeaderLength returns the maximum size of the link layer header. Given it doesn't have a header, it just returns 0.

func (*Endpoint) ParseHeader

func (e *Endpoint) ParseHeader(pkt *stack.PacketBuffer) bool

ParseHeader implements stack.LinkEndpoint.ParseHeader.

func (*Endpoint) SetLinkAddress

func (e *Endpoint) SetLinkAddress(addr tcpip.LinkAddress)

SetLinkAddress implements stack.LinkEndpoint.SetLinkAddress.

func (*Endpoint) SetMTU

func (e *Endpoint) SetMTU(mtu uint32)

SetMTU implements stack.LinkEndpoint.SetMTU.

func (*Endpoint) SetOnCloseAction

func (e *Endpoint) SetOnCloseAction(action func())

SetOnCloseAction implements stack.LinkEndpoint.

func (*Endpoint) SupportedGSO

func (e *Endpoint) SupportedGSO() stack.SupportedGSO

SupportedGSO implements stack.GSOEndpoint.

func (*Endpoint) Wait

func (*Endpoint) Wait()

Wait implements stack.LinkEndpoint.Wait.

func (*Endpoint) WritePackets

func (e *Endpoint) WritePackets(pkts stack.PacketBufferList) (int, tcpip.Error)

WritePackets stores outbound packets into the channel. Multiple concurrent calls are permitted.