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 _VOLUMEMANAGER_H 18 #define _VOLUMEMANAGER_H 19 20 #include <pthread.h> 21 22 #ifdef __cplusplus 23 #include <utils/List.h> 24 #include <sysutils/SocketListener.h> 25 26 #include "Volume.h" 27 28 /* The length of an MD5 hash when encoded into ASCII hex characters */ 29 #define MD5_ASCII_LENGTH_PLUS_NULL ((MD5_DIGEST_LENGTH*2)+1) 30 31 typedef enum { ASEC, OBB } container_type_t; 32 33 class ContainerData { 34 public: 35 ContainerData(char* _id, container_type_t _type) 36 : id(_id) 37 , type(_type) 38 {} 39 40 ~ContainerData() { 41 if (id != NULL) { 42 free(id); 43 id = NULL; 44 } 45 } 46 47 char *id; 48 container_type_t type; 49 }; 50 51 typedef android::List<ContainerData*> AsecIdCollection; 52 53 class VolumeManager { 54 private: 55 static VolumeManager *sInstance; 56 57 private: 58 SocketListener *mBroadcaster; 59 60 VolumeCollection *mVolumes; 61 AsecIdCollection *mActiveContainers; 62 bool mDebug; 63 64 // for adjusting /proc/sys/vm/dirty_ratio when UMS is active 65 int mUmsSharingCount; 66 int mSavedDirtyRatio; 67 int mUmsDirtyRatio; 68 int mVolManagerDisabled; 69 70 public: 71 virtual ~VolumeManager(); 72 73 int start(); 74 int stop(); 75 76 void handleBlockEvent(NetlinkEvent *evt); 77 78 int addVolume(Volume *v); 79 80 int listVolumes(SocketClient *cli); 81 int mountVolume(const char *label); 82 int unmountVolume(const char *label, bool force, bool revert); 83 int shareVolume(const char *label, const char *method); 84 int unshareVolume(const char *label, const char *method); 85 int shareEnabled(const char *path, const char *method, bool *enabled); 86 int formatVolume(const char *label, bool wipe); 87 void disableVolumeManager(void) { mVolManagerDisabled = 1; } 88 89 /* ASEC */ 90 int findAsec(const char *id, char *asecPath = NULL, size_t asecPathLen = 0, 91 const char **directory = NULL) const; 92 int createAsec(const char *id, unsigned numSectors, const char *fstype, 93 const char *key, const int ownerUid, bool isExternal); 94 int finalizeAsec(const char *id); 95 96 /** 97 * Fixes ASEC permissions on a filesystem that has owners and permissions. 98 * This currently means EXT4-based ASEC containers. 99 * 100 * There is a single file that can be marked as "private" and will not have 101 * world-readable permission. The group for that file will be set to the gid 102 * supplied. 103 * 104 * Returns 0 on success. 105 */ 106 int fixupAsecPermissions(const char *id, gid_t gid, const char* privateFilename); 107 int destroyAsec(const char *id, bool force); 108 int mountAsec(const char *id, const char *key, int ownerUid); 109 int unmountAsec(const char *id, bool force); 110 int renameAsec(const char *id1, const char *id2); 111 int getAsecMountPath(const char *id, char *buffer, int maxlen); 112 int getAsecFilesystemPath(const char *id, char *buffer, int maxlen); 113 114 /* Loopback images */ 115 int listMountedObbs(SocketClient* cli); 116 int mountObb(const char *fileName, const char *key, int ownerUid); 117 int unmountObb(const char *fileName, bool force); 118 int getObbMountPath(const char *id, char *buffer, int maxlen); 119 120 Volume* getVolumeForFile(const char *fileName); 121 122 /* Shared between ASEC and Loopback images */ 123 int unmountLoopImage(const char *containerId, const char *loopId, 124 const char *fileName, const char *mountPoint, bool force); 125 126 void setDebug(bool enable); 127 128 // XXX: Post froyo this should be moved and cleaned up 129 int cleanupAsec(Volume *v, bool force); 130 131 void setBroadcaster(SocketListener *sl) { mBroadcaster = sl; } 132 SocketListener *getBroadcaster() { return mBroadcaster; } 133 134 static VolumeManager *Instance(); 135 136 static char *asecHash(const char *id, char *buffer, size_t len); 137 138 Volume *lookupVolume(const char *label); 139 int getNumDirectVolumes(void); 140 int getDirectVolumeList(struct volume_info *vol_list); 141 int unmountAllAsecsInDir(const char *directory); 142 143 /* 144 * Ensure that all directories along given path exist, creating parent 145 * directories as needed. Validates that given path is absolute and that 146 * it contains no relative "." or ".." paths or symlinks. Last path segment 147 * is treated as filename and ignored, unless the path ends with "/". Also 148 * ensures that path belongs to a volume managed by vold. 149 */ 150 int mkdirs(char* path); 151 152 private: 153 VolumeManager(); 154 void readInitialState(); 155 bool isMountpointMounted(const char *mp); 156 bool isAsecInDirectory(const char *dir, const char *asec) const; 157 bool isLegalAsecId(const char *id) const; 158 }; 159 160 extern "C" { 161 #endif /* __cplusplus */ 162 #define UNMOUNT_NOT_MOUNTED_ERR -2 163 int vold_disableVol(const char *label); 164 int vold_getNumDirectVolumes(void); 165 int vold_getDirectVolumeList(struct volume_info *v); 166 int vold_unmountAllAsecs(void); 167 #ifdef __cplusplus 168 } 169 #endif 170 171 #endif 172
