]>
git.ipfire.org Git - thirdparty/squid.git/blob - src/fs/ufs/UFSSwapDir.h
2 * Copyright (C) 1996-2017 The Squid Software Foundation and contributors
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.
9 #ifndef SQUID_FS_UFS_UFSSWAPDIR_H
10 #define SQUID_FS_UFS_UFSSWAPDIR_H
12 #include "SquidString.h"
14 #include "store/Disk.h"
15 #include "StoreIOState.h"
16 #include "StoreSearch.h"
17 #include "swap_log_op.h"
18 #include "UFSStrategy.h"
21 class ConfigOptionVector
;
30 class UFSSwapDir
: public SwapDir
33 static bool IsUFSDir(SwapDir
* sd
);
34 static int DirClean(int swap_index
);
35 /** check whether swapfile belongs to the specified cachedir/l1dir/l2dir
37 * \param cachedir the number of the cachedir which is being tested
38 * \param level1dir level-1 dir in the cachedir
39 * \param level2dir level-2 dir
41 static bool FilenoBelongsHere(int fn
, int cachedir
, int level1dir
, int level2dir
);
43 UFSSwapDir(char const *aType
, const char *aModuleType
);
44 virtual ~UFSSwapDir();
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 unlink(StoreEntry
&) override
;
53 virtual void statfs(StoreEntry
&) const override
;
54 virtual void maintain() override
;
55 virtual void markForUnlink(StoreEntry
&) 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
;
59 virtual StoreIOState::Pointer
createStoreIO(StoreEntry
&, StoreIOState::STFNCB
*, StoreIOState::STIOCB
*, void *) override
;
60 virtual StoreIOState::Pointer
openStoreIO(StoreEntry
&, StoreIOState::STFNCB
*, StoreIOState::STIOCB
*, void *) 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 swappedOut(const StoreEntry
&e
) override
;
71 virtual uint64_t currentSize() const override
{ return cur_size
; }
72 virtual uint64_t currentCount() const override
{ return n_disk_objects
; }
73 virtual ConfigOption
*getOptionTree() const override
;
74 virtual bool smpAware() const override
{ return false; }
76 void unlinkFile(sfileno f
);
77 // move down when unlink is a virtual method
79 Fs::Ufs::UFSStrategy
*IO
;
80 char *fullPath(sfileno
, char *) const;
82 void closeTmpSwapLog();
83 FILE *openTmpSwapLog(int *clean_flag
, int *zero_flag
);
84 char *swapSubDir(int subdirn
) const;
85 int mapBitTest(sfileno filn
);
86 void mapBitReset(sfileno filn
);
87 void mapBitSet(sfileno filn
);
88 /** Add a new object to the cache with empty memory copy and pointer to disk
90 * This method is used to rebuild a store from disk
92 StoreEntry
*addDiskRestore(const cache_key
* key
,
94 uint64_t swap_file_sz
,
102 /// Undo the effects of UFSSwapDir::addDiskRestore().
103 void undoAddDiskRestore(StoreEntry
*e
);
104 int validFileno(sfileno filn
, int flag
) const;
105 int mapBitAllocate();
109 bool validL2(int) const;
110 bool validL1(int) const;
112 /** Add and remove the given StoreEntry from the replacement policy in use */
113 void replacementAdd(StoreEntry
*e
);
114 void replacementRemove(StoreEntry
*e
);
123 void parseSizeL1L2();
124 static int NumberOfUFSDirs
;
125 static int * UFSDirToGlobalDirMapping
;
126 bool pathIsDirectory(const char *path
)const;
128 static EVH CleanEvent
;
129 static int HandleCleanEvent();
130 /** Verify that the the CacheDir exists
132 * If this returns < 0, then Squid exits, complains about swap
133 * directories not existing, and instructs the admin to run 'squid -z'
134 * Called by UFSSwapDir::init
136 bool verifyCacheDirs();
138 int createDirectory(const char *path
, int);
139 void createSwapSubDirs();
140 void dumpEntry(StoreEntry
&) const;
141 char *logFile(char const *ext
= NULL
)const;
142 void changeIO(DiskIOModule
*);
143 bool optionIOParse(char const *option
, const char *value
, int reconfiguring
);
144 void optionIODump(StoreEntry
* e
) const;
145 mutable ConfigOptionVector
*currentIOOptions
;
147 uint64_t cur_size
; ///< currently used space in the storage area
148 uint64_t n_disk_objects
; ///< total number of objects stored
149 bool rebuilding_
; ///< whether RebuildState is writing the new swap.state
154 #endif /* SQUID_FS_UFS_UFSSWAPDIR_H */