src/third_party/WebKit/Source/modules/webdatabase/DatabaseTracker.h

   1 /*
   2  * Copyright (C) 2007, 2008, 2013 Apple Inc. All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions
   6  * are met:
   7  *
   8  * 1.  Redistributions of source code must retain the above copyright
   9  *     notice, this list of conditions and the following disclaimer.
  10  * 2.  Redistributions in binary form must reproduce the above copyright
  11  *     notice, this list of conditions and the following disclaimer in the
  12  *     documentation and/or other materials provided with the distribution.
  13  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
  14  *     its contributors may be used to endorse or promote products derived
  15  *     from this software without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
  18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
  21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  */
  28
  29 #ifndef DatabaseTracker_h
  30 #define DatabaseTracker_h
  31
  32 #include "modules/webdatabase/DatabaseError.h"
  33 #include "wtf/HashMap.h"
  34 #include "wtf/HashSet.h"
  35 #include "wtf/ThreadingPrimitives.h"
  36 #include "wtf/text/StringHash.h"
  37 #include "wtf/text/WTFString.h"
  38
  39 namespace blink {
  40
  41 class DatabaseBackendBase;
  42 class DatabaseContext;
  43 class OriginLock;
  44 class SecurityOrigin;
  45
  46 class DatabaseTracker {
  47     WTF_MAKE_NONCOPYABLE(DatabaseTracker); WTF_MAKE_FAST_ALLOCATED;
  48 public:
  49     static DatabaseTracker& tracker();
  50     // This singleton will potentially be used from multiple worker threads and the page's context thread simultaneously.  To keep this safe, it's
  51     // currently using 4 locks.  In order to avoid deadlock when taking multiple locks, you must take them in the correct order:
  52     // m_databaseGuard before quotaManager if both locks are needed.
  53     // m_openDatabaseMapGuard before quotaManager if both locks are needed.
  54     // m_databaseGuard and m_openDatabaseMapGuard currently don't overlap.
  55     // notificationMutex() is currently independent of the other locks.
  56
  57     bool canEstablishDatabase(DatabaseContext*, const String& name, const String& displayName, unsigned long estimatedSize, DatabaseError&);
  58     String fullPathForDatabase(SecurityOrigin*, const String& name, bool createIfDoesNotExist = true);
  59
  60     void addOpenDatabase(DatabaseBackendBase*);
  61     void removeOpenDatabase(DatabaseBackendBase*);
  62
  63     unsigned long long getMaxSizeForDatabase(const DatabaseBackendBase*);
  64
  65     void interruptAllDatabasesForContext(const DatabaseContext*);
  66     void closeDatabasesImmediately(const String& originIdentifier, const String& name);
  67
  68     void prepareToOpenDatabase(DatabaseBackendBase*);
  69     void failedToOpenDatabase(DatabaseBackendBase*);
  70
  71 private:
  72     typedef HashSet<DatabaseBackendBase*> DatabaseSet;
  73     typedef HashMap<String, DatabaseSet*> DatabaseNameMap;
  74     typedef HashMap<String, DatabaseNameMap*> DatabaseOriginMap;
  75     class CloseOneDatabaseImmediatelyTask;
  76
  77     DatabaseTracker();
  78
  79     void closeOneDatabaseImmediately(const String& originIdentifier, const String& name, DatabaseBackendBase*);
  80
  81     Mutex m_openDatabaseMapGuard;
  82     mutable OwnPtr<DatabaseOriginMap> m_openDatabaseMap;
  83 };
  84
  85 } // namespace blink
  86
  87 #endif // DatabaseTracker_h