xref: /frameworks/base/docs/html/topic/performance/threads.jd

page.title=Threading Performance
@jd:body

<div id="qv-wrapper">
<div id="qv">

<h2>In this document</h2>
<ol>
<li><a href="#main">Main Thread</a>
  <ol>
    <li><a href="#internals">Internals</a></li>
  </ol>
</li>
<li><a href="#references">Threading and UI Object References</a>
  <ol>
    <li><a href="#explicit">Explicit references</a></li>
    <li><a href="#implicit">Implicit references</a></li>
  </ol>
</li>
<li><a href="#lifecycles">Threading and App and Activity Lifecycles</a>
   <ol>
      <li><a href="#persisting">Persisting threads</a></li>
      <li><a href="#priority">Thread priority</a></li>
   </ol>
      </li>
<li><a href="#helper">Helper Classes for Threading</a>
   <ol>
      <li><a href="#asynctask">The AsyncTask class</a></li>
      <li><a href="#handlerthread">The HandlerThread class</a></li>
      <li><a href="#threadpool">The ThreadPoolExecutor class</a></li>
   </ol>
      </li>
</ol>
</div>
</div>

<p>
Making adept use of threads on Android can help you boost your apps
performance. This page discusses several aspects of working with threads:
working with the UI, or main, thread; the relationship between app lifecycle and
thread priority; and, methods that the platform provides to help manage thread
complexity. In each of these areas, this page describes potential pitfalls and
strategies for avoiding them.
</p>
<h2 id="main">Main Thread</h2>
<p>
When the user launches your app, Android creates a new <a
href="{@docRoot}guide/components/fundamentals.html">Linux
process</a> along with an execution thread. This <strong>main thread,</strong>
also known as the UI thread, is responsible for everything that happens
onscreen. Understanding how it works can help you design your app to use the
main thread for the best possible performance.
</p>
<h3 id="internals">Internals</h3>
<p>
The main thread has a very simple design: Its only job is to take and execute
blocks of work from a thread-safe work queue until its app is terminated. The
framework generates some of these blocks of work from a variety of places. These
places include callbacks associated with lifecycle information, user events such
as input, or events coming from other apps and processes. In addition, app can
explicitly enqueue blocks on their own, without using the framework.
</p>
<p>
Nearly <a
href="https://www.youtube.com/watch?v=qk5F6Bxqhr4&index=1&list=PLWz5rJ2EKKc9CBxr3BVjPTPoDPLdPIFCE">any
block of code your app executes</a> is tied to an event callback, such as input,
layout inflation, or draw. When something triggers an event, the thread where the event
happened pushes the event out of itself, and into the main threads message
queue. The main thread can then service the event.
</p>

