/* * Copyright (C) 2016 The Android Open Source Project * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ #ifndef DEXOPT_H_ #define DEXOPT_H_ #include "installd_constants.h" #include #include #include namespace android { namespace installd { /* dexopt needed flags matching those in dalvik.system.DexFile */ static constexpr int NO_DEXOPT_NEEDED = 0; static constexpr int DEX2OAT_FROM_SCRATCH = 1; static constexpr int DEX2OAT_FOR_BOOT_IMAGE = 2; static constexpr int DEX2OAT_FOR_FILTER = 3; #define ANDROID_ART_APEX_BIN "/apex/com.android.art/bin" // Location of binaries in the Android Runtime APEX. static constexpr const char* kDex2oat32Path = ANDROID_ART_APEX_BIN "/dex2oat32"; static constexpr const char* kDex2oat64Path = ANDROID_ART_APEX_BIN "/dex2oat64"; static constexpr const char* kDex2oatDebug32Path = ANDROID_ART_APEX_BIN "/dex2oatd32"; static constexpr const char* kDex2oatDebug64Path = ANDROID_ART_APEX_BIN "/dex2oatd64"; static constexpr const char* kProfmanPath = ANDROID_ART_APEX_BIN "/profman"; static constexpr const char* kProfmanDebugPath = ANDROID_ART_APEX_BIN "/profmand"; static constexpr const char* kDexoptanalyzerPath = ANDROID_ART_APEX_BIN "/dexoptanalyzer"; static constexpr const char* kDexoptanalyzerDebugPath = ANDROID_ART_APEX_BIN "/dexoptanalyzerd"; #undef ANDROID_ART_APEX_BIN // Clear the reference profile identified by the given profile name. bool clear_primary_reference_profile(const std::string& pkgname, const std::string& profile_name); // Clear the current profile identified by the given profile name (for single user). bool clear_primary_current_profile(const std::string& pkgname, const std::string& profile_name, userid_t user); // Clear all current profiles identified by the given profile name (all users). bool clear_primary_current_profiles(const std::string& pkgname, const std::string& profile_name); // Decides if profile guided compilation is needed or not based on existing profiles. // The analysis is done for a single profile name (which corresponds to a single code path). // // Returns PROFILES_ANALYSIS_OPTIMIZE if there is enough information in the current profiles // that makes it worth to recompile the package. // If the return value is PROFILES_ANALYSIS_OPTIMIZE all the current profiles would have been // merged into the reference profiles accessible with open_reference_profile(). // // Return PROFILES_ANALYSIS_DONT_OPTIMIZE_SMALL_DELTA if the package should not optimize. // As a special case returns PROFILES_ANALYSIS_DONT_OPTIMIZE_EMPTY_PROFILES if all profiles are // empty. int analyze_primary_profiles(uid_t uid, const std::string& pkgname, const std::string& profile_name); // Create a snapshot of the profile information for the given package profile. // If appId is -1, the method creates the profile snapshot for the boot image. // // The profile snapshot is the aggregation of all existing profiles (all current user // profiles & the reference profile) and is meant to capture the all the profile information // without performing a merge into the reference profile which might impact future dex2oat // compilations. // The snapshot is created next to the reference profile of the package and the // ownership is assigned to AID_SYSTEM. // The snapshot location is reference_profile_location.snapshot. If a snapshot is already // there, it will be truncated and overwritten. // // The classpath acts as filter: only profiling data belonging to elements of the classpath // will end up in the snapshot. bool create_profile_snapshot(int32_t app_id, const std::string& package, const std::string& profile_name, const std::string& classpath); bool dump_profiles(int32_t uid, const std::string& pkgname, const std::string& profile_name, const std::string& code_path, bool dump_classes_and_methods); bool copy_system_profile(const std::string& system_profile, uid_t packageUid, const std::string& pkgname, const std::string& profile_name); // Prepares the app profile for the package at the given path: // - Creates the current profile for the given user ID, unless the user ID is `USER_NULL`. // - Merges the profile from the dex metadata file (if present) into the reference profile. bool prepare_app_profile(const std::string& package_name, userid_t user_id, appid_t app_id, const std::string& profile_name, const std::string& code_path, const std::optional& dex_metadata); // Returns the total bytes that were freed, or -1 in case of errors. int64_t delete_odex(const char* apk_path, const char* instruction_set, const char* output_path); bool reconcile_secondary_dex_file(const std::string& dex_path, const std::string& pkgname, int uid, const std::vector& isas, const std::optional& volumeUuid, int storage_flag, /*out*/bool* out_secondary_dex_exists); bool hash_secondary_dex_file(const std::string& dex_path, const std::string& pkgname, int uid, const std::optional& volume_uuid, int storage_flag, std::vector* out_secondary_dex_hash); // completed pass false if it is canceled. Otherwise it will be true even if there is other // error. int dexopt(const char *apk_path, uid_t uid, const char *pkgName, const char *instruction_set, int dexopt_needed, const char* oat_dir, int dexopt_flags, const char* compiler_filter, const char* volume_uuid, const char* class_loader_context, const char* se_info, bool downgrade, int target_sdk_version, const char* profile_name, const char* dexMetadataPath, const char* compilation_reason, std::string* error_msg, /* out */ bool* completed = nullptr); bool is_dexopt_blocked(); void control_dexopt_blocking(bool block); bool calculate_oat_file_path_default(char path[PKG_PATH_MAX], const char *oat_dir, const char *apk_path, const char *instruction_set); bool calculate_odex_file_path_default(char path[PKG_PATH_MAX], const char *apk_path, const char *instruction_set); bool create_cache_path_default(char path[PKG_PATH_MAX], const char *src, const char *instruction_set); bool move_ab(const char* apk_path, const char* instruction_set, const char* output_path); const char* select_execution_binary( const char* binary, const char* debug_binary, bool background_job_compile, bool is_debug_runtime, bool is_release, bool is_debuggable_build); // Returns `ODEX_NOT_FOUND` if the optimized artifacts are not found, or `ODEX_IS_PUBLIC` if the // optimized artifacts are accessible by all apps, or `ODEX_IS_PRIVATE` if the optimized artifacts // are only accessible by this app, or -1 if failed to get the visibility of the optimized // artifacts. int get_odex_visibility(const char* apk_path, const char* instruction_set, const char* oat_dir); } // namespace installd } // namespace android #endif // DEXOPT_H_