Client.cc
Go to the documentation of this file.
1 /*
2  * Copyright (C) 1996-2020 The Squid Software Foundation and contributors
3  *
4  * Squid software is distributed under GPLv2+ license and includes
5  * contributions from numerous individuals and organizations.
6  * Please see the COPYING and CONTRIBUTORS files for details.
7  */
8 
9 #include "squid.h"
10 #include "acl/FilledChecklist.h"
11 #include "acl/Gadgets.h"
12 #include "base/TextException.h"
13 #include "clients/Client.h"
14 #include "comm/Connection.h"
15 #include "comm/forward.h"
16 #include "comm/Write.h"
17 #include "err_detail_type.h"
18 #include "errorpage.h"
19 #include "fd.h"
20 #include "HttpHdrContRange.h"
21 #include "HttpReply.h"
22 #include "HttpRequest.h"
23 #include "SquidConfig.h"
24 #include "SquidTime.h"
25 #include "StatCounters.h"
26 #include "Store.h"
27 #include "tools.h"
28 
29 #if USE_ADAPTATION
30 #include "adaptation/AccessCheck.h"
31 #include "adaptation/Answer.h"
32 #include "adaptation/Iterator.h"
33 #include "base/AsyncCall.h"
34 #endif
35 
36 // implemented in client_side_reply.cc until sides have a common parent
37 void purgeEntriesByUrl(HttpRequest * req, const char *url);
38 
39 Client::Client(FwdState *theFwdState) :
40  AsyncJob("Client"),
41  fwd(theFwdState),
42  request(fwd->request)
43 {
44  entry = fwd->entry;
45  entry->lock("Client");
46 }
47 
49 {
50  // paranoid: check that swanSong has been called
52 #if USE_ADAPTATION
55 #endif
56 
57  entry->unlock("Client");
58 
61 
62  if (responseBodyBuffer != NULL) {
63  delete responseBodyBuffer;
65  }
66 }
67 
68 void
70 {
71  // get rid of our piping obligations
72  if (requestBodySource != NULL)
74 
75 #if USE_ADAPTATION
77 #endif
78 
79  if (!doneWithServer())
80  closeServer();
81 
82  if (!doneWithFwd) {
83  doneWithFwd = "swanSong()";
85  }
86 
88 #if USE_ADAPTATION
89  Initiator::swanSong();
91 #endif
92 
93  // paranoid: check that swanSong has been called
94  // extra paranoid: yeah, I really mean it. they MUST pass here.
96 #if USE_ADAPTATION
99 #endif
100 }
101 
102 HttpReply *
104 {
106  return theVirginReply;
107 }
108 
109 const HttpReply *
110 Client::virginReply() const
111 {
113  return theVirginReply;
114 }
115 
116 HttpReply *
118 {
119  debugs(11,5, HERE << this << " setting virgin reply to " << rep);
121  assert(rep);
122  theVirginReply = rep;
124  if (fwd->al)
126  return theVirginReply;
127 }
128 
129 HttpReply *
131 {
133  return theFinalReply;
134 }
135 
136 HttpReply *
138 {
139  debugs(11,5, HERE << this << " setting final reply to " << rep);
140 
142  assert(rep);
143  theFinalReply = rep;
145  if (fwd->al)
147 
148  // give entry the reply because haveParsedReplyHeaders() expects it there
149  entry->replaceHttpReply(theFinalReply, false); // but do not write yet
150  haveParsedReplyHeaders(); // update the entry/reply (e.g., set timestamps)
152  entry->release();
153  entry->startWriting(); // write the updated entry to store
154 
155  return theFinalReply;
156 }
157 
158 // called when no more server communication is expected; may quit
159 void
161 {
162  debugs(11,5,HERE << "serverComplete " << this);
163 
164  if (!doneWithServer()) {
165  closeServer();
167  }
168 
169  completed = true;
171 
172  if (requestBodySource != NULL)
174 
175  if (responseBodyBuffer != NULL)
176  return;
177 
178  serverComplete2();
179 }
180 
181 void
183 {
184  debugs(11,5,HERE << "serverComplete2 " << this);
185 
186 #if USE_ADAPTATION
189 
190  if (!doneWithAdaptation())
191  return;
192 #endif
193 
195 }
196 
197 bool Client::doneAll() const
198 {
199  return doneWithServer() &&
200 #if USE_ADAPTATION
201  doneWithAdaptation() &&
204 #endif
206 }
207 
208 // FTP side overloads this to work around multiple calls to fwd->complete
209 void
211 {
212  debugs(11,5, HERE << "completing forwarding for " << fwd);
213  assert(fwd != NULL);
214  doneWithFwd = "completeForwarding()";
215  fwd->complete();
216 }
217 
218 // Register to receive request body
220 {
222  assert(r->body_pipe != NULL);
225  debugs(11,3, HERE << "expecting request body from " <<
227  return true;
228  }
229 
230  debugs(11,3, HERE << "aborting on partially consumed request body: " <<
233  return false;
234 }
235 
236 // Entry-dependent callbacks use this check to quit if the entry went bad
237 bool
238 Client::abortOnBadEntry(const char *abortReason)
239 {
240  if (entry->isAccepting())
241  return false;
242 
243  debugs(11,5, HERE << "entry is not Accepting!");
244  abortOnData(abortReason);
245  return true;
246 }
247 
248 // more request or adapted response body is available
249 void
251 {
252 #if USE_ADAPTATION
253  if (adaptedBodySource == bp) {
255  return;
256  }
257 #endif
258  if (requestBodySource == bp)
260 }
261 
262 // the entire request or adapted response body was provided, successfully
263 void
265 {
266 #if USE_ADAPTATION
267  if (adaptedBodySource == bp) {
269  return;
270  }
271 #endif
272  if (requestBodySource == bp)
274 }
275 
276 // premature end of the request or adapted response body production
277 void
279 {
280 #if USE_ADAPTATION
281  if (adaptedBodySource == bp) {
283  return;
284  }
285 #endif
286  if (requestBodySource == bp)
288 }
289 
290 bool
291 Client::abortOnData(const char *reason)
292 {
293  abortAll(reason);
294  return true;
295 }
296 
297 // more origin request body data is available
298 void
300 {
301  if (!requestSender)
303  else
304  debugs(9,3, HERE << "waiting for request body write to complete");
305 }
306 
307 // there will be no more handleMoreRequestBodyAvailable calls
308 void
310 {
312  if (!requestSender)
314  else
315  debugs(9,3, HERE << "waiting for request body write to complete");
316 }
317 
318 // called when we are done sending request body; kids extend this
319 void
321 {
322  debugs(9,3, HERE << "done sending request body");
325 
326  // kids extend this
327 }
328 
329 // called when body producers aborts; kids extend this
330 void
332 {
333  if (requestSender != NULL)
334  debugs(9,3, HERE << "fyi: request body aborted while we were sending");
335 
336  fwd->dontRetry(true); // the problem is not with the server
337  stopConsumingFrom(requestBodySource); // requestSender, if any, will notice
338 
339  // kids extend this
340 }
341 
342 // called when we wrote request headers(!) or a part of the body
343 void
345 {
346  debugs(11, 5, "sentRequestBody: FD " << io.fd << ": size " << io.size << ": errflag " << io.flag << ".");
347  debugs(32,3,HERE << "sentRequestBody called");
348 
350 
351  if (io.size > 0) {
352  fd_bytes(io.fd, io.size, FD_WRITE);
353  statCounter.server.all.kbytes_out += io.size;
354  // kids should increment their counters
355  }
356 
357  if (io.flag == Comm::ERR_CLOSING)
358  return;
359 
360  if (!requestBodySource) {
361  debugs(9,3, HERE << "detected while-we-were-sending abort");
362  return; // do nothing;
363  }
364 
365  // both successful and failed writes affect response times
367 
368  if (io.flag) {
369  debugs(11, DBG_IMPORTANT, "sentRequestBody error: FD " << io.fd << ": " << xstrerr(io.xerrno));
370  ErrorState *err;
372  err->xerrno = io.xerrno;
373  fwd->fail(err);
374  abortOnData("I/O error while sending request body");
375  return;
376  }
377 
379  abortOnData("store entry aborted while sending request body");
380  return;
381  }
382 
385  else if (receivedWholeRequestBody)
387  else
388  debugs(9,3, HERE << "waiting for body production end or abort");
389 }
390 
391 void
393 {
396 
398 
399  if (!Comm::IsConnOpen(conn)) {
400  debugs(9,3, HERE << "cannot send request body to closing " << conn);
401  return; // wait for the kid's close handler; TODO: assert(closer);
402  }
403 
404  MemBuf buf;
405  if (getMoreRequestBody(buf) && buf.contentSize() > 0) {
406  debugs(9,3, HERE << "will write " << buf.contentSize() << " request body bytes");
408  requestSender = JobCallback(93,3, Dialer, this, Client::sentRequestBody);
410  } else {
411  debugs(9,3, HERE << "will wait for more request body bytes or eof");
413  }
414 }
415 
417 bool
419 {
420  // default implementation does not encode request body content
423 }
424 
425 // Compares hosts in urls, returns false if different, no sheme, or no host.
426 static bool
427 sameUrlHosts(const char *url1, const char *url2)
428 {
429  // XXX: Want AnyP::Uri::parse() here, but it uses static storage and copying
430  const char *host1 = strchr(url1, ':');
431  const char *host2 = strchr(url2, ':');
432 
433  if (host1 && host2) {
434  // skip scheme slashes
435  do {
436  ++host1;
437  ++host2;
438  } while (*host1 == '/' && *host2 == '/');
439 
440  if (!*host1)
441  return false; // no host
442 
443  // increment while the same until we reach the end of the URL/host
444  while (*host1 && *host1 != '/' && *host1 == *host2) {
445  ++host1;
446  ++host2;
447  }
448  return *host1 == *host2;
449  }
450 
451  return false; // no URL scheme
452 }
453 
454 // purges entries that match the value of a given HTTP [response] header
455 static void
456 purgeEntriesByHeader(HttpRequest *req, const char *reqUrl, Http::Message *rep, Http::HdrType hdr)
457 {
458  const auto hdrUrl = rep->header.getStr(hdr);
459  if (!hdrUrl)
460  return;
461 
462  /*
463  * If the URL is relative, make it absolute so we can find it.
464  * If it's absolute, make sure the host parts match to avoid DOS attacks
465  * as per RFC 2616 13.10.
466  */
467  SBuf absUrlMaker;
468  const char *absUrl = nullptr;
469  if (urlIsRelative(hdrUrl)) {
470  if (req->method.id() == Http::METHOD_CONNECT)
471  absUrl = hdrUrl; // TODO: merge authority-uri and hdrUrl
472  else if (req->url.getScheme() == AnyP::PROTO_URN)
473  absUrl = req->url.absolute().c_str();
474  else {
475  AnyP::Uri tmpUrl = req->url;
476  if (*hdrUrl == '/') {
477  // RFC 3986 section 4.2: absolute-path reference
478  // for this logic replace the entire request-target URI path
479  tmpUrl.path(hdrUrl);
480  } else {
481  tmpUrl.addRelativePath(reqUrl);
482  }
483  absUrlMaker = tmpUrl.absolute();
484  absUrl = absUrlMaker.c_str();
485  }
486  } else if (!sameUrlHosts(reqUrl, hdrUrl)) {
487  return;
488  } else
489  absUrl = hdrUrl;
490 
491  purgeEntriesByUrl(req, absUrl);
492 }
493 
494 // some HTTP methods should purge matching cache entries
495 void
497 {
498  // only some HTTP methods should purge matching cache entries
499  if (!request->method.purgesOthers())
500  return;
501 
502  // and probably only if the response was successful
503  if (theFinalReply->sline.status() >= 400)
504  return;
505 
506  // XXX: should we use originalRequest() here?
508  const char *reqUrl = tmp.c_str();
509  debugs(88, 5, "maybe purging due to " << request->method << ' ' << tmp);
510  purgeEntriesByUrl(request.getRaw(), reqUrl);
513 }
514 
516 void
518 {
521 
522  // adaptation may overwrite old offset computed using the virgin response
523  const bool partial = theFinalReply->contentRange();
524  currentOffset = partial ? theFinalReply->contentRange()->spec.offset : 0;
525 }
526 
528 bool
530 {
531  if (const Acl::Tree *acl = Config.accessList.storeMiss) {
532  // This relatively expensive check is not in StoreEntry::checkCachable:
533  // That method lacks HttpRequest and may be called too many times.
534  ACLFilledChecklist ch(acl, originalRequest().getRaw());
535  ch.reply = const_cast<HttpReply*>(&entry->mem().freshestReply()); // ACLFilledChecklist API bug
536  HTTPMSGLOCK(ch.reply);
537  ch.al = fwd->al;
538  if (!ch.fastCheck().allowed()) { // when in doubt, block
539  debugs(20, 3, "store_miss prohibits caching");
540  return true;
541  }
542  }
543  return false;
544 }
545 
548 {
549  return request;
550 }
551 
552 #if USE_ADAPTATION
553 void
556 {
557  debugs(11, 5, "Client::startAdaptation() called");
558  // check whether we should be sending a body as well
559  // start body pipe to feed ICAP transaction if needed
561  HttpReply *vrep = virginReply();
562  assert(!vrep->body_pipe);
563  int64_t size = 0;
564  if (vrep->expectingBody(cause->method, size) && size) {
565  virginBodyDestination = new BodyPipe(this);
567  debugs(93, 6, HERE << "will send virgin reply body to " <<
568  virginBodyDestination << "; size: " << size);
569  if (size > 0)
571  }
572 
574  new Adaptation::Iterator(vrep, cause, fwd->al, group));
577 }
578 
579 // properly cleans up ICAP-related state
580 // may be called multiple times
582 {
583  debugs(11,5, HERE << "cleaning ICAP; ACL: " << adaptationAccessCheckPending);
584 
587 
589 
590  if (adaptedBodySource != NULL)
592 
593  if (!adaptationAccessCheckPending) // we cannot cancel a pending callback
594  assert(doneWithAdaptation()); // make sure the two methods are in sync
595 }
596 
597 bool
599 {
602 }
603 
604 // sends virgin reply body to ICAP, buffering excesses if needed
605 void
606 Client::adaptVirginReplyBody(const char *data, ssize_t len)
607 {
609 
610  if (!virginBodyDestination) {
611  debugs(11,3, HERE << "ICAP does not want more virgin body");
612  return;
613  }
614 
615  // grow overflow area if already overflowed
616  if (responseBodyBuffer) {
620  }
621 
622  const ssize_t putSize = virginBodyDestination->putMoreData(data, len);
623  data += putSize;
624  len -= putSize;
625 
626  // if we had overflow area, shrink it as necessary
627  if (responseBodyBuffer) {
628  if (putSize == responseBodyBuffer->contentSize()) {
629  delete responseBodyBuffer;
631  } else {
632  responseBodyBuffer->consume(putSize);
633  }
634  return;
635  }
636 
637  // if we did not have an overflow area, create it as needed
638  if (len > 0) {
641  responseBodyBuffer->init(4096, SQUID_TCP_SO_RCVBUF * 10);
643  }
644 }
645 
646 // can supply more virgin response body data
647 void
649 {
650  if (responseBodyBuffer) {
651  addVirginReplyBody(NULL, 0); // kick the buffered fragment alive again
652  if (completed && !responseBodyBuffer) {
653  serverComplete2();
654  return;
655  }
656  }
658 }
659 
660 // the consumer of our virgin response body aborted
661 void
663 {
665 
666  // do not force closeServer here in case we need to bypass AdaptationQueryAbort
667 
668  if (doneWithAdaptation()) // we may still be receiving adapted response
670 }
671 
672 // received adapted response headers (body may follow)
673 void
675 {
676  clearAdaptation(adaptedHeadSource); // we do not expect more messages
677 
678  switch (answer.kind) {
680  handleAdaptedHeader(const_cast<Http::Message*>(answer.message.getRaw()));
681  break;
682 
684  handleAdaptationBlocked(answer);
685  break;
686 
689  break;
690  }
691 }
692 
693 void
695 {
696  if (abortOnBadEntry("entry went bad while waiting for adapted headers")) {
697  // If the adapted response has a body, the ICAP side needs to know
698  // that nobody will consume that body. We will be destroyed upon
699  // return. Tell the ICAP side that it is on its own.
700  HttpReply *rep = dynamic_cast<HttpReply*>(msg);
701  assert(rep);
702  if (rep->body_pipe != NULL)
704 
705  return;
706  }
707 
708  HttpReply *rep = dynamic_cast<HttpReply*>(msg);
709  assert(rep);
710  debugs(11,5, HERE << this << " setting adapted reply to " << rep);
711  setFinalReply(rep);
712 
714  if (rep->body_pipe != NULL) {
715  // subscribe to receive adapted body
717  // assume that ICAP does not auto-consume on failures
718  const bool result = adaptedBodySource->setConsumerIfNotLate(this);
719  assert(result);
720  } else {
721  // no body
722  if (doneWithAdaptation()) // we may still be sending virgin response
724  }
725 }
726 
727 void
729 {
730  if (abortOnBadEntry("store entry aborted while kick producer callback"))
731  return;
732 
733  if (!adaptedBodySource)
734  return;
735 
737 
740 }
741 
742 // more adapted response body is available
743 void
745 {
746  if (abortOnBadEntry("entry refuses adapted body"))
747  return;
748 
749  assert(entry);
750 
751  size_t contentSize = adaptedBodySource->buf().contentSize();
752 
753  if (!contentSize)
754  return; // XXX: bytesWanted asserts on zero-size ranges
755 
756  const size_t spaceAvailable = entry->bytesWanted(Range<size_t>(0, contentSize), true);
757 
758  if (spaceAvailable < contentSize ) {
759  // No or partial body data consuming
760  typedef NullaryMemFunT<Client> Dialer;
761  AsyncCall::Pointer call = asyncCall(93, 5, "Client::resumeBodyStorage",
762  Dialer(this, &Client::resumeBodyStorage));
763  entry->deferProducer(call);
764  }
765 
766  if (!spaceAvailable) {
767  debugs(11, 5, HERE << "NOT storing " << contentSize << " bytes of adapted " <<
768  "response body at offset " << adaptedBodySource->consumedSize());
769  return;
770  }
771 
772  if (spaceAvailable < contentSize ) {
773  debugs(11, 5, HERE << "postponing storage of " <<
774  (contentSize - spaceAvailable) << " body bytes");
775  contentSize = spaceAvailable;
776  }
777 
778  debugs(11,5, HERE << "storing " << contentSize << " bytes of adapted " <<
779  "response body at offset " << adaptedBodySource->consumedSize());
780 
782  const StoreIOBuffer ioBuf(&bpc.buf, currentOffset, contentSize);
783  currentOffset += ioBuf.length;
784  entry->write(ioBuf);
785  bpc.buf.consume(contentSize);
786  bpc.checkIn();
787 }
788 
789 // the entire adapted response body was produced, successfully
790 void
792 {
793  if (abortOnBadEntry("entry went bad while waiting for adapted body eof"))
794  return;
795 
796  // end consumption if we consumed everything
799  // else resumeBodyStorage() will eventually consume the rest
800 }
801 
802 void
804 {
807 }
808 
809 // premature end of the adapted response body
811 {
812  if (abortOnBadEntry("entry went bad while waiting for the now-aborted adapted body"))
813  return;
814 
815  Must(adaptedBodySource != nullptr);
816  if (!adaptedBodySource->exhausted()) {
817  debugs(11,5, "waiting to consume the remainder of the aborted adapted body");
818  return; // resumeBodyStorage() should eventually consume the rest
819  }
820 
822 
824  return;
825 
826  entry->lengthWentBad("body adaptation aborted");
827  handleAdaptationCompleted(); // the user should get a truncated response
828 }
829 
830 // common part of noteAdaptationAnswer and handleAdaptedBodyProductionEnded
831 void
833 {
834  debugs(11,5, HERE << "handleAdaptationCompleted");
835  cleanAdaptation();
836 
837  // We stop reading origin response because we have no place to put it(*) and
838  // cannot use it. If some origin servers do not like that or if we want to
839  // reuse more pconns, we can add code to discard unneeded origin responses.
840  // (*) TODO: Is it possible that the adaptation xaction is still running?
841  if (mayReadVirginReplyBody()) {
842  debugs(11,3, HERE << "closing origin conn due to ICAP completion");
843  closeServer();
844  }
845 
847 }
848 
849 // common part of noteAdaptation*Aborted and noteBodyConsumerAborted methods
850 void
852 {
853  debugs(11,5, HERE << "handleAdaptationAborted; bypassable: " << bypassable <<
854  ", entry empty: " << entry->isEmpty());
855 
856  if (abortOnBadEntry("entry went bad while ICAP aborted"))
857  return;
858 
859  // TODO: bypass if possible
861  abortAll("adaptation failure with a filled entry");
862 }
863 
866 bool
868 {
869  if (entry->isEmpty()) {
870  debugs(11,8, "adaptation failure with an empty entry: " << *entry);
872  err->detailError(ERR_DETAIL_ICAP_RESPMOD_EARLY);
873  fwd->fail(err);
874  fwd->dontRetry(true);
875  abortAll("adaptation failure with an empty entry");
876  return true; // handled
877  }
878 
879  if (request) // update logged info directly
881 
882  return false; // the caller must handle
883 }
884 
885 // adaptation service wants us to deny HTTP client access to this response
886 void
888 {
889  debugs(11,5, HERE << answer.ruleId);
890 
891  if (abortOnBadEntry("entry went bad while ICAP aborted"))
892  return;
893 
894  if (!entry->isEmpty()) { // too late to block (should not really happen)
895  if (request)
897  abortAll("late adaptation block");
898  return;
899  }
900 
901  debugs(11,7, HERE << "creating adaptation block response");
902 
903  err_type page_id =
905  if (page_id == ERR_NONE)
906  page_id = ERR_ACCESS_DENIED;
907 
908  const auto err = new ErrorState(page_id, Http::scForbidden, request.getRaw(), fwd->al);
909  err->detailError(ERR_DETAIL_RESPMOD_BLOCK_EARLY);
910  fwd->fail(err);
911  fwd->dontRetry(true);
912 
913  abortOnData("timely adaptation block");
914 }
915 
916 void
918 {
920 
921  if (abortOnBadEntry("entry went bad while waiting for ICAP ACL check"))
922  return;
923 
924  // TODO: Should non-ICAP and ICAP REPMOD pre-cache paths check this?
925  // That check now only happens on REQMOD pre-cache and REPMOD post-cache, in processReplyAccess().
926  if (virginReply()->expectedBodyTooLarge(*request)) {
928  return;
929  }
930  // TODO: Should we check receivedBodyTooLarge as well?
931 
932  if (!group) {
933  debugs(11,3, HERE << "no adapation needed");
936  return;
937  }
938 
939  startAdaptation(group, originalRequest().getRaw());
941 }
942 #endif
943 
944 void
946 {
947  const auto err = new ErrorState(ERR_TOO_BIG, Http::scForbidden, request.getRaw(), fwd->al);
948  fwd->fail(err);
949  fwd->dontRetry(true);
950  abortOnData("Virgin body too large.");
951 }
952 
953 // TODO: when HttpStateData sends all errors to ICAP,
954 // we should be able to move this at the end of setVirginReply().
955 void
957 {
958 #if USE_ADAPTATION
959  // TODO: merge with client side and return void to hide the on/off logic?
960  // The callback can be called with a NULL service if adaptation is off.
963  originalRequest().getRaw(), virginReply(), fwd->al, this);
964  debugs(11,5, HERE << "adaptationAccessCheckPending=" << adaptationAccessCheckPending);
966  return;
967 #endif
968 
970 }
971 
973 void
974 Client::adjustBodyBytesRead(const int64_t delta)
975 {
976  int64_t &bodyBytesRead = originalRequest()->hier.bodyBytesRead;
977 
978  // if we got here, do not log a dash even if we got nothing from the server
979  if (bodyBytesRead < 0)
980  bodyBytesRead = 0;
981 
982  bodyBytesRead += delta; // supports negative and zero deltas
983 
984  // check for overflows ("infinite" response?) and underflows (a bug)
985  Must(bodyBytesRead >= 0);
986 }
987 
988 void
989 Client::addVirginReplyBody(const char *data, ssize_t len)
990 {
992 
993 #if USE_ADAPTATION
994  assert(!adaptationAccessCheckPending); // or would need to buffer while waiting
995  if (startedAdaptation) {
997  return;
998  }
999 #endif
1001 }
1002 
1003 // writes virgin or adapted reply body to store
1004 void
1005 Client::storeReplyBody(const char *data, ssize_t len)
1006 {
1007  // write even if len is zero to push headers towards the client side
1009 
1010  currentOffset += len;
1011 }
1012 
1013 size_t
1014 Client::calcBufferSpaceToReserve(size_t space, const size_t wantSpace) const
1015 {
1016  if (space < wantSpace) {
1017  const size_t maxSpace = SBuf::maxSize; // absolute best
1018  space = min(wantSpace, maxSpace); // do not promise more than asked
1019  }
1020 
1021 #if USE_ADAPTATION
1022  if (responseBodyBuffer) {
1023  return 0; // Stop reading if already overflowed waiting for ICAP to catch up
1024  }
1025 
1026  if (virginBodyDestination != NULL) {
1027  /*
1028  * BodyPipe buffer has a finite size limit. We
1029  * should not read more data from the network than will fit
1030  * into the pipe buffer or we _lose_ what did not fit if
1031  * the response ends sooner that BodyPipe frees up space:
1032  * There is no code to keep pumping data into the pipe once
1033  * response ends and serverComplete() is called.
1034  */
1035  const size_t adaptor_space = virginBodyDestination->buf().potentialSpaceSize();
1036 
1037  debugs(11,9, "Client may read up to min(" <<
1038  adaptor_space << ", " << space << ") bytes");
1039 
1040  if (adaptor_space < space)
1041  space = adaptor_space;
1042  }
1043 #endif
1044 
1045  return space;
1046 }
1047 
1048 size_t
1049 Client::replyBodySpace(const MemBuf &readBuf, const size_t minSpace) const
1050 {
1051  size_t space = readBuf.spaceSize(); // available space w/o heroic measures
1052  if (space < minSpace) {
1053  const size_t maxSpace = readBuf.potentialSpaceSize(); // absolute best
1054  space = min(minSpace, maxSpace); // do not promise more than asked
1055  }
1056 
1057 #if USE_ADAPTATION
1058  if (responseBodyBuffer) {
1059  return 0; // Stop reading if already overflowed waiting for ICAP to catch up
1060  }
1061 
1062  if (virginBodyDestination != NULL) {
1063  /*
1064  * BodyPipe buffer has a finite size limit. We
1065  * should not read more data from the network than will fit
1066  * into the pipe buffer or we _lose_ what did not fit if
1067  * the response ends sooner that BodyPipe frees up space:
1068  * There is no code to keep pumping data into the pipe once
1069  * response ends and serverComplete() is called.
1070  *
1071  * If the pipe is totally full, don't register the read handler.
1072  * The BodyPipe will call our noteMoreBodySpaceAvailable() method
1073  * when it has free space again.
1074  */
1075  size_t adaptation_space =
1077 
1078  debugs(11,9, "Client may read up to min(" <<
1079  adaptation_space << ", " << space << ") bytes");
1080 
1081  if (adaptation_space < space)
1082  space = adaptation_space;
1083  }
1084 #endif
1085 
1086  return space;
1087 }
1088 
virtual void noteMoreBodyDataAvailable(BodyPipe::Pointer)
Definition: Client.cc:250
const MemBuf & buf() const
Definition: BodyPipe.h:137
const char * xstrerr(int error)
Definition: xstrerror.cc:83
void handleMoreRequestBodyAvailable()
Definition: Client.cc:299
static bool sameUrlHosts(const char *url1, const char *url2)
Definition: Client.cc:427
struct StatCounters::@130::@140 all
void storeReplyBody(const char *buf, ssize_t len)
Definition: Client.cc:1005
HttpReply * theVirginReply
Definition: Client.h:190
virtual bool getMoreRequestBody(MemBuf &buf)
either fill buf with available [encoded] request body bytes or return false
Definition: Client.cc:418
HttpHdrRangeSpec spec
StoreEntry * entry
Definition: Client.h:164
@ ERR_ICAP_FAILURE
Definition: err_type.h:62
bool initiated(const CbcPointer< AsyncJob > &job) const
Must(initiated(initiate)) instead of Must(initiate.set()), for clarity.
Definition: Initiator.h:52
AnyP::Uri url
the request URI
Definition: HttpRequest.h:115
common parts of HttpRequest and HttpReply
Definition: Message.h:25
BodyPipe::Pointer body_pipe
optional pipeline to receive message body
Definition: Message.h:98
void endAdaptedBodyConsumption()
called when the entire adapted response body is consumed
Definition: Client.cc:803
Definition: Uri.h:30
void adaptVirginReplyBody(const char *buf, ssize_t len)
Definition: Client.cc:606
@ FD_WRITE
Definition: enums.h:24
void stopPeerClock(const bool force)
Definition: access_log.cc:303
virtual void swanSong()
Definition: Client.cc:69
bool completed
Definition: Client.h:86
const char * getStr(Http::HdrType id) const
Definition: HttpHeader.cc:1208
@ ERR_DETAIL_ICAP_RESPMOD_LATE
HttpHeader header
Definition: Message.h:75
AsyncCall::Pointer requestSender
Definition: Client.h:170
virtual void swanSong()
Definition: AsyncJob.h:54
bool final
whether the error, if any, cannot be bypassed
Definition: Answer.h:41
Client(FwdState *)
Definition: Client.cc:39
void setBodySize(uint64_t aSize)
Definition: BodyPipe.cc:147
MemObject & mem()
Definition: Store.h:52
void handleAdaptationCompleted()
Definition: Client.cc:832
@ ERR_NONE
Definition: err_type.h:13
void lock(const char *context)
Definition: store.cc:459
virtual void handleRequestBodyProducerAborted()=0
Definition: Client.cc:331
struct SquidConfig::@113 accessList
AccessLogEntryPointer al
info for the future access.log entry
Definition: FwdState.h:174
HttpReplyPointer reply
virtual void abortAll(const char *reason)=0
abnormal transaction termination; reason is for debugging only
void init(mb_size_t szInit, mb_size_t szMax)
Definition: MemBuf.cc:96
Definition: SBuf.h:86
void maybePurgeOthers()
Definition: Client.cc:496
void serverComplete2()
Definition: Client.cc:182
bool purgesOthers() const
BodyPipe::Pointer requestBodySource
Definition: Client.h:169
static void purgeEntriesByHeader(HttpRequest *req, const char *reqUrl, Http::Message *rep, Http::HdrType hdr)
Definition: Client.cc:456
int fd
FD which the call was about. Set by the async call creator.
Definition: CommCalls.h:90
C * getRaw() const
Definition: RefCount.h:80
virtual void noteBodyConsumerAborted(BodyPipe::Pointer)
Definition: Client.cc:662
virtual void append(const char *c, int sz)
Definition: MemBuf.cc:216
uint16_t flags
Definition: Store.h:224
virtual const Comm::ConnectionPointer & dataConnection() const =0
AccessLogEntry::Pointer al
info for the future access.log, and external ACL
void cleanAdaptation()
Definition: Client.cc:581
bool IsConnOpen(const Comm::ConnectionPointer &conn)
Definition: Connection.cc:26
void adjustBodyBytesRead(const int64_t delta)
initializes bodyBytesRead stats if needed and applies delta
Definition: Client.cc:974
bool isAccepting() const
Definition: store.cc:2029
Http::StatusLine sline
Definition: HttpReply.h:60
void HTTPMSGUNLOCK(M *&a)
Definition: Message.h:149
void detailError(err_type aType, int aDetail)
sets error detail if no earlier detail was available
Definition: HttpRequest.cc:468
void replaceHttpReply(const HttpReplyPointer &, const bool andStartWriting=true)
Definition: store.cc:1761
virtual void noteMoreBodySpaceAvailable(BodyPipe::Pointer)
Definition: Client.cc:648
void adaptOrFinalizeReply()
Definition: Client.cc:956
MemBuf * responseBodyBuffer
Definition: Client.h:161
void fail(ErrorState *err)
Definition: FwdState.cc:471
virtual void noteBodyProductionEnded(BodyPipe::Pointer)
Definition: Client.cc:264
BodyPipe::Pointer virginBodyDestination
Definition: Client.h:173
bool startRequestBodyFlow()
Definition: Client.cc:219
@ akForward
forward the supplied adapted HTTP message
Definition: Answer.h:27
void startWriting()
Definition: store.cc:1777
@ ERR_CLOSING
Definition: Flag.h:25
CbcPointer< Initiate > initiateAdaptation(Initiate *x)
< starts freshly created initiate and returns a safe pointer to it
Definition: Initiator.cc:23
virtual void haveParsedReplyHeaders()
called when we have final (possibly adapted) reply headers; kids extend
Definition: Client.cc:517
int64_t currentOffset
Definition: Client.h:160
bool setConsumerIfNotLate(const Consumer::Pointer &aConsumer)
Definition: BodyPipe.cc:228
#define DBG_IMPORTANT
Definition: Debug.h:46
int xerrno
The last errno to occur. non-zero if flag is Comm::COMM_ERROR.
Definition: CommCalls.h:88
static const size_type maxSize
Maximum size of a SBuf. By design it MUST be < MAX(size_type)/2. Currently 256Mb.
Definition: SBuf.h:95
AclDenyInfoList * denyInfoList
Definition: SquidConfig.h:412
virtual bool mayReadVirginReplyBody() const =0
whether we may receive more virgin response body bytes
size_t getMoreData(MemBuf &buf)
Definition: BodyPipe.cc:294
virtual void noteAdaptationAclCheckDone(Adaptation::ServiceGroupPointer group)
Definition: Client.cc:917
bool exhausted() const
Definition: BodyPipe.cc:174
void serverComplete()
Definition: Client.cc:160
virtual void completeForwarding()
Definition: Client.cc:210
Definition: Range.h:18
@ PROTO_URN
Definition: ProtocolType.h:37
void handleMoreAdaptedBodyAvailable()
Definition: Client.cc:744
@ ERR_DETAIL_ICAP_RESPMOD_EARLY
MemBuf & buf
Definition: BodyPipe.h:74
void handleAdaptedHeader(Http::Message *msg)
Definition: Client.cc:694
Http::MethodType id() const
Definition: RequestMethod.h:76
virtual bool expectingBody(const HttpRequestMethod &, int64_t &) const
Definition: HttpReply.cc:488
mb_size_t contentSize() const
available data size
Definition: MemBuf.h:47
int size
Definition: ModDevPoll.cc:77
#define NULL
Definition: types.h:166
virtual bool doneAll() const
whether positive goal has been reached
Definition: AsyncJob.cc:96
virtual void doneSendingRequestBody()=0
Definition: Client.cc:320
@ scForbidden
Definition: StatusCode.h:47
err_type aclGetDenyInfoPage(AclDenyInfoList **head, const char *name, int redirect_allowed)
Definition: Gadgets.cc:41
bool dontRetry()
Definition: FwdState.h:102
void resumeBodyStorage()
called by StoreEntry when it has more buffer space available
Definition: Client.cc:728
#define debugs(SECTION, LEVEL, CONTENT)
Definition: Debug.h:128
const HttpReply * virginReply() const
Definition: Client.cc:103
void stopConsumingFrom(RefCount< BodyPipe > &)
Definition: BodyPipe.cc:118
Http::StatusCode status() const
retrieve the status code for this status line
Definition: StatusLine.h:45
iterates services in ServiceGroup, starting adaptation launchers
Definition: Iterator.h:31
HttpReply * theFinalReply
Definition: Client.h:191
bool blockCaching()
whether to prevent caching of an otherwise cachable response
Definition: Client.cc:529
virtual void noteBodyProducerAborted(BodyPipe::Pointer)
Definition: Client.cc:278
@ ERR_DETAIL_RESPMOD_BLOCK_LATE
virtual void noteAdaptationAnswer(const Adaptation::Answer &answer)
Definition: Client.cc:674
virtual void processReplyBody()=0
const Acl::Answer & fastCheck()
Definition: Checklist.cc:336
void clearAdaptation(CbcPointer< Initiate > &x)
clears the pointer (does not call announceInitiatorAbort)
Definition: Initiator.cc:32
@ scBadGateway
Definition: StatusCode.h:73
Definition: MemBuf.h:23
@ CONTENT_LOCATION
#define EBIT_TEST(flag, bit)
Definition: defines.h:107
std::ostream & HERE(std::ostream &s)
Definition: Debug.h:157
@ ERR_DETAIL_RESPMOD_BLOCK_EARLY
Kind kind
the type of the answer
Definition: Answer.h:42
err_type
Definition: err_type.h:12
@ METHOD_CONNECT
Definition: MethodType.h:29
void const char HLPCB void * data
Definition: stub_helper.cc:16
void handleAdaptedBodyProducerAborted()
Definition: Client.cc:810
int unlock(const char *context)
Definition: store.cc:483
virtual ~Client()
Definition: Client.cc:48
Definition: Tree.h:20
int conn
the current server connection FD
Definition: Transport.cc:26
#define assert(EX)
Definition: assert.h:19
void sendMoreRequestBody()
Definition: Client.cc:392
static bool Start(Method method, VectPoint vp, HttpRequest *req, HttpReply *rep, AccessLogEntry::Pointer &al, Adaptation::Initiator *initiator)
Definition: AccessCheck.cc:30
FwdState::Pointer fwd
Definition: Client.h:165
HierarchyLogEntry hier
Definition: HttpRequest.h:157
void purgeEntriesByUrl(HttpRequest *req, const char *url)
bool handledEarlyAdaptationAbort()
Definition: Client.cc:867
HttpReply * setFinalReply(HttpReply *r)
Definition: Client.cc:137
void HTTPMSGLOCK(Http::Message *a)
Definition: Message.h:160
virtual HttpRequestPointer originalRequest()
a hack to reach HttpStateData::orignal_request
Definition: Client.cc:547
Comm::Flag flag
comm layer result status.
Definition: CommCalls.h:87
const AnyP::UriScheme & getScheme() const
Definition: Uri.h:67
bool adaptationAccessCheckPending
Definition: Client.h:177
void write(StoreIOBuffer)
Definition: store.cc:803
#define JobCallback(dbgSection, dbgLevel, Dialer, job, method)
Convenience macro to create a Dialer-based job callback.
Definition: AsyncJobCalls.h:69
@ scInternalServerError
Definition: StatusCode.h:71
HttpReply * setVirginReply(HttpReply *r)
Definition: Client.cc:117
const char * c_str()
Definition: SBuf.cc:526
void Write(const Comm::ConnectionPointer &conn, const char *buf, int size, AsyncCall::Pointer &callback, FREE *free_func)
Definition: Write.cc:35
bool receivedWholeRequestBody
handleRequestBodyProductionEnded called
Definition: Client.h:180
size_t bytesWanted(Range< size_t > const aRange, bool ignoreDelayPool=false) const
Definition: store.cc:249
void addRelativePath(const char *relUrl)
Definition: Uri.cc:720
HttpReply * finalReply()
Definition: Client.cc:130
int xerrno
Definition: errorpage.h:180
bool abortOnBadEntry(const char *abortReason)
Entry-dependent callbacks use this check to quit if the entry went bad.
Definition: Client.cc:238
void fd_bytes(int fd, int len, unsigned int type)
Definition: fd.cc:256
summarizes adaptation service answer for the noteAdaptationAnswer() API
Definition: Answer.h:22
struct StatCounters::@130 server
BodyPipe::Pointer adaptedBodySource
Definition: Client.h:175
virtual bool doneAll() const
whether positive goal has been reached
Definition: Client.cc:197
virtual bool doneWithAdaptation() const
Definition: Client.cc:598
void sendBodyIsTooLargeError()
Definition: Client.cc:945
int64_t bodyBytesRead
number of body bytes received from the next hop or -1
SBuf & absolute() const
Definition: Uri.cc:592
size_t calcBufferSpaceToReserve(const size_t space, const size_t wantSpace) const
determine how much space the buffer needs to reserve
Definition: Client.cc:1014
void startAdaptation(const Adaptation::ServiceGroupPointer &group, HttpRequest *cause)
Initiate an asynchronous adaptation transaction which will call us back.
Definition: Client.cc:555
@ pointPreCache
Definition: Elements.h:18
void handleAdaptationAborted(bool bypassable=false)
Definition: Client.cc:851
HttpRequestMethod method
Definition: HttpRequest.h:114
void path(const char *p)
Definition: Uri.h:99
Http::MessagePointer message
HTTP request or response to forward.
Definition: Answer.h:39
@ ENTRY_ABORTED
Definition: enums.h:115
const char * termedBuf() const
Definition: SquidString.h:91
@ methodRespmod
Definition: Elements.h:17
bool allowed() const
Definition: Acl.h:143
size_t putMoreData(const char *buf, size_t size)
Definition: BodyPipe.cc:213
void addVirginReplyBody(const char *buf, ssize_t len)
Definition: Client.cc:989
const char * status() const
Definition: BodyPipe.cc:445
const char * doneWithFwd
Definition: Client.h:184
void complete()
Definition: FwdState.cc:530
virtual void sentRequestBody(const CommIoCbParams &io)=0
Definition: Client.cc:344
mb_size_t potentialSpaceSize() const
Definition: MemBuf.cc:164
@ akError
no adapted message will come; see bypassable
Definition: Answer.h:29
const HttpHdrContRange * contentRange() const
Definition: HttpReply.cc:343
char * content()
start of the added data
Definition: MemBuf.h:41
mb_size_t spaceSize() const
Definition: MemBuf.cc:158
void expectNoConsumption()
there will be no more setConsumer() calls
Definition: BodyPipe.cc:267
@ ERR_TOO_BIG
Definition: err_type.h:38
void announceInitiatorAbort(CbcPointer< Initiate > &x)
inform the transaction about abnormal termination and clear the pointer
Definition: Initiator.cc:38
bool isEmpty() const
Definition: Store.h:67
@ ERR_ACCESS_DENIED
Definition: err_type.h:16
#define Must(condition)
Like assert() but throws an exception instead of aborting the process.
Definition: TextException.h:69
acl_access * storeMiss
Definition: SquidConfig.h:372
void handleRequestBodyProductionEnded()
Definition: Client.cc:309
void stopProducingFor(RefCount< BodyPipe > &, bool atEof)
Definition: BodyPipe.cc:107
AsyncCall * asyncCall(int aDebugSection, int aDebugLevel, const char *aName, const Dialer &aDialer)
Definition: AsyncCall.h:156
virtual void maybeReadVirginBody()=0
read response data from the network
int unsigned int const char *desc STUB void int len
Definition: stub_fd.cc:20
StoreEntry * entry
Definition: FwdState.h:172
bool urlIsRelative(const char *url)
Definition: Uri.cc:684
void release(const bool shareable=false)
Definition: store.cc:1175
virtual void closeServer()=0
virtual bool abortOnData(const char *reason)
Definition: Client.cc:291
const HttpReply & freshestReply() const
Definition: MemObject.h:67
@ ERR_WRITE_ERROR
Definition: err_type.h:27
@ RELEASE_REQUEST
prohibits making the key public
Definition: enums.h:98
void handleAdaptedBodyProductionEnded()
Definition: Client.cc:791
bool startedAdaptation
Definition: Client.h:178
void deferProducer(const AsyncCall::Pointer &producer)
call back producer when more buffer space is available
Definition: store.cc:378
@ akBlock
block or deny the master xaction; see authority
Definition: Answer.h:28
void lengthWentBad(const char *reason)
flags [truncated or too big] entry with ENTRY_BAD_LENGTH and releases it
Definition: store.cc:1049
void consume(mb_size_t sz)
removes sz bytes and "packs" by moving content left
Definition: MemBuf.cc:171
CbcPointer< Adaptation::Initiate > adaptedHeadSource
Definition: Client.h:174
size_t replyBodySpace(const MemBuf &readBuf, const size_t minSpace) const
Definition: Client.cc:1049
const SBuf & effectiveRequestUri() const
RFC 7230 section 5.5 - Effective Request URI.
Definition: HttpRequest.cc:705
void handleAdaptationBlocked(const Adaptation::Answer &answer)
Definition: Client.cc:887
HttpRequest * request
Definition: FwdState.h:173
String ruleId
ACL (or similar rule) name that blocked forwarding.
Definition: Answer.h:40
HttpRequestPointer request
Definition: Client.h:166
struct _request * request(char *urlin)
Definition: tcp-banger2.c:291
const A & min(A const &lhs, A const &rhs)
void const char * buf
Definition: stub_helper.cc:16
uint64_t consumedSize() const
Definition: BodyPipe.h:111
void handleUnregisteredServerEnd()
Definition: FwdState.cc:767
class SquidConfig Config
Definition: SquidConfig.cc:12
StatCounters statCounter
Definition: StatCounters.cc:12
virtual bool doneWithServer() const =0

 

Introduction

Documentation

Support

Miscellaneous

Web Site Translations

Mirrors