Controller.h

Go to the documentation of this file.

/*
 * Copyright (C) 1996-2023 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.
 */
 
#ifndef SQUID_STORE_CONTROLLER_H
#define SQUID_STORE_CONTROLLER_H
 
#include "store/Storage.h"
 
class MemObject;
class RequestFlags;
class HttpRequestMethod;
 
namespace Store {
 
class Controller: public Storage
{
public:
    Controller();
    ~Controller() override;
 
    /* Storage API */
    void create() override;
    void init() override;
    uint64_t maxSize() const override;
    uint64_t minSize() const override;
    uint64_t currentSize() const override;
    uint64_t currentCount() const override;
    int64_t maxObjectSize() const override;
    void getStats(StoreInfoStats &stats) const override;
    void stat(StoreEntry &) const override;
    void sync() override;
    void maintain() override;
    void evictCached(StoreEntry &) override;
    void evictIfFound(const cache_key *) override;
    int callback() override;
 
    StoreEntry *find(const cache_key *);
 
    StoreEntry *peek(const cache_key *);
 
    StoreEntry *findCallbackXXX(const cache_key *);
 
    bool markedForDeletion(const cache_key *key) const;
 
    bool markedForDeletionAndAbandoned(const StoreEntry &) const;
 
    bool hasReadableDiskEntry(const StoreEntry &) const;
 
    int64_t accumulateMore(StoreEntry &) const;
 
    void configure();
 
    void handleIdleEntry(StoreEntry &);
 
    void freeMemorySpace(const int spaceRequired);
 
    void memoryOut(StoreEntry &, const bool preserveSwappable);
 
    bool updateOnNotModified(StoreEntry *old, StoreEntry &e304);
 
    bool allowCollapsing(StoreEntry *, const RequestFlags &, const HttpRequestMethod &);
 
    void addReading(StoreEntry *, const cache_key *);
 
    void addWriting(StoreEntry *, const cache_key *);
 
    bool transientsReader(const StoreEntry &) const;
 
    bool transientsWriter(const StoreEntry &) const;
 
    void syncCollapsed(const sfileno);
 
    void noteStoppedSharedWriting(StoreEntry &);
 
    int transientReaders(const StoreEntry &) const;
 
    void transientsDisconnect(StoreEntry &);
 
    void memoryDisconnect(StoreEntry &);
 
    StoreSearch *search();
 
    static bool SmpAware();
 
    static int store_dirs_rebuilding;
 
private:
    bool memoryCacheHasSpaceFor(const int pagesRequired) const;
 
    void referenceBusy(StoreEntry &e);
    bool dereferenceIdle(StoreEntry &, bool wantsLocalMemory);
 
    void allowSharing(StoreEntry &, const cache_key *);
    StoreEntry *peekAtLocal(const cache_key *);
 
    void memoryEvictCached(StoreEntry &);
    void transientsUnlinkByKeyIfFound(const cache_key *);
    bool keepForLocalMemoryCache(StoreEntry &e) const;
    bool anchorToCache(StoreEntry &);
    void checkTransients(const StoreEntry &) const;
    void checkFoundCandidate(const StoreEntry &) const;
 
    Disks *swapDir; 
    Memory *sharedMemStore; 
    bool localMemStore; 
 
    Transients *transients;
 
    int memoryPagesDebt_ = 0;
};
 
extern Controller &Root();
 
extern void Init(Controller *root = nullptr);
 
extern void FreeMemory();
 
} // namespace Store
 
#endif /* SQUID_STORE_CONTROLLER_H */