xref: /aosp_15_r20/system/core/fs_mgr/include/fs_mgr_overlayfs.h (revision 00c7fec1bb09f3284aad6a6f96d2f63dfc3650ad)
1 /*
2  * Copyright (C) 2018 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 <functional>
20 #include <set>
21 #include <string>
22 
23 #include <fstab/fstab.h>
24 
25 // Keep the list short and only add interfaces that must be exported public.
26 
27 bool fs_mgr_overlayfs_mount_all(android::fs_mgr::Fstab* fstab);
28 bool fs_mgr_overlayfs_is_setup();
29 
30 namespace android {
31 namespace fs_mgr {
32 
33 // Mount the overlayfs override for |fstab_entry|.
34 void MountOverlayfs(const FstabEntry& fstab_entry, bool* scratch_can_be_mounted);
35 
36 void MapScratchPartitionIfNeeded(Fstab* fstab,
37                                  const std::function<bool(const std::set<std::string>&)>& init);
38 
39 // Teardown overlays of all sources (cache dir, scratch device, DSU) for |mount_point|.
40 // Teardown all overlays if |mount_point| is empty.
41 //
42 // Note: This should be called if and only if in recovery or fastbootd to teardown
43 // overlays if any partition is flashed or updated.
44 void TeardownAllOverlayForMountPoint(const std::string& mount_point = {});
45 
46 }  // namespace fs_mgr
47 }  // namespace android
48