1 /*
2  * Copyright (C) 2007 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 #pragma once
18 
19 #include <string>
20 
21 #include <fstab/fstab.h>
22 
23 using Volume = android::fs_mgr::FstabEntry;
24 
25 // Load and parse volume data from /etc/recovery.fstab.
26 void load_volume_table();
27 
28 // Return the Volume* record for this mount point (or nullptr).
29 Volume* volume_for_mount_point(const std::string& mount_point);
30 
31 // Make sure that the volume 'path' is on is mounted.  Returns 0 on
32 // success (volume is mounted).
33 int ensure_path_mounted(const std::string& path);
34 
35 // Similar to ensure_path_mounted, but allows one to specify the mount_point.
36 int ensure_path_mounted_at(const std::string& path, const std::string& mount_point);
37 
38 // Make sure that the volume 'path' is on is unmounted.  Returns 0 on
39 // success (volume is unmounted);
40 int ensure_path_unmounted(const std::string& path);
41 
42 // Reformat the given volume (must be the mount point only, eg
43 // "/cache"), no paths permitted.  Attempts to unmount the volume if
44 // it is mounted.
45 int format_volume(const std::string& volume);
46 
47 // Reformat the given volume (must be the mount point only, eg
48 // "/cache"), no paths permitted.  Attempts to unmount the volume if
49 // it is mounted.
50 // Copies 'directory' to root of the newly formatted volume
51 int format_volume(const std::string& volume, const std::string& directory);
52 
53 // Ensure that all and only the volumes that packages expect to find
54 // mounted (/tmp and /cache) are mounted.  Returns 0 on success.
55 int setup_install_mounts();
56 
57 // Returns true if there is /cache in the volumes.
58 bool HasCache();
59