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 <utils/Errors.h>
  23 #include <cutils/multiuser.h>
  24 #include <selinux/selinux.h>
  25
  26 #include <vector>
  27 #include <string>
  28
  29 // DISALLOW_COPY_AND_ASSIGN disallows the copy and operator= functions. It goes in the private:
  30 // declarations in a class.
  31 #if !defined(DISALLOW_COPY_AND_ASSIGN)
  32 #define DISALLOW_COPY_AND_ASSIGN(TypeName) \
  33     TypeName(const TypeName&) = delete;  \
  34     void operator=(const TypeName&) = delete
  35 #endif
  36
  37 struct DIR;
  38
  39 namespace android {
  40 namespace vold {
  41
  42 /* SELinux contexts used depending on the block device type */
  43 extern security_context_t sBlkidContext;
  44 extern security_context_t sBlkidUntrustedContext;
  45 extern security_context_t sFsckContext;
  46 extern security_context_t sFsckUntrustedContext;
  47
  48 status_t CreateDeviceNode(const std::string& path, dev_t dev);
  49 status_t DestroyDeviceNode(const std::string& path);
  50
  51 /* fs_prepare_dir wrapper that creates with SELinux context */
  52 status_t PrepareDir(const std::string& path, mode_t mode, uid_t uid, gid_t gid);
  53
  54 /* Really unmounts the path, killing active processes along the way */
  55 status_t ForceUnmount(const std::string& path);
  56
  57 /* Kills any processes using given path */
  58 status_t KillProcessesUsingPath(const std::string& path);
  59
  60 /* Creates bind mount from source to target */
  61 status_t BindMount(const std::string& source, const std::string& target);
  62
  63 /* Reads filesystem metadata from device at path */
  64 status_t ReadMetadata(const std::string& path, std::string& fsType,
  65         std::string& fsUuid, std::string& fsLabel);
  66
  67 /* Reads filesystem metadata from untrusted device at path */
  68 status_t ReadMetadataUntrusted(const std::string& path, std::string& fsType,
  69         std::string& fsUuid, std::string& fsLabel);
  70
  71 /* Returns either WEXITSTATUS() status, or a negative errno */
  72 status_t ForkExecvp(const std::vector<std::string>& args);
  73 status_t ForkExecvp(const std::vector<std::string>& args, security_context_t context);
  74
  75 status_t ForkExecvp(const std::vector<std::string>& args,
  76         std::vector<std::string>& output);
  77 status_t ForkExecvp(const std::vector<std::string>& args,
  78         std::vector<std::string>& output, security_context_t context);
  79
  80 pid_t ForkExecvpAsync(const std::vector<std::string>& args);
  81
  82 status_t ReadRandomBytes(size_t bytes, std::string& out);
  83 status_t ReadRandomBytes(size_t bytes, char* buffer);
  84 status_t GenerateRandomUuid(std::string& out);
  85
  86 /* Converts hex string to raw bytes, ignoring [ :-] */
  87 status_t HexToStr(const std::string& hex, std::string& str);
  88 /* Converts raw bytes to hex string */
  89 status_t StrToHex(const std::string& str, std::string& hex);
  90 /* Converts raw key bytes to hex string */
  91 status_t StrToHex(const KeyBuffer& str, KeyBuffer& hex);
  92 /* Normalize given hex string into consistent format */
  93 status_t NormalizeHex(const std::string& in, std::string& out);
  94
  95 uint64_t GetFreeBytes(const std::string& path);
  96 uint64_t GetTreeBytes(const std::string& path);
  97
  98 bool IsFilesystemSupported(const std::string& fsType);
  99
 100 /* Wipes contents of block device at given path */
 101 status_t WipeBlockDevice(const std::string& path);
 102
 103 std::string BuildKeyPath(const std::string& partGuid);
 104
 105 std::string BuildDataSystemLegacyPath(userid_t userid);
 106 std::string BuildDataSystemCePath(userid_t userid);
 107 std::string BuildDataSystemDePath(userid_t userid);
 108 std::string BuildDataMiscLegacyPath(userid_t userid);
 109 std::string BuildDataMiscCePath(userid_t userid);
 110 std::string BuildDataMiscDePath(userid_t userid);
 111 std::string BuildDataProfilesDePath(userid_t userid);
 112
 113 std::string BuildDataPath(const char* volumeUuid);
 114 std::string BuildDataMediaCePath(const char* volumeUuid, userid_t userid);
 115 std::string BuildDataUserCePath(const char* volumeUuid, userid_t userid);
 116 std::string BuildDataUserDePath(const char* volumeUuid, userid_t userid);
 117
 118 dev_t GetDevice(const std::string& path);
 119
 120 status_t RestoreconRecursive(const std::string& path);
 121
 122 status_t SaneReadLinkAt(int dirfd, const char* path, char* buf, size_t bufsiz);
 123
 124 /* Checks if Android is running in QEMU */
 125 bool IsRunningInEmulator();
 126
 127 }  // namespace vold
 128 }  // namespace android
 129
 130 #endif