blob: 5a637b1ce75bcaccdb4e8626a2e2ff84c5b2723f [file] [log] [blame]
Jeff Sharkey6c2c0562016-12-07 12:12:00 -07001/*
2 * Copyright (C) 2016 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
17#ifndef DEXOPT_H_
18#define DEXOPT_H_
19
Jeff Sharkeyc1149c92017-09-21 14:51:09 -060020#include "installd_constants.h"
21
Jeff Sharkey6c2c0562016-12-07 12:12:00 -070022#include <sys/types.h>
23
Jooyung Han9fcc4ef2020-01-23 12:45:10 +090024#include <optional>
25
Jeff Sharkey90aff262016-12-12 14:28:24 -070026#include <cutils/multiuser.h>
27
Jeff Sharkey6c2c0562016-12-07 12:12:00 -070028namespace android {
29namespace installd {
30
Jeff Sharkey90aff262016-12-12 14:28:24 -070031/* dexopt needed flags matching those in dalvik.system.DexFile */
Calin Juravle80a21252017-01-17 14:43:25 -080032static constexpr int NO_DEXOPT_NEEDED = 0;
Jeff Sharkey90aff262016-12-12 14:28:24 -070033static constexpr int DEX2OAT_FROM_SCRATCH = 1;
34static constexpr int DEX2OAT_FOR_BOOT_IMAGE = 2;
35static constexpr int DEX2OAT_FOR_FILTER = 3;
Jeff Sharkey90aff262016-12-12 14:28:24 -070036
Martin Stjernholmf4caaa02019-07-17 22:14:14 +010037#define ANDROID_ART_APEX_BIN "/apex/com.android.art/bin"
Roland Levillain67a14f62019-01-23 15:59:50 +000038// Location of binaries in the Android Runtime APEX.
David Sehr6df89a62020-04-15 20:43:48 -070039static constexpr const char* kDex2oat32Path = ANDROID_ART_APEX_BIN "/dex2oat32";
40static constexpr const char* kDex2oat64Path = ANDROID_ART_APEX_BIN "/dex2oat64";
41static constexpr const char* kDex2oatDebug32Path = ANDROID_ART_APEX_BIN "/dex2oatd32";
42static constexpr const char* kDex2oatDebug64Path = ANDROID_ART_APEX_BIN "/dex2oatd64";
Martin Stjernholmf4caaa02019-07-17 22:14:14 +010043static constexpr const char* kProfmanPath = ANDROID_ART_APEX_BIN "/profman";
44static constexpr const char* kProfmanDebugPath = ANDROID_ART_APEX_BIN "/profmand";
45static constexpr const char* kDexoptanalyzerPath = ANDROID_ART_APEX_BIN "/dexoptanalyzer";
46static constexpr const char* kDexoptanalyzerDebugPath = ANDROID_ART_APEX_BIN "/dexoptanalyzerd";
47#undef ANDROID_ART_APEX_BIN
Roland Levillain67a14f62019-01-23 15:59:50 +000048
Calin Juravle824a64d2018-01-18 20:23:17 -080049// Clear the reference profile identified by the given profile name.
50bool clear_primary_reference_profile(const std::string& pkgname, const std::string& profile_name);
51// Clear the current profile identified by the given profile name (for single user).
52bool clear_primary_current_profile(const std::string& pkgname, const std::string& profile_name,
53 userid_t user);
54// Clear all current profiles identified by the given profile name (all users).
55bool clear_primary_current_profiles(const std::string& pkgname, const std::string& profile_name);
Jeff Sharkey90aff262016-12-12 14:28:24 -070056
Calin Juravlee90de862021-06-08 08:04:52 -070057// Decides if profile guided compilation is needed or not based on existing profiles.
Calin Juravle824a64d2018-01-18 20:23:17 -080058// The analysis is done for a single profile name (which corresponds to a single code path).
Calin Juravlee90de862021-06-08 08:04:52 -070059//
60// Returns PROFILES_ANALYSIS_OPTIMIZE if there is enough information in the current profiles
61// that makes it worth to recompile the package.
62// If the return value is PROFILES_ANALYSIS_OPTIMIZE all the current profiles would have been
63// merged into the reference profiles accessible with open_reference_profile().
64//
65// Return PROFILES_ANALYSIS_DONT_OPTIMIZE_SMALL_DELTA if the package should not optimize.
66// As a special case returns PROFILES_ANALYSIS_DONT_OPTIMIZE_EMPTY_PROFILES if all profiles are
67// empty.
68int analyze_primary_profiles(uid_t uid,
69 const std::string& pkgname,
70 const std::string& profile_name);
Calin Juravle114f0812017-03-08 19:05:07 -080071
Calin Juravle824a64d2018-01-18 20:23:17 -080072// Create a snapshot of the profile information for the given package profile.
Calin Juravle0d0a4922018-01-23 19:54:11 -080073// If appId is -1, the method creates the profile snapshot for the boot image.
74//
Calin Juravle29591732017-11-20 17:46:19 -080075// The profile snapshot is the aggregation of all existing profiles (all current user
76// profiles & the reference profile) and is meant to capture the all the profile information
77// without performing a merge into the reference profile which might impact future dex2oat
78// compilations.
79// The snapshot is created next to the reference profile of the package and the
80// ownership is assigned to AID_SYSTEM.
81// The snapshot location is reference_profile_location.snapshot. If a snapshot is already
82// there, it will be truncated and overwritten.
Calin Juravle0d0a4922018-01-23 19:54:11 -080083//
84// The classpath acts as filter: only profiling data belonging to elements of the classpath
85// will end up in the snapshot.
86bool create_profile_snapshot(int32_t app_id,
87 const std::string& package,
88 const std::string& profile_name,
89 const std::string& classpath);
Calin Juravle29591732017-11-20 17:46:19 -080090
Calin Juravle408cd4a2018-01-20 23:34:18 -080091bool dump_profiles(int32_t uid,
92 const std::string& pkgname,
93 const std::string& profile_name,
94 const std::string& code_path);
Jeff Sharkey90aff262016-12-12 14:28:24 -070095
Mathieu Chartierf966f2a2017-05-10 12:48:37 -070096bool copy_system_profile(const std::string& system_profile,
97 uid_t packageUid,
Calin Juravle824a64d2018-01-18 20:23:17 -080098 const std::string& pkgname,
99 const std::string& profile_name);
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700100
Calin Juravlec3b049e2018-01-18 22:32:58 -0800101// Prepare the app profile for the given code path:
102// - create the current profile using profile_name
103// - merge the profile from the dex metadata file (if present) into
104// the reference profile.
105bool prepare_app_profile(const std::string& package_name,
106 userid_t user_id,
107 appid_t app_id,
108 const std::string& profile_name,
109 const std::string& code_path,
Jooyung Han9fcc4ef2020-01-23 12:45:10 +0900110 const std::optional<std::string>& dex_metadata);
Calin Juravlec3b049e2018-01-18 22:32:58 -0800111
Calin Juravle0f3beba2021-06-11 09:17:20 -0700112// Returns the total bytes that were freed, or -1 in case of errors.
113int64_t delete_odex(const char* apk_path, const char* instruction_set, const char* output_path);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700114
Calin Juravlec9eab382017-01-25 01:17:17 -0800115bool reconcile_secondary_dex_file(const std::string& dex_path,
116 const std::string& pkgname, int uid, const std::vector<std::string>& isas,
Jooyung Han9fcc4ef2020-01-23 12:45:10 +0900117 const std::optional<std::string>& volumeUuid, int storage_flag,
Calin Juravlec9eab382017-01-25 01:17:17 -0800118 /*out*/bool* out_secondary_dex_exists);
119
Alan Stokesa25d90c2017-10-16 10:56:00 +0100120bool hash_secondary_dex_file(const std::string& dex_path,
Jooyung Han9fcc4ef2020-01-23 12:45:10 +0900121 const std::string& pkgname, int uid, const std::optional<std::string>& volume_uuid,
Alan Stokesa25d90c2017-10-16 10:56:00 +0100122 int storage_flag, std::vector<uint8_t>* out_secondary_dex_hash);
123
Jeff Sharkey6c2c0562016-12-07 12:12:00 -0700124int dexopt(const char *apk_path, uid_t uid, const char *pkgName, const char *instruction_set,
125 int dexopt_needed, const char* oat_dir, int dexopt_flags, const char* compiler_filter,
Calin Juravle52c45822017-07-13 22:50:21 -0700126 const char* volume_uuid, const char* class_loader_context, const char* se_info,
Calin Juravle62c5a372018-02-01 17:03:23 +0000127 bool downgrade, int target_sdk_version, const char* profile_name,
Andreas Gampe023b2242018-02-28 16:03:25 -0800128 const char* dexMetadataPath, const char* compilation_reason, std::string* error_msg);
Jeff Sharkey6c2c0562016-12-07 12:12:00 -0700129
Jeff Sharkeyc1149c92017-09-21 14:51:09 -0600130bool calculate_oat_file_path_default(char path[PKG_PATH_MAX], const char *oat_dir,
131 const char *apk_path, const char *instruction_set);
132
133bool calculate_odex_file_path_default(char path[PKG_PATH_MAX], const char *apk_path,
134 const char *instruction_set);
135
136bool create_cache_path_default(char path[PKG_PATH_MAX], const char *src,
137 const char *instruction_set);
138
Calin Juravle824a64d2018-01-18 20:23:17 -0800139bool move_ab(const char* apk_path, const char* instruction_set, const char* output_path);
140
Calin Juravlef74a7372019-02-28 20:29:41 -0800141const char* select_execution_binary(
142 const char* binary,
143 const char* debug_binary,
144 bool background_job_compile,
145 bool is_debug_runtime,
146 bool is_release,
147 bool is_debuggable_build);
148
Jeff Sharkey6c2c0562016-12-07 12:12:00 -0700149} // namespace installd
150} // namespace android
151
152#endif // DEXOPT_H_