forked from mozilla/gecko-dev
-
Notifications
You must be signed in to change notification settings - Fork 1
/
CacheIndex.h
1311 lines (1124 loc) · 49.8 KB
/
CacheIndex.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#ifndef CacheIndex__h__
#define CacheIndex__h__
#include "CacheLog.h"
#include "CacheFileIOManager.h"
#include "nsIRunnable.h"
#include "CacheHashUtils.h"
#include "nsICacheStorageService.h"
#include "nsICacheEntry.h"
#include "nsILoadContextInfo.h"
#include "nsIWeakReferenceUtils.h"
#include "nsTHashtable.h"
#include "nsThreadUtils.h"
#include "mozilla/IntegerPrintfMacros.h"
#include "mozilla/SHA1.h"
#include "mozilla/StaticMutex.h"
#include "mozilla/StaticPtr.h"
#include "mozilla/EndianUtils.h"
#include "mozilla/TimeStamp.h"
#include "mozilla/UniquePtr.h"
class nsIFile;
class nsIDirectoryEnumerator;
class nsITimer;
#ifdef DEBUG
# define DEBUG_STATS 1
#endif
namespace mozilla {
namespace net {
class CacheFileMetadata;
class FileOpenHelper;
class CacheIndexIterator;
const uint16_t kIndexTimeNotAvailable = 0xFFFFU;
const uint16_t kIndexTimeOutOfBound = 0xFFFEU;
using CacheIndexHeader = struct {
// Version of the index. The index must be ignored and deleted when the file
// on disk was written with a newer version.
uint32_t mVersion;
// Timestamp of time when the last successful write of the index started.
// During update process we use this timestamp for a quick validation of entry
// files. If last modified time of the file is lower than this timestamp, we
// skip parsing of such file since the information in index should be up to
// date.
uint32_t mTimeStamp;
// We set this flag as soon as possible after parsing index during startup
// and clean it after we write journal to disk during shutdown. We ignore the
// journal and start update process whenever this flag is set during index
// parsing.
uint32_t mIsDirty;
// The amount of data written to the cache. When it reaches
// kTelemetryReportBytesLimit a telemetry report is sent and the counter is
// reset.
uint32_t mKBWritten;
};
static_assert(sizeof(CacheIndexHeader::mVersion) +
sizeof(CacheIndexHeader::mTimeStamp) +
sizeof(CacheIndexHeader::mIsDirty) +
sizeof(CacheIndexHeader::mKBWritten) ==
sizeof(CacheIndexHeader),
"Unexpected sizeof(CacheIndexHeader)!");
#pragma pack(push, 1)
struct CacheIndexRecord {
SHA1Sum::Hash mHash{};
uint32_t mFrecency{0};
OriginAttrsHash mOriginAttrsHash{0};
uint16_t mOnStartTime{kIndexTimeNotAvailable};
uint16_t mOnStopTime{kIndexTimeNotAvailable};
uint8_t mContentType{nsICacheEntry::CONTENT_TYPE_UNKNOWN};
/*
* 1000 0000 0000 0000 0000 0000 0000 0000 : initialized
* 0100 0000 0000 0000 0000 0000 0000 0000 : anonymous
* 0010 0000 0000 0000 0000 0000 0000 0000 : removed
* 0001 0000 0000 0000 0000 0000 0000 0000 : dirty
* 0000 1000 0000 0000 0000 0000 0000 0000 : fresh
* 0000 0100 0000 0000 0000 0000 0000 0000 : pinned
* 0000 0010 0000 0000 0000 0000 0000 0000 : has cached alt data
* 0000 0001 0000 0000 0000 0000 0000 0000 : reserved
* 0000 0000 1111 1111 1111 1111 1111 1111 : file size (in kB)
*/
uint32_t mFlags{0};
CacheIndexRecord() = default;
};
#pragma pack(pop)
static_assert(sizeof(CacheIndexRecord::mHash) +
sizeof(CacheIndexRecord::mFrecency) +
sizeof(CacheIndexRecord::mOriginAttrsHash) +
sizeof(CacheIndexRecord::mOnStartTime) +
sizeof(CacheIndexRecord::mOnStopTime) +
sizeof(CacheIndexRecord::mContentType) +
sizeof(CacheIndexRecord::mFlags) ==
sizeof(CacheIndexRecord),
"Unexpected sizeof(CacheIndexRecord)!");
class CacheIndexRecordWrapper final {
public:
NS_INLINE_DECL_THREADSAFE_REFCOUNTING_WITH_DESTROY(
CacheIndexRecordWrapper, DispatchDeleteSelfToCurrentThread());
CacheIndexRecordWrapper() : mRec(MakeUnique<CacheIndexRecord>()) {}
CacheIndexRecord* Get() { return mRec.get(); }
private:
~CacheIndexRecordWrapper();
void DispatchDeleteSelfToCurrentThread();
UniquePtr<CacheIndexRecord> mRec;
friend class DeleteCacheIndexRecordWrapper;
};
class CacheIndexEntry : public PLDHashEntryHdr {
public:
using KeyType = const SHA1Sum::Hash&;
using KeyTypePointer = const SHA1Sum::Hash*;
explicit CacheIndexEntry(KeyTypePointer aKey) {
MOZ_COUNT_CTOR(CacheIndexEntry);
mRec = new CacheIndexRecordWrapper();
LOG(("CacheIndexEntry::CacheIndexEntry() - Created record [rec=%p]",
mRec->Get()));
memcpy(&mRec->Get()->mHash, aKey, sizeof(SHA1Sum::Hash));
}
CacheIndexEntry(const CacheIndexEntry& aOther) {
MOZ_ASSERT_UNREACHABLE("CacheIndexEntry copy constructor is forbidden!");
}
~CacheIndexEntry() {
MOZ_COUNT_DTOR(CacheIndexEntry);
LOG(("CacheIndexEntry::~CacheIndexEntry() - Deleting record [rec=%p]",
mRec->Get()));
}
// KeyEquals(): does this entry match this key?
bool KeyEquals(KeyTypePointer aKey) const {
return memcmp(&mRec->Get()->mHash, aKey, sizeof(SHA1Sum::Hash)) == 0;
}
// KeyToPointer(): Convert KeyType to KeyTypePointer
static KeyTypePointer KeyToPointer(KeyType aKey) { return &aKey; }
// HashKey(): calculate the hash number
static PLDHashNumber HashKey(KeyTypePointer aKey) {
return (reinterpret_cast<const uint32_t*>(aKey))[0];
}
// ALLOW_MEMMOVE can we move this class with memmove(), or do we have
// to use the copy constructor?
enum { ALLOW_MEMMOVE = true };
bool operator==(const CacheIndexEntry& aOther) const {
return KeyEquals(&aOther.mRec->Get()->mHash);
}
CacheIndexEntry& operator=(const CacheIndexEntry& aOther) {
MOZ_ASSERT(memcmp(&mRec->Get()->mHash, &aOther.mRec->Get()->mHash,
sizeof(SHA1Sum::Hash)) == 0);
mRec->Get()->mFrecency = aOther.mRec->Get()->mFrecency;
mRec->Get()->mOriginAttrsHash = aOther.mRec->Get()->mOriginAttrsHash;
mRec->Get()->mOnStartTime = aOther.mRec->Get()->mOnStartTime;
mRec->Get()->mOnStopTime = aOther.mRec->Get()->mOnStopTime;
mRec->Get()->mContentType = aOther.mRec->Get()->mContentType;
mRec->Get()->mFlags = aOther.mRec->Get()->mFlags;
return *this;
}
void InitNew() {
mRec->Get()->mFrecency = 0;
mRec->Get()->mOriginAttrsHash = 0;
mRec->Get()->mOnStartTime = kIndexTimeNotAvailable;
mRec->Get()->mOnStopTime = kIndexTimeNotAvailable;
mRec->Get()->mContentType = nsICacheEntry::CONTENT_TYPE_UNKNOWN;
mRec->Get()->mFlags = 0;
}
void Init(OriginAttrsHash aOriginAttrsHash, bool aAnonymous, bool aPinned) {
MOZ_ASSERT(mRec->Get()->mFrecency == 0);
MOZ_ASSERT(mRec->Get()->mOriginAttrsHash == 0);
MOZ_ASSERT(mRec->Get()->mOnStartTime == kIndexTimeNotAvailable);
MOZ_ASSERT(mRec->Get()->mOnStopTime == kIndexTimeNotAvailable);
MOZ_ASSERT(mRec->Get()->mContentType ==
nsICacheEntry::CONTENT_TYPE_UNKNOWN);
// When we init the entry it must be fresh and may be dirty
MOZ_ASSERT((mRec->Get()->mFlags & ~kDirtyMask) == kFreshMask);
mRec->Get()->mOriginAttrsHash = aOriginAttrsHash;
mRec->Get()->mFlags |= kInitializedMask;
if (aAnonymous) {
mRec->Get()->mFlags |= kAnonymousMask;
}
if (aPinned) {
mRec->Get()->mFlags |= kPinnedMask;
}
}
const SHA1Sum::Hash* Hash() const { return &mRec->Get()->mHash; }
bool IsInitialized() const {
return !!(mRec->Get()->mFlags & kInitializedMask);
}
mozilla::net::OriginAttrsHash OriginAttrsHash() const {
return mRec->Get()->mOriginAttrsHash;
}
bool Anonymous() const { return !!(mRec->Get()->mFlags & kAnonymousMask); }
bool IsRemoved() const { return !!(mRec->Get()->mFlags & kRemovedMask); }
void MarkRemoved() { mRec->Get()->mFlags |= kRemovedMask; }
bool IsDirty() const { return !!(mRec->Get()->mFlags & kDirtyMask); }
void MarkDirty() { mRec->Get()->mFlags |= kDirtyMask; }
void ClearDirty() { mRec->Get()->mFlags &= ~kDirtyMask; }
bool IsFresh() const { return !!(mRec->Get()->mFlags & kFreshMask); }
void MarkFresh() { mRec->Get()->mFlags |= kFreshMask; }
bool IsPinned() const { return !!(mRec->Get()->mFlags & kPinnedMask); }
void SetFrecency(uint32_t aFrecency) { mRec->Get()->mFrecency = aFrecency; }
uint32_t GetFrecency() const { return mRec->Get()->mFrecency; }
void SetHasAltData(bool aHasAltData) {
aHasAltData ? mRec->Get()->mFlags |= kHasAltDataMask
: mRec->Get()->mFlags &= ~kHasAltDataMask;
}
bool GetHasAltData() const {
return !!(mRec->Get()->mFlags & kHasAltDataMask);
}
void SetOnStartTime(uint16_t aTime) { mRec->Get()->mOnStartTime = aTime; }
uint16_t GetOnStartTime() const { return mRec->Get()->mOnStartTime; }
void SetOnStopTime(uint16_t aTime) { mRec->Get()->mOnStopTime = aTime; }
uint16_t GetOnStopTime() const { return mRec->Get()->mOnStopTime; }
void SetContentType(uint8_t aType) { mRec->Get()->mContentType = aType; }
uint8_t GetContentType() const { return GetContentType(mRec->Get()); }
static uint8_t GetContentType(CacheIndexRecord* aRec) {
if (aRec->mContentType >= nsICacheEntry::CONTENT_TYPE_LAST) {
LOG(
("CacheIndexEntry::GetContentType() - Found invalid content type "
"[hash=%08x%08x%08x%08x%08x, contentType=%u]",
LOGSHA1(aRec->mHash), aRec->mContentType));
return nsICacheEntry::CONTENT_TYPE_UNKNOWN;
}
return aRec->mContentType;
}
// Sets filesize in kilobytes.
void SetFileSize(uint32_t aFileSize) {
if (aFileSize > kFileSizeMask) {
LOG(
("CacheIndexEntry::SetFileSize() - FileSize is too large, "
"truncating to %u",
kFileSizeMask));
aFileSize = kFileSizeMask;
}
mRec->Get()->mFlags &= ~kFileSizeMask;
mRec->Get()->mFlags |= aFileSize;
}
// Returns filesize in kilobytes.
uint32_t GetFileSize() const { return GetFileSize(*(mRec->Get())); }
static uint32_t GetFileSize(const CacheIndexRecord& aRec) {
return aRec.mFlags & kFileSizeMask;
}
static uint32_t IsPinned(CacheIndexRecord* aRec) {
return aRec->mFlags & kPinnedMask;
}
bool IsFileEmpty() const { return GetFileSize() == 0; }
void WriteToBuf(void* aBuf) {
uint8_t* ptr = static_cast<uint8_t*>(aBuf);
memcpy(ptr, mRec->Get()->mHash, sizeof(SHA1Sum::Hash));
ptr += sizeof(SHA1Sum::Hash);
NetworkEndian::writeUint32(ptr, mRec->Get()->mFrecency);
ptr += sizeof(uint32_t);
NetworkEndian::writeUint64(ptr, mRec->Get()->mOriginAttrsHash);
ptr += sizeof(uint64_t);
NetworkEndian::writeUint16(ptr, mRec->Get()->mOnStartTime);
ptr += sizeof(uint16_t);
NetworkEndian::writeUint16(ptr, mRec->Get()->mOnStopTime);
ptr += sizeof(uint16_t);
*ptr = mRec->Get()->mContentType;
ptr += sizeof(uint8_t);
// Dirty and fresh flags should never go to disk, since they make sense only
// during current session.
NetworkEndian::writeUint32(
ptr, mRec->Get()->mFlags & ~(kDirtyMask | kFreshMask));
}
void ReadFromBuf(void* aBuf) {
const uint8_t* ptr = static_cast<const uint8_t*>(aBuf);
MOZ_ASSERT(memcmp(&mRec->Get()->mHash, ptr, sizeof(SHA1Sum::Hash)) == 0);
ptr += sizeof(SHA1Sum::Hash);
mRec->Get()->mFrecency = NetworkEndian::readUint32(ptr);
ptr += sizeof(uint32_t);
mRec->Get()->mOriginAttrsHash = NetworkEndian::readUint64(ptr);
ptr += sizeof(uint64_t);
mRec->Get()->mOnStartTime = NetworkEndian::readUint16(ptr);
ptr += sizeof(uint16_t);
mRec->Get()->mOnStopTime = NetworkEndian::readUint16(ptr);
ptr += sizeof(uint16_t);
mRec->Get()->mContentType = *ptr;
ptr += sizeof(uint8_t);
mRec->Get()->mFlags = NetworkEndian::readUint32(ptr);
}
void Log() const {
LOG(
("CacheIndexEntry::Log() [this=%p, hash=%08x%08x%08x%08x%08x, fresh=%u,"
" initialized=%u, removed=%u, dirty=%u, anonymous=%u, "
"originAttrsHash=%" PRIx64 ", frecency=%u, hasAltData=%u, "
"onStartTime=%u, onStopTime=%u, contentType=%u, size=%u]",
this, LOGSHA1(mRec->Get()->mHash), IsFresh(), IsInitialized(),
IsRemoved(), IsDirty(), Anonymous(), OriginAttrsHash(), GetFrecency(),
GetHasAltData(), GetOnStartTime(), GetOnStopTime(), GetContentType(),
GetFileSize()));
}
static bool RecordMatchesLoadContextInfo(CacheIndexRecordWrapper* aRec,
nsILoadContextInfo* aInfo) {
MOZ_ASSERT(aInfo);
return !aInfo->IsPrivate() &&
GetOriginAttrsHash(*aInfo->OriginAttributesPtr()) ==
aRec->Get()->mOriginAttrsHash &&
aInfo->IsAnonymous() == !!(aRec->Get()->mFlags & kAnonymousMask);
}
// Memory reporting
size_t SizeOfExcludingThis(mozilla::MallocSizeOf mallocSizeOf) const {
return mallocSizeOf(mRec->Get());
}
size_t SizeOfIncludingThis(mozilla::MallocSizeOf mallocSizeOf) const {
return mallocSizeOf(this) + SizeOfExcludingThis(mallocSizeOf);
}
private:
friend class CacheIndexEntryUpdate;
friend class CacheIndex;
friend class CacheIndexEntryAutoManage;
friend struct CacheIndexRecord;
static const uint32_t kInitializedMask = 0x80000000;
static const uint32_t kAnonymousMask = 0x40000000;
// This flag is set when the entry was removed. We need to keep this
// information in memory until we write the index file.
static const uint32_t kRemovedMask = 0x20000000;
// This flag is set when the information in memory is not in sync with the
// information in index file on disk.
static const uint32_t kDirtyMask = 0x10000000;
// This flag is set when the information about the entry is fresh, i.e.
// we've created or opened this entry during this session, or we've seen
// this entry during update or build process.
static const uint32_t kFreshMask = 0x08000000;
// Indicates a pinned entry.
static const uint32_t kPinnedMask = 0x04000000;
// Indicates there is cached alternative data in the entry.
static const uint32_t kHasAltDataMask = 0x02000000;
static const uint32_t kReservedMask = 0x01000000;
// FileSize in kilobytes
static const uint32_t kFileSizeMask = 0x00FFFFFF;
RefPtr<CacheIndexRecordWrapper> mRec;
};
class CacheIndexEntryUpdate : public CacheIndexEntry {
public:
explicit CacheIndexEntryUpdate(CacheIndexEntry::KeyTypePointer aKey)
: CacheIndexEntry(aKey), mUpdateFlags(0) {
MOZ_COUNT_CTOR(CacheIndexEntryUpdate);
LOG(("CacheIndexEntryUpdate::CacheIndexEntryUpdate()"));
}
~CacheIndexEntryUpdate() {
MOZ_COUNT_DTOR(CacheIndexEntryUpdate);
LOG(("CacheIndexEntryUpdate::~CacheIndexEntryUpdate()"));
}
CacheIndexEntryUpdate& operator=(const CacheIndexEntry& aOther) {
MOZ_ASSERT(memcmp(&mRec->Get()->mHash, &aOther.mRec->Get()->mHash,
sizeof(SHA1Sum::Hash)) == 0);
mUpdateFlags = 0;
*(static_cast<CacheIndexEntry*>(this)) = aOther;
return *this;
}
void InitNew() {
mUpdateFlags = kFrecencyUpdatedMask | kHasAltDataUpdatedMask |
kOnStartTimeUpdatedMask | kOnStopTimeUpdatedMask |
kContentTypeUpdatedMask | kFileSizeUpdatedMask;
CacheIndexEntry::InitNew();
}
void SetFrecency(uint32_t aFrecency) {
mUpdateFlags |= kFrecencyUpdatedMask;
CacheIndexEntry::SetFrecency(aFrecency);
}
void SetHasAltData(bool aHasAltData) {
mUpdateFlags |= kHasAltDataUpdatedMask;
CacheIndexEntry::SetHasAltData(aHasAltData);
}
void SetOnStartTime(uint16_t aTime) {
mUpdateFlags |= kOnStartTimeUpdatedMask;
CacheIndexEntry::SetOnStartTime(aTime);
}
void SetOnStopTime(uint16_t aTime) {
mUpdateFlags |= kOnStopTimeUpdatedMask;
CacheIndexEntry::SetOnStopTime(aTime);
}
void SetContentType(uint8_t aType) {
mUpdateFlags |= kContentTypeUpdatedMask;
CacheIndexEntry::SetContentType(aType);
}
void SetFileSize(uint32_t aFileSize) {
mUpdateFlags |= kFileSizeUpdatedMask;
CacheIndexEntry::SetFileSize(aFileSize);
}
void ApplyUpdate(CacheIndexEntry* aDst) {
MOZ_ASSERT(memcmp(&mRec->Get()->mHash, &aDst->mRec->Get()->mHash,
sizeof(SHA1Sum::Hash)) == 0);
if (mUpdateFlags & kFrecencyUpdatedMask) {
aDst->mRec->Get()->mFrecency = mRec->Get()->mFrecency;
}
aDst->mRec->Get()->mOriginAttrsHash = mRec->Get()->mOriginAttrsHash;
if (mUpdateFlags & kOnStartTimeUpdatedMask) {
aDst->mRec->Get()->mOnStartTime = mRec->Get()->mOnStartTime;
}
if (mUpdateFlags & kOnStopTimeUpdatedMask) {
aDst->mRec->Get()->mOnStopTime = mRec->Get()->mOnStopTime;
}
if (mUpdateFlags & kContentTypeUpdatedMask) {
aDst->mRec->Get()->mContentType = mRec->Get()->mContentType;
}
if (mUpdateFlags & kHasAltDataUpdatedMask &&
((aDst->mRec->Get()->mFlags ^ mRec->Get()->mFlags) & kHasAltDataMask)) {
// Toggle the bit if we need to.
aDst->mRec->Get()->mFlags ^= kHasAltDataMask;
}
if (mUpdateFlags & kFileSizeUpdatedMask) {
// Copy all flags except |HasAltData|.
aDst->mRec->Get()->mFlags |= (mRec->Get()->mFlags & ~kHasAltDataMask);
} else {
// Copy all flags except |HasAltData| and file size.
aDst->mRec->Get()->mFlags &= kFileSizeMask;
aDst->mRec->Get()->mFlags |=
(mRec->Get()->mFlags & ~kHasAltDataMask & ~kFileSizeMask);
}
}
private:
static const uint32_t kFrecencyUpdatedMask = 0x00000001;
static const uint32_t kContentTypeUpdatedMask = 0x00000002;
static const uint32_t kFileSizeUpdatedMask = 0x00000004;
static const uint32_t kHasAltDataUpdatedMask = 0x00000008;
static const uint32_t kOnStartTimeUpdatedMask = 0x00000010;
static const uint32_t kOnStopTimeUpdatedMask = 0x00000020;
uint32_t mUpdateFlags;
};
class CacheIndexStats {
public:
CacheIndexStats() {
for (uint32_t i = 0; i < nsICacheEntry::CONTENT_TYPE_LAST; ++i) {
mCountByType[i] = 0;
mSizeByType[i] = 0;
}
}
bool operator==(const CacheIndexStats& aOther) const {
for (uint32_t i = 0; i < nsICacheEntry::CONTENT_TYPE_LAST; ++i) {
if (mCountByType[i] != aOther.mCountByType[i] ||
mSizeByType[i] != aOther.mSizeByType[i]) {
return false;
}
}
return
#ifdef DEBUG
aOther.mStateLogged == mStateLogged &&
#endif
aOther.mCount == mCount && aOther.mNotInitialized == mNotInitialized &&
aOther.mRemoved == mRemoved && aOther.mDirty == mDirty &&
aOther.mFresh == mFresh && aOther.mEmpty == mEmpty &&
aOther.mSize == mSize;
}
#ifdef DEBUG
void DisableLogging() { mDisableLogging = true; }
#endif
void Log() {
LOG(
("CacheIndexStats::Log() [count=%u, notInitialized=%u, removed=%u, "
"dirty=%u, fresh=%u, empty=%u, size=%u]",
mCount, mNotInitialized, mRemoved, mDirty, mFresh, mEmpty, mSize));
}
void Clear() {
MOZ_ASSERT(!mStateLogged, "CacheIndexStats::Clear() - state logged!");
mCount = 0;
mNotInitialized = 0;
mRemoved = 0;
mDirty = 0;
mFresh = 0;
mEmpty = 0;
mSize = 0;
for (uint32_t i = 0; i < nsICacheEntry::CONTENT_TYPE_LAST; ++i) {
mCountByType[i] = 0;
mSizeByType[i] = 0;
}
}
#ifdef DEBUG
bool StateLogged() { return mStateLogged; }
#endif
uint32_t Count() {
MOZ_ASSERT(!mStateLogged, "CacheIndexStats::Count() - state logged!");
return mCount;
}
uint32_t CountByType(uint8_t aContentType) {
MOZ_ASSERT(!mStateLogged, "CacheIndexStats::CountByType() - state logged!");
MOZ_RELEASE_ASSERT(aContentType < nsICacheEntry::CONTENT_TYPE_LAST);
return mCountByType[aContentType];
}
uint32_t Dirty() {
MOZ_ASSERT(!mStateLogged, "CacheIndexStats::Dirty() - state logged!");
return mDirty;
}
uint32_t Fresh() {
MOZ_ASSERT(!mStateLogged, "CacheIndexStats::Fresh() - state logged!");
return mFresh;
}
uint32_t ActiveEntriesCount() {
MOZ_ASSERT(!mStateLogged,
"CacheIndexStats::ActiveEntriesCount() - state "
"logged!");
return mCount - mRemoved - mNotInitialized - mEmpty;
}
uint32_t Size() {
MOZ_ASSERT(!mStateLogged, "CacheIndexStats::Size() - state logged!");
return mSize;
}
uint32_t SizeByType(uint8_t aContentType) {
MOZ_ASSERT(!mStateLogged, "CacheIndexStats::SizeByType() - state logged!");
MOZ_RELEASE_ASSERT(aContentType < nsICacheEntry::CONTENT_TYPE_LAST);
return mSizeByType[aContentType];
}
void BeforeChange(const CacheIndexEntry* aEntry) {
#ifdef DEBUG_STATS
if (!mDisableLogging) {
LOG(("CacheIndexStats::BeforeChange()"));
Log();
}
#endif
MOZ_ASSERT(!mStateLogged,
"CacheIndexStats::BeforeChange() - state "
"logged!");
#ifdef DEBUG
mStateLogged = true;
#endif
if (aEntry) {
MOZ_ASSERT(mCount);
uint8_t contentType = aEntry->GetContentType();
mCount--;
mCountByType[contentType]--;
if (aEntry->IsDirty()) {
MOZ_ASSERT(mDirty);
mDirty--;
}
if (aEntry->IsFresh()) {
MOZ_ASSERT(mFresh);
mFresh--;
}
if (aEntry->IsRemoved()) {
MOZ_ASSERT(mRemoved);
mRemoved--;
} else {
if (!aEntry->IsInitialized()) {
MOZ_ASSERT(mNotInitialized);
mNotInitialized--;
} else {
if (aEntry->IsFileEmpty()) {
MOZ_ASSERT(mEmpty);
mEmpty--;
} else {
MOZ_ASSERT(mSize >= aEntry->GetFileSize());
mSize -= aEntry->GetFileSize();
mSizeByType[contentType] -= aEntry->GetFileSize();
}
}
}
}
}
void AfterChange(const CacheIndexEntry* aEntry) {
MOZ_ASSERT(mStateLogged,
"CacheIndexStats::AfterChange() - state not "
"logged!");
#ifdef DEBUG
mStateLogged = false;
#endif
if (aEntry) {
uint8_t contentType = aEntry->GetContentType();
++mCount;
++mCountByType[contentType];
if (aEntry->IsDirty()) {
mDirty++;
}
if (aEntry->IsFresh()) {
mFresh++;
}
if (aEntry->IsRemoved()) {
mRemoved++;
} else {
if (!aEntry->IsInitialized()) {
mNotInitialized++;
} else {
if (aEntry->IsFileEmpty()) {
mEmpty++;
} else {
mSize += aEntry->GetFileSize();
mSizeByType[contentType] += aEntry->GetFileSize();
}
}
}
}
#ifdef DEBUG_STATS
if (!mDisableLogging) {
LOG(("CacheIndexStats::AfterChange()"));
Log();
}
#endif
}
private:
uint32_t mCount{0};
uint32_t mCountByType[nsICacheEntry::CONTENT_TYPE_LAST]{0};
uint32_t mNotInitialized{0};
uint32_t mRemoved{0};
uint32_t mDirty{0};
uint32_t mFresh{0};
uint32_t mEmpty{0};
uint32_t mSize{0};
uint32_t mSizeByType[nsICacheEntry::CONTENT_TYPE_LAST]{0};
#ifdef DEBUG
// We completely remove the data about an entry from the stats in
// BeforeChange() and set this flag to true. The entry is then modified,
// deleted or created and the data is again put into the stats and this flag
// set to false. Statistics must not be read during this time since the
// information is not correct.
bool mStateLogged{false};
// Disables logging in this instance of CacheIndexStats
bool mDisableLogging{false};
#endif
};
class CacheIndex final : public CacheFileIOListener, public nsIRunnable {
public:
NS_DECL_THREADSAFE_ISUPPORTS
NS_DECL_NSIRUNNABLE
CacheIndex();
static nsresult Init(nsIFile* aCacheDirectory);
static nsresult PreShutdown();
static nsresult Shutdown();
// Following methods can be called only on IO thread.
// Add entry to the index. The entry shouldn't be present in index. This
// method is called whenever a new handle for a new entry file is created. The
// newly created entry is not initialized and it must be either initialized
// with InitEntry() or removed with RemoveEntry().
static nsresult AddEntry(const SHA1Sum::Hash* aHash);
// Inform index about an existing entry that should be present in index. This
// method is called whenever a new handle for an existing entry file is
// created. Like in case of AddEntry(), either InitEntry() or RemoveEntry()
// must be called on the entry, since the entry is not initizlized if the
// index is outdated.
static nsresult EnsureEntryExists(const SHA1Sum::Hash* aHash);
// Initialize the entry. It MUST be present in index. Call to AddEntry() or
// EnsureEntryExists() must precede the call to this method.
static nsresult InitEntry(const SHA1Sum::Hash* aHash,
OriginAttrsHash aOriginAttrsHash, bool aAnonymous,
bool aPinned);
// Remove entry from index. The entry should be present in index.
static nsresult RemoveEntry(const SHA1Sum::Hash* aHash);
// Update some information in entry. The entry MUST be present in index and
// MUST be initialized. Call to AddEntry() or EnsureEntryExists() and to
// InitEntry() must precede the call to this method.
// Pass nullptr if the value didn't change.
static nsresult UpdateEntry(const SHA1Sum::Hash* aHash,
const uint32_t* aFrecency,
const bool* aHasAltData,
const uint16_t* aOnStartTime,
const uint16_t* aOnStopTime,
const uint8_t* aContentType,
const uint32_t* aSize);
// Remove all entries from the index. Called when clearing the whole cache.
static nsresult RemoveAll();
enum EntryStatus { EXISTS = 0, DOES_NOT_EXIST = 1, DO_NOT_KNOW = 2 };
// Returns status of the entry in index for the given key. It can be called
// on any thread.
// If the optional aCB callback is given, the it will be called with a
// CacheIndexEntry only if _retval is EXISTS when the method returns.
static nsresult HasEntry(
const nsACString& aKey, EntryStatus* _retval,
const std::function<void(const CacheIndexEntry*)>& aCB = nullptr);
static nsresult HasEntry(
const SHA1Sum::Hash& hash, EntryStatus* _retval,
const std::function<void(const CacheIndexEntry*)>& aCB = nullptr);
// Returns a hash of the least important entry that should be evicted if the
// cache size is over limit and also returns a total number of all entries in
// the index minus the number of forced valid entries and unpinned entries
// that we encounter when searching (see below)
static nsresult GetEntryForEviction(bool aIgnoreEmptyEntries,
SHA1Sum::Hash* aHash, uint32_t* aCnt);
// Checks if a cache entry is currently forced valid. Used to prevent an entry
// (that has been forced valid) from being evicted when the cache size reaches
// its limit.
static bool IsForcedValidEntry(const SHA1Sum::Hash* aHash);
// Returns cache size in kB.
static nsresult GetCacheSize(uint32_t* _retval);
// Returns number of entry files in the cache
static nsresult GetEntryFileCount(uint32_t* _retval);
// Synchronously returns the disk occupation and number of entries
// per-context. Callable on any thread. It will ignore loadContextInfo and get
// stats for all entries if the aInfo is a nullptr.
static nsresult GetCacheStats(nsILoadContextInfo* aInfo, uint32_t* aSize,
uint32_t* aCount);
// Asynchronously gets the disk cache size, used for display in the UI.
static nsresult AsyncGetDiskConsumption(
nsICacheStorageConsumptionObserver* aObserver);
// Returns an iterator that returns entries matching a given context that were
// present in the index at the time this method was called. If aAddNew is true
// then the iterator will also return entries created after this call.
// NOTE: When some entry is removed from index it is removed also from the
// iterator regardless what aAddNew was passed.
static nsresult GetIterator(nsILoadContextInfo* aInfo, bool aAddNew,
CacheIndexIterator** _retval);
// Returns true if we _think_ that the index is up to date. I.e. the state is
// READY or WRITING and mIndexNeedsUpdate as well as mShuttingDown is false.
static nsresult IsUpToDate(bool* _retval);
// Called from CacheStorageService::Clear() and
// CacheFileContextEvictor::EvictEntries(), sets a flag that blocks
// notification to AsyncGetDiskConsumption.
static void OnAsyncEviction(bool aEvicting);
// We keep track of total bytes written to the cache to be able to do
// a telemetry report after writting certain amount of data to the cache.
static void UpdateTotalBytesWritten(uint32_t aBytesWritten);
// Memory reporting
static size_t SizeOfExcludingThis(mozilla::MallocSizeOf mallocSizeOf);
static size_t SizeOfIncludingThis(mozilla::MallocSizeOf mallocSizeOf);
private:
friend class CacheIndexEntryAutoManage;
friend class FileOpenHelper;
friend class CacheIndexIterator;
friend class CacheIndexRecordWrapper;
friend class DeleteCacheIndexRecordWrapper;
virtual ~CacheIndex();
NS_IMETHOD OnFileOpened(CacheFileHandle* aHandle, nsresult aResult) override;
void OnFileOpenedInternal(FileOpenHelper* aOpener, CacheFileHandle* aHandle,
nsresult aResult,
const StaticMutexAutoLock& aProofOfLock)
MOZ_REQUIRES(sLock);
NS_IMETHOD OnDataWritten(CacheFileHandle* aHandle, const char* aBuf,
nsresult aResult) override;
NS_IMETHOD OnDataRead(CacheFileHandle* aHandle, char* aBuf,
nsresult aResult) override;
NS_IMETHOD OnFileDoomed(CacheFileHandle* aHandle, nsresult aResult) override;
NS_IMETHOD OnEOFSet(CacheFileHandle* aHandle, nsresult aResult) override;
NS_IMETHOD OnFileRenamed(CacheFileHandle* aHandle, nsresult aResult) override;
nsresult InitInternal(nsIFile* aCacheDirectory,
const StaticMutexAutoLock& aProofOfLock);
void PreShutdownInternal();
// This method returns false when index is not initialized or is shut down.
bool IsIndexUsable() MOZ_REQUIRES(sLock);
// This method checks whether the entry has the same values of
// originAttributes and isAnonymous. We don't expect to find a collision
// since these values are part of the key that we hash and we use a strong
// hash function.
static bool IsCollision(CacheIndexEntry* aEntry,
OriginAttrsHash aOriginAttrsHash, bool aAnonymous);
// Checks whether any of the information about the entry has changed.
static bool HasEntryChanged(CacheIndexEntry* aEntry,
const uint32_t* aFrecency,
const bool* aHasAltData,
const uint16_t* aOnStartTime,
const uint16_t* aOnStopTime,
const uint8_t* aContentType,
const uint32_t* aSize);
// Merge all pending operations from mPendingUpdates into mIndex.
void ProcessPendingOperations(const StaticMutexAutoLock& aProofOfLock)
MOZ_REQUIRES(sLock);
// Following methods perform writing of the index file.
//
// The index is written periodically, but not earlier than once in
// kMinDumpInterval and there must be at least kMinUnwrittenChanges
// differences between index on disk and in memory. Index is always first
// written to a temporary file and the old index file is replaced when the
// writing process succeeds.
//
// Starts writing of index when both limits (minimal delay between writes and
// minimum number of changes in index) were exceeded.
bool WriteIndexToDiskIfNeeded(const StaticMutexAutoLock& aProofOfLock)
MOZ_REQUIRES(sLock);
// Starts writing of index file.
void WriteIndexToDisk(const StaticMutexAutoLock& aProofOfLock)
MOZ_REQUIRES(sLock);
// Serializes part of mIndex hashtable to the write buffer a writes the buffer
// to the file.
void WriteRecords(const StaticMutexAutoLock& aProofOfLock)
MOZ_REQUIRES(sLock);
// Finalizes writing process.
void FinishWrite(bool aSucceeded, const StaticMutexAutoLock& aProofOfLock)
MOZ_REQUIRES(sLock);
// Following methods perform writing of the journal during shutdown. All these
// methods must be called only during shutdown since they write/delete files
// directly on the main thread instead of using CacheFileIOManager that does
// it asynchronously on IO thread. Journal contains only entries that are
// dirty, i.e. changes that are not present in the index file on the disk.
// When the log is written successfully, the dirty flag in index file is
// cleared.
nsresult GetFile(const nsACString& aName, nsIFile** _retval);
void RemoveFile(const nsACString& aName) MOZ_REQUIRES(sLock);
void RemoveAllIndexFiles() MOZ_REQUIRES(sLock);
void RemoveJournalAndTempFile() MOZ_REQUIRES(sLock);
// Writes journal to the disk and clears dirty flag in index header.
nsresult WriteLogToDisk() MOZ_REQUIRES(sLock);
// Following methods perform reading of the index from the disk.
//
// Index is read at startup just after initializing the CacheIndex. There are
// 3 files used when manipulating with index: index file, journal file and
// a temporary file. All files contain the hash of the data, so we can check
// whether the content is valid and complete. Index file contains also a dirty
// flag in the index header which is unset on a clean shutdown. During opening
// and reading of the files we determine the status of the whole index from
// the states of the separate files. Following table shows all possible
// combinations:
//
// index, journal, tmpfile
// M * * - index is missing -> BUILD
// I * * - index is invalid -> BUILD
// D * * - index is dirty -> UPDATE
// C M * - index is dirty -> UPDATE
// C I * - unexpected state -> UPDATE
// C V E - unexpected state -> UPDATE
// C V M - index is up to date -> READY
//
// where the letters mean:
// * - any state
// E - file exists
// M - file is missing
// I - data is invalid (parsing failed or hash didn't match)
// D - dirty (data in index file is correct, but dirty flag is set)
// C - clean (index file is clean)
// V - valid (data in journal file is correct)
//
// Note: We accept the data from journal only when the index is up to date as
// a whole (i.e. C,V,M state).
//
// We rename the journal file to the temporary file as soon as possible after
// initial test to ensure that we start update process on the next startup if
// FF crashes during parsing of the index.
//
// Initiates reading index from disk.
void ReadIndexFromDisk(const StaticMutexAutoLock& aProofOfLock)
MOZ_REQUIRES(sLock);
// Starts reading data from index file.
void StartReadingIndex(const StaticMutexAutoLock& aProofOfLock)
MOZ_REQUIRES(sLock);
// Parses data read from index file.
void ParseRecords(const StaticMutexAutoLock& aProofOfLock)
MOZ_REQUIRES(sLock);
// Starts reading data from journal file.
void StartReadingJournal(const StaticMutexAutoLock& aProofOfLock)
MOZ_REQUIRES(sLock);
// Parses data read from journal file.
void ParseJournal(const StaticMutexAutoLock& aProofOfLock)
MOZ_REQUIRES(sLock);
// Merges entries from journal into mIndex.
void MergeJournal(const StaticMutexAutoLock& aProofOfLock)
MOZ_REQUIRES(sLock);
// In debug build this method checks that we have no fresh entry in mIndex
// after we finish reading index and before we process pending operations.
void EnsureNoFreshEntry() MOZ_REQUIRES(sLock);
// In debug build this method is called after processing pending operations
// to make sure mIndexStats contains correct information.
void EnsureCorrectStats() MOZ_REQUIRES(sLock);
// Finalizes reading process.
void FinishRead(bool aSucceeded, const StaticMutexAutoLock& aProofOfLock)
MOZ_REQUIRES(sLock);
// Following methods perform updating and building of the index.
// Timer callback that starts update or build process.
static void DelayedUpdate(nsITimer* aTimer, void* aClosure);
void DelayedUpdateLocked(const StaticMutexAutoLock& aProofOfLock)
MOZ_REQUIRES(sLock);
// Posts timer event that start update or build process.
nsresult ScheduleUpdateTimer(uint32_t aDelay) MOZ_REQUIRES(sLock);
nsresult SetupDirectoryEnumerator() MOZ_REQUIRES(sLock);
nsresult InitEntryFromDiskData(CacheIndexEntry* aEntry,
CacheFileMetadata* aMetaData,
int64_t aFileSize);
// Returns true when either a timer is scheduled or event is posted.
bool IsUpdatePending() MOZ_REQUIRES(sLock);
// Iterates through all files in entries directory that we didn't create/open
// during this session, parses them and adds the entries to the index.
void BuildIndex(const StaticMutexAutoLock& aProofOfLock) MOZ_REQUIRES(sLock);
bool StartUpdatingIndexIfNeeded(const StaticMutexAutoLock& aProofOfLock,
bool aSwitchingToReadyState = false);
// Starts update or build process or fires a timer when it is too early after
// startup.
void StartUpdatingIndex(bool aRebuild,
const StaticMutexAutoLock& aProofOfLock)
MOZ_REQUIRES(sLock);
// Iterates through all files in entries directory that we didn't create/open
// during this session and theirs last modified time is newer than timestamp
// in the index header. Parses the files and adds the entries to the index.
void UpdateIndex(const StaticMutexAutoLock& aProofOfLock) MOZ_REQUIRES(sLock);
// Finalizes update or build process.
void FinishUpdate(bool aSucceeded, const StaticMutexAutoLock& aProofOfLock)
MOZ_REQUIRES(sLock);
void RemoveNonFreshEntries(const StaticMutexAutoLock& aProofOfLock)
MOZ_REQUIRES(sLock);
enum EState {