blob: 5b3fbf6dcba8250252f05fe9332c8d9e820819c2 [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
26#include <string>
27#include <list>
28
29#include <cutils/multiuser.h>
San Mehatf1b736b2009-10-10 17:22:08 -070030#include <utils/List.h>
31#include <sysutils/SocketListener.h>
32
Jeff Sharkey36801cc2015-03-13 16:09:20 -070033#include "Disk.h"
San Mehatf1b736b2009-10-10 17:22:08 -070034#include "Volume.h"
Jeff Sharkey36801cc2015-03-13 16:09:20 -070035#include "VolumeBase.h"
San Mehatf1b736b2009-10-10 17:22:08 -070036
Kenny Rootacc9e7d2010-06-18 19:06:50 -070037/* The length of an MD5 hash when encoded into ASCII hex characters */
38#define MD5_ASCII_LENGTH_PLUS_NULL ((MD5_DIGEST_LENGTH*2)+1)
39
Kenny Rootcbacf782010-09-24 15:11:48 -070040typedef enum { ASEC, OBB } container_type_t;
41
42class ContainerData {
43public:
44 ContainerData(char* _id, container_type_t _type)
45 : id(_id)
46 , type(_type)
47 {}
48
49 ~ContainerData() {
50 if (id != NULL) {
51 free(id);
52 id = NULL;
53 }
54 }
55
56 char *id;
57 container_type_t type;
58};
59
60typedef android::List<ContainerData*> AsecIdCollection;
San Mehat88705162010-01-15 09:26:28 -080061
San Mehatf1b736b2009-10-10 17:22:08 -070062class VolumeManager {
63private:
64 static VolumeManager *sInstance;
65
San Mehatf1b736b2009-10-10 17:22:08 -070066 SocketListener *mBroadcaster;
San Mehatf1b736b2009-10-10 17:22:08 -070067
68 VolumeCollection *mVolumes;
San Mehat88705162010-01-15 09:26:28 -080069 AsecIdCollection *mActiveContainers;
San Mehatd9a4e352010-03-12 13:32:47 -080070 bool mDebug;
San Mehatf1b736b2009-10-10 17:22:08 -070071
Mike Lockwooda28056b2010-10-28 15:21:24 -040072 // for adjusting /proc/sys/vm/dirty_ratio when UMS is active
73 int mUmsSharingCount;
74 int mSavedDirtyRatio;
75 int mUmsDirtyRatio;
Ken Sumrall3b170052011-07-11 15:38:57 -070076 int mVolManagerDisabled;
Mike Lockwooda28056b2010-10-28 15:21:24 -040077
San Mehatf1b736b2009-10-10 17:22:08 -070078public:
79 virtual ~VolumeManager();
80
81 int start();
82 int stop();
83
San Mehatfd7f5872009-10-12 11:32:47 -070084 void handleBlockEvent(NetlinkEvent *evt);
San Mehatf1b736b2009-10-10 17:22:08 -070085
86 int addVolume(Volume *v);
87
Jeff Sharkey36801cc2015-03-13 16:09:20 -070088 class DiskSource {
89 public:
90 DiskSource(const std::string& sysPattern, const std::string& nickname, int flags) :
91 mSysPattern(sysPattern), mNickname(nickname), mFlags(flags) {
92 }
93
94 bool matches(const std::string& sysPath) {
95 return !fnmatch(mSysPattern.c_str(), sysPath.c_str(), 0);
96 }
97
98 const std::string& getNickname() { return mNickname; }
99 int getFlags() { return mFlags; }
100
101 private:
102 std::string mSysPattern;
103 std::string mNickname;
104 int mFlags;
105 };
106
107 void addDiskSource(const std::shared_ptr<DiskSource>& diskSource);
108
109 std::shared_ptr<android::vold::Disk> findDisk(const std::string& id);
110 std::shared_ptr<android::vold::VolumeBase> findVolume(const std::string& id);
111
112 int startUser(userid_t userId);
113 int cleanupUser(userid_t userId);
114
115 int setPrimary(const std::shared_ptr<android::vold::VolumeBase>& vol);
116
117 /* Reset all internal state, typically during framework boot */
118 int reset();
119 /* Prepare for device shutdown, safely unmounting all devices */
120 int shutdown();
121
JP Abgrall40b64a62014-07-24 18:02:16 -0700122 int listVolumes(SocketClient *cli, bool broadcast);
San Mehat49e2bce2009-10-12 16:29:01 -0700123 int mountVolume(const char *label);
Ken Sumrall0b8b5972011-08-31 16:14:23 -0700124 int unmountVolume(const char *label, bool force, bool revert);
San Mehata2677e42009-12-13 10:40:18 -0800125 int shareVolume(const char *label, const char *method);
126 int unshareVolume(const char *label, const char *method);
San Mehateba65e92010-01-29 05:15:16 -0800127 int shareEnabled(const char *path, const char *method, bool *enabled);
Ken Sumrall9caab762013-06-11 19:10:20 -0700128 int formatVolume(const char *label, bool wipe);
Ken Sumrall3b170052011-07-11 15:38:57 -0700129 void disableVolumeManager(void) { mVolManagerDisabled = 1; }
Kenny Rootfb7c4d52010-06-30 18:48:41 -0700130
131 /* ASEC */
Kenny Root344ca102012-04-03 17:23:01 -0700132 int findAsec(const char *id, char *asecPath = NULL, size_t asecPathLen = 0,
133 const char **directory = NULL) const;
San Mehat8b8f71b2010-01-11 09:17:25 -0800134 int createAsec(const char *id, unsigned numSectors, const char *fstype,
Kenny Root344ca102012-04-03 17:23:01 -0700135 const char *key, const int ownerUid, bool isExternal);
Daniel Rosenbergfcd34a02014-05-22 11:23:56 -0700136 int resizeAsec(const char *id, unsigned numSectors, const char *key);
San Mehata19b2502010-01-06 10:33:53 -0800137 int finalizeAsec(const char *id);
Kenny Root344ca102012-04-03 17:23:01 -0700138
139 /**
140 * Fixes ASEC permissions on a filesystem that has owners and permissions.
141 * This currently means EXT4-based ASEC containers.
142 *
143 * There is a single file that can be marked as "private" and will not have
144 * world-readable permission. The group for that file will be set to the gid
145 * supplied.
146 *
147 * Returns 0 on success.
148 */
149 int fixupAsecPermissions(const char *id, gid_t gid, const char* privateFilename);
San Mehat4ba89482010-02-18 09:00:18 -0800150 int destroyAsec(const char *id, bool force);
Jeff Sharkey43ed1232014-08-22 12:29:05 -0700151 int mountAsec(const char *id, const char *key, int ownerUid, bool readOnly);
San Mehat4ba89482010-02-18 09:00:18 -0800152 int unmountAsec(const char *id, bool force);
San Mehat048b0802010-01-23 08:17:06 -0800153 int renameAsec(const char *id1, const char *id2);
San Mehata19b2502010-01-06 10:33:53 -0800154 int getAsecMountPath(const char *id, char *buffer, int maxlen);
Dianne Hackborn736910c2011-06-27 13:37:07 -0700155 int getAsecFilesystemPath(const char *id, char *buffer, int maxlen);
San Mehatf1b736b2009-10-10 17:22:08 -0700156
Kenny Rootfb7c4d52010-06-30 18:48:41 -0700157 /* Loopback images */
Kenny Root508c0e12010-07-12 09:59:49 -0700158 int listMountedObbs(SocketClient* cli);
159 int mountObb(const char *fileName, const char *key, int ownerUid);
160 int unmountObb(const char *fileName, bool force);
161 int getObbMountPath(const char *id, char *buffer, int maxlen);
Kenny Rootfb7c4d52010-06-30 18:48:41 -0700162
Kenny Root93ecb382012-08-09 11:28:37 -0700163 Volume* getVolumeForFile(const char *fileName);
164
Kenny Rootfb7c4d52010-06-30 18:48:41 -0700165 /* Shared between ASEC and Loopback images */
166 int unmountLoopImage(const char *containerId, const char *loopId,
167 const char *fileName, const char *mountPoint, bool force);
168
San Mehatd9a4e352010-03-12 13:32:47 -0800169 void setDebug(bool enable);
170
San Mehat1a06eda2010-04-15 12:58:50 -0700171 // XXX: Post froyo this should be moved and cleaned up
172 int cleanupAsec(Volume *v, bool force);
San Mehat0cde53c2009-12-22 08:32:33 -0800173
San Mehatf1b736b2009-10-10 17:22:08 -0700174 void setBroadcaster(SocketListener *sl) { mBroadcaster = sl; }
175 SocketListener *getBroadcaster() { return mBroadcaster; }
176
177 static VolumeManager *Instance();
178
San Mehatd9a4e352010-03-12 13:32:47 -0800179 static char *asecHash(const char *id, char *buffer, size_t len);
San Mehat1a06eda2010-04-15 12:58:50 -0700180
Ken Sumrall29d8da82011-05-18 17:20:07 -0700181 Volume *lookupVolume(const char *label);
182 int getNumDirectVolumes(void);
183 int getDirectVolumeList(struct volume_info *vol_list);
Ken Sumrall425524d2012-06-14 20:55:28 -0700184 int unmountAllAsecsInDir(const char *directory);
Ken Sumrall29d8da82011-05-18 17:20:07 -0700185
Jeff Sharkey71ebe152013-09-17 17:24:38 -0700186 /*
187 * Ensure that all directories along given path exist, creating parent
188 * directories as needed. Validates that given path is absolute and that
189 * it contains no relative "." or ".." paths or symlinks. Last path segment
190 * is treated as filename and ignored, unless the path ends with "/". Also
191 * ensures that path belongs to a volume managed by vold.
192 */
193 int mkdirs(char* path);
194
San Mehatf1b736b2009-10-10 17:22:08 -0700195private:
196 VolumeManager();
Mike Lockwood99635f62010-06-25 23:04:04 -0400197 void readInitialState();
San Mehata19b2502010-01-06 10:33:53 -0800198 bool isMountpointMounted(const char *mp);
Kenny Root344ca102012-04-03 17:23:01 -0700199 bool isAsecInDirectory(const char *dir, const char *asec) const;
Nick Kralevich66962602014-01-27 14:58:06 -0800200 bool isLegalAsecId(const char *id) const;
Jeff Sharkey36801cc2015-03-13 16:09:20 -0700201
202 int linkPrimary(userid_t userId);
203
204 std::list<std::shared_ptr<DiskSource>> mDiskSources;
205 std::list<std::shared_ptr<android::vold::Disk>> mDisks;
206
207 std::list<userid_t> mUsers;
208
209 std::shared_ptr<android::vold::VolumeBase> mInternalEmulated;
210 std::shared_ptr<android::vold::VolumeBase> mPrimary;
San Mehatf1b736b2009-10-10 17:22:08 -0700211};
Ken Sumrall29d8da82011-05-18 17:20:07 -0700212
213extern "C" {
214#endif /* __cplusplus */
Ken Sumrall319b1042011-06-14 14:01:55 -0700215#define UNMOUNT_NOT_MOUNTED_ERR -2
Ken Sumrall3b170052011-07-11 15:38:57 -0700216 int vold_disableVol(const char *label);
Ken Sumrall29d8da82011-05-18 17:20:07 -0700217 int vold_getNumDirectVolumes(void);
218 int vold_getDirectVolumeList(struct volume_info *v);
Ken Sumrall425524d2012-06-14 20:55:28 -0700219 int vold_unmountAllAsecs(void);
Ken Sumrall29d8da82011-05-18 17:20:07 -0700220#ifdef __cplusplus
221}
222#endif
223
San Mehatf1b736b2009-10-10 17:22:08 -0700224#endif