src/DelayId.cc

   1
   2 /*
   3  * $Id$
   4  *
   5  * DEBUG: section 77    Delay Pools
   6  * AUTHOR: Robert Collins <robertc@squid-cache.org>
   7  * Based upon original delay pools code by
   8  *   David Luyer <david@luyer.net>
   9  *
  10  * SQUID Web Proxy Cache          http://www.squid-cache.org/
  11  * ----------------------------------------------------------
  12  *
  13  *  Squid is the result of efforts by numerous individuals from
  14  *  the Internet community; see the CONTRIBUTORS file for full
  15  *  details.   Many organizations have provided support for Squid's
  16  *  development; see the SPONSORS file for full details.  Squid is
  17  *  Copyrighted (C) 2001 by the Regents of the University of
  18  *  California; see the COPYRIGHT file for full details.  Squid
  19  *  incorporates software developed and/or copyrighted by other
  20  *  sources; see the CREDITS file for full details.
  21  *
  22  *  This program is free software; you can redistribute it and/or modify
  23  *  it under the terms of the GNU General Public License as published by
  24  *  the Free Software Foundation; either version 2 of the License, or
  25  *  (at your option) any later version.
  26  *
  27  *  This program is distributed in the hope that it will be useful,
  28  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  29  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  30  *  GNU General Public License for more details.
  31  *
  32  *  You should have received a copy of the GNU General Public License
  33  *  along with this program; if not, write to the Free Software
  34  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
  35  *
  36  *
  37  * Copyright (c) 2003, Robert Collins <robertc@squid-cache.org>
  38  */
  39
  40 #include "config.h"
  41
  42 /* MS Visual Studio Projects are monolithic, so we need the following
  43  * #if to exclude the delay pools code from compile process when not needed.
  44  */
  45 #if DELAY_POOLS
  46
  47 #include "squid.h"
  48 #include "DelayId.h"
  49 #include "client_side_request.h"
  50 #include "ACLChecklist.h"
  51 #include "DelayPools.h"
  52 #include "DelayPool.h"
  53 #include "HttpRequest.h"
  54 #include "CommRead.h"
  55
  56 DelayId::DelayId () : pool_ (0), compositeId(NULL), markedAsNoDelay(false)
  57 {}
  58
  59 DelayId::DelayId (unsigned short aPool) :
  60         pool_ (aPool), compositeId (NULL), markedAsNoDelay (false)
  61 {
  62     debugs(77, 3, "DelayId::DelayId: Pool " << aPool << "u");
  63 }
  64
  65 DelayId::~DelayId ()
  66 {}
  67
  68 void
  69 DelayId::compositePosition(DelayIdComposite::Pointer newPosition)
  70 {
  71     compositeId = newPosition;
  72 }
  73
  74 unsigned short
  75 DelayId::pool() const
  76 {
  77     return pool_;
  78 }
  79
  80 bool
  81 DelayId::operator == (DelayId const &rhs) const
  82 {
  83     /* Doesn't compare composites properly....
  84      * only use to test against default ID's
  85      */
  86     return pool_ == rhs.pool_ && compositeId == rhs.compositeId;
  87 }
  88
  89 DelayId::operator bool() const
  90 {
  91     return pool_ || compositeId.getRaw();
  92 }
  93
  94 /* create a delay Id for a given request */
  95 DelayId
  96 DelayId::DelayClient(ClientHttpRequest * http)
  97 {
  98     HttpRequest *r;
  99     unsigned short pool;
 100     assert(http);
 101     r = http->request;
 102
 103     if (r->client_addr.IsNoAddr()) {
 104         debugs(77, 2, "delayClient: WARNING: Called with 'NO_ADDR' address, ignoring");
 105         return DelayId();
 106     }
 107
 108     for (pool = 0; pool < DelayPools::pools(); pool++) {
 109
 110         /* pools require explicit 'allow' to assign a client into them */
 111         if (!DelayPools::delay_data[pool].access) {
 112             debugs(77, DBG_IMPORTANT, "delay_pool " << pool <<
 113                    " has no delay_access configured. This means that no clients will ever use it.");
 114             continue;
 115         }
 116
 117         ACLChecklist ch;
 118 #if FOLLOW_X_FORWARDED_FOR
 119         if (Config.onoff.delay_pool_uses_indirect_client)
 120             ch.src_addr = r->indirect_client_addr;
 121         else
 122 #endif /* FOLLOW_X_FORWARDED_FOR */
 123             ch.src_addr = r->client_addr;
 124         ch.my_addr = r->my_addr;
 125
 126         if (http->getConn() != NULL)
 127             ch.conn(http->getConn());
 128
 129         ch.request = HTTPMSGLOCK(r);
 130
 131         ch.accessList = cbdataReference(DelayPools::delay_data[pool].access);
 132
 133         /* cbdataReferenceDone() happens in either fastCheck() or ~ACLCheckList */
 134
 135         if (DelayPools::delay_data[pool].theComposite().getRaw() && ch.fastCheck()) {
 136
 137             DelayId result (pool + 1);
 138             CompositePoolNode::CompositeSelectionDetails details;
 139             details.src_addr = ch.src_addr;
 140             details.user = r->auth_user_request;
 141             details.tag = r->tag;
 142             result.compositePosition(DelayPools::delay_data[pool].theComposite()->id(details));
 143             return result;
 144         }
 145     }
 146
 147     return DelayId();
 148 }
 149
 150 void
 151 DelayId::setNoDelay(bool const newValue)
 152 {
 153     markedAsNoDelay = newValue;
 154 }
 155
 156 /*
 157  * this returns the number of bytes the client is permitted. it does not take
 158  * into account bytes already buffered - that is up to the caller.
 159  */
 160 int
 161 DelayId::bytesWanted(int minimum, int maximum) const
 162 {
 163     /* unlimited */
 164
 165     if (! (*this) || markedAsNoDelay)
 166         return max(minimum, maximum);
 167
 168     /* limited */
 169     int nbytes = max(minimum, maximum);
 170
 171     if (compositeId != NULL)
 172         nbytes = compositeId->bytesWanted(minimum, nbytes);
 173
 174     return nbytes;
 175 }
 176
 177 /*
 178  * this records actual bytes received.  always recorded, even if the
 179  * class is disabled - it's more efficient to just do it than to do all
 180  * the checks.
 181  */
 182 void
 183 DelayId::bytesIn(int qty)
 184 {
 185     if (! (*this))
 186         return;
 187
 188     if (markedAsNoDelay)
 189         return;
 190
 191     assert ((unsigned short)(pool() - 1) != 0xFFFF);
 192
 193     if (compositeId != NULL)
 194         compositeId->bytesIn(qty);
 195 }
 196
 197 void
 198 DelayId::delayRead(DeferredRead const &aRead)
 199 {
 200     assert (compositeId != NULL);
 201     compositeId->delayRead(aRead);
 202
 203 }
 204
 205 #endif /* DELAY_POOLS */