blob: 9bf75999c9e21ace80986b096420fa27dc5a74a2 [file] [log] [blame]
San Mehatf1b736b2009-10-10 17:22:08 -07001/*
2 * Copyright (C) 2008 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
Jeff Sharkey36801cc2015-03-13 16:09:20 -070017#ifndef ANDROID_VOLD_VOLUME_MANAGER_H
18#define ANDROID_VOLD_VOLUME_MANAGER_H
San Mehatf1b736b2009-10-10 17:22:08 -070019
Jeff Sharkey36801cc2015-03-13 16:09:20 -070020#include <fnmatch.h>
Paul Crowleyedf7a4e2018-09-18 15:14:18 -070021#include <pthread.h>
Jeff Sharkey36801cc2015-03-13 16:09:20 -070022#include <stdlib.h>
San Mehatf1b736b2009-10-10 17:22:08 -070023
Jeff Sharkey36801cc2015-03-13 16:09:20 -070024#include <list>
Jeff Sharkeyc8e04c52015-04-21 12:14:17 -070025#include <mutex>
26#include <string>
Jeff Sharkeybd3038d2015-06-10 09:42:01 -070027#include <unordered_map>
28#include <unordered_set>
Jeff Sharkey36801cc2015-03-13 16:09:20 -070029
Jeff Sharkey11c2d382017-09-11 10:32:01 -060030#include <android-base/unique_fd.h>
Jeff Sharkey36801cc2015-03-13 16:09:20 -070031#include <cutils/multiuser.h>
Paul Crowleyedf7a4e2018-09-18 15:14:18 -070032#include <sysutils/NetlinkEvent.h>
San Mehatf1b736b2009-10-10 17:22:08 -070033#include <utils/List.h>
Jeff Sharkey5a6bfca2015-05-14 20:33:55 -070034#include <utils/Timers.h>
San Mehatf1b736b2009-10-10 17:22:08 -070035
Jeff Sharkey814e9d32017-09-13 11:49:44 -060036#include "android/os/IVoldListener.h"
37
Jeff Sharkey11c2d382017-09-11 10:32:01 -060038#include "model/Disk.h"
39#include "model/VolumeBase.h"
San Mehatf1b736b2009-10-10 17:22:08 -070040
41class VolumeManager {
Paul Crowleyedf7a4e2018-09-18 15:14:18 -070042 private:
43 static VolumeManager* sInstance;
San Mehatf1b736b2009-10-10 17:22:08 -070044
Paul Crowleyedf7a4e2018-09-18 15:14:18 -070045 bool mDebug;
San Mehatf1b736b2009-10-10 17:22:08 -070046
Paul Crowleyedf7a4e2018-09-18 15:14:18 -070047 public:
San Mehatf1b736b2009-10-10 17:22:08 -070048 virtual ~VolumeManager();
49
Jeff Sharkeyc8e04c52015-04-21 12:14:17 -070050 // TODO: pipe all requests through VM to avoid exposing this lock
51 std::mutex& getLock() { return mLock; }
Jeff Sharkey83b559c2017-09-12 16:30:52 -060052 std::mutex& getCryptLock() { return mCryptLock; }
Jeff Sharkeyc8e04c52015-04-21 12:14:17 -070053
Jeff Sharkey814e9d32017-09-13 11:49:44 -060054 void setListener(android::sp<android::os::IVoldListener> listener) { mListener = listener; }
Greg Kaiser2bc201e2018-12-18 08:42:08 -080055 android::sp<android::os::IVoldListener> getListener() const { return mListener; }
Jeff Sharkey814e9d32017-09-13 11:49:44 -060056
San Mehatf1b736b2009-10-10 17:22:08 -070057 int start();
58 int stop();
59
Paul Crowleyedf7a4e2018-09-18 15:14:18 -070060 void handleBlockEvent(NetlinkEvent* evt);
San Mehatf1b736b2009-10-10 17:22:08 -070061
Jeff Sharkey36801cc2015-03-13 16:09:20 -070062 class DiskSource {
Paul Crowleyedf7a4e2018-09-18 15:14:18 -070063 public:
64 DiskSource(const std::string& sysPattern, const std::string& nickname, int flags)
65 : mSysPattern(sysPattern), mNickname(nickname), mFlags(flags) {}
Jeff Sharkey36801cc2015-03-13 16:09:20 -070066
67 bool matches(const std::string& sysPath) {
68 return !fnmatch(mSysPattern.c_str(), sysPath.c_str(), 0);
69 }
70
Greg Kaiser2bc201e2018-12-18 08:42:08 -080071 const std::string& getNickname() const { return mNickname; }
72 int getFlags() const { return mFlags; }
Jeff Sharkey36801cc2015-03-13 16:09:20 -070073
Paul Crowleyedf7a4e2018-09-18 15:14:18 -070074 private:
Jeff Sharkey36801cc2015-03-13 16:09:20 -070075 std::string mSysPattern;
76 std::string mNickname;
77 int mFlags;
78 };
79
80 void addDiskSource(const std::shared_ptr<DiskSource>& diskSource);
81
82 std::shared_ptr<android::vold::Disk> findDisk(const std::string& id);
83 std::shared_ptr<android::vold::VolumeBase> findVolume(const std::string& id);
84
Greg Kaiser2bc201e2018-12-18 08:42:08 -080085 void listVolumes(android::vold::VolumeBase::Type type, std::list<std::string>& list) const;
Jeff Sharkeyc86ab6f2015-06-26 14:02:09 -070086
Jeff Sharkey3ce18252017-10-24 11:08:45 -060087 int forgetPartition(const std::string& partGuid, const std::string& fsUuid);
Jeff Sharkeybc40cc82015-06-18 14:25:08 -070088
Jeff Sharkeybd3038d2015-06-10 09:42:01 -070089 int onUserAdded(userid_t userId, int userSerialNumber);
90 int onUserRemoved(userid_t userId);
Sudheer Shankaebce4cc2019-04-29 10:46:35 -070091 int onUserStarted(userid_t userId);
Jeff Sharkeybd3038d2015-06-10 09:42:01 -070092 int onUserStopped(userid_t userId);
Jeff Sharkey36801cc2015-03-13 16:09:20 -070093
Jeff Sharkey401b2602017-12-14 22:15:20 -070094 int onSecureKeyguardStateChanged(bool isShowing);
95
Jeff Sharkey36801cc2015-03-13 16:09:20 -070096 int setPrimary(const std::shared_ptr<android::vold::VolumeBase>& vol);
97
Sudheer Shanka817b9112018-12-13 17:40:28 -080098 int remountUid(uid_t uid, int32_t remountMode);
Jeff Sharkey66270a22015-06-24 11:49:24 -070099
Jeff Sharkey36801cc2015-03-13 16:09:20 -0700100 /* Reset all internal state, typically during framework boot */
101 int reset();
102 /* Prepare for device shutdown, safely unmounting all devices */
103 int shutdown();
Jeff Sharkey9c484982015-03-31 10:35:33 -0700104 /* Unmount all volumes, usually for encryption */
105 int unmountAll();
Jeff Sharkey36801cc2015-03-13 16:09:20 -0700106
Jeff Sharkeyfa1c6772017-03-25 22:49:13 -0600107 int updateVirtualDisk();
Jeff Sharkeyf1b996d2015-04-17 17:35:20 -0700108 int setDebug(bool enable);
San Mehatd9a4e352010-03-12 13:32:47 -0800109
Paul Crowleyedf7a4e2018-09-18 15:14:18 -0700110 static VolumeManager* Instance();
San Mehatf1b736b2009-10-10 17:22:08 -0700111
Jeff Sharkey71ebe152013-09-17 17:24:38 -0700112 /*
113 * Ensure that all directories along given path exist, creating parent
114 * directories as needed. Validates that given path is absolute and that
115 * it contains no relative "." or ".." paths or symlinks. Last path segment
116 * is treated as filename and ignored, unless the path ends with "/". Also
117 * ensures that path belongs to a volume managed by vold.
118 */
Jeff Sharkey3472e522017-10-06 18:02:53 -0600119 int mkdirs(const std::string& path);
Jeff Sharkey71ebe152013-09-17 17:24:38 -0700120
Jeff Sharkey11c2d382017-09-11 10:32:01 -0600121 int createObb(const std::string& path, const std::string& key, int32_t ownerGid,
Paul Crowleyedf7a4e2018-09-18 15:14:18 -0700122 std::string* outVolId);
Jeff Sharkey11c2d382017-09-11 10:32:01 -0600123 int destroyObb(const std::string& volId);
124
Risan8c9f3322018-10-29 08:52:56 +0900125 int createStubVolume(const std::string& sourcePath, const std::string& mountPath,
126 const std::string& fsType, const std::string& fsUuid,
127 const std::string& fsLabel, std::string* outVolId);
128 int destroyStubVolume(const std::string& volId);
129
Risan8f6198d2018-10-26 20:56:45 -0600130 int mountAppFuse(uid_t uid, int mountId, android::base::unique_fd* device_fd);
131 int unmountAppFuse(uid_t uid, int mountId);
132 int openAppFuseFile(uid_t uid, int mountId, int fileId, int flags);
Jeff Sharkey11c2d382017-09-11 10:32:01 -0600133
Paul Crowleyedf7a4e2018-09-18 15:14:18 -0700134 private:
San Mehatf1b736b2009-10-10 17:22:08 -0700135 VolumeManager();
Mike Lockwood99635f62010-06-25 23:04:04 -0400136 void readInitialState();
Jeff Sharkey36801cc2015-03-13 16:09:20 -0700137
Sudheer Shanka40ab6742018-09-18 13:07:45 -0700138 int linkPrimary(userid_t userId);
Sudheer Shanka53947a32018-08-01 10:24:13 -0700139
Jeff Sharkey401b2602017-12-14 22:15:20 -0700140 void handleDiskAdded(const std::shared_ptr<android::vold::Disk>& disk);
141 void handleDiskChanged(dev_t device);
142 void handleDiskRemoved(dev_t device);
143
Jeff Sharkeyc8e04c52015-04-21 12:14:17 -0700144 std::mutex mLock;
Jeff Sharkey83b559c2017-09-12 16:30:52 -0600145 std::mutex mCryptLock;
Jeff Sharkeyc8e04c52015-04-21 12:14:17 -0700146
Jeff Sharkey814e9d32017-09-13 11:49:44 -0600147 android::sp<android::os::IVoldListener> mListener;
148
Jeff Sharkey36801cc2015-03-13 16:09:20 -0700149 std::list<std::shared_ptr<DiskSource>> mDiskSources;
150 std::list<std::shared_ptr<android::vold::Disk>> mDisks;
Jeff Sharkey401b2602017-12-14 22:15:20 -0700151 std::list<std::shared_ptr<android::vold::Disk>> mPendingDisks;
Jeff Sharkey11c2d382017-09-11 10:32:01 -0600152 std::list<std::shared_ptr<android::vold::VolumeBase>> mObbVolumes;
Risan8c9f3322018-10-29 08:52:56 +0900153 std::list<std::shared_ptr<android::vold::VolumeBase>> mStubVolumes;
Jeff Sharkey36801cc2015-03-13 16:09:20 -0700154
Jeff Sharkeybd3038d2015-06-10 09:42:01 -0700155 std::unordered_map<userid_t, int> mAddedUsers;
156 std::unordered_set<userid_t> mStartedUsers;
Jeff Sharkey36801cc2015-03-13 16:09:20 -0700157
Jeff Sharkeyfa1c6772017-03-25 22:49:13 -0600158 std::string mVirtualDiskPath;
159 std::shared_ptr<android::vold::Disk> mVirtualDisk;
Jeff Sharkey36801cc2015-03-13 16:09:20 -0700160 std::shared_ptr<android::vold::VolumeBase> mInternalEmulated;
161 std::shared_ptr<android::vold::VolumeBase> mPrimary;
Jeff Sharkey11c2d382017-09-11 10:32:01 -0600162
163 int mNextObbId;
Risan8c9f3322018-10-29 08:52:56 +0900164 int mNextStubVolumeId;
Jeff Sharkey401b2602017-12-14 22:15:20 -0700165 bool mSecureKeyguardShowing;
San Mehatf1b736b2009-10-10 17:22:08 -0700166};
Ken Sumrall29d8da82011-05-18 17:20:07 -0700167
San Mehatf1b736b2009-10-10 17:22:08 -0700168#endif