blob: 42b4d65d06da682d1d4bdc22a18de2d85e459227 [file] [log] [blame]
Jeff Sharkeydeb24052015-03-02 21:01:40 -08001/*
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 ANDROID_VOLD_VOLUME_BASE_H
18#define ANDROID_VOLD_VOLUME_BASE_H
19
20#include "Utils.h"
21
Jeff Sharkey36801cc2015-03-13 16:09:20 -070022#include <cutils/multiuser.h>
Jeff Sharkeydeb24052015-03-02 21:01:40 -080023#include <utils/Errors.h>
24
25#include <sys/types.h>
26#include <list>
27#include <string>
28
29namespace android {
30namespace vold {
31
Jeff Sharkeydeb24052015-03-02 21:01:40 -080032/*
33 * Representation of a mounted volume ready for presentation.
34 *
35 * Various subclasses handle the different mounting prerequisites, such as
36 * encryption details, etc. Volumes can also be "stacked" above other
37 * volumes to help communicate dependencies. For example, an ASEC volume
38 * can be stacked on a vfat volume.
39 *
40 * Mounted volumes can be asked to manage bind mounts to present themselves
41 * to specific users on the device.
42 *
43 * When an unmount is requested, the volume recursively unmounts any stacked
44 * volumes and removes any bind mounts before finally unmounting itself.
45 */
46class VolumeBase {
47public:
48 virtual ~VolumeBase();
49
Jeff Sharkey36801cc2015-03-13 16:09:20 -070050 enum class Type {
51 kPublic = 0,
52 kPrivate,
53 kEmulated,
54 kAsec,
55 kObb,
56 };
Jeff Sharkeydeb24052015-03-02 21:01:40 -080057
Jeff Sharkeyf1b996d2015-04-17 17:35:20 -070058 enum MountFlags {
Jeff Sharkey36801cc2015-03-13 16:09:20 -070059 /* Flag that volume is primary external storage */
60 kPrimary = 1 << 0,
61 /* Flag that volume is visible to normal apps */
62 kVisible = 1 << 1,
63 };
64
65 enum class State {
66 kUnmounted = 0,
Jeff Sharkeyf1b996d2015-04-17 17:35:20 -070067 kChecking,
Jeff Sharkey36801cc2015-03-13 16:09:20 -070068 kMounted,
Jeff Sharkeyf1b996d2015-04-17 17:35:20 -070069 kMountedReadOnly,
Jeff Sharkey36801cc2015-03-13 16:09:20 -070070 kFormatting,
Jeff Sharkeyf1b996d2015-04-17 17:35:20 -070071 kEjecting,
Jeff Sharkey0fd95352015-04-04 21:38:59 -070072 kUnmountable,
Jeff Sharkey3161fb32015-04-12 16:03:33 -070073 kRemoved,
Jeff Sharkeyf1b996d2015-04-17 17:35:20 -070074 kBadRemoval,
Jeff Sharkey36801cc2015-03-13 16:09:20 -070075 };
76
77 const std::string& getId() { return mId; }
Jeff Sharkeyf1b996d2015-04-17 17:35:20 -070078 const std::string& getDiskId() { return mDiskId; }
Jeff Sharkey36801cc2015-03-13 16:09:20 -070079 Type getType() { return mType; }
Jeff Sharkeyf1b996d2015-04-17 17:35:20 -070080 int getMountFlags() { return mMountFlags; }
81 userid_t getMountUserId() { return mMountUserId; }
Jeff Sharkey36801cc2015-03-13 16:09:20 -070082 State getState() { return mState; }
83 const std::string& getPath() { return mPath; }
Jeff Sharkey1d6fbcc2015-04-24 16:00:03 -070084 const std::string& getInternalPath() { return mInternalPath; }
Jeff Sharkey36801cc2015-03-13 16:09:20 -070085
Jeff Sharkeyf1b996d2015-04-17 17:35:20 -070086 status_t setDiskId(const std::string& diskId);
87 status_t setMountFlags(int mountFlags);
88 status_t setMountUserId(userid_t mountUserId);
Jeff Sharkeyce6a9132015-04-08 21:07:21 -070089 status_t setSilent(bool silent);
Jeff Sharkey36801cc2015-03-13 16:09:20 -070090
91 void addVolume(const std::shared_ptr<VolumeBase>& volume);
92 void removeVolume(const std::shared_ptr<VolumeBase>& volume);
93
94 std::shared_ptr<VolumeBase> findVolume(const std::string& id);
95
96 status_t create();
97 status_t destroy();
Jeff Sharkeydeb24052015-03-02 21:01:40 -080098 status_t mount();
99 status_t unmount();
Jeff Sharkeyd0640f62015-05-21 22:35:42 -0700100 status_t format(const std::string& fsType);
Jeff Sharkeydeb24052015-03-02 21:01:40 -0800101
102protected:
Jeff Sharkey36801cc2015-03-13 16:09:20 -0700103 explicit VolumeBase(Type type);
Jeff Sharkeydeb24052015-03-02 21:01:40 -0800104
Jeff Sharkey9c484982015-03-31 10:35:33 -0700105 virtual status_t doCreate();
106 virtual status_t doDestroy();
Jeff Sharkeydeb24052015-03-02 21:01:40 -0800107 virtual status_t doMount() = 0;
108 virtual status_t doUnmount() = 0;
Jeff Sharkeyd0640f62015-05-21 22:35:42 -0700109 virtual status_t doFormat(const std::string& fsType);
Jeff Sharkeydeb24052015-03-02 21:01:40 -0800110
Jeff Sharkey36801cc2015-03-13 16:09:20 -0700111 status_t setId(const std::string& id);
112 status_t setPath(const std::string& path);
Jeff Sharkey1d6fbcc2015-04-24 16:00:03 -0700113 status_t setInternalPath(const std::string& internalPath);
Jeff Sharkey36801cc2015-03-13 16:09:20 -0700114
Jeff Sharkeyce6a9132015-04-08 21:07:21 -0700115 void notifyEvent(int msg);
116 void notifyEvent(int msg, const std::string& value);
117
Jeff Sharkeydeb24052015-03-02 21:01:40 -0800118private:
Jeff Sharkey36801cc2015-03-13 16:09:20 -0700119 /* ID that uniquely references volume while alive */
120 std::string mId;
Jeff Sharkeyf1b996d2015-04-17 17:35:20 -0700121 /* ID that uniquely references parent disk while alive */
122 std::string mDiskId;
Jeff Sharkeydeb24052015-03-02 21:01:40 -0800123 /* Volume type */
Jeff Sharkey36801cc2015-03-13 16:09:20 -0700124 Type mType;
Jeff Sharkeyf1b996d2015-04-17 17:35:20 -0700125 /* Flags used when mounting this volume */
126 int mMountFlags;
Jeff Sharkey36801cc2015-03-13 16:09:20 -0700127 /* User that owns this volume, otherwise -1 */
Jeff Sharkeyf1b996d2015-04-17 17:35:20 -0700128 userid_t mMountUserId;
Jeff Sharkey36801cc2015-03-13 16:09:20 -0700129 /* Flag indicating object is created */
130 bool mCreated;
Jeff Sharkeydeb24052015-03-02 21:01:40 -0800131 /* Current state of volume */
Jeff Sharkey36801cc2015-03-13 16:09:20 -0700132 State mState;
133 /* Path to mounted volume */
134 std::string mPath;
Jeff Sharkey1d6fbcc2015-04-24 16:00:03 -0700135 /* Path to internal backing storage */
136 std::string mInternalPath;
Jeff Sharkeyce6a9132015-04-08 21:07:21 -0700137 /* Flag indicating that volume should emit no events */
138 bool mSilent;
Jeff Sharkeydeb24052015-03-02 21:01:40 -0800139
140 /* Volumes stacked on top of this volume */
Jeff Sharkey36801cc2015-03-13 16:09:20 -0700141 std::list<std::shared_ptr<VolumeBase>> mVolumes;
Jeff Sharkeydeb24052015-03-02 21:01:40 -0800142
Jeff Sharkey36801cc2015-03-13 16:09:20 -0700143 void setState(State state);
Jeff Sharkeydeb24052015-03-02 21:01:40 -0800144
145 DISALLOW_COPY_AND_ASSIGN(VolumeBase);
146};
147
148} // namespace vold
149} // namespace android
150
151#endif