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         int saved_errno = errno;
  43
  44         if (!initialised) return;
  45
  46         if (pipe_written > pipe_read+256) return;
  47
  48         if (write(select_pipe[1], &c, 1) == 1) pipe_written++;
  49
  50         errno = saved_errno;
  51 }
  52
  53 /*******************************************************************
  54  Like select() but avoids the signal race using a pipe
  55  it also guuarantees that fds on return only ever contains bits set
  56  for file descriptors that were readable.
  57 ********************************************************************/
  58
  59 int sys_select(int maxfd, fd_set *readfds, fd_set *writefds, fd_set *errorfds, struct timeval *tval)
  60 {
  61         int ret, saved_errno;
  62         fd_set *readfds2, readfds_buf;
  63
  64         if (initialised != sys_getpid()) {
  65                 if (pipe(select_pipe) == -1)
  66                 {
  67                         DEBUG(0, ("sys_select: pipe failed (%s)\n",
  68                                 strerror(errno)));
  69                         if (readfds != NULL)
  70                                 FD_ZERO(readfds);
  71                         if (writefds != NULL)
  72                                 FD_ZERO(writefds);
  73                         if (errorfds != NULL)
  74                                 FD_ZERO(errorfds);
  75                         return -1;
  76                 }
  77
  78                 if (select_pipe[0] < 0 || select_pipe[0] >= FD_SETSIZE) {
  79                         DEBUG(0, ("sys_select: bad fd\n"));
  80                         if (readfds != NULL)
  81                                 FD_ZERO(readfds);
  82                         if (writefds != NULL)
  83                                 FD_ZERO(writefds);
  84                         if (errorfds != NULL)
  85                                 FD_ZERO(errorfds);
  86                         errno = EBADF;
  87                         return -1;
  88                 }
  89                 /*
  90                  * These next two lines seem to fix a bug with the Linux
  91                  * 2.0.x kernel (and probably other UNIXes as well) where
  92                  * the one byte read below can block even though the
  93                  * select returned that there is data in the pipe and
  94                  * the pipe_written variable was incremented. Thanks to
  95                  * HP for finding this one. JRA.
  96                  */
  97
  98                 if(set_blocking(select_pipe[0],0)==-1)
  99                         smb_panic("select_pipe[0]: O_NONBLOCK failed");
 100                 if(set_blocking(select_pipe[1],0)==-1)
 101                         smb_panic("select_pipe[1]: O_NONBLOCK failed");
 102
 103                 initialised = sys_getpid();
 104         }
 105
 106         maxfd = MAX(select_pipe[0]+1, maxfd);
 107
 108         /* If readfds is NULL we need to provide our own set. */
 109         if (readfds) {
 110                 readfds2 = readfds;
 111         } else {
 112                 readfds2 = &readfds_buf;
 113                 FD_ZERO(readfds2);
 114         }
 115
 116         FD_SET(select_pipe[0], readfds2);
 117
 118         errno = 0;
 119         ret = select(maxfd,readfds2,writefds,errorfds,tval);
 120
 121         if (ret <= 0) {
 122                 FD_ZERO(readfds2);
 123                 if (writefds)
 124                         FD_ZERO(writefds);
 125                 if (errorfds)
 126                         FD_ZERO(errorfds);
 127         } else if (FD_ISSET(select_pipe[0], readfds2)) {
 128                 char c;
 129                 saved_errno = errno;
 130                 if (read(select_pipe[0], &c, 1) == 1) {
 131                         pipe_read++;
 132                         /* Mark Weaver <mark-clist@npsl.co.uk> pointed out a critical
 133                            fix to ensure we don't lose signals. We must always
 134                            return -1 when the select pipe is set, otherwise if another
 135                            fd is also ready (so ret == 2) then we used to eat the
 136                            byte in the pipe and lose the signal. JRA.
 137                         */
 138                         ret = -1;
 139 #if 0
 140                         /* JRA - we can use this to debug the signal messaging... */
 141                         DEBUG(0,("select got %u signal\n", (unsigned int)c));
 142 #endif
 143                         errno = EINTR;
 144                 } else {
 145                         FD_CLR(select_pipe[0], readfds2);
 146                         ret--;
 147                         errno = saved_errno;
 148                 }
 149         }
 150
 151         return ret;
 152 }
 153
 154 /*******************************************************************
 155  Similar to sys_select() but catch EINTR and continue.
 156  This is what sys_select() used to do in Samba.
 157 ********************************************************************/
 158
 159 int sys_select_intr(int maxfd, fd_set *readfds, fd_set *writefds, fd_set *errorfds, struct timeval *tval)
 160 {
 161         int ret;
 162         fd_set *readfds2, readfds_buf, *writefds2, writefds_buf, *errorfds2, errorfds_buf;
 163         struct timeval tval2, *ptval, end_time;
 164
 165         readfds2 = (readfds ? &readfds_buf : NULL);
 166         writefds2 = (writefds ? &writefds_buf : NULL);
 167         errorfds2 = (errorfds ? &errorfds_buf : NULL);
 168         if (tval) {
 169                 GetTimeOfDay(&end_time);
 170                 end_time.tv_sec += tval->tv_sec;
 171                 end_time.tv_usec += tval->tv_usec;
 172                 end_time.tv_sec += end_time.tv_usec / 1000000;
 173                 end_time.tv_usec %= 1000000;
 174                 errno = 0;
 175                 tval2 = *tval;
 176                 ptval = &tval2;
 177         } else {
 178                 ptval = NULL;
 179         }
 180
 181         do {
 182                 if (readfds)
 183                         readfds_buf = *readfds;
 184                 if (writefds)
 185                         writefds_buf = *writefds;
 186                 if (errorfds)
 187                         errorfds_buf = *errorfds;
 188                 if (ptval && (errno == EINTR)) {
 189                         struct timeval now_time;
 190                         int64_t tdif;
 191
 192                         GetTimeOfDay(&now_time);
 193                         tdif = usec_time_diff(&end_time, &now_time);
 194                         if (tdif <= 0) {
 195                                 ret = 0; /* time expired. */
 196                                 break;
 197                         }
 198                         ptval->tv_sec = tdif / 1000000;
 199                         ptval->tv_usec = tdif % 1000000;
 200                 }
 201
 202                 /* We must use select and not sys_select here. If we use
 203                    sys_select we'd lose the fact a signal occurred when sys_select
 204                    read a byte from the pipe. Fix from Mark Weaver
 205                    <mark-clist@npsl.co.uk>
 206                 */
 207                 ret = select(maxfd, readfds2, writefds2, errorfds2, ptval);
 208         } while (ret == -1 && errno == EINTR);
 209
 210         if (readfds)
 211                 *readfds = readfds_buf;
 212         if (writefds)
 213                 *writefds = writefds_buf;
 214         if (errorfds)
 215                 *errorfds = errorfds_buf;
 216
 217         return ret;
 218 }