Bug 1032254 - Provide a way to pin resources in the http cache r=honzab

--HG--
rename : netwerk/test/unit/test_cache2-28-concurrent_read_resumable_entry_size_zero.js => netwerk/test/unit/test_cache2-29a-concurrent_read_resumable_entry_size_zero.js
rename : netwerk/test/unit/test_cache2-29-concurrent_read_non-resumable_entry_size_zero.js => netwerk/test/unit/test_cache2-29b-concurrent_read_non-resumable_entry_size_zero.js

Author: valenting

netwerk/base/nsICachingChannel.idl

@@ -17,7 +17,7 @@ interface nsIFile;
  *   3) Support for uniquely identifying cached data in cases when the URL
  *      is insufficient (e.g., HTTP form submission).
  */
-[scriptable, uuid(436b939d-e391-48e5-ba64-ab0e496e3400)]
+[scriptable, uuid(dd1d6122-5ecf-4fe4-8f0f-995e7ab3121a)]
 interface nsICachingChannel : nsICacheInfoChannel
 {
     /**
@@ -53,6 +53,11 @@ interface nsICachingChannel : nsICacheInfoChannel
      */
     attribute boolean cacheOnlyMetadata;
 
+    /**
+     * Tells the channel to use the pinning storage.
+     */
+    attribute boolean pin;
+
     /**************************************************************************
      * Caching channel specific load flags:
      */

netwerk/cache2/CacheEntry.cpp

@@ -163,7 +163,8 @@ NS_IMPL_ISUPPORTS(CacheEntry,
 CacheEntry::CacheEntry(const nsACString& aStorageID,
                        nsIURI* aURI,
                        const nsACString& aEnhanceID,
-                       bool aUseDisk)
+                       bool aUseDisk,
+                       uint32_t aPinningAppId)
 : mFrecency(0)
 , mSortingExpirationTime(uint32_t(-1))
 , mLock("CacheEntry")
@@ -172,6 +173,7 @@ CacheEntry::CacheEntry(const nsACString& aStorageID,
 , mEnhanceID(aEnhanceID)
 , mStorageID(aStorageID)
 , mUseDisk(aUseDisk)
+, mPinningAppId(aPinningAppId)
 , mIsDoomed(false)
 , mSecurityInfoLoaded(false)
 , mPreventCallbacks(false)
@@ -341,7 +343,8 @@ bool CacheEntry::Load(bool aTruncate, bool aPriority)
   //    as a new one.
   // 2. When this is a memory-only entry, check there is a disk file.
   //    If there is or could be, doom that file.
-  if ((!aTruncate || !mUseDisk) && NS_SUCCEEDED(rv)) {
+  if ((!aTruncate || !mUseDisk) && NS_SUCCEEDED(rv) &&
+      !mPinningAppId) {
     // Check the index right now to know we have or have not the entry
     // as soon as possible.
     CacheIndex::EntryStatus status;
@@ -391,6 +394,7 @@ bool CacheEntry::Load(bool aTruncate, bool aPriority)
       rv = mFile->Init(fileKey,
                        aTruncate,
                        !mUseDisk,
+                       mPinningAppId,
                        aPriority,
                        directLoad ? nullptr : this);
     }
@@ -486,6 +490,7 @@ already_AddRefed<CacheEntryHandle> CacheEntry::ReopenTruncated(bool aMemoryOnly,
     nsresult rv = CacheStorageService::Self()->AddStorageEntry(
       GetStorageID(), GetURI(), GetEnhanceID(),
       mUseDisk && !aMemoryOnly,
+      mPinningAppId,
       true, // always create
       true, // truncate existing (this one)
       getter_AddRefs(handle));

netwerk/cache2/CacheEntry.h

@@ -55,7 +55,7 @@ class CacheEntry final : public nsICacheEntry
   NS_DECL_NSIRUNNABLE
 
   CacheEntry(const nsACString& aStorageID, nsIURI* aURI, const nsACString& aEnhanceID,
-             bool aUseDisk);
+             bool aUseDisk, uint32_t aPinningAppId);
 
   void AsyncOpen(nsICacheEntryOpenCallback* aCallback, uint32_t aFlags);
 
@@ -276,6 +276,9 @@ class CacheEntry final : public nsICacheEntry
   // Whether it's allowed to persist the data to disk
   bool const mUseDisk;
 
+  // AppId of an app that wants this entry be pinned
+  uint32_t const mPinningAppId;
+
   // Set when entry is doomed with AsyncDoom() or DoomAlreadyRemoved().
   // Left as a standalone flag to not bother with locking (there is no need).
   bool mIsDoomed;

netwerk/cache2/CacheFile.cpp

@@ -212,6 +212,7 @@ nsresult
 CacheFile::Init(const nsACString &aKey,
                 bool aCreateNew,
                 bool aMemoryOnly,
+                uint32_t aPinningAppID,
                 bool aPriority,
                 CacheFileListener *aCallback)
 {
@@ -266,7 +267,7 @@ CacheFile::Init(const nsACString &aKey,
 
     mOpeningFile = true;
     mListener = aCallback;
-    rv = CacheFileIOManager::OpenFile(mKey, flags, this);
+    rv = CacheFileIOManager::OpenFile(mKey, aPinningAppID, flags, this);
     if (NS_FAILED(rv)) {
       mListener = nullptr;
       mOpeningFile = false;

netwerk/cache2/CacheFile.h

@@ -56,6 +56,7 @@ class CacheFile final : public CacheFileChunkListener
   nsresult Init(const nsACString &aKey,
                 bool aCreateNew,
                 bool aMemoryOnly,
+                uint32_t aPinningAppID,
                 bool aPriority,
                 CacheFileListener *aCallback);
 
@@ -103,6 +104,10 @@ class CacheFile final : public CacheFileChunkListener
   void Key(nsACString& aKey) { aKey = mKey; }
   bool IsDoomed();
   bool IsWriteInProgress();
+  CacheFileIOManager* Manager()
+  {
+    return mHandle ? mHandle->Manager() : nullptr;
+  }
 
   // Memory reporting
   size_t SizeOfExcludingThis(mozilla::MallocSizeOf mallocSizeOf) const;

netwerk/cache2/CacheFileContextEvictor.cpp

@@ -398,7 +398,7 @@ CacheFileContextEvictor::GetContextFile(nsILoadContextInfo *aLoadContextInfo,
   leafName.AssignLiteral(CONTEXT_EVICTION_PREFIX);
 
   nsAutoCString keyPrefix;
-  CacheFileUtils::AppendKeyPrefix(aLoadContextInfo, keyPrefix);
+  CacheFileUtils::AppendKeyPrefix(aLoadContextInfo, false, keyPrefix);
 
   nsAutoCString data64;
   rv = Base64Encode(keyPrefix, data64);