gnet

[中文]

gnet is an Event-Loop networking framework that is fast and small. It makes direct epoll and kqueue syscalls rather than using the standard Go net package, and works in a similar manner as netty and libuv.

The goal of this project is to create a server framework for Go that performs on par with Redis and Haproxy for packet handling.

gnet sells itself as a high-performance, lightweight, non-blocking network library written in pure Go which works on transport layer with TCP/UDP/Unix-Socket protocols, so it allows developers to implement their own protocols of application layer upon gnet for building diversified network applications, for instance, you get an HTTP Server or Web Framework if you implement HTTP protocol upon gnet while you have a Redis Server done with the implementation of Redis protocol upon gnet and so on.

gnet derives from the project: evio while having a much higher performance.

Features

• High-performance Event-Loop under multi-threads/goroutines model
• Built-in load balancing algorithm: Round-Robin
• Concise APIs
• Efficient memory usage: Ring-Buffer
• Supporting multiple protocols: TCP, UDP, and Unix Sockets
• Supporting two event-notification mechanisms: epoll on Linux and kqueue on FreeBSD
• Supporting asynchronous write operation
• Flexible ticker event
• SO_REUSEPORT socket option

Key Designs

Multiple-Threads/Goroutines Model

Multiple Reactors Model

gnet redesigns and implements a new built-in multiple-threads/goroutines model: 『Multiple Reactors』 which is also the default multiple-threads model of netty, Here's the schematic diagram:

and it works as the following sequence diagram:

Multiple Reactors + Goroutine-Pool Model

You may ask me a question: what if my business logic in EventHandler.React contains some blocking code which leads to blocking in event-loop of gnet, what is the solution for this kind of situation？

As you know, there is a most important tenet when writing code under gnet: you should never block the event-loop in the EventHandler.React, otherwise, it will lead to a low throughput in your gnet server, which is also the most important tenet in netty.

And the solution for that would be found in the subsequent multiple-threads/goroutines model of gnet: 『Multiple Reactors with thread/goroutine pool』which pulls you out from the blocking mire, it will construct a worker-pool with fixed capacity and put those blocking jobs in EventHandler.React into the worker-pool to unblock the event-loop goroutines.

This new networking model is under development and about to be delivered soon and its architecture diagram of the new model is in here:

and it works as the following sequence diagram:

Before you can benefit from this new networking model in handling blocking business logic, there is still a way for you to handle your business logic in networking: you can utilize the open-source goroutine-pool to unblock your blocking code, and I now present you ants: a high-performance goroutine pool in Go that allows you to manage and recycle a massive number of goroutines in your concurrent programs.

You can import ants to your gnet server and put your blocking code to the ants pool in EventHandler.React, which makes your business code non-blocking.

Auto-scaling Ring Buffer

gnet utilizes Ring-Buffer to buffer network data and manage memories in networking.

Getting Started

Installation

$ go get -u github.com/panjf2000/gnet

Usage

It is easy to create a network server with gnet. All you have to do is just make your implementation of gnet.EventHandler interface and register your event-handler functions to it, then pass it to the gnet.Serve function along with the binding address(es). Each connection is represented as a gnet.Conn interface that is passed to various events to differentiate the clients. At any point you can close a client or shutdown the server by return a Close or Shutdown action from an event.

The simplest example to get you started playing with gnet would be the echo server. So here you are, a simplest echo server upon gnet that is listening on port 9000:

Echo server without blocking logic

package main

import (
	"log"

	"github.com/panjf2000/gnet"
)

type echoServer struct {
	*gnet.EventServer
}

func (es *echoServer) React(c gnet.Conn) (out []byte, action gnet.Action) {
	top, tail := c.ReadPair()
	out = top
	if tail != nil {
		out = append(top, tail...)
	}
	c.ResetBuffer()
	return
}

func main() {
	echo := new(echoServer)
	log.Fatal(gnet.Serve(echo, "tcp://:9000", gnet.WithMulticore(true)))
}

As you can see, this example of echo server only sets up the EventHandler.React function where you commonly write your main business code and it will be invoked once the server receives input data from a client. The output data will be then sent back to that client by assigning the out variable and return it after your business code finish processing data(in this case, it just echo the data back).

