rio

README

RIO

基于IOURING的AIO网络库，非CGO方式，且遵循标准库使用设计模式。

支持协议：TCP、UDP、UNIX、UNIXGRAM（IP为代理标准库）。

Linux 内核版本需要>= 5.14，推荐版本为>= 6.1。

性能

基于默认参数的测试，详见 Benchmark 。

使用

go get -u github.com/brickingsoft/rio

基本使用rio替换net：

// 将 net.Listen() 替换成 rio.Listen() 
ln, lnErr := rio.Listen("tcp", ":9000")
// 将 net.Dial() 替换成 rio.Dial() 
conn, dialErr := rio.Dial("tcp", "127.0.0.1:9000")

TLS场景：

// server("github.com/brickingsoft/rio/tls")
ln, _ = tls.Listen("tcp", "127.0.0.1:9000", tls.ConfigFrom(config))
// server(use wrap)
ln, _ := rio.Listen("tcp", ":9000")
ln, _ := tls.NewListener(ln, config)

// client("github.com/brickingsoft/rio/tls")
conn, _ = tls.Dial("tcp", "127.0.0.1:9000", tls.ConfigFrom(config))

// client(use wrap)
rawConn, dialErr := rio.Dial("tcp", "127.0.0.1:9000")
conn := tls.Client(rawConn, config)
if err := conn.HandshakeContext(ctx); err != nil {
	rawConn.Close()
	return nil, err
}

转换场景：

// tcp sendfile
reader, ok := conn.(io.ReaderFrom)
// 转换成 TCP 链接 
tcpConn, ok := conn.(*rio.TCPConn)
// 转换成 UDP 链接
udpConn, ok := conn.(*rio.UDPConn)
// 转换成 UNIX 链接
unixConn, ok := conn.(*rio.UnixConn)

纯客户端场景：

建议PIN住IOURING，直到程序退出再UNPIN。

因为IOURING的生命周期为当被使用时开启，当被没有被使用时关闭。

因为Listen的生命周期往往和程序是一致的，所以IOURING为常驻状况。

而Dial的生命周期是短的，往往是频繁Dial，所以需要PIN来常驻IOURING，而不是频繁开闭。

// 程序启动位置
pinErr := rio.PinVortexes()
// 程序退出位置
unpinErr := rio.UnpinVortexes()

HTTP场景：

Server 使用Listener代替法。

Client 使用RoundTripper代替法。

// http server
http.Serve(ln, handler)
// fasthttp server
fasthttp.Serve(ln, handler)

REUSE PORT：

lc := rio.ListenConfig{}
lc.SetReusePort(true)

ln, lnErr := lc.Listen(...)

进阶调参

setting_linux.go

//go:build linux
package main

import (
    "github.com/brickingsoft/rio"
)


func setup() {
	// 设置进程等级
	rio.UseProcessPriority()
	// 设置 IOURING 的大小
	rio.UseEntries()
	// 设置边缘大小
	// 不是越多越好，与 CPU 数量相关，默认是 CPU 数量的一半。
	rio.UseSides()
	// 设置边缘加载平衡器
	rio.UseSidesLoadBalancer()
	// 设置任务准备批大小
	// 默认是任务数
	rio.UsePrepareBatchSize()
	// 设置完成事件等待变速器构建器
	// 这与性能息息相关，调整变速器实现不同的性能。
	// 默认是曲线变速器，
	rio.UseWaitTransmissionBuilder() 
	// 设置从可读方读数据策略
	rio.UseReadFromFilePolicy()
	// 使用爆操性能模式
	rio.UsePreformMode()
	// 设置 IOURING 的 Flags
	rio.UseFlags()
	// 设置 IOURING 的 Features
	rio.UseFeatures()
	
}

settings_posix.go

//go:build !linux
package main


func setup() {}

main.go

package main

import "github.com/brickingsoft/rio"

func main() {
	setup()

	ln, lnErr := rio.Listen("tcp", ":9000")
}

Documentation

Index

