Alex Rousskov <rousskov@measurement-factory.com>

Client-side bandwidth limit (a.k.a., quota or delay pool) implementation.

Add forgoten ClientDelayConfig.h and ClientDelayConfig.cc files. These
files should be submitted with the  r10980 patch

diff --git a/src/ClientDelayConfig.cc b/src/ClientDelayConfig.cc
new file mode 100644 (file)
index 0000000..12366f2
--- /dev/null
+++ b/src/ClientDelayConfig.cc
@@ -0,0 +1,97 @@
+#include "config.h"
+#include "squid.h"
+#include "ConfigParser.h"
+#include "ClientDelayConfig.h"
+#include "Parsing.h"
+#include "Store.h"
+#include "acl/Acl.h"
+#include "acl/Gadgets.h"
+
+void ClientDelayPool::dump(StoreEntry * entry, unsigned int poolNumberMinusOne) const
+{
+    LOCAL_ARRAY(char, nom, 32);
+    snprintf(nom, 32, "client_delay_access %d", poolNumberMinusOne + 1);
+    dump_acl_access(entry, nom, access);
+    storeAppendPrintf(entry, "client_delay_parameters %d %d %"PRId64"\n", poolNumberMinusOne + 1, rate,highwatermark);
+    storeAppendPrintf(entry, "\n");
+}
+
+void
+ClientDelayConfig::finalize()
+{
+    for (unsigned int i = 0; i < pools.size(); ++i) {
+        /* pools require explicit 'allow' to assign a client into them */
+        if (!pools[i].access) {
+            debugs(77, DBG_IMPORTANT, "client_delay_pool #" << (i+1) <<
+               " has no client_delay_access configured. " <<
+               "No client will ever use it.");
+               }
+       }
+}
+
+void ClientDelayConfig::freePoolCount()
+{
+    pools.clean();
+}
+
+void ClientDelayConfig::dumpPoolCount(StoreEntry * entry, const char *name) const
+{
+    if (pools.size()) {
+        storeAppendPrintf(entry, "%s %d\n", name, (int)pools.size());
+        for (unsigned int i = 0; i < pools.size(); i++)
+            pools[i].dump(entry, i);
+    }
+}
+
+void ClientDelayConfig::parsePoolCount()
+{
+    if (pools.size()) {
+        debugs(3, 0, "parse_client_delay_pool_count: multiple client_delay_pools lines, aborting all previous client_delay_pools config");
+        clean();
+    }
+    u_short pools_;
+    ConfigParser::ParseUShort(&pools_);
+    for (int i = 0; i < pools_; i++)
+    {
+        pools.push_back(ClientDelayPool());
+    }
+}
+
+void ClientDelayConfig::parsePoolRates()
+{
+    ushort pool;
+    ConfigParser::ParseUShort(&pool);
+
+    if (pool < 1 || pool > pools.size()) {
+        debugs(3, 0, "parse_client_delay_pool_rates: Ignoring pool " << pool << " not in 1 .. " << pools.size());
+        return;
+    }
+
+    pool--;
+
+    pools[pool].rate = GetInteger();
+    pools[pool].highwatermark = GetInteger64();
+}
+
+void ClientDelayConfig::parsePoolAccess(ConfigParser &parser)
+{
+    ushort pool;
+
+    ConfigParser::ParseUShort(&pool);
+
+    if (pool < 1 || pool > pools.size()) {
+        debugs(3, 0, "parse_client_delay_pool_rates: Ignoring pool " << pool << " not in 1 .. " << pools.size());
+        return;
+    }
+
+    --pool;
+    aclParseAccessLine(parser, &pools[pool].access);
+}
+
+void ClientDelayConfig::clean()
+{
+    for (unsigned int i = 0; i < pools.size(); i++)
+    {
+        aclDestroyAccessList(&pools[i].access);
+    }
+}

diff --git a/src/ClientDelayConfig.h b/src/ClientDelayConfig.h
new file mode 100644 (file)
index 0000000..8694869
--- /dev/null
+++ b/src/ClientDelayConfig.h
@@ -0,0 +1,51 @@
+#ifndef SQUID_CLIENTDELAYCONFIG_H
+#define SQUID_CLIENTDELAYCONFIG_H
+
+#include "Array.h"
+class StoreEntry;
+class acl_access;
+class ConfigParser;
+
+/// \ingroup DelayPoolsAPI
+
+/* represents one client write limiting delay 'pool' */
+class ClientDelayPool
+{
+public:
+    ClientDelayPool()
+    :   access(NULL), rate(0), highwatermark(0)
+    {}
+    void dump (StoreEntry * entry, unsigned int poolNumberMinusOne) const;
+    acl_access *access;
+    int rate;
+    int64_t highwatermark;
+};
+
+typedef Vector<ClientDelayPool> ClientDelayPools;
+
+/* represents configuration of client write limiting delay pools */
+class ClientDelayConfig
+{
+public:
+    ClientDelayConfig()
+        :   initial(50)
+    {}
+    void freePoolCount();
+    void dumpPoolCount(StoreEntry * entry, const char *name) const;
+    /* parsing of client_delay_pools - number of pools */
+    void parsePoolCount();
+    /* parsing of client_delay_parameters lines */
+    void parsePoolRates();
+    /* parsing client_delay_access lines */
+    void parsePoolAccess(ConfigParser &parser);
+
+    void finalize(); ///< checks pools configuration
+
+    /* initial bucket level, how fill bucket at startup */
+    unsigned short initial;
+    ClientDelayPools pools;
+private:
+    void clean();
+};
+
+#endif // SQUID_CLIENTDELAYCONFIG_H