blob: 40f4d0ad2a1c3ba6f4fde6201cf9cbcf31dd300e [file] [log] [blame]
Jeff Sharkeydeb24052015-03-02 21:01:40 -08001/*
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
Pavel Grafove2e2d302017-08-01 17:15:53 +010020#include "KeyBuffer.h"
21
Jeff Sharkey814e9d32017-09-13 11:49:44 -060022#include <android-base/macros.h>
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -080023#include <cutils/multiuser.h>
Jeff Sharkey95c87cc2015-04-01 11:54:32 -070024#include <selinux/selinux.h>
Paul Crowley14c8c072018-09-18 13:30:21 -070025#include <utils/Errors.h>
Jeff Sharkeydeb24052015-03-02 21:01:40 -080026
27#include <string>
Paul Crowley14c8c072018-09-18 13:30:21 -070028#include <vector>
Jeff Sharkeydeb24052015-03-02 21:01:40 -080029
Daichi Hirono10d34882016-01-29 14:33:51 +090030struct DIR;
31
Jeff Sharkeydeb24052015-03-02 21:01:40 -080032namespace android {
33namespace vold {
34
Jeff Sharkey95c87cc2015-04-01 11:54:32 -070035/* SELinux contexts used depending on the block device type */
36extern security_context_t sBlkidContext;
37extern security_context_t sBlkidUntrustedContext;
38extern security_context_t sFsckContext;
39extern security_context_t sFsckUntrustedContext;
40
Paul Crowley56292ef2017-10-20 08:07:53 -070041// TODO remove this with better solution, b/64143519
42extern bool sSleepOnUnmount;
43
Jeff Sharkeydeb24052015-03-02 21:01:40 -080044status_t CreateDeviceNode(const std::string& path, dev_t dev);
45status_t DestroyDeviceNode(const std::string& path);
46
Jeff Sharkeyf0121c52015-04-06 14:08:45 -070047/* fs_prepare_dir wrapper that creates with SELinux context */
48status_t PrepareDir(const std::string& path, mode_t mode, uid_t uid, gid_t gid);
49
Jeff Sharkeydeb24052015-03-02 21:01:40 -080050/* Really unmounts the path, killing active processes along the way */
51status_t ForceUnmount(const std::string& path);
52
Jeff Sharkey89f74fb2015-10-21 12:16:12 -070053/* Kills any processes using given path */
54status_t KillProcessesUsingPath(const std::string& path);
55
Jeff Sharkey36801cc2015-03-13 16:09:20 -070056/* Creates bind mount from source to target */
57status_t BindMount(const std::string& source, const std::string& target);
58
Jeff Sharkey3472e522017-10-06 18:02:53 -060059bool FindValue(const std::string& raw, const std::string& key, std::string* value);
60
Jeff Sharkey9c484982015-03-31 10:35:33 -070061/* Reads filesystem metadata from device at path */
Paul Crowley14c8c072018-09-18 13:30:21 -070062status_t ReadMetadata(const std::string& path, std::string* fsType, std::string* fsUuid,
63 std::string* fsLabel);
Jeff Sharkey9c484982015-03-31 10:35:33 -070064
Jeff Sharkey95c87cc2015-04-01 11:54:32 -070065/* Reads filesystem metadata from untrusted device at path */
Paul Crowley14c8c072018-09-18 13:30:21 -070066status_t ReadMetadataUntrusted(const std::string& path, std::string* fsType, std::string* fsUuid,
67 std::string* fsLabel);
Jeff Sharkey95c87cc2015-04-01 11:54:32 -070068
Jeff Sharkeyce6a9132015-04-08 21:07:21 -070069/* Returns either WEXITSTATUS() status, or a negative errno */
70status_t ForkExecvp(const std::vector<std::string>& args);
71status_t ForkExecvp(const std::vector<std::string>& args, security_context_t context);
72
Paul Crowley14c8c072018-09-18 13:30:21 -070073status_t ForkExecvp(const std::vector<std::string>& args, std::vector<std::string>& output);
74status_t ForkExecvp(const std::vector<std::string>& args, std::vector<std::string>& output,
75 security_context_t context);
Jeff Sharkey9c484982015-03-31 10:35:33 -070076
Jeff Sharkey1d6fbcc2015-04-24 16:00:03 -070077pid_t ForkExecvpAsync(const std::vector<std::string>& args);
78
Oleksiy Avramchenko625dc782018-05-23 10:50:46 +020079/* Gets block device size in bytes */
80status_t GetBlockDevSize(int fd, uint64_t* size);
81status_t GetBlockDevSize(const std::string& path, uint64_t* size);
82/* Gets block device size in 512 byte sectors */
83status_t GetBlockDev512Sectors(const std::string& path, uint64_t* nr_sec);
84
Jeff Sharkey9c484982015-03-31 10:35:33 -070085status_t ReadRandomBytes(size_t bytes, std::string& out);
Pavel Grafove2e2d302017-08-01 17:15:53 +010086status_t ReadRandomBytes(size_t bytes, char* buffer);
Jeff Sharkey46bb69f2017-06-21 13:52:23 -060087status_t GenerateRandomUuid(std::string& out);
Jeff Sharkey9c484982015-03-31 10:35:33 -070088
Jeff Sharkey95c87cc2015-04-01 11:54:32 -070089/* Converts hex string to raw bytes, ignoring [ :-] */
Jeff Sharkey9c484982015-03-31 10:35:33 -070090status_t HexToStr(const std::string& hex, std::string& str);
Jeff Sharkey95c87cc2015-04-01 11:54:32 -070091/* Converts raw bytes to hex string */
Jeff Sharkey9c484982015-03-31 10:35:33 -070092status_t StrToHex(const std::string& str, std::string& hex);
Pavel Grafove2e2d302017-08-01 17:15:53 +010093/* Converts raw key bytes to hex string */
94status_t StrToHex(const KeyBuffer& str, KeyBuffer& hex);
Jeff Sharkeybc40cc82015-06-18 14:25:08 -070095/* Normalize given hex string into consistent format */
96status_t NormalizeHex(const std::string& in, std::string& out);
Jeff Sharkey9c484982015-03-31 10:35:33 -070097
Jeff Sharkey1d6fbcc2015-04-24 16:00:03 -070098uint64_t GetFreeBytes(const std::string& path);
99uint64_t GetTreeBytes(const std::string& path);
100
Jeff Sharkeyd0640f62015-05-21 22:35:42 -0700101bool IsFilesystemSupported(const std::string& fsType);
102
103/* Wipes contents of block device at given path */
104status_t WipeBlockDevice(const std::string& path);
105
Jeff Sharkeybc40cc82015-06-18 14:25:08 -0700106std::string BuildKeyPath(const std::string& partGuid);
107
Jeff Sharkeybe70c9a2016-04-14 20:45:16 -0600108std::string BuildDataSystemLegacyPath(userid_t userid);
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800109std::string BuildDataSystemCePath(userid_t userid);
Jeff Sharkey47695b22016-02-01 17:02:29 -0700110std::string BuildDataSystemDePath(userid_t userid);
Jeff Sharkeybe70c9a2016-04-14 20:45:16 -0600111std::string BuildDataMiscLegacyPath(userid_t userid);
Jeff Sharkey47695b22016-02-01 17:02:29 -0700112std::string BuildDataMiscCePath(userid_t userid);
113std::string BuildDataMiscDePath(userid_t userid);
Calin Juravle79f55a42016-02-17 20:14:46 +0000114std::string BuildDataProfilesDePath(userid_t userid);
Andreas Huber71cd43f2018-01-22 11:25:29 -0800115std::string BuildDataVendorCePath(userid_t userid);
116std::string BuildDataVendorDePath(userid_t userid);
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800117
Paul Crowley3b71fc52017-10-09 10:55:21 -0700118std::string BuildDataPath(const std::string& volumeUuid);
119std::string BuildDataMediaCePath(const std::string& volumeUuid, userid_t userid);
120std::string BuildDataUserCePath(const std::string& volumeUuid, userid_t userid);
121std::string BuildDataUserDePath(const std::string& volumeUuid, userid_t userid);
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800122
Jeff Sharkey66270a22015-06-24 11:49:24 -0700123dev_t GetDevice(const std::string& path);
124
Jeff Sharkeyd24aeda2016-07-15 16:20:22 -0600125status_t RestoreconRecursive(const std::string& path);
126
Jeff Sharkey3472e522017-10-06 18:02:53 -0600127// TODO: promote to android::base
128bool Readlinkat(int dirfd, const std::string& path, std::string* result);
Daichi Hirono10d34882016-01-29 14:33:51 +0900129
Yu Ning942d4e82016-01-08 17:36:47 +0800130/* Checks if Android is running in QEMU */
131bool IsRunningInEmulator();
132
Jeff Sharkeydeb24052015-03-02 21:01:40 -0800133} // namespace vold
134} // namespace android
135
136#endif