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 #define APPLY_HARD_QUOTAS 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 std::string create_data_app_package_path(const char* volume_uuid, const char* package_name); 53 54 std::string create_data_user_ce_path(const char* volume_uuid, userid_t userid); 55 std::string create_data_user_de_path(const char* volume_uuid, userid_t userid); 56 57 std::string create_data_user_ce_package_path(const char* volume_uuid, 58 userid_t user, const char* package_name); 59 std::string create_data_user_ce_package_path(const char* volume_uuid, 60 userid_t user, const char* package_name, ino_t ce_data_inode); 61 std::string create_data_user_de_package_path(const char* volume_uuid, 62 userid_t user, const char* package_name); 63 std::string create_data_user_ce_package_path_as_user_link( 64 const char* volume_uuid, userid_t userid, const char* package_name); 65 66 std::string create_data_media_path(const char* volume_uuid, userid_t userid); 67 std::string create_data_media_obb_path(const char* volume_uuid, const char* package_name); 68 std::string create_data_media_package_path(const char* volume_uuid, userid_t userid, 69 const char* data_type, const char* package_name); 70 71 std::string create_data_misc_legacy_path(userid_t userid); 72 73 std::string create_data_dalvik_cache_path(); 74 75 std::string create_primary_cur_profile_dir_path(userid_t userid); 76 std::string create_primary_current_profile_package_dir_path( 77 userid_t user, const std::string& package_name); 78 79 std::string create_primary_ref_profile_dir_path(); 80 std::string create_primary_reference_profile_package_dir_path(const std::string& package_name); 81 82 std::string create_current_profile_path( 83 userid_t user, 84 const std::string& package_name, 85 const std::string& location, 86 bool is_secondary_dex); 87 std::string create_reference_profile_path( 88 const std::string& package_name, 89 const std::string& location, 90 bool is_secondary_dex); 91 std::string create_snapshot_profile_path( 92 const std::string& package, 93 const std::string& profile_name); 94 95 std::vector<userid_t> get_known_users(const char* volume_uuid); 96 97 int calculate_tree_size(const std::string& path, int64_t* size, 98 int32_t include_gid = -1, int32_t exclude_gid = -1, bool exclude_apps = false); 99 100 int create_user_config_path(char path[PKG_PATH_MAX], userid_t userid); 101 102 bool is_valid_filename(const std::string& name); 103 bool is_valid_package_name(const std::string& packageName); 104 105 int delete_dir_contents(const std::string& pathname, bool ignore_if_missing = false); 106 int delete_dir_contents_and_dir(const std::string& pathname, bool ignore_if_missing = false); 107 108 int delete_dir_contents(const char *pathname, 109 int also_delete_dir, 110 int (*exclusion_predicate)(const char *name, const int is_dir), 111 bool ignore_if_missing = false); 112 113 int delete_dir_contents_fd(int dfd, const char *name); 114 115 int copy_dir_files(const char *srcname, const char *dstname, uid_t owner, gid_t group); 116 117 int64_t data_disk_free(const std::string& data_path); 118 119 int get_path_inode(const std::string& path, ino_t *inode); 120 121 int write_path_inode(const std::string& parent, const char* name, const char* inode_xattr); 122 std::string read_path_inode(const std::string& parent, const char* name, const char* inode_xattr); 123 void remove_path_xattr(const std::string& path, const char* inode_xattr); 124 125 int validate_system_app_path(const char* path); 126 bool validate_secondary_dex_path(const std::string& pkgname, const std::string& dex_path, 127 const char* volume_uuid, int uid, int storage_flag); 128 129 int validate_apk_path(const char *path); 130 int validate_apk_path_subdirs(const char *path); 131 132 int ensure_config_user_dirs(userid_t userid); 133 134 int wait_child(pid_t pid); 135 136 int prepare_app_cache_dir(const std::string& parent, const char* name, mode_t target_mode, 137 uid_t uid, gid_t gid); 138 139 // Collect all non empty profiles from the global profile directory and 140 // put then into profile_paths. The profiles are identified based on PROFILE_EXT extension. 141 // If a subdirectory or profile file cannot be opened the method logs a warning and moves on. 142 // It returns true if there were no errors at all, and false otherwise. 143 bool collect_profiles(std::vector<std::string>* profiles_paths); 144 145 } // namespace installd 146 } // namespace android 147 148 #endif // UTILS_H_ 149