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