• Variables
• func Dial(network string, address string) (net.Conn, error)
• func DialContext(ctx context.Context, network string, address string) (net.Conn, error)
• func DialTimeout(network string, address string, timeout time.Duration) (net.Conn, error)
• func Listen(network string, addr string) (net.Listener, error)
• func ListenPacket(network string, addr string) (net.PacketConn, error)
• func PinVortexes() error
• func UnpinVortexes() error
• func UseProcessPriority(level process.PriorityLevel)
• type Dialer
  • func (d *Dialer) SetFastOpen(_ int)
• type IPConn
  • func DialIP(network string, laddr, raddr *net.IPAddr) (*IPConn, error)
  • func ListenIP(network string, addr *net.IPAddr) (*IPConn, error)
• type TCPConn
  • func DialTCP(network string, laddr, raddr *net.TCPAddr) (*TCPConn, error)
• type TCPListener
  • func ListenTCP(network string, addr *net.TCPAddr) (*TCPListener, error)
• type UDPConn
  • func DialUDP(network string, laddr, raddr *net.UDPAddr) (*UDPConn, error)
  • func ListenMulticastUDP(network string, ifi *net.Interface, addr *net.UDPAddr) (*UDPConn, error)
  • func ListenUDP(network string, addr *net.UDPAddr) (*UDPConn, error)
• type UnixConn
  • func DialUnix(network string, laddr, raddr *net.UnixAddr) (*UnixConn, error)
  • func ListenUnixgram(network string, addr *net.UnixAddr) (*UnixConn, error)
• type UnixListener
  • func ListenUnix(network string, addr *net.UnixAddr) (*UnixListener, error)

Variables

var (
	DefaultDialer = Dialer{}
)

Functions

func Dial

func Dial(network string, address string) (net.Conn, error)

func DialContext

func DialContext(ctx context.Context, network string, address string) (net.Conn, error)

func DialTimeout

func DialTimeout(network string, address string, timeout time.Duration) (net.Conn, error)

func Listen

func Listen(network string, addr string) (net.Listener, error)

func ListenPacket

func ListenPacket(network string, addr string) (net.PacketConn, error)

func PinVortexes

func PinVortexes() error

func UnpinVortexes

func UnpinVortexes() error

func UseProcessPriority

func UseProcessPriority(level process.PriorityLevel)

Types

type Dialer

type Dialer struct {
	net.Dialer
}

func (*Dialer) SetFastOpen

func (d *Dialer) SetFastOpen(_ int)

type IPConn

type IPConn struct {
	*net.IPConn
}

func DialIP

func DialIP(network string, laddr, raddr *net.IPAddr) (*IPConn, error)

func ListenIP

func ListenIP(network string, addr *net.IPAddr) (*IPConn, error)

type TCPConn

type TCPConn struct {
	*net.TCPConn
}

func DialTCP

func DialTCP(network string, laddr, raddr *net.TCPAddr) (*TCPConn, error)

type TCPListener

type TCPListener struct {
	*net.TCPListener
}

func ListenTCP

func ListenTCP(network string, addr *net.TCPAddr) (*TCPListener, error)

type UDPConn

type UDPConn struct {
	*net.UDPConn
}

func DialUDP

func DialUDP(network string, laddr, raddr *net.UDPAddr) (*UDPConn, error)

func ListenMulticastUDP

func ListenMulticastUDP(network string, ifi *net.Interface, addr *net.UDPAddr) (*UDPConn, error)

func ListenUDP

func ListenUDP(network string, addr *net.UDPAddr) (*UDPConn, error)

type UnixConn

type UnixConn struct {
	*net.UnixConn
}

func DialUnix

func DialUnix(network string, laddr, raddr *net.UnixAddr) (*UnixConn, error)

func ListenUnixgram

func ListenUnixgram(network string, addr *net.UnixAddr) (*UnixConn, error)

type UnixListener

type UnixListener struct {
	*net.UnixListener
}

func ListenUnix

func ListenUnix(network string, addr *net.UnixAddr) (*UnixListener, error)