diff options
Diffstat (limited to 'services/core/java/com/android/server/content/SyncQueue.java')
-rw-r--r-- | services/core/java/com/android/server/content/SyncQueue.java | 230 |
1 files changed, 230 insertions, 0 deletions
diff --git a/services/core/java/com/android/server/content/SyncQueue.java b/services/core/java/com/android/server/content/SyncQueue.java new file mode 100644 index 0000000..6f3fe6e --- /dev/null +++ b/services/core/java/com/android/server/content/SyncQueue.java @@ -0,0 +1,230 @@ +/* + * Copyright (C) 2010 The Android Open Source Project + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.android.server.content; + +import android.accounts.Account; +import android.content.pm.PackageManager; +import android.content.pm.RegisteredServicesCache; +import android.content.SyncAdapterType; +import android.content.SyncAdaptersCache; +import android.content.pm.RegisteredServicesCache.ServiceInfo; +import android.os.SystemClock; +import android.text.format.DateUtils; +import android.util.Log; +import android.util.Pair; + +import com.google.android.collect.Maps; + +import java.util.ArrayList; +import java.util.Collection; +import java.util.HashMap; +import java.util.Iterator; +import java.util.Map; + +/** + * Queue of pending sync operations. Not inherently thread safe, external + * callers are responsible for locking. + * + * @hide + */ +public class SyncQueue { + private static final String TAG = "SyncManager"; + private final SyncStorageEngine mSyncStorageEngine; + private final SyncAdaptersCache mSyncAdapters; + private final PackageManager mPackageManager; + + // A Map of SyncOperations operationKey -> SyncOperation that is designed for + // quick lookup of an enqueued SyncOperation. + private final HashMap<String, SyncOperation> mOperationsMap = Maps.newHashMap(); + + public SyncQueue(PackageManager packageManager, SyncStorageEngine syncStorageEngine, + final SyncAdaptersCache syncAdapters) { + mPackageManager = packageManager; + mSyncStorageEngine = syncStorageEngine; + mSyncAdapters = syncAdapters; + } + + public void addPendingOperations(int userId) { + for (SyncStorageEngine.PendingOperation op : mSyncStorageEngine.getPendingOperations()) { + if (op.userId != userId) continue; + + final Pair<Long, Long> backoff = mSyncStorageEngine.getBackoff( + op.account, op.userId, op.authority); + final ServiceInfo<SyncAdapterType> syncAdapterInfo = mSyncAdapters.getServiceInfo( + SyncAdapterType.newKey(op.authority, op.account.type), op.userId); + if (syncAdapterInfo == null) { + Log.w(TAG, "Missing sync adapter info for authority " + op.authority + ", userId " + + op.userId); + continue; + } + SyncOperation syncOperation = new SyncOperation( + op.account, op.userId, op.reason, op.syncSource, op.authority, op.extras, + 0 /* delay */, 0 /* flex */, backoff != null ? backoff.first : 0, + mSyncStorageEngine.getDelayUntilTime(op.account, op.userId, op.authority), + syncAdapterInfo.type.allowParallelSyncs()); + syncOperation.expedited = op.expedited; + syncOperation.pendingOperation = op; + add(syncOperation, op); + } + } + + public boolean add(SyncOperation operation) { + return add(operation, null /* this is not coming from the database */); + } + + /** + * Adds a SyncOperation to the queue and creates a PendingOperation object to track that sync. + * If an operation is added that already exists, the existing operation is updated if the newly + * added operation occurs before (or the interval overlaps). + */ + private boolean add(SyncOperation operation, + SyncStorageEngine.PendingOperation pop) { + // If an operation with the same key exists and this one should run sooner/overlaps, + // replace the run interval of the existing operation with this new one. + // Complications: what if the existing operation is expedited but the new operation has an + // earlier run time? Will not be a problem for periodic syncs (no expedited flag), and for + // one-off syncs we only change it if the new sync is sooner. + final String operationKey = operation.key; + final SyncOperation existingOperation = mOperationsMap.get(operationKey); + + if (existingOperation != null) { + boolean changed = false; + if (operation.compareTo(existingOperation) <= 0 ) { + existingOperation.expedited = operation.expedited; + long newRunTime = + Math.min(existingOperation.latestRunTime, operation.latestRunTime); + // Take smaller runtime. + existingOperation.latestRunTime = newRunTime; + // Take newer flextime. + existingOperation.flexTime = operation.flexTime; + changed = true; + } + return changed; + } + + operation.pendingOperation = pop; + // Don't update the PendingOp if one already exists. This really is just a placeholder, + // no actual scheduling info is placed here. + // TODO: Change this to support service components. + if (operation.pendingOperation == null) { + pop = new SyncStorageEngine.PendingOperation( + operation.account, operation.userId, operation.reason, operation.syncSource, + operation.authority, operation.extras, operation.expedited); + pop = mSyncStorageEngine.insertIntoPending(pop); + if (pop == null) { + throw new IllegalStateException("error adding pending sync operation " + + operation); + } + operation.pendingOperation = pop; + } + + mOperationsMap.put(operationKey, operation); + return true; + } + + public void removeUser(int userId) { + ArrayList<SyncOperation> opsToRemove = new ArrayList<SyncOperation>(); + for (SyncOperation op : mOperationsMap.values()) { + if (op.userId == userId) { + opsToRemove.add(op); + } + } + + for (SyncOperation op : opsToRemove) { + remove(op); + } + } + + /** + * Remove the specified operation if it is in the queue. + * @param operation the operation to remove + */ + public void remove(SyncOperation operation) { + SyncOperation operationToRemove = mOperationsMap.remove(operation.key); + if (operationToRemove == null) { + return; + } + if (!mSyncStorageEngine.deleteFromPending(operationToRemove.pendingOperation)) { + final String errorMessage = "unable to find pending row for " + operationToRemove; + Log.e(TAG, errorMessage, new IllegalStateException(errorMessage)); + } + } + + public void onBackoffChanged(Account account, int userId, String providerName, long backoff) { + // for each op that matches the account and provider update its + // backoff and effectiveStartTime + for (SyncOperation op : mOperationsMap.values()) { + if (op.account.equals(account) && op.authority.equals(providerName) + && op.userId == userId) { + op.backoff = backoff; + op.updateEffectiveRunTime(); + } + } + } + + public void onDelayUntilTimeChanged(Account account, String providerName, long delayUntil) { + // for each op that matches the account and provider update its + // delayUntilTime and effectiveStartTime + for (SyncOperation op : mOperationsMap.values()) { + if (op.account.equals(account) && op.authority.equals(providerName)) { + op.delayUntil = delayUntil; + op.updateEffectiveRunTime(); + } + } + } + + public void remove(Account account, int userId, String authority) { + Iterator<Map.Entry<String, SyncOperation>> entries = mOperationsMap.entrySet().iterator(); + while (entries.hasNext()) { + Map.Entry<String, SyncOperation> entry = entries.next(); + SyncOperation syncOperation = entry.getValue(); + if (account != null && !syncOperation.account.equals(account)) { + continue; + } + if (authority != null && !syncOperation.authority.equals(authority)) { + continue; + } + if (userId != syncOperation.userId) { + continue; + } + entries.remove(); + if (!mSyncStorageEngine.deleteFromPending(syncOperation.pendingOperation)) { + final String errorMessage = "unable to find pending row for " + syncOperation; + Log.e(TAG, errorMessage, new IllegalStateException(errorMessage)); + } + } + } + + public Collection<SyncOperation> getOperations() { + return mOperationsMap.values(); + } + + public void dump(StringBuilder sb) { + final long now = SystemClock.elapsedRealtime(); + sb.append("SyncQueue: ").append(mOperationsMap.size()).append(" operation(s)\n"); + for (SyncOperation operation : mOperationsMap.values()) { + sb.append(" "); + if (operation.effectiveRunTime <= now) { + sb.append("READY"); + } else { + sb.append(DateUtils.formatElapsedTime((operation.effectiveRunTime - now) / 1000)); + } + sb.append(" - "); + sb.append(operation.dump(mPackageManager, false)).append("\n"); + } + } +} |