<p>
While an animation or screen update is occurring, the system tries to execute a
block of work (which is responsible for drawing the screen) every 16ms or so, in
order to render smoothly at <a
href="https://www.youtube.com/watch?v=CaMTIgxCSqU&index=62&list=PLWz5rJ2EKKc9CBxr3BVjPTPoDPLdPIFCE">60
frames per second</a>. For the system to reach this goal, some operations must
happen on the main thread. However, when the main threads messaging queue
contains tasks that are either too numerous or too long for the main thread to
complete work within the 16ms window, the app should move this work to a worker
thread. If the main thread cannot finish executing blocks of work within 16ms,
the user may observe hitching, lagging, or a lack of UI responsiveness to input.
If the main thread blocks for approximately five seconds, the system displays
the <a
href="{@docRoot}training/articles/perf-anr.html"><em>Application
Not Responding</em></a> (ANR) dialog, allowing the user to close the app directly.
</p>
<p>
Moving numerous or long tasks from the main thread, so that they dont interfere
with smooth rendering and fast responsiveness to user input, is the biggest
reason for you to adopt threading in your app.
</p>
<h2 id="references">Threading and UI Object References</h2>
<p>
By design, <a
href="https://www.youtube.com/watch?v=tBHPmQQNiS8&index=3&list=PLWz5rJ2EKKc9CBxr3BVjPTPoDPLdPIFCE">Android
UI objects are not thread-safe</a>. An app is expected to create, use, and
destroy UI objects, all on the main thread. If you try to modify
or even reference a UI object in a thread other than the main thread, the result
can be exceptions, silent failures, crashes, and other undefined misbehavior.
</p>
<p>
Issues with references fall into two distinct categories: explicit references
and implicit references.
</p>
<h3 id="explicit">Explicit references</h3>
<p>
Many tasks on non-main threads have the end goal of updating UI objects.
However, if one of these threads accesses an object in the view hierarchy,
application instability can result: If a worker thread changes the properties of
that object at the same time that any other thread is referencing the object,
the results are undefined.
</p>
<p>
For example, consider an app that holds a direct reference to a UI object on a
worker thread. The object on the worker thread may contain a reference to a
{@link android.view.View}; but before the work completes, the {@link android.view.View} is
removed from the view hierarchy. When these two actions happen simultaneously,
the reference keeps the {@link android.view.View} object in memory and sets properties on it.
However, the user never sees
this object, and the app deletes the object once the reference to it is gone.
</p>

<p>
In another example, {@link android.view.View} objects contain references to the activity
that owns them. If
that activity is destroyed, but there remains a threaded block of work that
references it&mdash;directly or indirectly&mdash;the garbage collector will not collect
the activity until that block of work finishes executing.
</p>
<p>
This scenario can cause a problem in situations where threaded work may be in
flight while some activity lifecycle event, such as a screen rotation, occurs.
The system wouldnt be able to perform garbage collection until the in-flight
work completes. As a result, there may be two {@link android.app.Activity} objects in
memory until garbage collection can take place.
</p>

<p>
With scenarios like these, we suggest that your app not include explicit
references to UI objects in threaded work tasks. Avoiding such references helps you avoid
these types of memory leaks, while also steering clear of threading contention.
</p>
<p>
In all cases, your app should only update UI objects on the main thread. This
means that you should craft a negotiation policy that allows multiple threads to
communicate work back to the main thread, which tasks the topmost activity or
fragment with the work of updating the actual UI object.
</p>
<h3 id="implicit">Implicit references</h3>
<p>
A common code-design flaw with threaded objects can be seen in the snippet of
code below:
</p>
<pre class="prettyprint">
public class MainActivity extends Activity {
  // ...
  public class MyAsyncTask extends AsyncTask<Void, Void, String>   {
    &#64;Override protected String doInBackground(Void... params) {...}
    &#64;Override protected void onPostExecute(String result) {...}
  }
}
</pre>
<p>
The flaw in this snippet is that the code declares the threading object
{@code MyAsyncTask} as an inner class of some activity. This declaration creates an
implicit reference to the enclosing {@link android.app.Activity} object.
As a result, the object contains a reference to the activity until the
threaded work completes, causing a delay in the destruction of the referenced activity.
This delay, in turn, puts more pressure on memory.
</p>
<p>
A direct solution to this problem would be to define your overloaded class
instances in their own files, thus removing the implicit reference.
</p>
<p>
Another solution is to declare the {@link android.os.AsyncTask} object
as a static nested class.  Doing so eliminates the implicit reference problem
because of the way a static nested
class differs from an inner class: An instance of an inner class requires an
instance of the outer class to be instantiated, and has direct access to the
methods and fields of its enclosing instance. By contrast, a static nested class
does not require a reference to an instance of enclosing class, so it contains
no references to the outer class members.
</p>
<pre class="prettyprint">
public class MainActivity extends Activity {
  // ...
  Static public class MyAsyncTask extends AsyncTask<Void, Void, String>   {
    &#64;Override protected String doInBackground(Void... params) {...}
    &#64;Override protected void onPostExecute(String result) {...}
  }
}
</pre>
<h2 id="lifecycles">Threading and App and Activity Lifecycles</h2>
<p>
The app lifecycle can affect how threading works in your application.
You may need to decide that a thread should, or should not, persist after an
activity is destroyed. You should also be aware of the relationship between
thread prioritization and whether an activity is running in the foreground or
background.
</p>
<h3 id="persisting">Persisting threads</h3>
<p>
Threads persist past the lifetime of the activities that spawn them. Threads
continue to execute, uninterrupted, regardless of the creation or destruction of
activities. In some cases, this persistence is undesirable.
</p>
<p>
Consider a case in which an activity spawns a set of threaded work blocks, and
is then destroyed before a worker thread can execute the blocks. What should the
app do with the blocks that are in flight?
</p>

