cmds/installd/utils.h

   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
  35 namespace android {
  36 namespace installd {
  37
  38 struct dir_rec_t;
  39
  40 typedef struct cache_dir_struct {
  41     struct cache_dir_struct* parent;
  42     int32_t childCount;
  43     int32_t hiddenCount;
  44     int32_t deleted;
  45     char name[];
  46 } cache_dir_t;
  47
  48 typedef struct {
  49     cache_dir_t* dir;
  50     time_t modTime;
  51     char name[];
  52 } cache_file_t;
  53
  54 typedef struct {
  55     size_t numDirs;
  56     size_t availDirs;
  57     cache_dir_t** dirs;
  58     size_t numFiles;
  59     size_t availFiles;
  60     cache_file_t** files;
  61     size_t numCollected;
  62     void* memBlocks;
  63     int8_t* curMemBlockAvail;
  64     int8_t* curMemBlockEnd;
  65 } cache_t;
  66
  67 constexpr const char* kXattrInodeCache = "user.inode_cache";
  68 constexpr const char* kXattrInodeCodeCache = "user.inode_code_cache";
  69 constexpr const char* kXattrCacheAtomic = "user.cache_atomic";
  70 constexpr const char* kXattrCacheTombstone = "user.cache_tombstone";
  71
  72 int create_pkg_path(char path[PKG_PATH_MAX],
  73                     const char *pkgname,
  74                     const char *postfix,
  75                     userid_t userid);
  76
  77 std::string create_data_path(const char* volume_uuid);
  78
  79 std::string create_data_app_path(const char* volume_uuid);
  80 std::string create_data_app_package_path(const char* volume_uuid, const char* package_name);
  81
  82 std::string create_data_user_ce_path(const char* volume_uuid, userid_t userid);
  83 std::string create_data_user_de_path(const char* volume_uuid, userid_t userid);
  84
  85 std::string create_data_user_ce_package_path(const char* volume_uuid,
  86         userid_t user, const char* package_name);
  87 std::string create_data_user_ce_package_path(const char* volume_uuid,
  88         userid_t user, const char* package_name, ino_t ce_data_inode);
  89 std::string create_data_user_de_package_path(const char* volume_uuid,
  90         userid_t user, const char* package_name);
  91
  92 std::string create_data_media_path(const char* volume_uuid, userid_t userid);
  93 std::string create_data_media_obb_path(const char* volume_uuid, const char* package_name);
  94 std::string create_data_media_package_path(const char* volume_uuid, userid_t userid,
  95         const char* data_type, const char* package_name);
  96
  97 std::string create_data_misc_legacy_path(userid_t userid);
  98
  99 std::string create_data_dalvik_cache_path();
 100
 101 std::string create_primary_cur_profile_dir_path(userid_t userid);
 102 std::string create_primary_current_profile_package_dir_path(
 103         userid_t user, const std::string& package_name);
 104
 105 std::string create_primary_ref_profile_dir_path();
 106 std::string create_primary_reference_profile_package_dir_path(const std::string& package_name);
 107
 108 std::string create_current_profile_path(
 109         userid_t user, const std::string& package_name, bool is_secondary_dex);
 110 std::string create_reference_profile_path(
 111         const std::string& package_name, bool is_secondary_dex);
 112
 113 std::vector<userid_t> get_known_users(const char* volume_uuid);
 114
 115 int calculate_tree_size(const std::string& path, int64_t* size,
 116         int32_t include_gid = -1, int32_t exclude_gid = -1, bool exclude_apps = false);
 117
 118 int create_user_config_path(char path[PKG_PATH_MAX], userid_t userid);
 119
 120 int create_move_path(char path[PKG_PATH_MAX],
 121                      const char* pkgname,
 122                      const char* leaf,
 123                      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 delete_dir_contents(const std::string& pathname, bool ignore_if_missing = false);
 129 int delete_dir_contents_and_dir(const std::string& pathname, bool ignore_if_missing = false);
 130
 131 int delete_dir_contents(const char *pathname,
 132                         int also_delete_dir,
 133                         int (*exclusion_predicate)(const char *name, const int is_dir),
 134                         bool ignore_if_missing = false);
 135
 136 int delete_dir_contents_fd(int dfd, const char *name);
 137
 138 int copy_dir_files(const char *srcname, const char *dstname, uid_t owner, gid_t group);
 139
 140 int64_t data_disk_free(const std::string& data_path);
 141
 142 cache_t* start_cache_collection();
 143
 144 int get_path_inode(const std::string& path, ino_t *inode);
 145
 146 int write_path_inode(const std::string& parent, const char* name, const char* inode_xattr);
 147 std::string read_path_inode(const std::string& parent, const char* name, const char* inode_xattr);
 148
 149 void add_cache_files(cache_t* cache, const std::string& data_path);
 150
 151 void add_preloads_file_cache(cache_t* cache, const char* volume_uuid);
 152
 153 void clear_cache_files(const std::string& data_path, cache_t* cache, int64_t free_size);
 154
 155 void finish_cache_collection(cache_t* cache);
 156
 157 int validate_system_app_path(const char* path);
 158 bool validate_secondary_dex_path(const std::string& pkgname, const std::string& dex_path,
 159         const char* volume_uuid, int uid, int storage_flag);
 160
 161 int get_path_from_env(dir_rec_t* rec, const char* var);
 162
 163 int get_path_from_string(dir_rec_t* rec, const char* path);
 164
 165 int copy_and_append(dir_rec_t* dst, const dir_rec_t* src, const char* suffix);
 166
 167 int validate_apk_path(const char *path);
 168 int validate_apk_path_subdirs(const char *path);
 169
 170 int append_and_increment(char** dst, const char* src, size_t* dst_size);
 171
 172 char *build_string2(const char *s1, const char *s2);
 173 char *build_string3(const char *s1, const char *s2, const char *s3);
 174
 175 int ensure_config_user_dirs(userid_t userid);
 176
 177 int wait_child(pid_t pid);
 178
 179 int prepare_app_cache_dir(const std::string& parent, const char* name, mode_t target_mode,
 180         uid_t uid, gid_t gid);
 181
 182 }  // namespace installd
 183 }  // namespace android
 184
 185 #endif  // UTILS_H_