1 /*
2  * Copyright (C) 2012 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 __CORE_FS_MGR_H
18 #define __CORE_FS_MGR_H
19 
20 #include <stdint.h>
21 #include <linux/dm-ioctl.h>
22 
23 // Magic number at start of verity metadata
24 #define VERITY_METADATA_MAGIC_NUMBER 0xb001b001
25 
26 // Replacement magic number at start of verity metadata to cleanly
27 // turn verity off in userdebug builds.
28 #define VERITY_METADATA_MAGIC_DISABLE 0x46464f56 // "VOFF"
29 
30 #ifdef __cplusplus
31 extern "C" {
32 #endif
33 
34 // Verity modes
35 enum verity_mode {
36     VERITY_MODE_EIO = 0,
37     VERITY_MODE_LOGGING = 1,
38     VERITY_MODE_RESTART = 2,
39     VERITY_MODE_LAST = VERITY_MODE_RESTART,
40     VERITY_MODE_DEFAULT = VERITY_MODE_RESTART
41 };
42 
43 /*
44  * The entries must be kept in the same order as they were seen in the fstab.
45  * Unless explicitly requested, a lookup on mount point should always
46  * return the 1st one.
47  */
48 struct fstab {
49     int num_entries;
50     struct fstab_rec *recs;
51     char *fstab_filename;
52 };
53 
54 struct fstab_rec {
55     char *blk_device;
56     char *mount_point;
57     char *fs_type;
58     unsigned long flags;
59     char *fs_options;
60     int fs_mgr_flags;
61     char *key_loc;
62     char *verity_loc;
63     long long length;
64     char *label;
65     int partnum;
66     int swap_prio;
67     unsigned int zram_size;
68 };
69 
70 // Callback function for verity status
71 typedef void (*fs_mgr_verity_state_callback)(struct fstab_rec *fstab,
72         const char *mount_point, int mode, int status);
73 
74 struct fstab *fs_mgr_read_fstab(const char *fstab_path);
75 void fs_mgr_free_fstab(struct fstab *fstab);
76 
77 #define FS_MGR_MNTALL_DEV_FILE_ENCRYPTED 5
78 #define FS_MGR_MNTALL_DEV_NEEDS_RECOVERY 4
79 #define FS_MGR_MNTALL_DEV_NEEDS_ENCRYPTION 3
80 #define FS_MGR_MNTALL_DEV_MIGHT_BE_ENCRYPTED 2
81 #define FS_MGR_MNTALL_DEV_NOT_ENCRYPTED 1
82 #define FS_MGR_MNTALL_DEV_NOT_ENCRYPTABLE 0
83 #define FS_MGR_MNTALL_FAIL -1
84 int fs_mgr_mount_all(struct fstab *fstab);
85 
86 #define FS_MGR_DOMNT_FAILED -1
87 #define FS_MGR_DOMNT_BUSY -2
88 int fs_mgr_do_mount(struct fstab *fstab, char *n_name, char *n_blk_device,
89                     char *tmp_mount_point);
90 int fs_mgr_do_tmpfs_mount(char *n_name);
91 int fs_mgr_unmount_all(struct fstab *fstab);
92 int fs_mgr_get_crypt_info(struct fstab *fstab, char *key_loc,
93                           char *real_blk_device, int size);
94 int fs_mgr_load_verity_state(int *mode);
95 int fs_mgr_update_verity_state(fs_mgr_verity_state_callback callback);
96 int fs_mgr_add_entry(struct fstab *fstab,
97                      const char *mount_point, const char *fs_type,
98                      const char *blk_device);
99 struct fstab_rec *fs_mgr_get_entry_for_mount_point(struct fstab *fstab, const char *path);
100 int fs_mgr_is_voldmanaged(const struct fstab_rec *fstab);
101 int fs_mgr_is_nonremovable(const struct fstab_rec *fstab);
102 int fs_mgr_is_verified(const struct fstab_rec *fstab);
103 int fs_mgr_is_encryptable(const struct fstab_rec *fstab);
104 int fs_mgr_is_file_encrypted(const struct fstab_rec *fstab);
105 int fs_mgr_is_convertible_to_fbe(const struct fstab_rec *fstab);
106 int fs_mgr_is_noemulatedsd(const struct fstab_rec *fstab);
107 int fs_mgr_is_notrim(struct fstab_rec *fstab);
108 int fs_mgr_is_formattable(struct fstab_rec *fstab);
109 int fs_mgr_is_nofail(struct fstab_rec *fstab);
110 int fs_mgr_swapon_all(struct fstab *fstab);
111 
112 int fs_mgr_do_format(struct fstab_rec *fstab);
113 
114 #ifdef __cplusplus
115 }
116 #endif
117 
118 #endif /* __CORE_FS_MGR_H */
119