3bb8fec7e4
Accept packet vectors for reading and writing in the tun.Device and conn.Bind interfaces, so that the internal plumbing between these interfaces now passes a vector of packets. Vectors move untouched between these interfaces, i.e. if 128 packets are received from conn.Bind.Read(), 128 packets are passed to tun.Device.Write(). There is no internal buffering. Currently, existing implementations are only adjusted to have vectors of length one. Subsequent patches will improve that. Also, as a related fixup, use the unix and windows packages rather than the syscall package when possible. Co-authored-by: James Tucker <james@tailscale.com> Signed-off-by: James Tucker <james@tailscale.com> Signed-off-by: Jordan Whited <jordan@tailscale.com> Signed-off-by: Jason A. Donenfeld <Jason@zx2c4.com>
54 lines
1.5 KiB
Go
54 lines
1.5 KiB
Go
/* SPDX-License-Identifier: MIT
|
|
*
|
|
* Copyright (C) 2017-2023 WireGuard LLC. All Rights Reserved.
|
|
*/
|
|
|
|
package tun
|
|
|
|
import (
|
|
"os"
|
|
)
|
|
|
|
type Event int
|
|
|
|
const (
|
|
EventUp = 1 << iota
|
|
EventDown
|
|
EventMTUUpdate
|
|
)
|
|
|
|
type Device interface {
|
|
// File returns the file descriptor of the device.
|
|
File() *os.File
|
|
|
|
// Read one or more packets from the Device (without any additional headers).
|
|
// On a successful read it returns the number of packets read, and sets
|
|
// packet lengths within the sizes slice. len(sizes) must be >= len(buffs).
|
|
// A nonzero offset can be used to instruct the Device on where to begin
|
|
// reading into each element of the buffs slice.
|
|
Read(buffs [][]byte, sizes []int, offset int) (n int, err error)
|
|
|
|
// Write one or more packets to the device (without any additional headers).
|
|
// On a successful write it returns the number of packets written. A nonzero
|
|
// offset can be used to instruct the Device on where to begin writing from
|
|
// each packet contained within the buffs slice.
|
|
Write(buffs [][]byte, offset int) (int, error)
|
|
|
|
// MTU returns the MTU of the Device.
|
|
MTU() (int, error)
|
|
|
|
// Name returns the current name of the Device.
|
|
Name() (string, error)
|
|
|
|
// Events returns a channel of type Event, which is fed Device events.
|
|
Events() <-chan Event
|
|
|
|
// Close stops the Device and closes the Event channel.
|
|
Close() error
|
|
|
|
// BatchSize returns the preferred/max number of packets that can be read or
|
|
// written in a single read/write call. BatchSize must not change over the
|
|
// lifetime of a Device.
|
|
BatchSize() int
|
|
}
|