src/comm/TcpAcceptor.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    Listener Socket Handler */
  10
  11 #include "squid.h"
  12 #include "anyp/PortCfg.h"
  13 #include "base/TextException.h"
  14 #include "client_db.h"
  15 #include "comm/AcceptLimiter.h"
  16 #include "comm/comm_internal.h"
  17 #include "comm/Connection.h"
  18 #include "comm/Loops.h"
  19 #include "comm/TcpAcceptor.h"
  20 #include "CommCalls.h"
  21 #include "eui/Config.h"
  22 #include "fd.h"
  23 #include "fde.h"
  24 #include "globals.h"
  25 #include "ip/Intercept.h"
  26 #include "ip/QosConfig.h"
  27 #include "MasterXaction.h"
  28 #include "profiler/Profiler.h"
  29 #include "SquidConfig.h"
  30 #include "SquidTime.h"
  31 #include "StatCounters.h"
  32
  33 #include <cerrno>
  34 #ifdef HAVE_NETINET_TCP_H
  35 // required for accept_filter to build.
  36 #include <netinet/tcp.h>
  37 #endif
  38
  39 CBDATA_NAMESPACED_CLASS_INIT(Comm, TcpAcceptor);
  40
  41 Comm::TcpAcceptor::TcpAcceptor(const Comm::ConnectionPointer &newConn, const char *, const Subscription::Pointer &aSub) :
  42     AsyncJob("Comm::TcpAcceptor"),
  43     errcode(0),
  44     isLimited(0),
  45     theCallSub(aSub),
  46     conn(newConn),
  47     listenPort_()
  48 {}
  49
  50 Comm::TcpAcceptor::TcpAcceptor(const AnyP::PortCfgPointer &p, const char *, const Subscription::Pointer &aSub) :
  51     AsyncJob("Comm::TcpAcceptor"),
  52     errcode(0),
  53     isLimited(0),
  54     theCallSub(aSub),
  55     conn(p->listenConn),
  56     listenPort_(p)
  57 {}
  58
  59 void
  60 Comm::TcpAcceptor::subscribe(const Subscription::Pointer &aSub)
  61 {
  62     debugs(5, 5, HERE << status() << " AsyncCall Subscription: " << aSub);
  63     unsubscribe("subscription change");
  64     theCallSub = aSub;
  65 }
  66
  67 void
  68 Comm::TcpAcceptor::unsubscribe(const char *reason)
  69 {
  70     debugs(5, 5, HERE << status() << " AsyncCall Subscription " << theCallSub << " removed: " << reason);
  71     theCallSub = NULL;
  72 }
  73
  74 void
  75 Comm::TcpAcceptor::start()
  76 {
  77     debugs(5, 5, HERE << status() << " AsyncCall Subscription: " << theCallSub);
  78
  79     Must(IsConnOpen(conn));
  80
  81     setListen();
  82
  83     conn->noteStart();
  84
  85     // if no error so far start accepting connections.
  86     if (errcode == 0)
  87         SetSelect(conn->fd, COMM_SELECT_READ, doAccept, this, 0);
  88 }
  89
  90 bool
  91 Comm::TcpAcceptor::doneAll() const
  92 {
  93     // stop when FD is closed
  94     if (!IsConnOpen(conn)) {
  95         return AsyncJob::doneAll();
  96     }
  97
  98     // stop when handlers are gone
  99     if (theCallSub == NULL) {
 100         return AsyncJob::doneAll();
 101     }
 102
 103     // open FD with handlers...keep accepting.
 104     return false;
 105 }
 106
 107 void
 108 Comm::TcpAcceptor::swanSong()
 109 {
 110     debugs(5,5, HERE);
 111     unsubscribe("swanSong");
 112     if (IsConnOpen(conn)) {
 113         if (closer_ != NULL)
 114             comm_remove_close_handler(conn->fd, closer_);
 115         conn->close();
 116     }
 117
 118     conn = NULL;
 119     AcceptLimiter::Instance().removeDead(this);
 120     AsyncJob::swanSong();
 121 }
 122
 123 const char *
 124 Comm::TcpAcceptor::status() const
 125 {
 126     if (conn == NULL)
 127         return "[nil connection]";
 128
 129     static char ipbuf[MAX_IPSTRLEN] = {'\0'};
 130     if (ipbuf[0] == '\0')
 131         conn->local.toHostStr(ipbuf, MAX_IPSTRLEN);
 132
 133     static MemBuf buf;
 134     buf.reset();
 135     buf.appendf(" FD %d, %s",conn->fd, ipbuf);
 136
 137     const char *jobStatus = AsyncJob::status();
 138     buf.append(jobStatus, strlen(jobStatus));
 139
 140     return buf.content();
 141 }
 142
 143 /**
 144  * New-style listen and accept routines
 145  *
 146  * setListen simply registers our interest in an FD for listening.
 147  * The constructor takes a callback to call when an FD has been
 148  * accept()ed some time later.
 149  */
 150 void
 151 Comm::TcpAcceptor::setListen()
 152 {
 153     errcode = errno = 0;
 154     if (listen(conn->fd, Squid_MaxFD >> 2) < 0) {
 155         errcode = errno;
 156         debugs(50, DBG_CRITICAL, "ERROR: listen(" << status() << ", " << (Squid_MaxFD >> 2) << "): " << xstrerr(errcode));
 157         return;
 158     }
 159
 160     if (Config.accept_filter && strcmp(Config.accept_filter, "none") != 0) {
 161 #ifdef SO_ACCEPTFILTER
 162         struct accept_filter_arg afa;
 163         bzero(&afa, sizeof(afa));
 164         debugs(5, DBG_IMPORTANT, "Installing accept filter '" << Config.accept_filter << "' on " << conn);
 165         xstrncpy(afa.af_name, Config.accept_filter, sizeof(afa.af_name));
 166         if (setsockopt(conn->fd, SOL_SOCKET, SO_ACCEPTFILTER, &afa, sizeof(afa)) < 0)
 167             debugs(5, DBG_CRITICAL, "WARNING: SO_ACCEPTFILTER '" << Config.accept_filter << "': '" << xstrerror());
 168 #elif defined(TCP_DEFER_ACCEPT)
 169         int seconds = 30;
 170         if (strncmp(Config.accept_filter, "data=", 5) == 0)
 171             seconds = atoi(Config.accept_filter + 5);
 172         if (setsockopt(conn->fd, IPPROTO_TCP, TCP_DEFER_ACCEPT, &seconds, sizeof(seconds)) < 0)
 173             debugs(5, DBG_CRITICAL, "WARNING: TCP_DEFER_ACCEPT '" << Config.accept_filter << "': '" << xstrerror());
 174 #else
 175         debugs(5, DBG_CRITICAL, "WARNING: accept_filter not supported on your OS");
 176 #endif
 177     }
 178
 179 #if 0
 180     // Untested code.
 181     // Set TOS if needed.
 182     // To correctly implement TOS values on listening sockets, probably requires
 183     // more work to inherit TOS values to created connection objects.
 184     if (conn->tos)
 185             Ip::Qos::setSockTos(conn, conn->tos)
 186 #if SO_MARK
 187     if (conn->nfmark)
 188             Ip::Qos::setSockNfmark(conn, conn->nfmark);
 189 #endif
 190 #endif
 191
 192     typedef CommCbMemFunT<Comm::TcpAcceptor, CommCloseCbParams> Dialer;
 193     closer_ = JobCallback(5, 4, Dialer, this, Comm::TcpAcceptor::handleClosure);
 194     comm_add_close_handler(conn->fd, closer_);
 195 }
 196
 197 /// called when listening descriptor is closed by an external force
 198 /// such as clientHttpConnectionsClose()
 199 void
 200 Comm::TcpAcceptor::handleClosure(const CommCloseCbParams &)
 201 {
 202     closer_ = NULL;
 203     conn = NULL;
 204     Must(done());
 205 }
 206
 207 /**
 208  * This private callback is called whenever a filedescriptor is ready
 209  * to dupe itself and fob off an accept()ed connection
 210  *
 211  * It will either do that accept operation. Or if there are not enough FD
 212  * available to do the clone safely will push the listening FD into a list
 213  * of deferred operations. The list gets kicked and the dupe/accept() actually
 214  * done later when enough sockets become available.
 215  */
 216 void
 217 Comm::TcpAcceptor::doAccept(int fd, void *data)
 218 {
 219     try {
 220         debugs(5, 2, HERE << "New connection on FD " << fd);
 221
 222         Must(isOpen(fd));
 223         TcpAcceptor *afd = static_cast<TcpAcceptor*>(data);
 224
 225         if (!okToAccept()) {
 226             AcceptLimiter::Instance().defer(afd);
 227         } else {
 228             afd->acceptNext();
 229         }
 230         SetSelect(fd, COMM_SELECT_READ, Comm::TcpAcceptor::doAccept, afd, 0);
 231
 232     } catch (const std::exception &e) {
 233         fatalf("FATAL: error while accepting new client connection: %s\n", e.what());
 234     } catch (...) {
 235         fatal("FATAL: error while accepting new client connection: [unknown]\n");
 236     }
 237 }
 238
 239 bool
 240 Comm::TcpAcceptor::okToAccept()
 241 {
 242     static time_t last_warn = 0;
 243
 244     if (fdNFree() >= RESERVED_FD)
 245         return true;
 246
 247     if (last_warn + 15 < squid_curtime) {
 248         debugs(5, DBG_CRITICAL, "WARNING! Your cache is running out of filedescriptors");
 249         last_warn = squid_curtime;
 250     }
 251
 252     return false;
 253 }
 254
 255 void
 256 Comm::TcpAcceptor::acceptOne()
 257 {
 258     /*
 259      * We don't worry about running low on FDs here.  Instead,
 260      * doAccept() will use AcceptLimiter if we reach the limit
 261      * there.
 262      */
 263
 264     /* Accept a new connection */
 265     ConnectionPointer newConnDetails = new Connection();
 266     const Comm::Flag flag = oldAccept(newConnDetails);
 267
 268     /* Check for errors */
 269     if (!newConnDetails->isOpen()) {
 270
 271         if (flag == Comm::NOMESSAGE) {
 272             /* register interest again */
 273             debugs(5, 5, HERE << "try later: " << conn << " handler Subscription: " << theCallSub);
 274             SetSelect(conn->fd, COMM_SELECT_READ, doAccept, this, 0);
 275             return;
 276         }
 277
 278         // A non-recoverable error; notify the caller */
 279         debugs(5, 5, HERE << "non-recoverable error:" << status() << " handler Subscription: " << theCallSub);
 280         notify(flag, newConnDetails);
 281         mustStop("Listener socket closed");
 282         return;
 283     }
 284
 285     debugs(5, 5, HERE << "Listener: " << conn <<
 286            " accepted new connection " << newConnDetails <<
 287            " handler Subscription: " << theCallSub);
 288     notify(flag, newConnDetails);
 289 }
 290
 291 void
 292 Comm::TcpAcceptor::acceptNext()
 293 {
 294     Must(IsConnOpen(conn));
 295     debugs(5, 2, HERE << "connection on " << conn);
 296     acceptOne();
 297 }
 298
 299 void
 300 Comm::TcpAcceptor::notify(const Comm::Flag flag, const Comm::ConnectionPointer &newConnDetails) const
 301 {
 302     // listener socket handlers just abandon the port with Comm::ERR_CLOSING
 303     // it should only happen when this object is deleted...
 304     if (flag == Comm::ERR_CLOSING) {
 305         return;
 306     }
 307
 308     if (theCallSub != NULL) {
 309         AsyncCall::Pointer call = theCallSub->callback();
 310         CommAcceptCbParams &params = GetCommParams<CommAcceptCbParams>(call);
 311         params.xaction = new MasterXaction;
 312         params.xaction->squidPort = listenPort_;
 313         params.fd = conn->fd;
 314         params.conn = params.xaction->tcpClient = newConnDetails;
 315         params.flag = flag;
 316         params.xerrno = errcode;
 317         ScheduleCallHere(call);
 318     }
 319 }
 320
 321 /**
 322  * accept() and process
 323  * Wait for an incoming connection on our listener socket.
 324  *
 325  * \retval Comm::OK         success. details parameter filled.
 326  * \retval Comm::NOMESSAGE  attempted accept() but nothing useful came in.
 327  * \retval Comm::COMM_ERROR      an outright failure occured.
 328  *                         Or if this client has too many connections already.
 329  */
 330 Comm::Flag
 331 Comm::TcpAcceptor::oldAccept(Comm::ConnectionPointer &details)
 332 {
 333     PROF_start(comm_accept);
 334     ++statCounter.syscalls.sock.accepts;
 335     int sock;
 336     struct addrinfo *gai = NULL;
 337     Ip::Address::InitAddr(gai);
 338
 339     errcode = 0; // reset local errno copy.
 340     if ((sock = accept(conn->fd, gai->ai_addr, &gai->ai_addrlen)) < 0) {
 341         errcode = errno; // store last accept errno locally.
 342
 343         Ip::Address::FreeAddr(gai);
 344
 345         PROF_stop(comm_accept);
 346
 347         if (ignoreErrno(errno)) {
 348             debugs(50, 5, HERE << status() << ": " << xstrerror());
 349             return Comm::NOMESSAGE;
 350         } else if (ENFILE == errno || EMFILE == errno) {
 351             debugs(50, 3, HERE << status() << ": " << xstrerror());
 352             return Comm::COMM_ERROR;
 353         } else {
 354             debugs(50, DBG_IMPORTANT, HERE << status() << ": " << xstrerror());
 355             return Comm::COMM_ERROR;
 356         }
 357     }
 358
 359     Must(sock >= 0);
 360     details->fd = sock;
 361     details->remote = *gai;
 362
 363     if ( Config.client_ip_max_connections >= 0) {
 364         if (clientdbEstablished(details->remote, 0) > Config.client_ip_max_connections) {
 365             debugs(50, DBG_IMPORTANT, "WARNING: " << details->remote << " attempting more than " << Config.client_ip_max_connections << " connections.");
 366             Ip::Address::FreeAddr(gai);
 367             PROF_stop(comm_accept);
 368             return Comm::COMM_ERROR;
 369         }
 370     }
 371
 372     // lookup the local-end details of this new connection
 373     Ip::Address::InitAddr(gai);
 374     details->local.setEmpty();
 375     if (getsockname(sock, gai->ai_addr, &gai->ai_addrlen) != 0) {
 376         debugs(50, DBG_IMPORTANT, "ERROR: getsockname() failed to locate local-IP on " << details << ": " << xstrerror());
 377         Ip::Address::FreeAddr(gai);
 378         PROF_stop(comm_accept);
 379         return Comm::COMM_ERROR;
 380     }
 381     details->local = *gai;
 382     Ip::Address::FreeAddr(gai);
 383
 384     /* fdstat update */
 385     // XXX : these are not all HTTP requests. use a note about type and ip:port details->
 386     // so we end up with a uniform "(HTTP|FTP-data|HTTPS|...) remote-ip:remote-port"
 387     fd_open(sock, FD_SOCKET, "HTTP Request");
 388
 389     fdd_table[sock].close_file = NULL;
 390     fdd_table[sock].close_line = 0;
 391
 392     fde *F = &fd_table[sock];
 393     details->remote.toStr(F->ipaddr,MAX_IPSTRLEN);
 394     F->remote_port = details->remote.port();
 395     F->local_addr = details->local;
 396     F->sock_family = details->local.isIPv6()?AF_INET6:AF_INET;
 397
 398     // set socket flags
 399     commSetCloseOnExec(sock);
 400     commSetNonBlocking(sock);
 401
 402     /* IFF the socket is (tproxy) transparent, pass the flag down to allow spoofing */
 403     F->flags.transparent = fd_table[conn->fd].flags.transparent; // XXX: can we remove this line yet?
 404
 405     // Perform NAT or TPROXY operations to retrieve the real client/dest IP addresses
 406     if (conn->flags&(COMM_TRANSPARENT|COMM_INTERCEPTION) && !Ip::Interceptor.Lookup(details, conn)) {
 407         debugs(50, DBG_IMPORTANT, "ERROR: NAT/TPROXY lookup failed to locate original IPs on " << details);
 408         // Failed.
 409         PROF_stop(comm_accept);
 410         return Comm::COMM_ERROR;
 411     }
 412
 413 #if USE_SQUID_EUI
 414     if (Eui::TheConfig.euiLookup) {
 415         if (details->remote.isIPv4()) {
 416             details->remoteEui48.lookup(details->remote);
 417         } else if (details->remote.isIPv6()) {
 418             details->remoteEui64.lookup(details->remote);
 419         }
 420     }
 421 #endif
 422
 423     PROF_stop(comm_accept);
 424     return Comm::OK;
 425 }
 426