blob: 7272fe18199b2141a508a5f19a80eebf96adc229 [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
20#include <utils/Errors.h>
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -080021#include <cutils/multiuser.h>
Jeff Sharkey95c87cc2015-04-01 11:54:32 -070022#include <selinux/selinux.h>
Jeff Sharkeydeb24052015-03-02 21:01:40 -080023
Jeff Sharkey9c484982015-03-31 10:35:33 -070024#include <vector>
Jeff Sharkeydeb24052015-03-02 21:01:40 -080025#include <string>
26
27// DISALLOW_COPY_AND_ASSIGN disallows the copy and operator= functions. It goes in the private:
28// declarations in a class.
29#if !defined(DISALLOW_COPY_AND_ASSIGN)
30#define DISALLOW_COPY_AND_ASSIGN(TypeName) \
31 TypeName(const TypeName&) = delete; \
32 void operator=(const TypeName&) = delete
33#endif
34
Daichi Hirono10d34882016-01-29 14:33:51 +090035struct DIR;
36
Jeff Sharkeydeb24052015-03-02 21:01:40 -080037namespace android {
38namespace vold {
39
Jeff Sharkey95c87cc2015-04-01 11:54:32 -070040/* SELinux contexts used depending on the block device type */
41extern security_context_t sBlkidContext;
42extern security_context_t sBlkidUntrustedContext;
43extern security_context_t sFsckContext;
44extern security_context_t sFsckUntrustedContext;
45
Jeff Sharkeydeb24052015-03-02 21:01:40 -080046status_t CreateDeviceNode(const std::string& path, dev_t dev);
47status_t DestroyDeviceNode(const std::string& path);
48
Jeff Sharkeyf0121c52015-04-06 14:08:45 -070049/* fs_prepare_dir wrapper that creates with SELinux context */
50status_t PrepareDir(const std::string& path, mode_t mode, uid_t uid, gid_t gid);
51
Jeff Sharkeydeb24052015-03-02 21:01:40 -080052/* Really unmounts the path, killing active processes along the way */
53status_t ForceUnmount(const std::string& path);
54
Jeff Sharkey89f74fb2015-10-21 12:16:12 -070055/* Kills any processes using given path */
56status_t KillProcessesUsingPath(const std::string& path);
57
Jeff Sharkey36801cc2015-03-13 16:09:20 -070058/* Creates bind mount from source to target */
59status_t BindMount(const std::string& source, const std::string& target);
60
Jeff Sharkey9c484982015-03-31 10:35:33 -070061/* Reads filesystem metadata from device at path */
62status_t ReadMetadata(const std::string& path, std::string& fsType,
63 std::string& fsUuid, std::string& fsLabel);
64
Jeff Sharkey95c87cc2015-04-01 11:54:32 -070065/* Reads filesystem metadata from untrusted device at path */
66status_t ReadMetadataUntrusted(const std::string& path, std::string& fsType,
67 std::string& fsUuid, std::string& fsLabel);
68
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
73status_t ForkExecvp(const std::vector<std::string>& args,
74 std::vector<std::string>& output);
75status_t ForkExecvp(const std::vector<std::string>& args,
76 std::vector<std::string>& output, security_context_t context);
Jeff Sharkey9c484982015-03-31 10:35:33 -070077
Jeff Sharkey1d6fbcc2015-04-24 16:00:03 -070078pid_t ForkExecvpAsync(const std::vector<std::string>& args);
79
Jeff Sharkey9c484982015-03-31 10:35:33 -070080status_t ReadRandomBytes(size_t bytes, std::string& out);
Jeff Sharkey46bb69f2017-06-21 13:52:23 -060081status_t GenerateRandomUuid(std::string& out);
Jeff Sharkey9c484982015-03-31 10:35:33 -070082
Jeff Sharkey95c87cc2015-04-01 11:54:32 -070083/* Converts hex string to raw bytes, ignoring [ :-] */
Jeff Sharkey9c484982015-03-31 10:35:33 -070084status_t HexToStr(const std::string& hex, std::string& str);
Jeff Sharkey95c87cc2015-04-01 11:54:32 -070085/* Converts raw bytes to hex string */
Jeff Sharkey9c484982015-03-31 10:35:33 -070086status_t StrToHex(const std::string& str, std::string& hex);
Jeff Sharkeybc40cc82015-06-18 14:25:08 -070087/* Normalize given hex string into consistent format */
88status_t NormalizeHex(const std::string& in, std::string& out);
Jeff Sharkey9c484982015-03-31 10:35:33 -070089
Jeff Sharkey1d6fbcc2015-04-24 16:00:03 -070090uint64_t GetFreeBytes(const std::string& path);
91uint64_t GetTreeBytes(const std::string& path);
92
Jeff Sharkeyd0640f62015-05-21 22:35:42 -070093bool IsFilesystemSupported(const std::string& fsType);
94
95/* Wipes contents of block device at given path */
96status_t WipeBlockDevice(const std::string& path);
97
Jeff Sharkeybc40cc82015-06-18 14:25:08 -070098std::string BuildKeyPath(const std::string& partGuid);
99
Jeff Sharkeybe70c9a2016-04-14 20:45:16 -0600100std::string BuildDataSystemLegacyPath(userid_t userid);
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800101std::string BuildDataSystemCePath(userid_t userid);
Jeff Sharkey47695b22016-02-01 17:02:29 -0700102std::string BuildDataSystemDePath(userid_t userid);
Jeff Sharkeybe70c9a2016-04-14 20:45:16 -0600103std::string BuildDataMiscLegacyPath(userid_t userid);
Jeff Sharkey47695b22016-02-01 17:02:29 -0700104std::string BuildDataMiscCePath(userid_t userid);
105std::string BuildDataMiscDePath(userid_t userid);
Calin Juravle79f55a42016-02-17 20:14:46 +0000106std::string BuildDataProfilesDePath(userid_t userid);
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800107
108std::string BuildDataPath(const char* volumeUuid);
Jeff Sharkeybe70c9a2016-04-14 20:45:16 -0600109std::string BuildDataMediaCePath(const char* volumeUuid, userid_t userid);
110std::string BuildDataUserCePath(const char* volumeUuid, userid_t userid);
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800111std::string BuildDataUserDePath(const char* volumeUuid, userid_t userid);
112
Jeff Sharkey66270a22015-06-24 11:49:24 -0700113dev_t GetDevice(const std::string& path);
114
Jeff Sharkeyd24aeda2016-07-15 16:20:22 -0600115status_t RestoreconRecursive(const std::string& path);
116
Daichi Hirono10d34882016-01-29 14:33:51 +0900117status_t SaneReadLinkAt(int dirfd, const char* path, char* buf, size_t bufsiz);
118
Yu Ning942d4e82016-01-08 17:36:47 +0800119/* Checks if Android is running in QEMU */
120bool IsRunningInEmulator();
121
Jeff Sharkeydeb24052015-03-02 21:01:40 -0800122} // namespace vold
123} // namespace android
124
125#endif