Millió WebSocket and Go

Sziasztok! A nevem Sergey Kamardin, és a Mail.Ru fejlesztője vagyok.

Ez a cikk arról szól, hogyan fejlesztettük ki a nagy terhelésű WebSocket szervert a Go alkalmazással.

Ha ismeri a WebSocketeket, de keveset tud a Go-ról, remélem, hogy a cikket mégis érdekesnek találja a teljesítmény optimalizálásához szükséges ötletek és technikák szempontjából.

1. Bemutatkozás

A történetünk kontextusának meghatározásához néhány szót el kell mondani arról, hogy miért van szükségünk erre a szerverre.

A Mail.Ru-nak sok állapottartó rendszere van. A felhasználói e-mail tárhely az egyik ilyen. Számos módja van a rendszeren belüli állapotváltozások és a rendszer eseményeinek nyomon követésére. Leginkább ez rendszeres rendszeres közvélemény-kutatással vagy az állapotváltozásokról szóló rendszer értesítésekkel történik.

Mindkét útnak megvan az előnye és hátránya. De ami a levelet illeti, annál jobb, minél gyorsabban kap egy felhasználó új levelet.

A levelezési szavazás másodpercenként körülbelül 50 000 HTTP-lekérdezést tartalmaz, amelyek 60% -a visszaadja a 304 állapotot, vagyis nincs változás a postaládában.

Ezért a szerverek terhelésének csökkentése és a felhasználók kézbesítésének felgyorsítása érdekében úgy döntöttek, hogy újból feltalálják a kereket egy kiadó-előfizető szerver (más néven busz, üzenetközvetítő vagy esemény- csatorna), amelyek egyrészt értesítéseket kapnának az állapotváltozásokról, másrészt az ilyen értesítésekre vonatkozó előfizetéseket.

Korábban:

Most:

Az első séma megmutatja, milyen volt azelőtt. A böngésző rendszeresen lekérdezte az API-t, és a tárolás (postaláda szolgáltatás) változásairól kérdezett.

A második séma az új architektúrát írja le. A böngésző létrehoz egy WebSocket kapcsolatot az értesítési API-val, amely a buszszerver kliense. Az új e-mail kézhezvétele után a Storage értesítést küld erről a Bus (1) és a Bus elõfizetõinek (2). Az API meghatározza a kapcsolatot a kapott értesítés elküldéséhez, és elküldi a felhasználó böngészőjének (3).

Tehát ma az API-ról vagy a WebSocket szerverről fogunk beszélni. Előretekintve elmondom, hogy a szervernek körülbelül 3 millió online kapcsolata lesz.

2. Az idiomatikus mód

Lássuk, hogyan valósítanánk meg szerverünk egyes részeit a sima Go funkciókkal optimalizálás nélkül.

Mielőtt folytatnánk net/http, beszéljünk arról, hogyan fogunk adatokat küldeni és fogadni. Az adatok amely áll fent a WebSocket protokoll (pl JSON tárgyak) a továbbiakban, mint csomagokat .

Kezdjük el bevezetni azt a Channelstruktúrát, amely tartalmazza az ilyen csomagok WebSocket kapcsolaton keresztüli küldésének és fogadásának logikáját.

2.1. Csatorna felépítése

// Packet represents application level data. type Packet struct { ... } // Channel wraps user connection. type Channel struct { conn net.Conn // WebSocket connection. send chan Packet // Outgoing packets queue. } func NewChannel(conn net.Conn) *Channel { c := &Channel{ conn: conn, send: make(chan Packet, N), } go c.reader() go c.writer() return c }

Szeretném felhívni a figyelmét két olvasó és író korall bevezetésére. Minden egyes rutinhoz saját memóriakészlet szükséges, amelynek kezdeti mérete 2–8 KB lehet, az operációs rendszertől és a Go verziótól függően.

A fent említett 3 millió online kapcsolat tekintetében 24 GB memóriára lesz szükségünk (4 KB-os köteggel) az összes kapcsolathoz. És ez a Channelszerkezet, a kimenő csomagok ch.sendés más belső mezők számára lefoglalt memória nélkül .

2.2. I / O gorut

Vessünk egy pillantást az „olvasó” megvalósítására:

