MemStore.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 1996-2019 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_MEMSTORE_H
10 #define SQUID_MEMSTORE_H
11 
12 #include "ipc/mem/Page.h"
13 #include "ipc/mem/PageStack.h"
14 #include "ipc/StoreMap.h"
15 #include "Store.h"
16 #include "store/Controlled.h"
17 
18 // StoreEntry restoration info not already stored by Ipc::StoreMap
21 };
24 
25 class ShmWriter;
26 
30 {
31 public:
32  MemStore();
33  virtual ~MemStore();
34 
36  bool keepInLocalMemory(const StoreEntry &e) const;
37 
39  void write(StoreEntry &e);
40 
42  void completeWriting(StoreEntry &e);
43 
45  void disconnect(StoreEntry &e);
46 
47  /* Storage API */
48  virtual void create() override {}
49  virtual void init() override;
50  virtual StoreEntry *get(const cache_key *) override;
51  virtual uint64_t maxSize() const override;
52  virtual uint64_t minSize() const override;
53  virtual uint64_t currentSize() const override;
54  virtual uint64_t currentCount() const override;
55  virtual int64_t maxObjectSize() const override;
56  virtual void getStats(StoreInfoStats &stats) const override;
57  virtual void stat(StoreEntry &e) const override;
58  virtual void reference(StoreEntry &e) override;
59  virtual bool dereference(StoreEntry &e) override;
60  virtual void updateHeaders(StoreEntry *e) override;
61  virtual void maintain() override;
62  virtual bool anchorToCache(StoreEntry &e, bool &inSync) override;
63  virtual bool updateAnchored(StoreEntry &) override;
64  virtual void evictCached(StoreEntry &) override;
65  virtual void evictIfFound(const cache_key *) override;
66 
68  static bool Enabled() { return EntryLimit() > 0; }
69  static int64_t EntryLimit();
72  static bool Requested();
73 
74 protected:
75  friend ShmWriter;
76 
77  bool shouldCache(StoreEntry &e) const;
78  bool startCaching(StoreEntry &e);
79 
80  void copyToShm(StoreEntry &e);
81  void copyToShmSlice(StoreEntry &e, Ipc::StoreMapAnchor &anchor, Ipc::StoreMap::Slice &slice);
82  bool copyFromShm(StoreEntry &e, const sfileno index, const Ipc::StoreMapAnchor &anchor);
83  bool copyFromShmSlice(StoreEntry &e, const StoreIOBuffer &buf, bool eof);
84 
85  void updateHeadersOrThrow(Ipc::StoreMapUpdate &update);
86 
87  void anchorEntry(StoreEntry &e, const sfileno index, const Ipc::StoreMapAnchor &anchor);
88  bool updateAnchoredWith(StoreEntry &, const sfileno, const Ipc::StoreMapAnchor &);
89 
90  Ipc::Mem::PageId pageForSlice(Ipc::StoreMapSliceId sliceId);
91  Ipc::StoreMap::Slice &nextAppendableSlice(const sfileno entryIndex, sfileno &sliceOffset);
92  sfileno reserveSapForWriting(Ipc::Mem::PageId &page);
93 
94  // Ipc::StoreMapCleaner API
95  virtual void noteFreeMapSlice(const Ipc::StoreMapSliceId sliceId) override;
96 
97 private:
98  // TODO: move freeSlots into map
101 
104 
107 
110  {
111  public:
112  SlotAndPage(): slot(NULL), page(NULL) {}
113  bool operator !() const { return !slot && !page; }
116  };
118 };
119 
120 // Why use Store as a base? MemStore and SwapDir are both "caches".
121 
122 // Why not just use a SwapDir API? That would not help much because Store has
123 // to check/update memory cache separately from the disk cache. And same API
124 // would hurt because we can support synchronous get/put, unlike the disks.
125 
126 #endif /* SQUID_MEMSTORE_H */
127 
friend ShmWriter
Definition: MemStore.h:75
MemStoreMapExtras Extras
Definition: MemStore.h:102
Aggregates information required for updating entry metadata and headers.
Definition: StoreMap.h:162
SlotAndPage waitingFor
a cache for a single "hot" free slot and page
Definition: MemStore.h:117
Ipc::Mem::Pointer< Ipc::Mem::PageStack > freeSlots
unused map slot IDs
Definition: MemStore.h:99
unsigned char cache_key
Store key.
Definition: forward.h:29
Ipc::Mem::PageId * slot
local slot variable, waiting to be filled
Definition: MemStore.h:114
Ipc::StoreMap MemStoreMap
Definition: MemStore.h:23
MemStoreMap * map
index of mem-cached entries
Definition: MemStore.h:100
class Ping::pingStats_ stats
Ipc::Mem::PageId * page
local page variable, waiting to be filled
Definition: MemStore.h:115
High-level store statistics used by mgr:info action. Used inside PODs!
Definition: StoreStats.h:13
temporary storage for slot and page ID pointers; for the waiting cache
Definition: MemStore.h:109
API for adjusting external state when dirty map slice is being freed.
Definition: StoreMap.h:358
static bool Enabled()
whether Squid is correctly configured to use a shared memory cache
Definition: MemStore.h:68
int32_t StoreMapSliceId
Definition: StoreMap.h:24
signed_int32_t sfileno
Definition: forward.h:22
void const char * buf
Definition: stub_helper.cc:16
Ipc::StoreMapItems< MemStoreMapExtraItem > MemStoreMapExtras
Definition: MemStore.h:22
Shared memory page identifier, address, or handler.
Definition: Page.h:21
Ipc::Mem::Pointer< Extras > extras
IDs of pages with slice data.
Definition: MemStore.h:103
sfileno lastWritingSlice
the last allocate slice for writing a store entry (during copyToShm)
Definition: MemStore.h:106
virtual void create() override
create system resources needed for this store to operate in the future
Definition: MemStore.h:48
#define NULL
Definition: types.h:166
Ipc::Mem::PageId page
shared memory page with entry slice content
Definition: MemStore.h:20

 

Introduction

Documentation

Support

Miscellaneous

Web Site Translations

Mirrors