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 _VOLUME_H
18#define _VOLUME_H
19
20#include <utils/List.h>
21
22class NetlinkEvent;
23class VolumeManager;
24
25class Volume {
26private:
27    int mState;
28
29public:
30    static const int State_Init       = -1;
31    static const int State_NoMedia    = 0;
32    static const int State_Idle       = 1;
33    static const int State_Pending    = 2;
34    static const int State_Checking   = 3;
35    static const int State_Mounted    = 4;
36    static const int State_Unmounting = 5;
37    static const int State_Formatting = 6;
38    static const int State_Shared     = 7;
39    static const int State_SharedMnt  = 8;
40
41    static const char *SECDIR;
42    static const char *SEC_STGDIR;
43    static const char *SEC_STG_SECIMGDIR;
44    static const char *SEC_ASECDIR;
45    static const char *ASECDIR;
46
47    static const char *LOOPDIR;
48
49protected:
50    char *mLabel;
51    char *mMountpoint;
52    VolumeManager *mVm;
53    bool mDebug;
54    int mPartIdx;
55    int mOrigPartIdx;
56    bool mRetryMount;
57
58    /*
59     * The major/minor tuple of the currently mounted filesystem.
60     */
61    dev_t mCurrentlyMountedKdev;
62
63public:
64    Volume(VolumeManager *vm, const char *label, const char *mount_point);
65    virtual ~Volume();
66
67    int mountVol();
68    int unmountVol(bool force, bool revert);
69    int formatVol();
70
71    const char *getLabel() { return mLabel; }
72    const char *getMountpoint() { return mMountpoint; }
73    int getState() { return mState; }
74
75    virtual int handleBlockEvent(NetlinkEvent *evt);
76    virtual dev_t getDiskDevice();
77    virtual dev_t getShareDevice();
78    virtual void handleVolumeShared();
79    virtual void handleVolumeUnshared();
80
81    void setDebug(bool enable);
82    virtual int getVolInfo(struct volume_info *v) = 0;
83
84protected:
85    void setState(int state);
86
87    virtual int getDeviceNodes(dev_t *devs, int max) = 0;
88    virtual int updateDeviceInfo(char *new_path, int new_major, int new_minor) = 0;
89    virtual void revertDeviceInfo(void) = 0;
90    virtual int isDecrypted(void) = 0;
91    virtual int getFlags(void) = 0;
92
93    int createDeviceNode(const char *path, int major, int minor);
94
95private:
96    int initializeMbr(const char *deviceNode);
97    bool isMountpointMounted(const char *path);
98    int createBindMounts();
99    int doUnmount(const char *path, bool force);
100    int doMoveMount(const char *src, const char *dst, bool force);
101    void protectFromAutorunStupidity();
102};
103
104typedef android::List<Volume *> VolumeCollection;
105
106#endif
107