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