1 /* 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 20 #include "installd_constants.h" 21 #include "unique_file.h" 22 23 #include <sys/types.h> 24 25 #include <optional> 26 27 #include <cutils/multiuser.h> 28 29 namespace android { 30 namespace installd { 31 32 /* dexopt needed flags matching those in dalvik.system.DexFile */ 33 static constexpr int NO_DEXOPT_NEEDED = 0; 34 static constexpr int DEX2OAT_FROM_SCRATCH = 1; 35 static constexpr int DEX2OAT_FOR_BOOT_IMAGE = 2; 36 static constexpr int DEX2OAT_FOR_FILTER = 3; 37 38 #define ANDROID_ART_APEX_BIN "/apex/com.android.art/bin" 39 // Location of binaries in the Android Runtime APEX. 40 static constexpr const char* kDex2oat32Path = ANDROID_ART_APEX_BIN "/dex2oat32"; 41 static constexpr const char* kDex2oat64Path = ANDROID_ART_APEX_BIN "/dex2oat64"; 42 static constexpr const char* kDex2oatDebug32Path = ANDROID_ART_APEX_BIN "/dex2oatd32"; 43 static constexpr const char* kDex2oatDebug64Path = ANDROID_ART_APEX_BIN "/dex2oatd64"; 44 static constexpr const char* kProfmanPath = ANDROID_ART_APEX_BIN "/profman"; 45 static constexpr const char* kProfmanDebugPath = ANDROID_ART_APEX_BIN "/profmand"; 46 static constexpr const char* kDexoptanalyzerPath = ANDROID_ART_APEX_BIN "/dexoptanalyzer"; 47 static constexpr const char* kDexoptanalyzerDebugPath = ANDROID_ART_APEX_BIN "/dexoptanalyzerd"; 48 #undef ANDROID_ART_APEX_BIN 49 50 // Clear the reference profile identified by the given profile name. 51 bool clear_primary_reference_profile(const std::string& pkgname, const std::string& profile_name); 52 // Clear the current profile identified by the given profile name (for single user). 53 bool clear_primary_current_profile(const std::string& pkgname, const std::string& profile_name, 54 userid_t user); 55 // Clear all current profiles identified by the given profile name (all users). 56 bool clear_primary_current_profiles(const std::string& pkgname, const std::string& profile_name); 57 58 // Decides if profile guided compilation is needed or not based on existing profiles. 59 // The analysis is done for a single profile name (which corresponds to a single code path). 60 // 61 // Returns PROFILES_ANALYSIS_OPTIMIZE if there is enough information in the current profiles 62 // that makes it worth to recompile the package. 63 // If the return value is PROFILES_ANALYSIS_OPTIMIZE all the current profiles would have been 64 // merged into the reference profiles accessible with open_reference_profile(). 65 // 66 // Return PROFILES_ANALYSIS_DONT_OPTIMIZE_SMALL_DELTA if the package should not optimize. 67 // As a special case returns PROFILES_ANALYSIS_DONT_OPTIMIZE_EMPTY_PROFILES if all profiles are 68 // empty. 69 int analyze_primary_profiles(uid_t uid, 70 const std::string& pkgname, 71 const std::string& profile_name); 72 73 // Create a snapshot of the profile information for the given package profile. 74 // If appId is -1, the method creates the profile snapshot for the boot image. 75 // 76 // The profile snapshot is the aggregation of all existing profiles (all current user 77 // profiles & the reference profile) and is meant to capture the all the profile information 78 // without performing a merge into the reference profile which might impact future dex2oat 79 // compilations. 80 // The snapshot is created next to the reference profile of the package and the 81 // ownership is assigned to AID_SYSTEM. 82 // The snapshot location is reference_profile_location.snapshot. If a snapshot is already 83 // there, it will be truncated and overwritten. 84 // 85 // The classpath acts as filter: only profiling data belonging to elements of the classpath 86 // will end up in the snapshot. 87 bool create_profile_snapshot(int32_t app_id, 88 const std::string& package, 89 const std::string& profile_name, 90 const std::string& classpath); 91 92 bool dump_profiles(int32_t uid, const std::string& pkgname, const std::string& profile_name, 93 const std::string& code_path, bool dump_classes_and_methods); 94 95 bool copy_system_profile(const std::string& system_profile, 96 uid_t packageUid, 97 const std::string& pkgname, 98 const std::string& profile_name); 99 100 // Prepares the app profile for the package at the given path: 101 // - Creates the current profile for the given user ID, unless the user ID is `USER_NULL`. 102 // - Merges the profile from the dex metadata file (if present) into the reference profile. 103 bool prepare_app_profile(const std::string& package_name, 104 userid_t user_id, 105 appid_t app_id, 106 const std::string& profile_name, 107 const std::string& code_path, 108 const std::optional<std::string>& dex_metadata); 109 110 // Returns the total bytes that were freed, or -1 in case of errors. 111 int64_t delete_odex(const char* apk_path, const char* instruction_set, const char* output_path); 112 113 bool reconcile_secondary_dex_file(const std::string& dex_path, 114 const std::string& pkgname, int uid, const std::vector<std::string>& isas, 115 const std::optional<std::string>& volumeUuid, int storage_flag, 116 /*out*/bool* out_secondary_dex_exists); 117 118 bool hash_secondary_dex_file(const std::string& dex_path, 119 const std::string& pkgname, int uid, const std::optional<std::string>& volume_uuid, 120 int storage_flag, std::vector<uint8_t>* out_secondary_dex_hash); 121 122 // completed pass false if it is canceled. Otherwise it will be true even if there is other 123 // error. 124 int 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, 126 const char* volume_uuid, const char* class_loader_context, const char* se_info, 127 bool downgrade, int target_sdk_version, const char* profile_name, 128 const char* dexMetadataPath, const char* compilation_reason, std::string* error_msg, 129 /* out */ bool* completed = nullptr); 130 131 bool is_dexopt_blocked(); 132 133 void control_dexopt_blocking(bool block); 134 135 bool calculate_oat_file_path_default(char path[PKG_PATH_MAX], const char *oat_dir, 136 const char *apk_path, const char *instruction_set); 137 138 bool calculate_odex_file_path_default(char path[PKG_PATH_MAX], const char *apk_path, 139 const char *instruction_set); 140 141 bool create_cache_path_default(char path[PKG_PATH_MAX], const char *src, 142 const char *instruction_set); 143 144 bool move_ab(const char* apk_path, const char* instruction_set, const char* output_path); 145 146 const char* select_execution_binary( 147 const char* binary, 148 const char* debug_binary, 149 bool background_job_compile, 150 bool is_debug_runtime, 151 bool is_release, 152 bool is_debuggable_build); 153 154 // Returns `ODEX_NOT_FOUND` if the optimized artifacts are not found, or `ODEX_IS_PUBLIC` if the 155 // optimized artifacts are accessible by all apps, or `ODEX_IS_PRIVATE` if the optimized artifacts 156 // are only accessible by this app, or -1 if failed to get the visibility of the optimized 157 // artifacts. 158 int get_odex_visibility(const char* apk_path, const char* instruction_set, const char* oat_dir); 159 160 UniqueFile maybe_open_reference_profile(const std::string& pkgname, const std::string& dex_path, 161 const char* profile_name, bool profile_guided, 162 bool is_public, int uid, bool is_secondary_dex); 163 164 } // namespace installd 165 } // namespace android 166 167 #endif // DEXOPT_H_ 168