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 22 #include <sys/types.h> 23 24 #include <cutils/multiuser.h> 25 26 namespace android { 27 namespace installd { 28 29 /* dexopt needed flags matching those in dalvik.system.DexFile */ 30 static constexpr int NO_DEXOPT_NEEDED = 0; 31 static constexpr int DEX2OAT_FROM_SCRATCH = 1; 32 static constexpr int DEX2OAT_FOR_BOOT_IMAGE = 2; 33 static constexpr int DEX2OAT_FOR_FILTER = 3; 34 35 #define ANDROID_ART_APEX_BIN "/apex/com.android.art/bin" 36 // Location of binaries in the Android Runtime APEX. 37 static constexpr const char* kDex2oat32Path = ANDROID_ART_APEX_BIN "/dex2oat32"; 38 static constexpr const char* kDex2oat64Path = ANDROID_ART_APEX_BIN "/dex2oat64"; 39 static constexpr const char* kDex2oatDebug32Path = ANDROID_ART_APEX_BIN "/dex2oatd32"; 40 static constexpr const char* kDex2oatDebug64Path = ANDROID_ART_APEX_BIN "/dex2oatd64"; 41 static constexpr const char* kProfmanPath = ANDROID_ART_APEX_BIN "/profman"; 42 static constexpr const char* kProfmanDebugPath = ANDROID_ART_APEX_BIN "/profmand"; 43 static constexpr const char* kDexoptanalyzerPath = ANDROID_ART_APEX_BIN "/dexoptanalyzer"; 44 static constexpr const char* kDexoptanalyzerDebugPath = ANDROID_ART_APEX_BIN "/dexoptanalyzerd"; 45 #undef ANDROID_ART_APEX_BIN 46 47 // Clear the reference profile identified by the given profile name. 48 bool clear_primary_reference_profile(const std::string& pkgname, const std::string& profile_name); 49 // Clear the current profile identified by the given profile name (for single user). 50 bool clear_primary_current_profile(const std::string& pkgname, const std::string& profile_name, 51 userid_t user); 52 // Clear all current profiles identified by the given profile name (all users). 53 bool clear_primary_current_profiles(const std::string& pkgname, const std::string& profile_name); 54 55 // Decide if profile guided compilation is needed or not based on existing profiles. 56 // The analysis is done for a single profile name (which corresponds to a single code path). 57 // Returns true if there is enough information in the current profiles that makes it 58 // worth to recompile the package. 59 // If the return value is true all the current profiles would have been merged into 60 // the reference profiles accessible with open_reference_profile(). 61 bool analyze_primary_profiles(uid_t uid, 62 const std::string& pkgname, 63 const std::string& profile_name); 64 65 // Create a snapshot of the profile information for the given package profile. 66 // If appId is -1, the method creates the profile snapshot for the boot image. 67 // 68 // The profile snapshot is the aggregation of all existing profiles (all current user 69 // profiles & the reference profile) and is meant to capture the all the profile information 70 // without performing a merge into the reference profile which might impact future dex2oat 71 // compilations. 72 // The snapshot is created next to the reference profile of the package and the 73 // ownership is assigned to AID_SYSTEM. 74 // The snapshot location is reference_profile_location.snapshot. If a snapshot is already 75 // there, it will be truncated and overwritten. 76 // 77 // The classpath acts as filter: only profiling data belonging to elements of the classpath 78 // will end up in the snapshot. 79 bool create_profile_snapshot(int32_t app_id, 80 const std::string& package, 81 const std::string& profile_name, 82 const std::string& classpath); 83 84 bool dump_profiles(int32_t uid, 85 const std::string& pkgname, 86 const std::string& profile_name, 87 const std::string& code_path); 88 89 bool copy_system_profile(const std::string& system_profile, 90 uid_t packageUid, 91 const std::string& pkgname, 92 const std::string& profile_name); 93 94 // Prepare the app profile for the given code path: 95 // - create the current profile using profile_name 96 // - merge the profile from the dex metadata file (if present) into 97 // the reference profile. 98 bool prepare_app_profile(const std::string& package_name, 99 userid_t user_id, 100 appid_t app_id, 101 const std::string& profile_name, 102 const std::string& code_path, 103 const std::unique_ptr<std::string>& dex_metadata); 104 105 bool delete_odex(const char* apk_path, const char* instruction_set, const char* output_path); 106 107 bool reconcile_secondary_dex_file(const std::string& dex_path, 108 const std::string& pkgname, int uid, const std::vector<std::string>& isas, 109 const std::unique_ptr<std::string>& volumeUuid, int storage_flag, 110 /*out*/bool* out_secondary_dex_exists); 111 112 bool hash_secondary_dex_file(const std::string& dex_path, 113 const std::string& pkgname, int uid, const std::unique_ptr<std::string>& volume_uuid, 114 int storage_flag, std::vector<uint8_t>* out_secondary_dex_hash); 115 116 int dexopt(const char *apk_path, uid_t uid, const char *pkgName, const char *instruction_set, 117 int dexopt_needed, const char* oat_dir, int dexopt_flags, const char* compiler_filter, 118 const char* volume_uuid, const char* class_loader_context, const char* se_info, 119 bool downgrade, int target_sdk_version, const char* profile_name, 120 const char* dexMetadataPath, const char* compilation_reason, std::string* error_msg); 121 122 bool calculate_oat_file_path_default(char path[PKG_PATH_MAX], const char *oat_dir, 123 const char *apk_path, const char *instruction_set); 124 125 bool calculate_odex_file_path_default(char path[PKG_PATH_MAX], const char *apk_path, 126 const char *instruction_set); 127 128 bool create_cache_path_default(char path[PKG_PATH_MAX], const char *src, 129 const char *instruction_set); 130 131 bool move_ab(const char* apk_path, const char* instruction_set, const char* output_path); 132 133 const char* select_execution_binary( 134 const char* binary, 135 const char* debug_binary, 136 bool background_job_compile, 137 bool is_debug_runtime, 138 bool is_release, 139 bool is_debuggable_build); 140 141 } // namespace installd 142 } // namespace android 143 144 #endif // DEXOPT_H_ 145