ProfileInstaller
public class ProfileInstaller
Install ahead of time tracing profiles to configure ART to precompile bundled libraries. This will automatically be called by ProfileInstallerInitializer and you should never call this unless you have disabled the initializer in your manifest. This reads profiles from the assets directory, where they must be embedded during the build process. This will have no effect if there is not a profile embedded in the current APK.
Summary
Nested types |
|---|
public interface ProfileInstaller.DiagnosticsCallbackAn object which can be passed to the ProfileInstaller which will receive information during the installation process which can be used for logging and telemetry. |
Constants |
|
|---|---|
static final int |
Indicates that when tryInstallSync was run, no existing profile was found in the "cur" directory. |
static final int |
Indicates that when tryInstallSync was run, an existing profile was found in the "cur" directory. |
static final int |
Indicates that the profile is compressed and a version of bundletool newer than 1.13.2 needs to be used to build the app. |
static final int |
Indicates that when tryInstallSync was run, no existing profile was found in the "cur" directory. |
static final int |
Indicates that when tryInstallSync was run, an existing profile was found in the "cur" directory. |
static final int |
Indicates that no installation occurred because it was determined that the baseline profile had already been installed previously. |
static final int |
Indicates that no baseline profile was bundled with the APK, and as a result, no installation could take place. |
static final int |
Indicates that the benchmark operation failed |
static final int |
Indicates that the benchmark operation was successful |
static final int |
Indicates that the benchmark operation was unknown, likely meaning profileinstaller needs to update to support the operation |
static final int |
Indicates that a skip file was successfully deleted and profile installation will resume. |
static final int |
Indicates that the format required by this SDK version is not supported by this version of the ProfileInstaller library. |
static final int |
Indicates that a skip file was successfully written and profile installation will be skipped. |
static final int |
Indicates that the profile got installed and written to disk successfully. |
static final int |
Indicates that an IO Exception took place during install. |
static final int |
Indicates that the device requires a metadata file in order to install the profile successfully, but there was not one included in the APK. |
static final int |
Indicates that the installation was aborted because the app was found to not have adequate permissions to write the profile to disk. |
static final int |
Indicates that a parsing exception occurred during install. |
static final int |
Indicates that this process was signalled to save it's profile information |
static final int |
Indicates that this process was not able to signal itself to save profile information |
static final int |
Indicates that the current SDK level is such that installing a profile is not supported by ART. |
Public methods |
|
|---|---|
static void |
@WorkerThreadTry to write the profile from assets into the ART aot profile directory. |
static void |
@WorkerThreadTry to write the profile from assets into the ART aot profile directory. |
Constants
DIAGNOSTIC_CURRENT_PROFILE_DOES_NOT_EXIST
public static final int DIAGNOSTIC_CURRENT_PROFILE_DOES_NOT_EXIST = 2
Indicates that when tryInstallSync was run, no existing profile was found in the "cur" directory.
DIAGNOSTIC_CURRENT_PROFILE_EXISTS
public static final int DIAGNOSTIC_CURRENT_PROFILE_EXISTS = 1
Indicates that when tryInstallSync was run, an existing profile was found in the "cur" directory. The associated [data] passed in for this call will be the size, in bytes, of the profile that was found.
DIAGNOSTIC_PROFILE_IS_COMPRESSED
public static final int DIAGNOSTIC_PROFILE_IS_COMPRESSED = 5
Indicates that the profile is compressed and a version of bundletool newer than 1.13.2 needs to be used to build the app.
DIAGNOSTIC_REF_PROFILE_DOES_NOT_EXIST
public static final int DIAGNOSTIC_REF_PROFILE_DOES_NOT_EXIST = 4
Indicates that when tryInstallSync was run, no existing profile was found in the "cur" directory.
DIAGNOSTIC_REF_PROFILE_EXISTS
public static final int DIAGNOSTIC_REF_PROFILE_EXISTS = 3
Indicates that when tryInstallSync was run, an existing profile was found in the "cur" directory. The associated [data] passed in for this call will be the size, in bytes, of the profile that was found.
RESULT_ALREADY_INSTALLED
public static final int RESULT_ALREADY_INSTALLED = 2
Indicates that no installation occurred because it was determined that the baseline profile had already been installed previously.
RESULT_BASELINE_PROFILE_NOT_FOUND
public static final int RESULT_BASELINE_PROFILE_NOT_FOUND = 6
Indicates that no baseline profile was bundled with the APK, and as a result, no installation could take place.
RESULT_BENCHMARK_OPERATION_FAILURE
public static final int RESULT_BENCHMARK_OPERATION_FAILURE = 15
Indicates that the benchmark operation failed
RESULT_BENCHMARK_OPERATION_SUCCESS
public static final int RESULT_BENCHMARK_OPERATION_SUCCESS = 14
Indicates that the benchmark operation was successful
RESULT_BENCHMARK_OPERATION_UNKNOWN
public static final int RESULT_BENCHMARK_OPERATION_UNKNOWN = 16
Indicates that the benchmark operation was unknown, likely meaning profileinstaller needs to update to support the operation
RESULT_DELETE_SKIP_FILE_SUCCESS
public static final int RESULT_DELETE_SKIP_FILE_SUCCESS = 11
Indicates that a skip file was successfully deleted and profile installation will resume.
RESULT_DESIRED_FORMAT_UNSUPPORTED
public static final int RESULT_DESIRED_FORMAT_UNSUPPORTED = 5
Indicates that the format required by this SDK version is not supported by this version of the ProfileInstaller library.
RESULT_INSTALL_SKIP_FILE_SUCCESS
public static final int RESULT_INSTALL_SKIP_FILE_SUCCESS = 10
Indicates that a skip file was successfully written and profile installation will be skipped.
RESULT_INSTALL_SUCCESS
public static final int RESULT_INSTALL_SUCCESS = 1
Indicates that the profile got installed and written to disk successfully. Note that this should happen but is not the only condition that indicates "nothing went wrong". Several result codes are indicative of expected behavior.
RESULT_IO_EXCEPTION
public static final int RESULT_IO_EXCEPTION = 7
Indicates that an IO Exception took place during install. The associated [data] with this result is the exception.
RESULT_META_FILE_REQUIRED_BUT_NOT_FOUND
public static final int RESULT_META_FILE_REQUIRED_BUT_NOT_FOUND = 9
Indicates that the device requires a metadata file in order to install the profile successfully, but there was not one included in the APK. The correct metadata files are produced when using Android Gradle Plugin `7.1.0-alpha05` or newer.
RESULT_NOT_WRITABLE
public static final int RESULT_NOT_WRITABLE = 4
Indicates that the installation was aborted because the app was found to not have adequate permissions to write the profile to disk.
RESULT_PARSE_EXCEPTION
public static final int RESULT_PARSE_EXCEPTION = 8
Indicates that a parsing exception occurred during install. The associated [data] with this result is the exception.
RESULT_SAVE_PROFILE_SIGNALLED
public static final int RESULT_SAVE_PROFILE_SIGNALLED = 12
Indicates that this process was signalled to save it's profile information
RESULT_SAVE_PROFILE_SKIPPED
public static final int RESULT_SAVE_PROFILE_SKIPPED = 13
Indicates that this process was not able to signal itself to save profile information
RESULT_UNSUPPORTED_ART_VERSION
public static final int RESULT_UNSUPPORTED_ART_VERSION = 3
Indicates that the current SDK level is such that installing a profile is not supported by ART.
Public methods
writeProfile
@WorkerThread
public static void writeProfile(@NonNull Context context)
Try to write the profile from assets into the ART aot profile directory. You do not need to call this method if ProfileInstallerInitializer is enabled for your application. If you disable the initializer, you should call this method within 5-10 seconds of app launch, to ensure that art can use the generated profile. This should always be called after the first screen is shown to the user, to avoid delaying application startup to install AOT profiles. It is encouraged that you call this method during every app startup to ensure profiles are written correctly after app upgrades, or if the profile failed to write on the previous launch. Profiles will be correctly formatted based on the current API level of the device, and only installed if profileinstaller can determine that it is safe to do so. If the profile is not written, no action needs to be taken.
writeProfile
@WorkerThread
public static void writeProfile(
@NonNull Context context,
@NonNull Executor executor,
@NonNull ProfileInstaller.DiagnosticsCallback diagnostics
)
Try to write the profile from assets into the ART aot profile directory. You do not need to call this method if ProfileInstallerInitializer is enabled for your application. If you disable the initializer, you should call this method within 5-10 seconds of app launch, to ensure that art can use the generated profile. This should always be called after the first screen is shown to the user, to avoid delaying application startup to install AOT profiles. It is encouraged that you call this method during every app startup to ensure profiles are written correctly after app upgrades, or if the profile failed to write on the previous launch. Profiles will be correctly formatted based on the current API level of the device, and only installed if profileinstaller can determine that it is safe to do so. If the profile is not written, no action needs to be taken.