Mercurial > prosody-hg
annotate util/queue.lua @ 13652:a08065207ef0
net.server_epoll: Call :shutdown() on TLS sockets when supported
Comment from Matthew:
This fixes a potential issue where the Prosody process gets blocked on sockets
waiting for them to close. Unlike non-TLS sockets, closing a TLS socket sends
layer 7 data, and this can cause problems for sockets which are in the process
of being cleaned up.
This depends on LuaSec changes which are not yet upstream.
From Martijn's original email:
So first my analysis of luasec. in ssl.c the socket is put into blocking
mode right before calling SSL_shutdown() inside meth_destroy(). My best
guess to why this is is because meth_destroy is linked to the __close
and __gc methods, which can't exactly be called multiple times and
luasec does want to make sure that a tls session is shutdown as clean
as possible.
I can't say I disagree with this reasoning and don't want to change this
behaviour. My solution to this without changing the current behaviour is
to introduce a shutdown() method. I am aware that this overlaps in a
conflicting way with tcp's shutdown method, but it stays close to the
OpenSSL name. This method calls SSL_shutdown() in the current
(non)blocking mode of the underlying socket and returns a boolean
whether or not the shutdown is completed (matching SSL_shutdown()'s 0
or 1 return values), and returns the familiar ssl_ioerror() strings on
error with a false for completion. This error can then be used to
determine if we have wantread/wantwrite to finalize things. Once
meth_shutdown() has been called once a shutdown flag will be set, which
indicates to meth_destroy() that the SSL_shutdown() has been handled
by the application and it shouldn't be needed to set the socket to
blocking mode. I've left the SSL_shutdown() call in the
LSEC_STATE_CONNECTED to prevent TOCTOU if the application reaches a
timeout for the shutdown code, which might allow SSL_shutdown() to
clean up anyway at the last possible moment.
Another thing I've changed to luasec is the call to socket_setblocking()
right before calling close(2) in socket_destroy() in usocket.c.
According to the latest POSIX[0]:
Note that the requirement for close() on a socket to block for up to
the current linger interval is not conditional on the O_NONBLOCK
setting.
Which I read to mean that removing O_NONBLOCK on the socket before close
doesn't impact the behaviour and only causes noise in system call
tracers. I didn't touch the windows bits of this, since I don't do
windows.
For the prosody side of things I've made the TLS shutdown bits resemble
interface:onwritable(), and put it under a combined guard of self._tls
and self.conn.shutdown. The self._tls bit is there to prevent getting
stuck on this condition, and self.conn.shutdown is there to prevent the
code being called by instances where the patched luasec isn't deployed.
The destroy() method can be called from various places and is read by
me as the "we give up" error path. To accommodate for these unexpected
entrypoints I've added a single call to self.conn:shutdown() to prevent
the socket being put into blocking mode. I have no expectations that
there is any other use here. Same as previous, the self.conn.shutdown
check is there to make sure it's not called on unpatched luasec
deployments and self._tls is there to make sure we don't call shutdown()
on tcp sockets.
I wouldn't recommend logging of the conn:shutdown() error inside
close(), since a lot of clients simply close the connection before
SSL_shutdown() is done.
| author | Martijn van Duren <martijn@openbsd.org> |
|---|---|
| date | Thu, 06 Feb 2025 15:04:38 +0000 |
| parents | d10957394a3c |
| children | f50a9746fec0 |
| rev | line source |
|---|---|
|
6678
343ca80ceb36
util.queue: Small fast FIFO/ringbuffer/queue library
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
1 -- Prosody IM |
|
343ca80ceb36
util.queue: Small fast FIFO/ringbuffer/queue library
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
2 -- Copyright (C) 2008-2015 Matthew Wild |
|
343ca80ceb36
util.queue: Small fast FIFO/ringbuffer/queue library
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
3 -- Copyright (C) 2008-2015 Waqas Hussain |
|
343ca80ceb36
util.queue: Small fast FIFO/ringbuffer/queue library
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
4 -- |
|
343ca80ceb36
util.queue: Small fast FIFO/ringbuffer/queue library
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
5 -- This project is MIT/X11 licensed. Please see the |
|
343ca80ceb36
util.queue: Small fast FIFO/ringbuffer/queue library
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
6 -- COPYING file in the source package for more information. |
|
343ca80ceb36
util.queue: Small fast FIFO/ringbuffer/queue library
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
7 -- |
|
343ca80ceb36
util.queue: Small fast FIFO/ringbuffer/queue library
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
8 |
|
343ca80ceb36
util.queue: Small fast FIFO/ringbuffer/queue library
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
9 -- Small ringbuffer library (i.e. an efficient FIFO queue with a size limit) |
|
343ca80ceb36
util.queue: Small fast FIFO/ringbuffer/queue library
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
10 -- (because unbounded dynamically-growing queues are a bad thing...) |
|
343ca80ceb36
util.queue: Small fast FIFO/ringbuffer/queue library
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
11 |
|
12975
d10957394a3c
util: Prefix module imports with prosody namespace
Kim Alvefur <zash@zash.se>
parents:
11114
diff
changeset
|
12 local have_utable, utable = pcall(require, "prosody.util.table"); -- For pre-allocation of table |
|
6678
343ca80ceb36
util.queue: Small fast FIFO/ringbuffer/queue library
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
13 |
|
6731
d4a6c9ee4bc5
util.queue: Allow optional wrap-around when pushing, overwriting oldest unread item
Matthew Wild <mwild1@gmail.com>
parents:
6678
diff
changeset
|
14 local function new(size, allow_wrapping) |
|
6678
343ca80ceb36
util.queue: Small fast FIFO/ringbuffer/queue library
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
15 -- Head is next insert, tail is next read |
|
343ca80ceb36
util.queue: Small fast FIFO/ringbuffer/queue library
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
16 local head, tail = 1, 1; |
|
343ca80ceb36
util.queue: Small fast FIFO/ringbuffer/queue library
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
17 local items = 0; -- Number of stored items |
|
343ca80ceb36
util.queue: Small fast FIFO/ringbuffer/queue library
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
18 local t = have_utable and utable.create(size, 0) or {}; -- Table to hold items |
|
6912
cb5b14c95b7b
util.queue: Add luacheck annotations
Matthew Wild <mwild1@gmail.com>
parents:
6911
diff
changeset
|
19 --luacheck: ignore 212/self |
|
6678
343ca80ceb36
util.queue: Small fast FIFO/ringbuffer/queue library
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
20 return { |
|
6911
56c9bc4ba247
util.queue: Add :items() iterator
Matthew Wild <mwild1@gmail.com>
parents:
6731
diff
changeset
|
21 _items = t; |
|
6678
343ca80ceb36
util.queue: Small fast FIFO/ringbuffer/queue library
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
22 size = size; |
|
343ca80ceb36
util.queue: Small fast FIFO/ringbuffer/queue library
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
23 count = function (self) return items; end; |
|
343ca80ceb36
util.queue: Small fast FIFO/ringbuffer/queue library
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
24 push = function (self, item) |
|
343ca80ceb36
util.queue: Small fast FIFO/ringbuffer/queue library
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
25 if items >= size then |
|
6731
d4a6c9ee4bc5
util.queue: Allow optional wrap-around when pushing, overwriting oldest unread item
Matthew Wild <mwild1@gmail.com>
parents:
6678
diff
changeset
|
26 if allow_wrapping then |
|
d4a6c9ee4bc5
util.queue: Allow optional wrap-around when pushing, overwriting oldest unread item
Matthew Wild <mwild1@gmail.com>
parents:
6678
diff
changeset
|
27 tail = (tail%size)+1; -- Advance to next oldest item |
|
d4a6c9ee4bc5
util.queue: Allow optional wrap-around when pushing, overwriting oldest unread item
Matthew Wild <mwild1@gmail.com>
parents:
6678
diff
changeset
|
28 items = items - 1; |
|
d4a6c9ee4bc5
util.queue: Allow optional wrap-around when pushing, overwriting oldest unread item
Matthew Wild <mwild1@gmail.com>
parents:
6678
diff
changeset
|
29 else |
|
d4a6c9ee4bc5
util.queue: Allow optional wrap-around when pushing, overwriting oldest unread item
Matthew Wild <mwild1@gmail.com>
parents:
6678
diff
changeset
|
30 return nil, "queue full"; |
|
d4a6c9ee4bc5
util.queue: Allow optional wrap-around when pushing, overwriting oldest unread item
Matthew Wild <mwild1@gmail.com>
parents:
6678
diff
changeset
|
31 end |
|
6678
343ca80ceb36
util.queue: Small fast FIFO/ringbuffer/queue library
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
32 end |
|
343ca80ceb36
util.queue: Small fast FIFO/ringbuffer/queue library
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
33 t[head] = item; |
|
343ca80ceb36
util.queue: Small fast FIFO/ringbuffer/queue library
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
34 items = items + 1; |
|
343ca80ceb36
util.queue: Small fast FIFO/ringbuffer/queue library
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
35 head = (head%size)+1; |
|
343ca80ceb36
util.queue: Small fast FIFO/ringbuffer/queue library
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
36 return true; |
|
343ca80ceb36
util.queue: Small fast FIFO/ringbuffer/queue library
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
37 end; |
|
343ca80ceb36
util.queue: Small fast FIFO/ringbuffer/queue library
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
38 pop = function (self) |
|
343ca80ceb36
util.queue: Small fast FIFO/ringbuffer/queue library
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
39 if items == 0 then |
|
343ca80ceb36
util.queue: Small fast FIFO/ringbuffer/queue library
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
40 return nil; |
|
343ca80ceb36
util.queue: Small fast FIFO/ringbuffer/queue library
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
41 end |
|
343ca80ceb36
util.queue: Small fast FIFO/ringbuffer/queue library
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
42 local item; |
|
343ca80ceb36
util.queue: Small fast FIFO/ringbuffer/queue library
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
43 item, t[tail] = t[tail], 0; |
|
343ca80ceb36
util.queue: Small fast FIFO/ringbuffer/queue library
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
44 tail = (tail%size)+1; |
|
343ca80ceb36
util.queue: Small fast FIFO/ringbuffer/queue library
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
45 items = items - 1; |
|
343ca80ceb36
util.queue: Small fast FIFO/ringbuffer/queue library
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
46 return item; |
|
343ca80ceb36
util.queue: Small fast FIFO/ringbuffer/queue library
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
47 end; |
|
343ca80ceb36
util.queue: Small fast FIFO/ringbuffer/queue library
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
48 peek = function (self) |
|
343ca80ceb36
util.queue: Small fast FIFO/ringbuffer/queue library
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
49 if items == 0 then |
|
343ca80ceb36
util.queue: Small fast FIFO/ringbuffer/queue library
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
50 return nil; |
|
343ca80ceb36
util.queue: Small fast FIFO/ringbuffer/queue library
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
51 end |
|
343ca80ceb36
util.queue: Small fast FIFO/ringbuffer/queue library
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
52 return t[tail]; |
|
343ca80ceb36
util.queue: Small fast FIFO/ringbuffer/queue library
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
53 end; |
|
11103
73b8aaf55775
util.dbuffer: dynamic string buffer
Matthew Wild <mwild1@gmail.com>
parents:
6912
diff
changeset
|
54 replace = function (self, data) |
|
73b8aaf55775
util.dbuffer: dynamic string buffer
Matthew Wild <mwild1@gmail.com>
parents:
6912
diff
changeset
|
55 if items == 0 then |
|
73b8aaf55775
util.dbuffer: dynamic string buffer
Matthew Wild <mwild1@gmail.com>
parents:
6912
diff
changeset
|
56 return self:push(data); |
|
73b8aaf55775
util.dbuffer: dynamic string buffer
Matthew Wild <mwild1@gmail.com>
parents:
6912
diff
changeset
|
57 end |
|
73b8aaf55775
util.dbuffer: dynamic string buffer
Matthew Wild <mwild1@gmail.com>
parents:
6912
diff
changeset
|
58 t[tail] = data; |
|
73b8aaf55775
util.dbuffer: dynamic string buffer
Matthew Wild <mwild1@gmail.com>
parents:
6912
diff
changeset
|
59 return true; |
|
73b8aaf55775
util.dbuffer: dynamic string buffer
Matthew Wild <mwild1@gmail.com>
parents:
6912
diff
changeset
|
60 end; |
|
6911
56c9bc4ba247
util.queue: Add :items() iterator
Matthew Wild <mwild1@gmail.com>
parents:
6731
diff
changeset
|
61 items = function (self) |
|
9926
1bfd28e774db
util.queue: Update :items() to consistently use private data directly
Matthew Wild <mwild1@gmail.com>
parents:
9925
diff
changeset
|
62 return function (_, pos) |
|
1bfd28e774db
util.queue: Update :items() to consistently use private data directly
Matthew Wild <mwild1@gmail.com>
parents:
9925
diff
changeset
|
63 if pos >= items then |
|
6911
56c9bc4ba247
util.queue: Add :items() iterator
Matthew Wild <mwild1@gmail.com>
parents:
6731
diff
changeset
|
64 return nil; |
|
56c9bc4ba247
util.queue: Add :items() iterator
Matthew Wild <mwild1@gmail.com>
parents:
6731
diff
changeset
|
65 end |
|
56c9bc4ba247
util.queue: Add :items() iterator
Matthew Wild <mwild1@gmail.com>
parents:
6731
diff
changeset
|
66 local read_pos = tail + pos; |
|
9926
1bfd28e774db
util.queue: Update :items() to consistently use private data directly
Matthew Wild <mwild1@gmail.com>
parents:
9925
diff
changeset
|
67 if read_pos > self.size then |
|
6911
56c9bc4ba247
util.queue: Add :items() iterator
Matthew Wild <mwild1@gmail.com>
parents:
6731
diff
changeset
|
68 read_pos = (read_pos%size); |
|
56c9bc4ba247
util.queue: Add :items() iterator
Matthew Wild <mwild1@gmail.com>
parents:
6731
diff
changeset
|
69 end |
|
9926
1bfd28e774db
util.queue: Update :items() to consistently use private data directly
Matthew Wild <mwild1@gmail.com>
parents:
9925
diff
changeset
|
70 return pos+1, t[read_pos]; |
|
6911
56c9bc4ba247
util.queue: Add :items() iterator
Matthew Wild <mwild1@gmail.com>
parents:
6731
diff
changeset
|
71 end, self, 0; |
|
56c9bc4ba247
util.queue: Add :items() iterator
Matthew Wild <mwild1@gmail.com>
parents:
6731
diff
changeset
|
72 end; |
|
9901
c8b75239846c
util.queue: Add 'consume()' convenience iterator
Matthew Wild <mwild1@gmail.com>
parents:
6912
diff
changeset
|
73 consume = function (self) |
|
c8b75239846c
util.queue: Add 'consume()' convenience iterator
Matthew Wild <mwild1@gmail.com>
parents:
6912
diff
changeset
|
74 return self.pop, self; |
|
c8b75239846c
util.queue: Add 'consume()' convenience iterator
Matthew Wild <mwild1@gmail.com>
parents:
6912
diff
changeset
|
75 end; |
|
6678
343ca80ceb36
util.queue: Small fast FIFO/ringbuffer/queue library
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
76 }; |
|
343ca80ceb36
util.queue: Small fast FIFO/ringbuffer/queue library
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
77 end |
|
343ca80ceb36
util.queue: Small fast FIFO/ringbuffer/queue library
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
78 |
|
343ca80ceb36
util.queue: Small fast FIFO/ringbuffer/queue library
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
79 return { |
|
343ca80ceb36
util.queue: Small fast FIFO/ringbuffer/queue library
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
80 new = new; |
|
343ca80ceb36
util.queue: Small fast FIFO/ringbuffer/queue library
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
81 }; |
|
343ca80ceb36
util.queue: Small fast FIFO/ringbuffer/queue library
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
82 |
