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