-
/*
- * $Id$
- *
- * DEBUG: section 20 Swap Dir base object
- * AUTHOR: Robert Collins
- *
- * SQUID Web Proxy Cache http://www.squid-cache.org/
- * ----------------------------------------------------------
- *
- * Squid is the result of efforts by numerous individuals from
- * the Internet community; see the CONTRIBUTORS file for full
- * details. Many organizations have provided support for Squid's
- * development; see the SPONSORS file for full details. Squid is
- * Copyrighted (C) 2001 by the Regents of the University of
- * California; see the COPYRIGHT file for full details. Squid
- * incorporates software developed and/or copyrighted by other
- * sources; see the CREDITS file for full details.
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
+ * Copyright (C) 1996-2015 The Squid Software Foundation and contributors
*
+ * Squid software is distributed under GPLv2+ license and includes
+ * contributions from numerous individuals and organizations.
+ * Please see the COPYING and CONTRIBUTORS files for details.
*/
+/* DEBUG: section 20 Swap Dir base object */
+
#include "squid.h"
-#include "SwapDir.h"
-#include "StoreFileSystem.h"
+#include "cache_cf.h"
+#include "compat/strtoll.h"
#include "ConfigOption.h"
+#include "ConfigParser.h"
+#include "globals.h"
+#include "Parsing.h"
+#include "SquidConfig.h"
+#include "StoreFileSystem.h"
+#include "SwapDir.h"
+#include "tools.h"
+
+SwapDir::SwapDir(char const *aType): theType(aType),
+ max_size(0), min_objsize(0), max_objsize (-1),
+ path(NULL), index(-1), disker(-1),
+ repl(NULL), removals(0), scanned(0),
+ cleanLog(NULL)
+{
+ fs.blksize = 1024;
+}
SwapDir::~SwapDir()
{
+ // TODO: should we delete repl?
xfree(path);
}
void
SwapDir::unlink(StoreEntry &) {}
+void
+SwapDir::getStats(StoreInfoStats &stats) const
+{
+ if (!doReportStat())
+ return;
+
+ stats.swap.size = currentSize();
+ stats.swap.capacity = maxSize();
+ stats.swap.count = currentCount();
+}
+
void
SwapDir::stat(StoreEntry &output) const
{
+ if (!doReportStat())
+ return;
+
storeAppendPrintf(&output, "Store Directory #%d (%s): %s\n", index, type(),
path);
storeAppendPrintf(&output, "FS Block Size %d Bytes\n",
void
SwapDir::maintain() {}
-size_t
+uint64_t
SwapDir::minSize() const
{
- return (size_t) (((float) maxSize() *
- (float) Config.Swap.lowWaterMark) / 100.0);
+ return ((maxSize() * Config.Swap.lowWaterMark) / 100);
+}
+
+int64_t
+SwapDir::maxObjectSize() const
+{
+ // per-store max-size=N value is authoritative
+ if (max_objsize > -1)
+ return max_objsize;
+
+ // store with no individual max limit is limited by configured maximum_object_size
+ // or the total store size, whichever is smaller
+ return min(static_cast<int64_t>(maxSize()), Config.Store.maxObjectSize);
}
void
-SwapDir::reference(StoreEntry &) {}
+SwapDir::maxObjectSize(int64_t newMax)
+{
+ // negative values mean no limit (-1)
+ if (newMax < 0) {
+ max_objsize = -1; // set explicitly in case it had a non-default value previously
+ return;
+ }
+
+ // prohibit values greater than total storage area size
+ // but set max_objsize to the maximum allowed to override maximum_object_size global config
+ if (static_cast<uint64_t>(newMax) > maxSize()) {
+ debugs(47, DBG_PARSE_NOTE(2), "WARNING: Ignoring 'max-size' option for " << path <<
+ " which is larger than total cache_dir size of " << maxSize() << " bytes.");
+ max_objsize = maxSize();
+ return;
+ }
+
+ max_objsize = newMax;
+}
void
-SwapDir::dereference(StoreEntry &) {}
+SwapDir::reference(StoreEntry &) {}
+
+bool
+SwapDir::dereference(StoreEntry &, bool)
+{
+ return true; // keep in global store_table
+}
int
SwapDir::callback()
return 0;
}
+bool
+SwapDir::canStore(const StoreEntry &e, int64_t diskSpaceNeeded, int &load) const
+{
+ debugs(47,8, HERE << "cache_dir[" << index << "]: needs " <<
+ diskSpaceNeeded << " <? " << max_objsize);
+
+ if (EBIT_TEST(e.flags, ENTRY_SPECIAL))
+ return false; // we do not store Squid-generated entries
+
+ if (!objectSizeIsAcceptable(diskSpaceNeeded))
+ return false; // does not satisfy size limits
+
+ if (flags.read_only)
+ return false; // cannot write at all
+
+ if (currentSize() > maxSize())
+ return false; // already overflowing
+
+ /* Return 999 (99.9%) constant load; TODO: add a named constant for this */
+ load = 999;
+ return true; // kids may provide more tests and should report true load
+}
+
void
SwapDir::sync() {}
SwapDir::writeCleanDone() {}
void
-SwapDir::logEntry(const StoreEntry & e, int op) const {}
+SwapDir::logEntry(const StoreEntry &, int) const {}
char const *
SwapDir::type() const
return theType;
}
+bool
+SwapDir::active() const
+{
+ if (IamWorkerProcess())
+ return true;
+
+ // we are inside a disker dedicated to this disk
+ if (KidIdentifier == disker)
+ return true;
+
+ return false; // Coordinator, wrong disker, etc.
+}
+
+bool
+SwapDir::needsDiskStrand() const
+{
+ return false;
+}
+
/* NOT performance critical. Really. Don't bother optimising for speed
* - RBC 20030718
*/
{
ConfigOptionVector *result = new ConfigOptionVector;
result->options.push_back(new ConfigOptionAdapter<SwapDir>(*const_cast<SwapDir *>(this), &SwapDir::optionReadOnlyParse, &SwapDir::optionReadOnlyDump));
- result->options.push_back(new ConfigOptionAdapter<SwapDir>(*const_cast<SwapDir *>(this), &SwapDir::optionMaxSizeParse, &SwapDir::optionMaxSizeDump));
+ result->options.push_back(new ConfigOptionAdapter<SwapDir>(*const_cast<SwapDir *>(this), &SwapDir::optionObjectSizeParse, &SwapDir::optionObjectSizeDump));
return result;
}
void
SwapDir::parseOptions(int isaReconfig)
{
- unsigned int old_read_only = flags.read_only;
+ const bool old_read_only = flags.read_only;
char *name, *value;
ConfigOption *newOption = getOptionTree();
- while ((name = strtok(NULL, w_space)) != NULL) {
+ while ((name = ConfigParser::NextToken()) != NULL) {
value = strchr(name, '=');
- if (value)
- *value++ = '\0'; /* cut on = */
+ if (value) {
+ *value = '\0'; /* cut on = */
+ ++value;
+ }
debugs(3,2, "SwapDir::parseOptions: parsing store option '" << name << "'='" << (value ? value : "") << "'");
if (isaReconfig) {
if (old_read_only != flags.read_only) {
- debugs(3, 1, "Cache dir '" << path << "' now " << (flags.read_only ? "No-Store" : "Read-Write"));
+ debugs(3, DBG_IMPORTANT, "Cache dir '" << path << "' now " << (flags.read_only ? "No-Store" : "Read-Write"));
}
}
}
}
bool
-SwapDir::optionReadOnlyParse(char const *option, const char *value, int isaReconfig)
+SwapDir::optionReadOnlyParse(char const *option, const char *value, int)
{
if (strcmp(option, "no-store") != 0 && strcmp(option, "read-only") != 0)
return false;
- int read_only = 0;
+ if (strcmp(option, "read-only") == 0) {
+ debugs(3, DBG_PARSE_NOTE(3), "UPGRADE WARNING: Replace cache_dir option 'read-only' with 'no-store'.");
+ }
+
+ bool read_only = 0;
if (value)
- read_only = xatoi(value);
+ read_only = (xatoi(value) != 0);
else
- read_only = 1;
+ read_only = true;
flags.read_only = read_only;
}
bool
-SwapDir::optionMaxSizeParse(char const *option, const char *value, int isaReconfig)
+SwapDir::optionObjectSizeParse(char const *option, const char *value, int isaReconfig)
{
- if (strcmp(option, "max-size") != 0)
+ int64_t *val;
+ if (strcmp(option, "max-size") == 0) {
+ val = &max_objsize;
+ } else if (strcmp(option, "min-size") == 0) {
+ val = &min_objsize;
+ } else
return false;
if (!value)
int64_t size = strtoll(value, NULL, 10);
- if (isaReconfig && max_objsize != size)
- debugs(3, 1, "Cache dir '" << path << "' max object size now " << size);
+ if (isaReconfig && *val != size) {
+ if (allowOptionReconfigure(option)) {
+ debugs(3, DBG_IMPORTANT, "cache_dir '" << path << "' object " <<
+ option << " now " << size << " Bytes");
+ } else {
+ debugs(3, DBG_IMPORTANT, "WARNING: cache_dir '" << path << "' "
+ "object " << option << " cannot be changed dynamically, " <<
+ "value left unchanged (" << *val << " Bytes)");
+ return true;
+ }
+ }
- max_objsize = size;
+ *val = size;
return true;
}
void
-SwapDir::optionMaxSizeDump(StoreEntry * e) const
+SwapDir::optionObjectSizeDump(StoreEntry * e) const
{
+ if (min_objsize != 0)
+ storeAppendPrintf(e, " min-size=%" PRId64, min_objsize);
+
if (max_objsize != -1)
- storeAppendPrintf(e, " max-size=%"PRId64, max_objsize);
+ storeAppendPrintf(e, " max-size=%" PRId64, max_objsize);
}
-/* Swapdirs do not have an index of their own - thus they ask their parent..
- * but the parent child relationship isn't implemented yet
- */
+// some SwapDirs may maintain their indexes and be able to lookup an entry key
StoreEntry *
-
-SwapDir::get
-(const cache_key *key)
+SwapDir::get(const cache_key *)
{
- return Store::Root().get(key);
+ return NULL;
}
void
-
-SwapDir::get
-(String const key, STOREGETCLIENT aCallback, void *aCallbackData)
+SwapDir::get(String const, STOREGETCLIENT, void *)
{
fatal("not implemented");
}
+