<p>
If the blocks were going to update a UI that no longer exists, theres no reason
for the work to continue. For example, if the work is to load user information
from a database, and then update views, the thread is no longer necessary.
</p>

<p>
By contrast, the work packets may have some benefit not entirely related to the
UI. In this case, you should persist the thread. For example, the packets may be
waiting to download an image, cache it to disk, and update the associated
{@link android.view.View} object. Although the object no longer exists, the acts of downloading and
caching the image may still be helpful, in case the user returns to the
destroyed activity.
</p>

<p>
Managing lifecycle responses manually for all threading objects can become
extremely complex. If you dont manage them correctly, your app can suffer from
memory contention and performance issues. <a
href="{@docRoot}guide/components/loaders.html">Loaders</a>
are one solution to this problem. A loader facilitates asynchronous loading of
data, while also persisting information through configuration changes.
</p>
<h3 id="priority">Thread priority</h3>
<p>
As described in <a
href="{@docRoot}guide/topics/processes/process-lifecycle.html">Processes
and the Application Lifecycle</a>, the priority that your apps threads receive
depends partly on where the app is in the app lifecycle. As you create and
manage threads in your application, its important to set their priority so that
the right threads get the right priorities at the right times. If set too high,
your thread may interrupt the UI thread and RenderThread, causing your app to
drop frames. If set too low, you can make your async tasks (such as image
loading) slower than they need to be.
</p>
<p>
Every time you create a thread, you should call
{@link android.os.Process#setThreadPriority(int, int) setThreadPriority()}.
The systems thread
scheduler gives preference to threads with high priorities, balancing those
priorities with the need to eventually get all the work done. Generally, threads
in the <a
href="https://www.youtube.com/watch?v=NwFXVsM15Co&list=PLWz5rJ2EKKc9CBxr3BVjPTPoDPLdPIFCE&index=9">foreground
group get about 95%</a> of the total execution time from the device, while the
background group gets roughly 5%.
</p>
<p>
The system also assigns each thread its own priority value, using the
{@link android.os.Process} class.
</p>
<p>
By default, the system sets a threads priority to the same priority and group
memberships as the spawning thread. However, your application can explicitly
adjust thread priority by using
{@link android.os.Process#setThreadPriority(int, int) setThreadPriority()}.
</p>
<p>
The {@link android.os.Process}
class</a> helps reduce complexity in assigning priority values by providing a
set of constants that your app can use to set thread priorities. For example, <a
href="{@docRoot}reference/android/os/Process.html#THREAD_PRIORITY_DEFAULT">THREAD_PRIORITY_DEFAULT</a>
represents the default value for a thread. Your app should set the thread's priority to <a
href="{@docRoot}reference/android/os/Process.html#THREAD_PRIORITY_BACKGROUND">THREAD_PRIORITY_BACKGROUND</a>
for threads that are executing less-urgent work.
</p>
<p>
Your app can use the <a
href="{@docRoot}reference/android/os/Process.html#THREAD_PRIORITY_LESS_FAVORABLE">THREAD_PRIORITY_LESS_FAVORABLE</a>
and <a
href="{@docRoot}reference/android/os/Process.html#THREAD_PRIORITY_MORE_FAVORABLE">THREAD_PRIORITY_MORE_FAVORABLE</a>
constants as incrementers to set relative priorities. A list of all of these
enumerated states and modifiers appears in the reference documentation for
the {@link android.os.Process#THREAD_PRIORITY_AUDIO} class.

For more information on
managing threads, see the reference documentation about the
{@link java.lang.Thread} and {@link android.os.Process} classes.
</p>
<p>
https://developer.android.com/reference/android/os/Process.html#THREAD_PRIORITY_AUDIO
</p>
<h2 id="helper">Helper Classes for Threading</h2>
<p>
The framework provides the same Java classes & primitives to facilitate
threading, such as the {@link java.lang.Thread} and
{@link java.lang.Runnable} classes.
In order to help reduce the cognitive load associated with
of developing threaded applications for
Android, the framework provides a set of helpers which can aide in development.
Each helper class has a specific set of performance nuances that make them
unique for a specific subset of threading problems. Using the wrong class for
the wrong situation can lead to performance issues.
</p>
<h3 id="asynctask">The AsyncTask class</h3>
<p>

The {@link android.os.AsyncTask} class
is a simple, useful primitive for apps that need to quickly move work from the
main thread onto worker threads. For example, an input event might trigger the
need to update the UI with a loaded bitmap. An {@link android.os.AsyncTask}
object can offload the
bitmap loading and decoding to an alternate thread; once that processing is
complete, the {@link android.os.AsyncTask} object can manage receiving the work
back on the main thread to update the UI.
</p>
<p>
When using {@link android.os.AsyncTask}, there are a few important performance
aspects to keep in
mind. First, by default, an app pushes all of the {@link android.os.AsyncTask}
objects it creates into a
single thread. Therefore, they execute in serial fashion, and&mdash;as with the
main
thread&mdash;an especially long work packet can block the queue. For this reason,
we suggest that you only use {@link android.os.AsyncTask} to handle work items
shorter than 5ms in duration.
</p>
<p>
{@link android.os.AsyncTask} objects are also the most common offenders
for implicit-reference issues.
{@link android.os.AsyncTask} objects present risks related to explicit
references, as well, but these are
sometimes easier to work around. For example, an {@link android.os.AsyncTask}
may require a reference to a UI object in order to update the UI object
properly once {@link android.os.AsyncTask} executes its callbacks on the
main thread. In such a situation, you
can use a {@link java.lang.ref.WeakReference}
to store a reference to the required UI object, and access the object once the
{@link android.os.AsyncTask} is operating on the main thread. To be clear,
holding a {@link java.lang.ref.WeakReference}
to an object does not make the object thread-safe; the
{@link java.lang.ref.WeakReference} merely
provides a method to handle issues with explicit references and garbage
collection.
</p>
<h3 id="handlerthread">The HandlerThread class</h3>
<p>
While an {@link android.os.AsyncTask}
is useful,<a
href="https://www.youtube.com/watch?v=adPLIAnx9og&index=5&list=PLWz5rJ2EKKc9CBxr3BVjPTPoDPLdPIFCE">
it may not always be the right solution</a> to your threading problem. Instead,
you may need a more traditional approach to executing a block of work on a
longer running thread, and some ability to manage that workflow manually.
</p>

<p>
Consider a common challenge with getting preview frames from your
{@link android.hardware.Camera} object.
 When you register for Camera preview frames, you receive them in the
 {@link android.hardware.Camera.PreviewCallback#onPreviewFrame(byte[], android.hardware.Camera) onPreviewFrame()}
callback, which is invoked on the event thread it was called from. If this
callback were invoked on the UI thread, the task of dealing with the huge pixel
arrays would be interfering with rendering and event processing work. The same
problem applies to {@link android.os.AsyncTask}, which also executes jobs serially and is
susceptible to blocking.
</p>
<p>
This is a situation where a handler thread would be appropriate: A handler thread
is effectively a long-running thread that grabs work from a queue, and operates
on it. In this example, when your app delegates the
{@link android.hardware.Camera#open Camera.open()} command to a
block of work on the handler thread, the associated
 {@link android.hardware.Camera.PreviewCallback#onPreviewFrame(byte[], android.hardware.Camera) onPreviewFrame()}
callback
lands on the handler thread, rather than the UI or {@link android.os.AsyncTask}
threads. So, if youre going to be doing long-running work on the pixels, this
may be a better solution for you.
</p>
<p>
When your app creates a thread using {@link android.os.HandlerThread}, dont
forget to set the threads
<a href="https://www.youtube.com/watch?v=NwFXVsM15Co&index=9&list=PLWz5rJ2EKKc9CBxr3BVjPTPoDPLdPIFCE">
priority based on the type of work its doing</a>. Remember, CPUs can only
handle a small number of threads in parallel. Setting the priority helps
the system know the right ways to schedule this work when all other threads
are fighting for attention.
</p>
<h3 id="threadpool">The ThreadPoolExecutor class</h3>
<p>
There are certain types of work that can be reduced to highly parallel,
distributed tasks. One such task, for example, is calculating a filter for each
8x8 block of an 8 megapixel image. With the sheer volume of work packets this
creates, <a
href="https://www.youtube.com/watch?v=uCmHoEY1iTM&index=6&list=PLWz5rJ2EKKc9CBxr3BVjPTPoDPLdPIFCE">
{@code AsyncTask} and {@code HandlerThread} arent appropriate
classes</a>. The single-threaded nature of {@link android.os.AsyncTask} would
turn all the threadpooled work into a linear system.
Using the {@link android.os.HandlerThread} class, on the other hand, would
require the programmer to manually manage load balancing between a group of
threads.
</p>

<p>
{@link java.util.concurrent.ThreadPoolExecutor} is a helper class to make
this process easier. This class manages the creation of a group of threads, sets
their priorities, and manages how work is distributed among those threads.
As workload increases or decreases, the class spins up or destroys more threads
to adjust to the workload.
</p>
<p>
This class also helps your app spawn an optimum number of threads. When it
constructs a {@link java.util.concurrent.ThreadPoolExecutor}
object, the app sets a minimum and maximum
number of threads. As the workload given to the
{@link java.util.concurrent.ThreadPoolExecutor} increases,
the class will take the initialized minimum and maximum thread counts into
account, and consider the amount of pending work there is to do. Based on these
factors, {@link java.util.concurrent.ThreadPoolExecutor} decides on how many
threads should be alive at any given time.
</p>
<h4>How many threads should you create?</h4>
<p>
Although from a software level, your code has the ability to create hundreds of
threads, doing so can create performance issues. CPUs really only have the
ability to handle a small number of threads in parallel; everything above that
runs<a
href="https://www.youtube.com/watch?v=NwFXVsM15Co&list=PLWz5rJ2EKKc9CBxr3BVjPTPoDPLdPIFCE&index=9">
into priority and scheduling issues</a>. As such, its important to only create
as many threads as your workload needs.
</p>
<p>
Practically speaking, theres a number of variables responsible for this, but
picking a value (like 4, for starters), and testing it with <a
href={@docRoot}studio/profile/systrace-commandline.html>Systrace</a> is as
solid a strategy as any other. You can use trial-and-error to discover the
minimum number of threads you can use without running into problems.
</p>
<p>
Another consideration in deciding on how many threads to have is that threads
arent free: they take up memory. Each thread costs a minimum of 64k of memory.
This adds up quickly across the many apps installed on a device, especially in
situations where the call stacks grow significantly.
</p>
<p>
Many system processes and third-party libraries often spin up their own
threadpools. If your app can reuse an existing threadpool, this reuse may help
performance by reducing contention for memory and processing resources.
</p>