blob: f33a379d16ae03fa558b4a874a6bb1e7c979d1ee [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 Sharkey95c87cc2015-04-01 11:54:32 -070021#include <selinux/selinux.h>
Jeff Sharkeydeb24052015-03-02 21:01:40 -080022
Jeff Sharkey9c484982015-03-31 10:35:33 -070023#include <vector>
Jeff Sharkeydeb24052015-03-02 21:01:40 -080024#include <string>
25
26// DISALLOW_COPY_AND_ASSIGN disallows the copy and operator= functions. It goes in the private:
27// declarations in a class.
28#if !defined(DISALLOW_COPY_AND_ASSIGN)
29#define DISALLOW_COPY_AND_ASSIGN(TypeName) \
30 TypeName(const TypeName&) = delete; \
31 void operator=(const TypeName&) = delete
32#endif
33
34namespace android {
35namespace vold {
36
Jeff Sharkey95c87cc2015-04-01 11:54:32 -070037/* SELinux contexts used depending on the block device type */
38extern security_context_t sBlkidContext;
39extern security_context_t sBlkidUntrustedContext;
40extern security_context_t sFsckContext;
41extern security_context_t sFsckUntrustedContext;
42
Jeff Sharkeydeb24052015-03-02 21:01:40 -080043status_t CreateDeviceNode(const std::string& path, dev_t dev);
44status_t DestroyDeviceNode(const std::string& path);
45
Jeff Sharkeyf0121c52015-04-06 14:08:45 -070046/* fs_prepare_dir wrapper that creates with SELinux context */
47status_t PrepareDir(const std::string& path, mode_t mode, uid_t uid, gid_t gid);
48
Jeff Sharkeydeb24052015-03-02 21:01:40 -080049/* Really unmounts the path, killing active processes along the way */
50status_t ForceUnmount(const std::string& path);
51
Jeff Sharkey36801cc2015-03-13 16:09:20 -070052/* Creates bind mount from source to target */
53status_t BindMount(const std::string& source, const std::string& target);
54
Jeff Sharkey9c484982015-03-31 10:35:33 -070055/* Reads filesystem metadata from device at path */
56status_t ReadMetadata(const std::string& path, std::string& fsType,
57 std::string& fsUuid, std::string& fsLabel);
58
Jeff Sharkey95c87cc2015-04-01 11:54:32 -070059/* Reads filesystem metadata from untrusted device at path */
60status_t ReadMetadataUntrusted(const std::string& path, std::string& fsType,
61 std::string& fsUuid, std::string& fsLabel);
62
Jeff Sharkeyce6a9132015-04-08 21:07:21 -070063/* Returns either WEXITSTATUS() status, or a negative errno */
64status_t ForkExecvp(const std::vector<std::string>& args);
65status_t ForkExecvp(const std::vector<std::string>& args, security_context_t context);
66
67status_t ForkExecvp(const std::vector<std::string>& args,
68 std::vector<std::string>& output);
69status_t ForkExecvp(const std::vector<std::string>& args,
70 std::vector<std::string>& output, security_context_t context);
Jeff Sharkey9c484982015-03-31 10:35:33 -070071
Jeff Sharkey1d6fbcc2015-04-24 16:00:03 -070072pid_t ForkExecvpAsync(const std::vector<std::string>& args);
73
Jeff Sharkey9c484982015-03-31 10:35:33 -070074status_t ReadRandomBytes(size_t bytes, std::string& out);
75
Jeff Sharkey95c87cc2015-04-01 11:54:32 -070076/* Converts hex string to raw bytes, ignoring [ :-] */
Jeff Sharkey9c484982015-03-31 10:35:33 -070077status_t HexToStr(const std::string& hex, std::string& str);
Jeff Sharkey95c87cc2015-04-01 11:54:32 -070078/* Converts raw bytes to hex string */
Jeff Sharkey9c484982015-03-31 10:35:33 -070079status_t StrToHex(const std::string& str, std::string& hex);
Jeff Sharkeybc40cc82015-06-18 14:25:08 -070080/* Normalize given hex string into consistent format */
81status_t NormalizeHex(const std::string& in, std::string& out);
Jeff Sharkey9c484982015-03-31 10:35:33 -070082
Jeff Sharkey1d6fbcc2015-04-24 16:00:03 -070083uint64_t GetFreeBytes(const std::string& path);
84uint64_t GetTreeBytes(const std::string& path);
85
Jeff Sharkeyd0640f62015-05-21 22:35:42 -070086bool IsFilesystemSupported(const std::string& fsType);
87
88/* Wipes contents of block device at given path */
89status_t WipeBlockDevice(const std::string& path);
90
Jeff Sharkeybc40cc82015-06-18 14:25:08 -070091std::string BuildKeyPath(const std::string& partGuid);
92
Jeff Sharkey66270a22015-06-24 11:49:24 -070093dev_t GetDevice(const std::string& path);
94
Jeff Sharkeyc86ab6f2015-06-26 14:02:09 -070095std::string DefaultFstabPath();
96
Jeff Sharkeydeb24052015-03-02 21:01:40 -080097} // namespace vold
98} // namespace android
99
100#endif