blob: 5d211dbf42f2fe6727d94d570482b2466fbab406 [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
Jeff Sharkey11c2d382017-09-11 10:32:01 -060041#define DEBUG_APPFUSE 0
42
San Mehatf1b736b2009-10-10 17:22:08 -070043class VolumeManager {
Paul Crowleyedf7a4e2018-09-18 15:14:18 -070044 private:
45 static VolumeManager* sInstance;
San Mehatf1b736b2009-10-10 17:22:08 -070046
Paul Crowleyedf7a4e2018-09-18 15:14:18 -070047 bool mDebug;
San Mehatf1b736b2009-10-10 17:22:08 -070048
Paul Crowleyedf7a4e2018-09-18 15:14:18 -070049 public:
San Mehatf1b736b2009-10-10 17:22:08 -070050 virtual ~VolumeManager();
51
Jeff Sharkeyc8e04c52015-04-21 12:14:17 -070052 // TODO: pipe all requests through VM to avoid exposing this lock
53 std::mutex& getLock() { return mLock; }
Jeff Sharkey83b559c2017-09-12 16:30:52 -060054 std::mutex& getCryptLock() { return mCryptLock; }
Jeff Sharkeyc8e04c52015-04-21 12:14:17 -070055
Jeff Sharkey814e9d32017-09-13 11:49:44 -060056 void setListener(android::sp<android::os::IVoldListener> listener) { mListener = listener; }
57 android::sp<android::os::IVoldListener> getListener() { return mListener; }
58
San Mehatf1b736b2009-10-10 17:22:08 -070059 int start();
60 int stop();
61
Paul Crowleyedf7a4e2018-09-18 15:14:18 -070062 void handleBlockEvent(NetlinkEvent* evt);
San Mehatf1b736b2009-10-10 17:22:08 -070063
Jeff Sharkey36801cc2015-03-13 16:09:20 -070064 class DiskSource {
Paul Crowleyedf7a4e2018-09-18 15:14:18 -070065 public:
66 DiskSource(const std::string& sysPattern, const std::string& nickname, int flags)
67 : mSysPattern(sysPattern), mNickname(nickname), mFlags(flags) {}
Jeff Sharkey36801cc2015-03-13 16:09:20 -070068
69 bool matches(const std::string& sysPath) {
70 return !fnmatch(mSysPattern.c_str(), sysPath.c_str(), 0);
71 }
72
73 const std::string& getNickname() { return mNickname; }
74 int getFlags() { return mFlags; }
75
Paul Crowleyedf7a4e2018-09-18 15:14:18 -070076 private:
Jeff Sharkey36801cc2015-03-13 16:09:20 -070077 std::string mSysPattern;
78 std::string mNickname;
79 int mFlags;
80 };
81
82 void addDiskSource(const std::shared_ptr<DiskSource>& diskSource);
83
84 std::shared_ptr<android::vold::Disk> findDisk(const std::string& id);
85 std::shared_ptr<android::vold::VolumeBase> findVolume(const std::string& id);
86
Jeff Sharkeyc86ab6f2015-06-26 14:02:09 -070087 void listVolumes(android::vold::VolumeBase::Type type, std::list<std::string>& list);
88
Jeff Sharkey3ce18252017-10-24 11:08:45 -060089 int forgetPartition(const std::string& partGuid, const std::string& fsUuid);
Jeff Sharkeybc40cc82015-06-18 14:25:08 -070090
Jeff Sharkeybd3038d2015-06-10 09:42:01 -070091 int onUserAdded(userid_t userId, int userSerialNumber);
92 int onUserRemoved(userid_t userId);
Sudheer Shankaebaad1c2018-07-31 16:39:59 -070093 int onUserStarted(userid_t userId, const std::vector<std::string>& packageNames);
Jeff Sharkeybd3038d2015-06-10 09:42:01 -070094 int onUserStopped(userid_t userId);
Jeff Sharkey36801cc2015-03-13 16:09:20 -070095
Sudheer Shankad484aa92018-07-31 10:07:34 -070096 int addAppIds(const std::vector<std::string>& packageNames, const std::vector<int32_t>& appIds);
97 int addSandboxIds(const std::vector<int32_t>& appIds,
Paul Crowleyedf7a4e2018-09-18 15:14:18 -070098 const std::vector<std::string>& sandboxIds);
Sudheer Shankac7562092018-08-24 10:20:56 -070099 int mountExternalStorageForApp(const std::string& packageName, appid_t appId,
Paul Crowleyedf7a4e2018-09-18 15:14:18 -0700100 const std::string& sandboxId, userid_t userId);
Sudheer Shankad484aa92018-07-31 10:07:34 -0700101
Sudheer Shanka40ab6742018-09-18 13:07:45 -0700102 int onVolumeMounted(android::vold::VolumeBase* vol);
103 int onVolumeUnmounted(android::vold::VolumeBase* vol);
104
Jeff Sharkey401b2602017-12-14 22:15:20 -0700105 int onSecureKeyguardStateChanged(bool isShowing);
106
Jeff Sharkey36801cc2015-03-13 16:09:20 -0700107 int setPrimary(const std::shared_ptr<android::vold::VolumeBase>& vol);
108
Jeff Sharkey66270a22015-06-24 11:49:24 -0700109 int remountUid(uid_t uid, const std::string& mode);
110
Jeff Sharkey36801cc2015-03-13 16:09:20 -0700111 /* Reset all internal state, typically during framework boot */
112 int reset();
113 /* Prepare for device shutdown, safely unmounting all devices */
114 int shutdown();
Jeff Sharkey9c484982015-03-31 10:35:33 -0700115 /* Unmount all volumes, usually for encryption */
116 int unmountAll();
Jeff Sharkey36801cc2015-03-13 16:09:20 -0700117
Jeff Sharkeyfa1c6772017-03-25 22:49:13 -0600118 int updateVirtualDisk();
Jeff Sharkeyf1b996d2015-04-17 17:35:20 -0700119 int setDebug(bool enable);
San Mehatd9a4e352010-03-12 13:32:47 -0800120
Paul Crowleyedf7a4e2018-09-18 15:14:18 -0700121 static VolumeManager* Instance();
San Mehatf1b736b2009-10-10 17:22:08 -0700122
Jeff Sharkey71ebe152013-09-17 17:24:38 -0700123 /*
124 * Ensure that all directories along given path exist, creating parent
125 * directories as needed. Validates that given path is absolute and that
126 * it contains no relative "." or ".." paths or symlinks. Last path segment
127 * is treated as filename and ignored, unless the path ends with "/". Also
128 * ensures that path belongs to a volume managed by vold.
129 */
Jeff Sharkey3472e522017-10-06 18:02:53 -0600130 int mkdirs(const std::string& path);
Jeff Sharkey71ebe152013-09-17 17:24:38 -0700131
Jeff Sharkey11c2d382017-09-11 10:32:01 -0600132 int createObb(const std::string& path, const std::string& key, int32_t ownerGid,
Paul Crowleyedf7a4e2018-09-18 15:14:18 -0700133 std::string* outVolId);
Jeff Sharkey11c2d382017-09-11 10:32:01 -0600134 int destroyObb(const std::string& volId);
135
136 int mountAppFuse(uid_t uid, pid_t pid, int mountId, android::base::unique_fd* device_fd);
137 int unmountAppFuse(uid_t uid, pid_t pid, int mountId);
138
Paul Crowleyedf7a4e2018-09-18 15:14:18 -0700139 private:
San Mehatf1b736b2009-10-10 17:22:08 -0700140 VolumeManager();
Mike Lockwood99635f62010-06-25 23:04:04 -0400141 void readInitialState();
Jeff Sharkey36801cc2015-03-13 16:09:20 -0700142
Sudheer Shanka40ab6742018-09-18 13:07:45 -0700143 int linkPrimary(userid_t userId);
Sudheer Shanka53947a32018-08-01 10:24:13 -0700144
Sudheer Shanka40ab6742018-09-18 13:07:45 -0700145 int prepareSandboxes(userid_t userId, const std::vector<std::string>& packageNames,
146 const std::vector<std::string>& visibleVolLabels);
147 int mountPkgSpecificDirsForRunningProcs(userid_t userId,
148 const std::vector<std::string>& packageNames,
149 const std::vector<std::string>& visibleVolLabels);
150 int destroySandboxesForVol(android::vold::VolumeBase* vol, userid_t userId);
Sudheer Shanka53947a32018-08-01 10:24:13 -0700151 std::string prepareSandboxSource(uid_t uid, const std::string& sandboxId,
Paul Crowleyedf7a4e2018-09-18 15:14:18 -0700152 const std::string& sandboxRootDir);
Sudheer Shanka53947a32018-08-01 10:24:13 -0700153 std::string prepareSandboxTarget(const std::string& packageName, uid_t uid,
Paul Crowleyedf7a4e2018-09-18 15:14:18 -0700154 const std::string& volumeLabel,
155 const std::string& mntTargetRootDir, bool isUserDependent);
Sudheer Shanka53947a32018-08-01 10:24:13 -0700156 std::string preparePkgDataSource(const std::string& packageName, uid_t uid,
Paul Crowleyedf7a4e2018-09-18 15:14:18 -0700157 const std::string& dataRootDir);
Sudheer Shanka53947a32018-08-01 10:24:13 -0700158 std::string prepareSubDirs(const std::string& pathPrefix, const std::string& subDirs,
Paul Crowleyedf7a4e2018-09-18 15:14:18 -0700159 mode_t mode, uid_t uid, gid_t gid);
Sudheer Shanka40ab6742018-09-18 13:07:45 -0700160 bool createPkgSpecificDirRoots(const std::string& volumeRoot);
161 bool createPkgSpecificDirs(const std::string& packageName, uid_t uid,
162 const std::string& volumeRoot, const std::string& sandboxDirRoot);
163 int mountPkgSpecificDir(const std::string& mntSourceRoot, const std::string& mntTargetRoot,
164 const std::string& packageName, const char* dirName);
Jeff Sharkey36801cc2015-03-13 16:09:20 -0700165
Jeff Sharkey401b2602017-12-14 22:15:20 -0700166 void handleDiskAdded(const std::shared_ptr<android::vold::Disk>& disk);
167 void handleDiskChanged(dev_t device);
168 void handleDiskRemoved(dev_t device);
169
Jeff Sharkeyc8e04c52015-04-21 12:14:17 -0700170 std::mutex mLock;
Jeff Sharkey83b559c2017-09-12 16:30:52 -0600171 std::mutex mCryptLock;
Jeff Sharkeyc8e04c52015-04-21 12:14:17 -0700172
Jeff Sharkey814e9d32017-09-13 11:49:44 -0600173 android::sp<android::os::IVoldListener> mListener;
174
Jeff Sharkey36801cc2015-03-13 16:09:20 -0700175 std::list<std::shared_ptr<DiskSource>> mDiskSources;
176 std::list<std::shared_ptr<android::vold::Disk>> mDisks;
Jeff Sharkey401b2602017-12-14 22:15:20 -0700177 std::list<std::shared_ptr<android::vold::Disk>> mPendingDisks;
Jeff Sharkey11c2d382017-09-11 10:32:01 -0600178 std::list<std::shared_ptr<android::vold::VolumeBase>> mObbVolumes;
Jeff Sharkey36801cc2015-03-13 16:09:20 -0700179
Jeff Sharkeybd3038d2015-06-10 09:42:01 -0700180 std::unordered_map<userid_t, int> mAddedUsers;
181 std::unordered_set<userid_t> mStartedUsers;
Jeff Sharkey36801cc2015-03-13 16:09:20 -0700182
Jeff Sharkeyfa1c6772017-03-25 22:49:13 -0600183 std::string mVirtualDiskPath;
184 std::shared_ptr<android::vold::Disk> mVirtualDisk;
Jeff Sharkey36801cc2015-03-13 16:09:20 -0700185 std::shared_ptr<android::vold::VolumeBase> mInternalEmulated;
186 std::shared_ptr<android::vold::VolumeBase> mPrimary;
Jeff Sharkey11c2d382017-09-11 10:32:01 -0600187
Sudheer Shanka62bbb2b2018-08-01 01:09:10 -0700188 std::unordered_map<std::string, appid_t> mAppIds;
189 std::unordered_map<appid_t, std::string> mSandboxIds;
190 std::unordered_map<userid_t, std::vector<std::string>> mUserPackages;
Sudheer Shanka40ab6742018-09-18 13:07:45 -0700191 std::unordered_set<std::string> mVisibleVolumeIds;
Sudheer Shanka62bbb2b2018-08-01 01:09:10 -0700192
Jeff Sharkey11c2d382017-09-11 10:32:01 -0600193 int mNextObbId;
Jeff Sharkey401b2602017-12-14 22:15:20 -0700194 bool mSecureKeyguardShowing;
San Mehatf1b736b2009-10-10 17:22:08 -0700195};
Ken Sumrall29d8da82011-05-18 17:20:07 -0700196
San Mehatf1b736b2009-10-10 17:22:08 -0700197#endif