VolumeManager.h revision a976656ff90291b9437a4d37b48e82abcd48195e 
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
31typedef enum { ASEC, OBB } container_type_t;
32
33class ContainerData {
34public:
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
51typedef android::List<ContainerData*> AsecIdCollection;
52
53class VolumeManager {
54private:
55    static VolumeManager *sInstance;
56
57private:
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
69public:
70    virtual ~VolumeManager();
71
72    int start();
73    int stop();
74
75    void handleBlockEvent(NetlinkEvent *evt);
76
77    int addVolume(Volume *v);
78
79    int listVolumes(SocketClient *cli);
80    int mountVolume(const char *label);
81    int unmountVolume(const char *label, bool force);
82    int shareVolume(const char *label, const char *method);
83    int unshareVolume(const char *label, const char *method);
84    int shareEnabled(const char *path, const char *method, bool *enabled);
85    int formatVolume(const char *label);
86
87    /* ASEC */
88    int createAsec(const char *id, unsigned numSectors, const char *fstype,
89                   const char *key, int ownerUid);
90    int finalizeAsec(const char *id);
91    int destroyAsec(const char *id, bool force);
92    int mountAsec(const char *id, const char *key, int ownerUid);
93    int unmountAsec(const char *id, bool force);
94    int renameAsec(const char *id1, const char *id2);
95    int getAsecMountPath(const char *id, char *buffer, int maxlen);
96
97    /* Loopback images */
98    int listMountedObbs(SocketClient* cli);
99    int mountObb(const char *fileName, const char *key, int ownerUid);
100    int unmountObb(const char *fileName, bool force);
101    int getObbMountPath(const char *id, char *buffer, int maxlen);
102
103    /* Shared between ASEC and Loopback images */
104    int unmountLoopImage(const char *containerId, const char *loopId,
105            const char *fileName, const char *mountPoint, bool force);
106
107    void setDebug(bool enable);
108
109    // XXX: Post froyo this should be moved and cleaned up
110    int cleanupAsec(Volume *v, bool force);
111
112    void setBroadcaster(SocketListener *sl) { mBroadcaster = sl; }
113    SocketListener *getBroadcaster() { return mBroadcaster; }
114
115    static VolumeManager *Instance();
116
117    static char *asecHash(const char *id, char *buffer, size_t len);
118
119    Volume *lookupVolume(const char *label);
120    int getNumDirectVolumes(void);
121    int getDirectVolumeList(struct volume_info *vol_list);
122
123private:
124    VolumeManager();
125    void readInitialState();
126    bool isMountpointMounted(const char *mp);
127};
128
129extern "C" {
130#endif /* __cplusplus */
131    int vold_unmountVol(const char *label);
132    int vold_getNumDirectVolumes(void);
133    int vold_getDirectVolumeList(struct volume_info *v);
134#ifdef __cplusplus
135}
136#endif
137
138#endif
139