2 * Copyright (C) 1996-2015 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 /* DEBUG: section 47 Store Directory Routines */
14 #include "RebuildState.h"
15 #include "SquidConfig.h"
16 #include "SquidTime.h"
17 #include "store/Disks.h"
18 #include "store_key_md5.h"
19 #include "store_rebuild.h"
20 #include "StoreSwapLogData.h"
22 #include "UFSSwapLogParser.h"
30 CBDATA_NAMESPACED_CLASS_INIT(Fs::Ufs
,RebuildState
);
32 Fs::Ufs::RebuildState::RebuildState(RefCount
<UFSSwapDir
> aSwapDir
) :
52 * If the swap.state file exists in the cache_dir, then
53 * we'll use commonUfsDirRebuildFromSwapLog(), otherwise we'll
54 * use commonUfsDirRebuildFromDirectory() to open up each file
55 * and suck in the meta data.
57 int clean
= 0; //TODO: change to bool
58 int zeroLengthLog
= 0;
59 FILE *fp
= sd
->openTmpSwapLog(&clean
, &zeroLengthLog
);
61 if (fp
&& !zeroLengthLog
)
62 LogParser
= Fs::Ufs::UFSSwapLogParser::GetUFSSwapLogParser(fp
);
64 if (LogParser
== NULL
) {
72 flags
.clean
= (clean
!= 0);
76 flags
.need_to_validate
= true;
78 debugs(47, DBG_IMPORTANT
, "Rebuilding storage in " << sd
->path
<< " (" <<
79 (clean
? "clean log" : (LogParser
? "dirty log" : "no log")) << ")");
82 Fs::Ufs::RebuildState::~RebuildState()
84 sd
->closeTmpSwapLog();
91 Fs::Ufs::RebuildState::RebuildStep(void *data
)
93 RebuildState
*rb
= (RebuildState
*)data
;
97 eventAdd("storeRebuild", RebuildStep
, rb
, 0.01, 1);
99 -- StoreController::store_dirs_rebuilding
;
100 storeRebuildComplete(&rb
->counts
);
105 /// load entries from swap.state or files until we run out of entries or time
107 Fs::Ufs::RebuildState::rebuildStep()
111 // Balance our desire to maximize the number of entries processed at once
112 // (and, hence, minimize overheads and total rebuild time) with a
113 // requirement to also process Coordinator events, disk I/Os, etc.
114 const int maxSpentMsec
= 50; // keep small: most RAM I/Os are under 1ms
115 const timeval loopStart
= current_time
;
117 const int totalEntries
= LogParser
? LogParser
->SwapLogEntries() : -1;
121 rebuildFromSwapLog();
123 rebuildFromDirectory();
125 // TODO: teach storeRebuildProgress to handle totalEntries <= 0
126 if (totalEntries
> 0 && (n_read
% 4000 == 0))
127 storeRebuildProgress(sd
->index
, totalEntries
, n_read
);
129 if (opt_foreground_rebuild
)
130 continue; // skip "few entries at a time" check below
133 const double elapsedMsec
= tvSubMsec(loopStart
, current_time
);
134 if (elapsedMsec
> maxSpentMsec
|| elapsedMsec
< 0) {
135 debugs(47, 5, HERE
<< "pausing after " << n_read
<< " entries in " <<
136 elapsedMsec
<< "ms; " << (elapsedMsec
/n_read
) << "ms per entry");
142 /// process one cache file
144 Fs::Ufs::RebuildState::rebuildFromDirectory()
146 cache_key key
[SQUID_MD5_DIGEST_LENGTH
];
150 debugs(47, 3, HERE
<< "DIR #" << sd
->index
);
155 fd
= getNextFile(&filn
, &size
);
158 debugs(47, DBG_IMPORTANT
, "Done scanning " << sd
->path
<< " dir (" <<
159 n_read
<< " entries)");
167 /* lets get file stats here */
171 if (fstat(fd
, &sb
) < 0) {
172 debugs(47, DBG_IMPORTANT
, HERE
<< "fstat(FD " << fd
<< "): " << xstrerror());
174 --store_open_disk_fd
;
180 buf
.init(SM_PAGE_SIZE
, SM_PAGE_SIZE
);
181 if (!storeRebuildLoadEntry(fd
, sd
->index
, buf
, counts
))
184 const uint64_t expectedSize
= sb
.st_size
> 0 ?
185 static_cast<uint64_t>(sb
.st_size
) : 0;
188 const bool parsed
= storeRebuildParseEntry(buf
, tmpe
, key
, counts
,
192 --store_open_disk_fd
;
195 bool accepted
= parsed
&& tmpe
.swap_file_sz
> 0;
196 if (parsed
&& !accepted
) {
197 debugs(47, DBG_IMPORTANT
, "WARNING: Ignoring ufs cache entry with " <<
198 "unknown size: " << tmpe
);
203 // XXX: shouldn't this be a call to commonUfsUnlink?
204 sd
->unlinkFile(filn
); // should we unlink in all failure cases?
208 if (!storeRebuildKeepEntry(tmpe
, key
, counts
))
213 currentEntry(sd
->addDiskRestore(key
,
220 tmpe
.refcount
, /* refcount */
221 tmpe
.flags
, /* flags */
223 storeDirSwapLog(currentEntry(), SWAP_LOG_ADD
);
227 Fs::Ufs::RebuildState::currentEntry() const
233 Fs::Ufs::RebuildState::currentEntry(StoreEntry
*newValue
)
238 /// process one swap log entry
240 Fs::Ufs::RebuildState::rebuildFromSwapLog()
242 StoreSwapLogData swapData
;
244 if (LogParser
->ReadRecord(swapData
) != 1) {
245 debugs(47, DBG_IMPORTANT
, "Done reading " << sd
->path
<< " swaplog (" << n_read
<< " entries)");
255 if (!swapData
.sane()) {
261 * BC: during 2.4 development, we changed the way swap file
262 * numbers are assigned and stored. The high 16 bits used
263 * to encode the SD index number. There used to be a call
264 * to storeDirProperFileno here that re-assigned the index
265 * bits. Now, for backwards compatibility, we just need
268 swapData
.swap_filen
&= 0x00FFFFFF;
270 debugs(47, 3, HERE
<< swap_log_op_str
[(int) swapData
.op
] << " " <<
271 storeKeyText(swapData
.key
) << " "<< std::setfill('0') <<
272 std::hex
<< std::uppercase
<< std::setw(8) <<
273 swapData
.swap_filen
);
275 if (swapData
.op
== SWAP_LOG_ADD
) {
277 } else if (swapData
.op
== SWAP_LOG_DEL
) {
278 /* Delete unless we already have a newer copy anywhere in any store */
279 /* this needs to become
281 * 2) make synthetic request with headers ?? or otherwise search
282 * for a matching object in the store
283 * TODO FIXME change to new async api
285 currentEntry (Store::Root().get(swapData
.key
));
287 if (currentEntry() != NULL
&& swapData
.lastref
>= e
->lastref
) {
290 ++counts
.cancelcount
;
295 x
= ::log(static_cast<double>(++counts
.bad_log_op
)) / ::log(10.0);
297 if (0.0 == x
- (double) (int) x
)
298 debugs(47, DBG_IMPORTANT
, "WARNING: " << counts
.bad_log_op
<< " invalid swap log entries found");
305 ++counts
.scancount
; // XXX: should not this be incremented earlier?
307 if (!sd
->validFileno(swapData
.swap_filen
, 0)) {
312 if (EBIT_TEST(swapData
.flags
, KEY_PRIVATE
)) {
317 /* this needs to become
319 * 2) make synthetic request with headers ?? or otherwise search
320 * for a matching object in the store
321 * TODO FIXME change to new async api
323 currentEntry (Store::Root().get(swapData
.key
));
325 int used
; /* is swapfile already in use? */
327 used
= sd
->mapBitTest(swapData
.swap_filen
);
329 /* If this URL already exists in the cache, does the swap log
330 * appear to have a newer entry? Compare 'lastref' from the
331 * swap log to e->lastref. */
332 /* is the log entry newer than current entry? */
333 int disk_entry_newer
= currentEntry() ? (swapData
.lastref
> currentEntry()->lastref
? 1 : 0) : 0;
335 if (used
&& !disk_entry_newer
) {
336 /* log entry is old, ignore it */
339 } else if (used
&& currentEntry() && currentEntry()->swap_filen
== swapData
.swap_filen
&& currentEntry()->swap_dirn
== sd
->index
) {
340 /* swapfile taken, same URL, newer, update meta */
342 if (currentEntry()->store_status
== STORE_OK
) {
343 currentEntry()->lastref
= swapData
.timestamp
;
344 currentEntry()->timestamp
= swapData
.timestamp
;
345 currentEntry()->expires
= swapData
.expires
;
346 currentEntry()->lastmod
= swapData
.lastmod
;
347 currentEntry()->flags
= swapData
.flags
;
348 currentEntry()->refcount
+= swapData
.refcount
;
349 sd
->dereference(*currentEntry());
351 debug_trap("commonUfsDirRebuildFromSwapLog: bad condition");
352 debugs(47, DBG_IMPORTANT
, HERE
<< "bad condition");
356 /* swapfile in use, not by this URL, log entry is newer */
357 /* This is sorta bad: the log entry should NOT be newer at this
358 * point. If the log is dirty, the filesize check should have
359 * caught this. If the log is clean, there should never be a
361 debugs(47, DBG_IMPORTANT
, "WARNING: newer swaplog entry for dirno " <<
362 sd
->index
<< ", fileno "<< std::setfill('0') << std::hex
<<
363 std::uppercase
<< std::setw(8) << swapData
.swap_filen
);
365 /* I'm tempted to remove the swapfile here just to be safe,
366 * but there is a bad race condition in the NOVM version if
367 * the swapfile has recently been opened for writing, but
368 * not yet opened for reading. Because we can't map
369 * swapfiles back to StoreEntrys, we don't know the state
370 * of the entry using that file. */
371 /* We'll assume the existing entry is valid, probably because
372 * were in a slow rebuild and the the swap file number got taken
373 * and the validation procedure hasn't run. */
374 assert(flags
.need_to_validate
);
377 } else if (currentEntry() && !disk_entry_newer
) {
378 /* key already exists, current entry is newer */
379 /* keep old, ignore new */
382 } else if (currentEntry()) {
383 /* key already exists, this swapfile not being used */
384 /* junk old, load new */
389 /* URL doesnt exist, swapfile not in use */
396 currentEntry(sd
->addDiskRestore(swapData
.key
,
398 swapData
.swap_file_sz
,
407 storeDirSwapLog(currentEntry(), SWAP_LOG_ADD
);
410 /// undo the effects of adding an entry in rebuildFromSwapLog()
412 Fs::Ufs::RebuildState::undoAdd()
414 StoreEntry
*added
= currentEntry();
418 // TODO: Why bother with these two if we are going to release?!
420 added
->releaseRequest();
422 if (added
->swap_filen
> -1) {
423 SwapDir
*someDir
= INDEXSD(added
->swap_dirn
);
425 if (UFSSwapDir
*ufsDir
= dynamic_cast<UFSSwapDir
*>(someDir
))
426 ufsDir
->undoAddDiskRestore(added
);
427 // else the entry was loaded from and/or is currently in a non-UFS dir
428 // Thus, there is no use in preserving its disk file (the only purpose
429 // of undoAddDiskRestore!), even if we could. Instead, we release the
430 // the entry and [eventually] unlink its disk file or free its slot.
437 Fs::Ufs::RebuildState::getNextFile(sfileno
* filn_p
, int *)
441 debugs(47, 3, HERE
<< "flag=" << flags
.init
<< ", " <<
442 sd
->index
<< ": /"<< std::setfill('0') << std::hex
<<
443 std::uppercase
<< std::setw(2) << curlvl1
<< "/" << std::setw(2) <<
449 while (fd
< 0 && done
== 0) {
452 if (!flags
.init
) { /* initialize, open first file */
453 // XXX: 0's should not be needed, constructor inits now
459 assert(Config
.cacheSwap
.n_configured
> 0);
462 if (0 == in_dir
) { /* we need to read in a new directory */
463 snprintf(fullpath
, MAXPATHLEN
, "%s/%02X/%02X",
470 td
= opendir(fullpath
);
475 debugs(47, DBG_IMPORTANT
, HERE
<< "error in opendir (" << fullpath
<< "): " << xstrerror());
477 entry
= readdir(td
); /* skip . and .. */
480 if (entry
== NULL
&& errno
== ENOENT
)
481 debugs(47, DBG_IMPORTANT
, HERE
<< "WARNING: directory does not exist!");
482 debugs(47, 3, HERE
<< "Directory " << fullpath
);
486 if (td
!= NULL
&& (entry
= readdir(td
)) != NULL
) {
489 if (sscanf(entry
->d_name
, "%x", &fn
) != 1) {
490 debugs(47, 3, HERE
<< "invalid entry " << entry
->d_name
);
494 if (!UFSSwapDir::FilenoBelongsHere(fn
, sd
->index
, curlvl1
, curlvl2
)) {
495 debugs(47, 3, HERE
<< std::setfill('0') <<
496 std::hex
<< std::uppercase
<< std::setw(8) << fn
<<
497 " does not belong in " << std::dec
<< sd
->index
<< "/" <<
498 curlvl1
<< "/" << curlvl2
);
503 if (sd
->mapBitTest(fn
)) {
504 debugs(47, 3, HERE
<< "Locked, continuing with next.");
508 snprintf(fullfilename
, MAXPATHLEN
, "%s/%s",
509 fullpath
, entry
->d_name
);
510 debugs(47, 3, HERE
<< "Opening " << fullfilename
);
511 fd
= file_open(fullfilename
, O_RDONLY
| O_BINARY
);
514 debugs(47, DBG_IMPORTANT
, HERE
<< "error opening " << fullfilename
<< ": " << xstrerror());
516 ++store_open_disk_fd
;
528 if (sd
->validL2(++curlvl2
))
533 if (sd
->validL1(++curlvl1
))
546 Fs::Ufs::RebuildState::error() const
552 Fs::Ufs::RebuildState::isDone() const
558 Fs::Ufs::RebuildState::currentItem()
560 return currentEntry();