]>
Commit | Line | Data |
---|---|---|
9b7de833 | 1 | |
2 | /* | |
ae2c08a2 | 3 | * $Id: peer_digest.cc,v 1.70 1999/01/29 21:28:17 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 | |
107 | pd = memAllocate(MEM_PEER_DIGEST); | |
db1cd23c | 108 | cbdataAdd(pd, memFree, MEM_PEER_DIGEST); |
e13ee7ad | 109 | peerDigestInit(pd, p); |
8a6218c6 | 110 | cbdataLock(pd->peer); /* we will use the peer */ |
e13ee7ad | 111 | |
112 | return pd; | |
113 | } | |
114 | ||
115 | /* call Clean and free/unlock everything */ | |
116 | void | |
8a6218c6 | 117 | peerDigestDestroy(PeerDigest * pd) |
e13ee7ad | 118 | { |
fcbbccfe | 119 | peer *p; |
e13ee7ad | 120 | assert(pd); |
e13ee7ad | 121 | |
fcbbccfe | 122 | p = pd->peer; |
e13ee7ad | 123 | pd->peer = NULL; |
fcbbccfe | 124 | /* inform peer (if any) that we are gone */ |
125 | if (cbdataValid(p)) | |
126 | peerNoteDigestGone(p); | |
48c27a0e | 127 | cbdataUnlock(p); /* must unlock, valid or not */ |
e13ee7ad | 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 | eventAdd("peerDigestCheck", peerDigestCheck, pd, (double) delay, 1); |
192 | pd->times.next_check = squid_curtime + delay; | |
193 | debug(72, 3) ("peerDigestSetCheck: will check peer %s in %d secs\n", | |
194 | strBuf(pd->host), delay); | |
195 | } | |
196 | ||
5385c86a | 197 | /* |
198 | * called when peer is about to disappear or have already disappeared | |
199 | */ | |
e13ee7ad | 200 | void |
8a6218c6 | 201 | peerDigestNotePeerGone(PeerDigest * pd) |
202 | { | |
e13ee7ad | 203 | if (pd->flags.requested) { |
5385c86a | 204 | debug(72, 2) ("peerDigest: peer %s gone, will destroy after fetch.\n", |
205 | strBuf(pd->host)); | |
e13ee7ad | 206 | /* do nothing now, the fetching chain will notice and take action */ |
395b813e | 207 | } else { |
5385c86a | 208 | debug(72, 2) ("peerDigest: peer %s is gone, destroying now.\n", |
209 | strBuf(pd->host)); | |
e13ee7ad | 210 | peerDigestDestroy(pd); |
395b813e | 211 | } |
212 | } | |
213 | ||
e13ee7ad | 214 | /* callback for eventAdd() (with peer digest locked) |
215 | * request new digest if our copy is too old or if we lack one; | |
216 | * schedule next check otherwise */ | |
9b7de833 | 217 | static void |
e13ee7ad | 218 | peerDigestCheck(void *data) |
9b7de833 | 219 | { |
e13ee7ad | 220 | PeerDigest *pd = data; |
221 | time_t req_time; | |
222 | ||
48c27a0e | 223 | /* |
224 | * you can't assert(cbdataValid(pd)) -- if its not valid this | |
225 | * function never gets called | |
226 | */ | |
e13ee7ad | 227 | assert(!pd->flags.requested); |
5d9bb360 | 228 | |
8a6218c6 | 229 | pd->times.next_check = 0; /* unknown */ |
e13ee7ad | 230 | |
231 | if (!cbdataValid(pd->peer)) { | |
232 | peerDigestNotePeerGone(pd); | |
233 | return; | |
9b7de833 | 234 | } |
e13ee7ad | 235 | debug(72, 3) ("peerDigestCheck: peer %s:%d\n", pd->peer->host, pd->peer->http_port); |
236 | debug(72, 3) ("peerDigestCheck: time: %d, last received: %d (%+d)\n", | |
8a6218c6 | 237 | squid_curtime, pd->times.received, (squid_curtime - pd->times.received)); |
e13ee7ad | 238 | |
239 | /* decide when we should send the request: | |
240 | * request now unless too close to other requests */ | |
241 | req_time = squid_curtime; | |
242 | ||
243 | /* per-peer limit */ | |
244 | if (req_time - pd->times.received < PeerDigestReqMinGap) { | |
245 | debug(72, 2) ("peerDigestCheck: %s, avoiding close peer requests (%d < %d secs).\n", | |
8a6218c6 | 246 | strBuf(pd->host), req_time - pd->times.received, |
e13ee7ad | 247 | PeerDigestReqMinGap); |
248 | req_time = pd->times.received + PeerDigestReqMinGap; | |
bd890734 | 249 | } |
e13ee7ad | 250 | /* global limit */ |
251 | if (req_time - pd_last_req_time < GlobDigestReqMinGap) { | |
252 | debug(72, 2) ("peerDigestCheck: %s, avoiding close requests (%d < %d secs).\n", | |
253 | strBuf(pd->host), req_time - pd_last_req_time, | |
254 | GlobDigestReqMinGap); | |
255 | req_time = pd_last_req_time + GlobDigestReqMinGap; | |
9b7de833 | 256 | } |
e13ee7ad | 257 | if (req_time <= squid_curtime) |
8a6218c6 | 258 | peerDigestRequest(pd); /* will set pd->flags.requested */ |
e13ee7ad | 259 | else |
260 | peerDigestSetCheck(pd, req_time - squid_curtime); | |
9b7de833 | 261 | } |
262 | ||
e13ee7ad | 263 | /* ask store for a digest */ |
9b7de833 | 264 | static void |
e13ee7ad | 265 | peerDigestRequest(PeerDigest * pd) |
9b7de833 | 266 | { |
e13ee7ad | 267 | peer *p = pd->peer; |
9b7de833 | 268 | StoreEntry *e, *old_e; |
269 | char *url; | |
9d486b43 | 270 | const cache_key *key; |
9b7de833 | 271 | request_t *req; |
272 | DigestFetchState *fetch = NULL; | |
e13ee7ad | 273 | |
274 | pd->req_result = NULL; | |
275 | pd->flags.requested = 1; | |
276 | ||
9b7de833 | 277 | /* compute future request components */ |
e13ee7ad | 278 | url = internalRemoteUri(p->host, p->http_port, "/squid-internal-periodic/", StoreDigestFileName); |
9d486b43 | 279 | key = storeKeyPublic(url, METHOD_GET); |
280 | debug(72, 2) ("peerDigestRequest: %s key: %s\n", url, storeKeyText(key)); | |
50a97cee | 281 | req = urlParse(METHOD_GET, url); |
e13ee7ad | 282 | assert(req); |
283 | ||
9b7de833 | 284 | /* add custom headers */ |
2246b732 | 285 | assert(!req->header.len); |
4820f62b | 286 | httpHeaderPutStr(&req->header, HDR_ACCEPT, StoreDigestMimeStr); |
287 | httpHeaderPutStr(&req->header, HDR_ACCEPT, "text/html"); | |
e13ee7ad | 288 | |
9b7de833 | 289 | /* create fetch state structure */ |
290 | fetch = memAllocate(MEM_DIGEST_FETCH_STATE); | |
db1cd23c | 291 | cbdataAdd(fetch, memFree, MEM_DIGEST_FETCH_STATE); |
903c39e4 | 292 | fetch->request = requestLink(req); |
e13ee7ad | 293 | fetch->pd = pd; |
294 | fetch->offset = 0; | |
295 | ||
296 | /* update timestamps */ | |
9b7de833 | 297 | fetch->start_time = squid_curtime; |
e13ee7ad | 298 | pd->times.requested = squid_curtime; |
299 | pd_last_req_time = squid_curtime; | |
300 | ||
92695e5e | 301 | req->flags.cachable = 1; |
9b7de833 | 302 | /* the rest is based on clientProcessExpired() */ |
92695e5e | 303 | req->flags.refresh = 1; |
9d486b43 | 304 | old_e = fetch->old_entry = storeGet(key); |
9b7de833 | 305 | if (old_e) { |
4b4cd312 | 306 | debug(72, 5) ("peerDigestRequest: found old entry\n"); |
9b7de833 | 307 | storeLockObject(old_e); |
308 | storeCreateMemObject(old_e, url, url); | |
309 | storeClientListAdd(old_e, fetch); | |
310 | } | |
311 | e = fetch->entry = storeCreateEntry(url, url, req->flags, req->method); | |
e13ee7ad | 312 | assert(EBIT_TEST(e->flags, KEY_PRIVATE)); |
9b7de833 | 313 | storeClientListAdd(e, fetch); |
314 | /* set lastmod to trigger IMS request if possible */ | |
315 | if (old_e) | |
316 | e->lastmod = old_e->lastmod; | |
e13ee7ad | 317 | |
9b7de833 | 318 | /* push towards peer cache */ |
e13ee7ad | 319 | debug(72, 3) ("peerDigestRequest: forwarding to fwdStart...\n"); |
ae2c08a2 | 320 | fwdStart(-1, e, req, no_addr, no_addr); |
e13ee7ad | 321 | cbdataLock(fetch); |
322 | cbdataLock(fetch->pd); | |
323 | storeClientCopy(e, 0, 0, 4096, memAllocate(MEM_4K_BUF), | |
9b7de833 | 324 | peerDigestFetchReply, fetch); |
325 | } | |
326 | ||
e13ee7ad | 327 | /* wait for full http headers to be received then parse them */ |
9b7de833 | 328 | static void |
329 | peerDigestFetchReply(void *data, char *buf, ssize_t size) | |
330 | { | |
331 | DigestFetchState *fetch = data; | |
e13ee7ad | 332 | PeerDigest *pd = fetch->pd; |
333 | assert(pd && buf); | |
9b7de833 | 334 | assert(!fetch->offset); |
e13ee7ad | 335 | |
9b7de833 | 336 | if (peerDigestFetchedEnough(fetch, buf, size, "peerDigestFetchReply")) |
337 | return; | |
e13ee7ad | 338 | |
9b7de833 | 339 | if (headersEnd(buf, size)) { |
340 | http_status status; | |
341 | HttpReply *reply = fetch->entry->mem_obj->reply; | |
342 | assert(reply); | |
343 | httpReplyParse(reply, buf); | |
344 | status = reply->sline.status; | |
e13ee7ad | 345 | debug(72, 3) ("peerDigestFetchReply: %s status: %d, expires: %d (%+d)\n", |
346 | strBuf(pd->host), status, | |
8a6218c6 | 347 | reply->expires, reply->expires - squid_curtime); |
e13ee7ad | 348 | |
9b7de833 | 349 | /* this "if" is based on clientHandleIMSReply() */ |
350 | if (status == HTTP_NOT_MODIFIED) { | |
351 | request_t *r = NULL; | |
352 | /* our old entry is fine */ | |
353 | assert(fetch->old_entry); | |
354 | if (!fetch->old_entry->mem_obj->request) | |
355 | fetch->old_entry->mem_obj->request = r = | |
2920225f | 356 | requestLink(fetch->entry->mem_obj->request); |
357 | assert(fetch->old_entry->mem_obj->request); | |
9b7de833 | 358 | httpReplyUpdateOnNotModified(fetch->old_entry->mem_obj->reply, reply); |
359 | storeTimestampsSet(fetch->old_entry); | |
360 | /* get rid of 304 reply */ | |
361 | storeUnregister(fetch->entry, fetch); | |
9b7de833 | 362 | storeUnlockObject(fetch->entry); |
363 | fetch->entry = fetch->old_entry; | |
364 | fetch->old_entry = NULL; | |
2920225f | 365 | /* preserve request -- we need its size to update counters */ |
366 | /* requestUnlink(r); */ | |
367 | /* fetch->entry->mem_obj->request = NULL; */ | |
4b4cd312 | 368 | } else if (status == HTTP_OK) { |
9b7de833 | 369 | /* get rid of old entry if any */ |
370 | if (fetch->old_entry) { | |
e13ee7ad | 371 | debug(72, 3) ("peerDigestFetchReply: got new digest, releasing old one\n"); |
9b7de833 | 372 | storeUnregister(fetch->old_entry, fetch); |
373 | storeReleaseRequest(fetch->old_entry); | |
374 | storeUnlockObject(fetch->old_entry); | |
375 | fetch->old_entry = NULL; | |
376 | } | |
377 | } else { | |
378 | /* some kind of a bug */ | |
e13ee7ad | 379 | peerDigestFetchAbort(fetch, buf, httpStatusLineReason(&reply->sline)); |
9b7de833 | 380 | return; |
381 | } | |
382 | /* must have a ready-to-use store entry if we got here */ | |
e13ee7ad | 383 | /* can we stay with the old in-memory digest? */ |
384 | if (status == HTTP_NOT_MODIFIED && fetch->pd->cd) | |
551e60a9 | 385 | peerDigestFetchStop(fetch, buf, "Not modified"); |
9b7de833 | 386 | else |
4b4cd312 | 387 | storeClientCopy(fetch->entry, /* have to swap in */ |
9b7de833 | 388 | 0, 0, SM_PAGE_SIZE, buf, peerDigestSwapInHeaders, fetch); |
9b7de833 | 389 | } else { |
390 | /* need more data, do we have space? */ | |
391 | if (size >= SM_PAGE_SIZE) | |
e13ee7ad | 392 | peerDigestFetchAbort(fetch, buf, "reply header too big"); |
9b7de833 | 393 | else |
394 | storeClientCopy(fetch->entry, size, 0, SM_PAGE_SIZE, buf, | |
395 | peerDigestFetchReply, fetch); | |
396 | } | |
397 | } | |
398 | ||
399 | /* fetch headers from disk, pass on to SwapInCBlock */ | |
400 | static void | |
401 | peerDigestSwapInHeaders(void *data, char *buf, ssize_t size) | |
402 | { | |
403 | DigestFetchState *fetch = data; | |
9b7de833 | 404 | size_t hdr_size; |
e13ee7ad | 405 | |
9b7de833 | 406 | if (peerDigestFetchedEnough(fetch, buf, size, "peerDigestSwapInHeaders")) |
407 | return; | |
e13ee7ad | 408 | |
9d486b43 | 409 | assert(!fetch->offset); |
9b7de833 | 410 | if ((hdr_size = headersEnd(buf, size))) { |
411 | assert(fetch->entry->mem_obj->reply); | |
412 | if (!fetch->entry->mem_obj->reply->sline.status) | |
413 | httpReplyParse(fetch->entry->mem_obj->reply, buf); | |
dba2bbcd | 414 | if (fetch->entry->mem_obj->reply->sline.status != HTTP_OK) { |
415 | debug(72, 1) ("peerDigestSwapInHeaders: %s status %d got cached!\n", | |
e13ee7ad | 416 | strBuf(fetch->pd->host), fetch->entry->mem_obj->reply->sline.status); |
417 | peerDigestFetchAbort(fetch, buf, "internal status error"); | |
dba2bbcd | 418 | return; |
419 | } | |
9b7de833 | 420 | fetch->offset += hdr_size; |
421 | storeClientCopy(fetch->entry, size, fetch->offset, | |
422 | SM_PAGE_SIZE, buf, | |
423 | peerDigestSwapInCBlock, fetch); | |
424 | } else { | |
425 | /* need more data, do we have space? */ | |
426 | if (size >= SM_PAGE_SIZE) | |
e13ee7ad | 427 | peerDigestFetchAbort(fetch, buf, "stored header too big"); |
9b7de833 | 428 | else |
429 | storeClientCopy(fetch->entry, size, 0, SM_PAGE_SIZE, buf, | |
430 | peerDigestSwapInHeaders, fetch); | |
431 | } | |
432 | } | |
433 | ||
434 | static void | |
435 | peerDigestSwapInCBlock(void *data, char *buf, ssize_t size) | |
436 | { | |
437 | DigestFetchState *fetch = data; | |
e13ee7ad | 438 | |
9b7de833 | 439 | if (peerDigestFetchedEnough(fetch, buf, size, "peerDigestSwapInCBlock")) |
440 | return; | |
e13ee7ad | 441 | |
9b7de833 | 442 | if (size >= StoreDigestCBlockSize) { |
e13ee7ad | 443 | PeerDigest *pd = fetch->pd; |
9d486b43 | 444 | HttpReply *rep = fetch->entry->mem_obj->reply; |
445 | const int seen = fetch->offset + size; | |
446 | ||
e13ee7ad | 447 | assert(pd && rep); |
448 | if (peerDigestSetCBlock(pd, buf)) { | |
449 | /* XXX: soon we will have variable header size */ | |
9b7de833 | 450 | fetch->offset += StoreDigestCBlockSize; |
e13ee7ad | 451 | /* switch to CD buffer and fetch digest guts */ |
db1cd23c | 452 | memFree(buf, MEM_4K_BUF); |
da407def | 453 | buf = NULL; |
e13ee7ad | 454 | assert(pd->cd->mask); |
da407def | 455 | storeClientCopy(fetch->entry, |
456 | seen, | |
457 | fetch->offset, | |
e13ee7ad | 458 | pd->cd->mask_size, |
459 | pd->cd->mask, | |
9b7de833 | 460 | peerDigestSwapInMask, fetch); |
461 | } else { | |
e13ee7ad | 462 | peerDigestFetchAbort(fetch, buf, "invalid digest cblock"); |
9b7de833 | 463 | } |
464 | } else { | |
465 | /* need more data, do we have space? */ | |
466 | if (size >= SM_PAGE_SIZE) | |
e13ee7ad | 467 | peerDigestFetchAbort(fetch, buf, "digest cblock too big"); |
9b7de833 | 468 | else |
469 | storeClientCopy(fetch->entry, size, 0, SM_PAGE_SIZE, buf, | |
470 | peerDigestSwapInCBlock, fetch); | |
471 | } | |
472 | } | |
473 | ||
474 | static void | |
475 | peerDigestSwapInMask(void *data, char *buf, ssize_t size) | |
476 | { | |
477 | DigestFetchState *fetch = data; | |
e13ee7ad | 478 | PeerDigest *pd; |
479 | ||
480 | /* NOTE! buf points to the middle of pd->cd->mask! */ | |
da407def | 481 | if (peerDigestFetchedEnough(fetch, NULL, size, "peerDigestSwapInMask")) |
482 | return; | |
9d486b43 | 483 | |
e13ee7ad | 484 | pd = fetch->pd; |
485 | assert(pd->cd && pd->cd->mask); | |
9d486b43 | 486 | |
da407def | 487 | fetch->offset += size; |
488 | fetch->mask_offset += size; | |
e13ee7ad | 489 | if (fetch->mask_offset >= pd->cd->mask_size) { |
68814ffd | 490 | debug(72, 2) ("peerDigestSwapInMask: Done! Got %d, expected %d\n", |
e13ee7ad | 491 | fetch->mask_offset, pd->cd->mask_size); |
492 | assert(fetch->mask_offset == pd->cd->mask_size); | |
493 | assert(peerDigestFetchedEnough(fetch, NULL, 0, "peerDigestSwapInMask")); | |
494 | } else { | |
495 | const size_t buf_sz = pd->cd->mask_size - fetch->mask_offset; | |
496 | assert(buf_sz > 0); | |
497 | storeClientCopy(fetch->entry, | |
498 | fetch->offset, | |
499 | fetch->offset, | |
500 | buf_sz, | |
501 | pd->cd->mask + fetch->mask_offset, | |
502 | peerDigestSwapInMask, fetch); | |
9b7de833 | 503 | } |
504 | } | |
505 | ||
506 | static int | |
4b4cd312 | 507 | peerDigestFetchedEnough(DigestFetchState * fetch, char *buf, ssize_t size, const char *step_name) |
9b7de833 | 508 | { |
e13ee7ad | 509 | PeerDigest *pd = NULL; |
8a6218c6 | 510 | const char *host = "<unknown>"; /* peer host */ |
511 | const char *reason = NULL; /* reason for completion */ | |
512 | const char *no_bug = NULL; /* successful completion if set */ | |
9d486b43 | 513 | const int fcb_valid = cbdataValid(fetch); |
e13ee7ad | 514 | const int pdcb_valid = fcb_valid && cbdataValid(fetch->pd); |
515 | const int pcb_valid = pdcb_valid && cbdataValid(fetch->pd->peer); | |
516 | ||
517 | /* test possible exiting conditions (the same for most steps!) | |
518 | * cases marked with '?!' should not happen */ | |
519 | ||
520 | if (!reason) { | |
521 | if (!fcb_valid) | |
8a6218c6 | 522 | reason = "fetch aborted?!"; |
e13ee7ad | 523 | else if (!(pd = fetch->pd)) |
524 | reason = "peer digest disappeared?!"; | |
5385c86a | 525 | #if DONT |
e13ee7ad | 526 | else if (!cbdataValid(pd)) |
527 | reason = "invalidated peer digest?!"; | |
5385c86a | 528 | #endif |
e13ee7ad | 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?!"; | |
b7fe0ab0 | 543 | else if (EBIT_TEST(fetch->entry->flags, ENTRY_ABORTED)) |
e13ee7ad | 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 | } |
3855c318 | 667 | fetch->pd = NULL; |
5d9bb360 | 668 | cbdataUnlock(pd); |
e13ee7ad | 669 | } |
670 | ||
671 | /* free fetch state structures | |
672 | * must be called only when fetch cbdata is valid */ | |
673 | static void | |
674 | peerDigestFetchFinish(DigestFetchState * fetch, int err) | |
675 | { | |
676 | assert(fetch->entry && fetch->request); | |
677 | ||
9b7de833 | 678 | if (fetch->old_entry) { |
4b4cd312 | 679 | debug(72, 2) ("peerDigestFetchFinish: deleting old entry\n"); |
9b7de833 | 680 | storeUnregister(fetch->old_entry, fetch); |
681 | storeReleaseRequest(fetch->old_entry); | |
682 | storeUnlockObject(fetch->old_entry); | |
683 | fetch->old_entry = NULL; | |
684 | } | |
1543ab6c | 685 | /* update global stats */ |
e13ee7ad | 686 | kb_incr(&Counter.cd.kbytes_sent, (size_t) fetch->sent.bytes); |
687 | kb_incr(&Counter.cd.kbytes_recv, (size_t) fetch->recv.bytes); | |
688 | Counter.cd.msgs_sent += fetch->sent.msg; | |
689 | Counter.cd.msgs_recv += fetch->recv.msg; | |
690 | ||
1543ab6c | 691 | /* unlock everything */ |
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; |
3855c318 | 697 | assert(fetch->pd == NULL); |
9d486b43 | 698 | cbdataUnlock(fetch); |
9b7de833 | 699 | cbdataFree(fetch); |
9b7de833 | 700 | } |
701 | ||
e13ee7ad | 702 | /* calculate fetch stats after completion */ |
703 | static void | |
704 | peerDigestFetchSetStats(DigestFetchState * fetch) | |
705 | { | |
706 | MemObject *mem; | |
707 | assert(fetch->entry && fetch->request); | |
708 | ||
709 | mem = fetch->entry->mem_obj; | |
710 | assert(mem); | |
711 | ||
712 | /* XXX: outgoing numbers are not precise */ | |
713 | /* XXX: we must distinguish between 304 hits and misses here */ | |
714 | fetch->sent.bytes = httpRequestPrefixLen(fetch->request); | |
715 | fetch->recv.bytes = fetch->entry->store_status == STORE_PENDING ? | |
716 | mem->inmem_hi : mem->object_sz; | |
717 | fetch->sent.msg = fetch->recv.msg = 1; | |
718 | fetch->expires = fetch->entry->expires; | |
719 | fetch->resp_time = squid_curtime - fetch->start_time; | |
720 | ||
721 | debug(72, 3) ("peerDigestFetchFinish: recv %d bytes in %d secs\n", | |
722 | fetch->recv.bytes, fetch->resp_time); | |
723 | debug(72, 3) ("peerDigestFetchFinish: expires: %d (%+d), lmt: %d (%+d)\n", | |
8a6218c6 | 724 | fetch->expires, fetch->expires - squid_curtime, |
725 | fetch->entry->lastmod, fetch->entry->lastmod - squid_curtime); | |
e13ee7ad | 726 | } |
727 | ||
728 | ||
9b7de833 | 729 | static int |
8a6218c6 | 730 | peerDigestSetCBlock(PeerDigest * pd, const char *buf) |
9b7de833 | 731 | { |
732 | StoreDigestCBlock cblock; | |
733 | int freed_size = 0; | |
e13ee7ad | 734 | const char *host = strBuf(pd->host); |
735 | ||
9b7de833 | 736 | xmemcpy(&cblock, buf, sizeof(cblock)); |
737 | /* network -> host conversions */ | |
738 | cblock.ver.current = ntohs(cblock.ver.current); | |
739 | cblock.ver.required = ntohs(cblock.ver.required); | |
740 | cblock.capacity = ntohl(cblock.capacity); | |
741 | cblock.count = ntohl(cblock.count); | |
742 | cblock.del_count = ntohl(cblock.del_count); | |
743 | cblock.mask_size = ntohl(cblock.mask_size); | |
4b4cd312 | 744 | debug(72, 2) ("got digest cblock from %s; ver: %d (req: %d)\n", |
e13ee7ad | 745 | host, (int) cblock.ver.current, (int) cblock.ver.required); |
4b4cd312 | 746 | debug(72, 2) ("\t size: %d bytes, e-cnt: %d, e-util: %d%%\n", |
9b7de833 | 747 | cblock.mask_size, cblock.count, |
748 | xpercentInt(cblock.count, cblock.capacity)); | |
6106c6fc | 749 | /* check version requirements (both ways) */ |
9b7de833 | 750 | if (cblock.ver.required > CacheDigestVer.current) { |
4b4cd312 | 751 | debug(72, 1) ("%s digest requires version %d; have: %d\n", |
e13ee7ad | 752 | host, cblock.ver.required, CacheDigestVer.current); |
9b7de833 | 753 | return 0; |
754 | } | |
6106c6fc | 755 | if (cblock.ver.current < CacheDigestVer.required) { |
4b4cd312 | 756 | debug(72, 1) ("%s digest is version %d; we require: %d\n", |
e13ee7ad | 757 | host, cblock.ver.current, CacheDigestVer.required); |
6106c6fc | 758 | return 0; |
759 | } | |
9b7de833 | 760 | /* check consistency */ |
4b4cd312 | 761 | if (cblock.ver.required > cblock.ver.current || |
d1cdaa16 | 762 | cblock.mask_size <= 0 || cblock.capacity <= 0 || |
763 | cblock.bits_per_entry <= 0 || cblock.hash_func_count <= 0) { | |
e13ee7ad | 764 | debug(72, 0) ("%s digest cblock is corrupted.\n", host); |
9b7de833 | 765 | return 0; |
766 | } | |
d1cdaa16 | 767 | /* check consistency further */ |
768 | if (cblock.mask_size != cacheDigestCalcMaskSize(cblock.capacity, cblock.bits_per_entry)) { | |
4b4cd312 | 769 | debug(72, 0) ("%s digest cblock is corrupted (mask size mismatch: %d ? %d).\n", |
e13ee7ad | 770 | host, cblock.mask_size, cacheDigestCalcMaskSize(cblock.capacity, cblock.bits_per_entry)); |
d1cdaa16 | 771 | return 0; |
772 | } | |
773 | /* there are some things we cannot do yet */ | |
774 | if (cblock.hash_func_count != CacheDigestHashFuncCount) { | |
4b4cd312 | 775 | debug(72, 0) ("%s digest: unsupported #hash functions: %d ? %d.\n", |
e13ee7ad | 776 | host, cblock.hash_func_count, CacheDigestHashFuncCount); |
d1cdaa16 | 777 | return 0; |
778 | } | |
9b7de833 | 779 | /* |
780 | * no cblock bugs below this point | |
781 | */ | |
782 | /* check size changes */ | |
e13ee7ad | 783 | if (pd->cd && cblock.mask_size != pd->cd->mask_size) { |
4b4cd312 | 784 | debug(72, 2) ("%s digest changed size: %d -> %d\n", |
8a6218c6 | 785 | host, cblock.mask_size, pd->cd->mask_size); |
e13ee7ad | 786 | freed_size = pd->cd->mask_size; |
787 | cacheDigestDestroy(pd->cd); | |
788 | pd->cd = NULL; | |
9b7de833 | 789 | } |
e13ee7ad | 790 | if (!pd->cd) { |
45694534 | 791 | debug(72, 2) ("creating %s digest; size: %d (%+d) bytes\n", |
e13ee7ad | 792 | host, cblock.mask_size, (int) (cblock.mask_size - freed_size)); |
793 | pd->cd = cacheDigestCreate(cblock.capacity, cblock.bits_per_entry); | |
9b7de833 | 794 | if (cblock.mask_size >= freed_size) |
795 | kb_incr(&Counter.cd.memory, cblock.mask_size - freed_size); | |
796 | } | |
e13ee7ad | 797 | assert(pd->cd); |
9b7de833 | 798 | /* these assignments leave us in an inconsistent state until we finish reading the digest */ |
e13ee7ad | 799 | pd->cd->count = cblock.count; |
800 | pd->cd->del_count = cblock.del_count; | |
9b7de833 | 801 | return 1; |
802 | } | |
803 | ||
9b7de833 | 804 | static int |
8a6218c6 | 805 | peerDigestUseful(const PeerDigest * pd) |
9b7de833 | 806 | { |
d1cdaa16 | 807 | /* TODO: we should calculate the prob of a false hit instead of bit util */ |
e13ee7ad | 808 | const int bit_util = cacheDigestBitUtil(pd->cd); |
809 | if (bit_util > 65) { | |
4b4cd312 | 810 | debug(72, 0) ("Warning: %s peer digest has too many bits on (%d%%).\n", |
e13ee7ad | 811 | strBuf(pd->host), bit_util); |
d1cdaa16 | 812 | return 0; |
9b7de833 | 813 | } |
814 | return 1; | |
815 | } | |
7f6eb0fe | 816 | |
e13ee7ad | 817 | static int |
818 | saneDiff(time_t diff) | |
819 | { | |
8a6218c6 | 820 | return abs(diff) > squid_curtime / 2 ? 0 : diff; |
e13ee7ad | 821 | } |
822 | ||
823 | void | |
8a6218c6 | 824 | peerDigestStatsReport(const PeerDigest * pd, StoreEntry * e) |
e13ee7ad | 825 | { |
826 | #define f2s(flag) (pd->flags.flag ? "yes" : "no") | |
827 | #define appendTime(tm) storeAppendPrintf(e, "%s\t %10d\t %+d\t %+d\n", \ | |
828 | ""#tm, pd->times.tm, \ | |
829 | saneDiff(pd->times.tm - squid_curtime), \ | |
830 | saneDiff(pd->times.tm - pd->times.initialized)) | |
831 | ||
832 | const char *host = pd ? strBuf(pd->host) : NULL; | |
833 | assert(pd); | |
834 | ||
835 | storeAppendPrintf(e, "\npeer digest from %s\n", host); | |
836 | ||
837 | cacheDigestGuessStatsReport(&pd->stats.guess, e, host); | |
838 | ||
839 | storeAppendPrintf(e, "\nevent\t timestamp\t secs from now\t secs from init\n"); | |
840 | appendTime(initialized); | |
841 | appendTime(needed); | |
842 | appendTime(requested); | |
843 | appendTime(received); | |
844 | appendTime(next_check); | |
845 | ||
846 | storeAppendPrintf(e, "peer digest state:\n"); | |
847 | storeAppendPrintf(e, "\tneeded: %3s, usable: %3s, requested: %3s\n", | |
848 | f2s(needed), f2s(usable), f2s(requested)); | |
849 | storeAppendPrintf(e, "\n\tlast retry delay: %d secs\n", | |
850 | pd->times.retry_delay); | |
851 | storeAppendPrintf(e, "\tlast request response time: %d secs\n", | |
852 | pd->times.req_delay); | |
853 | storeAppendPrintf(e, "\tlast request result: %s\n", | |
854 | pd->req_result ? pd->req_result : "(none)"); | |
855 | ||
856 | storeAppendPrintf(e, "\npeer digest traffic:\n"); | |
857 | storeAppendPrintf(e, "\trequests sent: %d, volume: %d KB\n", | |
858 | pd->stats.sent.msgs, (int) pd->stats.sent.kbytes.kb); | |
859 | storeAppendPrintf(e, "\treplies recv: %d, volume: %d KB\n", | |
860 | pd->stats.recv.msgs, (int) pd->stats.recv.kbytes.kb); | |
861 | ||
862 | storeAppendPrintf(e, "\npeer digest structure:\n"); | |
863 | if (pd->cd) | |
864 | cacheDigestReport(pd->cd, host, e); | |
865 | else | |
866 | storeAppendPrintf(e, "\tno in-memory copy\n"); | |
867 | } | |
868 | ||
7f6eb0fe | 869 | #endif |