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 
21 #include <fstab/fstab.h>
22 
23 #include <set>
24 #include <string>
25 #include <vector>
26 
27 android::fs_mgr::Fstab fs_mgr_overlayfs_candidate_list(const android::fs_mgr::Fstab& fstab);
28 
29 bool fs_mgr_overlayfs_mount_all(android::fs_mgr::Fstab* fstab);
30 bool fs_mgr_overlayfs_setup(const char* backing = nullptr, const char* mount_point = nullptr,
31                             bool* change = nullptr, bool force = true);
32 bool fs_mgr_overlayfs_teardown(const char* mount_point = nullptr, bool* change = nullptr);
33 bool fs_mgr_overlayfs_is_setup();
34 bool fs_mgr_has_shared_blocks(const std::string& mount_point, const std::string& dev);
35 std::string fs_mgr_get_context(const std::string& mount_point);
36 
37 enum class OverlayfsValidResult {
38     kNotSupported = 0,
39     kOk,
40     kOverrideCredsRequired,
41 };
42 OverlayfsValidResult fs_mgr_overlayfs_valid();
43 
44 namespace android {
45 namespace fs_mgr {
46 
47 void MapScratchPartitionIfNeeded(Fstab* fstab,
48                                  const std::function<bool(const std::set<std::string>&)>& init);
49 void CleanupOldScratchFiles();
50 
51 // Teardown overlays of all sources (cache dir, scratch device, DSU) for |mount_point|.
52 // Teardown all overlays if |mount_point| is empty.
53 //
54 // Note: This should be called if and only if in recovery or fastbootd to teardown
55 // overlays if any partition is flashed or updated.
56 void TeardownAllOverlayForMountPoint(const std::string& mount_point = {});
57 
58 }  // namespace fs_mgr
59 }  // namespace android
60