POLLHUP polling
This page is a work in progress
Recently I've been trying to listen on multiple sockets at once for events like reading or writing. This has worked fine, but as I've tried to listen for a socket close event I've found the documentation poor and often contradictory. This page is my attempt to figure this topic out.
POSIX
POSIX specifies two functions for waiting on multiple file descriptors:
- select which originates from the BSD sockets API
- poll which originates from the System V STREAMS API
select doesn't specify anything to do with sockets being closed, so that's not too useful.
poll initially looks like it's better but it leaves a lot of questions after reading:
- Does POLLHUP apply to sockets?
- Can the events field be 0 and still get POLLHUP events?
- Under what conditions do we even get return events?
I highly recommend trying to read the poll standard and sussing out these details.
As far as I can tell nobody has brought up either of these questions during the standards process. At least in these sources:
- Aardvark defect reports for The Austin Group Specification
- Austin Group Defect Tracker
- Austin Group Document Register
- austin-group-l mailing list
The only talk of this issue I've found online is the 2001 email "poll() and events==0" which has no clear answers.
Existing lore
Richard Kettlewell's poll() and EOF has a test results for the case of setting POLLIN and closing a socket with no data to read. This is the most common case of POLLHUP use I see online.
The test results give us some interesting data:
- The first is that POLLIN is often set if a socket is closed. If set alone this means a POLLIN poll without any return events may mean you still can't read from the socket
- The second is that POLLHUP is often not set on older systems. This means programs polling POLLOUT may miss socket closures altogether. This is one reason why systems are moving to set POLLHUP instead of just POLLIN
- The third is that neither are always set. Cygwin and very early Linux systems only set POLLHUP. This seems like a bug to me especially as most online advice recommend watching POLLIN for socket closures when writing portable programs
This data doesn't check what poll returns if there's still data in the socket to read but the connection has closed. That case may have entirely different results.
Another issue is what to return if a socket was never connected in the first place?
Test code
I wrote this quick program that tests what happens when you poll a closed socket with or without data with various event flags.
/* compile and run with gcc test.c -oTEST && ./TEST */
#include <stdio.h>
#include <errno.h>
#include <poll.h>
#include <sys/socket.h>
#include <unistd.h>
#include <string.h>
short do_test(short events, const char *data) {
/* create a socket pair, one end for parent, one end for child */
int sockets[2];
int rc;
rc = socketpair(AF_UNIX, SOCK_STREAM, 0, sockets);
if(rc == -1) { printf("socket err %i\n", errno); return 1; }
if(data) {
rc = write(sockets[1], data, strlen(data));
if(rc == -1) { printf("write err %i\n", errno); return 1; }
}
rc = close(sockets[1]); /* close one end */
if(rc == -1) { printf("close err %i\n", errno); return 1; }
/* poll for events */
struct pollfd fd;
fd.fd = sockets[0]; /* watch other end */
fd.events = events;
fd.revents = 0;
rc = poll(&fd, 1, 10000);
if(rc < 1) { printf("poll err %i\n", errno); return 1; }
printf("do_test events %x data %p: %0x\n", events, data, fd.revents);
}
void do_multitest(const char* str) {
do_test(0, str);
do_test(POLLIN, str);
do_test(POLLOUT, str);
do_test(POLLIN|POLLOUT, str);
do_test(POLLIN|POLLOUT|POLLPRI|POLLHUP|POLLERR|POLLNVAL, str);
}
int main(void) {
printf("POLLIN: %x POLLOUT: %x POLLHUP: %x\n", POLLIN, POLLOUT, POLLHUP);
do_multitest(NULL);
do_multitest("hello world");
return 0;
}
It's a bit nasty but it seems to get the job done to verify behaviour.
Linux
https://man7.org/linux/man-pages/man2/poll.2.html
"The field fd contains a file descriptor for an open file."
"The field events is an input parameter, a bit mask specifying the events the application is interested in for the file descriptor fd. This field may be specified as zero, in which case the only events that can be returned in revents are POLLHUP, POLLERR, and POLLNVAL (see below)."
"POLLHUP - Hang up (only returned in revents; ignored in events). Note that when reading from a channel such as a pipe or a stream socket, this event merely indicates that the peer closed its end of the channel."
"If none of the events requested (and no error) has occurred for any of the file descriptors, then poll() blocks until one of the events occurs."
POLLRDHUP can be ignored
Linux's poll implementation
when did poll get added? how does it work?
Unix
- sysv
- sunos
BSDs
- netbsd
- freebsd
- openbsd
- illumos
- macos
Windows
wsapoll
Emulation
cygwin
minix
my dosbox code :(