blob: 796a91d3f6bd22199c7737f14a07688d702cfade [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
20#include <pthread.h>
Jeff Sharkey36801cc2015-03-13 16:09:20 -070021#include <fnmatch.h>
22#include <stdlib.h>
San Mehatf1b736b2009-10-10 17:22:08 -070023
Ken Sumrall29d8da82011-05-18 17:20:07 -070024#ifdef __cplusplus
Jeff Sharkey36801cc2015-03-13 16:09:20 -070025
Jeff Sharkey36801cc2015-03-13 16:09:20 -070026#include <list>
Jeff Sharkeyc8e04c52015-04-21 12:14:17 -070027#include <mutex>
28#include <string>
Jeff Sharkeybd3038d2015-06-10 09:42:01 -070029#include <unordered_map>
30#include <unordered_set>
Jeff Sharkey36801cc2015-03-13 16:09:20 -070031
32#include <cutils/multiuser.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#include <sysutils/SocketListener.h>
Jeff Sharkey9f18fe72015-04-01 23:32:18 -070036#include <sysutils/NetlinkEvent.h>
San Mehatf1b736b2009-10-10 17:22:08 -070037
Jeff Sharkey36801cc2015-03-13 16:09:20 -070038#include "Disk.h"
Jeff Sharkey36801cc2015-03-13 16:09:20 -070039#include "VolumeBase.h"
San Mehatf1b736b2009-10-10 17:22:08 -070040
Kenny Rootacc9e7d2010-06-18 19:06:50 -070041/* The length of an MD5 hash when encoded into ASCII hex characters */
42#define MD5_ASCII_LENGTH_PLUS_NULL ((MD5_DIGEST_LENGTH*2)+1)
43
Kenny Rootcbacf782010-09-24 15:11:48 -070044typedef enum { ASEC, OBB } container_type_t;
45
46class ContainerData {
47public:
48 ContainerData(char* _id, container_type_t _type)
49 : id(_id)
50 , type(_type)
51 {}
52
53 ~ContainerData() {
54 if (id != NULL) {
55 free(id);
56 id = NULL;
57 }
58 }
59
60 char *id;
61 container_type_t type;
62};
63
64typedef android::List<ContainerData*> AsecIdCollection;
San Mehat88705162010-01-15 09:26:28 -080065
San Mehatf1b736b2009-10-10 17:22:08 -070066class VolumeManager {
Jeff Sharkey9f18fe72015-04-01 23:32:18 -070067public:
68 static const char *SEC_ASECDIR_EXT;
69 static const char *SEC_ASECDIR_INT;
70 static const char *ASECDIR;
71 static const char *LOOPDIR;
72
San Mehatf1b736b2009-10-10 17:22:08 -070073private:
74 static VolumeManager *sInstance;
75
San Mehatf1b736b2009-10-10 17:22:08 -070076 SocketListener *mBroadcaster;
San Mehatf1b736b2009-10-10 17:22:08 -070077
San Mehat88705162010-01-15 09:26:28 -080078 AsecIdCollection *mActiveContainers;
San Mehatd9a4e352010-03-12 13:32:47 -080079 bool mDebug;
San Mehatf1b736b2009-10-10 17:22:08 -070080
Mike Lockwooda28056b2010-10-28 15:21:24 -040081 // for adjusting /proc/sys/vm/dirty_ratio when UMS is active
82 int mUmsSharingCount;
83 int mSavedDirtyRatio;
84 int mUmsDirtyRatio;
85
San Mehatf1b736b2009-10-10 17:22:08 -070086public:
87 virtual ~VolumeManager();
88
Jeff Sharkeyc8e04c52015-04-21 12:14:17 -070089 // TODO: pipe all requests through VM to avoid exposing this lock
90 std::mutex& getLock() { return mLock; }
91
San Mehatf1b736b2009-10-10 17:22:08 -070092 int start();
93 int stop();
94
San Mehatfd7f5872009-10-12 11:32:47 -070095 void handleBlockEvent(NetlinkEvent *evt);
San Mehatf1b736b2009-10-10 17:22:08 -070096
Jeff Sharkey36801cc2015-03-13 16:09:20 -070097 class DiskSource {
98 public:
99 DiskSource(const std::string& sysPattern, const std::string& nickname, int flags) :
100 mSysPattern(sysPattern), mNickname(nickname), mFlags(flags) {
101 }
102
103 bool matches(const std::string& sysPath) {
104 return !fnmatch(mSysPattern.c_str(), sysPath.c_str(), 0);
105 }
106
107 const std::string& getNickname() { return mNickname; }
108 int getFlags() { return mFlags; }
109
110 private:
111 std::string mSysPattern;
112 std::string mNickname;
113 int mFlags;
114 };
115
116 void addDiskSource(const std::shared_ptr<DiskSource>& diskSource);
117
118 std::shared_ptr<android::vold::Disk> findDisk(const std::string& id);
119 std::shared_ptr<android::vold::VolumeBase> findVolume(const std::string& id);
120
Jeff Sharkeyc86ab6f2015-06-26 14:02:09 -0700121 void listVolumes(android::vold::VolumeBase::Type type, std::list<std::string>& list);
122
123 nsecs_t benchmarkPrivate(const std::string& id);
Jeff Sharkey5a6bfca2015-05-14 20:33:55 -0700124
Jeff Sharkeybc40cc82015-06-18 14:25:08 -0700125 int forgetPartition(const std::string& partGuid);
126
Jeff Sharkeybd3038d2015-06-10 09:42:01 -0700127 int onUserAdded(userid_t userId, int userSerialNumber);
128 int onUserRemoved(userid_t userId);
129 int onUserStarted(userid_t userId);
130 int onUserStopped(userid_t userId);
Jeff Sharkey36801cc2015-03-13 16:09:20 -0700131
132 int setPrimary(const std::shared_ptr<android::vold::VolumeBase>& vol);
133
Jeff Sharkey66270a22015-06-24 11:49:24 -0700134 int remountUid(uid_t uid, const std::string& mode);
135
Jeff Sharkey36801cc2015-03-13 16:09:20 -0700136 /* Reset all internal state, typically during framework boot */
137 int reset();
138 /* Prepare for device shutdown, safely unmounting all devices */
139 int shutdown();
Jeff Sharkey9c484982015-03-31 10:35:33 -0700140 /* Unmount all volumes, usually for encryption */
141 int unmountAll();
Jeff Sharkey36801cc2015-03-13 16:09:20 -0700142
Kenny Rootfb7c4d52010-06-30 18:48:41 -0700143 /* ASEC */
Kenny Root344ca102012-04-03 17:23:01 -0700144 int findAsec(const char *id, char *asecPath = NULL, size_t asecPathLen = 0,
145 const char **directory = NULL) const;
Mateusz Nowaka4f48d02015-08-03 18:06:39 +0200146 int createAsec(const char *id, unsigned long numSectors, const char *fstype,
Kenny Root344ca102012-04-03 17:23:01 -0700147 const char *key, const int ownerUid, bool isExternal);
Mateusz Nowaka4f48d02015-08-03 18:06:39 +0200148 int resizeAsec(const char *id, unsigned long numSectors, const char *key);
San Mehata19b2502010-01-06 10:33:53 -0800149 int finalizeAsec(const char *id);
Kenny Root344ca102012-04-03 17:23:01 -0700150
151 /**
152 * Fixes ASEC permissions on a filesystem that has owners and permissions.
153 * This currently means EXT4-based ASEC containers.
154 *
155 * There is a single file that can be marked as "private" and will not have
156 * world-readable permission. The group for that file will be set to the gid
157 * supplied.
158 *
159 * Returns 0 on success.
160 */
161 int fixupAsecPermissions(const char *id, gid_t gid, const char* privateFilename);
San Mehat4ba89482010-02-18 09:00:18 -0800162 int destroyAsec(const char *id, bool force);
Jeff Sharkey43ed1232014-08-22 12:29:05 -0700163 int mountAsec(const char *id, const char *key, int ownerUid, bool readOnly);
San Mehat4ba89482010-02-18 09:00:18 -0800164 int unmountAsec(const char *id, bool force);
San Mehat048b0802010-01-23 08:17:06 -0800165 int renameAsec(const char *id1, const char *id2);
San Mehata19b2502010-01-06 10:33:53 -0800166 int getAsecMountPath(const char *id, char *buffer, int maxlen);
Dianne Hackborn736910c2011-06-27 13:37:07 -0700167 int getAsecFilesystemPath(const char *id, char *buffer, int maxlen);
San Mehatf1b736b2009-10-10 17:22:08 -0700168
Kenny Rootfb7c4d52010-06-30 18:48:41 -0700169 /* Loopback images */
Kenny Root508c0e12010-07-12 09:59:49 -0700170 int listMountedObbs(SocketClient* cli);
171 int mountObb(const char *fileName, const char *key, int ownerUid);
172 int unmountObb(const char *fileName, bool force);
173 int getObbMountPath(const char *id, char *buffer, int maxlen);
Kenny Rootfb7c4d52010-06-30 18:48:41 -0700174
175 /* Shared between ASEC and Loopback images */
176 int unmountLoopImage(const char *containerId, const char *loopId,
177 const char *fileName, const char *mountPoint, bool force);
178
Jeff Sharkeyfa1c6772017-03-25 22:49:13 -0600179 int updateVirtualDisk();
Jeff Sharkeyf1b996d2015-04-17 17:35:20 -0700180 int setDebug(bool enable);
San Mehatd9a4e352010-03-12 13:32:47 -0800181
San Mehatf1b736b2009-10-10 17:22:08 -0700182 void setBroadcaster(SocketListener *sl) { mBroadcaster = sl; }
183 SocketListener *getBroadcaster() { return mBroadcaster; }
184
185 static VolumeManager *Instance();
186
San Mehatd9a4e352010-03-12 13:32:47 -0800187 static char *asecHash(const char *id, char *buffer, size_t len);
San Mehat1a06eda2010-04-15 12:58:50 -0700188
Jeff Sharkey71ebe152013-09-17 17:24:38 -0700189 /*
190 * Ensure that all directories along given path exist, creating parent
191 * directories as needed. Validates that given path is absolute and that
192 * it contains no relative "." or ".." paths or symlinks. Last path segment
193 * is treated as filename and ignored, unless the path ends with "/". Also
194 * ensures that path belongs to a volume managed by vold.
195 */
196 int mkdirs(char* path);
197
San Mehatf1b736b2009-10-10 17:22:08 -0700198private:
199 VolumeManager();
Mike Lockwood99635f62010-06-25 23:04:04 -0400200 void readInitialState();
San Mehata19b2502010-01-06 10:33:53 -0800201 bool isMountpointMounted(const char *mp);
Kenny Root344ca102012-04-03 17:23:01 -0700202 bool isAsecInDirectory(const char *dir, const char *asec) const;
Nick Kralevich66962602014-01-27 14:58:06 -0800203 bool isLegalAsecId(const char *id) const;
Jeff Sharkey36801cc2015-03-13 16:09:20 -0700204
205 int linkPrimary(userid_t userId);
206
Jeff Sharkeyc8e04c52015-04-21 12:14:17 -0700207 std::mutex mLock;
208
Jeff Sharkey36801cc2015-03-13 16:09:20 -0700209 std::list<std::shared_ptr<DiskSource>> mDiskSources;
210 std::list<std::shared_ptr<android::vold::Disk>> mDisks;
211
Jeff Sharkeybd3038d2015-06-10 09:42:01 -0700212 std::unordered_map<userid_t, int> mAddedUsers;
213 std::unordered_set<userid_t> mStartedUsers;
Jeff Sharkey36801cc2015-03-13 16:09:20 -0700214
Jeff Sharkeyfa1c6772017-03-25 22:49:13 -0600215 std::string mVirtualDiskPath;
216 std::shared_ptr<android::vold::Disk> mVirtualDisk;
Jeff Sharkey36801cc2015-03-13 16:09:20 -0700217 std::shared_ptr<android::vold::VolumeBase> mInternalEmulated;
218 std::shared_ptr<android::vold::VolumeBase> mPrimary;
San Mehatf1b736b2009-10-10 17:22:08 -0700219};
Ken Sumrall29d8da82011-05-18 17:20:07 -0700220
221extern "C" {
222#endif /* __cplusplus */
Chih-Hung Hsiehaae79382016-06-10 14:13:59 -0700223#define UNMOUNT_NOT_MOUNTED_ERR (-2)
Jeff Sharkey9c484982015-03-31 10:35:33 -0700224 int vold_unmountAll(void);
Ken Sumrall29d8da82011-05-18 17:20:07 -0700225#ifdef __cplusplus
226}
227#endif
228
San Mehatf1b736b2009-10-10 17:22:08 -0700229#endif