src/icp_v2.cc

   1 /*
   2  * DEBUG: section 12    Internet Cache Protocol (ICP)
   3  * AUTHOR: Duane Wessels
   4  *
   5  * SQUID Web Proxy Cache          http://www.squid-cache.org/
   6  * ----------------------------------------------------------
   7  *
   8  *  Squid is the result of efforts by numerous individuals from
   9  *  the Internet community; see the CONTRIBUTORS file for full
  10  *  details.   Many organizations have provided support for Squid's
  11  *  development; see the SPONSORS file for full details.  Squid is
  12  *  Copyrighted (C) 2001 by the Regents of the University of
  13  *  California; see the COPYRIGHT file for full details.  Squid
  14  *  incorporates software developed and/or copyrighted by other
  15  *  sources; see the CREDITS file for full details.
  16  *
  17  *  This program is free software; you can redistribute it and/or modify
  18  *  it under the terms of the GNU General Public License as published by
  19  *  the Free Software Foundation; either version 2 of the License, or
  20  *  (at your option) any later version.
  21  *
  22  *  This program is distributed in the hope that it will be useful,
  23  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  24  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  25  *  GNU General Public License for more details.
  26  *
  27  *  You should have received a copy of the GNU General Public License
  28  *  along with this program; if not, write to the Free Software
  29  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
  30  *
  31  */
  32
  33 /**
  34  \defgroup ServerProtocolICPInternal2 ICPv2 Internals
  35  \ingroup ServerProtocolICPAPI
  36  */
  37
  38 #include "squid.h"
  39 #include "Store.h"
  40 #include "comm.h"
  41 #include "comm/Loops.h"
  42 #include "ICP.h"
  43 #include "comm/Connection.h"
  44 #include "HttpRequest.h"
  45 #include "acl/FilledChecklist.h"
  46 #include "acl/Acl.h"
  47 #include "AccessLogEntry.h"
  48 #include "wordlist.h"
  49 #include "SquidTime.h"
  50 #include "SwapDir.h"
  51 #include "icmp/net_db.h"
  52 #include "ip/Address.h"
  53 #include "ip/tools.h"
  54 #include "ipc/StartListening.h"
  55 #include "ipcache.h"
  56 #include "rfc1738.h"
  57
  58 /// dials icpIncomingConnectionOpened call
  59 class IcpListeningStartedDialer: public CallDialer,
  60         public Ipc::StartListeningCb
  61 {
  62 public:
  63     typedef void (*Handler)(int errNo);
  64     IcpListeningStartedDialer(Handler aHandler):
  65             handler(aHandler) {}
  66
  67     virtual void print(std::ostream &os) const { startPrint(os) << ')'; }
  68     virtual bool canDial(AsyncCall &) const { return true; }
  69     virtual void dial(AsyncCall &) { (handler)(errNo); }
  70
  71 public:
  72     Handler handler;
  73 };
  74
  75 static void icpIncomingConnectionOpened(int errNo);
  76
  77 /// \ingroup ServerProtocolICPInternal2
  78 static void icpLogIcp(const Ip::Address &, log_type, int, const char *, int);
  79
  80 /// \ingroup ServerProtocolICPInternal2
  81 static void icpHandleIcpV2(int, Ip::Address &, char *, int);
  82
  83 /// \ingroup ServerProtocolICPInternal2
  84 static void icpCount(void *, int, size_t, int);
  85
  86 /**
  87  \ingroup ServerProtocolICPInternal2
  88  * IcpQueueHead is global so comm_incoming() knows whether or not
  89  * to call icpUdpSendQueue.
  90  */
  91 static icpUdpData *IcpQueueHead = NULL;
  92 /// \ingroup ServerProtocolICPInternal2
  93 static icpUdpData *IcpQueueTail = NULL;
  94
  95 /// \ingroup ServerProtocolICPInternal2
  96 Comm::ConnectionPointer icpIncomingConn = NULL;
  97 /// \ingroup ServerProtocolICPInternal2
  98 Comm::ConnectionPointer icpOutgoingConn = NULL;
  99
 100 /* icp_common_t */
 101 _icp_common_t::_icp_common_t() : opcode(ICP_INVALID), version(0), length(0), reqnum(0), flags(0), pad(0), shostid(0)
 102 {}
 103
 104 _icp_common_t::_icp_common_t(char *buf, unsigned int len)
 105 {
 106     if (len < sizeof(_icp_common_t)) {
 107         /* mark as invalid */
 108         length = len + 1;
 109         return;
 110     }
 111
 112     memcpy(this, buf, sizeof(icp_common_t));
 113     /*
 114      * Convert network order sensitive fields
 115      */
 116     length = ntohs(length);
 117     reqnum = ntohl(reqnum);
 118     flags = ntohl(flags);
 119     pad = ntohl(pad);
 120 }
 121
 122 icp_opcode
 123 _icp_common_t::getOpCode() const
 124 {
 125     if (opcode > (char)ICP_END)
 126         return ICP_INVALID;
 127
 128     return (icp_opcode)opcode;
 129 }
 130
 131 /* ICPState */
 132
 133 ICPState::ICPState(icp_common_t &aHeader, HttpRequest *aRequest):
 134         header(aHeader),
 135         request(HTTPMSGLOCK(aRequest)),
 136         fd(-1),
 137         url(NULL)
 138 {}
 139
 140 ICPState::~ICPState()
 141 {
 142     safe_free(url);
 143     HTTPMSGUNLOCK(request);
 144 }
 145
 146
 147 /* End ICPState */
 148
 149 /* ICP2State */
 150
 151 /// \ingroup ServerProtocolICPInternal2
 152 class ICP2State : public ICPState, public StoreClient
 153 {
 154
 155 public:
 156     ICP2State(icp_common_t & aHeader, HttpRequest *aRequest):
 157             ICPState(aHeader, aRequest),rtt(0),src_rtt(0),flags(0) {}
 158
 159     ~ICP2State();
 160     void created(StoreEntry * newEntry);
 161
 162     int rtt;
 163     int src_rtt;
 164     uint32_t flags;
 165 };
 166
 167 ICP2State::~ICP2State()
 168 {}
 169
 170 void
 171 ICP2State::created(StoreEntry *newEntry)
 172 {
 173     StoreEntry *entry = newEntry->isNull () ? NULL : newEntry;
 174     debugs(12, 5, "icpHandleIcpV2: OPCODE " << icp_opcode_str[header.opcode]);
 175     icp_opcode codeToSend;
 176
 177     if (icpCheckUdpHit(entry, request)) {
 178         codeToSend = ICP_HIT;
 179     } else {
 180 #if USE_ICMP
 181         if (Config.onoff.test_reachability && rtt == 0) {
 182             if ((rtt = netdbHostRtt(request->GetHost())) == 0)
 183                 netdbPingSite(request->GetHost());
 184         }
 185 #endif /* USE_ICMP */
 186
 187         if (icpGetCommonOpcode() != ICP_ERR)
 188             codeToSend = icpGetCommonOpcode();
 189         else if (Config.onoff.test_reachability && rtt == 0)
 190             codeToSend = ICP_MISS_NOFETCH;
 191         else
 192             codeToSend = ICP_MISS;
 193     }
 194
 195     icpCreateAndSend(codeToSend, flags, url, header.reqnum, src_rtt, fd, from);
 196     delete this;
 197 }
 198
 199 /* End ICP2State */
 200
 201 /// \ingroup ServerProtocolICPInternal2
 202 static void
 203 icpLogIcp(const Ip::Address &caddr, log_type logcode, int len, const char *url, int delay)
 204 {
 205     AccessLogEntry al;
 206
 207     if (LOG_TAG_NONE == logcode)
 208         return;
 209
 210     if (LOG_ICP_QUERY == logcode)
 211         return;
 212
 213     clientdbUpdate(caddr, logcode, AnyP::PROTO_ICP, len);
 214
 215     if (!Config.onoff.log_udp)
 216         return;
 217
 218     al.icp.opcode = ICP_QUERY;
 219
 220     al.url = url;
 221
 222     al.cache.caddr = caddr;
 223
 224     al.cache.replySize = len;
 225
 226     al.cache.code = logcode;
 227
 228     al.cache.msec = delay;
 229
 230     accessLogLog(&al, NULL);
 231 }
 232
 233 /// \ingroup ServerProtocolICPInternal2
 234 void
 235 icpUdpSendQueue(int fd, void *unused)
 236 {
 237     icpUdpData *q;
 238
 239     while ((q = IcpQueueHead) != NULL) {
 240         int delay = tvSubUsec(q->queue_time, current_time);
 241         /* increment delay to prevent looping */
 242         const int x = icpUdpSend(fd, q->address, (icp_common_t *) q->msg, q->logcode, ++delay);
 243         IcpQueueHead = q->next;
 244         xfree(q);
 245
 246         if (x < 0)
 247             break;
 248     }
 249 }
 250
 251 _icp_common_t *
 252 _icp_common_t::createMessage(
 253     icp_opcode opcode,
 254     int flags,
 255     const char *url,
 256     int reqnum,
 257     int pad)
 258 {
 259     char *buf = NULL;
 260     icp_common_t *headerp = NULL;
 261     char *urloffset = NULL;
 262     int buf_len;
 263     buf_len = sizeof(icp_common_t) + strlen(url) + 1;
 264
 265     if (opcode == ICP_QUERY)
 266         buf_len += sizeof(uint32_t);
 267
 268     buf = (char *) xcalloc(buf_len, 1);
 269
 270     headerp = (icp_common_t *) (void *) buf;
 271
 272     headerp->opcode = (char) opcode;
 273
 274     headerp->version = ICP_VERSION_CURRENT;
 275
 276     headerp->length = (uint16_t) htons(buf_len);
 277
 278     headerp->reqnum = htonl(reqnum);
 279
 280     headerp->flags = htonl(flags);
 281
 282     headerp->pad = htonl(pad);
 283
 284     headerp->shostid = 0;
 285
 286     urloffset = buf + sizeof(icp_common_t);
 287
 288     if (opcode == ICP_QUERY)
 289         urloffset += sizeof(uint32_t);
 290
 291     memcpy(urloffset, url, strlen(url));
 292
 293     return (icp_common_t *)buf;
 294 }
 295
 296 int
 297 icpUdpSend(int fd,
 298            const Ip::Address &to,
 299            icp_common_t * msg,
 300            log_type logcode,
 301            int delay)
 302 {
 303     icpUdpData *queue;
 304     int x;
 305     int len;
 306     len = (int) ntohs(msg->length);
 307     debugs(12, 5, "icpUdpSend: FD " << fd << " sending " <<
 308            icp_opcode_str[msg->opcode] << ", " << len << " bytes to " << to);
 309
 310     x = comm_udp_sendto(fd, to, msg, len);
 311
 312     if (x >= 0) {
 313         /* successfully written */
 314         icpLogIcp(to, logcode, len, (char *) (msg + 1), delay);
 315         icpCount(msg, SENT, (size_t) len, delay);
 316         safe_free(msg);
 317     } else if (0 == delay) {
 318         /* send failed, but queue it */
 319         queue = (icpUdpData *) xcalloc(1, sizeof(icpUdpData));
 320         queue->address = to;
 321         queue->msg = msg;
 322         queue->len = (int) ntohs(msg->length);
 323         queue->queue_time = current_time;
 324         queue->logcode = logcode;
 325
 326         if (IcpQueueHead == NULL) {
 327             IcpQueueHead = queue;
 328             IcpQueueTail = queue;
 329         } else if (IcpQueueTail == IcpQueueHead) {
 330             IcpQueueTail = queue;
 331             IcpQueueHead->next = queue;
 332         } else {
 333             IcpQueueTail->next = queue;
 334             IcpQueueTail = queue;
 335         }
 336
 337         Comm::SetSelect(fd, COMM_SELECT_WRITE, icpUdpSendQueue, NULL, 0);
 338         statCounter.icp.replies_queued++;
 339     } else {
 340         /* don't queue it */
 341         statCounter.icp.replies_dropped++;
 342     }
 343
 344     return x;
 345 }
 346
 347 int
 348 icpCheckUdpHit(StoreEntry * e, HttpRequest * request)
 349 {
 350     if (e == NULL)
 351         return 0;
 352
 353     if (!e->validToSend())
 354         return 0;
 355
 356     if (Config.onoff.icp_hit_stale)
 357         return 1;
 358
 359     if (refreshCheckICP(e, request))
 360         return 0;
 361
 362     return 1;
 363 }
 364
 365 /**
 366  * This routine selects an ICP opcode for ICP misses.
 367  *
 368  \retval ICP_ERR            no opcode selected here
 369  \retval ICP_MISS_NOFETCH   store is rebuilding, no fetch is possible yet
 370  */
 371 icp_opcode
 372 icpGetCommonOpcode()
 373 {
 374     /* if store is rebuilding, return a UDP_MISS_NOFETCH */
 375
 376     if ((StoreController::store_dirs_rebuilding && opt_reload_hit_only) ||
 377             hit_only_mode_until > squid_curtime) {
 378         return ICP_MISS_NOFETCH;
 379     }
 380
 381     return ICP_ERR;
 382 }
 383
 384 log_type
 385 icpLogFromICPCode(icp_opcode opcode)
 386 {
 387     if (opcode == ICP_ERR)
 388         return LOG_UDP_INVALID;
 389
 390     if (opcode == ICP_DENIED)
 391         return LOG_UDP_DENIED;
 392
 393     if (opcode == ICP_HIT)
 394         return LOG_UDP_HIT;
 395
 396     if (opcode == ICP_MISS)
 397         return LOG_UDP_MISS;
 398
 399     if (opcode == ICP_MISS_NOFETCH)
 400         return LOG_UDP_MISS_NOFETCH;
 401
 402     fatal("expected ICP opcode\n");
 403
 404     return LOG_UDP_INVALID;
 405 }
 406
 407 void
 408 icpCreateAndSend(icp_opcode opcode, int flags, char const *url, int reqnum, int pad, int fd, const Ip::Address &from)
 409 {
 410     icp_common_t *reply = _icp_common_t::createMessage(opcode, flags, url, reqnum, pad);
 411     icpUdpSend(fd, from, reply, icpLogFromICPCode(opcode), 0);
 412 }
 413
 414 void
 415 icpDenyAccess(Ip::Address &from, char *url, int reqnum, int fd)
 416 {
 417     debugs(12, 2, "icpDenyAccess: Access Denied for " << from << " by " << AclMatchedName << ".");
 418
 419     if (clientdbCutoffDenied(from)) {
 420         /*
 421          * count this DENIED query in the clientdb, even though
 422          * we're not sending an ICP reply...
 423          */
 424         clientdbUpdate(from, LOG_UDP_DENIED, AnyP::PROTO_ICP, 0);
 425     } else {
 426         icpCreateAndSend(ICP_DENIED, 0, url, reqnum, 0, fd, from);
 427     }
 428 }
 429
 430 bool
 431 icpAccessAllowed(Ip::Address &from, HttpRequest * icp_request)
 432 {
 433     /* absent an explicit allow, we deny all */
 434     if (!Config.accessList.icp)
 435         return true;
 436
 437     ACLFilledChecklist checklist(Config.accessList.icp, icp_request, NULL);
 438     checklist.src_addr = from;
 439     checklist.my_addr.SetNoAddr();
 440     return (checklist.fastCheck() == ACCESS_ALLOWED);
 441 }
 442
 443 char const *
 444 icpGetUrlToSend(char *url)
 445 {
 446     if (strpbrk(url, w_space))
 447         return rfc1738_escape(url);
 448     else
 449         return url;
 450 }
 451
 452 HttpRequest *
 453 icpGetRequest(char *url, int reqnum, int fd, Ip::Address &from)
 454 {
 455     if (strpbrk(url, w_space)) {
 456         url = rfc1738_escape(url);
 457         icpCreateAndSend(ICP_ERR, 0, rfc1738_escape(url), reqnum, 0, fd, from);
 458         return NULL;
 459     }
 460
 461     HttpRequest *result;
 462
 463     if ((result = HttpRequest::CreateFromUrl(url)) == NULL)
 464         icpCreateAndSend(ICP_ERR, 0, url, reqnum, 0, fd, from);
 465
 466     return result;
 467
 468 }
 469
 470 static void
 471 doV2Query(int fd, Ip::Address &from, char *buf, icp_common_t header)
 472 {
 473     int rtt = 0;
 474     int src_rtt = 0;
 475     uint32_t flags = 0;
 476     /* We have a valid packet */
 477     char *url = buf + sizeof(icp_common_t) + sizeof(uint32_t);
 478     HttpRequest *icp_request = icpGetRequest(url, header.reqnum, fd, from);
 479
 480     if (!icp_request)
 481         return;
 482
 483     HTTPMSGLOCK(icp_request);
 484
 485     if (!icpAccessAllowed(from, icp_request)) {
 486         icpDenyAccess(from, url, header.reqnum, fd);
 487         HTTPMSGUNLOCK(icp_request);
 488         return;
 489     }
 490 #if USE_ICMP
 491     if (header.flags & ICP_FLAG_SRC_RTT) {
 492         rtt = netdbHostRtt(icp_request->GetHost());
 493         int hops = netdbHostHops(icp_request->GetHost());
 494         src_rtt = ((hops & 0xFFFF) << 16) | (rtt & 0xFFFF);
 495
 496         if (rtt)
 497             flags |= ICP_FLAG_SRC_RTT;
 498     }
 499 #endif /* USE_ICMP */
 500
 501     /* The peer is allowed to use this cache */
 502     ICP2State *state = new ICP2State (header, icp_request);
 503
 504     state->fd = fd;
 505
 506     state->from = from;
 507
 508     state->url = xstrdup (url);
 509
 510     state->flags = flags;
 511
 512     state->rtt = rtt;
 513
 514     state->src_rtt = src_rtt;
 515
 516     StoreEntry::getPublic (state, url, METHOD_GET);
 517
 518     HTTPMSGUNLOCK(icp_request);
 519 }
 520
 521 void
 522 _icp_common_t::handleReply(char *buf, Ip::Address &from)
 523 {
 524     if (neighbors_do_private_keys && reqnum == 0) {
 525         debugs(12, 0, "icpHandleIcpV2: Neighbor " << from << " returned reqnum = 0");
 526         debugs(12, 0, "icpHandleIcpV2: Disabling use of private keys");
 527         neighbors_do_private_keys = 0;
 528     }
 529
 530     char *url = buf + sizeof(icp_common_t);
 531     debugs(12, 3, "icpHandleIcpV2: " << icp_opcode_str[opcode] << " from " << from << " for '" << url << "'");
 532
 533     const cache_key *key = icpGetCacheKey(url, (int) reqnum);
 534     /* call neighborsUdpAck even if ping_status != PING_WAITING */
 535     neighborsUdpAck(key, this, from);
 536 }
 537
 538 static void
 539 icpHandleIcpV2(int fd, Ip::Address &from, char *buf, int len)
 540 {
 541     if (len <= 0) {
 542         debugs(12, 3, "icpHandleIcpV2: ICP message is too small");
 543         return;
 544     }
 545
 546     icp_common_t header(buf, len);
 547     /*
 548      * Length field should match the number of bytes read
 549      */
 550
 551     if (len != header.length) {
 552         debugs(12, 3, "icpHandleIcpV2: ICP message is too small");
 553         return;
 554     }
 555
 556     switch (header.opcode) {
 557
 558     case ICP_QUERY:
 559         /* We have a valid packet */
 560         doV2Query(fd, from, buf, header);
 561         break;
 562
 563     case ICP_HIT:
 564
 565     case ICP_DECHO:
 566
 567     case ICP_MISS:
 568
 569     case ICP_DENIED:
 570
 571     case ICP_MISS_NOFETCH:
 572         header.handleReply(buf, from);
 573         break;
 574
 575     case ICP_INVALID:
 576
 577     case ICP_ERR:
 578         break;
 579
 580     default:
 581         debugs(12, 0, "icpHandleIcpV2: UNKNOWN OPCODE: " << header.opcode << " from " << from);
 582
 583         break;
 584     }
 585 }
 586
 587 #ifdef ICP_PKT_DUMP
 588 static void
 589 icpPktDump(icp_common_t * pkt)
 590 {
 591     Ip::Address a;
 592
 593     debugs(12, 9, "opcode:     " << std::setw(3) << pkt->opcode  << " " << icp_opcode_str[pkt->opcode]);
 594     debugs(12, 9, "version: "<< std::left << std::setw(8) << pkt->version);
 595     debugs(12, 9, "length:  "<< std::left << std::setw(8) << ntohs(pkt->length));
 596     debugs(12, 9, "reqnum:  "<< std::left << std::setw(8) << ntohl(pkt->reqnum));
 597     debugs(12, 9, "flags:   "<< std::left << std::hex << std::setw(8) << ntohl(pkt->flags));
 598     a = (struct in_addr)pkt->shostid;
 599     debugs(12, 9, "shostid: " << a );
 600     debugs(12, 9, "payload: " << (char *) pkt + sizeof(icp_common_t));
 601 }
 602
 603 #endif
 604
 605 void
 606 icpHandleUdp(int sock, void *data)
 607 {
 608     int *N = &incoming_sockets_accepted;
 609
 610     Ip::Address from;
 611     LOCAL_ARRAY(char, buf, SQUID_UDP_SO_RCVBUF);
 612     int len;
 613     int icp_version;
 614     int max = INCOMING_ICP_MAX;
 615     Comm::SetSelect(sock, COMM_SELECT_READ, icpHandleUdp, NULL, 0);
 616
 617     while (max--) {
 618         len = comm_udp_recvfrom(sock,
 619                                 buf,
 620                                 SQUID_UDP_SO_RCVBUF - 1,
 621                                 0,
 622                                 from);
 623
 624         if (len == 0)
 625             break;
 626
 627         if (len < 0) {
 628             if (ignoreErrno(errno))
 629                 break;
 630
 631 #if _SQUID_LINUX_
 632             /* Some Linux systems seem to set the FD for reading and then
 633              * return ECONNREFUSED when sendto() fails and generates an ICMP
 634              * port unreachable message. */
 635             /* or maybe an EHOSTUNREACH "No route to host" message */
 636             if (errno != ECONNREFUSED && errno != EHOSTUNREACH)
 637 #endif
 638
 639                 debugs(50, 1, "icpHandleUdp: FD " << sock << " recvfrom: " << xstrerror());
 640
 641             break;
 642         }
 643
 644         (*N)++;
 645         icpCount(buf, RECV, (size_t) len, 0);
 646         buf[len] = '\0';
 647         debugs(12, 4, "icpHandleUdp: FD " << sock << ": received " <<
 648                (unsigned long int)len << " bytes from " << from);
 649
 650 #ifdef ICP_PACKET_DUMP
 651
 652         icpPktDump(buf);
 653 #endif
 654
 655         if ((size_t) len < sizeof(icp_common_t)) {
 656             debugs(12, 4, "icpHandleUdp: Ignoring too-small UDP packet");
 657             break;
 658         }
 659
 660         icp_version = (int) buf[1];     /* cheat! */
 661
 662         if (icpOutgoingConn->local == from)
 663             // ignore ICP packets which loop back (multicast usually)
 664             debugs(12, 4, "icpHandleUdp: Ignoring UDP packet sent by myself");
 665         else if (icp_version == ICP_VERSION_2)
 666             icpHandleIcpV2(sock, from, buf, len);
 667         else if (icp_version == ICP_VERSION_3)
 668             icpHandleIcpV3(sock, from, buf, len);
 669         else
 670             debugs(12, 1, "WARNING: Unused ICP version " << icp_version <<
 671                    " received from " << from);
 672     }
 673 }
 674
 675 void
 676 icpConnectionsOpen(void)
 677 {
 678     uint16_t port;
 679
 680     if ((port = Config.Port.icp) <= 0)
 681         return;
 682
 683     icpIncomingConn = new Comm::Connection;
 684     icpIncomingConn->local = Config.Addrs.udp_incoming;
 685     icpIncomingConn->local.SetPort(port);
 686
 687     if (!Ip::EnableIpv6 && !icpIncomingConn->local.SetIPv4()) {
 688         debugs(12, DBG_CRITICAL, "ERROR: IPv6 is disabled. " << icpIncomingConn->local << " is not an IPv4 address.");
 689         fatal("ICP port cannot be opened.");
 690     }
 691     /* split-stack for now requires default IPv4-only ICP */
 692     if (Ip::EnableIpv6&IPV6_SPECIAL_SPLITSTACK && icpIncomingConn->local.IsAnyAddr()) {
 693         icpIncomingConn->local.SetIPv4();
 694     }
 695
 696     AsyncCall::Pointer call = asyncCall(12, 2,
 697                                         "icpIncomingConnectionOpened",
 698                                         IcpListeningStartedDialer(&icpIncomingConnectionOpened));
 699
 700     Ipc::StartListening(SOCK_DGRAM,
 701                         IPPROTO_UDP,
 702                         icpIncomingConn,
 703                         Ipc::fdnInIcpSocket, call);
 704
 705     if ( !Config.Addrs.udp_outgoing.IsNoAddr() ) {
 706         icpOutgoingConn = new Comm::Connection;
 707         icpOutgoingConn->local = Config.Addrs.udp_outgoing;
 708         icpOutgoingConn->local.SetPort(port);
 709
 710         if (!Ip::EnableIpv6 && !icpOutgoingConn->local.SetIPv4()) {
 711             debugs(49, DBG_CRITICAL, "ERROR: IPv6 is disabled. " << icpOutgoingConn->local << " is not an IPv4 address.");
 712             fatal("ICP port cannot be opened.");
 713         }
 714         /* split-stack for now requires default IPv4-only ICP */
 715         if (Ip::EnableIpv6&IPV6_SPECIAL_SPLITSTACK && icpOutgoingConn->local.IsAnyAddr()) {
 716             icpOutgoingConn->local.SetIPv4();
 717         }
 718
 719         enter_suid();
 720         comm_open_listener(SOCK_DGRAM, IPPROTO_UDP, icpOutgoingConn, "Outgoing ICP Port");
 721         leave_suid();
 722
 723         if (!Comm::IsConnOpen(icpOutgoingConn))
 724             fatal("Cannot open Outgoing ICP Port");
 725
 726         debugs(12, DBG_CRITICAL, "Sending ICP messages from " << icpOutgoingConn->local);
 727
 728         Comm::SetSelect(icpOutgoingConn->fd, COMM_SELECT_READ, icpHandleUdp, NULL, 0);
 729         fd_note(icpOutgoingConn->fd, "Outgoing ICP socket");
 730     }
 731 }
 732
 733 static void
 734 icpIncomingConnectionOpened(int errNo)
 735 {
 736     if (!Comm::IsConnOpen(icpIncomingConn))
 737         fatal("Cannot open ICP Port");
 738
 739     Comm::SetSelect(icpIncomingConn->fd, COMM_SELECT_READ, icpHandleUdp, NULL, 0);
 740
 741     for (const wordlist *s = Config.mcast_group_list; s; s = s->next)
 742         ipcache_nbgethostbyname(s->key, mcastJoinGroups, NULL); // XXX: pass the icpIncomingConn for mcastJoinGroups usage.
 743
 744     debugs(12, DBG_IMPORTANT, "Accepting ICP messages on " << icpIncomingConn->local);
 745
 746     fd_note(icpIncomingConn->fd, "Incoming ICP port");
 747
 748     if (Config.Addrs.udp_outgoing.IsNoAddr()) {
 749         icpOutgoingConn = icpIncomingConn;
 750         debugs(12, DBG_IMPORTANT, "Sending ICP messages from " << icpOutgoingConn->local);
 751     }
 752 }
 753
 754 /**
 755  * icpConnectionShutdown only closes the 'in' socket if it is
 756  * different than the 'out' socket.
 757  */
 758 void
 759 icpConnectionShutdown(void)
 760 {
 761     if (!Comm::IsConnOpen(icpIncomingConn))
 762         return;
 763
 764     debugs(12, DBG_IMPORTANT, "Stop receiving ICP on " << icpIncomingConn->local);
 765
 766     /** Release the 'in' socket for lazy closure.
 767      * in and out sockets may be sharing one same FD.
 768      * This prevents this function from executing repeatedly.
 769      */
 770     icpIncomingConn = NULL;
 771
 772     /**
 773      * Normally we only write to the outgoing ICP socket, but
 774      * we also have a read handler there to catch messages sent
 775      * to that specific interface.  During shutdown, we must
 776      * disable reading on the outgoing socket.
 777      */
 778     assert(Comm::IsConnOpen(icpOutgoingConn));
 779
 780     Comm::SetSelect(icpOutgoingConn->fd, COMM_SELECT_READ, NULL, NULL, 0);
 781 }
 782
 783 void
 784 icpConnectionClose(void)
 785 {
 786     icpConnectionShutdown();
 787
 788     if (icpOutgoingConn != NULL) {
 789         debugs(12, DBG_IMPORTANT, "Stop sending ICP from " << icpOutgoingConn->local);
 790         icpOutgoingConn = NULL;
 791     }
 792 }
 793
 794 static void
 795 icpCount(void *buf, int which, size_t len, int delay)
 796 {
 797     icp_common_t *icp = (icp_common_t *) buf;
 798
 799     if (len < sizeof(*icp))
 800         return;
 801
 802     if (SENT == which) {
 803         statCounter.icp.pkts_sent++;
 804         kb_incr(&statCounter.icp.kbytes_sent, len);
 805
 806         if (ICP_QUERY == icp->opcode) {
 807             statCounter.icp.queries_sent++;
 808             kb_incr(&statCounter.icp.q_kbytes_sent, len);
 809         } else {
 810             statCounter.icp.replies_sent++;
 811             kb_incr(&statCounter.icp.r_kbytes_sent, len);
 812             /* this is the sent-reply service time */
 813             statHistCount(&statCounter.icp.reply_svc_time, delay);
 814         }
 815
 816         if (ICP_HIT == icp->opcode)
 817             statCounter.icp.hits_sent++;
 818     } else if (RECV == which) {
 819         statCounter.icp.pkts_recv++;
 820         kb_incr(&statCounter.icp.kbytes_recv, len);
 821
 822         if (ICP_QUERY == icp->opcode) {
 823             statCounter.icp.queries_recv++;
 824             kb_incr(&statCounter.icp.q_kbytes_recv, len);
 825         } else {
 826             statCounter.icp.replies_recv++;
 827             kb_incr(&statCounter.icp.r_kbytes_recv, len);
 828             /* statCounter.icp.query_svc_time set in clientUpdateCounters */
 829         }
 830
 831         if (ICP_HIT == icp->opcode)
 832             statCounter.icp.hits_recv++;
 833     }
 834 }
 835
 836 #define N_QUERIED_KEYS 8192
 837 #define N_QUERIED_KEYS_MASK 8191
 838 static cache_key queried_keys[N_QUERIED_KEYS][SQUID_MD5_DIGEST_LENGTH];
 839
 840 int
 841 icpSetCacheKey(const cache_key * key)
 842 {
 843     static int reqnum = 0;
 844
 845     if (++reqnum < 0)
 846         reqnum = 1;
 847
 848     storeKeyCopy(queried_keys[reqnum & N_QUERIED_KEYS_MASK], key);
 849
 850     return reqnum;
 851 }
 852
 853 const cache_key *
 854 icpGetCacheKey(const char *url, int reqnum)
 855 {
 856     if (neighbors_do_private_keys && reqnum)
 857         return queried_keys[reqnum & N_QUERIED_KEYS_MASK];
 858
 859     return storeKeyPublic(url, METHOD_GET);
 860 }