// Copyright (c) ppy Pty Ltd . Licensed under the MIT Licence. // See the LICENCE file in the repository root for full licence text. using System.Threading; using osu.Framework.Logging; using osu.Framework.Platform; using osu.Framework.Statistics; using Realms; namespace osu.Game.Database { public class RealmContextFactory : IRealmFactory { private readonly Storage storage; private const string database_name = @"client"; private const int schema_version = 5; private readonly ThreadLocal threadContexts; /// /// Lock object which is held for the duration of a write operation (via ). /// private readonly object writeLock = new object(); private ThreadLocal refreshCompleted = new ThreadLocal(); private bool rollbackRequired; private int currentWriteUsages; private Transaction currentWriteTransaction; public RealmContextFactory(Storage storage) { this.storage = storage; threadContexts = new ThreadLocal(createContext, true); // creating a context will ensure our schema is up-to-date and migrated. var realm = Get(); Logger.Log($"Opened realm \"{realm.Config.DatabasePath}\" at version {realm.Config.SchemaVersion}"); } private void onMigration(Migration migration, ulong lastSchemaVersion) { } private static readonly GlobalStatistic reads = GlobalStatistics.Get("Realm", "Get (Read)"); private static readonly GlobalStatistic writes = GlobalStatistics.Get("Realm", "Get (Write)"); private static readonly GlobalStatistic commits = GlobalStatistics.Get("Realm", "Commits"); private static readonly GlobalStatistic rollbacks = GlobalStatistics.Get("Realm", "Rollbacks"); private static readonly GlobalStatistic contexts_open = GlobalStatistics.Get("Realm", "Contexts (Open)"); private static readonly GlobalStatistic contexts_created = GlobalStatistics.Get("Realm", "Contexts (Created)"); /// /// Get a context for the current thread for read-only usage. /// If a is in progress, the existing write-safe context will be returned. /// public Realm Get() { reads.Value++; return getContextForCurrentThread(); } /// /// Request a context for write usage. Can be consumed in a nested fashion (and will return the same underlying context). /// This method may block if a write is already active on a different thread. /// /// A usage containing a usable context. public RealmWriteUsage GetForWrite() { writes.Value++; Monitor.Enter(writeLock); Realm context; try { context = getContextForCurrentThread(); currentWriteTransaction ??= context.BeginWrite(); } catch { // retrieval of a context could trigger a fatal error. Monitor.Exit(writeLock); throw; } Interlocked.Increment(ref currentWriteUsages); return new RealmWriteUsage(context, usageCompleted) { IsTransactionLeader = currentWriteTransaction != null && currentWriteUsages == 1 }; } private Realm getContextForCurrentThread() { var context = threadContexts.Value; if (context?.IsClosed != false) threadContexts.Value = context = createContext(); contexts_open.Value = threadContexts.Values.Count; if (!refreshCompleted.Value) { // to keep things simple, realm refreshes are currently performed per thread context at the point of retrieval. // in the future this should likely be run as part of the update loop for the main (update thread) context. context.Refresh(); refreshCompleted.Value = true; } return context; } private Realm createContext() { contexts_created.Value++; return Realm.GetInstance(new RealmConfiguration(storage.GetFullPath($"{database_name}.realm", true)) { SchemaVersion = schema_version, MigrationCallback = onMigration, }); } private void usageCompleted(RealmWriteUsage usage) { int usages = Interlocked.Decrement(ref currentWriteUsages); try { rollbackRequired |= usage.RollbackRequired; if (usages == 0) { if (rollbackRequired) { rollbacks.Value++; currentWriteTransaction?.Rollback(); } else { commits.Value++; currentWriteTransaction?.Commit(); } currentWriteTransaction = null; rollbackRequired = false; refreshCompleted = new ThreadLocal(); } } finally { Monitor.Exit(writeLock); } } } }