VolumeManager.h revision 508c0e1605b795bbb51cb47d955b89f3df26ca94 
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
30typedef android::List<char *> AsecIdCollection;
31
32class VolumeManager {
33private:
34    static VolumeManager *sInstance;
35
36private:
37    SocketListener        *mBroadcaster;
38
39    VolumeCollection      *mVolumes;
40    AsecIdCollection      *mActiveContainers;
41    bool                   mUsbMassStorageEnabled;
42    bool                   mUsbConnected;
43    bool                   mDebug;
44
45public:
46    virtual ~VolumeManager();
47
48    int start();
49    int stop();
50
51    void handleBlockEvent(NetlinkEvent *evt);
52    void handleSwitchEvent(NetlinkEvent *evt);
53    void handleUsbCompositeEvent(NetlinkEvent *evt);
54
55    int addVolume(Volume *v);
56
57    int listVolumes(SocketClient *cli);
58    int mountVolume(const char *label);
59    int unmountVolume(const char *label, bool force);
60    int shareVolume(const char *label, const char *method);
61    int unshareVolume(const char *label, const char *method);
62    int shareAvailable(const char *method, bool *avail);
63    int shareEnabled(const char *path, const char *method, bool *enabled);
64    int simulate(const char *cmd, const char *arg);
65    int formatVolume(const char *label);
66
67    /* ASEC */
68    int createAsec(const char *id, unsigned numSectors, const char *fstype,
69                   const char *key, int ownerUid);
70    int finalizeAsec(const char *id);
71    int destroyAsec(const char *id, bool force);
72    int mountAsec(const char *id, const char *key, int ownerUid);
73    int unmountAsec(const char *id, bool force);
74    int renameAsec(const char *id1, const char *id2);
75    int getAsecMountPath(const char *id, char *buffer, int maxlen);
76
77    /* Loopback images */
78    int listMountedObbs(SocketClient* cli);
79    int mountObb(const char *fileName, const char *key, int ownerUid);
80    int unmountObb(const char *fileName, bool force);
81    int getObbMountPath(const char *id, char *buffer, int maxlen);
82
83    /* Shared between ASEC and Loopback images */
84    int unmountLoopImage(const char *containerId, const char *loopId,
85            const char *fileName, const char *mountPoint, bool force);
86
87    void setDebug(bool enable);
88
89    // XXX: Post froyo this should be moved and cleaned up
90    int cleanupAsec(Volume *v, bool force);
91
92    void setBroadcaster(SocketListener *sl) { mBroadcaster = sl; }
93    SocketListener *getBroadcaster() { return mBroadcaster; }
94
95    static VolumeManager *Instance();
96
97    static char *asecHash(const char *id, char *buffer, size_t len);
98
99private:
100    VolumeManager();
101    void readInitialState();
102    Volume *lookupVolume(const char *label);
103    bool isMountpointMounted(const char *mp);
104
105    inline bool massStorageAvailable() const { return mUsbMassStorageEnabled && mUsbConnected; }
106    void notifyUmsAvailable(bool available);
107};
108#endif
109