src/comm/Read.cc

   1 /*
   2  * Copyright (C) 1996-2015 The Squid Software Foundation and contributors
   3  *
   4  * Squid software is distributed under GPLv2+ license and includes
   5  * contributions from numerous individuals and organizations.
   6  * Please see the COPYING and CONTRIBUTORS files for details.
   7  */
   8
   9 /* DEBUG: section 05    Socket Functions */
  10
  11 #include "squid.h"
  12 #include "comm.h"
  13 #include "comm/IoCallback.h"
  14 #include "comm/Loops.h"
  15 #include "comm/Read.h"
  16 #include "comm_internal.h"
  17 #include "CommCalls.h"
  18 #include "Debug.h"
  19 #include "fd.h"
  20 #include "fde.h"
  21 #include "SBuf.h"
  22 #include "StatCounters.h"
  23 //#include "tools.h"
  24
  25 // Does comm check this fd for read readiness?
  26 // Note that when comm is not monitoring, there can be a pending callback
  27 // call, which may resume comm monitoring once fired.
  28 bool
  29 Comm::MonitorsRead(int fd)
  30 {
  31     assert(isOpen(fd) && COMMIO_FD_READCB(fd) != NULL);
  32     // Being active is usually the same as monitoring because we always
  33     // start monitoring the FD when we configure Comm::IoCallback for I/O
  34     // and we usually configure Comm::IoCallback for I/O when we starting
  35     // monitoring a FD for reading.
  36     return COMMIO_FD_READCB(fd)->active();
  37 }
  38
  39 void
  40 Comm::Read(const Comm::ConnectionPointer &conn, AsyncCall::Pointer &callback)
  41 {
  42     // TODO: move comm_read_base() internals into here
  43     // when comm_read() char* API is no longer needed
  44     comm_read_base(conn, NULL, 0, callback);
  45 }
  46
  47 /**
  48  * Queue a read.
  49  * If a buffer is given the callback is scheduled when the read
  50  * completes, on error, or on file descriptor close.
  51  *
  52  * If no buffer (NULL) is given the callback is scheduled when
  53  * the socket FD is ready for a read(2)/recv(2).
  54  */
  55 void
  56 comm_read_base(const Comm::ConnectionPointer &conn, char *buf, int size, AsyncCall::Pointer &callback)
  57 {
  58     debugs(5, 5, "comm_read, queueing read for " << conn << "; asynCall " << callback);
  59
  60     /* Make sure we are open and not closing */
  61     assert(Comm::IsConnOpen(conn));
  62     assert(!fd_table[conn->fd].closing());
  63     Comm::IoCallback *ccb = COMMIO_FD_READCB(conn->fd);
  64
  65     // Make sure we are either not reading or just passively monitoring.
  66     // Active/passive conflicts are OK and simply cancel passive monitoring.
  67     if (ccb->active()) {
  68         // if the assertion below fails, we have an active comm_read conflict
  69         assert(fd_table[conn->fd].halfClosedReader != NULL);
  70         commStopHalfClosedMonitor(conn->fd);
  71         assert(!ccb->active());
  72     }
  73     ccb->conn = conn;
  74
  75     /* Queue the read */
  76     ccb->setCallback(Comm::IOCB_READ, callback, (char *)buf, NULL, size);
  77     Comm::SetSelect(conn->fd, COMM_SELECT_READ, Comm::HandleRead, ccb, 0);
  78 }
  79
  80 Comm::Flag
  81 Comm::ReadNow(CommIoCbParams &params, SBuf &buf)
  82 {
  83     /* Attempt a read */
  84     ++ statCounter.syscalls.sock.reads;
  85     const SBuf::size_type sz = buf.spaceSize();
  86     char *inbuf = buf.rawSpace(sz);
  87     errno = 0;
  88     const int retval = FD_READ_METHOD(params.conn->fd, inbuf, sz);
  89     params.xerrno = errno;
  90
  91     debugs(5, 3, params.conn << ", size " << sz << ", retval " << retval << ", errno " << params.xerrno);
  92
  93     if (retval > 0) { // data read most common case
  94         buf.append(inbuf, retval);
  95         fd_bytes(params.conn->fd, retval, FD_READ);
  96         params.flag = Comm::OK;
  97         params.size = retval;
  98
  99     } else if (retval == 0) { // remote closure (somewhat less) common
 100         // Note - read 0 == socket EOF, which is a valid read.
 101         params.flag = Comm::ENDFILE;
 102
 103     } else if (retval < 0) { // connection errors are worst-case
 104         debugs(5, 3, params.conn << " Comm::COMM_ERROR: " << xstrerr(params.xerrno));
 105         if (ignoreErrno(params.xerrno))
 106             params.flag =  Comm::INPROGRESS;
 107         else
 108             params.flag =  Comm::COMM_ERROR;
 109     }
 110
 111     return params.flag;
 112 }
 113
 114 /**
 115  * Handle an FD which is ready for read(2).
 116  *
 117  * If there is no provided buffer to fill call the callback.
 118  *
 119  * Otherwise attempt a read into the provided buffer.
 120  * If the read attempt succeeds or fails, call the callback.
 121  * Else, wait for another IO notification.
 122  */
 123 void
 124 Comm::HandleRead(int fd, void *data)
 125 {
 126     Comm::IoCallback *ccb = (Comm::IoCallback *) data;
 127
 128     assert(data == COMMIO_FD_READCB(fd));
 129     assert(ccb->active());
 130
 131     // Without a buffer, just call back.
 132     // The callee may ReadMore() to get the data.
 133     if (!ccb->buf) {
 134         ccb->finish(Comm::OK, 0);
 135         return;
 136     }
 137
 138     /* For legacy callers : Attempt a read */
 139     // Keep in sync with Comm::ReadNow()!
 140     ++ statCounter.syscalls.sock.reads;
 141     errno = 0;
 142     int retval = FD_READ_METHOD(fd, ccb->buf, ccb->size);
 143     debugs(5, 3, "FD " << fd << ", size " << ccb->size << ", retval " << retval << ", errno " << errno);
 144
 145     /* See if we read anything */
 146     /* Note - read 0 == socket EOF, which is a valid read */
 147     if (retval >= 0) {
 148         fd_bytes(fd, retval, FD_READ);
 149         ccb->offset = retval;
 150         ccb->finish(Comm::OK, errno);
 151         return;
 152
 153     } else if (retval < 0 && !ignoreErrno(errno)) {
 154         debugs(5, 3, "comm_read_try: scheduling Comm::COMM_ERROR");
 155         ccb->offset = 0;
 156         ccb->finish(Comm::COMM_ERROR, errno);
 157         return;
 158     };
 159
 160     /* Nope, register for some more IO */
 161     Comm::SetSelect(fd, COMM_SELECT_READ, Comm::HandleRead, data, 0);
 162 }
 163
 164 /**
 165  * Cancel a pending read. Assert that we have the right parameters,
 166  * and that there are no pending read events!
 167  *
 168  * XXX: We do not assert that there are no pending read events and
 169  * with async calls it becomes even more difficult.
 170  * The whole interface should be reworked to do callback->cancel()
 171  * instead of searching for places where the callback may be stored and
 172  * updating the state of those places.
 173  *
 174  * AHC Don't call the comm handlers?
 175  */
 176 void
 177 comm_read_cancel(int fd, IOCB *callback, void *data)
 178 {
 179     if (!isOpen(fd)) {
 180         debugs(5, 4, "fails: FD " << fd << " closed");
 181         return;
 182     }
 183
 184     Comm::IoCallback *cb = COMMIO_FD_READCB(fd);
 185     // TODO: is "active" == "monitors FD"?
 186     if (!cb->active()) {
 187         debugs(5, 4, "fails: FD " << fd << " inactive");
 188         return;
 189     }
 190
 191     typedef CommCbFunPtrCallT<CommIoCbPtrFun> Call;
 192     Call *call = dynamic_cast<Call*>(cb->callback.getRaw());
 193     if (!call) {
 194         debugs(5, 4, "fails: FD " << fd << " lacks callback");
 195         return;
 196     }
 197
 198     call->cancel("old comm_read_cancel");
 199
 200     typedef CommIoCbParams Params;
 201     const Params &params = GetCommParams<Params>(cb->callback);
 202
 203     /* Ok, we can be reasonably sure we won't lose any data here! */
 204     assert(call->dialer.handler == callback);
 205     assert(params.data == data);
 206
 207     /* Delete the callback */
 208     cb->cancel("old comm_read_cancel");
 209
 210     /* And the IO event */
 211     Comm::SetSelect(fd, COMM_SELECT_READ, NULL, NULL, 0);
 212 }
 213
 214 void
 215 Comm::ReadCancel(int fd, AsyncCall::Pointer &callback)
 216 {
 217     callback->cancel("comm_read_cancel");
 218
 219     if (!isOpen(fd)) {
 220         debugs(5, 4, "fails: FD " << fd << " closed");
 221         return;
 222     }
 223
 224     Comm::IoCallback *cb = COMMIO_FD_READCB(fd);
 225
 226     if (!cb->active()) {
 227         debugs(5, 4, "fails: FD " << fd << " inactive");
 228         return;
 229     }
 230
 231     AsyncCall::Pointer call = cb->callback;
 232
 233     /* Ok, we can be reasonably sure we won't lose any data here! */
 234     assert(call == callback);
 235
 236     /* Delete the callback */
 237     cb->cancel("comm_read_cancel");
 238
 239     /* And the IO event */
 240     Comm::SetSelect(fd, COMM_SELECT_READ, NULL, NULL, 0);
 241 }
 242