Client.cc
Go to the documentation of this file.
1 /*
2  * Copyright (C) 1996-2019 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 *
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);
409  Comm::Write(conn, &buf, requestSender);
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
422  return requestBodySource->getMoreData(buf);
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 urlHostname() 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 char *hdrUrl, *absUrl;
459 
460  absUrl = NULL;
461  hdrUrl = rep->header.getStr(hdr);
462  if (hdrUrl == NULL) {
463  return;
464  }
465 
466  /*
467  * If the URL is relative, make it absolute so we can find it.
468  * If it's absolute, make sure the host parts match to avoid DOS attacks
469  * as per RFC 2616 13.10.
470  */
471  if (urlIsRelative(hdrUrl)) {
472  absUrl = urlMakeAbsolute(req, hdrUrl);
473  if (absUrl != NULL) {
474  hdrUrl = absUrl;
475  }
476  } else if (!sameUrlHosts(reqUrl, hdrUrl)) {
477  return;
478  }
479 
480  purgeEntriesByUrl(req, hdrUrl);
481 
482  if (absUrl != NULL) {
483  safe_free(absUrl);
484  }
485 }
486 
487 // some HTTP methods should purge matching cache entries
488 void
490 {
491  // only some HTTP methods should purge matching cache entries
492  if (!request->method.purgesOthers())
493  return;
494 
495  // and probably only if the response was successful
496  if (theFinalReply->sline.status() >= 400)
497  return;
498 
499  // XXX: should we use originalRequest() here?
501  const char *reqUrl = tmp.c_str();
502  debugs(88, 5, "maybe purging due to " << request->method << ' ' << tmp);
503  purgeEntriesByUrl(request.getRaw(), reqUrl);
506 }
507 
509 void
511 {
514 
515  // adaptation may overwrite old offset computed using the virgin response
516  const bool partial = theFinalReply->contentRange();
517  currentOffset = partial ? theFinalReply->contentRange()->spec.offset : 0;
518 }
519 
521 bool
523 {
524  if (const Acl::Tree *acl = Config.accessList.storeMiss) {
525  // This relatively expensive check is not in StoreEntry::checkCachable:
526  // That method lacks HttpRequest and may be called too many times.
527  ACLFilledChecklist ch(acl, originalRequest().getRaw());
528  ch.reply = const_cast<HttpReply*>(entry->getReply()); // ACLFilledChecklist API bug
529  HTTPMSGLOCK(ch.reply);
530  ch.al = fwd->al;
531  if (!ch.fastCheck().allowed()) { // when in doubt, block
532  debugs(20, 3, "store_miss prohibits caching");
533  return true;
534  }
535  }
536  return false;
537 }
538 
541 {
542  return request;
543 }
544 
545 #if USE_ADAPTATION
546 void
549 {
550  debugs(11, 5, "Client::startAdaptation() called");
551  // check whether we should be sending a body as well
552  // start body pipe to feed ICAP transaction if needed
554  HttpReply *vrep = virginReply();
555  assert(!vrep->body_pipe);
556  int64_t size = 0;
557  if (vrep->expectingBody(cause->method, size) && size) {
558  virginBodyDestination = new BodyPipe(this);
560  debugs(93, 6, HERE << "will send virgin reply body to " <<
561  virginBodyDestination << "; size: " << size);
562  if (size > 0)
564  }
565 
567  new Adaptation::Iterator(vrep, cause, fwd->al, group));
570 }
571 
572 // properly cleans up ICAP-related state
573 // may be called multiple times
575 {
576  debugs(11,5, HERE << "cleaning ICAP; ACL: " << adaptationAccessCheckPending);
577 
580 
582 
583  if (adaptedBodySource != NULL)
585 
586  if (!adaptationAccessCheckPending) // we cannot cancel a pending callback
587  assert(doneWithAdaptation()); // make sure the two methods are in sync
588 }
589 
590 bool
592 {
595 }
596 
597 // sends virgin reply body to ICAP, buffering excesses if needed
598 void
599 Client::adaptVirginReplyBody(const char *data, ssize_t len)
600 {
602 
603  if (!virginBodyDestination) {
604  debugs(11,3, HERE << "ICAP does not want more virgin body");
605  return;
606  }
607 
608  // grow overflow area if already overflowed
609  if (responseBodyBuffer) {
610  responseBodyBuffer->append(data, len);
611  data = responseBodyBuffer->content();
613  }
614 
615  const ssize_t putSize = virginBodyDestination->putMoreData(data, len);
616  data += putSize;
617  len -= putSize;
618 
619  // if we had overflow area, shrink it as necessary
620  if (responseBodyBuffer) {
621  if (putSize == responseBodyBuffer->contentSize()) {
622  delete responseBodyBuffer;
624  } else {
625  responseBodyBuffer->consume(putSize);
626  }
627  return;
628  }
629 
630  // if we did not have an overflow area, create it as needed
631  if (len > 0) {
634  responseBodyBuffer->init(4096, SQUID_TCP_SO_RCVBUF * 10);
635  responseBodyBuffer->append(data, len);
636  }
637 }
638 
639 // can supply more virgin response body data
640 void
642 {
643  if (responseBodyBuffer) {
644  addVirginReplyBody(NULL, 0); // kick the buffered fragment alive again
645  if (completed && !responseBodyBuffer) {
646  serverComplete2();
647  return;
648  }
649  }
651 }
652 
653 // the consumer of our virgin response body aborted
654 void
656 {
658 
659  // do not force closeServer here in case we need to bypass AdaptationQueryAbort
660 
661  if (doneWithAdaptation()) // we may still be receiving adapted response
663 }
664 
665 // received adapted response headers (body may follow)
666 void
668 {
669  clearAdaptation(adaptedHeadSource); // we do not expect more messages
670 
671  switch (answer.kind) {
673  handleAdaptedHeader(const_cast<Http::Message*>(answer.message.getRaw()));
674  break;
675 
677  handleAdaptationBlocked(answer);
678  break;
679 
682  break;
683  }
684 }
685 
686 void
688 {
689  if (abortOnBadEntry("entry went bad while waiting for adapted headers")) {
690  // If the adapted response has a body, the ICAP side needs to know
691  // that nobody will consume that body. We will be destroyed upon
692  // return. Tell the ICAP side that it is on its own.
693  HttpReply *rep = dynamic_cast<HttpReply*>(msg);
694  assert(rep);
695  if (rep->body_pipe != NULL)
697 
698  return;
699  }
700 
701  HttpReply *rep = dynamic_cast<HttpReply*>(msg);
702  assert(rep);
703  debugs(11,5, HERE << this << " setting adapted reply to " << rep);
704  setFinalReply(rep);
705 
707  if (rep->body_pipe != NULL) {
708  // subscribe to receive adapted body
710  // assume that ICAP does not auto-consume on failures
711  const bool result = adaptedBodySource->setConsumerIfNotLate(this);
712  assert(result);
713  } else {
714  // no body
715  if (doneWithAdaptation()) // we may still be sending virgin response
717  }
718 }
719 
720 void
722 {
723  if (abortOnBadEntry("store entry aborted while kick producer callback"))
724  return;
725 
726  if (!adaptedBodySource)
727  return;
728 
730 
733 }
734 
735 // more adapted response body is available
736 void
738 {
739  if (abortOnBadEntry("entry refuses adapted body"))
740  return;
741 
742  assert(entry);
743 
744  size_t contentSize = adaptedBodySource->buf().contentSize();
745 
746  if (!contentSize)
747  return; // XXX: bytesWanted asserts on zero-size ranges
748 
749  const size_t spaceAvailable = entry->bytesWanted(Range<size_t>(0, contentSize), true);
750 
751  if (spaceAvailable < contentSize ) {
752  // No or partial body data consuming
753  typedef NullaryMemFunT<Client> Dialer;
754  AsyncCall::Pointer call = asyncCall(93, 5, "Client::resumeBodyStorage",
755  Dialer(this, &Client::resumeBodyStorage));
756  entry->deferProducer(call);
757  }
758 
759  if (!spaceAvailable) {
760  debugs(11, 5, HERE << "NOT storing " << contentSize << " bytes of adapted " <<
761  "response body at offset " << adaptedBodySource->consumedSize());
762  return;
763  }
764 
765  if (spaceAvailable < contentSize ) {
766  debugs(11, 5, HERE << "postponing storage of " <<
767  (contentSize - spaceAvailable) << " body bytes");
768  contentSize = spaceAvailable;
769  }
770 
771  debugs(11,5, HERE << "storing " << contentSize << " bytes of adapted " <<
772  "response body at offset " << adaptedBodySource->consumedSize());
773 
775  const StoreIOBuffer ioBuf(&bpc.buf, currentOffset, contentSize);
776  currentOffset += ioBuf.length;
777  entry->write(ioBuf);
778  bpc.buf.consume(contentSize);
779  bpc.checkIn();
780 }
781 
782 // the entire adapted response body was produced, successfully
783 void
785 {
786  if (abortOnBadEntry("entry went bad while waiting for adapted body eof"))
787  return;
788 
789  // end consumption if we consumed everything
792  // else resumeBodyStorage() will eventually consume the rest
793 }
794 
795 void
797 {
800 }
801 
802 // premature end of the adapted response body
804 {
805  if (abortOnBadEntry("entry went bad while waiting for the now-aborted adapted body"))
806  return;
807 
808  Must(adaptedBodySource != nullptr);
809  if (!adaptedBodySource->exhausted()) {
810  debugs(11,5, "waiting to consume the remainder of the aborted adapted body");
811  return; // resumeBodyStorage() should eventually consume the rest
812  }
813 
815 
817  return;
818 
819  entry->lengthWentBad("body adaptation aborted");
820  handleAdaptationCompleted(); // the user should get a truncated response
821 }
822 
823 // common part of noteAdaptationAnswer and handleAdaptedBodyProductionEnded
824 void
826 {
827  debugs(11,5, HERE << "handleAdaptationCompleted");
828  cleanAdaptation();
829 
830  // We stop reading origin response because we have no place to put it(*) and
831  // cannot use it. If some origin servers do not like that or if we want to
832  // reuse more pconns, we can add code to discard unneeded origin responses.
833  // (*) TODO: Is it possible that the adaptation xaction is still running?
834  if (mayReadVirginReplyBody()) {
835  debugs(11,3, HERE << "closing origin conn due to ICAP completion");
836  closeServer();
837  }
838 
840 }
841 
842 // common part of noteAdaptation*Aborted and noteBodyConsumerAborted methods
843 void
845 {
846  debugs(11,5, HERE << "handleAdaptationAborted; bypassable: " << bypassable <<
847  ", entry empty: " << entry->isEmpty());
848 
849  if (abortOnBadEntry("entry went bad while ICAP aborted"))
850  return;
851 
852  // TODO: bypass if possible
854  abortAll("adaptation failure with a filled entry");
855 }
856 
859 bool
861 {
862  if (entry->isEmpty()) {
863  debugs(11,8, "adaptation failure with an empty entry: " << *entry);
866  fwd->fail(err);
867  fwd->dontRetry(true);
868  abortAll("adaptation failure with an empty entry");
869  return true; // handled
870  }
871 
872  if (request) // update logged info directly
874 
875  return false; // the caller must handle
876 }
877 
878 // adaptation service wants us to deny HTTP client access to this response
879 void
881 {
882  debugs(11,5, HERE << answer.ruleId);
883 
884  if (abortOnBadEntry("entry went bad while ICAP aborted"))
885  return;
886 
887  if (!entry->isEmpty()) { // too late to block (should not really happen)
888  if (request)
890  abortAll("late adaptation block");
891  return;
892  }
893 
894  debugs(11,7, HERE << "creating adaptation block response");
895 
896  err_type page_id =
898  if (page_id == ERR_NONE)
899  page_id = ERR_ACCESS_DENIED;
900 
901  const auto err = new ErrorState(page_id, Http::scForbidden, request.getRaw(), fwd->al);
903  fwd->fail(err);
904  fwd->dontRetry(true);
905 
906  abortOnData("timely adaptation block");
907 }
908 
909 void
911 {
913 
914  if (abortOnBadEntry("entry went bad while waiting for ICAP ACL check"))
915  return;
916 
917  // TODO: Should non-ICAP and ICAP REPMOD pre-cache paths check this?
918  // That check now only happens on REQMOD pre-cache and REPMOD post-cache, in processReplyAccess().
919  if (virginReply()->expectedBodyTooLarge(*request)) {
921  return;
922  }
923  // TODO: Should we check receivedBodyTooLarge as well?
924 
925  if (!group) {
926  debugs(11,3, HERE << "no adapation needed");
929  return;
930  }
931 
932  startAdaptation(group, originalRequest().getRaw());
934 }
935 #endif
936 
937 void
939 {
940  const auto err = new ErrorState(ERR_TOO_BIG, Http::scForbidden, request.getRaw(), fwd->al);
941  fwd->fail(err);
942  fwd->dontRetry(true);
943  abortOnData("Virgin body too large.");
944 }
945 
946 // TODO: when HttpStateData sends all errors to ICAP,
947 // we should be able to move this at the end of setVirginReply().
948 void
950 {
951 #if USE_ADAPTATION
952  // TODO: merge with client side and return void to hide the on/off logic?
953  // The callback can be called with a NULL service if adaptation is off.
956  originalRequest().getRaw(), virginReply(), fwd->al, this);
957  debugs(11,5, HERE << "adaptationAccessCheckPending=" << adaptationAccessCheckPending);
959  return;
960 #endif
961 
963 }
964 
966 void
967 Client::adjustBodyBytesRead(const int64_t delta)
968 {
969  int64_t &bodyBytesRead = originalRequest()->hier.bodyBytesRead;
970 
971  // if we got here, do not log a dash even if we got nothing from the server
972  if (bodyBytesRead < 0)
973  bodyBytesRead = 0;
974 
975  bodyBytesRead += delta; // supports negative and zero deltas
976 
977  // check for overflows ("infinite" response?) and undeflows (a bug)
978  Must(bodyBytesRead >= 0);
979 }
980 
981 void
982 Client::addVirginReplyBody(const char *data, ssize_t len)
983 {
984  adjustBodyBytesRead(len);
985 
986 #if USE_ADAPTATION
987  assert(!adaptationAccessCheckPending); // or would need to buffer while waiting
988  if (startedAdaptation) {
989  adaptVirginReplyBody(data, len);
990  return;
991  }
992 #endif
993  storeReplyBody(data, len);
994 }
995 
996 // writes virgin or adapted reply body to store
997 void
998 Client::storeReplyBody(const char *data, ssize_t len)
999 {
1000  // write even if len is zero to push headers towards the client side
1001  entry->write (StoreIOBuffer(len, currentOffset, (char*)data));
1002 
1003  currentOffset += len;
1004 }
1005 
1006 size_t
1007 Client::calcBufferSpaceToReserve(size_t space, const size_t wantSpace) const
1008 {
1009  if (space < wantSpace) {
1010  const size_t maxSpace = SBuf::maxSize; // absolute best
1011  space = min(wantSpace, maxSpace); // do not promise more than asked
1012  }
1013 
1014 #if USE_ADAPTATION
1015  if (responseBodyBuffer) {
1016  return 0; // Stop reading if already overflowed waiting for ICAP to catch up
1017  }
1018 
1019  if (virginBodyDestination != NULL) {
1020  /*
1021  * BodyPipe buffer has a finite size limit. We
1022  * should not read more data from the network than will fit
1023  * into the pipe buffer or we _lose_ what did not fit if
1024  * the response ends sooner that BodyPipe frees up space:
1025  * There is no code to keep pumping data into the pipe once
1026  * response ends and serverComplete() is called.
1027  */
1028  const size_t adaptor_space = virginBodyDestination->buf().potentialSpaceSize();
1029 
1030  debugs(11,9, "Client may read up to min(" <<
1031  adaptor_space << ", " << space << ") bytes");
1032 
1033  if (adaptor_space < space)
1034  space = adaptor_space;
1035  }
1036 #endif
1037 
1038  return space;
1039 }
1040 
1041 size_t
1042 Client::replyBodySpace(const MemBuf &readBuf, const size_t minSpace) const
1043 {
1044  size_t space = readBuf.spaceSize(); // available space w/o heroic measures
1045  if (space < minSpace) {
1046  const size_t maxSpace = readBuf.potentialSpaceSize(); // absolute best
1047  space = min(minSpace, maxSpace); // do not promise more than asked
1048  }
1049 
1050 #if USE_ADAPTATION
1051  if (responseBodyBuffer) {
1052  return 0; // Stop reading if already overflowed waiting for ICAP to catch up
1053  }
1054 
1055  if (virginBodyDestination != NULL) {
1056  /*
1057  * BodyPipe buffer has a finite size limit. We
1058  * should not read more data from the network than will fit
1059  * into the pipe buffer or we _lose_ what did not fit if
1060  * the response ends sooner that BodyPipe frees up space:
1061  * There is no code to keep pumping data into the pipe once
1062  * response ends and serverComplete() is called.
1063  *
1064  * If the pipe is totally full, don't register the read handler.
1065  * The BodyPipe will call our noteMoreBodySpaceAvailable() method
1066  * when it has free space again.
1067  */
1068  size_t adaptation_space =
1070 
1071  debugs(11,9, "Client may read up to min(" <<
1072  adaptation_space << ", " << space << ") bytes");
1073 
1074  if (adaptation_space < space)
1075  space = adaptation_space;
1076  }
1077 #endif
1078 
1079  return space;
1080 }
1081 
iterates services in ServiceGroup, starting adaptation launchers
Definition: Iterator.h:31
HierarchyLogEntry hier
Definition: HttpRequest.h:157
summarizes adaptation service answer for the noteAdaptationAnswer() API
Definition: Answer.h:22
#define JobCallback(dbgSection, dbgLevel, Dialer, job, method)
Convenience macro to create a Dialer-based job callback.
Definition: AsyncJobCalls.h:69
const char * status() const
Definition: BodyPipe.cc:445
const MemBuf & buf() const
Definition: BodyPipe.h:137
struct StatCounters::@130::@139 all
CbcPointer< Initiate > initiateAdaptation(Initiate *x)
< starts freshly created initiate and returns a safe pointer to it
Definition: Initiator.cc:23
StatCounters statCounter
Definition: StatCounters.cc:12
#define assert(EX)
Definition: assert.h:17
bool startedAdaptation
Definition: Client.h:178
Definition: Tree.h:20
void purgeEntriesByUrl(HttpRequest *req, const char *url)
MemBuf * responseBodyBuffer
Definition: Client.h:161
String ruleId
ACL (or similar rule) name that blocked forwarding.
Definition: Answer.h:40
void handleRequestBodyProductionEnded()
Definition: Client.cc:309
virtual const Comm::ConnectionPointer & dataConnection() const =0
void handleAdaptationBlocked(const Adaptation::Answer &answer)
Definition: Client.cc:880
char * urlMakeAbsolute(const HttpRequest *req, const char *relUrl)
Definition: Uri.cc:655
virtual void append(const char *c, int sz)
Definition: MemBuf.cc:216
void release(const bool shareable=false)
Definition: store.cc:1195
int unlock(const char *context)
Definition: store.cc:463
bool startRequestBodyFlow()
Definition: Client.cc:219
virtual bool abortOnData(const char *reason)
Definition: Client.cc:291
void adaptOrFinalizeReply()
Definition: Client.cc:949
bool urlIsRelative(const char *url)
Definition: Uri.cc:622
Definition: SBuf.h:86
virtual bool getMoreRequestBody(MemBuf &buf)
either fill buf with available [encoded] request body bytes or return false
Definition: Client.cc:418
virtual void noteMoreBodySpaceAvailable(BodyPipe::Pointer)
Definition: Client.cc:641
void consume(mb_size_t sz)
removes sz bytes and "packs" by moving content left
Definition: MemBuf.cc:171
struct StatCounters::@130 server
void handleMoreRequestBodyAvailable()
Definition: Client.cc:299
HttpRequestMethod method
Definition: HttpRequest.h:114
void serverComplete()
Definition: Client.cc:160
void handleMoreAdaptedBodyAvailable()
Definition: Client.cc:737
struct _request * request(char *urlin)
Definition: tcp-banger2.c:291
Http::MessagePointer message
HTTP request or response to forward.
Definition: Answer.h:39
StoreEntry * entry
Definition: Client.h:164
void storeReplyBody(const char *buf, ssize_t len)
Definition: Client.cc:998
void announceInitiatorAbort(CbcPointer< Initiate > &x)
inform the transaction about abnormal termination and clear the pointer
Definition: Initiator.cc:38
#define safe_free(x)
Definition: xalloc.h:73
bool initiated(const CbcPointer< AsyncJob > &job) const
Must(initiated(initiate)) instead of Must(initiate.set()), for clarity.
Definition: Initiator.h:52
virtual void noteAdaptationAclCheckDone(Adaptation::ServiceGroupPointer group)
Definition: Client.cc:910
AccessLogEntry::Pointer al
info for the future access.log, and external ACL
Definition: Range.h:18
void HTTPMSGLOCK(Http::Message *a)
Definition: Message.h:160
void handleAdaptedHeader(Http::Message *msg)
Definition: Client.cc:687
HttpRequest * request
Definition: FwdState.h:165
#define Must(condition)
Like assert() but throws an exception instead of aborting the process.
Definition: TextException.h:69
HttpReply const * getReply() const
Definition: store.cc:1676
const HttpHdrContRange * contentRange() const
Definition: HttpReply.cc:339
virtual bool doneWithServer() const =0
Definition: enums.h:24
bool purgesOthers() const
bool isAccepting() const
Definition: store.cc:2063
virtual void noteAdaptationAnswer(const Adaptation::Answer &answer)
Definition: Client.cc:667
int conn
the current server connection FD
Definition: Transport.cc:26
void setBodySize(uint64_t aSize)
Definition: BodyPipe.cc:147
virtual void processReplyBody()=0
void expectNoConsumption()
there will be no more setConsumer() calls
Definition: BodyPipe.cc:267
virtual ~Client()
Definition: Client.cc:48
uint64_t consumedSize() const
Definition: BodyPipe.h:111
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
HttpReply * theVirginReply
Definition: Client.h:190
Acl::Answer const & fastCheck()
Definition: Checklist.cc:336
size_t putMoreData(const char *buf, size_t size)
Definition: BodyPipe.cc:213
void replaceHttpReply(HttpReply *, bool andStartWriting=true)
Definition: store.cc:1788
no adapted message will come; see bypassable
Definition: Answer.h:29
void resumeBodyStorage()
called by StoreEntry when it has more buffer space available
Definition: Client.cc:721
void maybePurgeOthers()
Definition: Client.cc:489
AsyncCall * asyncCall(int aDebugSection, int aDebugLevel, const char *aName, const Dialer &aDialer)
Definition: AsyncCall.h:156
int64_t bodyBytesRead
number of body bytes received from the next hop or -1
virtual void noteBodyProducerAborted(BodyPipe::Pointer)
Definition: Client.cc:278
void init(mb_size_t szInit, mb_size_t szMax)
Definition: MemBuf.cc:96
void fd_bytes(int fd, int len, unsigned int type)
Definition: fd.cc:256
void sendMoreRequestBody()
Definition: Client.cc:392
const SBuf & effectiveRequestUri() const
RFC 7230 section 5.5 - Effective Request URI.
Definition: HttpRequest.cc:705
const char * xstrerr(int error)
Definition: xstrerror.cc:83
bool IsConnOpen(const Comm::ConnectionPointer &conn)
Definition: Connection.cc:24
AsyncCall::Pointer requestSender
Definition: Client.h:170
mb_size_t potentialSpaceSize() const
Definition: MemBuf.cc:164
void sendBodyIsTooLargeError()
Definition: Client.cc:938
void const char HLPCB void * data
Definition: stub_helper.cc:16
int fd
FD which the call was about. Set by the async call creator.
Definition: CommCalls.h:90
Client(FwdState *)
Definition: Client.cc:39
void handleAdaptedBodyProducerAborted()
Definition: Client.cc:803
virtual void noteBodyProductionEnded(BodyPipe::Pointer)
Definition: Client.cc:264
virtual bool doneWithAdaptation() const
Definition: Client.cc:591
virtual void abortAll(const char *reason)=0
abnormal transaction termination; reason is for debugging only
#define debugs(SECTION, LEVEL, CONTENT)
Definition: Debug.h:124
BodyPipe::Pointer virginBodyDestination
Definition: Client.h:173
#define DBG_IMPORTANT
Definition: Debug.h:46
virtual void noteBodyConsumerAborted(BodyPipe::Pointer)
Definition: Client.cc:655
virtual void haveParsedReplyHeaders()
called when we have final (possibly adapted) reply headers; kids extend
Definition: Client.cc:510
FwdState::Pointer fwd
Definition: Client.h:165
virtual void swanSong()
Definition: AsyncJob.h:54
bool allowed() const
Definition: Acl.h:143
void complete()
Definition: FwdState.cc:512
acl_access * storeMiss
Definition: SquidConfig.h:367
void serverComplete2()
Definition: Client.cc:182
mb_size_t contentSize() const
available data size
Definition: MemBuf.h:47
virtual void handleRequestBodyProducerAborted()=0
Definition: Client.cc:331
virtual bool expectingBody(const HttpRequestMethod &, int64_t &) const
Definition: HttpReply.cc:484
bool handledEarlyAdaptationAbort()
Definition: Client.cc:860
void startAdaptation(const Adaptation::ServiceGroupPointer &group, HttpRequest *cause)
Initiate an asynchronous adaptation transaction which will call us back.
Definition: Client.cc:548
virtual void sentRequestBody(const CommIoCbParams &io)=0
Definition: Client.cc:344
int xerrno
The last errno to occur. non-zero if flag is Comm::COMM_ERROR.
Definition: CommCalls.h:88
BodyPipe::Pointer requestBodySource
Definition: Client.h:169
virtual HttpRequestPointer originalRequest()
a hack to reach HttpStateData::orignal_request
Definition: Client.cc:540
size_t calcBufferSpaceToReserve(const size_t space, const size_t wantSpace) const
determine how much space the buffer needs to reserve
Definition: Client.cc:1007
void handleUnregisteredServerEnd()
Definition: FwdState.cc:748
bool isEmpty() const
Definition: Store.h:60
common parts of HttpRequest and HttpReply
Definition: Message.h:25
struct SquidConfig::@113 accessList
void adjustBodyBytesRead(const int64_t delta)
initializes bodyBytesRead stats if needed and applies delta
Definition: Client.cc:967
bool setConsumerIfNotLate(const Consumer::Pointer &aConsumer)
Definition: BodyPipe.cc:228
const char * c_str()
Definition: SBuf.cc:526
void cleanAdaptation()
Definition: Client.cc:574
uint16_t flags
Definition: Store.h:210
Http::StatusLine sline
Definition: HttpReply.h:60
virtual bool mayReadVirginReplyBody() const =0
whether we may receive more virgin response body bytes
virtual void completeForwarding()
Definition: Client.cc:210
bool blockCaching()
whether to prevent caching of an otherwise cachable response
Definition: Client.cc:522
virtual void closeServer()=0
virtual void maybeReadVirginBody()=0
read response data from the network
int64_t currentOffset
Definition: Client.h:160
void handleAdaptedBodyProductionEnded()
Definition: Client.cc:784
char const * termedBuf() const
Definition: SquidString.h:91
void addVirginReplyBody(const char *buf, ssize_t len)
Definition: Client.cc:982
int unsigned int const char *desc STUB void int len
Definition: stub_fd.cc:20
char * content()
start of the added data
Definition: MemBuf.h:41
const char * getStr(Http::HdrType id) const
Definition: HttpHeader.cc:1175
void const char * buf
Definition: stub_helper.cc:16
std::ostream & HERE(std::ostream &s)
Definition: Debug.h:153
void lengthWentBad(const char *reason)
flags [truncated or too big] entry with ENTRY_BAD_LENGTH and releases it
Definition: store.cc:1056
size_t getMoreData(MemBuf &buf)
Definition: BodyPipe.cc:294
HttpHeader header
Definition: Message.h:75
virtual void doneSendingRequestBody()=0
Definition: Client.cc:320
void stopPeerClock(const bool force)
Definition: access_log.cc:303
bool final
whether the error, if any, cannot be bypassed
Definition: Answer.h:41
AclDenyInfoList * denyInfoList
Definition: SquidConfig.h:407
HttpReplyPointer reply
AccessLogEntryPointer al
info for the future access.log entry
Definition: FwdState.h:166
prohibits making the key public
Definition: enums.h:94
mb_size_t spaceSize() const
Definition: MemBuf.cc:158
HttpRequestPointer request
Definition: Client.h:166
void write(StoreIOBuffer)
Definition: store.cc:803
void stopProducingFor(RefCount< BodyPipe > &, bool atEof)
Definition: BodyPipe.cc:107
static bool sameUrlHosts(const char *url1, const char *url2)
Definition: Client.cc:427
HttpReply * theFinalReply
Definition: Client.h:191
const HttpReply * virginReply() const
Definition: Client.cc:110
HttpHdrRangeSpec spec
virtual bool doneAll() const
whether positive goal has been reached
Definition: AsyncJob.cc:96
bool dontRetry()
Definition: FwdState.h:101
void HTTPMSGUNLOCK(M *&a)
Definition: Message.h:149
Kind kind
the type of the answer
Definition: Answer.h:42
void detailError(err_type aType, int aDetail)
sets error detail if no earlier detail was available
Definition: HttpRequest.cc:468
forward the supplied adapted HTTP message
Definition: Answer.h:27
HttpReply * setVirginReply(HttpReply *r)
Definition: Client.cc:117
Comm::Flag flag
comm layer result status.
Definition: CommCalls.h:87
HttpReply * setFinalReply(HttpReply *r)
Definition: Client.cc:137
block or deny the master xaction; see authority
Definition: Answer.h:28
C * getRaw() const
Definition: RefCount.h:74
static bool Start(Method method, VectPoint vp, HttpRequest *req, HttpReply *rep, AccessLogEntry::Pointer &al, Adaptation::Initiator *initiator)
Definition: AccessCheck.cc:30
bool receivedWholeRequestBody
handleRequestBodyProductionEnded called
Definition: Client.h:180
Definition: MemBuf.h:23
void stopConsumingFrom(RefCount< BodyPipe > &)
Definition: BodyPipe.cc:118
void adaptVirginReplyBody(const char *buf, ssize_t len)
Definition: Client.cc:599
BodyPipe::Pointer adaptedBodySource
Definition: Client.h:175
CbcPointer< Adaptation::Initiate > adaptedHeadSource
Definition: Client.h:174
void fail(ErrorState *err)
Definition: FwdState.cc:457
BodyPipe::Pointer body_pipe
optional pipeline to receive message body
Definition: Message.h:98
Http::StatusCode status() const
retrieve the status code for this status line
Definition: StatusLine.h:45
bool adaptationAccessCheckPending
Definition: Client.h:177
size_t replyBodySpace(const MemBuf &readBuf, const size_t minSpace) const
Definition: Client.cc:1042
void detailError(int dCode)
set error type-specific detail code
Definition: errorpage.h:112
void deferProducer(const AsyncCall::Pointer &producer)
call back producer when more buffer space is available
Definition: store.cc:358
int xerrno
Definition: errorpage.h:180
virtual void swanSong()
Definition: Client.cc:69
void startWriting()
Definition: store.cc:1804
bool exhausted() const
Definition: BodyPipe.cc:174
void handleAdaptationCompleted()
Definition: Client.cc:825
virtual void noteMoreBodyDataAvailable(BodyPipe::Pointer)
Definition: Client.cc:250
bool abortOnBadEntry(const char *abortReason)
Entry-dependent callbacks use this check to quit if the entry went bad.
Definition: Client.cc:238
HttpReply * finalReply()
Definition: Client.cc:130
static void purgeEntriesByHeader(HttpRequest *req, const char *reqUrl, Http::Message *rep, Http::HdrType hdr)
Definition: Client.cc:456
StoreEntry * entry
Definition: FwdState.h:164
#define EBIT_TEST(flag, bit)
Definition: defines.h:107
void endAdaptedBodyConsumption()
called when the entire adapted response body is consumed
Definition: Client.cc:796
const char * doneWithFwd
Definition: Client.h:184
class SquidConfig Config
Definition: SquidConfig.cc:12
#define NULL
Definition: types.h:166
void handleAdaptationAborted(bool bypassable=false)
Definition: Client.cc:844
int size
Definition: ModDevPoll.cc:77
bool completed
Definition: Client.h:86
A const & min(A const &lhs, A const &rhs)
size_t bytesWanted(Range< size_t > const aRange, bool ignoreDelayPool=false) const
Definition: store.cc:229
void Write(const Comm::ConnectionPointer &conn, const char *buf, int size, AsyncCall::Pointer &callback, FREE *free_func)
Definition: Write.cc:35
err_type
Definition: err_type.h:12
err_type aclGetDenyInfoPage(AclDenyInfoList **head, const char *name, int redirect_allowed)
Definition: Gadgets.cc:41
virtual bool doneAll() const
whether positive goal has been reached
Definition: Client.cc:197
void clearAdaptation(CbcPointer< Initiate > &x)
clears the pointer (does not call announceInitiatorAbort)
Definition: Initiator.cc:32
void lock(const char *context)
Definition: store.cc:439

 

Introduction

Documentation

Support

Miscellaneous

Web Site Translations

Mirrors