]>
Commit | Line | Data |
---|---|---|
9b7de833 | 1 | |
2 | /* | |
db1cd23c | 3 | * $Id: peer_digest.cc,v 1.63 1998/12/05 00:54:35 wessels Exp $ |
9b7de833 | 4 | * |
5 | * DEBUG: section 72 Peer Digest Routines | |
6 | * AUTHOR: Alex Rousskov | |
7 | * | |
8 | * SQUID Internet Object Cache http://squid.nlanr.net/Squid/ | |
e25c139f | 9 | * ---------------------------------------------------------- |
9b7de833 | 10 | * |
11 | * Squid is the result of efforts by numerous individuals from the | |
12 | * Internet community. Development is led by Duane Wessels of the | |
e25c139f | 13 | * National Laboratory for Applied Network Research and funded by the |
14 | * National Science Foundation. Squid is Copyrighted (C) 1998 by | |
15 | * Duane Wessels and the University of California San Diego. Please | |
16 | * see the COPYRIGHT file for full details. Squid incorporates | |
17 | * software developed and/or copyrighted by other sources. Please see | |
18 | * the CREDITS file for full details. | |
9b7de833 | 19 | * |
20 | * This program is free software; you can redistribute it and/or modify | |
21 | * it under the terms of the GNU General Public License as published by | |
22 | * the Free Software Foundation; either version 2 of the License, or | |
23 | * (at your option) any later version. | |
24 | * | |
25 | * This program is distributed in the hope that it will be useful, | |
26 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
27 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
28 | * GNU General Public License for more details. | |
29 | * | |
30 | * You should have received a copy of the GNU General Public License | |
31 | * along with this program; if not, write to the Free Software | |
cbdec147 | 32 | * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA. |
e25c139f | 33 | * |
9b7de833 | 34 | */ |
35 | ||
36 | #include "squid.h" | |
37 | ||
6cfa8966 | 38 | #if USE_CACHE_DIGESTS |
7a2e5bb5 | 39 | |
9b7de833 | 40 | /* local types */ |
41 | ||
42 | /* local prototypes */ | |
e13ee7ad | 43 | static time_t peerDigestIncDelay(const PeerDigest * pd); |
44 | static time_t peerDigestNewDelay(const StoreEntry * e); | |
45 | static void peerDigestSetCheck(PeerDigest * pd, time_t delay); | |
eb16313f | 46 | static void peerDigestClean(PeerDigest *); |
e13ee7ad | 47 | static EVH peerDigestCheck; |
48 | static void peerDigestRequest(PeerDigest * pd); | |
c68e9c6b | 49 | static STCB peerDigestFetchReply; |
c68e9c6b | 50 | static STCB peerDigestSwapInHeaders; |
51 | static STCB peerDigestSwapInCBlock; | |
da407def | 52 | static STCB peerDigestSwapInMask; |
4b4cd312 | 53 | static int peerDigestFetchedEnough(DigestFetchState * fetch, char *buf, ssize_t size, const char *step_name); |
551e60a9 | 54 | static void peerDigestFetchStop(DigestFetchState * fetch, char *buf, const char *reason); |
e13ee7ad | 55 | static void peerDigestFetchAbort(DigestFetchState * fetch, char *buf, const char *reason); |
56 | static void peerDigestReqFinish(DigestFetchState * fetch, char *buf, int, int, int, const char *reason, int err); | |
57 | static void peerDigestPDFinish(DigestFetchState * fetch, int pcb_valid, int err); | |
58 | static void peerDigestFetchFinish(DigestFetchState * fetch, int err); | |
59 | static void peerDigestFetchSetStats(DigestFetchState * fetch); | |
60 | static int peerDigestSetCBlock(PeerDigest * pd, const char *buf); | |
61 | static int peerDigestUseful(const PeerDigest * pd); | |
395b813e | 62 | |
9b7de833 | 63 | |
64 | /* local constants */ | |
9d486b43 | 65 | |
9b7de833 | 66 | #define StoreDigestCBlockSize sizeof(StoreDigestCBlock) |
67 | ||
e13ee7ad | 68 | /* min interval for requesting digests from a given peer */ |
69 | static const time_t PeerDigestReqMinGap = 5 * 60; /* seconds */ | |
70 | /* min interval for requesting digests (cumulative request stream) */ | |
71 | static const time_t GlobDigestReqMinGap = 1 * 60; /* seconds */ | |
bd890734 | 72 | |
73 | /* local vars */ | |
9d486b43 | 74 | |
8a6218c6 | 75 | static time_t pd_last_req_time = 0; /* last call to Check */ |
9b7de833 | 76 | |
e13ee7ad | 77 | /* initialize peer digest */ |
78 | static void | |
8a6218c6 | 79 | peerDigestInit(PeerDigest * pd, peer * p) |
9b7de833 | 80 | { |
e13ee7ad | 81 | assert(pd && p); |
82 | ||
83 | memset(pd, 0, sizeof(*pd)); | |
84 | pd->peer = p; | |
85 | /* if peer disappears, we will know it's name */ | |
86 | stringInit(&pd->host, p->host); | |
87 | ||
88 | pd->times.initialized = squid_curtime; | |
9b7de833 | 89 | } |
90 | ||
4b4cd312 | 91 | static void |
8a6218c6 | 92 | peerDigestClean(PeerDigest * pd) |
9b7de833 | 93 | { |
e13ee7ad | 94 | assert(pd); |
95 | if (pd->cd) | |
96 | cacheDigestDestroy(pd->cd); | |
97 | stringClean(&pd->host); | |
9b7de833 | 98 | } |
99 | ||
e13ee7ad | 100 | /* allocate new peer digest, call Init, and lock everything */ |
101 | PeerDigest * | |
8a6218c6 | 102 | peerDigestCreate(peer * p) |
e13ee7ad | 103 | { |
104 | PeerDigest *pd; | |
8a6218c6 | 105 | assert(p); |
e13ee7ad | 106 | /* cannot check cbdataValid(p) because p may not be locked yet */ |
107 | ||
108 | pd = memAllocate(MEM_PEER_DIGEST); | |
db1cd23c | 109 | cbdataAdd(pd, memFree, MEM_PEER_DIGEST); |
e13ee7ad | 110 | peerDigestInit(pd, p); |
8a6218c6 | 111 | cbdataLock(pd->peer); /* we will use the peer */ |
e13ee7ad | 112 | |
113 | return pd; | |
114 | } | |
115 | ||
116 | /* call Clean and free/unlock everything */ | |
117 | void | |
8a6218c6 | 118 | peerDigestDestroy(PeerDigest * pd) |
e13ee7ad | 119 | { |
120 | assert(pd); | |
121 | assert(cbdataValid(pd)); | |
122 | ||
123 | /* inform peer (if any) that we are gone */ | |
124 | if (cbdataValid(pd->peer)) | |
125 | peerNoteDigestGone(pd->peer); | |
8a6218c6 | 126 | cbdataUnlock(pd->peer); /* must unlock, valid or not */ |
e13ee7ad | 127 | pd->peer = NULL; |
128 | ||
129 | peerDigestClean(pd); | |
130 | cbdataFree(pd); | |
131 | } | |
132 | ||
133 | /* called by peer to indicate that somebody actually needs this digest */ | |
134 | void | |
8a6218c6 | 135 | peerDigestNeeded(PeerDigest * pd) |
e13ee7ad | 136 | { |
137 | assert(pd); | |
138 | assert(!pd->flags.needed); | |
139 | assert(!pd->cd); | |
140 | ||
141 | pd->flags.needed = 1; | |
142 | pd->times.needed = squid_curtime; | |
8a6218c6 | 143 | peerDigestSetCheck(pd, 0); /* check asap */ |
e13ee7ad | 144 | } |
145 | ||
146 | /* currently we do not have a reason to disable without destroying */ | |
8a6218c6 | 147 | #if FUTURE_CODE |
395b813e | 148 | /* disables peer for good */ |
149 | static void | |
8a6218c6 | 150 | peerDigestDisable(PeerDigest * pd) |
395b813e | 151 | { |
8a6218c6 | 152 | debug(72, 2) ("peerDigestDisable: peer %s disabled for good\n", |
e13ee7ad | 153 | strBuf(pd->host)); |
154 | pd->times.disabled = squid_curtime; | |
8a6218c6 | 155 | pd->times.next_check = -1; /* never */ |
e13ee7ad | 156 | pd->flags.usable = 0; |
157 | ||
158 | if (pd->cd) { | |
159 | cacheDigestDestroy(pd->cd); | |
160 | pd->cd = NULL; | |
161 | } | |
162 | /* we do not destroy the pd itself to preserve its "history" and stats */ | |
395b813e | 163 | } |
e13ee7ad | 164 | #endif |
395b813e | 165 | |
e13ee7ad | 166 | /* increment retry delay [after an unsuccessful attempt] */ |
395b813e | 167 | static time_t |
8a6218c6 | 168 | peerDigestIncDelay(const PeerDigest * pd) |
395b813e | 169 | { |
e13ee7ad | 170 | assert(pd); |
171 | return pd->times.retry_delay > 0 ? | |
8a6218c6 | 172 | 2 * pd->times.retry_delay : /* exponential backoff */ |
173 | PeerDigestReqMinGap; /* minimal delay */ | |
395b813e | 174 | } |
175 | ||
e13ee7ad | 176 | /* artificially increases Expires: setting to avoid race conditions |
177 | * returns the delay till that [increased] expiration time */ | |
00485c29 | 178 | static time_t |
e13ee7ad | 179 | peerDigestNewDelay(const StoreEntry * e) |
00485c29 | 180 | { |
e13ee7ad | 181 | assert(e); |
00485c29 | 182 | if (e->expires > 0) |
e13ee7ad | 183 | return e->expires + PeerDigestReqMinGap - squid_curtime; |
184 | return PeerDigestReqMinGap; | |
00485c29 | 185 | } |
186 | ||
e13ee7ad | 187 | /* registers next digest verification */ |
395b813e | 188 | static void |
e13ee7ad | 189 | peerDigestSetCheck(PeerDigest * pd, time_t delay) |
395b813e | 190 | { |
e13ee7ad | 191 | cbdataLock(pd); |
192 | eventAdd("peerDigestCheck", peerDigestCheck, pd, (double) delay, 1); | |
193 | pd->times.next_check = squid_curtime + delay; | |
194 | debug(72, 3) ("peerDigestSetCheck: will check peer %s in %d secs\n", | |
195 | strBuf(pd->host), delay); | |
196 | } | |
197 | ||
198 | /* called only when cbdataValid(pd) and | |
199 | * peer is about to disappear or have already disappeared */ | |
200 | void | |
8a6218c6 | 201 | peerDigestNotePeerGone(PeerDigest * pd) |
202 | { | |
e13ee7ad | 203 | assert(cbdataValid(pd)); |
204 | if (pd->flags.requested) { | |
205 | debug(72, 2) ("peerDigest: peer %s is gone, will destroy after fetch.\n", strBuf(pd->host)); | |
206 | /* do nothing now, the fetching chain will notice and take action */ | |
395b813e | 207 | } else { |
e13ee7ad | 208 | debug(72, 2) ("peerDigest: peer %s is gone, destroying now.\n", strBuf(pd->host)); |
209 | peerDigestDestroy(pd); | |
395b813e | 210 | } |
211 | } | |
212 | ||
e13ee7ad | 213 | /* callback for eventAdd() (with peer digest locked) |
214 | * request new digest if our copy is too old or if we lack one; | |
215 | * schedule next check otherwise */ | |
9b7de833 | 216 | static void |
e13ee7ad | 217 | peerDigestCheck(void *data) |
9b7de833 | 218 | { |
e13ee7ad | 219 | PeerDigest *pd = data; |
220 | time_t req_time; | |
221 | ||
222 | assert(pd); | |
223 | ||
224 | if (!cbdataValid(pd)) { | |
225 | cbdataUnlock(pd); | |
9b7de833 | 226 | return; |
227 | } | |
8a6218c6 | 228 | cbdataUnlock(pd); /* non-blocking event is over */ |
e13ee7ad | 229 | |
230 | assert(!pd->flags.requested); | |
8a6218c6 | 231 | pd->times.next_check = 0; /* unknown */ |
e13ee7ad | 232 | |
233 | if (!cbdataValid(pd->peer)) { | |
234 | peerDigestNotePeerGone(pd); | |
235 | return; | |
9b7de833 | 236 | } |
e13ee7ad | 237 | debug(72, 3) ("peerDigestCheck: peer %s:%d\n", pd->peer->host, pd->peer->http_port); |
238 | debug(72, 3) ("peerDigestCheck: time: %d, last received: %d (%+d)\n", | |
8a6218c6 | 239 | squid_curtime, pd->times.received, (squid_curtime - pd->times.received)); |
e13ee7ad | 240 | |
241 | /* decide when we should send the request: | |
242 | * request now unless too close to other requests */ | |
243 | req_time = squid_curtime; | |
244 | ||
245 | /* per-peer limit */ | |
246 | if (req_time - pd->times.received < PeerDigestReqMinGap) { | |
247 | debug(72, 2) ("peerDigestCheck: %s, avoiding close peer requests (%d < %d secs).\n", | |
8a6218c6 | 248 | strBuf(pd->host), req_time - pd->times.received, |
e13ee7ad | 249 | PeerDigestReqMinGap); |
250 | req_time = pd->times.received + PeerDigestReqMinGap; | |
bd890734 | 251 | } |
e13ee7ad | 252 | /* global limit */ |
253 | if (req_time - pd_last_req_time < GlobDigestReqMinGap) { | |
254 | debug(72, 2) ("peerDigestCheck: %s, avoiding close requests (%d < %d secs).\n", | |
255 | strBuf(pd->host), req_time - pd_last_req_time, | |
256 | GlobDigestReqMinGap); | |
257 | req_time = pd_last_req_time + GlobDigestReqMinGap; | |
9b7de833 | 258 | } |
e13ee7ad | 259 | if (req_time <= squid_curtime) |
8a6218c6 | 260 | peerDigestRequest(pd); /* will set pd->flags.requested */ |
e13ee7ad | 261 | else |
262 | peerDigestSetCheck(pd, req_time - squid_curtime); | |
9b7de833 | 263 | } |
264 | ||
e13ee7ad | 265 | /* ask store for a digest */ |
9b7de833 | 266 | static void |
e13ee7ad | 267 | peerDigestRequest(PeerDigest * pd) |
9b7de833 | 268 | { |
e13ee7ad | 269 | peer *p = pd->peer; |
9b7de833 | 270 | StoreEntry *e, *old_e; |
271 | char *url; | |
9d486b43 | 272 | const cache_key *key; |
9b7de833 | 273 | request_t *req; |
274 | DigestFetchState *fetch = NULL; | |
e13ee7ad | 275 | |
276 | pd->req_result = NULL; | |
277 | pd->flags.requested = 1; | |
278 | ||
9b7de833 | 279 | /* compute future request components */ |
e13ee7ad | 280 | url = internalRemoteUri(p->host, p->http_port, "/squid-internal-periodic/", StoreDigestFileName); |
9d486b43 | 281 | key = storeKeyPublic(url, METHOD_GET); |
282 | debug(72, 2) ("peerDigestRequest: %s key: %s\n", url, storeKeyText(key)); | |
50a97cee | 283 | req = urlParse(METHOD_GET, url); |
e13ee7ad | 284 | assert(req); |
285 | ||
9b7de833 | 286 | /* add custom headers */ |
2246b732 | 287 | assert(!req->header.len); |
4820f62b | 288 | httpHeaderPutStr(&req->header, HDR_ACCEPT, StoreDigestMimeStr); |
289 | httpHeaderPutStr(&req->header, HDR_ACCEPT, "text/html"); | |
e13ee7ad | 290 | |
9b7de833 | 291 | /* create fetch state structure */ |
292 | fetch = memAllocate(MEM_DIGEST_FETCH_STATE); | |
db1cd23c | 293 | cbdataAdd(fetch, memFree, MEM_DIGEST_FETCH_STATE); |
903c39e4 | 294 | fetch->request = requestLink(req); |
e13ee7ad | 295 | fetch->pd = pd; |
296 | fetch->offset = 0; | |
297 | ||
298 | /* update timestamps */ | |
9b7de833 | 299 | fetch->start_time = squid_curtime; |
e13ee7ad | 300 | pd->times.requested = squid_curtime; |
301 | pd_last_req_time = squid_curtime; | |
302 | ||
92695e5e | 303 | req->flags.cachable = 1; |
9b7de833 | 304 | /* the rest is based on clientProcessExpired() */ |
92695e5e | 305 | req->flags.refresh = 1; |
9d486b43 | 306 | old_e = fetch->old_entry = storeGet(key); |
9b7de833 | 307 | if (old_e) { |
4b4cd312 | 308 | debug(72, 5) ("peerDigestRequest: found old entry\n"); |
9b7de833 | 309 | storeLockObject(old_e); |
310 | storeCreateMemObject(old_e, url, url); | |
311 | storeClientListAdd(old_e, fetch); | |
312 | } | |
313 | e = fetch->entry = storeCreateEntry(url, url, req->flags, req->method); | |
e13ee7ad | 314 | assert(EBIT_TEST(e->flags, KEY_PRIVATE)); |
9b7de833 | 315 | storeClientListAdd(e, fetch); |
316 | /* set lastmod to trigger IMS request if possible */ | |
317 | if (old_e) | |
318 | e->lastmod = old_e->lastmod; | |
e13ee7ad | 319 | |
9b7de833 | 320 | /* push towards peer cache */ |
e13ee7ad | 321 | debug(72, 3) ("peerDigestRequest: forwarding to fwdStart...\n"); |
5843eb62 | 322 | fwdStart(-1, e, req, no_addr); |
e13ee7ad | 323 | cbdataLock(fetch); |
324 | cbdataLock(fetch->pd); | |
325 | storeClientCopy(e, 0, 0, 4096, memAllocate(MEM_4K_BUF), | |
9b7de833 | 326 | peerDigestFetchReply, fetch); |
327 | } | |
328 | ||
e13ee7ad | 329 | /* wait for full http headers to be received then parse them */ |
9b7de833 | 330 | static void |
331 | peerDigestFetchReply(void *data, char *buf, ssize_t size) | |
332 | { | |
333 | DigestFetchState *fetch = data; | |
e13ee7ad | 334 | PeerDigest *pd = fetch->pd; |
335 | assert(pd && buf); | |
9b7de833 | 336 | assert(!fetch->offset); |
e13ee7ad | 337 | |
9b7de833 | 338 | if (peerDigestFetchedEnough(fetch, buf, size, "peerDigestFetchReply")) |
339 | return; | |
e13ee7ad | 340 | |
9b7de833 | 341 | if (headersEnd(buf, size)) { |
342 | http_status status; | |
343 | HttpReply *reply = fetch->entry->mem_obj->reply; | |
344 | assert(reply); | |
345 | httpReplyParse(reply, buf); | |
346 | status = reply->sline.status; | |
e13ee7ad | 347 | debug(72, 3) ("peerDigestFetchReply: %s status: %d, expires: %d (%+d)\n", |
348 | strBuf(pd->host), status, | |
8a6218c6 | 349 | reply->expires, reply->expires - squid_curtime); |
e13ee7ad | 350 | |
9b7de833 | 351 | /* this "if" is based on clientHandleIMSReply() */ |
352 | if (status == HTTP_NOT_MODIFIED) { | |
353 | request_t *r = NULL; | |
354 | /* our old entry is fine */ | |
355 | assert(fetch->old_entry); | |
356 | if (!fetch->old_entry->mem_obj->request) | |
357 | fetch->old_entry->mem_obj->request = r = | |
2920225f | 358 | requestLink(fetch->entry->mem_obj->request); |
359 | assert(fetch->old_entry->mem_obj->request); | |
9b7de833 | 360 | httpReplyUpdateOnNotModified(fetch->old_entry->mem_obj->reply, reply); |
361 | storeTimestampsSet(fetch->old_entry); | |
362 | /* get rid of 304 reply */ | |
363 | storeUnregister(fetch->entry, fetch); | |
9b7de833 | 364 | storeUnlockObject(fetch->entry); |
365 | fetch->entry = fetch->old_entry; | |
366 | fetch->old_entry = NULL; | |
2920225f | 367 | /* preserve request -- we need its size to update counters */ |
368 | /* requestUnlink(r); */ | |
369 | /* fetch->entry->mem_obj->request = NULL; */ | |
4b4cd312 | 370 | } else if (status == HTTP_OK) { |
9b7de833 | 371 | /* get rid of old entry if any */ |
372 | if (fetch->old_entry) { | |
e13ee7ad | 373 | debug(72, 3) ("peerDigestFetchReply: got new digest, releasing old one\n"); |
9b7de833 | 374 | storeUnregister(fetch->old_entry, fetch); |
375 | storeReleaseRequest(fetch->old_entry); | |
376 | storeUnlockObject(fetch->old_entry); | |
377 | fetch->old_entry = NULL; | |
378 | } | |
379 | } else { | |
380 | /* some kind of a bug */ | |
e13ee7ad | 381 | peerDigestFetchAbort(fetch, buf, httpStatusLineReason(&reply->sline)); |
9b7de833 | 382 | return; |
383 | } | |
384 | /* must have a ready-to-use store entry if we got here */ | |
e13ee7ad | 385 | /* can we stay with the old in-memory digest? */ |
386 | if (status == HTTP_NOT_MODIFIED && fetch->pd->cd) | |
551e60a9 | 387 | peerDigestFetchStop(fetch, buf, "Not modified"); |
9b7de833 | 388 | else |
4b4cd312 | 389 | storeClientCopy(fetch->entry, /* have to swap in */ |
9b7de833 | 390 | 0, 0, SM_PAGE_SIZE, buf, peerDigestSwapInHeaders, fetch); |
9b7de833 | 391 | } else { |
392 | /* need more data, do we have space? */ | |
393 | if (size >= SM_PAGE_SIZE) | |
e13ee7ad | 394 | peerDigestFetchAbort(fetch, buf, "reply header too big"); |
9b7de833 | 395 | else |
396 | storeClientCopy(fetch->entry, size, 0, SM_PAGE_SIZE, buf, | |
397 | peerDigestFetchReply, fetch); | |
398 | } | |
399 | } | |
400 | ||
401 | /* fetch headers from disk, pass on to SwapInCBlock */ | |
402 | static void | |
403 | peerDigestSwapInHeaders(void *data, char *buf, ssize_t size) | |
404 | { | |
405 | DigestFetchState *fetch = data; | |
9b7de833 | 406 | size_t hdr_size; |
e13ee7ad | 407 | |
9b7de833 | 408 | if (peerDigestFetchedEnough(fetch, buf, size, "peerDigestSwapInHeaders")) |
409 | return; | |
e13ee7ad | 410 | |
9d486b43 | 411 | assert(!fetch->offset); |
9b7de833 | 412 | if ((hdr_size = headersEnd(buf, size))) { |
413 | assert(fetch->entry->mem_obj->reply); | |
414 | if (!fetch->entry->mem_obj->reply->sline.status) | |
415 | httpReplyParse(fetch->entry->mem_obj->reply, buf); | |
dba2bbcd | 416 | if (fetch->entry->mem_obj->reply->sline.status != HTTP_OK) { |
417 | debug(72, 1) ("peerDigestSwapInHeaders: %s status %d got cached!\n", | |
e13ee7ad | 418 | strBuf(fetch->pd->host), fetch->entry->mem_obj->reply->sline.status); |
419 | peerDigestFetchAbort(fetch, buf, "internal status error"); | |
dba2bbcd | 420 | return; |
421 | } | |
9b7de833 | 422 | fetch->offset += hdr_size; |
423 | storeClientCopy(fetch->entry, size, fetch->offset, | |
424 | SM_PAGE_SIZE, buf, | |
425 | peerDigestSwapInCBlock, fetch); | |
426 | } else { | |
427 | /* need more data, do we have space? */ | |
428 | if (size >= SM_PAGE_SIZE) | |
e13ee7ad | 429 | peerDigestFetchAbort(fetch, buf, "stored header too big"); |
9b7de833 | 430 | else |
431 | storeClientCopy(fetch->entry, size, 0, SM_PAGE_SIZE, buf, | |
432 | peerDigestSwapInHeaders, fetch); | |
433 | } | |
434 | } | |
435 | ||
436 | static void | |
437 | peerDigestSwapInCBlock(void *data, char *buf, ssize_t size) | |
438 | { | |
439 | DigestFetchState *fetch = data; | |
e13ee7ad | 440 | |
9b7de833 | 441 | if (peerDigestFetchedEnough(fetch, buf, size, "peerDigestSwapInCBlock")) |
442 | return; | |
e13ee7ad | 443 | |
9b7de833 | 444 | if (size >= StoreDigestCBlockSize) { |
e13ee7ad | 445 | PeerDigest *pd = fetch->pd; |
9d486b43 | 446 | HttpReply *rep = fetch->entry->mem_obj->reply; |
447 | const int seen = fetch->offset + size; | |
448 | ||
e13ee7ad | 449 | assert(pd && rep); |
450 | if (peerDigestSetCBlock(pd, buf)) { | |
451 | /* XXX: soon we will have variable header size */ | |
9b7de833 | 452 | fetch->offset += StoreDigestCBlockSize; |
e13ee7ad | 453 | /* switch to CD buffer and fetch digest guts */ |
db1cd23c | 454 | memFree(buf, MEM_4K_BUF); |
da407def | 455 | buf = NULL; |
e13ee7ad | 456 | assert(pd->cd->mask); |
da407def | 457 | storeClientCopy(fetch->entry, |
458 | seen, | |
459 | fetch->offset, | |
e13ee7ad | 460 | pd->cd->mask_size, |
461 | pd->cd->mask, | |
9b7de833 | 462 | peerDigestSwapInMask, fetch); |
463 | } else { | |
e13ee7ad | 464 | peerDigestFetchAbort(fetch, buf, "invalid digest cblock"); |
9b7de833 | 465 | } |
466 | } else { | |
467 | /* need more data, do we have space? */ | |
468 | if (size >= SM_PAGE_SIZE) | |
e13ee7ad | 469 | peerDigestFetchAbort(fetch, buf, "digest cblock too big"); |
9b7de833 | 470 | else |
471 | storeClientCopy(fetch->entry, size, 0, SM_PAGE_SIZE, buf, | |
472 | peerDigestSwapInCBlock, fetch); | |
473 | } | |
474 | } | |
475 | ||
476 | static void | |
477 | peerDigestSwapInMask(void *data, char *buf, ssize_t size) | |
478 | { | |
479 | DigestFetchState *fetch = data; | |
e13ee7ad | 480 | PeerDigest *pd; |
481 | ||
482 | /* NOTE! buf points to the middle of pd->cd->mask! */ | |
da407def | 483 | if (peerDigestFetchedEnough(fetch, NULL, size, "peerDigestSwapInMask")) |
484 | return; | |
9d486b43 | 485 | |
e13ee7ad | 486 | pd = fetch->pd; |
487 | assert(pd->cd && pd->cd->mask); | |
9d486b43 | 488 | |
da407def | 489 | fetch->offset += size; |
490 | fetch->mask_offset += size; | |
e13ee7ad | 491 | if (fetch->mask_offset >= pd->cd->mask_size) { |
68814ffd | 492 | debug(72, 2) ("peerDigestSwapInMask: Done! Got %d, expected %d\n", |
e13ee7ad | 493 | fetch->mask_offset, pd->cd->mask_size); |
494 | assert(fetch->mask_offset == pd->cd->mask_size); | |
495 | assert(peerDigestFetchedEnough(fetch, NULL, 0, "peerDigestSwapInMask")); | |
496 | } else { | |
497 | const size_t buf_sz = pd->cd->mask_size - fetch->mask_offset; | |
498 | assert(buf_sz > 0); | |
499 | storeClientCopy(fetch->entry, | |
500 | fetch->offset, | |
501 | fetch->offset, | |
502 | buf_sz, | |
503 | pd->cd->mask + fetch->mask_offset, | |
504 | peerDigestSwapInMask, fetch); | |
9b7de833 | 505 | } |
506 | } | |
507 | ||
508 | static int | |
4b4cd312 | 509 | peerDigestFetchedEnough(DigestFetchState * fetch, char *buf, ssize_t size, const char *step_name) |
9b7de833 | 510 | { |
e13ee7ad | 511 | PeerDigest *pd = NULL; |
8a6218c6 | 512 | const char *host = "<unknown>"; /* peer host */ |
513 | const char *reason = NULL; /* reason for completion */ | |
514 | const char *no_bug = NULL; /* successful completion if set */ | |
9d486b43 | 515 | const int fcb_valid = cbdataValid(fetch); |
e13ee7ad | 516 | const int pdcb_valid = fcb_valid && cbdataValid(fetch->pd); |
517 | const int pcb_valid = pdcb_valid && cbdataValid(fetch->pd->peer); | |
518 | ||
519 | /* test possible exiting conditions (the same for most steps!) | |
520 | * cases marked with '?!' should not happen */ | |
521 | ||
522 | if (!reason) { | |
523 | if (!fcb_valid) | |
8a6218c6 | 524 | reason = "fetch aborted?!"; |
e13ee7ad | 525 | else if (!(pd = fetch->pd)) |
526 | reason = "peer digest disappeared?!"; | |
527 | else if (!cbdataValid(pd)) | |
528 | reason = "invalidated peer digest?!"; | |
529 | else | |
530 | host = strBuf(pd->host); | |
531 | } | |
e13ee7ad | 532 | debug(72, 6) ("%s: peer %s, offset: %d size: %d.\n", |
533 | step_name, host, fcb_valid ? fetch->offset : -1, size); | |
534 | ||
535 | /* continue checking (with pd and host known and valid) */ | |
536 | if (!reason) { | |
537 | if (!cbdataValid(pd->peer)) | |
538 | reason = "peer disappeared"; | |
539 | else if (size < 0) | |
540 | reason = "swap failure"; | |
541 | else if (!fetch->entry) | |
542 | reason = "swap aborted?!"; | |
543 | else if (fetch->entry->store_status == STORE_ABORTED) | |
544 | reason = "swap aborted"; | |
545 | } | |
e13ee7ad | 546 | /* continue checking (maybe-successful eof case) */ |
547 | if (!reason && !size) { | |
548 | if (!pd->cd) | |
549 | reason = "null digest?!"; | |
550 | else if (fetch->mask_offset != pd->cd->mask_size) | |
551 | reason = "premature end of digest?!"; | |
552 | else if (!peerDigestUseful(pd)) | |
553 | reason = "useless digest"; | |
554 | else | |
555 | reason = no_bug = "success"; | |
556 | } | |
e13ee7ad | 557 | /* finish if we have a reason */ |
9b7de833 | 558 | if (reason) { |
e13ee7ad | 559 | const int level = strstr(reason, "?!") ? 1 : 3; |
560 | debug(72, level) ("%s: peer %s, exiting after '%s'\n", | |
561 | step_name, host, reason); | |
562 | peerDigestReqFinish(fetch, buf, | |
563 | fcb_valid, pdcb_valid, pcb_valid, reason, !no_bug); | |
564 | } else { | |
565 | /* paranoid check */ | |
566 | assert(fcb_valid && pdcb_valid && pcb_valid); | |
567 | } | |
568 | return reason != NULL; | |
569 | } | |
570 | ||
551e60a9 | 571 | /* call this when all callback data is valid and fetch must be stopped but |
572 | * no error has occurred (e.g. we received 304 reply and reuse old digest) */ | |
573 | static void | |
574 | peerDigestFetchStop(DigestFetchState * fetch, char *buf, const char *reason) | |
575 | { | |
576 | assert(reason); | |
577 | debug(72, 2) ("peerDigestFetchStop: peer %s, reason: %s\n", | |
578 | strBuf(fetch->pd->host), reason); | |
579 | peerDigestReqFinish(fetch, buf, 1, 1, 1, reason, 0); | |
580 | } | |
581 | ||
e13ee7ad | 582 | /* call this when all callback data is valid but something bad happened */ |
583 | static void | |
584 | peerDigestFetchAbort(DigestFetchState * fetch, char *buf, const char *reason) | |
585 | { | |
551e60a9 | 586 | assert(reason); |
587 | debug(72, 2) ("peerDigestFetchAbort: peer %s, reason: %s\n", | |
588 | strBuf(fetch->pd->host), reason); | |
e13ee7ad | 589 | peerDigestReqFinish(fetch, buf, 1, 1, 1, reason, 1); |
590 | } | |
591 | ||
592 | /* complete the digest transfer, update stats, unlock/release everything */ | |
593 | static void | |
594 | peerDigestReqFinish(DigestFetchState * fetch, char *buf, | |
8a6218c6 | 595 | int fcb_valid, int pdcb_valid, int pcb_valid, |
e13ee7ad | 596 | const char *reason, int err) |
597 | { | |
598 | assert(reason); | |
599 | ||
600 | /* must go before peerDigestPDFinish */ | |
601 | if (pdcb_valid) { | |
602 | fetch->pd->flags.requested = 0; | |
603 | fetch->pd->req_result = reason; | |
604 | } | |
e13ee7ad | 605 | /* schedule next check if peer is still out there */ |
606 | if (pcb_valid) { | |
607 | PeerDigest *pd = fetch->pd; | |
608 | if (err) { | |
609 | pd->times.retry_delay = peerDigestIncDelay(pd); | |
610 | peerDigestSetCheck(pd, pd->times.retry_delay); | |
9d486b43 | 611 | } else { |
e13ee7ad | 612 | pd->times.retry_delay = 0; |
613 | peerDigestSetCheck(pd, peerDigestNewDelay(fetch->entry)); | |
9d486b43 | 614 | } |
9b7de833 | 615 | } |
e13ee7ad | 616 | /* note: order is significant */ |
617 | if (fcb_valid) | |
618 | peerDigestFetchSetStats(fetch); | |
619 | if (pdcb_valid) | |
620 | peerDigestPDFinish(fetch, pcb_valid, err); | |
621 | if (fcb_valid) | |
622 | peerDigestFetchFinish(fetch, err); | |
623 | if (buf) | |
db1cd23c | 624 | memFree(buf, MEM_4K_BUF); |
9b7de833 | 625 | } |
626 | ||
e13ee7ad | 627 | |
628 | /* destroys digest if peer disappeared | |
629 | * must be called only when fetch and pd cbdata are valid */ | |
9b7de833 | 630 | static void |
e13ee7ad | 631 | peerDigestPDFinish(DigestFetchState * fetch, int pcb_valid, int err) |
9b7de833 | 632 | { |
e13ee7ad | 633 | PeerDigest *pd = fetch->pd; |
634 | const char *host = strBuf(pd->host); | |
635 | ||
636 | pd->times.received = squid_curtime; | |
637 | pd->times.req_delay = fetch->resp_time; | |
8a6218c6 | 638 | kb_incr(&pd->stats.sent.kbytes, (size_t) fetch->sent.bytes); |
639 | kb_incr(&pd->stats.recv.kbytes, (size_t) fetch->recv.bytes); | |
e13ee7ad | 640 | pd->stats.sent.msgs += fetch->sent.msg; |
641 | pd->stats.recv.msgs += fetch->recv.msg; | |
642 | ||
643 | if (err) { | |
644 | debug(72, 1) ("%sdisabling (%s) digest from %s\n", | |
645 | pcb_valid ? "temporary " : "", | |
646 | pd->req_result, host); | |
647 | ||
648 | if (pd->cd) { | |
649 | cacheDigestDestroy(pd->cd); | |
650 | pd->cd = NULL; | |
651 | } | |
e13ee7ad | 652 | pd->flags.usable = 0; |
653 | ||
654 | if (!pcb_valid) | |
655 | peerDigestNotePeerGone(pd); | |
656 | } else { | |
657 | assert(pcb_valid); | |
658 | ||
659 | pd->flags.usable = 1; | |
660 | ||
661 | /* XXX: ugly condition, but how? */ | |
662 | if (fetch->entry->store_status == STORE_OK) | |
663 | debug(72, 2) ("re-used old digest from %s\n", host); | |
664 | else | |
665 | debug(72, 2) ("received valid digest from %s\n", host); | |
d1cdaa16 | 666 | } |
e13ee7ad | 667 | } |
668 | ||
669 | /* free fetch state structures | |
670 | * must be called only when fetch cbdata is valid */ | |
671 | static void | |
672 | peerDigestFetchFinish(DigestFetchState * fetch, int err) | |
673 | { | |
674 | assert(fetch->entry && fetch->request); | |
675 | ||
9b7de833 | 676 | if (fetch->old_entry) { |
4b4cd312 | 677 | debug(72, 2) ("peerDigestFetchFinish: deleting old entry\n"); |
9b7de833 | 678 | storeUnregister(fetch->old_entry, fetch); |
679 | storeReleaseRequest(fetch->old_entry); | |
680 | storeUnlockObject(fetch->old_entry); | |
681 | fetch->old_entry = NULL; | |
682 | } | |
1543ab6c | 683 | /* update global stats */ |
e13ee7ad | 684 | kb_incr(&Counter.cd.kbytes_sent, (size_t) fetch->sent.bytes); |
685 | kb_incr(&Counter.cd.kbytes_recv, (size_t) fetch->recv.bytes); | |
686 | Counter.cd.msgs_sent += fetch->sent.msg; | |
687 | Counter.cd.msgs_recv += fetch->recv.msg; | |
688 | ||
1543ab6c | 689 | /* unlock everything */ |
e13ee7ad | 690 | if (fetch->pd) |
691 | cbdataUnlock(fetch->pd); | |
9b7de833 | 692 | storeUnregister(fetch->entry, fetch); |
693 | storeUnlockObject(fetch->entry); | |
903c39e4 | 694 | requestUnlink(fetch->request); |
9b7de833 | 695 | fetch->entry = NULL; |
903c39e4 | 696 | fetch->request = NULL; |
9d486b43 | 697 | cbdataUnlock(fetch); |
9b7de833 | 698 | cbdataFree(fetch); |
9b7de833 | 699 | } |
700 | ||
e13ee7ad | 701 | /* calculate fetch stats after completion */ |
702 | static void | |
703 | peerDigestFetchSetStats(DigestFetchState * fetch) | |
704 | { | |
705 | MemObject *mem; | |
706 | assert(fetch->entry && fetch->request); | |
707 | ||
708 | mem = fetch->entry->mem_obj; | |
709 | assert(mem); | |
710 | ||
711 | /* XXX: outgoing numbers are not precise */ | |
712 | /* XXX: we must distinguish between 304 hits and misses here */ | |
713 | fetch->sent.bytes = httpRequestPrefixLen(fetch->request); | |
714 | fetch->recv.bytes = fetch->entry->store_status == STORE_PENDING ? | |
715 | mem->inmem_hi : mem->object_sz; | |
716 | fetch->sent.msg = fetch->recv.msg = 1; | |
717 | fetch->expires = fetch->entry->expires; | |
718 | fetch->resp_time = squid_curtime - fetch->start_time; | |
719 | ||
720 | debug(72, 3) ("peerDigestFetchFinish: recv %d bytes in %d secs\n", | |
721 | fetch->recv.bytes, fetch->resp_time); | |
722 | debug(72, 3) ("peerDigestFetchFinish: expires: %d (%+d), lmt: %d (%+d)\n", | |
8a6218c6 | 723 | fetch->expires, fetch->expires - squid_curtime, |
724 | fetch->entry->lastmod, fetch->entry->lastmod - squid_curtime); | |
e13ee7ad | 725 | } |
726 | ||
727 | ||
9b7de833 | 728 | static int |
8a6218c6 | 729 | peerDigestSetCBlock(PeerDigest * pd, const char *buf) |
9b7de833 | 730 | { |
731 | StoreDigestCBlock cblock; | |
732 | int freed_size = 0; | |
e13ee7ad | 733 | const char *host = strBuf(pd->host); |
734 | ||
9b7de833 | 735 | xmemcpy(&cblock, buf, sizeof(cblock)); |
736 | /* network -> host conversions */ | |
737 | cblock.ver.current = ntohs(cblock.ver.current); | |
738 | cblock.ver.required = ntohs(cblock.ver.required); | |
739 | cblock.capacity = ntohl(cblock.capacity); | |
740 | cblock.count = ntohl(cblock.count); | |
741 | cblock.del_count = ntohl(cblock.del_count); | |
742 | cblock.mask_size = ntohl(cblock.mask_size); | |
4b4cd312 | 743 | debug(72, 2) ("got digest cblock from %s; ver: %d (req: %d)\n", |
e13ee7ad | 744 | host, (int) cblock.ver.current, (int) cblock.ver.required); |
4b4cd312 | 745 | debug(72, 2) ("\t size: %d bytes, e-cnt: %d, e-util: %d%%\n", |
9b7de833 | 746 | cblock.mask_size, cblock.count, |
747 | xpercentInt(cblock.count, cblock.capacity)); | |
6106c6fc | 748 | /* check version requirements (both ways) */ |
9b7de833 | 749 | if (cblock.ver.required > CacheDigestVer.current) { |
4b4cd312 | 750 | debug(72, 1) ("%s digest requires version %d; have: %d\n", |
e13ee7ad | 751 | host, cblock.ver.required, CacheDigestVer.current); |
9b7de833 | 752 | return 0; |
753 | } | |
6106c6fc | 754 | if (cblock.ver.current < CacheDigestVer.required) { |
4b4cd312 | 755 | debug(72, 1) ("%s digest is version %d; we require: %d\n", |
e13ee7ad | 756 | host, cblock.ver.current, CacheDigestVer.required); |
6106c6fc | 757 | return 0; |
758 | } | |
9b7de833 | 759 | /* check consistency */ |
4b4cd312 | 760 | if (cblock.ver.required > cblock.ver.current || |
d1cdaa16 | 761 | cblock.mask_size <= 0 || cblock.capacity <= 0 || |
762 | cblock.bits_per_entry <= 0 || cblock.hash_func_count <= 0) { | |
e13ee7ad | 763 | debug(72, 0) ("%s digest cblock is corrupted.\n", host); |
9b7de833 | 764 | return 0; |
765 | } | |
d1cdaa16 | 766 | /* check consistency further */ |
767 | if (cblock.mask_size != cacheDigestCalcMaskSize(cblock.capacity, cblock.bits_per_entry)) { | |
4b4cd312 | 768 | debug(72, 0) ("%s digest cblock is corrupted (mask size mismatch: %d ? %d).\n", |
e13ee7ad | 769 | host, cblock.mask_size, cacheDigestCalcMaskSize(cblock.capacity, cblock.bits_per_entry)); |
d1cdaa16 | 770 | return 0; |
771 | } | |
772 | /* there are some things we cannot do yet */ | |
773 | if (cblock.hash_func_count != CacheDigestHashFuncCount) { | |
4b4cd312 | 774 | debug(72, 0) ("%s digest: unsupported #hash functions: %d ? %d.\n", |
e13ee7ad | 775 | host, cblock.hash_func_count, CacheDigestHashFuncCount); |
d1cdaa16 | 776 | return 0; |
777 | } | |
9b7de833 | 778 | /* |
779 | * no cblock bugs below this point | |
780 | */ | |
781 | /* check size changes */ | |
e13ee7ad | 782 | if (pd->cd && cblock.mask_size != pd->cd->mask_size) { |
4b4cd312 | 783 | debug(72, 2) ("%s digest changed size: %d -> %d\n", |
8a6218c6 | 784 | host, cblock.mask_size, pd->cd->mask_size); |
e13ee7ad | 785 | freed_size = pd->cd->mask_size; |
786 | cacheDigestDestroy(pd->cd); | |
787 | pd->cd = NULL; | |
9b7de833 | 788 | } |
e13ee7ad | 789 | if (!pd->cd) { |
45694534 | 790 | debug(72, 2) ("creating %s digest; size: %d (%+d) bytes\n", |
e13ee7ad | 791 | host, cblock.mask_size, (int) (cblock.mask_size - freed_size)); |
792 | pd->cd = cacheDigestCreate(cblock.capacity, cblock.bits_per_entry); | |
9b7de833 | 793 | if (cblock.mask_size >= freed_size) |
794 | kb_incr(&Counter.cd.memory, cblock.mask_size - freed_size); | |
795 | } | |
e13ee7ad | 796 | assert(pd->cd); |
9b7de833 | 797 | /* these assignments leave us in an inconsistent state until we finish reading the digest */ |
e13ee7ad | 798 | pd->cd->count = cblock.count; |
799 | pd->cd->del_count = cblock.del_count; | |
9b7de833 | 800 | return 1; |
801 | } | |
802 | ||
9b7de833 | 803 | static int |
8a6218c6 | 804 | peerDigestUseful(const PeerDigest * pd) |
9b7de833 | 805 | { |
d1cdaa16 | 806 | /* TODO: we should calculate the prob of a false hit instead of bit util */ |
e13ee7ad | 807 | const int bit_util = cacheDigestBitUtil(pd->cd); |
808 | if (bit_util > 65) { | |
4b4cd312 | 809 | debug(72, 0) ("Warning: %s peer digest has too many bits on (%d%%).\n", |
e13ee7ad | 810 | strBuf(pd->host), bit_util); |
d1cdaa16 | 811 | return 0; |
9b7de833 | 812 | } |
813 | return 1; | |
814 | } | |
7f6eb0fe | 815 | |
e13ee7ad | 816 | static int |
817 | saneDiff(time_t diff) | |
818 | { | |
8a6218c6 | 819 | return abs(diff) > squid_curtime / 2 ? 0 : diff; |
e13ee7ad | 820 | } |
821 | ||
822 | void | |
8a6218c6 | 823 | peerDigestStatsReport(const PeerDigest * pd, StoreEntry * e) |
e13ee7ad | 824 | { |
825 | #define f2s(flag) (pd->flags.flag ? "yes" : "no") | |
826 | #define appendTime(tm) storeAppendPrintf(e, "%s\t %10d\t %+d\t %+d\n", \ | |
827 | ""#tm, pd->times.tm, \ | |
828 | saneDiff(pd->times.tm - squid_curtime), \ | |
829 | saneDiff(pd->times.tm - pd->times.initialized)) | |
830 | ||
831 | const char *host = pd ? strBuf(pd->host) : NULL; | |
832 | assert(pd); | |
833 | ||
834 | storeAppendPrintf(e, "\npeer digest from %s\n", host); | |
835 | ||
836 | cacheDigestGuessStatsReport(&pd->stats.guess, e, host); | |
837 | ||
838 | storeAppendPrintf(e, "\nevent\t timestamp\t secs from now\t secs from init\n"); | |
839 | appendTime(initialized); | |
840 | appendTime(needed); | |
841 | appendTime(requested); | |
842 | appendTime(received); | |
843 | appendTime(next_check); | |
844 | ||
845 | storeAppendPrintf(e, "peer digest state:\n"); | |
846 | storeAppendPrintf(e, "\tneeded: %3s, usable: %3s, requested: %3s\n", | |
847 | f2s(needed), f2s(usable), f2s(requested)); | |
848 | storeAppendPrintf(e, "\n\tlast retry delay: %d secs\n", | |
849 | pd->times.retry_delay); | |
850 | storeAppendPrintf(e, "\tlast request response time: %d secs\n", | |
851 | pd->times.req_delay); | |
852 | storeAppendPrintf(e, "\tlast request result: %s\n", | |
853 | pd->req_result ? pd->req_result : "(none)"); | |
854 | ||
855 | storeAppendPrintf(e, "\npeer digest traffic:\n"); | |
856 | storeAppendPrintf(e, "\trequests sent: %d, volume: %d KB\n", | |
857 | pd->stats.sent.msgs, (int) pd->stats.sent.kbytes.kb); | |
858 | storeAppendPrintf(e, "\treplies recv: %d, volume: %d KB\n", | |
859 | pd->stats.recv.msgs, (int) pd->stats.recv.kbytes.kb); | |
860 | ||
861 | storeAppendPrintf(e, "\npeer digest structure:\n"); | |
862 | if (pd->cd) | |
863 | cacheDigestReport(pd->cd, host, e); | |
864 | else | |
865 | storeAppendPrintf(e, "\tno in-memory copy\n"); | |
866 | } | |
867 | ||
7f6eb0fe | 868 | #endif |