Echo server with blocking logic

package main

import (
	"log"
	"time"

	"github.com/panjf2000/ants/v2"
	"github.com/panjf2000/gnet"
)

type echoServer struct {
	*gnet.EventServer
	pool *ants.Pool
}

func (es *echoServer) React(c gnet.Conn) (out []byte, action gnet.Action) {
	data := c.ReadBytes()
	c.ResetBuffer()

	// Use ants pool to unblock the event-loop.
	_ = es.pool.Submit(func() {
		time.Sleep(1 * time.Second)
		c.AsyncWrite(data)
	})

	action = gnet.DataRead
	return
}

func main() {
	// Create a goroutine pool.
	poolSize := 64 * 1024
	pool, _ := ants.NewPool(poolSize, ants.WithNonblocking(true))
	defer pool.Release()
	echo := &echoServer{pool: pool}
	log.Fatal(gnet.Serve(echo, "tcp://:9000", gnet.WithMulticore(true)))
}

Like I said in the 『Multiple Reactors + Goroutine-Pool Model』section, if there are blocking code in your business logic, then you ought to turn them into non-blocking code in any way, for instance you can wrap them into a goroutine, but it will result in a massive amount of goroutines if massive traffic is passing through your server so I would suggest you utilize a goroutine pool like ants to manage those goroutines and reduce the cost of system resources.

I/O Events

Current supported I/O events in gnet:

• EventHandler.OnInitComplete is activated when the server is ready to accept new connections.
• EventHandler.OnOpened is activated when a connection has opened.
• EventHandler.OnClosed is activated when a connection has closed.
• EventHandler.React is activated when the server receives new data from a connection.
• EventHandler.Tick is activated immediately after the server starts and will fire again after a specified interval.
• EventHandler.PreWrite is activated just before any data is written to any client socket.

Ticker

The EventHandler.Tick event fires ticks at a specified interval. The first tick fires immediately after the Serving events and if you intend to set up a ticker event, remember to pass an option: gnet.WithTicker(true) to gnet.Serve.

events.Tick = func() (delay time.Duration, action Action){
	log.Printf("tick")
	delay = time.Second
	return
}

UDP

The gnet.Serve function can bind to UDP addresses.

• All incoming and outgoing packets will not be buffered but sent individually.
• The EventHandler.OnOpened and EventHandler.OnClosed events are not available for UDP sockets, only the React event.

Multi-threads

The gnet.WithMulticore(true) indicates whether the server will be effectively created with multi-cores, if so, then you must take care of synchronizing memory between all event callbacks, otherwise, it will run the server with a single thread. The number of threads in the server will be automatically assigned to the value of runtime.NumCPU().

Load balancing

The current built-in load balancing algorithm in gnet is Round-Robin.

SO_REUSEPORT

Servers can utilize the SO_REUSEPORT option which allows multiple sockets on the same host to bind to the same port and the OS kernel takes care of the load balancing for you, it wakes one socket per accpet event coming to resolved the thundering herd.

Just use functional options to set up SO_REUSEPORT and you can enjoy this feature:

gnet.Serve(events, "tcp://:9000", gnet.WithMulticore(true), gnet.WithReusePort(true)))

Performance

Contrasts to the similar networking libraries

On Linux (epoll)

Test Environment

# Machine information
        OS : Ubuntu 18.04/x86_64
       CPU : 8 Virtual CPUs
    Memory : 16.0 GiB

# Go version and configurations
Go Version : go1.12.9 linux/amd64
GOMAXPROCS=8

Echo Server

HTTP Server

On FreeBSD (kqueue)

Test Environment

# Machine information
        OS : macOS Mojave 10.14.6/x86_64
       CPU : 4 CPUs
    Memory : 8.0 GiB

# Go version and configurations
Go Version : go version go1.12.9 darwin/amd64
GOMAXPROCS=4

Echo Server

HTTP Server

License

Source code in gnet is available under the MIT License.

Thanks

• evio
• netty
• ants

Relevant Articles

• A Million WebSockets and Go
• Going Infinite, handling 1M websockets connections in Go
• gnet: 一个轻量级且高性能的 Golang 网络库