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 #include <utils/List.h>
     23 #include <sysutils/SocketListener.h>
     24 
     25 #include "Volume.h"
     26 
     27 /* The length of an MD5 hash when encoded into ASCII hex characters */
     28 #define MD5_ASCII_LENGTH_PLUS_NULL ((MD5_DIGEST_LENGTH*2)+1)
     29 
     30 typedef enum { ASEC, OBB } container_type_t;
     31 
     32 class ContainerData {
     33 public:
     34     ContainerData(char* _id, container_type_t _type)
     35             : id(_id)
     36             , type(_type)
     37     {}
     38 
     39     ~ContainerData() {
     40         if (id != NULL) {
     41             free(id);
     42             id = NULL;
     43         }
     44     }
     45 
     46     char *id;
     47     container_type_t type;
     48 };
     49 
     50 typedef android::List<ContainerData*> AsecIdCollection;
     51 
     52 class VolumeManager {
     53 private:
     54     static VolumeManager *sInstance;
     55 
     56 private:
     57     SocketListener        *mBroadcaster;
     58 
     59     VolumeCollection      *mVolumes;
     60     AsecIdCollection      *mActiveContainers;
     61     bool                   mUsbMassStorageEnabled;
     62     bool                   mUsbConnected;
     63     bool                   mDebug;
     64 
     65     // for adjusting /proc/sys/vm/dirty_ratio when UMS is active
     66     int                    mUmsSharingCount;
     67     int                    mSavedDirtyRatio;
     68     int                    mUmsDirtyRatio;
     69 
     70 public:
     71     virtual ~VolumeManager();
     72 
     73     int start();
     74     int stop();
     75 
     76     void handleBlockEvent(NetlinkEvent *evt);
     77     void handleSwitchEvent(NetlinkEvent *evt);
     78     void handleUsbCompositeEvent(NetlinkEvent *evt);
     79 
     80     int addVolume(Volume *v);
     81 
     82     int listVolumes(SocketClient *cli);
     83     int mountVolume(const char *label);
     84     int unmountVolume(const char *label, bool force);
     85     int shareVolume(const char *label, const char *method);
     86     int unshareVolume(const char *label, const char *method);
     87     int shareAvailable(const char *method, bool *avail);
     88     int shareEnabled(const char *path, const char *method, bool *enabled);
     89     int simulate(const char *cmd, const char *arg);
     90     int formatVolume(const char *label);
     91 
     92     /* ASEC */
     93     int createAsec(const char *id, unsigned numSectors, const char *fstype,
     94                    const char *key, int ownerUid);
     95     int finalizeAsec(const char *id);
     96     int destroyAsec(const char *id, bool force);
     97     int mountAsec(const char *id, const char *key, int ownerUid);
     98     int unmountAsec(const char *id, bool force);
     99     int renameAsec(const char *id1, const char *id2);
    100     int getAsecMountPath(const char *id, char *buffer, int maxlen);
    101 
    102     /* Loopback images */
    103     int listMountedObbs(SocketClient* cli);
    104     int mountObb(const char *fileName, const char *key, int ownerUid);
    105     int unmountObb(const char *fileName, bool force);
    106     int getObbMountPath(const char *id, char *buffer, int maxlen);
    107 
    108     /* Shared between ASEC and Loopback images */
    109     int unmountLoopImage(const char *containerId, const char *loopId,
    110             const char *fileName, const char *mountPoint, bool force);
    111 
    112     void setDebug(bool enable);
    113 
    114     // XXX: Post froyo this should be moved and cleaned up
    115     int cleanupAsec(Volume *v, bool force);
    116 
    117     void setBroadcaster(SocketListener *sl) { mBroadcaster = sl; }
    118     SocketListener *getBroadcaster() { return mBroadcaster; }
    119 
    120     static VolumeManager *Instance();
    121 
    122     static char *asecHash(const char *id, char *buffer, size_t len);
    123 
    124 private:
    125     VolumeManager();
    126     void readInitialState();
    127     Volume *lookupVolume(const char *label);
    128     bool isMountpointMounted(const char *mp);
    129 
    130     inline bool massStorageAvailable() const { return mUsbMassStorageEnabled && mUsbConnected; }
    131     void notifyUmsAvailable(bool available);
    132 };
    133 #endif
    134