michael@0: /* This Source Code Form is subject to the terms of the Mozilla Public michael@0: * License, v. 2.0. If a copy of the MPL was not distributed with this michael@0: * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ michael@0: michael@0: #ifndef CacheFileMetadata__h__ michael@0: #define CacheFileMetadata__h__ michael@0: michael@0: #include "CacheFileIOManager.h" michael@0: #include "CacheStorageService.h" michael@0: #include "CacheHashUtils.h" michael@0: #include "CacheObserver.h" michael@0: #include "mozilla/Endian.h" michael@0: #include "nsAutoPtr.h" michael@0: #include "nsString.h" michael@0: michael@0: namespace mozilla { michael@0: namespace net { michael@0: michael@0: // By multiplying with the current half-life we convert the frecency michael@0: // to time independent of half-life value. The range fits 32bits. michael@0: // When decay time changes on next run of the browser, we convert michael@0: // the frecency value to a correct internal representation again. michael@0: // It might not be 100% accurate, but for the purpose it suffice. michael@0: #define FRECENCY2INT(aFrecency) \ michael@0: ((uint32_t)(aFrecency * CacheObserver::HalfLifeSeconds())) michael@0: #define INT2FRECENCY(aInt) \ michael@0: ((double)(aInt) / (double)CacheObserver::HalfLifeSeconds()) michael@0: michael@0: michael@0: #pragma pack(push) michael@0: #pragma pack(1) michael@0: michael@0: class CacheFileMetadataHeader { michael@0: public: michael@0: uint32_t mVersion; michael@0: uint32_t mFetchCount; michael@0: uint32_t mLastFetched; michael@0: uint32_t mLastModified; michael@0: uint32_t mFrecency; michael@0: uint32_t mExpirationTime; michael@0: uint32_t mKeySize; michael@0: michael@0: void WriteToBuf(void *aBuf) michael@0: { michael@0: EnsureCorrectClassSize(); michael@0: michael@0: uint8_t* ptr = static_cast(aBuf); michael@0: NetworkEndian::writeUint32(ptr, mVersion); ptr += sizeof(uint32_t); michael@0: NetworkEndian::writeUint32(ptr, mFetchCount); ptr += sizeof(uint32_t); michael@0: NetworkEndian::writeUint32(ptr, mLastFetched); ptr += sizeof(uint32_t); michael@0: NetworkEndian::writeUint32(ptr, mLastModified); ptr += sizeof(uint32_t); michael@0: NetworkEndian::writeUint32(ptr, mFrecency); ptr += sizeof(uint32_t); michael@0: NetworkEndian::writeUint32(ptr, mExpirationTime); ptr += sizeof(uint32_t); michael@0: NetworkEndian::writeUint32(ptr, mKeySize); michael@0: } michael@0: michael@0: void ReadFromBuf(const void *aBuf) michael@0: { michael@0: EnsureCorrectClassSize(); michael@0: michael@0: const uint8_t* ptr = static_cast(aBuf); michael@0: mVersion = BigEndian::readUint32(ptr); ptr += sizeof(uint32_t); michael@0: mFetchCount = BigEndian::readUint32(ptr); ptr += sizeof(uint32_t); michael@0: mLastFetched = BigEndian::readUint32(ptr); ptr += sizeof(uint32_t); michael@0: mLastModified = BigEndian::readUint32(ptr); ptr += sizeof(uint32_t); michael@0: mFrecency = BigEndian::readUint32(ptr); ptr += sizeof(uint32_t); michael@0: mExpirationTime = BigEndian::readUint32(ptr); ptr += sizeof(uint32_t); michael@0: mKeySize = BigEndian::readUint32(ptr); michael@0: } michael@0: michael@0: inline void EnsureCorrectClassSize() michael@0: { michael@0: static_assert((sizeof(mVersion) + sizeof(mFetchCount) + michael@0: sizeof(mLastFetched) + sizeof(mLastModified) + sizeof(mFrecency) + michael@0: sizeof(mExpirationTime) + sizeof(mKeySize)) == michael@0: sizeof(CacheFileMetadataHeader), michael@0: "Unexpected sizeof(CacheFileMetadataHeader)!"); michael@0: } michael@0: }; michael@0: michael@0: #pragma pack(pop) michael@0: michael@0: michael@0: #define CACHEFILEMETADATALISTENER_IID \ michael@0: { /* a9e36125-3f01-4020-9540-9dafa8d31ba7 */ \ michael@0: 0xa9e36125, \ michael@0: 0x3f01, \ michael@0: 0x4020, \ michael@0: {0x95, 0x40, 0x9d, 0xaf, 0xa8, 0xd3, 0x1b, 0xa7} \ michael@0: } michael@0: michael@0: class CacheFileMetadataListener : public nsISupports michael@0: { michael@0: public: michael@0: NS_DECLARE_STATIC_IID_ACCESSOR(CACHEFILEMETADATALISTENER_IID) michael@0: michael@0: NS_IMETHOD OnMetadataRead(nsresult aResult) = 0; michael@0: NS_IMETHOD OnMetadataWritten(nsresult aResult) = 0; michael@0: }; michael@0: michael@0: NS_DEFINE_STATIC_IID_ACCESSOR(CacheFileMetadataListener, michael@0: CACHEFILEMETADATALISTENER_IID) michael@0: michael@0: michael@0: class CacheFileMetadata : public CacheFileIOListener michael@0: , public CacheMemoryConsumer michael@0: { michael@0: public: michael@0: NS_DECL_THREADSAFE_ISUPPORTS michael@0: michael@0: CacheFileMetadata(CacheFileHandle *aHandle, michael@0: const nsACString &aKey); michael@0: CacheFileMetadata(bool aMemoryOnly, michael@0: const nsACString &aKey); michael@0: CacheFileMetadata(); michael@0: michael@0: void SetHandle(CacheFileHandle *aHandle); michael@0: michael@0: nsresult GetKey(nsACString &_retval); michael@0: michael@0: nsresult ReadMetadata(CacheFileMetadataListener *aListener); michael@0: nsresult WriteMetadata(uint32_t aOffset, michael@0: CacheFileMetadataListener *aListener); michael@0: nsresult SyncReadMetadata(nsIFile *aFile); michael@0: michael@0: bool IsAnonymous() { return mAnonymous; } michael@0: bool IsInBrowser() { return mInBrowser; } michael@0: uint32_t AppId() { return mAppId; } michael@0: michael@0: const char * GetElement(const char *aKey); michael@0: nsresult SetElement(const char *aKey, const char *aValue); michael@0: michael@0: CacheHash::Hash16_t GetHash(uint32_t aIndex); michael@0: nsresult SetHash(uint32_t aIndex, CacheHash::Hash16_t aHash); michael@0: michael@0: nsresult SetExpirationTime(uint32_t aExpirationTime); michael@0: nsresult GetExpirationTime(uint32_t *_retval); michael@0: nsresult SetLastModified(uint32_t aLastModified); michael@0: nsresult GetLastModified(uint32_t *_retval); michael@0: nsresult SetFrecency(uint32_t aFrecency); michael@0: nsresult GetFrecency(uint32_t *_retval); michael@0: nsresult GetLastFetched(uint32_t *_retval); michael@0: nsresult GetFetchCount(uint32_t *_retval); michael@0: michael@0: int64_t Offset() { return mOffset; } michael@0: uint32_t ElementsSize() { return mElementsSize; } michael@0: void MarkDirty() { mIsDirty = true; } michael@0: bool IsDirty() { return mIsDirty; } michael@0: uint32_t MemoryUsage() { return sizeof(CacheFileMetadata) + mHashArraySize + mBufSize; } michael@0: michael@0: NS_IMETHOD OnFileOpened(CacheFileHandle *aHandle, nsresult aResult); michael@0: NS_IMETHOD OnDataWritten(CacheFileHandle *aHandle, const char *aBuf, michael@0: nsresult aResult); michael@0: NS_IMETHOD OnDataRead(CacheFileHandle *aHandle, char *aBuf, nsresult aResult); michael@0: NS_IMETHOD OnFileDoomed(CacheFileHandle *aHandle, nsresult aResult); michael@0: NS_IMETHOD OnEOFSet(CacheFileHandle *aHandle, nsresult aResult); michael@0: NS_IMETHOD OnFileRenamed(CacheFileHandle *aHandle, nsresult aResult); michael@0: michael@0: // Memory reporting michael@0: size_t SizeOfExcludingThis(mozilla::MallocSizeOf mallocSizeOf) const; michael@0: size_t SizeOfIncludingThis(mozilla::MallocSizeOf mallocSizeOf) const; michael@0: michael@0: private: michael@0: virtual ~CacheFileMetadata(); michael@0: michael@0: void InitEmptyMetadata(); michael@0: nsresult ParseMetadata(uint32_t aMetaOffset, uint32_t aBufOffset, bool aHaveKey); michael@0: nsresult CheckElements(const char *aBuf, uint32_t aSize); michael@0: void EnsureBuffer(uint32_t aSize); michael@0: nsresult ParseKey(const nsACString &aKey); michael@0: michael@0: nsRefPtr mHandle; michael@0: nsCString mKey; michael@0: CacheHash::Hash16_t *mHashArray; michael@0: uint32_t mHashArraySize; michael@0: uint32_t mHashCount; michael@0: int64_t mOffset; michael@0: char *mBuf; // used for parsing, then points michael@0: // to elements michael@0: uint32_t mBufSize; michael@0: char *mWriteBuf; michael@0: CacheFileMetadataHeader mMetaHdr; michael@0: uint32_t mElementsSize; michael@0: bool mIsDirty; michael@0: bool mAnonymous; michael@0: bool mInBrowser; michael@0: uint32_t mAppId; michael@0: nsCOMPtr mListener; michael@0: }; michael@0: michael@0: michael@0: } // net michael@0: } // mozilla michael@0: michael@0: #endif