3 * DEBUG: section 72 Peer Digest Routines
4 * AUTHOR: Alex Rousskov
6 * SQUID Web Proxy Cache http://www.squid-cache.org/
7 * ----------------------------------------------------------
9 * Squid is the result of efforts by numerous individuals from
10 * the Internet community; see the CONTRIBUTORS file for full
11 * details. Many organizations have provided support for Squid's
12 * development; see the SPONSORS file for full details. Squid is
13 * Copyrighted (C) 2001 by the Regents of the University of
14 * California; see the COPYRIGHT file for full details. Squid
15 * incorporates software developed and/or copyrighted by other
16 * sources; see the CREDITS file for full details.
18 * This program is free software; you can redistribute it and/or modify
19 * it under the terms of the GNU General Public License as published by
20 * the Free Software Foundation; either version 2 of the License, or
21 * (at your option) any later version.
23 * This program is distributed in the hope that it will be useful,
24 * but WITHOUT ANY WARRANTY; without even the implied warranty of
25 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
26 * GNU General Public License for more details.
28 * You should have received a copy of the GNU General Public License
29 * along with this program; if not, write to the Free Software
30 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
36 #include "CacheDigest.h"
37 #include "CachePeer.h"
41 #include "HttpReply.h"
42 #include "HttpRequest.h"
44 #include "MemObject.h"
45 #include "mime_header.h"
46 #include "neighbors.h"
47 #include "PeerDigest.h"
48 #include "SquidTime.h"
50 #include "store_key_md5.h"
51 #include "StoreClient.h"
56 /* local prototypes */
57 static time_t peerDigestIncDelay(const PeerDigest
* pd
);
58 static time_t peerDigestNewDelay(const StoreEntry
* e
);
59 static void peerDigestSetCheck(PeerDigest
* pd
, time_t delay
);
60 static void peerDigestClean(PeerDigest
*);
61 static EVH peerDigestCheck
;
62 static void peerDigestRequest(PeerDigest
* pd
);
63 static STCB peerDigestHandleReply
;
64 static int peerDigestFetchReply(void *, char *, ssize_t
);
65 int peerDigestSwapInHeaders(void *, char *, ssize_t
);
66 int peerDigestSwapInCBlock(void *, char *, ssize_t
);
67 int peerDigestSwapInMask(void *, char *, ssize_t
);
68 static int peerDigestFetchedEnough(DigestFetchState
* fetch
, char *buf
, ssize_t size
, const char *step_name
);
69 static void peerDigestFetchStop(DigestFetchState
* fetch
, char *buf
, const char *reason
);
70 static void peerDigestFetchAbort(DigestFetchState
* fetch
, char *buf
, const char *reason
);
71 static void peerDigestReqFinish(DigestFetchState
* fetch
, char *buf
, int, int, int, const char *reason
, int err
);
72 static void peerDigestPDFinish(DigestFetchState
* fetch
, int pcb_valid
, int err
);
73 static void peerDigestFetchFinish(DigestFetchState
* fetch
, int err
);
74 static void peerDigestFetchSetStats(DigestFetchState
* fetch
);
75 static int peerDigestSetCBlock(PeerDigest
* pd
, const char *buf
);
76 static int peerDigestUseful(const PeerDigest
* pd
);
79 Version
const CacheDigestVer
= { 5, 3 };
81 #define StoreDigestCBlockSize sizeof(StoreDigestCBlock)
83 /* min interval for requesting digests from a given peer */
84 static const time_t PeerDigestReqMinGap
= 5 * 60; /* seconds */
85 /* min interval for requesting digests (cumulative request stream) */
86 static const time_t GlobDigestReqMinGap
= 1 * 60; /* seconds */
90 static time_t pd_last_req_time
= 0; /* last call to Check */
92 /* initialize peer digest */
94 peerDigestInit(PeerDigest
* pd
, CachePeer
* p
)
98 memset(pd
, 0, sizeof(*pd
));
101 * Lock on to the peer here. The corresponding cbdataReferenceDone()
102 * is in peerDigestDestroy().
104 pd
->peer
= cbdataReference(p
);
105 /* if peer disappears, we will know it's name */
108 pd
->times
.initialized
= squid_curtime
;
112 peerDigestClean(PeerDigest
* pd
)
117 cacheDigestDestroy(pd
->cd
);
122 CBDATA_CLASS_INIT(PeerDigest
);
124 /* allocate new peer digest, call Init, and lock everything */
126 peerDigestCreate(CachePeer
* p
)
132 peerDigestInit(pd
, p
);
134 /* XXX This does not look right, and the same thing again in the caller */
135 return cbdataReference(pd
);
138 /* call Clean and free/unlock everything */
140 peerDigestDestroy(PeerDigest
* pd
)
144 void * peerTmp
= pd
->peer
;
148 * We locked the peer in peerDigestInit(), this is
149 * where we unlock it. If the peer is still valid,
150 * tell it that the digest is gone.
152 if (cbdataReferenceValidDone(peerTmp
, &p
))
153 peerNoteDigestGone((CachePeer
*)p
);
160 /* called by peer to indicate that somebody actually needs this digest */
162 peerDigestNeeded(PeerDigest
* pd
)
165 assert(!pd
->flags
.needed
);
168 pd
->flags
.needed
= true;
169 pd
->times
.needed
= squid_curtime
;
170 peerDigestSetCheck(pd
, 0); /* check asap */
173 /* currently we do not have a reason to disable without destroying */
175 /* disables peer for good */
177 peerDigestDisable(PeerDigest
* pd
)
179 debugs(72, 2, "peerDigestDisable: peer " << pd
->host
.buf() << " disabled for good");
180 pd
->times
.disabled
= squid_curtime
;
181 pd
->times
.next_check
= -1; /* never */
182 pd
->flags
.usable
= 0;
185 cacheDigestDestroy(pd
->cd
);
189 /* we do not destroy the pd itself to preserve its "history" and stats */
194 /* increment retry delay [after an unsuccessful attempt] */
196 peerDigestIncDelay(const PeerDigest
* pd
)
199 return pd
->times
.retry_delay
> 0 ?
200 2 * pd
->times
.retry_delay
: /* exponential backoff */
201 PeerDigestReqMinGap
; /* minimal delay */
204 /* artificially increases Expires: setting to avoid race conditions
205 * returns the delay till that [increased] expiration time */
207 peerDigestNewDelay(const StoreEntry
* e
)
212 return e
->expires
+ PeerDigestReqMinGap
- squid_curtime
;
214 return PeerDigestReqMinGap
;
217 /* registers next digest verification */
219 peerDigestSetCheck(PeerDigest
* pd
, time_t delay
)
221 eventAdd("peerDigestCheck", peerDigestCheck
, pd
, (double) delay
, 1);
222 pd
->times
.next_check
= squid_curtime
+ delay
;
223 debugs(72, 3, "peerDigestSetCheck: will check peer " << pd
->host
<< " in " << delay
<< " secs");
227 * called when peer is about to disappear or have already disappeared
230 peerDigestNotePeerGone(PeerDigest
* pd
)
232 if (pd
->flags
.requested
) {
233 debugs(72, 2, "peerDigest: peer " << pd
->host
<< " gone, will destroy after fetch.");
234 /* do nothing now, the fetching chain will notice and take action */
236 debugs(72, 2, "peerDigest: peer " << pd
->host
<< " is gone, destroying now.");
237 peerDigestDestroy(pd
);
241 /* callback for eventAdd() (with peer digest locked)
242 * request new digest if our copy is too old or if we lack one;
243 * schedule next check otherwise */
245 peerDigestCheck(void *data
)
247 PeerDigest
*pd
= (PeerDigest
*)data
;
250 assert(!pd
->flags
.requested
);
252 pd
->times
.next_check
= 0; /* unknown */
254 if (!cbdataReferenceValid(pd
->peer
)) {
255 peerDigestNotePeerGone(pd
);
259 debugs(72, 3, "peerDigestCheck: peer " << pd
->peer
->host
<< ":" << pd
->peer
->http_port
);
260 debugs(72, 3, "peerDigestCheck: time: " << squid_curtime
<<
261 ", last received: " << (long int) pd
->times
.received
<< " (" <<
262 std::showpos
<< (int) (squid_curtime
- pd
->times
.received
) << ")");
264 /* decide when we should send the request:
265 * request now unless too close to other requests */
266 req_time
= squid_curtime
;
270 if (req_time
- pd
->times
.received
< PeerDigestReqMinGap
) {
271 debugs(72, 2, "peerDigestCheck: " << pd
->host
<<
272 ", avoiding close peer requests (" <<
273 (int) (req_time
- pd
->times
.received
) << " < " <<
274 (int) PeerDigestReqMinGap
<< " secs).");
276 req_time
= pd
->times
.received
+ PeerDigestReqMinGap
;
280 if (req_time
- pd_last_req_time
< GlobDigestReqMinGap
) {
281 debugs(72, 2, "peerDigestCheck: " << pd
->host
<<
282 ", avoiding close requests (" <<
283 (int) (req_time
- pd_last_req_time
) << " < " <<
284 (int) GlobDigestReqMinGap
<< " secs).");
286 req_time
= pd_last_req_time
+ GlobDigestReqMinGap
;
289 if (req_time
<= squid_curtime
)
290 peerDigestRequest(pd
); /* will set pd->flags.requested */
292 peerDigestSetCheck(pd
, req_time
- squid_curtime
);
295 CBDATA_TYPE(DigestFetchState
);
297 /* ask store for a digest */
299 peerDigestRequest(PeerDigest
* pd
)
301 CachePeer
*p
= pd
->peer
;
302 StoreEntry
*e
, *old_e
;
304 const cache_key
*key
;
306 DigestFetchState
*fetch
= NULL
;
307 StoreIOBuffer tempBuffer
;
309 pd
->req_result
= NULL
;
310 pd
->flags
.requested
= true;
312 /* compute future request components */
315 url
= xstrdup(p
->digest_url
);
317 url
= internalRemoteUri(p
->host
, p
->http_port
,
318 "/squid-internal-periodic/", StoreDigestFileName
);
320 req
= HttpRequest::CreateFromUrl(url
);
324 key
= storeKeyPublicByRequest(req
);
326 debugs(72, 2, "peerDigestRequest: " << url
<< " key: " << storeKeyText(key
));
328 /* add custom headers */
329 assert(!req
->header
.len
);
331 req
->header
.putStr(HDR_ACCEPT
, StoreDigestMimeStr
);
333 req
->header
.putStr(HDR_ACCEPT
, "text/html");
336 p
->login
[0] != '*' &&
337 strcmp(p
->login
, "PASS") != 0 &&
338 strcmp(p
->login
, "PASSTHRU") != 0 &&
339 strcmp(p
->login
, "NEGOTIATE") != 0 &&
340 strcmp(p
->login
, "PROXYPASS") != 0) {
341 xstrncpy(req
->login
, p
->login
, MAX_LOGIN_SZ
);
343 /* create fetch state structure */
344 CBDATA_INIT_TYPE(DigestFetchState
);
346 fetch
= cbdataAlloc(DigestFetchState
);
348 fetch
->request
= req
;
349 HTTPMSGLOCK(fetch
->request
);
351 fetch
->pd
= cbdataReference(pd
);
355 fetch
->state
= DIGEST_READ_REPLY
;
357 /* update timestamps */
358 fetch
->start_time
= squid_curtime
;
360 pd
->times
.requested
= squid_curtime
;
362 pd_last_req_time
= squid_curtime
;
364 req
->flags
.cachable
= true;
366 /* the rest is based on clientProcessExpired() */
367 req
->flags
.refresh
= true;
369 old_e
= fetch
->old_entry
= Store::Root().get(key
);
372 debugs(72, 5, "peerDigestRequest: found old entry");
374 old_e
->lock("peerDigestRequest");
375 old_e
->createMemObject(url
, url
, req
->method
);
377 fetch
->old_sc
= storeClientListAdd(old_e
, fetch
);
380 e
= fetch
->entry
= storeCreateEntry(url
, url
, req
->flags
, req
->method
);
381 assert(EBIT_TEST(e
->flags
, KEY_PRIVATE
));
382 fetch
->sc
= storeClientListAdd(e
, fetch
);
383 /* set lastmod to trigger IMS request if possible */
386 e
->lastmod
= old_e
->lastmod
;
388 /* push towards peer cache */
389 debugs(72, 3, "peerDigestRequest: forwarding to fwdStart...");
391 FwdState::fwdStart(Comm::ConnectionPointer(), e
, req
);
393 tempBuffer
.offset
= 0;
395 tempBuffer
.length
= SM_PAGE_SIZE
;
397 tempBuffer
.data
= fetch
->buf
;
399 storeClientCopy(fetch
->sc
, e
, tempBuffer
,
400 peerDigestHandleReply
, fetch
);
405 /* Handle the data copying .. */
408 * This routine handles the copy data and then redirects the
409 * copy to a bunch of subfunctions depending upon the copy state.
410 * It also tracks the buffer offset and "seen", since I'm actually
411 * not interested in rewriting everything to suit my little idea.
414 peerDigestHandleReply(void *data
, StoreIOBuffer receivedData
)
416 DigestFetchState
*fetch
= (DigestFetchState
*)data
;
418 digest_read_state_t prevstate
;
421 assert(fetch
->pd
&& receivedData
.data
);
422 /* The existing code assumes that the received pointer is
423 * where we asked the data to be put
425 assert(fetch
->buf
+ fetch
->bufofs
== receivedData
.data
);
427 /* Update the buffer size */
428 fetch
->bufofs
+= receivedData
.length
;
430 assert(fetch
->bufofs
<= SM_PAGE_SIZE
);
432 /* If we've fetched enough, return */
434 if (peerDigestFetchedEnough(fetch
, fetch
->buf
, fetch
->bufofs
, "peerDigestHandleReply"))
437 /* Call the right function based on the state */
438 /* (Those functions will update the state if needed) */
440 /* Give us a temporary reference. Some of the calls we make may
441 * try to destroy the fetch structure, and we like to know if they
444 fetch
= cbdataReference(fetch
);
446 /* Repeat this loop until we're out of data OR the state changes */
447 /* (So keep going if the state has changed and we still have data */
449 prevstate
= fetch
->state
;
451 switch (fetch
->state
) {
453 case DIGEST_READ_REPLY
:
454 retsize
= peerDigestFetchReply(fetch
, fetch
->buf
, fetch
->bufofs
);
457 case DIGEST_READ_HEADERS
:
458 retsize
= peerDigestSwapInHeaders(fetch
, fetch
->buf
, fetch
->bufofs
);
461 case DIGEST_READ_CBLOCK
:
462 retsize
= peerDigestSwapInCBlock(fetch
, fetch
->buf
, fetch
->bufofs
);
465 case DIGEST_READ_MASK
:
466 retsize
= peerDigestSwapInMask(fetch
, fetch
->buf
, fetch
->bufofs
);
469 case DIGEST_READ_NONE
:
472 case DIGEST_READ_DONE
:
477 fatal("Bad digest transfer mode!\n");
484 * The returned size indicates how much of the buffer was read -
485 * so move the remainder of the buffer to the beginning
486 * and update the bufofs / bufsize
488 newsize
= fetch
->bufofs
- retsize
;
490 memmove(fetch
->buf
, fetch
->buf
+ retsize
, fetch
->bufofs
- newsize
);
492 fetch
->bufofs
= newsize
;
494 } while (cbdataReferenceValid(fetch
) && prevstate
!= fetch
->state
&& fetch
->bufofs
> 0);
496 /* Update the copy offset */
497 fetch
->offset
+= receivedData
.length
;
499 /* Schedule another copy */
500 if (cbdataReferenceValid(fetch
)) {
501 StoreIOBuffer tempBuffer
;
502 tempBuffer
.offset
= fetch
->offset
;
503 tempBuffer
.length
= SM_PAGE_SIZE
- fetch
->bufofs
;
504 tempBuffer
.data
= fetch
->buf
+ fetch
->bufofs
;
505 storeClientCopy(fetch
->sc
, fetch
->entry
, tempBuffer
,
506 peerDigestHandleReply
, fetch
);
510 /* Get rid of our reference, we've finished with it for now */
511 cbdataReferenceDone(fetch
);
514 /* wait for full http headers to be received then parse them */
516 * This routine handles parsing the reply line.
517 * If the reply line indicates an OK, the same data is thrown
518 * to SwapInHeaders(). If the reply line is a NOT_MODIFIED,
519 * we simply stop parsing.
522 peerDigestFetchReply(void *data
, char *buf
, ssize_t size
)
524 DigestFetchState
*fetch
= (DigestFetchState
*)data
;
525 PeerDigest
*pd
= fetch
->pd
;
528 assert(!fetch
->offset
);
530 assert(fetch
->state
== DIGEST_READ_REPLY
);
532 if (peerDigestFetchedEnough(fetch
, buf
, size
, "peerDigestFetchReply"))
535 if ((hdr_size
= headersEnd(buf
, size
))) {
536 HttpReply
const *reply
= fetch
->entry
->getReply();
538 assert(reply
->sline
.status() != Http::scNone
);
539 const Http::StatusCode status
= reply
->sline
.status();
540 debugs(72, 3, "peerDigestFetchReply: " << pd
->host
<< " status: " << status
<<
541 ", expires: " << (long int) reply
->expires
<< " (" << std::showpos
<<
542 (int) (reply
->expires
- squid_curtime
) << ")");
544 /* this "if" is based on clientHandleIMSReply() */
546 if (status
== Http::scNotModified
) {
547 /* our old entry is fine */
548 assert(fetch
->old_entry
);
550 if (!fetch
->old_entry
->mem_obj
->request
) {
551 fetch
->old_entry
->mem_obj
->request
= fetch
->entry
->mem_obj
->request
;
552 HTTPMSGLOCK(fetch
->old_entry
->mem_obj
->request
);
555 assert(fetch
->old_entry
->mem_obj
->request
);
557 HttpReply
*old_rep
= (HttpReply
*) fetch
->old_entry
->getReply();
559 old_rep
->updateOnNotModified(reply
);
561 fetch
->old_entry
->timestampsSet();
563 /* get rid of 304 reply */
564 storeUnregister(fetch
->sc
, fetch
->entry
, fetch
);
566 fetch
->entry
->unlock("peerDigestFetchReply 304");
568 fetch
->entry
= fetch
->old_entry
;
570 fetch
->old_entry
= NULL
;
572 /* preserve request -- we need its size to update counters */
573 /* requestUnlink(r); */
574 /* fetch->entry->mem_obj->request = NULL; */
575 } else if (status
== Http::scOkay
) {
576 /* get rid of old entry if any */
578 if (fetch
->old_entry
) {
579 debugs(72, 3, "peerDigestFetchReply: got new digest, releasing old one");
580 storeUnregister(fetch
->old_sc
, fetch
->old_entry
, fetch
);
581 fetch
->old_entry
->releaseRequest();
582 fetch
->old_entry
->unlock("peerDigestFetchReply 200");
583 fetch
->old_entry
= NULL
;
586 /* some kind of a bug */
587 peerDigestFetchAbort(fetch
, buf
, reply
->sline
.reason());
588 return -1; /* XXX -1 will abort stuff in ReadReply! */
591 /* must have a ready-to-use store entry if we got here */
592 /* can we stay with the old in-memory digest? */
593 if (status
== Http::scNotModified
&& fetch
->pd
->cd
) {
594 peerDigestFetchStop(fetch
, buf
, "Not modified");
595 fetch
->state
= DIGEST_READ_DONE
;
597 fetch
->state
= DIGEST_READ_HEADERS
;
600 /* need more data, do we have space? */
602 if (size
>= SM_PAGE_SIZE
)
603 peerDigestFetchAbort(fetch
, buf
, "reply header too big");
606 /* We don't want to actually ack that we've handled anything,
607 * otherwise SwapInHeaders() won't get the reply line .. */
611 /* fetch headers from disk, pass on to SwapInCBlock */
613 peerDigestSwapInHeaders(void *data
, char *buf
, ssize_t size
)
615 DigestFetchState
*fetch
= (DigestFetchState
*)data
;
618 assert(fetch
->state
== DIGEST_READ_HEADERS
);
620 if (peerDigestFetchedEnough(fetch
, buf
, size
, "peerDigestSwapInHeaders"))
623 assert(!fetch
->offset
);
625 if ((hdr_size
= headersEnd(buf
, size
))) {
626 assert(fetch
->entry
->getReply());
627 assert(fetch
->entry
->getReply()->sline
.status() != Http::scNone
);
629 if (fetch
->entry
->getReply()->sline
.status() != Http::scOkay
) {
630 debugs(72, DBG_IMPORTANT
, "peerDigestSwapInHeaders: " << fetch
->pd
->host
<<
631 " status " << fetch
->entry
->getReply()->sline
.status() <<
634 peerDigestFetchAbort(fetch
, buf
, "internal status error");
638 fetch
->state
= DIGEST_READ_CBLOCK
;
639 return hdr_size
; /* Say how much data we read */
641 /* need more data, do we have space? */
643 if (size
>= SM_PAGE_SIZE
) {
644 peerDigestFetchAbort(fetch
, buf
, "stored header too big");
647 return 0; /* We need to read more to parse .. */
651 fatal("peerDigestSwapInHeaders() - shouldn't get here!\n");
652 return 0; /* keep gcc happy */
656 peerDigestSwapInCBlock(void *data
, char *buf
, ssize_t size
)
658 DigestFetchState
*fetch
= (DigestFetchState
*)data
;
660 assert(fetch
->state
== DIGEST_READ_CBLOCK
);
662 if (peerDigestFetchedEnough(fetch
, buf
, size
, "peerDigestSwapInCBlock"))
665 if (size
>= (ssize_t
)StoreDigestCBlockSize
) {
666 PeerDigest
*pd
= fetch
->pd
;
668 assert(pd
&& fetch
->entry
->getReply());
670 if (peerDigestSetCBlock(pd
, buf
)) {
671 /* XXX: soon we will have variable header size */
672 /* switch to CD buffer and fetch digest guts */
674 assert(pd
->cd
->mask
);
675 fetch
->state
= DIGEST_READ_MASK
;
676 return StoreDigestCBlockSize
;
678 peerDigestFetchAbort(fetch
, buf
, "invalid digest cblock");
682 /* need more data, do we have space? */
684 if (size
>= SM_PAGE_SIZE
) {
685 peerDigestFetchAbort(fetch
, buf
, "digest cblock too big");
688 return 0; /* We need more data */
692 fatal("peerDigestSwapInCBlock(): shouldn't get here!\n");
693 return 0; /* keep gcc happy */
697 peerDigestSwapInMask(void *data
, char *buf
, ssize_t size
)
699 DigestFetchState
*fetch
= (DigestFetchState
*)data
;
703 assert(pd
->cd
&& pd
->cd
->mask
);
706 * NOTENOTENOTENOTENOTE: buf doesn't point to pd->cd->mask anymore!
707 * we need to do the copy ourselves!
709 memcpy(pd
->cd
->mask
+ fetch
->mask_offset
, buf
, size
);
711 /* NOTE! buf points to the middle of pd->cd->mask! */
713 if (peerDigestFetchedEnough(fetch
, NULL
, size
, "peerDigestSwapInMask"))
716 fetch
->mask_offset
+= size
;
718 if (fetch
->mask_offset
>= pd
->cd
->mask_size
) {
719 debugs(72, 2, "peerDigestSwapInMask: Done! Got " <<
720 fetch
->mask_offset
<< ", expected " << pd
->cd
->mask_size
);
721 assert(fetch
->mask_offset
== pd
->cd
->mask_size
);
722 assert(peerDigestFetchedEnough(fetch
, NULL
, 0, "peerDigestSwapInMask"));
723 return -1; /* XXX! */
725 /* We always read everything, so return so */
729 fatal("peerDigestSwapInMask(): shouldn't get here!\n");
730 return 0; /* keep gcc happy */
734 peerDigestFetchedEnough(DigestFetchState
* fetch
, char *buf
, ssize_t size
, const char *step_name
)
736 PeerDigest
*pd
= NULL
;
737 const char *host
= "<unknown>"; /* peer host */
738 const char *reason
= NULL
; /* reason for completion */
739 const char *no_bug
= NULL
; /* successful completion if set */
740 const int pdcb_valid
= cbdataReferenceValid(fetch
->pd
);
741 const int pcb_valid
= cbdataReferenceValid(fetch
->pd
->peer
);
743 /* test possible exiting conditions (the same for most steps!)
744 * cases marked with '?!' should not happen */
747 if (!(pd
= fetch
->pd
))
748 reason
= "peer digest disappeared?!";
750 #if DONT /* WHY NOT? /HNO */
752 else if (!cbdataReferenceValid(pd
))
753 reason
= "invalidated peer digest?!";
758 host
= pd
->host
.termedBuf();
761 debugs(72, 6, step_name
<< ": peer " << host
<< ", offset: " <<
762 fetch
->offset
<< " size: " << size
<< ".");
764 /* continue checking (with pd and host known and valid) */
767 if (!cbdataReferenceValid(pd
->peer
))
768 reason
= "peer disappeared";
770 reason
= "swap failure";
771 else if (!fetch
->entry
)
772 reason
= "swap aborted?!";
773 else if (EBIT_TEST(fetch
->entry
->flags
, ENTRY_ABORTED
))
774 reason
= "swap aborted";
777 /* continue checking (maybe-successful eof case) */
778 if (!reason
&& !size
) {
780 reason
= "null digest?!";
781 else if (fetch
->mask_offset
!= (int)pd
->cd
->mask_size
)
782 reason
= "premature end of digest?!";
783 else if (!peerDigestUseful(pd
))
784 reason
= "useless digest";
786 reason
= no_bug
= "success";
789 /* finish if we have a reason */
791 const int level
= strstr(reason
, "?!") ? 1 : 3;
792 debugs(72, level
, "" << step_name
<< ": peer " << host
<< ", exiting after '" << reason
<< "'");
793 peerDigestReqFinish(fetch
, buf
,
794 1, pdcb_valid
, pcb_valid
, reason
, !no_bug
);
797 assert(pdcb_valid
&& pcb_valid
);
800 return reason
!= NULL
;
803 /* call this when all callback data is valid and fetch must be stopped but
804 * no error has occurred (e.g. we received 304 reply and reuse old digest) */
806 peerDigestFetchStop(DigestFetchState
* fetch
, char *buf
, const char *reason
)
809 debugs(72, 2, "peerDigestFetchStop: peer " << fetch
->pd
->host
<< ", reason: " << reason
);
810 peerDigestReqFinish(fetch
, buf
, 1, 1, 1, reason
, 0);
813 /* call this when all callback data is valid but something bad happened */
815 peerDigestFetchAbort(DigestFetchState
* fetch
, char *buf
, const char *reason
)
818 debugs(72, 2, "peerDigestFetchAbort: peer " << fetch
->pd
->host
<< ", reason: " << reason
);
819 peerDigestReqFinish(fetch
, buf
, 1, 1, 1, reason
, 1);
822 /* complete the digest transfer, update stats, unlock/release everything */
824 peerDigestReqFinish(DigestFetchState
* fetch
, char *buf
,
825 int fcb_valid
, int pdcb_valid
, int pcb_valid
,
826 const char *reason
, int err
)
830 /* must go before peerDigestPDFinish */
833 fetch
->pd
->flags
.requested
= false;
834 fetch
->pd
->req_result
= reason
;
837 /* schedule next check if peer is still out there */
839 PeerDigest
*pd
= fetch
->pd
;
842 pd
->times
.retry_delay
= peerDigestIncDelay(pd
);
843 peerDigestSetCheck(pd
, pd
->times
.retry_delay
);
845 pd
->times
.retry_delay
= 0;
846 peerDigestSetCheck(pd
, peerDigestNewDelay(fetch
->entry
));
850 /* note: order is significant */
852 peerDigestFetchSetStats(fetch
);
855 peerDigestPDFinish(fetch
, pcb_valid
, err
);
858 peerDigestFetchFinish(fetch
, err
);
861 /* destroys digest if peer disappeared
862 * must be called only when fetch and pd cbdata are valid */
864 peerDigestPDFinish(DigestFetchState
* fetch
, int pcb_valid
, int err
)
866 PeerDigest
*pd
= fetch
->pd
;
867 const char *host
= pd
->host
.termedBuf();
869 pd
->times
.received
= squid_curtime
;
870 pd
->times
.req_delay
= fetch
->resp_time
;
871 kb_incr(&pd
->stats
.sent
.kbytes
, (size_t) fetch
->sent
.bytes
);
872 kb_incr(&pd
->stats
.recv
.kbytes
, (size_t) fetch
->recv
.bytes
);
873 pd
->stats
.sent
.msgs
+= fetch
->sent
.msg
;
874 pd
->stats
.recv
.msgs
+= fetch
->recv
.msg
;
877 debugs(72, DBG_IMPORTANT
, "" << (pcb_valid
? "temporary " : "" ) << "disabling (" << pd
->req_result
<< ") digest from " << host
);
880 cacheDigestDestroy(pd
->cd
);
884 pd
->flags
.usable
= false;
887 peerDigestNotePeerGone(pd
);
891 pd
->flags
.usable
= true;
893 /* XXX: ugly condition, but how? */
895 if (fetch
->entry
->store_status
== STORE_OK
)
896 debugs(72, 2, "re-used old digest from " << host
);
898 debugs(72, 2, "received valid digest from " << host
);
901 cbdataReferenceDone(fetch
->pd
);
904 /* free fetch state structures
905 * must be called only when fetch cbdata is valid */
907 peerDigestFetchFinish(DigestFetchState
* fetch
, int err
)
909 assert(fetch
->entry
&& fetch
->request
);
911 if (fetch
->old_entry
) {
912 debugs(72, 3, "peerDigestFetchFinish: deleting old entry");
913 storeUnregister(fetch
->old_sc
, fetch
->old_entry
, fetch
);
914 fetch
->old_entry
->releaseRequest();
915 fetch
->old_entry
->unlock("peerDigestFetchFinish old");
916 fetch
->old_entry
= NULL
;
919 /* update global stats */
920 kb_incr(&statCounter
.cd
.kbytes_sent
, (size_t) fetch
->sent
.bytes
);
922 kb_incr(&statCounter
.cd
.kbytes_recv
, (size_t) fetch
->recv
.bytes
);
924 statCounter
.cd
.msgs_sent
+= fetch
->sent
.msg
;
926 statCounter
.cd
.msgs_recv
+= fetch
->recv
.msg
;
928 /* unlock everything */
929 storeUnregister(fetch
->sc
, fetch
->entry
, fetch
);
931 fetch
->entry
->unlock("peerDigestFetchFinish new");
933 HTTPMSGUNLOCK(fetch
->request
);
937 assert(fetch
->pd
== NULL
);
942 /* calculate fetch stats after completion */
944 peerDigestFetchSetStats(DigestFetchState
* fetch
)
947 assert(fetch
->entry
&& fetch
->request
);
949 mem
= fetch
->entry
->mem_obj
;
952 /* XXX: outgoing numbers are not precise */
953 /* XXX: we must distinguish between 304 hits and misses here */
954 fetch
->sent
.bytes
= fetch
->request
->prefixLen();
955 /* XXX: this is slightly wrong: we don't KNOW that the entire memobject
956 * was fetched. We only know how big it is
958 fetch
->recv
.bytes
= mem
->size();
959 fetch
->sent
.msg
= fetch
->recv
.msg
= 1;
960 fetch
->expires
= fetch
->entry
->expires
;
961 fetch
->resp_time
= squid_curtime
- fetch
->start_time
;
963 debugs(72, 3, "peerDigestFetchFinish: recv " << fetch
->recv
.bytes
<<
964 " bytes in " << (int) fetch
->resp_time
<< " secs");
966 debugs(72, 3, "peerDigestFetchFinish: expires: " <<
967 (long int) fetch
->expires
<< " (" << std::showpos
<<
968 (int) (fetch
->expires
- squid_curtime
) << "), lmt: " <<
969 std::noshowpos
<< (long int) fetch
->entry
->lastmod
<< " (" <<
970 std::showpos
<< (int) (fetch
->entry
->lastmod
- squid_curtime
) <<
976 peerDigestSetCBlock(PeerDigest
* pd
, const char *buf
)
978 StoreDigestCBlock cblock
;
980 const char *host
= pd
->host
.termedBuf();
982 memcpy(&cblock
, buf
, sizeof(cblock
));
983 /* network -> host conversions */
984 cblock
.ver
.current
= ntohs(cblock
.ver
.current
);
985 cblock
.ver
.required
= ntohs(cblock
.ver
.required
);
986 cblock
.capacity
= ntohl(cblock
.capacity
);
987 cblock
.count
= ntohl(cblock
.count
);
988 cblock
.del_count
= ntohl(cblock
.del_count
);
989 cblock
.mask_size
= ntohl(cblock
.mask_size
);
990 debugs(72, 2, "got digest cblock from " << host
<< "; ver: " <<
991 (int) cblock
.ver
.current
<< " (req: " << (int) cblock
.ver
.required
<<
994 debugs(72, 2, "\t size: " <<
995 cblock
.mask_size
<< " bytes, e-cnt: " <<
996 cblock
.count
<< ", e-util: " <<
997 xpercentInt(cblock
.count
, cblock
.capacity
) << "%" );
998 /* check version requirements (both ways) */
1000 if (cblock
.ver
.required
> CacheDigestVer
.current
) {
1001 debugs(72, DBG_IMPORTANT
, "" << host
<< " digest requires version " <<
1002 cblock
.ver
.required
<< "; have: " << CacheDigestVer
.current
);
1007 if (cblock
.ver
.current
< CacheDigestVer
.required
) {
1008 debugs(72, DBG_IMPORTANT
, "" << host
<< " digest is version " <<
1009 cblock
.ver
.current
<< "; we require: " <<
1010 CacheDigestVer
.required
);
1015 /* check consistency */
1016 if (cblock
.ver
.required
> cblock
.ver
.current
||
1017 cblock
.mask_size
<= 0 || cblock
.capacity
<= 0 ||
1018 cblock
.bits_per_entry
<= 0 || cblock
.hash_func_count
<= 0) {
1019 debugs(72, DBG_CRITICAL
, "" << host
<< " digest cblock is corrupted.");
1023 /* check consistency further */
1024 if ((size_t)cblock
.mask_size
!= cacheDigestCalcMaskSize(cblock
.capacity
, cblock
.bits_per_entry
)) {
1025 debugs(72, DBG_CRITICAL
, host
<< " digest cblock is corrupted " <<
1026 "(mask size mismatch: " << cblock
.mask_size
<< " ? " <<
1027 cacheDigestCalcMaskSize(cblock
.capacity
, cblock
.bits_per_entry
)
1032 /* there are some things we cannot do yet */
1033 if (cblock
.hash_func_count
!= CacheDigestHashFuncCount
) {
1034 debugs(72, DBG_CRITICAL
, "" << host
<< " digest: unsupported #hash functions: " <<
1035 cblock
.hash_func_count
<< " ? " << CacheDigestHashFuncCount
<< ".");
1040 * no cblock bugs below this point
1042 /* check size changes */
1043 if (pd
->cd
&& cblock
.mask_size
!= (ssize_t
)pd
->cd
->mask_size
) {
1044 debugs(72, 2, host
<< " digest changed size: " << cblock
.mask_size
<<
1045 " -> " << pd
->cd
->mask_size
);
1046 freed_size
= pd
->cd
->mask_size
;
1047 cacheDigestDestroy(pd
->cd
);
1052 debugs(72, 2, "creating " << host
<< " digest; size: " << cblock
.mask_size
<< " (" <<
1053 std::showpos
<< (int) (cblock
.mask_size
- freed_size
) << ") bytes");
1054 pd
->cd
= cacheDigestCreate(cblock
.capacity
, cblock
.bits_per_entry
);
1056 if (cblock
.mask_size
>= freed_size
)
1057 kb_incr(&statCounter
.cd
.memory
, cblock
.mask_size
- freed_size
);
1061 /* these assignments leave us in an inconsistent state until we finish reading the digest */
1062 pd
->cd
->count
= cblock
.count
;
1063 pd
->cd
->del_count
= cblock
.del_count
;
1068 peerDigestUseful(const PeerDigest
* pd
)
1070 /* TODO: we should calculate the prob of a false hit instead of bit util */
1071 const int bit_util
= cacheDigestBitUtil(pd
->cd
);
1073 if (bit_util
> 65) {
1074 debugs(72, DBG_CRITICAL
, "Warning: " << pd
->host
<<
1075 " peer digest has too many bits on (" << bit_util
<< "%%).");
1084 saneDiff(time_t diff
)
1086 return abs((int) diff
) > squid_curtime
/ 2 ? 0 : diff
;
1090 peerDigestStatsReport(const PeerDigest
* pd
, StoreEntry
* e
)
1092 #define f2s(flag) (pd->flags.flag ? "yes" : "no")
1093 #define appendTime(tm) storeAppendPrintf(e, "%s\t %10ld\t %+d\t %+d\n", \
1094 ""#tm, (long int)pd->times.tm, \
1095 saneDiff(pd->times.tm - squid_curtime), \
1096 saneDiff(pd->times.tm - pd->times.initialized))
1100 const char *host
= pd
->host
.termedBuf();
1101 storeAppendPrintf(e
, "\npeer digest from %s\n", host
);
1103 cacheDigestGuessStatsReport(&pd
->stats
.guess
, e
, host
);
1105 storeAppendPrintf(e
, "\nevent\t timestamp\t secs from now\t secs from init\n");
1106 appendTime(initialized
);
1108 appendTime(requested
);
1109 appendTime(received
);
1110 appendTime(next_check
);
1112 storeAppendPrintf(e
, "peer digest state:\n");
1113 storeAppendPrintf(e
, "\tneeded: %3s, usable: %3s, requested: %3s\n",
1114 f2s(needed
), f2s(usable
), f2s(requested
));
1115 storeAppendPrintf(e
, "\n\tlast retry delay: %d secs\n",
1116 (int) pd
->times
.retry_delay
);
1117 storeAppendPrintf(e
, "\tlast request response time: %d secs\n",
1118 (int) pd
->times
.req_delay
);
1119 storeAppendPrintf(e
, "\tlast request result: %s\n",
1120 pd
->req_result
? pd
->req_result
: "(none)");
1122 storeAppendPrintf(e
, "\npeer digest traffic:\n");
1123 storeAppendPrintf(e
, "\trequests sent: %d, volume: %d KB\n",
1124 pd
->stats
.sent
.msgs
, (int) pd
->stats
.sent
.kbytes
.kb
);
1125 storeAppendPrintf(e
, "\treplies recv: %d, volume: %d KB\n",
1126 pd
->stats
.recv
.msgs
, (int) pd
->stats
.recv
.kbytes
.kb
);
1128 storeAppendPrintf(e
, "\npeer digest structure:\n");
1131 cacheDigestReport(pd
->cd
, host
, e
);
1133 storeAppendPrintf(e
, "\tno in-memory copy\n");