Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
pipe: add server backlog for concurrent Accept()
Teach `pipe.go:ListenPipe()` to create multiple instances of the server pipe in the kernel so that client connections are less likely to receive a `windows.ERROR_PIPE_BUSY` error. This is conceptually similar to the `backlog` argument of the Unix `listen(2)` function. The current `listenerRoutine()` function works sequentially and in response to calls to `Accept()`, such that there will never be more than one unbound server pipe in the NPFS present at any time. Even if the server application calls `Accept()` concurrrently from a pool of application threads, the `listenerRoutine()` will process them sequentially. In this model, because there is only one `listenerRoutine()` instance, there is an interval of time where there are no available unbound/free server pipes. This happens when `ConnectNamedPipe()` returns and `listenerRoutine()` sends the new pipe handle via a channel to the caller of `Accept()` where the application code has an opportunity to use the pipe or give it to another goroutine and then call `Accept()` again. The subsequent `Accept()` call causes `listenerRoutine()` to create a new unbound serer pipe instance in the file system and wait for the next connection. Anytime during this interval, a client will get a pipe busy error. Code in `DialPipe()` hides this from GOLANG callers because it includes a busy-retry loop. However, clients written in other languages without this assistance are likely to see the busy error and be forced deal with it. This change introduces an "accept queue" using a buffered channel and splits `listenerRoutine()` into a pool of listener worker threads. Each worker creates a new unbound pipe instance in the file system and waits for a client connection. The NPFS and kernel handle connection delivery to a random listener worker. The resulting connected pipe is then delivered back to the caller of `Accept()` as before. A `PipeConfig.QueueSize` variable controls the number of listener worker threads and the maximum number of unbound/free pipes server pipes that will be present at any given time. Note that a listener worker will normally have an unbound/free pipe except during that same delivery interval. Having multiple active workers (and unbound pipes in the file system) gives us extra capacity to handle rapidly arriving connections and minimizes the odds of a client seeing a busy error. The application is encouraged to call `Accept()` from a pool of application workers. The size of the application pool should be the same or larger than the queue size to take full advantage of the listener queue. To preserve backwards compatibility, a queue size of 0 or 1 will behave as before. Also for backwards compatibility, listener workers are required to wait for an `Accept()` call so that the worker has a return channel to send the connected pipe and/or error code. This implies that the number of unbound pipes will be the smaller of the queue size and the application pool size. Finally, a Mutex was added to `l.Close()` to ensure that concurrent threads do not simultaneously try to shutdown the pipe. Signed-off-by: Jeff Hostetler <jeffhostetler@github.com>
- Loading branch information