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 _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, bool broadcast);
  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 resizeAsec(const char *id, unsigned numSectors, const char *key);
  95     int finalizeAsec(const char *id);
  96
  97     /**
  98      * Fixes ASEC permissions on a filesystem that has owners and permissions.
  99      * This currently means EXT4-based ASEC containers.
 100      *
 101      * There is a single file that can be marked as "private" and will not have
 102      * world-readable permission. The group for that file will be set to the gid
 103      * supplied.
 104      *
 105      * Returns 0 on success.
 106      */
 107     int fixupAsecPermissions(const char *id, gid_t gid, const char* privateFilename);
 108     int destroyAsec(const char *id, bool force);
 109     int mountAsec(const char *id, const char *key, int ownerUid, bool readOnly);
 110     int unmountAsec(const char *id, bool force);
 111     int renameAsec(const char *id1, const char *id2);
 112     int getAsecMountPath(const char *id, char *buffer, int maxlen);
 113     int getAsecFilesystemPath(const char *id, char *buffer, int maxlen);
 114
 115     /* Loopback images */
 116     int listMountedObbs(SocketClient* cli);
 117     int mountObb(const char *fileName, const char *key, int ownerUid);
 118     int unmountObb(const char *fileName, bool force);
 119     int getObbMountPath(const char *id, char *buffer, int maxlen);
 120
 121     Volume* getVolumeForFile(const char *fileName);
 122
 123     /* Shared between ASEC and Loopback images */
 124     int unmountLoopImage(const char *containerId, const char *loopId,
 125             const char *fileName, const char *mountPoint, bool force);
 126
 127     void setDebug(bool enable);
 128
 129     // XXX: Post froyo this should be moved and cleaned up
 130     int cleanupAsec(Volume *v, bool force);
 131
 132     void setBroadcaster(SocketListener *sl) { mBroadcaster = sl; }
 133     SocketListener *getBroadcaster() { return mBroadcaster; }
 134
 135     static VolumeManager *Instance();
 136
 137     static char *asecHash(const char *id, char *buffer, size_t len);
 138
 139     Volume *lookupVolume(const char *label);
 140     int getNumDirectVolumes(void);
 141     int getDirectVolumeList(struct volume_info *vol_list);
 142     int unmountAllAsecsInDir(const char *directory);
 143
 144     /*
 145      * Ensure that all directories along given path exist, creating parent
 146      * directories as needed.  Validates that given path is absolute and that
 147      * it contains no relative "." or ".." paths or symlinks.  Last path segment
 148      * is treated as filename and ignored, unless the path ends with "/".  Also
 149      * ensures that path belongs to a volume managed by vold.
 150      */
 151     int mkdirs(char* path);
 152
 153 private:
 154     VolumeManager();
 155     void readInitialState();
 156     bool isMountpointMounted(const char *mp);
 157     bool isAsecInDirectory(const char *dir, const char *asec) const;
 158     bool isLegalAsecId(const char *id) const;
 159 };
 160
 161 extern "C" {
 162 #endif /* __cplusplus */
 163 #define UNMOUNT_NOT_MOUNTED_ERR -2
 164     int vold_disableVol(const char *label);
 165     int vold_getNumDirectVolumes(void);
 166     int vold_getDirectVolumeList(struct volume_info *v);
 167     int vold_unmountAllAsecs(void);
 168 #ifdef __cplusplus
 169 }
 170 #endif
 171
 172 #endif