func (c *Channel) reader() { // We make a buffered read to reduce read syscalls. buf := bufio.NewReader(c.conn) for { pkt, _ := readPacket(buf) c.handle(pkt) } }

Itt bufio.Readera read()syscallok számának csökkentésére és a bufpufferméret által annyi beolvasására használjuk . A végtelen körön belül új adatok érkezésére számítunk. Ne feledje, hogy új adatok érkeznek. Később visszatérünk hozzájuk.

Félretesszük a bejövő csomagok elemzését és feldolgozását, mivel ez nem fontos az optimalizálások szempontjából, amelyekről beszélni fogunk. bufÉrdemes azonban most figyelnünk: alapértelmezés szerint ez 4 KB, ami további 12 GB memóriát jelent kapcsolataink számára. Hasonló a helyzet az "íróval":

func (c *Channel) writer() { // We make buffered write to reduce write syscalls. buf := bufio.NewWriter(c.conn) for pkt := range c.send { _ := writePacket(buf, pkt) buf.Flush() } }

Iterálunk a kimenő csomagcsatornán c.sendés beírjuk őket a pufferbe. Ez, amint figyelmes olvasóink már sejteni tudják, további 4 KB és 12 GB memória a 3 millió kapcsolatunkhoz.

2.3. HTTP

Már van egy egyszerű Channelmegvalósításunk, most meg kell szereznünk egy WebSocket kapcsolatot, amellyel működhetünk. Mivel még mindig az Idiomatikus Út címszó alatt állunk , tegyük meg a megfelelő módon.

Megjegyzés: Ha nem tudja, hogyan működik a WebSocket, meg kell említeni, hogy az ügyfél egy speciális, Upgrade nevű HTTP mechanizmus segítségével vált a WebSocket protokollra. A frissítési kérelem sikeres feldolgozása után a szerver és az ügyfél a TCP kapcsolatot használja bináris WebSocket keretek cseréjére. Itt található a csatlakozáson belüli keretszerkezet leírása.
import ( "net/http" "some/websocket" ) http.HandleFunc("/v1/ws", func(w http.ResponseWriter, r *http.Request) { conn, _ := websocket.Upgrade(r, w) ch := NewChannel(conn) //... })

Felhívjuk figyelmét, hogy http.ResponseWriterteszi a memória kiosztás bufio.Readerés bufio.Writer(mindkettő 4 KB puffer) a *http.Requestvisszaállítás és újabb válasz írásban.

Függetlenül a használt WebSocket könyvtártól, a frissítési kérelem sikeres megválaszolása után a szerver a responseWriter.Hijack()hívás után I / O puffereket kap a TCP kapcsolattal együtt .

Tipp: Bizonyos esetekben a go:linknamepuffereket a híváson sync.Poolbelülre lehet visszaadni .net/httpnet/http.putBufio{Reader,Writer}

Így további 24 GB memóriára van szükségünk 3 millió kapcsolat számára.

Tehát összesen 72 GB memória az alkalmazás számára, amely még nem csinál semmit!

3. Optimalizálás

Nézzük át, miről beszéltünk a bevezető részben, és emlékezzünk a felhasználói kapcsolat viselkedésére. A WebSocketre váltás után az ügyfél csomagot küld a releváns eseményekről, vagy más szóval feliratkozik az eseményekre. Ezután (az olyan technikai üzeneteket nem figyelembe véve ping/pong) az ügyfél a kapcsolat teljes élettartama alatt mást nem küldhet.

A kapcsolat élettartama néhány másodperctől néhány napig tarthat.

Így a legtöbb időt a Channel.reader()és Channel.writer()várják az adatkezelés a fogad vagy küld. Velük együtt várakoznak az egyenként 4 KB-os I / O pufferek.

Most már világos, hogy bizonyos dolgokat jobban lehetne csinálni, nem?

3.1. Netpoll

Emlékszel arra a Channel.reader()megvalósításra, amely arra számított, hogy új adatok érkeznek azzal, hogy lezárják a conn.Read()hívást a bufio.Reader.Read()? Ha voltak adatok a kapcsolatban, a Go runtime "felébresztette" a mi rutinunkat, és lehetővé tette számára, hogy elolvassa a következő csomagot. Ezt követően a gorutint újra lezárták, miközben új adatokra számítottak. Lássuk, a Go runtime hogyan érti, hogy a gorutint "fel kell ébreszteni".

Ha megnézzük a conn.Read () implementációt, látni fogjuk benne a net.netFD.Read () hívást:

// net/fd_unix.go func (fd *netFD) Read(p []byte) (n int, err error) { //... for { n, err = syscall.Read(fd.sysfd, p) if err != nil { n = 0 if err == syscall.EAGAIN { if err = fd.pd.waitRead(); err == nil { continue } } } //... break } //... }
Go uses sockets in non-blocking mode. EAGAIN says there is no data in the socket and not to get locked on reading from the empty socket, OS returns control to us.

We see a read() syscall from the connection file descriptor. If read returns the EAGAIN error, runtime makes the pollDesc.waitRead() call:

// net/fd_poll_runtime.go func (pd *pollDesc) waitRead() error { return pd.wait('r') } func (pd *pollDesc) wait(mode int) error { res := runtime_pollWait(pd.runtimeCtx, mode) //... }

If we dig deeper, we’ll see that netpoll is implemented using epoll in Linux and kqueue in BSD. Why not use the same approach for our connections? We could allocate a read buffer and start the reading goroutine only when it is really necessary: when there is really readable data in the socket.

On github.com/golang/go, there is the issue of exporting netpoll functions.

3.2. Getting rid of goroutines

Suppose we have netpoll implementation for Go. Now we can avoid starting the Channel.reader() goroutine with the inside buffer, and subscribe for the event of readable data in the connection:

ch := NewChannel(conn) // Make conn to be observed by netpoll instance. poller.Start(conn, netpoll.EventRead, func() { // We spawn goroutine here to prevent poller wait loop // to become locked during receiving packet from ch. go Receive(ch) }) // Receive reads a packet from conn and handles it somehow. func (ch *Channel) Receive() { buf := bufio.NewReader(ch.conn) pkt := readPacket(buf) c.handle(pkt) }

It is easier with the Channel.writer() because we can run the goroutine and allocate the buffer only when we are going to send the packet:

func (ch *Channel) Send(p Packet) { if c.noWriterYet() { go ch.writer() } ch.send <- p }
Note that we do not handle cases when operating system returns EAGAIN on write() system calls. We lean on Go runtime for such cases, cause it is actually rare for such kind of servers. Nevertheless, it could be handled in the same way if needed.

After reading the outgoing packets from ch.send (one or several), the writer will finish its operation and free the goroutine stack and the send buffer.

Perfect! We have saved 48 GB by getting rid of the stack and I/O buffers inside of two continuously running goroutines.

3.3. Control of resources

A great number of connections involves not only high memory consumption. When developing the server, we experienced repeated race conditions and deadlocks often followed by the so-called self-DDoS — a situation when the application clients rampantly tried to connect to the server thus breaking it even more.

For example, if for some reason we suddenly could not handle ping/pong messages, but the handler of idle connections continued to close such connections (supposing that the connections were broken and therefore provided no data), the client appeared to lose connection every N seconds and tried to connect again instead of waiting for events.

It would be great if the locked or overloaded server just stopped accepting new connections, and the balancer before it (for example, nginx) passed request to the next server instance.

Moreover, regardless of the server load, if all clients suddenly want to send us a packet for any reason (presumably by cause of bug), the previously saved 48 GB will be of use again, as we will actually get back to the initial state of the goroutine and the buffer per each connection.

Goroutine pool

We can restrict the number of packets handled simultaneously using a goroutine pool. This is what a naive implementation of such pool looks like:

package gopool func New(size int) *Pool { return &Pool{ work: make(chan func()), sem: make(chan struct{}, size), } } func (p *Pool) Schedule(task func()) error { select { case p.work <- task: case p.sem <- struct{}{}: go p.worker(task) } } func (p *Pool) worker(task func()) { defer func() { <-p.sem } for { task() task = <-p.work } }

Now our code with netpoll looks as follows:

pool := gopool.New(128) poller.Start(conn, netpoll.EventRead, func() { // We will block poller wait loop when // all pool workers are busy. pool.Schedule(func() { Receive(ch) }) })

So now we read the packet not only upon readable data appearance in the socket, but also upon the first opportunity to take up the free goroutine in the pool.

Similarly, we’ll change Send():

pool := gopool.New(128) func (ch *Channel) Send(p Packet) { if c.noWriterYet() { pool.Schedule(ch.writer) } ch.send <- p }

Instead of go ch.writer(), we want to write in one of the reused goroutines. Thus, for a pool of N goroutines, we can guarantee that with N requests handled simultaneously and the arrived N + 1 we will not allocate a N + 1 buffer for reading. The goroutine pool also allows us to limit Accept() and Upgrade() of new connections and to avoid most situations with DDoS.

3.4. Zero-copy upgrade

Let’s deviate a little from the WebSocket protocol. As was already mentioned, the client switches to the WebSocket protocol using a HTTP Upgrade request. This is what it looks like:

GET /ws HTTP/1.1 Host: mail.ru Connection: Upgrade Sec-Websocket-Key: A3xNe7sEB9HixkmBhVrYaA== Sec-Websocket-Version: 13 Upgrade: websocket HTTP/1.1 101 Switching Protocols Connection: Upgrade Sec-Websocket-Accept: ksu0wXWG+YmkVx+KQR2agP0cQn4= Upgrade: websocket

That is, in our case we need the HTTP request and its headers only for switch to the WebSocket protocol. This knowledge and what is stored inside the http.Request suggests that for the sake of optimization, we could probably refuse unnecessary allocations and copyings when processing HTTP requests and abandon the standard net/http server.

For example, the http.Request contains a field with the same-name Header type that is unconditionally filled with all request headers by copying data from the connection to the values strings. Imagine how much extra data could be kept inside this field, for example for a large-size Cookie header.

But what to take in return?

WebSocket implementation

Unfortunately, all libraries existing at the time of our server optimization allowed us to do upgrade only for the standard net/http server. Moreover, neither of the (two) libraries made it possible to use all the above read and write optimizations. For these optimizations to work, we must have a rather low-level API for working with WebSocket. To reuse the buffers, we need the procotol functions to look like this:

func ReadFrame(io.Reader) (Frame, error) func WriteFrame(io.Writer, Frame) error

If we had a library with such API, we could read packets from the connection as follows (the packet writing would look the same):

// getReadBuf, putReadBuf are intended to // reuse *bufio.Reader (with sync.Pool for example). func getReadBuf(io.Reader) *bufio.Reader func putReadBuf(*bufio.Reader) // readPacket must be called when data could be read from conn. func readPacket(conn io.Reader) error { buf := getReadBuf() defer putReadBuf(buf) buf.Reset(conn) frame, _ := ReadFrame(buf) parsePacket(frame.Payload) //... }

In short, it was time to make our own library.

github.com/gobwas/ws

Ideologically, the ws library was written so as not to impose its protocol operation logic on users. All reading and writing methods accept standard io.Reader and io.Writer interfaces, which makes it possible to use or not to use buffering or any other I/O wrappers.

Besides upgrade requests from standard net/http, ws supports zero-copy upgrade, the handling of upgrade requests and switching to WebSocket without memory allocations or copyings. ws.Upgrade() accepts io.ReadWriter (net.Conn implements this interface). In other words, we could use the standard net.Listen() and transfer the received connection from ln.Accept() immediately to ws.Upgrade(). The library makes it possible to copy any request data for future use in the application (for example, Cookie to verify the session).

Below there are benchmarks of Upgrade request processing: standard net/http server versus net.Listen() with zero-copy upgrade:

BenchmarkUpgradeHTTP 5156 ns/op 8576 B/op 9 allocs/op BenchmarkUpgradeTCP 973 ns/op 0 B/op 0 allocs/op

Switching to ws and zero-copy upgrade saved us another 24 GB — the space allocated for I/O buffers upon request processing by the net/http handler.

3.5. Summary

Let’s structure the optimizations I told you about.

  • A read goroutine with a buffer inside is expensive. Solution: netpoll (epoll, kqueue); reuse the buffers.
  • A write goroutine with a buffer inside is expensive. Solution: start the goroutine when necessary; reuse the buffers.
  • With a storm of connections, netpoll won’t work. Solution: reuse the goroutines with the limit on their number.
  • net/http is not the fastest way to handle Upgrade to WebSocket. Solution: use the zero-copy upgrade on bare TCP connection.

That is what the server code could look like:

import ( "net" "github.com/gobwas/ws" ) ln, _ := net.Listen("tcp", ":8080") for { // Try to accept incoming connection inside free pool worker. // If there no free workers for 1ms, do not accept anything and try later. // This will help us to prevent many self-ddos or out of resource limit cases. err := pool.ScheduleTimeout(time.Millisecond, func() { conn := ln.Accept() _ = ws.Upgrade(conn) // Wrap WebSocket connection with our Channel struct. // This will help us to handle/send our app's packets. ch := NewChannel(conn) // Wait for incoming bytes from connection. poller.Start(conn, netpoll.EventRead, func() { // Do not cross the resource limits. pool.Schedule(func() { // Read and handle incoming packet(s). ch.Recevie() }) }) }) if err != nil { time.Sleep(time.Millisecond) } }

4. Conclusion

Premature optimization is the root of all evil (or at least most of it) in programming. Donald Knuth

Of course, the above optimizations are relevant, but not in all cases. For example if the ratio between free resources (memory, CPU) and the number of online connections is rather high, there is probably no sense in optimizing. However, you can benefit a lot from knowing where and what to improve.

Thank you for your attention!

5. References

  • //github.com/mailru/easygo
  • //github.com/gobwas/ws
  • //github.com/gobwas/ws-examples
  • //github.com/gobwas/httphead
  • Russian version of this article