source3/lib/select.c

   1 /*
   2    Unix SMB/Netbios implementation.
   3    Version 3.0
   4    Samba select/poll implementation
   5    Copyright (C) Andrew Tridgell 1992-1998
   6
   7    This program is free software; you can redistribute it and/or modify
   8    it under the terms of the GNU General Public License as published by
   9    the Free Software Foundation; either version 3 of the License, or
  10    (at your option) any later version.
  11
  12    This program is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15    GNU General Public License for more details.
  16
  17    You should have received a copy of the GNU General Public License
  18    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19 */
  20
  21 #include "includes.h"
  22
  23 /* This is here because it allows us to avoid a nasty race in signal handling.
  24    We need to guarantee that when we get a signal we get out of a select immediately
  25    but doing that involves a race condition. We can avoid the race by getting the
  26    signal handler to write to a pipe that is in the select/poll list
  27
  28    This means all Samba signal handlers should call sys_select_signal().
  29 */
  30
  31 static pid_t initialised;
  32 static int select_pipe[2];
  33 static VOLATILE unsigned pipe_written, pipe_read;
  34
  35 /*******************************************************************
  36  Call this from all Samba signal handlers if you want to avoid a
  37  nasty signal race condition.
  38 ********************************************************************/
  39
  40 void sys_select_signal(char c)
  41 {
  42         if (!initialised) return;
  43
  44         if (pipe_written > pipe_read+256) return;
  45
  46         if (write(select_pipe[1], &c, 1) == 1) pipe_written++;
  47 }
  48
  49 /*******************************************************************
  50  Like select() but avoids the signal race using a pipe
  51  it also guuarantees that fds on return only ever contains bits set
  52  for file descriptors that were readable.
  53 ********************************************************************/
  54
  55 int sys_select(int maxfd, fd_set *readfds, fd_set *writefds, fd_set *errorfds, struct timeval *tval)
  56 {
  57         int ret, saved_errno;
  58         fd_set *readfds2, readfds_buf;
  59
  60         if (initialised != sys_getpid()) {
  61                 pipe(select_pipe);
  62
  63                 /*
  64                  * These next two lines seem to fix a bug with the Linux
  65                  * 2.0.x kernel (and probably other UNIXes as well) where
  66                  * the one byte read below can block even though the
  67                  * select returned that there is data in the pipe and
  68                  * the pipe_written variable was incremented. Thanks to
  69                  * HP for finding this one. JRA.
  70                  */
  71
  72                 if(set_blocking(select_pipe[0],0)==-1)
  73                         smb_panic("select_pipe[0]: O_NONBLOCK failed");
  74                 if(set_blocking(select_pipe[1],0)==-1)
  75                         smb_panic("select_pipe[1]: O_NONBLOCK failed");
  76
  77                 initialised = sys_getpid();
  78         }
  79
  80         maxfd = MAX(select_pipe[0]+1, maxfd);
  81
  82         /* If readfds is NULL we need to provide our own set. */
  83         if (readfds) {
  84                 readfds2 = readfds;
  85         } else {
  86                 readfds2 = &readfds_buf;
  87                 FD_ZERO(readfds2);
  88         }
  89         FD_SET(select_pipe[0], readfds2);
  90
  91         errno = 0;
  92         ret = select(maxfd,readfds2,writefds,errorfds,tval);
  93
  94         if (ret <= 0) {
  95                 FD_ZERO(readfds2);
  96                 if (writefds)
  97                         FD_ZERO(writefds);
  98                 if (errorfds)
  99                         FD_ZERO(errorfds);
 100         } else if (FD_ISSET(select_pipe[0], readfds2)) {
 101                 char c;
 102                 saved_errno = errno;
 103                 if (read(select_pipe[0], &c, 1) == 1) {
 104                         pipe_read++;
 105                         /* Mark Weaver <mark-clist@npsl.co.uk> pointed out a critical
 106                            fix to ensure we don't lose signals. We must always
 107                            return -1 when the select pipe is set, otherwise if another
 108                            fd is also ready (so ret == 2) then we used to eat the
 109                            byte in the pipe and lose the signal. JRA.
 110                         */
 111                         ret = -1;
 112 #if 0
 113                         /* JRA - we can use this to debug the signal messaging... */
 114                         DEBUG(0,("select got %u signal\n", (unsigned int)c));
 115 #endif
 116                         errno = EINTR;
 117                 } else {
 118                         FD_CLR(select_pipe[0], readfds2);
 119                         ret--;
 120                         errno = saved_errno;
 121                 }
 122         }
 123
 124         return ret;
 125 }
 126
 127 /*******************************************************************
 128  Similar to sys_select() but catch EINTR and continue.
 129  This is what sys_select() used to do in Samba.
 130 ********************************************************************/
 131
 132 int sys_select_intr(int maxfd, fd_set *readfds, fd_set *writefds, fd_set *errorfds, struct timeval *tval)
 133 {
 134         int ret;
 135         fd_set *readfds2, readfds_buf, *writefds2, writefds_buf, *errorfds2, errorfds_buf;
 136         struct timeval tval2, *ptval, end_time;
 137
 138         readfds2 = (readfds ? &readfds_buf : NULL);
 139         writefds2 = (writefds ? &writefds_buf : NULL);
 140         errorfds2 = (errorfds ? &errorfds_buf : NULL);
 141         if (tval) {
 142                 GetTimeOfDay(&end_time);
 143                 end_time.tv_sec += tval->tv_sec;
 144                 end_time.tv_usec += tval->tv_usec;
 145                 end_time.tv_sec += end_time.tv_usec / 1000000;
 146                 end_time.tv_usec %= 1000000;
 147                 errno = 0;
 148                 tval2 = *tval;
 149                 ptval = &tval2;
 150         } else {
 151                 ptval = NULL;
 152         }
 153
 154         do {
 155                 if (readfds)
 156                         readfds_buf = *readfds;
 157                 if (writefds)
 158                         writefds_buf = *writefds;
 159                 if (errorfds)
 160                         errorfds_buf = *errorfds;
 161                 if (ptval && (errno == EINTR)) {
 162                         struct timeval now_time;
 163                         SMB_BIG_INT tdif;
 164
 165                         GetTimeOfDay(&now_time);
 166                         tdif = usec_time_diff(&end_time, &now_time);
 167                         if (tdif <= 0) {
 168                                 ret = 0; /* time expired. */
 169                                 break;
 170                         }
 171                         ptval->tv_sec = tdif / 1000000;
 172                         ptval->tv_usec = tdif % 1000000;
 173                 }
 174
 175                 /* We must use select and not sys_select here. If we use
 176                    sys_select we'd lose the fact a signal occurred when sys_select
 177                    read a byte from the pipe. Fix from Mark Weaver
 178                    <mark-clist@npsl.co.uk>
 179                 */
 180                 ret = select(maxfd, readfds2, writefds2, errorfds2, ptval);
 181         } while (ret == -1 && errno == EINTR);
 182
 183         if (readfds)
 184                 *readfds = readfds_buf;
 185         if (writefds)
 186                 *writefds = writefds_buf;
 187         if (errorfds)
 188                 *errorfds = errorfds_buf;
 189
 190         return ret;
 191 }