blob: c0830215409b7c24068948f7f2642962f6283b14 [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
Paul Crowleycfe39722018-10-30 15:59:24 -070027#include <chrono>
Jeff Sharkeydeb24052015-03-02 21:01:40 -080028#include <string>
Paul Crowley14c8c072018-09-18 13:30:21 -070029#include <vector>
Jeff Sharkeydeb24052015-03-02 21:01:40 -080030
Daichi Hirono10d34882016-01-29 14:33:51 +090031struct DIR;
32
Jeff Sharkeydeb24052015-03-02 21:01:40 -080033namespace android {
34namespace vold {
35
Jeff Sharkey95c87cc2015-04-01 11:54:32 -070036/* SELinux contexts used depending on the block device type */
37extern security_context_t sBlkidContext;
38extern security_context_t sBlkidUntrustedContext;
39extern security_context_t sFsckContext;
40extern security_context_t sFsckUntrustedContext;
41
Paul Crowley56292ef2017-10-20 08:07:53 -070042// TODO remove this with better solution, b/64143519
43extern bool sSleepOnUnmount;
44
Jeff Sharkeydeb24052015-03-02 21:01:40 -080045status_t CreateDeviceNode(const std::string& path, dev_t dev);
46status_t DestroyDeviceNode(const std::string& path);
47
Jeff Sharkeyf0121c52015-04-06 14:08:45 -070048/* fs_prepare_dir wrapper that creates with SELinux context */
49status_t PrepareDir(const std::string& path, mode_t mode, uid_t uid, gid_t gid);
50
Jeff Sharkeydeb24052015-03-02 21:01:40 -080051/* Really unmounts the path, killing active processes along the way */
52status_t ForceUnmount(const std::string& path);
53
Jeff Sharkey89f74fb2015-10-21 12:16:12 -070054/* Kills any processes using given path */
55status_t KillProcessesUsingPath(const std::string& path);
56
Jeff Sharkey36801cc2015-03-13 16:09:20 -070057/* Creates bind mount from source to target */
58status_t BindMount(const std::string& source, const std::string& target);
59
Jeff Sharkey3472e522017-10-06 18:02:53 -060060bool FindValue(const std::string& raw, const std::string& key, std::string* value);
61
Jeff Sharkey9c484982015-03-31 10:35:33 -070062/* Reads filesystem metadata from device at path */
Paul Crowley14c8c072018-09-18 13:30:21 -070063status_t ReadMetadata(const std::string& path, std::string* fsType, std::string* fsUuid,
64 std::string* fsLabel);
Jeff Sharkey9c484982015-03-31 10:35:33 -070065
Jeff Sharkey95c87cc2015-04-01 11:54:32 -070066/* Reads filesystem metadata from untrusted device at path */
Paul Crowley14c8c072018-09-18 13:30:21 -070067status_t ReadMetadataUntrusted(const std::string& path, std::string* fsType, std::string* fsUuid,
68 std::string* fsLabel);
Jeff Sharkey95c87cc2015-04-01 11:54:32 -070069
Jeff Sharkeyce6a9132015-04-08 21:07:21 -070070/* Returns either WEXITSTATUS() status, or a negative errno */
Paul Crowleyde2d6202018-11-30 11:43:47 -080071status_t ForkExecvp(const std::vector<std::string>& args, std::vector<std::string>* output = nullptr,
72 security_context_t context = nullptr);
Jeff Sharkey9c484982015-03-31 10:35:33 -070073
Jeff Sharkey1d6fbcc2015-04-24 16:00:03 -070074pid_t ForkExecvpAsync(const std::vector<std::string>& args);
75
Oleksiy Avramchenko625dc782018-05-23 10:50:46 +020076/* Gets block device size in bytes */
77status_t GetBlockDevSize(int fd, uint64_t* size);
78status_t GetBlockDevSize(const std::string& path, uint64_t* size);
79/* Gets block device size in 512 byte sectors */
80status_t GetBlockDev512Sectors(const std::string& path, uint64_t* nr_sec);
81
Jeff Sharkey9c484982015-03-31 10:35:33 -070082status_t ReadRandomBytes(size_t bytes, std::string& out);
Pavel Grafove2e2d302017-08-01 17:15:53 +010083status_t ReadRandomBytes(size_t bytes, char* buffer);
Jeff Sharkey46bb69f2017-06-21 13:52:23 -060084status_t GenerateRandomUuid(std::string& out);
Jeff Sharkey9c484982015-03-31 10:35:33 -070085
Jeff Sharkey95c87cc2015-04-01 11:54:32 -070086/* Converts hex string to raw bytes, ignoring [ :-] */
Jeff Sharkey9c484982015-03-31 10:35:33 -070087status_t HexToStr(const std::string& hex, std::string& str);
Jeff Sharkey95c87cc2015-04-01 11:54:32 -070088/* Converts raw bytes to hex string */
Jeff Sharkey9c484982015-03-31 10:35:33 -070089status_t StrToHex(const std::string& str, std::string& hex);
Pavel Grafove2e2d302017-08-01 17:15:53 +010090/* Converts raw key bytes to hex string */
91status_t StrToHex(const KeyBuffer& str, KeyBuffer& hex);
Jeff Sharkeybc40cc82015-06-18 14:25:08 -070092/* Normalize given hex string into consistent format */
93status_t NormalizeHex(const std::string& in, std::string& out);
Jeff Sharkey9c484982015-03-31 10:35:33 -070094
Jeff Sharkey1d6fbcc2015-04-24 16:00:03 -070095uint64_t GetFreeBytes(const std::string& path);
96uint64_t GetTreeBytes(const std::string& path);
97
Jeff Sharkeyd0640f62015-05-21 22:35:42 -070098bool IsFilesystemSupported(const std::string& fsType);
99
100/* Wipes contents of block device at given path */
101status_t WipeBlockDevice(const std::string& path);
102
Jeff Sharkeybc40cc82015-06-18 14:25:08 -0700103std::string BuildKeyPath(const std::string& partGuid);
104
Jeff Sharkeybe70c9a2016-04-14 20:45:16 -0600105std::string BuildDataSystemLegacyPath(userid_t userid);
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800106std::string BuildDataSystemCePath(userid_t userid);
Jeff Sharkey47695b22016-02-01 17:02:29 -0700107std::string BuildDataSystemDePath(userid_t userid);
Jeff Sharkeybe70c9a2016-04-14 20:45:16 -0600108std::string BuildDataMiscLegacyPath(userid_t userid);
Jeff Sharkey47695b22016-02-01 17:02:29 -0700109std::string BuildDataMiscCePath(userid_t userid);
110std::string BuildDataMiscDePath(userid_t userid);
Calin Juravle79f55a42016-02-17 20:14:46 +0000111std::string BuildDataProfilesDePath(userid_t userid);
Andreas Huber71cd43f2018-01-22 11:25:29 -0800112std::string BuildDataVendorCePath(userid_t userid);
113std::string BuildDataVendorDePath(userid_t userid);
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800114
Paul Crowley3b71fc52017-10-09 10:55:21 -0700115std::string BuildDataPath(const std::string& volumeUuid);
116std::string BuildDataMediaCePath(const std::string& volumeUuid, userid_t userid);
117std::string BuildDataUserCePath(const std::string& volumeUuid, userid_t userid);
118std::string BuildDataUserDePath(const std::string& volumeUuid, userid_t userid);
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800119
Jeff Sharkey66270a22015-06-24 11:49:24 -0700120dev_t GetDevice(const std::string& path);
121
Jeff Sharkeyd24aeda2016-07-15 16:20:22 -0600122status_t RestoreconRecursive(const std::string& path);
123
Jeff Sharkey3472e522017-10-06 18:02:53 -0600124// TODO: promote to android::base
125bool Readlinkat(int dirfd, const std::string& path, std::string* result);
Daichi Hirono10d34882016-01-29 14:33:51 +0900126
Yu Ning942d4e82016-01-08 17:36:47 +0800127/* Checks if Android is running in QEMU */
128bool IsRunningInEmulator();
129
Sudheer Shanka295fb242019-01-16 23:04:07 -0800130status_t UnmountTreeWithPrefix(const std::string& prefix);
131status_t UnmountTree(const std::string& mountPoint);
Sudheer Shanka89ddf992018-09-25 14:22:07 -0700132
Paul Crowleycfe39722018-10-30 15:59:24 -0700133status_t WaitForFile(const char* filename, std::chrono::nanoseconds timeout);
134
Paul Crowley621d9b92018-12-07 15:36:09 -0800135bool FsyncDirectory(const std::string& dirname);
136
Tommy Chiu97466cb2019-03-26 17:18:09 +0800137bool writeStringToFile(const std::string& payload, const std::string& filename);
Jeff Sharkeydeb24052015-03-02 21:01:40 -0800138} // namespace vold
139} // namespace android
140
141#endif