io: retry fgets on EINTR (#7632)

The calls to `fgets` in `src/nvim/if_cscope.c` (and elsewhere) can show
communication errors to the user if a signal is delivered during its
system calls. For plugins that proxy subprocess output into cscope
requests, a `SIGCHLD` might *always* interfere with calls into `fgets`.

To see this in a debugger, put a breakpoint on `cs_reading_emsg` and
watch signals come in (with lldb, using `process handle --notify true
--pass true`).  Next, run a subcommand from neovim that calls through
cscope when it returns.  A tag picker plugin, like vim-picker and fzy,
with `cscopetag` and `cscopetagorder=0` set, reproduced this reliably.
The breakpoint will hit after a `SIGCHLD` is delivered, and `errno` will
be set to 4, `EINTR`.

The caller of `fgets` should retry when `NULL` is returned with `errno`
set to `EINTR`.
This commit is contained in:
Matt Widmann
2017-11-25 13:59:07 -08:00
parent d9b3ebfede
commit 0f9c90e0ed
4 changed files with 43 additions and 5 deletions

View File

@@ -3199,8 +3199,14 @@ static char_u *get_one_sourceline(struct source_cookie *sp)
ga_grow(&ga, 120); ga_grow(&ga, 120);
buf = (char_u *)ga.ga_data; buf = (char_u *)ga.ga_data;
retry:
errno = 0;
if (fgets((char *)buf + ga.ga_len, ga.ga_maxlen - ga.ga_len, if (fgets((char *)buf + ga.ga_len, ga.ga_maxlen - ga.ga_len,
sp->fp) == NULL) { sp->fp) == NULL) {
if (errno == EINTR) {
goto retry;
}
break; break;
} }
len = ga.ga_len + (int)STRLEN(buf + ga.ga_len); len = ga.ga_len + (int)STRLEN(buf + ga.ga_len);

View File

@@ -4448,7 +4448,12 @@ bool vim_fgets(char_u *buf, int size, FILE *fp) FUNC_ATTR_NONNULL_ALL
char tbuf[FGETS_SIZE]; char tbuf[FGETS_SIZE];
buf[size - 2] = NUL; buf[size - 2] = NUL;
retry:
errno = 0;
eof = fgets((char *)buf, size, fp); eof = fgets((char *)buf, size, fp);
if (eof == NULL && errno == EINTR) {
goto retry;
}
if (buf[size - 2] != NUL && buf[size - 2] != '\n') { if (buf[size - 2] != NUL && buf[size - 2] != '\n') {
buf[size - 1] = NUL; /* Truncate the line */ buf[size - 1] = NUL; /* Truncate the line */

View File

@@ -553,9 +553,15 @@ static int cs_cnt_matches(size_t idx)
char *buf = xmalloc(CSREAD_BUFSIZE); char *buf = xmalloc(CSREAD_BUFSIZE);
for (;; ) { for (;; ) {
errno = 0;
if (!fgets(buf, CSREAD_BUFSIZE, csinfo[idx].fr_fp)) { if (!fgets(buf, CSREAD_BUFSIZE, csinfo[idx].fr_fp)) {
if (feof(csinfo[idx].fr_fp)) if (errno == EINTR) {
continue;
}
if (feof(csinfo[idx].fr_fp)) {
errno = EIO; errno = EIO;
}
cs_reading_emsg(idx); cs_reading_emsg(idx);
@@ -1381,9 +1387,16 @@ static char *cs_parse_results(size_t cnumber, char *buf, int bufsize,
char *p; char *p;
char *name; char *name;
retry:
errno = 0;
if (fgets(buf, bufsize, csinfo[cnumber].fr_fp) == NULL) { if (fgets(buf, bufsize, csinfo[cnumber].fr_fp) == NULL) {
if (feof(csinfo[cnumber].fr_fp)) if (errno == EINTR) {
goto retry;
}
if (feof(csinfo[cnumber].fr_fp)) {
errno = EIO; errno = EIO;
}
cs_reading_emsg(cnumber); cs_reading_emsg(cnumber);

View File

@@ -570,7 +570,12 @@ static int qf_get_next_file_line(qfstate_T *state)
{ {
size_t growbuflen; size_t growbuflen;
retry:
errno = 0;
if (fgets((char *)IObuff, IOSIZE, state->fd) == NULL) { if (fgets((char *)IObuff, IOSIZE, state->fd) == NULL) {
if (errno == EINTR) {
goto retry;
}
return QF_END_OF_INPUT; return QF_END_OF_INPUT;
} }
@@ -590,8 +595,12 @@ static int qf_get_next_file_line(qfstate_T *state)
growbuflen = state->linelen; growbuflen = state->linelen;
for (;;) { for (;;) {
errno = 0;
if (fgets((char *)state->growbuf + growbuflen, if (fgets((char *)state->growbuf + growbuflen,
(int)(state->growbufsiz - growbuflen), state->fd) == NULL) { (int)(state->growbufsiz - growbuflen), state->fd) == NULL) {
if (errno == EINTR) {
continue;
}
break; break;
} }
state->linelen = STRLEN(state->growbuf + growbuflen); state->linelen = STRLEN(state->growbuf + growbuflen);
@@ -612,9 +621,14 @@ static int qf_get_next_file_line(qfstate_T *state)
while (discard) { while (discard) {
// The current line is longer than LINE_MAXLEN, continue reading but // The current line is longer than LINE_MAXLEN, continue reading but
// discard everything until EOL or EOF is reached. // discard everything until EOL or EOF is reached.
if (fgets((char *)IObuff, IOSIZE, state->fd) == NULL errno = 0;
|| STRLEN(IObuff) < IOSIZE - 1 if (fgets((char *)IObuff, IOSIZE, state->fd) == NULL) {
|| IObuff[IOSIZE - 1] == '\n') { if (errno == EINTR) {
continue;
}
break;
}
if (STRLEN(IObuff) < IOSIZE - 1 || IObuff[IOSIZE - 1] == '\n') {
break; break;
} }
} }