Home | History | Annotate | Download | only in installd
      1 /*
      2 **
      3 ** Copyright 2008, The Android Open Source Project
      4 **
      5 ** Licensed under the Apache License, Version 2.0 (the "License");
      6 ** you may not use this file except in compliance with the License.
      7 ** You may obtain a copy of the License at
      8 **
      9 **     http://www.apache.org/licenses/LICENSE-2.0
     10 **
     11 ** Unless required by applicable law or agreed to in writing, software
     12 ** distributed under the License is distributed on an "AS IS" BASIS,
     13 ** WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     14 ** See the License for the specific language governing permissions and
     15 ** limitations under the License.
     16 */
     17 
     18 #ifndef UTILS_H_
     19 #define UTILS_H_
     20 
     21 #include <string>
     22 #include <vector>
     23 
     24 #include <dirent.h>
     25 #include <inttypes.h>
     26 #include <unistd.h>
     27 #include <utime.h>
     28 
     29 #include <cutils/multiuser.h>
     30 
     31 #include <installd_constants.h>
     32 
     33 #define MEASURE_DEBUG 0
     34 #define FIXUP_DEBUG 0
     35 
     36 #define BYPASS_QUOTA 0
     37 #define BYPASS_SDCARDFS 0
     38 
     39 namespace android {
     40 namespace installd {
     41 
     42 constexpr const char* kXattrInodeCache = "user.inode_cache";
     43 constexpr const char* kXattrInodeCodeCache = "user.inode_code_cache";
     44 constexpr const char* kXattrCacheGroup = "user.cache_group";
     45 constexpr const char* kXattrCacheTombstone = "user.cache_tombstone";
     46 
     47 std::string create_data_path(const char* volume_uuid);
     48 
     49 std::string create_data_app_path(const char* volume_uuid);
     50 std::string create_data_app_package_path(const char* volume_uuid, const char* package_name);
     51 
     52 std::string create_data_user_ce_path(const char* volume_uuid, userid_t userid);
     53 std::string create_data_user_de_path(const char* volume_uuid, userid_t userid);
     54 
     55 std::string create_data_user_ce_package_path(const char* volume_uuid,
     56         userid_t user, const char* package_name);
     57 std::string create_data_user_ce_package_path(const char* volume_uuid,
     58         userid_t user, const char* package_name, ino_t ce_data_inode);
     59 std::string create_data_user_de_package_path(const char* volume_uuid,
     60         userid_t user, const char* package_name);
     61 std::string create_data_user_ce_package_path_as_user_link(
     62         const char* volume_uuid, userid_t userid, const char* package_name);
     63 
     64 std::string create_data_misc_ce_rollback_base_path(const char* volume_uuid, userid_t user);
     65 std::string create_data_misc_de_rollback_base_path(const char* volume_uuid, userid_t user);
     66 std::string create_data_misc_ce_rollback_path(const char* volume_uuid, userid_t user,
     67         int32_t snapshot_id);
     68 std::string create_data_misc_de_rollback_path(const char* volume_uuid, userid_t user,
     69         int32_t snapshot_id);
     70 std::string create_data_misc_ce_rollback_package_path(const char* volume_uuid,
     71         userid_t user, int32_t snapshot_id, const char* package_name);
     72 std::string create_data_misc_ce_rollback_package_path(const char* volume_uuid,
     73         userid_t user, int32_t snapshot_id, const char* package_name, ino_t ce_rollback_inode);
     74 std::string create_data_misc_de_rollback_package_path(const char* volume_uuid,
     75         userid_t user, int32_t snapshot_id, const char* package_name);
     76 
     77 std::string create_data_media_path(const char* volume_uuid, userid_t userid);
     78 std::string create_data_media_package_path(const char* volume_uuid, userid_t userid,
     79         const char* data_type, const char* package_name);
     80 
     81 std::string create_data_misc_legacy_path(userid_t userid);
     82 
     83 std::string create_data_dalvik_cache_path();
     84 
     85 std::string create_primary_cur_profile_dir_path(userid_t userid);
     86 std::string create_primary_current_profile_package_dir_path(
     87         userid_t user, const std::string& package_name);
     88 
     89 std::string create_primary_ref_profile_dir_path();
     90 std::string create_primary_reference_profile_package_dir_path(const std::string& package_name);
     91 
     92 std::string create_current_profile_path(
     93         userid_t user,
     94         const std::string& package_name,
     95         const std::string& location,
     96         bool is_secondary_dex);
     97 std::string create_reference_profile_path(
     98         const std::string& package_name,
     99         const std::string& location,
    100         bool is_secondary_dex);
    101 std::string create_snapshot_profile_path(
    102         const std::string& package,
    103         const std::string& profile_name);
    104 
    105 std::vector<userid_t> get_known_users(const char* volume_uuid);
    106 
    107 int calculate_tree_size(const std::string& path, int64_t* size,
    108         int32_t include_gid = -1, int32_t exclude_gid = -1, bool exclude_apps = false);
    109 
    110 int create_user_config_path(char path[PKG_PATH_MAX], userid_t userid);
    111 
    112 bool is_valid_filename(const std::string& name);
    113 bool is_valid_package_name(const std::string& packageName);
    114 
    115 int create_dir_if_needed(const std::string& pathname, mode_t mode);
    116 
    117 int delete_dir_contents(const std::string& pathname, bool ignore_if_missing = false);
    118 int delete_dir_contents_and_dir(const std::string& pathname, bool ignore_if_missing = false);
    119 
    120 int delete_dir_contents(const char *pathname,
    121                         int also_delete_dir,
    122                         int (*exclusion_predicate)(const char *name, const int is_dir),
    123                         bool ignore_if_missing = false);
    124 
    125 int delete_dir_contents_fd(int dfd, const char *name);
    126 
    127 int rm_package_dir(const std::string& package_dir);
    128 
    129 int copy_dir_files(const char *srcname, const char *dstname, uid_t owner, gid_t group);
    130 
    131 int64_t data_disk_free(const std::string& data_path);
    132 
    133 int get_path_inode(const std::string& path, ino_t *inode);
    134 
    135 int write_path_inode(const std::string& parent, const char* name, const char* inode_xattr);
    136 std::string read_path_inode(const std::string& parent, const char* name, const char* inode_xattr);
    137 void remove_path_xattr(const std::string& path, const char* inode_xattr);
    138 
    139 int validate_system_app_path(const char* path);
    140 bool validate_secondary_dex_path(const std::string& pkgname, const std::string& dex_path,
    141         const char* volume_uuid, int uid, int storage_flag);
    142 
    143 int validate_apk_path(const char *path);
    144 int validate_apk_path_subdirs(const char *path);
    145 
    146 int ensure_config_user_dirs(userid_t userid);
    147 
    148 int wait_child(pid_t pid);
    149 
    150 int prepare_app_cache_dir(const std::string& parent, const char* name, mode_t target_mode,
    151         uid_t uid, gid_t gid);
    152 
    153 // Collect all non empty profiles from the global profile directory and
    154 // put then into profile_paths. The profiles are identified based on PROFILE_EXT extension.
    155 // If a subdirectory or profile file cannot be opened the method logs a warning and moves on.
    156 // It returns true if there were no errors at all, and false otherwise.
    157 bool collect_profiles(std::vector<std::string>* profiles_paths);
    158 
    159 void drop_capabilities(uid_t uid);
    160 
    161 }  // namespace installd
    162 }  // namespace android
    163 
    164 #endif  // UTILS_H_
    165