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 <functional> 22 #include <string> 23 #include <vector> 24 25 #include <dirent.h> 26 #include <inttypes.h> 27 #include <unistd.h> 28 #include <utime.h> 29 30 #include <cutils/multiuser.h> 31 32 #include <installd_constants.h> 33 34 #define MEASURE_DEBUG 0 35 #define FIXUP_DEBUG 0 36 #define SDK_DEBUG 1 37 38 #define BYPASS_QUOTA 0 39 #define BYPASS_SDCARDFS 0 40 41 namespace android { 42 namespace installd { 43 44 constexpr const char* kXattrInodeCache = "user.inode_cache"; 45 constexpr const char* kXattrInodeCodeCache = "user.inode_code_cache"; 46 constexpr const char* kXattrCacheGroup = "user.cache_group"; 47 constexpr const char* kXattrCacheTombstone = "user.cache_tombstone"; 48 49 std::string create_data_path(const char* volume_uuid); 50 51 std::string create_data_app_path(const char* volume_uuid); 52 53 std::string create_data_user_ce_path(const char* volume_uuid, userid_t userid); 54 std::string create_data_user_de_path(const char* volume_uuid, userid_t userid); 55 56 std::string create_data_user_ce_package_path(const char* volume_uuid, 57 userid_t user, const char* package_name); 58 std::string create_data_user_ce_package_path(const char* volume_uuid, 59 userid_t user, const char* package_name, ino_t ce_data_inode); 60 std::string create_data_user_de_package_path(const char* volume_uuid, 61 userid_t user, const char* package_name); 62 std::string create_data_user_ce_package_path_as_user_link( 63 const char* volume_uuid, userid_t userid, const char* package_name); 64 65 std::string create_data_misc_sdk_sandbox_path(const char* volume_uuid, bool isCeData, 66 userid_t userid); 67 std::string create_data_misc_sdk_sandbox_package_path(const char* volume_uuid, bool isCeData, 68 userid_t userid, const char* package_name); 69 std::string create_data_misc_sdk_sandbox_sdk_path(const char* volume_uuid, bool isCeData, 70 userid_t userid, const char* package_name, 71 const char* sub_dir_name); 72 73 std::string create_data_misc_ce_rollback_base_path(const char* volume_uuid, userid_t user); 74 std::string create_data_misc_de_rollback_base_path(const char* volume_uuid, userid_t user); 75 std::string create_data_misc_ce_rollback_path(const char* volume_uuid, userid_t user, 76 int32_t snapshot_id); 77 std::string create_data_misc_de_rollback_path(const char* volume_uuid, userid_t user, 78 int32_t snapshot_id); 79 std::string create_data_misc_ce_rollback_package_path(const char* volume_uuid, 80 userid_t user, int32_t snapshot_id, const char* package_name); 81 std::string create_data_misc_ce_rollback_package_path(const char* volume_uuid, 82 userid_t user, int32_t snapshot_id, const char* package_name, ino_t ce_rollback_inode); 83 std::string create_data_misc_de_rollback_package_path(const char* volume_uuid, 84 userid_t user, int32_t snapshot_id, const char* package_name); 85 86 std::string create_data_media_path(const char* volume_uuid, userid_t userid); 87 std::string create_data_media_package_path(const char* volume_uuid, userid_t userid, 88 const char* data_type, const char* package_name); 89 90 std::string create_data_misc_legacy_path(userid_t userid); 91 92 std::string create_data_dalvik_cache_path(); 93 94 std::string create_system_user_ce_path(userid_t userId); 95 96 std::string create_system_user_ce_package_path(userid_t userId, const char* package_name); 97 98 std::string create_primary_cur_profile_dir_path(userid_t userid); 99 std::string create_primary_current_profile_package_dir_path( 100 userid_t user, const std::string& package_name); 101 102 std::string create_primary_ref_profile_dir_path(); 103 std::string create_primary_reference_profile_package_dir_path(const std::string& package_name); 104 105 std::string create_current_profile_path( 106 userid_t user, 107 const std::string& package_name, 108 const std::string& location, 109 bool is_secondary_dex); 110 std::string create_reference_profile_path( 111 const std::string& package_name, 112 const std::string& location, 113 bool is_secondary_dex); 114 std::string create_snapshot_profile_path( 115 const std::string& package, 116 const std::string& profile_name); 117 118 std::vector<userid_t> get_known_users(const char* volume_uuid); 119 120 int calculate_tree_size(const std::string& path, int64_t* size, 121 int32_t include_gid = -1, int32_t exclude_gid = -1, bool exclude_apps = false); 122 123 int create_user_config_path(char path[PKG_PATH_MAX], userid_t userid); 124 125 bool is_valid_filename(const std::string& name); 126 bool is_valid_package_name(const std::string& packageName); 127 128 int create_dir_if_needed(const std::string& pathname, mode_t mode); 129 130 int delete_dir_contents(const std::string& pathname, bool ignore_if_missing = false); 131 int delete_dir_contents_and_dir(const std::string& pathname, bool ignore_if_missing = false); 132 133 bool is_renamed_deleted_dir(const std::string& path); 134 int rename_delete_dir_contents_and_dir(const std::string& pathname, bool ignore_if_missing = true); 135 136 int foreach_subdir(const std::string& pathname, std::function<void(const std::string&)> fn); 137 138 void cleanup_invalid_package_dirs_under_path(const std::string& pathname); 139 140 int delete_dir_contents(const char *pathname, 141 int also_delete_dir, 142 int (*exclusion_predicate)(const char *name, const int is_dir), 143 bool ignore_if_missing = false); 144 145 int delete_dir_contents_fd(int dfd, const char *name); 146 147 int rm_package_dir(const std::string& package_dir); 148 149 int copy_dir_files(const char *srcname, const char *dstname, uid_t owner, gid_t group); 150 151 int64_t data_disk_free(const std::string& data_path); 152 153 int get_path_inode(const std::string& path, ino_t *inode); 154 155 int write_path_inode(const std::string& parent, const char* name, const char* inode_xattr); 156 std::string read_path_inode(const std::string& parent, const char* name, const char* inode_xattr); 157 void remove_path_xattr(const std::string& path, const char* inode_xattr); 158 159 int validate_system_app_path(const char* path); 160 bool validate_secondary_dex_path(const std::string& pkgname, const std::string& dex_path, 161 const char* volume_uuid, int uid, int storage_flag); 162 163 int validate_apk_path(const char *path); 164 int validate_apk_path_subdirs(const char *path); 165 166 int ensure_config_user_dirs(userid_t userid); 167 168 // Waits for a child process, or kills it if it times out. Returns the exit code. 169 int wait_child_with_timeout(pid_t pid, int timeout_ms); 170 171 int prepare_app_cache_dir(const std::string& parent, const char* name, mode_t target_mode, 172 uid_t uid, gid_t gid); 173 174 bool supports_sdcardfs(); 175 long get_project_id(uid_t uid, long start_project_id_range); 176 int set_quota_project_id(const std::string& path, long project_id, bool set_inherit); 177 int64_t get_occupied_app_space_external(const std::string& uuid, int32_t userId, int32_t appId); 178 int64_t get_occupied_app_cache_space_external(const std::string& uuid, int32_t userId, int32_t appId); 179 180 // Collect all non empty profiles from the global profile directory and 181 // put then into profile_paths. The profiles are identified based on PROFILE_EXT extension. 182 // If a subdirectory or profile file cannot be opened the method logs a warning and moves on. 183 // It returns true if there were no errors at all, and false otherwise. 184 bool collect_profiles(std::vector<std::string>* profiles_paths); 185 186 void drop_capabilities(uid_t uid); 187 188 // Removes a file specified by a file descriptor. Returns true on success. Reports the file path to 189 // `path` if present. 190 bool remove_file_at_fd(int fd, /*out*/ std::string* path = nullptr); 191 192 } // namespace installd 193 } // namespace android 194 195 #endif // UTILS_H_ 196