Utils.h

   1 /*
   2  * Copyright (C) 2015 The Android Open Source Project
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *      http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #ifndef ANDROID_VOLD_UTILS_H
  18 #define ANDROID_VOLD_UTILS_H
  19
  20 #include "KeyBuffer.h"
  21
  22 #include <android-base/macros.h>
  23 #include <android-base/unique_fd.h>
  24 #include <cutils/multiuser.h>
  25 #include <selinux/selinux.h>
  26 #include <utils/Errors.h>
  27
  28 #include <chrono>
  29 #include <string>
  30 #include <vector>
  31
  32 struct DIR;
  33
  34 namespace android {
  35 namespace vold {
  36
  37 static const char* kVoldAppDataIsolationEnabled = "persist.sys.vold_app_data_isolation_enabled";
  38 static const char* kExternalStorageSdcardfs = "external_storage.sdcardfs.enabled";
  39
  40 /* SELinux contexts used depending on the block device type */
  41 extern security_context_t sBlkidContext;
  42 extern security_context_t sBlkidUntrustedContext;
  43 extern security_context_t sFsckContext;
  44 extern security_context_t sFsckUntrustedContext;
  45
  46 // TODO remove this with better solution, b/64143519
  47 extern bool sSleepOnUnmount;
  48
  49 std::string GetFuseMountPathForUser(userid_t user_id, const std::string& relative_upper_path);
  50
  51 status_t CreateDeviceNode(const std::string& path, dev_t dev);
  52 status_t DestroyDeviceNode(const std::string& path);
  53
  54 status_t SetDefaultAcl(const std::string& path, mode_t mode, uid_t uid, gid_t gid,
  55                        std::vector<gid_t> additionalGids);
  56
  57 status_t AbortFuseConnections();
  58
  59 int SetQuotaInherit(const std::string& path);
  60 int SetQuotaProjectId(const std::string& path, long projectId);
  61 /*
  62  * Creates and sets up an application-specific path on external
  63  * storage with the correct ACL and project ID (if needed).
  64  *
  65  * ONLY for use with app-specific data directories on external storage!
  66  * (eg, /Android/data/com.foo, /Android/obb/com.foo, etc.)
  67  */
  68 int PrepareAppDirFromRoot(const std::string& path, const std::string& root, int appUid,
  69                           bool fixupExisting);
  70
  71 /* fs_prepare_dir wrapper that creates with SELinux context */
  72 status_t PrepareDir(const std::string& path, mode_t mode, uid_t uid, gid_t gid,
  73                     unsigned int attrs = 0);
  74
  75 /* Really unmounts the path, killing active processes along the way */
  76 status_t ForceUnmount(const std::string& path);
  77
  78 /* Kills any processes using given path */
  79 status_t KillProcessesUsingPath(const std::string& path);
  80
  81 /* Kills any processes using given tmpfs mount prifix */
  82 status_t KillProcessesWithTmpfsMountPrefix(const std::string& path);
  83
  84 /* Creates bind mount from source to target */
  85 status_t BindMount(const std::string& source, const std::string& target);
  86
  87 /** Creates a symbolic link to target */
  88 status_t Symlink(const std::string& target, const std::string& linkpath);
  89
  90 /** Calls unlink(2) at linkpath */
  91 status_t Unlink(const std::string& linkpath);
  92
  93 /** Creates the given directory if it is not already available */
  94 status_t CreateDir(const std::string& dir, mode_t mode);
  95
  96 bool FindValue(const std::string& raw, const std::string& key, std::string* value);
  97
  98 /* Reads filesystem metadata from device at path */
  99 status_t ReadMetadata(const std::string& path, std::string* fsType, std::string* fsUuid,
 100                       std::string* fsLabel);
 101
 102 /* Reads filesystem metadata from untrusted device at path */
 103 status_t ReadMetadataUntrusted(const std::string& path, std::string* fsType, std::string* fsUuid,
 104                                std::string* fsLabel);
 105
 106 /* Returns either WEXITSTATUS() status, or a negative errno */
 107 status_t ForkExecvp(const std::vector<std::string>& args, std::vector<std::string>* output = nullptr,
 108                     security_context_t context = nullptr);
 109
 110 pid_t ForkExecvpAsync(const std::vector<std::string>& args);
 111
 112 /* Gets block device size in bytes */
 113 status_t GetBlockDevSize(int fd, uint64_t* size);
 114 status_t GetBlockDevSize(const std::string& path, uint64_t* size);
 115 /* Gets block device size in 512 byte sectors */
 116 status_t GetBlockDev512Sectors(const std::string& path, uint64_t* nr_sec);
 117
 118 status_t ReadRandomBytes(size_t bytes, std::string& out);
 119 status_t ReadRandomBytes(size_t bytes, char* buffer);
 120 status_t GenerateRandomUuid(std::string& out);
 121
 122 /* Converts hex string to raw bytes, ignoring [ :-] */
 123 status_t HexToStr(const std::string& hex, std::string& str);
 124 /* Converts raw bytes to hex string */
 125 status_t StrToHex(const std::string& str, std::string& hex);
 126 /* Converts raw key bytes to hex string */
 127 status_t StrToHex(const KeyBuffer& str, KeyBuffer& hex);
 128 /* Normalize given hex string into consistent format */
 129 status_t NormalizeHex(const std::string& in, std::string& out);
 130
 131 uint64_t GetFreeBytes(const std::string& path);
 132 uint64_t GetTreeBytes(const std::string& path);
 133
 134 bool IsFilesystemSupported(const std::string& fsType);
 135 bool IsSdcardfsUsed();
 136 bool IsFuseDaemon(const pid_t pid);
 137
 138 /* Wipes contents of block device at given path */
 139 status_t WipeBlockDevice(const std::string& path);
 140
 141 std::string BuildKeyPath(const std::string& partGuid);
 142
 143 std::string BuildDataSystemLegacyPath(userid_t userid);
 144 std::string BuildDataSystemCePath(userid_t userid);
 145 std::string BuildDataSystemDePath(userid_t userid);
 146 std::string BuildDataMiscLegacyPath(userid_t userid);
 147 std::string BuildDataMiscCePath(userid_t userid);
 148 std::string BuildDataMiscDePath(userid_t userid);
 149 std::string BuildDataProfilesDePath(userid_t userid);
 150 std::string BuildDataVendorCePath(userid_t userid);
 151 std::string BuildDataVendorDePath(userid_t userid);
 152
 153 std::string BuildDataPath(const std::string& volumeUuid);
 154 std::string BuildDataMediaCePath(const std::string& volumeUuid, userid_t userid);
 155 std::string BuildDataUserCePath(const std::string& volumeUuid, userid_t userid);
 156 std::string BuildDataUserDePath(const std::string& volumeUuid, userid_t userid);
 157
 158 dev_t GetDevice(const std::string& path);
 159
 160 bool IsSameFile(const std::string& path1, const std::string& path2);
 161
 162 status_t EnsureDirExists(const std::string& path, mode_t mode, uid_t uid, gid_t gid);
 163
 164 status_t RestoreconRecursive(const std::string& path);
 165
 166 // TODO: promote to android::base
 167 bool Readlinkat(int dirfd, const std::string& path, std::string* result);
 168
 169 // Handles dynamic major assignment for virtio-block
 170 bool IsVirtioBlkDevice(unsigned int major);
 171
 172 status_t UnmountTreeWithPrefix(const std::string& prefix);
 173 status_t UnmountTree(const std::string& mountPoint);
 174
 175 bool IsDotOrDotDot(const struct dirent& ent);
 176
 177 status_t DeleteDirContentsAndDir(const std::string& pathname);
 178 status_t DeleteDirContents(const std::string& pathname);
 179
 180 status_t WaitForFile(const char* filename, std::chrono::nanoseconds timeout);
 181
 182 bool pathExists(const std::string& path);
 183
 184 bool FsyncDirectory(const std::string& dirname);
 185
 186 bool FsyncParentDirectory(const std::string& path);
 187
 188 bool MkdirsSync(const std::string& path, mode_t mode);
 189
 190 bool writeStringToFile(const std::string& payload, const std::string& filename);
 191
 192 void ConfigureMaxDirtyRatioForFuse(const std::string& fuse_mount, unsigned int max_ratio);
 193
 194 void ConfigureReadAheadForFuse(const std::string& fuse_mount, size_t read_ahead_kb);
 195
 196 status_t MountUserFuse(userid_t user_id, const std::string& absolute_lower_path,
 197                        const std::string& relative_upper_path, android::base::unique_fd* fuse_fd);
 198
 199 status_t UnmountUserFuse(userid_t userId, const std::string& absolute_lower_path,
 200                          const std::string& relative_upper_path);
 201
 202 status_t PrepareAndroidDirs(const std::string& volumeRoot);
 203 }  // namespace vold
 204 }  // namespace android
 205
 206 #endif