Home | History | Annotate | Download | only in vold 
      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);
     87     void disableVolumeManager(void) { mVolManagerDisabled = 1; }
     88 
     89     /* ASEC */
     90     int createAsec(const char *id, unsigned numSectors, const char *fstype,
     91                    const char *key, int ownerUid);
     92     int finalizeAsec(const char *id);
     93     int destroyAsec(const char *id, bool force);
     94     int mountAsec(const char *id, const char *key, int ownerUid);
     95     int unmountAsec(const char *id, bool force);
     96     int renameAsec(const char *id1, const char *id2);
     97     int getAsecMountPath(const char *id, char *buffer, int maxlen);
     98     int getAsecFilesystemPath(const char *id, char *buffer, int maxlen);
     99 
    100     /* Loopback images */
    101     int listMountedObbs(SocketClient* cli);
    102     int mountObb(const char *fileName, const char *key, int ownerUid);
    103     int unmountObb(const char *fileName, bool force);
    104     int getObbMountPath(const char *id, char *buffer, int maxlen);
    105 
    106     /* Shared between ASEC and Loopback images */
    107     int unmountLoopImage(const char *containerId, const char *loopId,
    108             const char *fileName, const char *mountPoint, bool force);
    109 
    110     void setDebug(bool enable);
    111 
    112     // XXX: Post froyo this should be moved and cleaned up
    113     int cleanupAsec(Volume *v, bool force);
    114 
    115     void setBroadcaster(SocketListener *sl) { mBroadcaster = sl; }
    116     SocketListener *getBroadcaster() { return mBroadcaster; }
    117 
    118     static VolumeManager *Instance();
    119 
    120     static char *asecHash(const char *id, char *buffer, size_t len);
    121 
    122     Volume *lookupVolume(const char *label);
    123     int getNumDirectVolumes(void);
    124     int getDirectVolumeList(struct volume_info *vol_list);
    125 
    126 private:
    127     VolumeManager();
    128     void readInitialState();
    129     bool isMountpointMounted(const char *mp);
    130 };
    131 
    132 extern "C" {
    133 #endif /* __cplusplus */
    134 #define UNMOUNT_NOT_MOUNTED_ERR -2
    135     int vold_disableVol(const char *label);
    136     int vold_getNumDirectVolumes(void);
    137     int vold_getDirectVolumeList(struct volume_info *v);
    138 #ifdef __cplusplus
    139 }
    140 #endif
    141 
    142 #endif
    143