blob: 48fecd5c4714f6c845ffc05b54d1406f0181482b [file] [log] [blame]
Craig Mautner21d24a22014-04-23 11:45:37 -07001/*
2 * Copyright (C) 2014 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17package com.android.server.am;
18
Suprabh Shukla4bccb462016-02-10 18:45:12 -080019import android.annotation.NonNull;
Craig Mautner21d24a22014-04-23 11:45:37 -070020import android.graphics.Bitmap;
21import android.graphics.BitmapFactory;
22import android.os.Debug;
Suprabh Shukla23593142015-11-03 17:31:15 -080023import android.os.Environment;
24import android.os.FileUtils;
Suprabh Shukla09a88f52015-12-02 14:36:31 -080025import android.os.Process;
Craig Mautner21d24a22014-04-23 11:45:37 -070026import android.os.SystemClock;
27import android.util.ArraySet;
28import android.util.AtomicFile;
29import android.util.Slog;
Suprabh Shukla4bccb462016-02-10 18:45:12 -080030import android.util.SparseArray;
31import android.util.SparseBooleanArray;
Craig Mautner21d24a22014-04-23 11:45:37 -070032import android.util.Xml;
Wale Ogunwale18795a22014-12-03 11:38:33 -080033
Suprabh Shukla4bccb462016-02-10 18:45:12 -080034import com.android.internal.annotations.VisibleForTesting;
Craig Mautner21d24a22014-04-23 11:45:37 -070035import com.android.internal.util.FastXmlSerializer;
36import com.android.internal.util.XmlUtils;
Suprabh Shukla09a88f52015-12-02 14:36:31 -080037import libcore.io.IoUtils;
38
Craig Mautner21d24a22014-04-23 11:45:37 -070039import org.xmlpull.v1.XmlPullParser;
40import org.xmlpull.v1.XmlPullParserException;
41import org.xmlpull.v1.XmlSerializer;
42
43import java.io.BufferedReader;
Suprabh Shukla4bccb462016-02-10 18:45:12 -080044import java.io.BufferedWriter;
Craig Mautner21d24a22014-04-23 11:45:37 -070045import java.io.File;
Suprabh Shukla4bccb462016-02-10 18:45:12 -080046import java.io.FileNotFoundException;
Craig Mautner21d24a22014-04-23 11:45:37 -070047import java.io.FileOutputStream;
48import java.io.FileReader;
Suprabh Shukla4bccb462016-02-10 18:45:12 -080049import java.io.FileWriter;
Craig Mautner21d24a22014-04-23 11:45:37 -070050import java.io.IOException;
51import java.io.StringWriter;
52import java.util.ArrayList;
Suprabh Shukla09a88f52015-12-02 14:36:31 -080053import java.util.Collections;
Craig Mautner21d24a22014-04-23 11:45:37 -070054import java.util.Comparator;
Suprabh Shukla23593142015-11-03 17:31:15 -080055import java.util.List;
Wale Ogunwale18795a22014-12-03 11:38:33 -080056
Craig Mautner21d24a22014-04-23 11:45:37 -070057public class TaskPersister {
58 static final String TAG = "TaskPersister";
Stefan Kuhnee88d1e52015-05-18 10:33:45 -070059 static final boolean DEBUG = false;
Craig Mautner21d24a22014-04-23 11:45:37 -070060
Craig Mautnerf4f8bb72014-07-29 10:41:40 -070061 /** When not flushing don't write out files faster than this */
62 private static final long INTER_WRITE_DELAY_MS = 500;
63
Suprabh Shukla23593142015-11-03 17:31:15 -080064 /**
65 * When not flushing delay this long before writing the first file out. This gives the next task
66 * being launched a chance to load its resources without this occupying IO bandwidth.
67 */
Craig Mautnerf4f8bb72014-07-29 10:41:40 -070068 private static final long PRE_TASK_DELAY_MS = 3000;
Craig Mautner21d24a22014-04-23 11:45:37 -070069
Craig Mautner63f10902014-09-16 23:57:21 -070070 /** The maximum number of entries to keep in the queue before draining it automatically. */
71 private static final int MAX_WRITE_QUEUE_LENGTH = 6;
72
73 /** Special value for mWriteTime to mean don't wait, just write */
74 private static final long FLUSH_QUEUE = -1;
75
Craig Mautner21d24a22014-04-23 11:45:37 -070076 private static final String RECENTS_FILENAME = "_task";
77 private static final String TASKS_DIRNAME = "recent_tasks";
78 private static final String TASK_EXTENSION = ".xml";
79 private static final String IMAGES_DIRNAME = "recent_images";
Suprabh Shukla4bccb462016-02-10 18:45:12 -080080 private static final String PERSISTED_TASK_IDS_FILENAME = "persisted_taskIds.txt";
Craig Mautnerc0ffce52014-07-01 12:38:52 -070081 static final String IMAGE_EXTENSION = ".png";
Craig Mautner21d24a22014-04-23 11:45:37 -070082
83 private static final String TAG_TASK = "task";
84
Craig Mautner21d24a22014-04-23 11:45:37 -070085 private final ActivityManagerService mService;
86 private final ActivityStackSupervisor mStackSupervisor;
Wale Ogunwalec82f2f52014-12-09 09:32:50 -080087 private final RecentTasks mRecentTasks;
Suprabh Shukla4bccb462016-02-10 18:45:12 -080088 private final SparseArray<SparseBooleanArray> mTaskIdsInFile = new SparseArray<>();
Suprabh Shuklaf50b4582016-02-23 17:44:22 -080089 private final File mTaskIdsDir;
Craig Mautner21d24a22014-04-23 11:45:37 -070090
Suprabh Shukla23593142015-11-03 17:31:15 -080091 /**
92 * Value determines write delay mode as follows: < 0 We are Flushing. No delays between writes
93 * until the image queue is drained and all tasks needing persisting are written to disk. There
94 * is no delay between writes. == 0 We are Idle. Next writes will be delayed by
95 * #PRE_TASK_DELAY_MS. > 0 We are Actively writing. Next write will be at this time. Subsequent
96 * writes will be delayed by #INTER_WRITE_DELAY_MS.
97 */
Craig Mautnerf4f8bb72014-07-29 10:41:40 -070098 private long mNextWriteTime = 0;
Craig Mautner21d24a22014-04-23 11:45:37 -070099
100 private final LazyTaskWriterThread mLazyTaskWriterThread;
101
Craig Mautnerf4f8bb72014-07-29 10:41:40 -0700102 private static class WriteQueueItem {}
Suprabh Shukla23593142015-11-03 17:31:15 -0800103
Craig Mautnerf4f8bb72014-07-29 10:41:40 -0700104 private static class TaskWriteQueueItem extends WriteQueueItem {
105 final TaskRecord mTask;
Winsonc809cbb2015-11-02 12:06:15 -0800106
Craig Mautnerf4f8bb72014-07-29 10:41:40 -0700107 TaskWriteQueueItem(TaskRecord task) {
108 mTask = task;
109 }
110 }
Suprabh Shukla23593142015-11-03 17:31:15 -0800111
Craig Mautnerf4f8bb72014-07-29 10:41:40 -0700112 private static class ImageWriteQueueItem extends WriteQueueItem {
Suprabh Shukla23593142015-11-03 17:31:15 -0800113 final String mFilePath;
Craig Mautnerf4f8bb72014-07-29 10:41:40 -0700114 Bitmap mImage;
Winsonc809cbb2015-11-02 12:06:15 -0800115
Suprabh Shukla23593142015-11-03 17:31:15 -0800116 ImageWriteQueueItem(String filePath, Bitmap image) {
117 mFilePath = filePath;
Craig Mautnerf4f8bb72014-07-29 10:41:40 -0700118 mImage = image;
119 }
120 }
121
122 ArrayList<WriteQueueItem> mWriteQueue = new ArrayList<WriteQueueItem>();
123
Wale Ogunwalec82f2f52014-12-09 09:32:50 -0800124 TaskPersister(File systemDir, ActivityStackSupervisor stackSupervisor,
Suprabh Shukla09a88f52015-12-02 14:36:31 -0800125 ActivityManagerService service, RecentTasks recentTasks) {
Suprabh Shukla23593142015-11-03 17:31:15 -0800126
127 final File legacyImagesDir = new File(systemDir, IMAGES_DIRNAME);
128 if (legacyImagesDir.exists()) {
129 if (!FileUtils.deleteContents(legacyImagesDir) || !legacyImagesDir.delete()) {
130 Slog.i(TAG, "Failure deleting legacy images directory: " + legacyImagesDir);
Craig Mautner21d24a22014-04-23 11:45:37 -0700131 }
132 }
133
Suprabh Shukla23593142015-11-03 17:31:15 -0800134 final File legacyTasksDir = new File(systemDir, TASKS_DIRNAME);
135 if (legacyTasksDir.exists()) {
136 if (!FileUtils.deleteContents(legacyTasksDir) || !legacyTasksDir.delete()) {
137 Slog.i(TAG, "Failure deleting legacy tasks directory: " + legacyTasksDir);
Craig Mautner21d24a22014-04-23 11:45:37 -0700138 }
139 }
140
Suprabh Shuklaf50b4582016-02-23 17:44:22 -0800141 mTaskIdsDir = new File(Environment.getDataDirectory(), "system_de");
Craig Mautner21d24a22014-04-23 11:45:37 -0700142 mStackSupervisor = stackSupervisor;
Suprabh Shukla09a88f52015-12-02 14:36:31 -0800143 mService = service;
Wale Ogunwalec82f2f52014-12-09 09:32:50 -0800144 mRecentTasks = recentTasks;
Craig Mautner21d24a22014-04-23 11:45:37 -0700145 mLazyTaskWriterThread = new LazyTaskWriterThread("LazyTaskWriterThread");
146 }
147
Suprabh Shuklaf50b4582016-02-23 17:44:22 -0800148 @VisibleForTesting
149 TaskPersister(File workingDir) {
150 mTaskIdsDir = workingDir;
151 mStackSupervisor = null;
152 mService = null;
153 mRecentTasks = null;
154 mLazyTaskWriterThread = new LazyTaskWriterThread("LazyTaskWriterThreadTest");
155 }
156
Craig Mautner21d24a22014-04-23 11:45:37 -0700157 void startPersisting() {
Wale Ogunwalec82f2f52014-12-09 09:32:50 -0800158 if (!mLazyTaskWriterThread.isAlive()) {
159 mLazyTaskWriterThread.start();
160 }
Craig Mautner21d24a22014-04-23 11:45:37 -0700161 }
162
Craig Mautner63f10902014-09-16 23:57:21 -0700163 private void removeThumbnails(TaskRecord task) {
164 final String taskString = Integer.toString(task.taskId);
165 for (int queueNdx = mWriteQueue.size() - 1; queueNdx >= 0; --queueNdx) {
166 final WriteQueueItem item = mWriteQueue.get(queueNdx);
Suprabh Shukla09a88f52015-12-02 14:36:31 -0800167 if (item instanceof ImageWriteQueueItem) {
168 final File thumbnailFile = new File(((ImageWriteQueueItem) item).mFilePath);
169 if (thumbnailFile.getName().startsWith(taskString)) {
170 if (DEBUG) {
171 Slog.d(TAG, "Removing " + ((ImageWriteQueueItem) item).mFilePath +
172 " from write queue");
173 }
174 mWriteQueue.remove(queueNdx);
175 }
Craig Mautner63f10902014-09-16 23:57:21 -0700176 }
177 }
178 }
179
180 private void yieldIfQueueTooDeep() {
181 boolean stall = false;
182 synchronized (this) {
183 if (mNextWriteTime == FLUSH_QUEUE) {
184 stall = true;
185 }
186 }
187 if (stall) {
188 Thread.yield();
189 }
190 }
191
Suprabh Shukla4bccb462016-02-10 18:45:12 -0800192 @NonNull
193 SparseBooleanArray loadPersistedTaskIdsForUser(int userId) {
194 if (mTaskIdsInFile.get(userId) != null) {
195 return mTaskIdsInFile.get(userId).clone();
196 }
197 final SparseBooleanArray persistedTaskIds = new SparseBooleanArray();
198 BufferedReader reader = null;
199 String line;
200 try {
201 reader = new BufferedReader(new FileReader(getUserPersistedTaskIdsFile(userId)));
202 while ((line = reader.readLine()) != null) {
203 for (String taskIdString : line.split("\\s+")) {
204 int id = Integer.parseInt(taskIdString);
205 persistedTaskIds.put(id, true);
206 }
207 }
208 } catch (FileNotFoundException e) {
209 // File doesn't exist. Ignore.
210 } catch (Exception e) {
211 Slog.e(TAG, "Error while reading taskIds file for user " + userId, e);
212 } finally {
213 IoUtils.closeQuietly(reader);
214 }
215 mTaskIdsInFile.put(userId, persistedTaskIds);
216 return persistedTaskIds.clone();
217 }
218
Suprabh Shuklaf50b4582016-02-23 17:44:22 -0800219 @VisibleForTesting
220 void maybeWritePersistedTaskIdsForUser(@NonNull SparseBooleanArray taskIds, int userId) {
Suprabh Shukla4bccb462016-02-10 18:45:12 -0800221 if (userId < 0) {
222 return;
223 }
224 SparseBooleanArray persistedIdsInFile = mTaskIdsInFile.get(userId);
225 if (persistedIdsInFile != null && persistedIdsInFile.equals(taskIds)) {
226 return;
227 }
228 final File persistedTaskIdsFile = getUserPersistedTaskIdsFile(userId);
229 BufferedWriter writer = null;
230 try {
231 writer = new BufferedWriter(new FileWriter(persistedTaskIdsFile));
232 for (int i = 0; i < taskIds.size(); i++) {
233 if (taskIds.valueAt(i)) {
234 writer.write(String.valueOf(taskIds.keyAt(i)));
235 writer.newLine();
236 }
237 }
238 } catch (Exception e) {
239 Slog.e(TAG, "Error while writing taskIds file for user " + userId, e);
240 } finally {
241 IoUtils.closeQuietly(writer);
242 }
243 mTaskIdsInFile.put(userId, taskIds.clone());
244 }
245
246 void unloadUserDataFromMemory(int userId) {
247 mTaskIdsInFile.delete(userId);
248 }
249
Craig Mautnerf4f8bb72014-07-29 10:41:40 -0700250 void wakeup(TaskRecord task, boolean flush) {
Craig Mautner21d24a22014-04-23 11:45:37 -0700251 synchronized (this) {
Craig Mautnerf4f8bb72014-07-29 10:41:40 -0700252 if (task != null) {
253 int queueNdx;
254 for (queueNdx = mWriteQueue.size() - 1; queueNdx >= 0; --queueNdx) {
255 final WriteQueueItem item = mWriteQueue.get(queueNdx);
256 if (item instanceof TaskWriteQueueItem &&
257 ((TaskWriteQueueItem) item).mTask == task) {
Craig Mautner63f10902014-09-16 23:57:21 -0700258 if (!task.inRecents) {
259 // This task is being removed.
260 removeThumbnails(task);
261 }
Craig Mautnerf4f8bb72014-07-29 10:41:40 -0700262 break;
263 }
264 }
Wale Ogunwalebe23ff42014-10-21 16:29:51 -0700265 if (queueNdx < 0 && task.isPersistable) {
Craig Mautnerf4f8bb72014-07-29 10:41:40 -0700266 mWriteQueue.add(new TaskWriteQueueItem(task));
267 }
268 } else {
Suprabh Shukla09a88f52015-12-02 14:36:31 -0800269 // Dummy. Ensures removeObsoleteFiles is called when LazyTaskThreadWriter is
270 // notified.
Craig Mautnerf4f8bb72014-07-29 10:41:40 -0700271 mWriteQueue.add(new WriteQueueItem());
272 }
Craig Mautner63f10902014-09-16 23:57:21 -0700273 if (flush || mWriteQueue.size() > MAX_WRITE_QUEUE_LENGTH) {
274 mNextWriteTime = FLUSH_QUEUE;
Craig Mautnerf4f8bb72014-07-29 10:41:40 -0700275 } else if (mNextWriteTime == 0) {
276 mNextWriteTime = SystemClock.uptimeMillis() + PRE_TASK_DELAY_MS;
277 }
Stefan Kuhnee88d1e52015-05-18 10:33:45 -0700278 if (DEBUG) Slog.d(TAG, "wakeup: task=" + task + " flush=" + flush + " mNextWriteTime="
279 + mNextWriteTime + " mWriteQueue.size=" + mWriteQueue.size()
280 + " Callers=" + Debug.getCallers(4));
Craig Mautner21d24a22014-04-23 11:45:37 -0700281 notifyAll();
282 }
Craig Mautner63f10902014-09-16 23:57:21 -0700283
284 yieldIfQueueTooDeep();
Craig Mautner21d24a22014-04-23 11:45:37 -0700285 }
286
Dianne Hackbornce0fd762014-09-19 12:58:15 -0700287 void flush() {
288 synchronized (this) {
289 mNextWriteTime = FLUSH_QUEUE;
290 notifyAll();
291 do {
292 try {
293 wait();
294 } catch (InterruptedException e) {
295 }
296 } while (mNextWriteTime == FLUSH_QUEUE);
297 }
298 }
299
Suprabh Shukla23593142015-11-03 17:31:15 -0800300 void saveImage(Bitmap image, String filePath) {
Craig Mautnerf4f8bb72014-07-29 10:41:40 -0700301 synchronized (this) {
302 int queueNdx;
303 for (queueNdx = mWriteQueue.size() - 1; queueNdx >= 0; --queueNdx) {
304 final WriteQueueItem item = mWriteQueue.get(queueNdx);
305 if (item instanceof ImageWriteQueueItem) {
306 ImageWriteQueueItem imageWriteQueueItem = (ImageWriteQueueItem) item;
Suprabh Shukla23593142015-11-03 17:31:15 -0800307 if (imageWriteQueueItem.mFilePath.equals(filePath)) {
Craig Mautnerf4f8bb72014-07-29 10:41:40 -0700308 // replace the Bitmap with the new one.
309 imageWriteQueueItem.mImage = image;
310 break;
311 }
312 }
313 }
314 if (queueNdx < 0) {
Suprabh Shukla23593142015-11-03 17:31:15 -0800315 mWriteQueue.add(new ImageWriteQueueItem(filePath, image));
Craig Mautnerf4f8bb72014-07-29 10:41:40 -0700316 }
Craig Mautner63f10902014-09-16 23:57:21 -0700317 if (mWriteQueue.size() > MAX_WRITE_QUEUE_LENGTH) {
318 mNextWriteTime = FLUSH_QUEUE;
319 } else if (mNextWriteTime == 0) {
Craig Mautnerf4f8bb72014-07-29 10:41:40 -0700320 mNextWriteTime = SystemClock.uptimeMillis() + PRE_TASK_DELAY_MS;
321 }
Suprabh Shukla23593142015-11-03 17:31:15 -0800322 if (DEBUG) Slog.d(TAG, "saveImage: filePath=" + filePath + " now=" +
Craig Mautnerf4f8bb72014-07-29 10:41:40 -0700323 SystemClock.uptimeMillis() + " mNextWriteTime=" +
324 mNextWriteTime + " Callers=" + Debug.getCallers(4));
325 notifyAll();
326 }
Craig Mautner63f10902014-09-16 23:57:21 -0700327
328 yieldIfQueueTooDeep();
Craig Mautnerf4f8bb72014-07-29 10:41:40 -0700329 }
330
Suprabh Shukla23593142015-11-03 17:31:15 -0800331 Bitmap getTaskDescriptionIcon(String filePath) {
Craig Mautner648f69b2014-09-18 14:16:26 -0700332 // See if it is in the write queue
Suprabh Shukla23593142015-11-03 17:31:15 -0800333 final Bitmap icon = getImageFromWriteQueue(filePath);
Craig Mautner648f69b2014-09-18 14:16:26 -0700334 if (icon != null) {
335 return icon;
336 }
Suprabh Shukla23593142015-11-03 17:31:15 -0800337 return restoreImage(filePath);
Craig Mautner648f69b2014-09-18 14:16:26 -0700338 }
339
Suprabh Shukla23593142015-11-03 17:31:15 -0800340 Bitmap getImageFromWriteQueue(String filePath) {
Craig Mautnerf4f8bb72014-07-29 10:41:40 -0700341 synchronized (this) {
342 for (int queueNdx = mWriteQueue.size() - 1; queueNdx >= 0; --queueNdx) {
343 final WriteQueueItem item = mWriteQueue.get(queueNdx);
344 if (item instanceof ImageWriteQueueItem) {
345 ImageWriteQueueItem imageWriteQueueItem = (ImageWriteQueueItem) item;
Suprabh Shukla23593142015-11-03 17:31:15 -0800346 if (imageWriteQueueItem.mFilePath.equals(filePath)) {
Craig Mautnerf4f8bb72014-07-29 10:41:40 -0700347 return imageWriteQueueItem.mImage;
348 }
349 }
350 }
351 return null;
352 }
353 }
354
Craig Mautner21d24a22014-04-23 11:45:37 -0700355 private StringWriter saveToXml(TaskRecord task) throws IOException, XmlPullParserException {
Stefan Kuhnee88d1e52015-05-18 10:33:45 -0700356 if (DEBUG) Slog.d(TAG, "saveToXml: task=" + task);
Craig Mautner21d24a22014-04-23 11:45:37 -0700357 final XmlSerializer xmlSerializer = new FastXmlSerializer();
358 StringWriter stringWriter = new StringWriter();
359 xmlSerializer.setOutput(stringWriter);
360
Stefan Kuhnee88d1e52015-05-18 10:33:45 -0700361 if (DEBUG) xmlSerializer.setFeature(
Suprabh Shukla23593142015-11-03 17:31:15 -0800362 "http://xmlpull.org/v1/doc/features.html#indent-output", true);
Craig Mautner21d24a22014-04-23 11:45:37 -0700363
364 // save task
365 xmlSerializer.startDocument(null, true);
366
367 xmlSerializer.startTag(null, TAG_TASK);
368 task.saveToXml(xmlSerializer);
369 xmlSerializer.endTag(null, TAG_TASK);
370
371 xmlSerializer.endDocument();
372 xmlSerializer.flush();
373
374 return stringWriter;
375 }
376
Craig Mautner77b04262014-06-27 15:22:12 -0700377 private String fileToString(File file) {
378 final String newline = System.lineSeparator();
379 try {
380 BufferedReader reader = new BufferedReader(new FileReader(file));
381 StringBuffer sb = new StringBuffer((int) file.length() * 2);
382 String line;
383 while ((line = reader.readLine()) != null) {
384 sb.append(line + newline);
385 }
386 reader.close();
387 return sb.toString();
388 } catch (IOException ioe) {
389 Slog.e(TAG, "Couldn't read file " + file.getName());
390 return null;
391 }
392 }
393
Craig Mautnera228ae92014-07-09 05:44:55 -0700394 private TaskRecord taskIdToTask(int taskId, ArrayList<TaskRecord> tasks) {
395 if (taskId < 0) {
396 return null;
397 }
398 for (int taskNdx = tasks.size() - 1; taskNdx >= 0; --taskNdx) {
399 final TaskRecord task = tasks.get(taskNdx);
400 if (task.taskId == taskId) {
401 return task;
402 }
403 }
404 Slog.e(TAG, "Restore affiliation error looking for taskId=" + taskId);
405 return null;
406 }
407
Suprabh Shukla09a88f52015-12-02 14:36:31 -0800408 List<TaskRecord> restoreTasksForUserLocked(final int userId) {
409 final ArrayList<TaskRecord> tasks = new ArrayList<TaskRecord>();
Craig Mautner21d24a22014-04-23 11:45:37 -0700410 ArraySet<Integer> recoveredTaskIds = new ArraySet<Integer>();
411
Suprabh Shukla23593142015-11-03 17:31:15 -0800412 File userTasksDir = getUserTasksDir(userId);
413
414 File[] recentFiles = userTasksDir.listFiles();
Craig Mautner21d24a22014-04-23 11:45:37 -0700415 if (recentFiles == null) {
Suprabh Shukla4bccb462016-02-10 18:45:12 -0800416 Slog.e(TAG, "restoreTasksForUserLocked: Unable to list files from " + userTasksDir);
Craig Mautner21d24a22014-04-23 11:45:37 -0700417 return tasks;
418 }
419
420 for (int taskNdx = 0; taskNdx < recentFiles.length; ++taskNdx) {
421 File taskFile = recentFiles[taskNdx];
Suprabh Shukla4bccb462016-02-10 18:45:12 -0800422 if (DEBUG) {
423 Slog.d(TAG, "restoreTasksForUserLocked: userId=" + userId
424 + ", taskFile=" + taskFile.getName());
425 }
Craig Mautner21d24a22014-04-23 11:45:37 -0700426 BufferedReader reader = null;
Craig Mautnere0129b32014-05-25 16:41:09 -0700427 boolean deleteFile = false;
Craig Mautner21d24a22014-04-23 11:45:37 -0700428 try {
429 reader = new BufferedReader(new FileReader(taskFile));
430 final XmlPullParser in = Xml.newPullParser();
431 in.setInput(reader);
432
433 int event;
434 while (((event = in.next()) != XmlPullParser.END_DOCUMENT) &&
435 event != XmlPullParser.END_TAG) {
436 final String name = in.getName();
437 if (event == XmlPullParser.START_TAG) {
Suprabh Shukla09a88f52015-12-02 14:36:31 -0800438 if (DEBUG) Slog.d(TAG, "restoreTasksForUserLocked: START_TAG name=" + name);
Craig Mautner21d24a22014-04-23 11:45:37 -0700439 if (TAG_TASK.equals(name)) {
Suprabh Shukla23593142015-11-03 17:31:15 -0800440 final TaskRecord task = TaskRecord.restoreFromXml(in, mStackSupervisor);
Suprabh Shukla09a88f52015-12-02 14:36:31 -0800441 if (DEBUG) Slog.d(TAG, "restoreTasksForUserLocked: restored task="
Suprabh Shukla23593142015-11-03 17:31:15 -0800442 + task);
Craig Mautner21d24a22014-04-23 11:45:37 -0700443 if (task != null) {
Dianne Hackborn852975d2014-08-22 17:42:43 -0700444 // XXX Don't add to write queue... there is no reason to write
445 // out the stuff we just read, if we don't write it we will
446 // read the same thing again.
Suprabh Shukla23593142015-11-03 17:31:15 -0800447 // mWriteQueue.add(new TaskWriteQueueItem(task));
Suprabh Shukla4bccb462016-02-10 18:45:12 -0800448
Craig Mautner21d24a22014-04-23 11:45:37 -0700449 final int taskId = task.taskId;
Suprabh Shukla4bccb462016-02-10 18:45:12 -0800450 if (mStackSupervisor.anyTaskForIdLocked(taskId,
451 /* restoreFromRecents= */ false, 0) != null) {
452 // Should not happen.
453 Slog.wtf(TAG, "Existing task with taskId " + taskId + "found");
454 } else if (userId != task.userId) {
455 // Should not happen.
456 Slog.wtf(TAG, "Task with userId " + task.userId + " found in "
457 + userTasksDir.getAbsolutePath());
458 } else {
459 // Looks fine.
460 mStackSupervisor.setNextTaskIdForUserLocked(taskId, userId);
Amith Yamasani515d4062015-09-28 11:30:06 -0700461 task.isPersistable = true;
462 tasks.add(task);
463 recoveredTaskIds.add(taskId);
464 }
Craig Mautner77b04262014-06-27 15:22:12 -0700465 } else {
Suprabh Shukla4bccb462016-02-10 18:45:12 -0800466 Slog.e(TAG, "restoreTasksForUserLocked: Unable to restore taskFile="
Suprabh Shukla23593142015-11-03 17:31:15 -0800467 + taskFile + ": " + fileToString(taskFile));
Craig Mautner21d24a22014-04-23 11:45:37 -0700468 }
469 } else {
Suprabh Shukla4bccb462016-02-10 18:45:12 -0800470 Slog.wtf(TAG, "restoreTasksForUserLocked: Unknown xml event=" + event
Suprabh Shukla23593142015-11-03 17:31:15 -0800471 + " name=" + name);
Craig Mautner21d24a22014-04-23 11:45:37 -0700472 }
473 }
474 XmlUtils.skipCurrentTag(in);
475 }
Craig Mautnere0129b32014-05-25 16:41:09 -0700476 } catch (Exception e) {
Craig Mautnera228ae92014-07-09 05:44:55 -0700477 Slog.wtf(TAG, "Unable to parse " + taskFile + ". Error ", e);
Craig Mautner77b04262014-06-27 15:22:12 -0700478 Slog.e(TAG, "Failing file: " + fileToString(taskFile));
Craig Mautnere0129b32014-05-25 16:41:09 -0700479 deleteFile = true;
Craig Mautner21d24a22014-04-23 11:45:37 -0700480 } finally {
Wale Ogunwale18795a22014-12-03 11:38:33 -0800481 IoUtils.closeQuietly(reader);
Stefan Kuhnee88d1e52015-05-18 10:33:45 -0700482 if (deleteFile) {
483 if (DEBUG) Slog.d(TAG, "Deleting file=" + taskFile.getName());
Craig Mautnere0129b32014-05-25 16:41:09 -0700484 taskFile.delete();
485 }
Craig Mautner21d24a22014-04-23 11:45:37 -0700486 }
487 }
488
Stefan Kuhnee88d1e52015-05-18 10:33:45 -0700489 if (!DEBUG) {
Suprabh Shukla23593142015-11-03 17:31:15 -0800490 removeObsoleteFiles(recoveredTaskIds, userTasksDir.listFiles());
491 }
Craig Mautner21d24a22014-04-23 11:45:37 -0700492
Suprabh Shukla23593142015-11-03 17:31:15 -0800493 // Fix up task affiliation from taskIds
Craig Mautnera228ae92014-07-09 05:44:55 -0700494 for (int taskNdx = tasks.size() - 1; taskNdx >= 0; --taskNdx) {
495 final TaskRecord task = tasks.get(taskNdx);
496 task.setPrevAffiliate(taskIdToTask(task.mPrevAffiliateTaskId, tasks));
497 task.setNextAffiliate(taskIdToTask(task.mNextAffiliateTaskId, tasks));
498 }
499
Suprabh Shukla09a88f52015-12-02 14:36:31 -0800500 Collections.sort(tasks, new Comparator<TaskRecord>() {
Craig Mautner21d24a22014-04-23 11:45:37 -0700501 @Override
502 public int compare(TaskRecord lhs, TaskRecord rhs) {
Craig Mautner43e52ed2014-06-16 17:18:52 -0700503 final long diff = rhs.mLastTimeMoved - lhs.mLastTimeMoved;
Craig Mautner21d24a22014-04-23 11:45:37 -0700504 if (diff < 0) {
505 return -1;
506 } else if (diff > 0) {
507 return +1;
508 } else {
509 return 0;
510 }
511 }
512 });
Suprabh Shukla09a88f52015-12-02 14:36:31 -0800513 return tasks;
Craig Mautner21d24a22014-04-23 11:45:37 -0700514 }
515
Craig Mautnere0129b32014-05-25 16:41:09 -0700516 private static void removeObsoleteFiles(ArraySet<Integer> persistentTaskIds, File[] files) {
Suprabh Shukla23593142015-11-03 17:31:15 -0800517 if (DEBUG) Slog.d(TAG, "removeObsoleteFiles: persistentTaskIds=" + persistentTaskIds +
Stefan Kuhnee88d1e52015-05-18 10:33:45 -0700518 " files=" + files);
Craig Mautnera5badf02014-09-11 12:47:03 -0700519 if (files == null) {
Suprabh Shukladc4b80d2016-04-20 15:24:31 -0700520 Slog.e(TAG, "File error accessing recents directory (directory doesn't exist?).");
Craig Mautnera5badf02014-09-11 12:47:03 -0700521 return;
522 }
Craig Mautner21d24a22014-04-23 11:45:37 -0700523 for (int fileNdx = 0; fileNdx < files.length; ++fileNdx) {
524 File file = files[fileNdx];
525 String filename = file.getName();
Craig Mautnerffcfcaa2014-06-05 09:54:38 -0700526 final int taskIdEnd = filename.indexOf('_');
Craig Mautner21d24a22014-04-23 11:45:37 -0700527 if (taskIdEnd > 0) {
528 final int taskId;
529 try {
Narayan Kamatha09b4d22016-04-15 18:32:45 +0100530 taskId = Integer.parseInt(filename.substring(0, taskIdEnd));
Suprabh Shukla23593142015-11-03 17:31:15 -0800531 if (DEBUG) Slog.d(TAG, "removeObsoleteFiles: Found taskId=" + taskId);
Craig Mautner21d24a22014-04-23 11:45:37 -0700532 } catch (Exception e) {
Suprabh Shukla23593142015-11-03 17:31:15 -0800533 Slog.wtf(TAG, "removeObsoleteFiles: Can't parse file=" + file.getName());
Craig Mautner21d24a22014-04-23 11:45:37 -0700534 file.delete();
535 continue;
536 }
537 if (!persistentTaskIds.contains(taskId)) {
Suprabh Shukla23593142015-11-03 17:31:15 -0800538 if (DEBUG) Slog.d(TAG, "removeObsoleteFiles: deleting file=" + file.getName());
Craig Mautner21d24a22014-04-23 11:45:37 -0700539 file.delete();
540 }
541 }
542 }
543 }
544
Suprabh Shukla4bccb462016-02-10 18:45:12 -0800545 private void writeTaskIdsFiles() {
546 int candidateUserIds[];
547 synchronized (mService) {
548 candidateUserIds = mRecentTasks.usersWithRecentsLoadedLocked();
549 }
550 SparseBooleanArray taskIdsToSave;
551 for (int userId : candidateUserIds) {
552 synchronized (mService) {
553 taskIdsToSave = mRecentTasks.mPersistedTaskIds.get(userId).clone();
554 }
555 maybeWritePersistedTaskIdsForUser(taskIdsToSave, userId);
556 }
557 }
558
Craig Mautner21d24a22014-04-23 11:45:37 -0700559 private void removeObsoleteFiles(ArraySet<Integer> persistentTaskIds) {
Suprabh Shukla09a88f52015-12-02 14:36:31 -0800560 int[] candidateUserIds;
561 synchronized (mService) {
562 // Remove only from directories of the users who have recents in memory synchronized
563 // with persistent storage.
564 candidateUserIds = mRecentTasks.usersWithRecentsLoadedLocked();
565 }
566 for (int userId : candidateUserIds) {
Suprabh Shukla23593142015-11-03 17:31:15 -0800567 removeObsoleteFiles(persistentTaskIds, getUserImagesDir(userId).listFiles());
568 removeObsoleteFiles(persistentTaskIds, getUserTasksDir(userId).listFiles());
569 }
Craig Mautner21d24a22014-04-23 11:45:37 -0700570 }
571
572 static Bitmap restoreImage(String filename) {
Stefan Kuhnee88d1e52015-05-18 10:33:45 -0700573 if (DEBUG) Slog.d(TAG, "restoreImage: restoring " + filename);
Suprabh Shukla23593142015-11-03 17:31:15 -0800574 return BitmapFactory.decodeFile(filename);
575 }
576
Suprabh Shuklaf50b4582016-02-23 17:44:22 -0800577 private File getUserPersistedTaskIdsFile(int userId) {
578 File userTaskIdsDir = new File(mTaskIdsDir, String.valueOf(userId));
579 if (!userTaskIdsDir.exists() && !userTaskIdsDir.mkdirs()) {
580 Slog.e(TAG, "Error while creating user directory: " + userTaskIdsDir);
581 }
582 return new File(userTaskIdsDir, PERSISTED_TASK_IDS_FILENAME);
Suprabh Shukla4bccb462016-02-10 18:45:12 -0800583 }
584
Suprabh Shukla23593142015-11-03 17:31:15 -0800585 static File getUserTasksDir(int userId) {
Suprabh Shukla4bccb462016-02-10 18:45:12 -0800586 File userTasksDir = new File(Environment.getDataSystemCeDirectory(userId), TASKS_DIRNAME);
Suprabh Shukla23593142015-11-03 17:31:15 -0800587
588 if (!userTasksDir.exists()) {
589 if (!userTasksDir.mkdir()) {
590 Slog.e(TAG, "Failure creating tasks directory for user " + userId + ": "
591 + userTasksDir);
592 }
593 }
594 return userTasksDir;
595 }
596
597 static File getUserImagesDir(int userId) {
Suprabh Shukladc4b80d2016-04-20 15:24:31 -0700598 return new File(Environment.getDataSystemCeDirectory(userId), IMAGES_DIRNAME);
599 }
Suprabh Shukla23593142015-11-03 17:31:15 -0800600
Suprabh Shukladc4b80d2016-04-20 15:24:31 -0700601 private static boolean createParentDirectory(String filePath) {
602 File parentDir = new File(filePath).getParentFile();
603 return parentDir.exists() || parentDir.mkdirs();
Craig Mautner21d24a22014-04-23 11:45:37 -0700604 }
605
606 private class LazyTaskWriterThread extends Thread {
Craig Mautner21d24a22014-04-23 11:45:37 -0700607
608 LazyTaskWriterThread(String name) {
609 super(name);
610 }
611
612 @Override
613 public void run() {
Riley Andrewsf16c2e82015-06-02 18:24:48 -0700614 Process.setThreadPriority(Process.THREAD_PRIORITY_BACKGROUND);
Craig Mautner21d24a22014-04-23 11:45:37 -0700615 ArraySet<Integer> persistentTaskIds = new ArraySet<Integer>();
616 while (true) {
Craig Mautnerf4f8bb72014-07-29 10:41:40 -0700617 // We can't lock mService while holding TaskPersister.this, but we don't want to
618 // call removeObsoleteFiles every time through the loop, only the last time before
619 // going to sleep. The risk is that we call removeObsoleteFiles() successively.
620 final boolean probablyDone;
Craig Mautner21d24a22014-04-23 11:45:37 -0700621 synchronized (TaskPersister.this) {
Craig Mautnerf4f8bb72014-07-29 10:41:40 -0700622 probablyDone = mWriteQueue.isEmpty();
623 }
624 if (probablyDone) {
Stefan Kuhnee88d1e52015-05-18 10:33:45 -0700625 if (DEBUG) Slog.d(TAG, "Looking for obsolete files.");
Craig Mautnerf4f8bb72014-07-29 10:41:40 -0700626 persistentTaskIds.clear();
627 synchronized (mService) {
Stefan Kuhnee88d1e52015-05-18 10:33:45 -0700628 if (DEBUG) Slog.d(TAG, "mRecents=" + mRecentTasks);
Wale Ogunwalec82f2f52014-12-09 09:32:50 -0800629 for (int taskNdx = mRecentTasks.size() - 1; taskNdx >= 0; --taskNdx) {
630 final TaskRecord task = mRecentTasks.get(taskNdx);
Stefan Kuhnee88d1e52015-05-18 10:33:45 -0700631 if (DEBUG) Slog.d(TAG, "LazyTaskWriter: task=" + task +
Wale Ogunwalebe23ff42014-10-21 16:29:51 -0700632 " persistable=" + task.isPersistable);
633 if ((task.isPersistable || task.inRecents)
Wale Ogunwale18795a22014-12-03 11:38:33 -0800634 && (task.stack == null || !task.stack.isHomeStack())) {
Stefan Kuhnee88d1e52015-05-18 10:33:45 -0700635 if (DEBUG) Slog.d(TAG, "adding to persistentTaskIds task=" + task);
Craig Mautnerf4f8bb72014-07-29 10:41:40 -0700636 persistentTaskIds.add(task.taskId);
637 } else {
Stefan Kuhnee88d1e52015-05-18 10:33:45 -0700638 if (DEBUG) Slog.d(TAG,
Wale Ogunwalebe23ff42014-10-21 16:29:51 -0700639 "omitting from persistentTaskIds task=" + task);
Craig Mautnerf4f8bb72014-07-29 10:41:40 -0700640 }
641 }
642 }
643 removeObsoleteFiles(persistentTaskIds);
644 }
Suprabh Shukla4bccb462016-02-10 18:45:12 -0800645 writeTaskIdsFiles();
Craig Mautnerf4f8bb72014-07-29 10:41:40 -0700646
647 // If mNextWriteTime, then don't delay between each call to saveToXml().
648 final WriteQueueItem item;
649 synchronized (TaskPersister.this) {
Craig Mautner63f10902014-09-16 23:57:21 -0700650 if (mNextWriteTime != FLUSH_QUEUE) {
Craig Mautnerf4f8bb72014-07-29 10:41:40 -0700651 // The next write we don't have to wait so long.
652 mNextWriteTime = SystemClock.uptimeMillis() + INTER_WRITE_DELAY_MS;
Stefan Kuhnee88d1e52015-05-18 10:33:45 -0700653 if (DEBUG) Slog.d(TAG, "Next write time may be in " +
Craig Mautnerf4f8bb72014-07-29 10:41:40 -0700654 INTER_WRITE_DELAY_MS + " msec. (" + mNextWriteTime + ")");
655 }
656
657 while (mWriteQueue.isEmpty()) {
Dianne Hackbornce0fd762014-09-19 12:58:15 -0700658 if (mNextWriteTime != 0) {
659 mNextWriteTime = 0; // idle.
660 TaskPersister.this.notifyAll(); // wake up flush() if needed.
661 }
Craig Mautnerf4f8bb72014-07-29 10:41:40 -0700662 try {
Stefan Kuhnee88d1e52015-05-18 10:33:45 -0700663 if (DEBUG) Slog.d(TAG, "LazyTaskWriter: waiting indefinitely.");
Craig Mautnerf4f8bb72014-07-29 10:41:40 -0700664 TaskPersister.this.wait();
665 } catch (InterruptedException e) {
666 }
Craig Mautner63f10902014-09-16 23:57:21 -0700667 // Invariant: mNextWriteTime is either FLUSH_QUEUE or PRE_WRITE_DELAY_MS
668 // from now.
Craig Mautnerf4f8bb72014-07-29 10:41:40 -0700669 }
670 item = mWriteQueue.remove(0);
671
Craig Mautner21d24a22014-04-23 11:45:37 -0700672 long now = SystemClock.uptimeMillis();
Stefan Kuhnee88d1e52015-05-18 10:33:45 -0700673 if (DEBUG) Slog.d(TAG, "LazyTaskWriter: now=" + now + " mNextWriteTime=" +
674 mNextWriteTime + " mWriteQueue.size=" + mWriteQueue.size());
Craig Mautnerf4f8bb72014-07-29 10:41:40 -0700675 while (now < mNextWriteTime) {
Craig Mautner21d24a22014-04-23 11:45:37 -0700676 try {
Stefan Kuhnee88d1e52015-05-18 10:33:45 -0700677 if (DEBUG) Slog.d(TAG, "LazyTaskWriter: waiting " +
Craig Mautnerf4f8bb72014-07-29 10:41:40 -0700678 (mNextWriteTime - now));
679 TaskPersister.this.wait(mNextWriteTime - now);
Craig Mautner21d24a22014-04-23 11:45:37 -0700680 } catch (InterruptedException e) {
681 }
682 now = SystemClock.uptimeMillis();
683 }
Craig Mautnerf4f8bb72014-07-29 10:41:40 -0700684
685 // Got something to do.
Craig Mautner21d24a22014-04-23 11:45:37 -0700686 }
687
Craig Mautnerf4f8bb72014-07-29 10:41:40 -0700688 if (item instanceof ImageWriteQueueItem) {
689 ImageWriteQueueItem imageWriteQueueItem = (ImageWriteQueueItem) item;
Suprabh Shukla23593142015-11-03 17:31:15 -0800690 final String filePath = imageWriteQueueItem.mFilePath;
Suprabh Shukladc4b80d2016-04-20 15:24:31 -0700691 if (!createParentDirectory(filePath)) {
692 Slog.e(TAG, "Error while creating images directory for file: " + filePath);
693 continue;
694 }
Craig Mautnerf4f8bb72014-07-29 10:41:40 -0700695 final Bitmap bitmap = imageWriteQueueItem.mImage;
Suprabh Shukla23593142015-11-03 17:31:15 -0800696 if (DEBUG) Slog.d(TAG, "writing bitmap: filename=" + filePath);
Craig Mautnerc0ffce52014-07-01 12:38:52 -0700697 FileOutputStream imageFile = null;
698 try {
Suprabh Shukla23593142015-11-03 17:31:15 -0800699 imageFile = new FileOutputStream(new File(filePath));
Craig Mautnerf4f8bb72014-07-29 10:41:40 -0700700 bitmap.compress(Bitmap.CompressFormat.PNG, 100, imageFile);
Craig Mautnerc0ffce52014-07-01 12:38:52 -0700701 } catch (Exception e) {
Suprabh Shukla23593142015-11-03 17:31:15 -0800702 Slog.e(TAG, "saveImage: unable to save " + filePath, e);
Craig Mautnerc0ffce52014-07-01 12:38:52 -0700703 } finally {
Wale Ogunwale18795a22014-12-03 11:38:33 -0800704 IoUtils.closeQuietly(imageFile);
Craig Mautnerc0ffce52014-07-01 12:38:52 -0700705 }
Craig Mautnerf4f8bb72014-07-29 10:41:40 -0700706 } else if (item instanceof TaskWriteQueueItem) {
707 // Write out one task.
708 StringWriter stringWriter = null;
709 TaskRecord task = ((TaskWriteQueueItem) item).mTask;
Stefan Kuhnee88d1e52015-05-18 10:33:45 -0700710 if (DEBUG) Slog.d(TAG, "Writing task=" + task);
Craig Mautnerf4f8bb72014-07-29 10:41:40 -0700711 synchronized (mService) {
Craig Mautner63f10902014-09-16 23:57:21 -0700712 if (task.inRecents) {
Craig Mautnerf4f8bb72014-07-29 10:41:40 -0700713 // Still there.
Craig Mautner21d24a22014-04-23 11:45:37 -0700714 try {
Stefan Kuhnee88d1e52015-05-18 10:33:45 -0700715 if (DEBUG) Slog.d(TAG, "Saving task=" + task);
Craig Mautnerf4f8bb72014-07-29 10:41:40 -0700716 stringWriter = saveToXml(task);
717 } catch (IOException e) {
718 } catch (XmlPullParserException e) {
Craig Mautner21d24a22014-04-23 11:45:37 -0700719 }
720 }
Dianne Hackborn852975d2014-08-22 17:42:43 -0700721 }
722 if (stringWriter != null) {
723 // Write out xml file while not holding mService lock.
724 FileOutputStream file = null;
725 AtomicFile atomicFile = null;
726 try {
Suprabh Shukla23593142015-11-03 17:31:15 -0800727 atomicFile = new AtomicFile(new File(
728 getUserTasksDir(task.userId),
729 String.valueOf(task.taskId) + RECENTS_FILENAME
730 + TASK_EXTENSION));
Dianne Hackborn852975d2014-08-22 17:42:43 -0700731 file = atomicFile.startWrite();
732 file.write(stringWriter.toString().getBytes());
733 file.write('\n');
734 atomicFile.finishWrite(file);
Suprabh Shukla23593142015-11-03 17:31:15 -0800735
Dianne Hackborn852975d2014-08-22 17:42:43 -0700736 } catch (IOException e) {
737 if (file != null) {
738 atomicFile.failWrite(file);
Craig Mautnerf4f8bb72014-07-29 10:41:40 -0700739 }
Suprabh Shukla23593142015-11-03 17:31:15 -0800740 Slog.e(TAG,
741 "Unable to open " + atomicFile + " for persisting. " + e);
Craig Mautnerf4f8bb72014-07-29 10:41:40 -0700742 }
Craig Mautner21d24a22014-04-23 11:45:37 -0700743 }
744 }
Craig Mautner21d24a22014-04-23 11:45:37 -0700745 }
746 }
747 }
Craig Mautner21d24a22014-04-23 11:45:37 -0700748}