VolumeManager.h

   1 /*
   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
  17 #ifndef ANDROID_VOLD_VOLUME_MANAGER_H
  18 #define ANDROID_VOLD_VOLUME_MANAGER_H
  19
  20 #include <pthread.h>
  21 #include <fnmatch.h>
  22 #include <stdlib.h>
  23
  24 #ifdef __cplusplus
  25
  26 #include <list>
  27 #include <mutex>
  28 #include <string>
  29 #include <unordered_map>
  30 #include <unordered_set>
  31
  32 #include <cutils/multiuser.h>
  33 #include <utils/List.h>
  34 #include <utils/Timers.h>
  35 #include <sysutils/SocketListener.h>
  36 #include <sysutils/NetlinkEvent.h>
  37
  38 #include "Disk.h"
  39 #include "DiskPartition.h"
  40 #include "VolumeBase.h"
  41
  42 /* The length of an MD5 hash when encoded into ASCII hex characters */
  43 #define MD5_ASCII_LENGTH_PLUS_NULL ((MD5_DIGEST_LENGTH*2)+1)
  44
  45 typedef enum { ASEC, OBB } container_type_t;
  46
  47 class ContainerData {
  48 public:
  49     ContainerData(char* _id, container_type_t _type)
  50             : id(_id)
  51             , type(_type)
  52     {}
  53
  54     ~ContainerData() {
  55         if (id != NULL) {
  56             free(id);
  57             id = NULL;
  58         }
  59     }
  60
  61     char *id;
  62     container_type_t type;
  63 };
  64
  65 typedef android::List<ContainerData*> AsecIdCollection;
  66
  67 class VolumeManager {
  68 public:
  69     static const char *SEC_ASECDIR_EXT;
  70     static const char *SEC_ASECDIR_INT;
  71     static const char *ASECDIR;
  72     static const char *LOOPDIR;
  73
  74 private:
  75     static VolumeManager *sInstance;
  76
  77     SocketListener        *mBroadcaster;
  78
  79     AsecIdCollection      *mActiveContainers;
  80     bool                   mDebug;
  81
  82     // for adjusting /proc/sys/vm/dirty_ratio when UMS is active
  83     int                    mUmsSharingCount;
  84     int                    mSavedDirtyRatio;
  85     int                    mUmsDirtyRatio;
  86
  87 public:
  88     virtual ~VolumeManager();
  89
  90     // TODO: pipe all requests through VM to avoid exposing this lock
  91     std::mutex& getLock() { return mLock; }
  92
  93     int start();
  94     int stop();
  95
  96     void handleBlockEvent(NetlinkEvent *evt);
  97
  98     class DiskSource {
  99     public:
 100         DiskSource(const std::string& sysPattern, const std::string& nickname,
 101                         int partnum, int flags,
 102                         const std::string& fstype, const std::string mntopts) :
 103                 mSysPattern(sysPattern), mNickname(nickname),
 104                 mPartNum(partnum), mFlags(flags),
 105                 mFsType(fstype), mMntOpts(mntopts) {
 106         }
 107
 108         bool matches(const std::string& sysPath) {
 109             return !fnmatch(mSysPattern.c_str(), sysPath.c_str(), 0);
 110         }
 111
 112         const std::string& getNickname() { return mNickname; }
 113         int getPartNum() { return mPartNum; }
 114         int getFlags() { return mFlags; }
 115         const std::string& getFsType() { return mFsType; }
 116         const std::string& getMntOpts() { return mMntOpts; }
 117
 118     private:
 119         std::string mSysPattern;
 120         std::string mNickname;
 121         int mPartNum;
 122         int mFlags;
 123         std::string mFsType;
 124         std::string mMntOpts;
 125     };
 126
 127     void addDiskSource(const std::shared_ptr<DiskSource>& diskSource);
 128
 129     std::shared_ptr<android::vold::Disk> findDisk(const std::string& id);
 130     std::shared_ptr<android::vold::VolumeBase> findVolume(const std::string& id);
 131
 132     void listVolumes(android::vold::VolumeBase::Type type, std::list<std::string>& list);
 133
 134     nsecs_t benchmarkPrivate(const std::string& id);
 135
 136     int forgetPartition(const std::string& partGuid);
 137
 138     int onUserAdded(userid_t userId, int userSerialNumber);
 139     int onUserRemoved(userid_t userId);
 140     int onUserStarted(userid_t userId);
 141     int onUserStopped(userid_t userId);
 142
 143     int setPrimary(const std::shared_ptr<android::vold::VolumeBase>& vol);
 144
 145     int remountUid(uid_t uid, const std::string& mode);
 146
 147     /* Reset all internal state, typically during framework boot */
 148     int reset();
 149     /* Prepare for device shutdown, safely unmounting all devices */
 150     int shutdown();
 151     /* Unmount all volumes, usually for encryption */
 152     int unmountAll();
 153
 154     /* ASEC */
 155     int findAsec(const char *id, char *asecPath = NULL, size_t asecPathLen = 0,
 156             const char **directory = NULL) const;
 157     int createAsec(const char *id, unsigned long numSectors, const char *fstype,
 158                    const char *key, const int ownerUid, bool isExternal);
 159     int resizeAsec(const char *id, unsigned long numSectors, const char *key);
 160     int finalizeAsec(const char *id);
 161
 162     /**
 163      * Fixes ASEC permissions on a filesystem that has owners and permissions.
 164      * This currently means EXT4-based ASEC containers.
 165      *
 166      * There is a single file that can be marked as "private" and will not have
 167      * world-readable permission. The group for that file will be set to the gid
 168      * supplied.
 169      *
 170      * Returns 0 on success.
 171      */
 172     int fixupAsecPermissions(const char *id, gid_t gid, const char* privateFilename);
 173     int destroyAsec(const char *id, bool force);
 174     int mountAsec(const char *id, const char *key, int ownerUid, bool readOnly);
 175     int unmountAsec(const char *id, bool force);
 176     int renameAsec(const char *id1, const char *id2);
 177     int getAsecMountPath(const char *id, char *buffer, int maxlen);
 178     int getAsecFilesystemPath(const char *id, char *buffer, int maxlen);
 179
 180     /* Loopback images */
 181     int listMountedObbs(SocketClient* cli);
 182     int mountObb(const char *fileName, const char *key, int ownerUid);
 183     int unmountObb(const char *fileName, bool force);
 184     int getObbMountPath(const char *id, char *buffer, int maxlen);
 185
 186     /* Shared between ASEC and Loopback images */
 187     int unmountLoopImage(const char *containerId, const char *loopId,
 188             const char *fileName, const char *mountPoint, bool force);
 189
 190     int updateVirtualDisk();
 191     int setDebug(bool enable);
 192
 193     void setBroadcaster(SocketListener *sl) { mBroadcaster = sl; }
 194     SocketListener *getBroadcaster() { return mBroadcaster; }
 195
 196     static VolumeManager *Instance();
 197
 198     static char *asecHash(const char *id, char *buffer, size_t len);
 199
 200     /*
 201      * Ensure that all directories along given path exist, creating parent
 202      * directories as needed.  Validates that given path is absolute and that
 203      * it contains no relative "." or ".." paths or symlinks.  Last path segment
 204      * is treated as filename and ignored, unless the path ends with "/".  Also
 205      * ensures that path belongs to a volume managed by vold.
 206      */
 207     int mkdirs(char* path);
 208
 209 private:
 210     VolumeManager();
 211     void readInitialState();
 212     bool isMountpointMounted(const char *mp);
 213     bool isAsecInDirectory(const char *dir, const char *asec) const;
 214     bool isLegalAsecId(const char *id) const;
 215
 216     int linkPrimary(userid_t userId);
 217
 218     std::mutex mLock;
 219
 220     std::list<std::shared_ptr<DiskSource>> mDiskSources;
 221     std::list<std::shared_ptr<android::vold::Disk>> mDisks;
 222
 223     std::unordered_map<userid_t, int> mAddedUsers;
 224     std::unordered_set<userid_t> mStartedUsers;
 225
 226     std::string mVirtualDiskPath;
 227     std::shared_ptr<android::vold::Disk> mVirtualDisk;
 228     std::shared_ptr<android::vold::VolumeBase> mInternalEmulated;
 229     std::shared_ptr<android::vold::VolumeBase> mPrimary;
 230 };
 231
 232 extern "C" {
 233 #endif /* __cplusplus */
 234 #define UNMOUNT_NOT_MOUNTED_ERR (-2)
 235     int vold_unmountAll(void);
 236 #ifdef __cplusplus
 237 }
 238 #endif
 239
 240 #endif