Create a utils class for executors.

Preliminary refactoring to fix
Bug: 13082957

Change-Id: I9f1283c37089bc96140b774b1c559d58031de004
This commit is contained in:
Jean Chalard 2014-02-24 20:52:49 +09:00
parent b08a9e021c
commit b434acee34
2 changed files with 75 additions and 49 deletions

View file

@ -29,6 +29,7 @@ import com.android.inputmethod.latin.SuggestedWords.SuggestedWordInfo;
import com.android.inputmethod.latin.utils.AsyncResultHolder; import com.android.inputmethod.latin.utils.AsyncResultHolder;
import com.android.inputmethod.latin.utils.CollectionUtils; import com.android.inputmethod.latin.utils.CollectionUtils;
import com.android.inputmethod.latin.utils.CombinedFormatUtils; import com.android.inputmethod.latin.utils.CombinedFormatUtils;
import com.android.inputmethod.latin.utils.ExecutorUtils;
import com.android.inputmethod.latin.utils.FileUtils; import com.android.inputmethod.latin.utils.FileUtils;
import com.android.inputmethod.latin.utils.LanguageModelParam; import com.android.inputmethod.latin.utils.LanguageModelParam;
import com.android.inputmethod.latin.utils.PrioritizedSerialExecutor; import com.android.inputmethod.latin.utils.PrioritizedSerialExecutor;
@ -80,9 +81,6 @@ abstract public class ExpandableBinaryDictionary extends Dictionary {
private static final ConcurrentHashMap<String, DictionaryUpdateController> private static final ConcurrentHashMap<String, DictionaryUpdateController>
sDictNameDictionaryUpdateControllerMap = CollectionUtils.newConcurrentHashMap(); sDictNameDictionaryUpdateControllerMap = CollectionUtils.newConcurrentHashMap();
private static final ConcurrentHashMap<String, PrioritizedSerialExecutor>
sDictNameExecutorMap = CollectionUtils.newConcurrentHashMap();
/** The application context. */ /** The application context. */
protected final Context mContext; protected final Context mContext;
@ -163,33 +161,6 @@ abstract public class ExpandableBinaryDictionary extends Dictionary {
return recorder; return recorder;
} }
/**
* Gets the executor for the given dictionary name.
*/
private static PrioritizedSerialExecutor getExecutor(final String dictName) {
PrioritizedSerialExecutor executor = sDictNameExecutorMap.get(dictName);
if (executor == null) {
synchronized(sDictNameExecutorMap) {
executor = new PrioritizedSerialExecutor();
sDictNameExecutorMap.put(dictName, executor);
}
}
return executor;
}
/**
* Shutdowns all executors and removes all executors from the executor map for testing.
*/
@UsedForTesting
public static void shutdownAllExecutors() {
synchronized(sDictNameExecutorMap) {
for (final PrioritizedSerialExecutor executor : sDictNameExecutorMap.values()) {
executor.shutdown();
sDictNameExecutorMap.remove(executor);
}
}
}
private static AbstractDictionaryWriter getDictionaryWriter( private static AbstractDictionaryWriter getDictionaryWriter(
final boolean isDynamicPersonalizationDictionary) { final boolean isDynamicPersonalizationDictionary) {
if (isDynamicPersonalizationDictionary) { if (isDynamicPersonalizationDictionary) {
@ -243,10 +214,10 @@ abstract public class ExpandableBinaryDictionary extends Dictionary {
*/ */
@Override @Override
public void close() { public void close() {
getExecutor(mDictName).execute(new Runnable() { ExecutorUtils.getExecutor(mDictName).execute(new Runnable() {
@Override @Override
public void run() { public void run() {
if (mBinaryDictionary!= null) { if (mBinaryDictionary != null) {
mBinaryDictionary.close(); mBinaryDictionary.close();
mBinaryDictionary = null; mBinaryDictionary = null;
} }
@ -256,7 +227,7 @@ abstract public class ExpandableBinaryDictionary extends Dictionary {
protected void closeBinaryDictionary() { protected void closeBinaryDictionary() {
// Ensure that no other threads are accessing the local binary dictionary. // Ensure that no other threads are accessing the local binary dictionary.
getExecutor(mDictName).execute(new Runnable() { ExecutorUtils.getExecutor(mDictName).execute(new Runnable() {
@Override @Override
public void run() { public void run() {
if (mBinaryDictionary != null) { if (mBinaryDictionary != null) {
@ -287,7 +258,7 @@ abstract public class ExpandableBinaryDictionary extends Dictionary {
} }
protected void clear() { protected void clear() {
getExecutor(mDictName).execute(new Runnable() { ExecutorUtils.getExecutor(mDictName).execute(new Runnable() {
@Override @Override
public void run() { public void run() {
if (mDictionaryWriter == null) { if (mDictionaryWriter == null) {
@ -331,7 +302,7 @@ abstract public class ExpandableBinaryDictionary extends Dictionary {
* Check whether GC is needed and run GC if required. * Check whether GC is needed and run GC if required.
*/ */
protected void runGCIfRequired(final boolean mindsBlockByGC) { protected void runGCIfRequired(final boolean mindsBlockByGC) {
getExecutor(mDictName).execute(new Runnable() { ExecutorUtils.getExecutor(mDictName).execute(new Runnable() {
@Override @Override
public void run() { public void run() {
runGCIfRequiredInternalLocked(mindsBlockByGC); runGCIfRequiredInternalLocked(mindsBlockByGC);
@ -344,7 +315,7 @@ abstract public class ExpandableBinaryDictionary extends Dictionary {
if (mBinaryDictionary.needsToRunGC(mindsBlockByGC)) { if (mBinaryDictionary.needsToRunGC(mindsBlockByGC)) {
if (setProcessingLargeTaskIfNot()) { if (setProcessingLargeTaskIfNot()) {
// Run GC after currently existing time sensitive operations. // Run GC after currently existing time sensitive operations.
getExecutor(mDictName).executePrioritized(new Runnable() { ExecutorUtils.getExecutor(mDictName).executePrioritized(new Runnable() {
@Override @Override
public void run() { public void run() {
try { try {
@ -368,7 +339,7 @@ abstract public class ExpandableBinaryDictionary extends Dictionary {
Log.w(TAG, "addWordDynamically is called for non-updatable dictionary: " + mDictName); Log.w(TAG, "addWordDynamically is called for non-updatable dictionary: " + mDictName);
return; return;
} }
getExecutor(mDictName).execute(new Runnable() { ExecutorUtils.getExecutor(mDictName).execute(new Runnable() {
@Override @Override
public void run() { public void run() {
runGCIfRequiredInternalLocked(true /* mindsBlockByGC */); runGCIfRequiredInternalLocked(true /* mindsBlockByGC */);
@ -388,7 +359,7 @@ abstract public class ExpandableBinaryDictionary extends Dictionary {
+ mDictName); + mDictName);
return; return;
} }
getExecutor(mDictName).execute(new Runnable() { ExecutorUtils.getExecutor(mDictName).execute(new Runnable() {
@Override @Override
public void run() { public void run() {
runGCIfRequiredInternalLocked(true /* mindsBlockByGC */); runGCIfRequiredInternalLocked(true /* mindsBlockByGC */);
@ -406,7 +377,7 @@ abstract public class ExpandableBinaryDictionary extends Dictionary {
+ mDictName); + mDictName);
return; return;
} }
getExecutor(mDictName).execute(new Runnable() { ExecutorUtils.getExecutor(mDictName).execute(new Runnable() {
@Override @Override
public void run() { public void run() {
runGCIfRequiredInternalLocked(true /* mindsBlockByGC */); runGCIfRequiredInternalLocked(true /* mindsBlockByGC */);
@ -430,7 +401,7 @@ abstract public class ExpandableBinaryDictionary extends Dictionary {
"dictionary: " + mDictName); "dictionary: " + mDictName);
return; return;
} }
getExecutor(mDictName).execute(new Runnable() { ExecutorUtils.getExecutor(mDictName).execute(new Runnable() {
@Override @Override
public void run() { public void run() {
final boolean locked = setProcessingLargeTaskIfNot(); final boolean locked = setProcessingLargeTaskIfNot();
@ -461,7 +432,7 @@ abstract public class ExpandableBinaryDictionary extends Dictionary {
} }
final AsyncResultHolder<ArrayList<SuggestedWordInfo>> holder = final AsyncResultHolder<ArrayList<SuggestedWordInfo>> holder =
new AsyncResultHolder<ArrayList<SuggestedWordInfo>>(); new AsyncResultHolder<ArrayList<SuggestedWordInfo>>();
getExecutor(mDictName).executePrioritized(new Runnable() { ExecutorUtils.getExecutor(mDictName).executePrioritized(new Runnable() {
@Override @Override
public void run() { public void run() {
if (mBinaryDictionary == null) { if (mBinaryDictionary == null) {
@ -500,7 +471,7 @@ abstract public class ExpandableBinaryDictionary extends Dictionary {
return false; return false;
} }
final AsyncResultHolder<Boolean> holder = new AsyncResultHolder<Boolean>(); final AsyncResultHolder<Boolean> holder = new AsyncResultHolder<Boolean>();
getExecutor(mDictName).executePrioritized(new Runnable() { ExecutorUtils.getExecutor(mDictName).executePrioritized(new Runnable() {
@Override @Override
public void run() { public void run() {
holder.set(isValidWordLocked(word)); holder.set(isValidWordLocked(word));
@ -560,7 +531,7 @@ abstract public class ExpandableBinaryDictionary extends Dictionary {
// swapping in the new one. // swapping in the new one.
// TODO: Ensure multi-thread assignment of mBinaryDictionary. // TODO: Ensure multi-thread assignment of mBinaryDictionary.
final BinaryDictionary oldBinaryDictionary = mBinaryDictionary; final BinaryDictionary oldBinaryDictionary = mBinaryDictionary;
getExecutor(mDictName).executePrioritized(new Runnable() { ExecutorUtils.getExecutor(mDictName).executePrioritized(new Runnable() {
@Override @Override
public void run() { public void run() {
mBinaryDictionary = newBinaryDictionary; mBinaryDictionary = newBinaryDictionary;
@ -662,7 +633,7 @@ abstract public class ExpandableBinaryDictionary extends Dictionary {
private final void reloadDictionary() { private final void reloadDictionary() {
// Ensure that only one thread attempts to read or write to the shared binary dictionary // Ensure that only one thread attempts to read or write to the shared binary dictionary
// file at the same time. // file at the same time.
getExecutor(mDictName).execute(new Runnable() { ExecutorUtils.getExecutor(mDictName).execute(new Runnable() {
@Override @Override
public void run() { public void run() {
try { try {
@ -696,7 +667,7 @@ abstract public class ExpandableBinaryDictionary extends Dictionary {
// If we just loaded the binary dictionary, then mBinaryDictionary is not // If we just loaded the binary dictionary, then mBinaryDictionary is not
// up-to-date yet so it's useless to test it right away. Schedule the check // up-to-date yet so it's useless to test it right away. Schedule the check
// for right after it's loaded instead. // for right after it's loaded instead.
getExecutor(mDictName).executePrioritized(new Runnable() { ExecutorUtils.getExecutor(mDictName).executePrioritized(new Runnable() {
@Override @Override
public void run() { public void run() {
if (mBinaryDictionary != null && !(isValidDictionary() if (mBinaryDictionary != null && !(isValidDictionary()
@ -736,7 +707,7 @@ abstract public class ExpandableBinaryDictionary extends Dictionary {
} }
}; };
final Runnable oldTask = mUnfinishedFlushingTask.getAndSet(newTask); final Runnable oldTask = mUnfinishedFlushingTask.getAndSet(newTask);
getExecutor(mDictName).replaceAndExecute(oldTask, newTask); ExecutorUtils.getExecutor(mDictName).replaceAndExecute(oldTask, newTask);
} }
/** /**
@ -757,7 +728,7 @@ abstract public class ExpandableBinaryDictionary extends Dictionary {
@UsedForTesting @UsedForTesting
public boolean isInUnderlyingBinaryDictionaryForTests(final String word) { public boolean isInUnderlyingBinaryDictionaryForTests(final String word) {
final AsyncResultHolder<Boolean> holder = new AsyncResultHolder<Boolean>(); final AsyncResultHolder<Boolean> holder = new AsyncResultHolder<Boolean>();
getExecutor(mDictName).execute(new Runnable() { ExecutorUtils.getExecutor(mDictName).execute(new Runnable() {
@Override @Override
public void run() { public void run() {
if (mDictType == Dictionary.TYPE_USER_HISTORY) { if (mDictType == Dictionary.TYPE_USER_HISTORY) {
@ -771,7 +742,7 @@ abstract public class ExpandableBinaryDictionary extends Dictionary {
@UsedForTesting @UsedForTesting
public void waitAllTasksForTests() { public void waitAllTasksForTests() {
final CountDownLatch countDownLatch = new CountDownLatch(1); final CountDownLatch countDownLatch = new CountDownLatch(1);
getExecutor(mDictName).execute(new Runnable() { ExecutorUtils.getExecutor(mDictName).execute(new Runnable() {
@Override @Override
public void run() { public void run() {
countDownLatch.countDown(); countDownLatch.countDown();
@ -787,7 +758,7 @@ abstract public class ExpandableBinaryDictionary extends Dictionary {
@UsedForTesting @UsedForTesting
public void dumpAllWordsForDebug() { public void dumpAllWordsForDebug() {
reloadDictionaryIfRequired(); reloadDictionaryIfRequired();
getExecutor(mDictName).execute(new Runnable() { ExecutorUtils.getExecutor(mDictName).execute(new Runnable() {
@Override @Override
public void run() { public void run() {
Log.d(TAG, "Dump dictionary: " + mDictName); Log.d(TAG, "Dump dictionary: " + mDictName);

View file

@ -0,0 +1,55 @@
/*
* Copyright (C) 2014 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.inputmethod.latin.utils;
import com.android.inputmethod.annotations.UsedForTesting;
import java.util.concurrent.ConcurrentHashMap;
/**
* Utilities to manage executors.
*/
public class ExecutorUtils {
private static final ConcurrentHashMap<String, PrioritizedSerialExecutor>
sExecutorMap = CollectionUtils.newConcurrentHashMap();
/**
* Gets the executor for the given dictionary name.
*/
public static PrioritizedSerialExecutor getExecutor(final String dictName) {
PrioritizedSerialExecutor executor = sExecutorMap.get(dictName);
if (executor == null) {
synchronized(sExecutorMap) {
executor = new PrioritizedSerialExecutor();
sExecutorMap.put(dictName, executor);
}
}
return executor;
}
/**
* Shutdowns all executors and removes all executors from the executor map for testing.
*/
@UsedForTesting
public static void shutdownAllExecutors() {
synchronized(sExecutorMap) {
for (final PrioritizedSerialExecutor executor : sExecutorMap.values()) {
executor.shutdown();
sExecutorMap.remove(executor);
}
}
}
}