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, int partnum, int flags) :
 101                 mSysPattern(sysPattern), mNickname(nickname), mPartNum(partnum), mFlags(flags) {
 102         }
 103
 104         bool matches(const std::string& sysPath) {
 105             return !fnmatch(mSysPattern.c_str(), sysPath.c_str(), 0);
 106         }
 107
 108         const std::string& getNickname() { return mNickname; }
 109         int getPartNum() { return mPartNum; }
 110         int getFlags() { return mFlags; }
 111
 112     private:
 113         std::string mSysPattern;
 114         std::string mNickname;
 115         int mPartNum;
 116         int mFlags;
 117     };
 118
 119     void addDiskSource(const std::shared_ptr<DiskSource>& diskSource);
 120
 121     std::shared_ptr<android::vold::Disk> findDisk(const std::string& id);
 122     std::shared_ptr<android::vold::VolumeBase> findVolume(const std::string& id);
 123
 124     void listVolumes(android::vold::VolumeBase::Type type, std::list<std::string>& list);
 125
 126     nsecs_t benchmarkPrivate(const std::string& id);
 127
 128     int forgetPartition(const std::string& partGuid);
 129
 130     int onUserAdded(userid_t userId, int userSerialNumber);
 131     int onUserRemoved(userid_t userId);
 132     int onUserStarted(userid_t userId);
 133     int onUserStopped(userid_t userId);
 134
 135     int setPrimary(const std::shared_ptr<android::vold::VolumeBase>& vol);
 136
 137     int remountUid(uid_t uid, const std::string& mode);
 138
 139     /* Reset all internal state, typically during framework boot */
 140     int reset();
 141     /* Prepare for device shutdown, safely unmounting all devices */
 142     int shutdown();
 143     /* Unmount all volumes, usually for encryption */
 144     int unmountAll();
 145
 146     /* ASEC */
 147     int findAsec(const char *id, char *asecPath = NULL, size_t asecPathLen = 0,
 148             const char **directory = NULL) const;
 149     int createAsec(const char *id, unsigned long numSectors, const char *fstype,
 150                    const char *key, const int ownerUid, bool isExternal);
 151     int resizeAsec(const char *id, unsigned long numSectors, const char *key);
 152     int finalizeAsec(const char *id);
 153
 154     /**
 155      * Fixes ASEC permissions on a filesystem that has owners and permissions.
 156      * This currently means EXT4-based ASEC containers.
 157      *
 158      * There is a single file that can be marked as "private" and will not have
 159      * world-readable permission. The group for that file will be set to the gid
 160      * supplied.
 161      *
 162      * Returns 0 on success.
 163      */
 164     int fixupAsecPermissions(const char *id, gid_t gid, const char* privateFilename);
 165     int destroyAsec(const char *id, bool force);
 166     int mountAsec(const char *id, const char *key, int ownerUid, bool readOnly);
 167     int unmountAsec(const char *id, bool force);
 168     int renameAsec(const char *id1, const char *id2);
 169     int getAsecMountPath(const char *id, char *buffer, int maxlen);
 170     int getAsecFilesystemPath(const char *id, char *buffer, int maxlen);
 171
 172     /* Loopback images */
 173     int listMountedObbs(SocketClient* cli);
 174     int mountObb(const char *fileName, const char *key, int ownerUid);
 175     int unmountObb(const char *fileName, bool force);
 176     int getObbMountPath(const char *id, char *buffer, int maxlen);
 177
 178     /* Shared between ASEC and Loopback images */
 179     int unmountLoopImage(const char *containerId, const char *loopId,
 180             const char *fileName, const char *mountPoint, bool force);
 181
 182     int updateVirtualDisk();
 183     int setDebug(bool enable);
 184
 185     void setBroadcaster(SocketListener *sl) { mBroadcaster = sl; }
 186     SocketListener *getBroadcaster() { return mBroadcaster; }
 187
 188     static VolumeManager *Instance();
 189
 190     static char *asecHash(const char *id, char *buffer, size_t len);
 191
 192     /*
 193      * Ensure that all directories along given path exist, creating parent
 194      * directories as needed.  Validates that given path is absolute and that
 195      * it contains no relative "." or ".." paths or symlinks.  Last path segment
 196      * is treated as filename and ignored, unless the path ends with "/".  Also
 197      * ensures that path belongs to a volume managed by vold.
 198      */
 199     int mkdirs(char* path);
 200
 201 private:
 202     VolumeManager();
 203     void readInitialState();
 204     bool isMountpointMounted(const char *mp);
 205     bool isAsecInDirectory(const char *dir, const char *asec) const;
 206     bool isLegalAsecId(const char *id) const;
 207
 208     int linkPrimary(userid_t userId);
 209
 210     std::mutex mLock;
 211
 212     std::list<std::shared_ptr<DiskSource>> mDiskSources;
 213     std::list<std::shared_ptr<android::vold::Disk>> mDisks;
 214
 215     std::unordered_map<userid_t, int> mAddedUsers;
 216     std::unordered_set<userid_t> mStartedUsers;
 217
 218     std::string mVirtualDiskPath;
 219     std::shared_ptr<android::vold::Disk> mVirtualDisk;
 220     std::shared_ptr<android::vold::VolumeBase> mInternalEmulated;
 221     std::shared_ptr<android::vold::VolumeBase> mPrimary;
 222 };
 223
 224 extern "C" {
 225 #endif /* __cplusplus */
 226 #define UNMOUNT_NOT_MOUNTED_ERR (-2)
 227     int vold_unmountAll(void);
 228 #ifdef __cplusplus
 229 }
 230 #endif
 231
 232 #endif