Andreas Gampe | 02d0de5 | 2015-11-11 20:43:16 -0800 | [diff] [blame] | 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 | |
Jeff Sharkey | df2d754 | 2017-01-07 09:19:35 -0700 | [diff] [blame] | 33 | #define MEASURE_DEBUG 0 |
Jeff Sharkey | e12d596 | 2017-04-03 16:41:02 -0600 | [diff] [blame] | 34 | #define FIXUP_DEBUG 0 |
Jeff Sharkey | df2d754 | 2017-01-07 09:19:35 -0700 | [diff] [blame] | 35 | |
Jeff Sharkey | d712f0c | 2017-05-03 11:36:42 -0600 | [diff] [blame] | 36 | #define BYPASS_QUOTA 0 |
| 37 | #define BYPASS_SDCARDFS 0 |
| 38 | |
Jeff Sharkey | 4f7be17 | 2017-08-11 15:13:31 -0600 | [diff] [blame] | 39 | #define APPLY_HARD_QUOTAS 1 |
| 40 | |
Andreas Gampe | 02d0de5 | 2015-11-11 20:43:16 -0800 | [diff] [blame] | 41 | namespace android { |
| 42 | namespace installd { |
| 43 | |
Jeff Sharkey | 9a998f4 | 2016-07-14 18:16:22 -0600 | [diff] [blame] | 44 | constexpr const char* kXattrInodeCache = "user.inode_cache"; |
| 45 | constexpr const char* kXattrInodeCodeCache = "user.inode_code_cache"; |
Jeff Sharkey | ed909ae | 2017-03-22 21:27:40 -0600 | [diff] [blame] | 46 | constexpr const char* kXattrCacheGroup = "user.cache_group"; |
Jeff Sharkey | 871a8f2 | 2017-02-21 18:30:28 -0700 | [diff] [blame] | 47 | constexpr const char* kXattrCacheTombstone = "user.cache_tombstone"; |
Jeff Sharkey | 9a998f4 | 2016-07-14 18:16:22 -0600 | [diff] [blame] | 48 | |
Andreas Gampe | 02d0de5 | 2015-11-11 20:43:16 -0800 | [diff] [blame] | 49 | std::string create_data_path(const char* volume_uuid); |
| 50 | |
| 51 | std::string create_data_app_path(const char* volume_uuid); |
Andreas Gampe | 02d0de5 | 2015-11-11 20:43:16 -0800 | [diff] [blame] | 52 | std::string create_data_app_package_path(const char* volume_uuid, const char* package_name); |
| 53 | |
Jeff Sharkey | 2f720f7 | 2016-04-10 20:51:40 -0600 | [diff] [blame] | 54 | std::string create_data_user_ce_path(const char* volume_uuid, userid_t userid); |
Andreas Gampe | 02d0de5 | 2015-11-11 20:43:16 -0800 | [diff] [blame] | 55 | std::string create_data_user_de_path(const char* volume_uuid, userid_t userid); |
| 56 | |
Jeff Sharkey | 2f720f7 | 2016-04-10 20:51:40 -0600 | [diff] [blame] | 57 | std::string create_data_user_ce_package_path(const char* volume_uuid, |
Andreas Gampe | 02d0de5 | 2015-11-11 20:43:16 -0800 | [diff] [blame] | 58 | userid_t user, const char* package_name); |
Jeff Sharkey | 2f720f7 | 2016-04-10 20:51:40 -0600 | [diff] [blame] | 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); |
Andreas Gampe | 02d0de5 | 2015-11-11 20:43:16 -0800 | [diff] [blame] | 61 | std::string create_data_user_de_package_path(const char* volume_uuid, |
| 62 | userid_t user, const char* package_name); |
Calin Juravle | 7d76546 | 2017-09-04 15:57:10 -0700 | [diff] [blame] | 63 | std::string create_data_user_ce_package_path_as_user_link( |
| 64 | const char* volume_uuid, userid_t userid, const char* package_name); |
Andreas Gampe | 02d0de5 | 2015-11-11 20:43:16 -0800 | [diff] [blame] | 65 | |
| 66 | std::string create_data_media_path(const char* volume_uuid, userid_t userid); |
Jeff Sharkey | df2d754 | 2017-01-07 09:19:35 -0700 | [diff] [blame] | 67 | std::string create_data_media_obb_path(const char* volume_uuid, const char* package_name); |
Jeff Sharkey | 3dfae0c | 2016-12-12 17:32:56 -0700 | [diff] [blame] | 68 | std::string create_data_media_package_path(const char* volume_uuid, userid_t userid, |
| 69 | const char* data_type, const char* package_name); |
Andreas Gampe | 02d0de5 | 2015-11-11 20:43:16 -0800 | [diff] [blame] | 70 | |
Jeff Sharkey | 379a12b | 2016-04-14 20:45:06 -0600 | [diff] [blame] | 71 | std::string create_data_misc_legacy_path(userid_t userid); |
| 72 | |
Jeff Sharkey | 3dfae0c | 2016-12-12 17:32:56 -0700 | [diff] [blame] | 73 | std::string create_data_dalvik_cache_path(); |
Jeff Sharkey | 3dfae0c | 2016-12-12 17:32:56 -0700 | [diff] [blame] | 74 | |
Calin Juravle | 114f081 | 2017-03-08 19:05:07 -0800 | [diff] [blame] | 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( |
Calin Juravle | 824a64d | 2018-01-18 20:23:17 -0800 | [diff] [blame] | 83 | userid_t user, |
| 84 | const std::string& package_name, |
| 85 | const std::string& location, |
| 86 | bool is_secondary_dex); |
Calin Juravle | 114f081 | 2017-03-08 19:05:07 -0800 | [diff] [blame] | 87 | std::string create_reference_profile_path( |
Calin Juravle | 824a64d | 2018-01-18 20:23:17 -0800 | [diff] [blame] | 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); |
Jeff Sharkey | 90aff26 | 2016-12-12 14:28:24 -0700 | [diff] [blame] | 94 | |
Andreas Gampe | 02d0de5 | 2015-11-11 20:43:16 -0800 | [diff] [blame] | 95 | std::vector<userid_t> get_known_users(const char* volume_uuid); |
| 96 | |
Jeff Sharkey | 3dfae0c | 2016-12-12 17:32:56 -0700 | [diff] [blame] | 97 | int calculate_tree_size(const std::string& path, int64_t* size, |
Jeff Sharkey | df2d754 | 2017-01-07 09:19:35 -0700 | [diff] [blame] | 98 | int32_t include_gid = -1, int32_t exclude_gid = -1, bool exclude_apps = false); |
Jeff Sharkey | 3dfae0c | 2016-12-12 17:32:56 -0700 | [diff] [blame] | 99 | |
Andreas Gampe | 02d0de5 | 2015-11-11 20:43:16 -0800 | [diff] [blame] | 100 | int create_user_config_path(char path[PKG_PATH_MAX], userid_t userid); |
| 101 | |
Jeff Sharkey | 423e746 | 2016-12-09 18:18:43 -0700 | [diff] [blame] | 102 | bool is_valid_filename(const std::string& name); |
| 103 | bool is_valid_package_name(const std::string& packageName); |
Andreas Gampe | 02d0de5 | 2015-11-11 20:43:16 -0800 | [diff] [blame] | 104 | |
Calin Juravle | b06f98a | 2016-03-28 15:11:01 +0100 | [diff] [blame] | 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); |
Andreas Gampe | 02d0de5 | 2015-11-11 20:43:16 -0800 | [diff] [blame] | 107 | |
| 108 | int delete_dir_contents(const char *pathname, |
| 109 | int also_delete_dir, |
Calin Juravle | b06f98a | 2016-03-28 15:11:01 +0100 | [diff] [blame] | 110 | int (*exclusion_predicate)(const char *name, const int is_dir), |
| 111 | bool ignore_if_missing = false); |
Andreas Gampe | 02d0de5 | 2015-11-11 20:43:16 -0800 | [diff] [blame] | 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 | |
Andreas Gampe | 02d0de5 | 2015-11-11 20:43:16 -0800 | [diff] [blame] | 117 | int64_t data_disk_free(const std::string& data_path); |
| 118 | |
Jeff Sharkey | 9a998f4 | 2016-07-14 18:16:22 -0600 | [diff] [blame] | 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); |
Ryuki Nakamura | c7342f8 | 2017-09-30 11:57:00 +0900 | [diff] [blame] | 123 | void remove_path_xattr(const std::string& path, const char* inode_xattr); |
Jeff Sharkey | 9a998f4 | 2016-07-14 18:16:22 -0600 | [diff] [blame] | 124 | |
Andreas Gampe | 02d0de5 | 2015-11-11 20:43:16 -0800 | [diff] [blame] | 125 | int validate_system_app_path(const char* path); |
Calin Juravle | 114f081 | 2017-03-08 19:05:07 -0800 | [diff] [blame] | 126 | bool validate_secondary_dex_path(const std::string& pkgname, const std::string& dex_path, |
Calin Juravle | 7d76546 | 2017-09-04 15:57:10 -0700 | [diff] [blame] | 127 | const char* volume_uuid, int uid, int storage_flag); |
Andreas Gampe | 02d0de5 | 2015-11-11 20:43:16 -0800 | [diff] [blame] | 128 | |
Andreas Gampe | 02d0de5 | 2015-11-11 20:43:16 -0800 | [diff] [blame] | 129 | int validate_apk_path(const char *path); |
| 130 | int validate_apk_path_subdirs(const char *path); |
| 131 | |
Andreas Gampe | 02d0de5 | 2015-11-11 20:43:16 -0800 | [diff] [blame] | 132 | int ensure_config_user_dirs(userid_t userid); |
| 133 | |
| 134 | int wait_child(pid_t pid); |
| 135 | |
Calin Juravle | 42451c0 | 2017-01-17 14:43:25 -0800 | [diff] [blame] | 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 | |
Calin Juravle | 0d0a492 | 2018-01-23 19:54:11 -0800 | [diff] [blame] | 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 | |
Andreas Gampe | 02d0de5 | 2015-11-11 20:43:16 -0800 | [diff] [blame] | 145 | } // namespace installd |
| 146 | } // namespace android |
| 147 | |
| 148 | #endif // UTILS_H_ |