UFSSwapDir.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_FS_UFS_UFSSWAPDIR_H
10#define SQUID_FS_UFS_UFSSWAPDIR_H
11
12#include "SquidString.h"
13#include "Store.h"
14#include "store/Disk.h"
15#include "StoreIOState.h"
16#include "StoreSearch.h"
17#include "swap_log_op.h"
18#include "UFSStrategy.h"
19
20class HttpRequest;
22class FileMap;
23class DiskIOModule;
24
25namespace Fs
26{
27namespace Ufs
28{
30class UFSSwapDir : public SwapDir
31{
32public:
33 static bool IsUFSDir(SwapDir* sd);
34 static int DirClean(int swap_index);
41 static bool FilenoBelongsHere(int fn, int cachedir, int level1dir, int level2dir);
42
43 UFSSwapDir(char const *aType, const char *aModuleType);
44 virtual ~UFSSwapDir();
45
46 /* Store::Disk API */
47 virtual void create() override;
48 virtual void init() override;
49 virtual void dump(StoreEntry &) const override;
50 virtual bool doubleCheck(StoreEntry &) override;
51 virtual bool unlinkdUseful() const override;
52 virtual void statfs(StoreEntry &) const override;
53 virtual void maintain() override;
54 virtual void evictCached(StoreEntry &) override;
55 virtual void evictIfFound(const cache_key *) override;
56 virtual bool canStore(const StoreEntry &e, int64_t diskSpaceNeeded, int &load) const override;
57 virtual void reference(StoreEntry &) override;
58 virtual bool dereference(StoreEntry &) override;
61 virtual void openLog() override;
62 virtual void closeLog() override;
63 virtual int writeCleanStart() override;
64 virtual void writeCleanDone() override;
65 virtual void logEntry(const StoreEntry & e, int op) const override;
66 virtual void parse(int index, char *path) override;
67 virtual void reconfigure() override;
68 virtual int callback() override;
69 virtual void sync() override;
70 virtual void finalizeSwapoutSuccess(const StoreEntry &) override;
71 virtual void finalizeSwapoutFailure(StoreEntry &) override;
72 virtual uint64_t currentSize() const override { return cur_size; }
73 virtual uint64_t currentCount() const override { return n_disk_objects; }
74 virtual ConfigOption *getOptionTree() const override;
75 virtual bool smpAware() const override { return false; }
78 virtual bool hasReadableEntry(const StoreEntry &) const override { return false; }
79
80 void unlinkFile(sfileno f);
81 // move down when unlink is a virtual method
82 //protected:
84 char *fullPath(sfileno, char *) const;
85 /* temp */
86 void closeTmpSwapLog();
87 FILE *openTmpSwapLog(int *clean_flag, int *zero_flag);
88 char *swapSubDir(int subdirn) const;
89 int mapBitTest(sfileno filn);
90 void mapBitReset(sfileno filn);
91 void mapBitSet(sfileno filn);
97 sfileno file_number,
98 uint64_t swap_file_sz,
99 time_t expires,
100 time_t timestamp,
101 time_t lastref,
102 time_t lastmod,
103 uint32_t refcount,
104 uint16_t flags,
105 int clean);
106 int validFileno(sfileno filn, int flag) const;
107 int mapBitAllocate();
108
109 void *fsdata;
110
111 bool validL2(int) const;
112 bool validL1(int) const;
113
115 void replacementAdd(StoreEntry *e);
117
118protected:
121 int l1;
122 int l2;
123
124private:
125 void parseSizeL1L2();
126 static int NumberOfUFSDirs;
128 bool pathIsDirectory(const char *path)const;
131 static int HandleCleanEvent();
138 bool verifyCacheDirs();
139 void rebuild();
140 int createDirectory(const char *path, int);
141 void createSwapSubDirs();
142 void dumpEntry(StoreEntry &) const;
143 SBuf logFile(char const *ext = nullptr) const;
144 void changeIO(DiskIOModule *);
145 bool optionIOParse(char const *option, const char *value, int reconfiguring);
146 void optionIODump(StoreEntry * e) const;
148 char const *ioType;
149 uint64_t cur_size;
150 uint64_t n_disk_objects;
152};
153
154} //namespace Ufs
155} //namespace Fs
156#endif /* SQUID_FS_UFS_UFSSWAPDIR_H */
157
virtual void openLog() override
Definition: UFSSwapDir.cc:728
bool pathIsDirectory(const char *path) const
Definition: UFSSwapDir.cc:629
virtual void sync() override
prepare for shutdown
Definition: UFSSwapDir.cc:1264
ConfigOptionVector * currentIOOptions
Definition: UFSSwapDir.h:147
static EVH CleanEvent
Definition: UFSSwapDir.h:130
virtual bool smpAware() const override
whether this disk storage is capable of serving multiple workers
Definition: UFSSwapDir.h:75
virtual void finalizeSwapoutFailure(StoreEntry &) override
abort the failed swapout that has been already noticed by Store
Definition: UFSSwapDir.cc:1277
virtual bool unlinkdUseful() const override
whether SwapDir may benefit from unlinkd
Definition: UFSSwapDir.cc:1173
virtual int callback() override
called once every main loop iteration; TODO: Move to UFS code.
Definition: UFSSwapDir.cc:1258
void replacementAdd(StoreEntry *e)
Definition: UFSSwapDir.cc:1209
virtual void evictIfFound(const cache_key *) override
Definition: UFSSwapDir.cc:1202
UFSSwapDir(char const *aType, const char *aModuleType)
Definition: UFSSwapDir.cc:307
StoreEntry * addDiskRestore(const cache_key *key, sfileno file_number, uint64_t swap_file_sz, time_t expires, time_t timestamp, time_t lastref, time_t lastmod, uint32_t refcount, uint16_t flags, int clean)
Definition: UFSSwapDir.cc:788
void mapBitReset(sfileno filn)
Definition: UFSSwapDir.cc:570
void optionIODump(StoreEntry *e) const
Definition: UFSSwapDir.cc:244
int createDirectory(const char *path, int)
Definition: UFSSwapDir.cc:604
void changeIO(DiskIOModule *)
Definition: UFSSwapDir.cc:194
virtual void reconfigure() override
Definition: UFSSwapDir.cc:173
virtual void finalizeSwapoutSuccess(const StoreEntry &) override
finalize the successful swapout that has been already noticed by Store
Definition: UFSSwapDir.cc:1270
virtual void parse(int index, char *path) override
Definition: UFSSwapDir.cc:180
virtual void statfs(StoreEntry &) const override
Definition: UFSSwapDir.cc:371
static int DirClean(int swap_index)
Definition: UFSSwapDir.cc:1314
virtual bool hasReadableEntry(const StoreEntry &) const override
Definition: UFSSwapDir.h:78
SBuf logFile(char const *ext=nullptr) const
Definition: UFSSwapDir.cc:689
FILE * openTmpSwapLog(int *clean_flag, int *zero_flag)
Definition: UFSSwapDir.cc:859
virtual void create() override
create system resources needed for this store to operate in the future
Definition: UFSSwapDir.cc:300
void mapBitSet(sfileno filn)
Definition: UFSSwapDir.cc:564
virtual void evictCached(StoreEntry &) override
Definition: UFSSwapDir.cc:1180
char const * ioType
Definition: UFSSwapDir.h:148
virtual void reference(StoreEntry &) override
somebody needs this entry (many cache replacement policies need to know)
Definition: UFSSwapDir.cc:524
char * swapSubDir(int subdirn) const
Definition: UFSSwapDir.cc:595
uint64_t n_disk_objects
total number of objects stored
Definition: UFSSwapDir.h:150
static int * UFSDirToGlobalDirMapping
Definition: UFSSwapDir.h:127
virtual void init() override
Definition: UFSSwapDir.cc:272
int validFileno(sfileno filn, int flag) const
Definition: UFSSwapDir.cc:1146
void replacementRemove(StoreEntry *e)
Definition: UFSSwapDir.cc:1216
int mapBitTest(sfileno filn)
Definition: UFSSwapDir.cc:558
Fs::Ufs::UFSStrategy * IO
Definition: UFSSwapDir.h:83
void dumpEntry(StoreEntry &) const
Definition: UFSSwapDir.cc:341
virtual ~UFSSwapDir()
Definition: UFSSwapDir.cc:328
virtual bool dereference(StoreEntry &) override
Definition: UFSSwapDir.cc:534
virtual StoreIOState::Pointer createStoreIO(StoreEntry &, StoreIOState::STFNCB *, StoreIOState::STIOCB *, void *) override
Definition: UFSSwapDir.cc:546
bool rebuilding_
whether RebuildState is writing the new swap.state
Definition: UFSSwapDir.h:151
virtual bool doubleCheck(StoreEntry &) override
Definition: UFSSwapDir.cc:349
virtual void maintain() override
perform regular periodic maintenance; TODO: move to UFSSwapDir::Maintain
Definition: UFSSwapDir.cc:414
static bool IsUFSDir(SwapDir *sd)
Definition: UFSSwapDir.cc:1104
virtual ConfigOption * getOptionTree() const override
Definition: UFSSwapDir.cc:250
static int NumberOfUFSDirs
Definition: UFSSwapDir.h:126
virtual void logEntry(const StoreEntry &e, int op) const override
Definition: UFSSwapDir.cc:1285
virtual void dump(StoreEntry &) const override
Definition: UFSSwapDir.cc:1230
static bool FilenoBelongsHere(int fn, int cachedir, int level1dir, int level2dir)
Definition: UFSSwapDir.cc:1116
char * fullPath(sfileno, char *) const
Definition: UFSSwapDir.cc:1237
virtual int writeCleanStart() override
Definition: UFSSwapDir.cc:933
virtual void closeLog() override
Definition: UFSSwapDir.cc:755
virtual uint64_t currentSize() const override
current size
Definition: UFSSwapDir.h:72
static int HandleCleanEvent()
safely cleans a few unused files if possible
Definition: UFSSwapDir.cc:1040
void unlinkFile(sfileno f)
Definition: UFSSwapDir.cc:1163
bool validL1(int) const
Definition: UFSSwapDir.cc:776
uint64_t cur_size
currently used space in the storage area
Definition: UFSSwapDir.h:149
bool optionIOParse(char const *option, const char *value, int reconfiguring)
Definition: UFSSwapDir.cc:217
virtual bool canStore(const StoreEntry &e, int64_t diskSpaceNeeded, int &load) const override
check whether we can store the entry; if we can, report current load
Definition: UFSSwapDir.cc:115
virtual StoreIOState::Pointer openStoreIO(StoreEntry &, StoreIOState::STFNCB *, StoreIOState::STIOCB *, void *) override
Definition: UFSSwapDir.cc:552
bool validL2(int) const
Definition: UFSSwapDir.cc:782
virtual void writeCleanDone() override
Definition: UFSSwapDir.cc:977
virtual uint64_t currentCount() const override
the total number of objects stored right now
Definition: UFSSwapDir.h:73
Definition: SBuf.h:94
void STFNCB(void *their_data, int errflag, StoreIOState::Pointer self)
Definition: StoreIOState.h:41
void STIOCB(void *their_data, int errflag, StoreIOState::Pointer self)
Definition: StoreIOState.h:51
manages a single cache_dir
Definition: Disk.h:22
char * path
Definition: Disk.h:102
int index
Definition: Disk.h:103
struct Store::Disk::Flags flags
void EVH(void *)
Definition: event.h:18
int reconfiguring
Definition: Module.h:13
unsigned char cache_key
Store key.
Definition: forward.h:29
signed_int32_t sfileno
Definition: forward.h:22

 

Introduction

Documentation

Support

Miscellaneous

Web Site Translations

Mirrors