Disks.h
Go to the documentation of this file.
1/*
2 * Copyright (C) 1996-2022 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#ifndef SQUID_STORE_DISKS_H
10#define SQUID_STORE_DISKS_H
11
12#include "store/Controlled.h"
13#include "store/forward.h"
14
15namespace Store {
16
18class Disks: public Controlled
19{
20public:
21 Disks();
22
23 /* Storage API */
24 virtual void create() override;
25 virtual void init() override;
26 virtual StoreEntry *get(const cache_key *) override;
27 virtual uint64_t maxSize() const override;
28 virtual uint64_t minSize() const override;
29 virtual uint64_t currentSize() const override;
30 virtual uint64_t currentCount() const override;
31 virtual int64_t maxObjectSize() const override;
32 virtual void getStats(StoreInfoStats &stats) const override;
33 virtual void stat(StoreEntry &) const override;
34 virtual void sync() override;
35 virtual void reference(StoreEntry &) override;
36 virtual bool dereference(StoreEntry &e) override;
37 virtual void updateHeaders(StoreEntry *) override;
38 virtual void maintain() override;
39 virtual bool anchorToCache(StoreEntry &e, bool &inSync) override;
40 virtual bool updateAnchored(StoreEntry &) override;
41 virtual void evictCached(StoreEntry &) override;
42 virtual void evictIfFound(const cache_key *) override;
43 virtual int callback() override;
44
46 void configure();
48 static void Parse(DiskConfig &);
50 static void Dump(const DiskConfig &, StoreEntry &, const char *name);
51
54 int64_t accumulateMore(const StoreEntry&) const;
56 static bool SmpAware();
57 static SwapDir *SelectSwapDir(const StoreEntry *);
59 bool hasReadableEntry(const StoreEntry &) const;
60
61private:
62 /* migration logic */
63 SwapDir *store(int const x) const;
64 static SwapDir &Dir(int const idx);
65
69};
70
71} // namespace Store
72
73/* Store::Disks globals that should be converted to use RegisteredRunner */
74void storeDirOpenSwapLogs(void);
75int storeDirWriteCleanLogs(int reopen);
76void storeDirCloseSwapLogs(void);
77
78/* Globals that should be converted to static Store::Disks methods */
81
82/* Globals that should be moved to some Store::UFS-specific logging module */
83void storeDirSwapLog(const StoreEntry *e, int op);
84
85#endif /* SQUID_STORE_DISKS_H */
86
void storeDirCloseSwapLogs(void)
Definition: Disks.cc:680
void storeDirOpenSwapLogs(void)
Definition: Disks.cc:673
void free_cachedir(Store::DiskConfig *swap)
Definition: Disks.cc:802
void storeDirSwapLog(const StoreEntry *e, int op)
Definition: Disks.cc:835
void allocate_new_swapdir(Store::DiskConfig &swap)
Definition: Disks.cc:783
int storeDirWriteCleanLogs(int reopen)
Definition: Disks.cc:696
High-level store statistics used by mgr:info action. Used inside PODs!
Definition: StoreStats.h:14
manages a single cache_dir
Definition: Disk.h:22
summary view of all disk caches (cache_dirs) combined
Definition: Disks.h:19
virtual void reference(StoreEntry &) override
somebody needs this entry (many cache replacement policies need to know)
Definition: Disks.cc:545
virtual void create() override
create system resources needed for this store to operate in the future
Definition: Disks.cc:220
virtual int64_t maxObjectSize() const override
the maximum size of a storable object; -1 if unlimited
Definition: Disks.cc:374
int64_t secondLargestMaximumObjectSize
the second-biggest Disk::maxObjectSize()
Definition: Disks.h:68
virtual void evictCached(StoreEntry &) override
Definition: Disks.cc:586
static void Dump(const DiskConfig &, StoreEntry &, const char *name)
prints the configuration into the provided StoreEntry
Definition: Disks.cc:468
virtual uint64_t currentCount() const override
the total number of objects stored right now
Definition: Disks.cc:361
virtual bool dereference(StoreEntry &e) override
Definition: Disks.cc:551
bool hasReadableEntry(const StoreEntry &) const
whether any of disk caches has entry with e.key
Definition: Disks.cc:664
virtual void getStats(StoreInfoStats &stats) const override
collect statistics
Definition: Disks.cc:516
void configure()
update configuration, including limits (re)calculation
Definition: Disks.cc:380
SwapDir * store(int const x) const
Definition: Disks.cc:176
virtual uint64_t currentSize() const override
current size
Definition: Disks.cc:348
int64_t largestMaximumObjectSize
maximum of all Disk::maxObjectSize()s
Definition: Disks.h:67
virtual uint64_t minSize() const override
the minimum size the store will shrink to via normal housekeeping
Definition: Disks.cc:335
virtual void maintain() override
perform regular periodic maintenance; TODO: move to UFSSwapDir::Maintain
Definition: Disks.cc:564
virtual void evictIfFound(const cache_key *) override
Definition: Disks.cc:603
int64_t accumulateMore(const StoreEntry &) const
Definition: Disks.cc:479
virtual bool updateAnchored(StoreEntry &) override
Definition: Disks.cc:638
virtual void sync() override
prepare for shutdown
Definition: Disks.cc:579
virtual void updateHeaders(StoreEntry *) override
make stored metadata and HTTP headers the same as in the given entry
Definition: Disks.cc:557
virtual void stat(StoreEntry &) const override
Definition: Disks.cc:532
int64_t largestMinimumObjectSize
maximum of all Disk::minObjectSize()s
Definition: Disks.h:66
static SwapDir * SelectSwapDir(const StoreEntry *)
Definition: Disks.cc:658
virtual int callback() override
called once every main loop iteration; TODO: Move to UFS code.
Definition: Disks.cc:188
virtual StoreEntry * get(const cache_key *) override
Definition: Disks.cc:233
virtual void init() override
Definition: Disks.cc:259
virtual uint64_t maxSize() const override
Definition: Disks.cc:322
static SwapDir & Dir(int const idx)
Definition: Disks.cc:182
static void Parse(DiskConfig &)
parses a single cache_dir configuration line
Definition: Disks.cc:415
static bool SmpAware()
whether any disk cache is SMP-aware
Definition: Disks.cc:645
virtual bool anchorToCache(StoreEntry &e, bool &inSync) override
Definition: Disks.cc:612
class Ping::pingStats_ stats
unsigned char cache_key
Store key.
Definition: forward.h:29

 

Introduction

Documentation

Support

Miscellaneous

Web Site Translations

Mirrors