blob: 77ec7df971617b471477c1d91abc0ab0c890d6c2 [file] [log] [blame]
Jeff Sharkeydeb24052015-03-02 21:01:40 -08001/*
2 * Copyright (C) 2015 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_DISK_H
18#define ANDROID_VOLD_DISK_H
19
20#include "Utils.h"
Jeff Sharkeyc86ab6f2015-06-26 14:02:09 -070021#include "VolumeBase.h"
Jeff Sharkeydeb24052015-03-02 21:01:40 -080022
23#include <utils/Errors.h>
24
25#include <vector>
26
27namespace android {
28namespace vold {
29
30class VolumeBase;
31
Jeff Sharkeydeb24052015-03-02 21:01:40 -080032/*
33 * Representation of detected physical media.
34 *
35 * Knows how to create volumes based on the partition tables found, and also
36 * how to repartition itself.
37 */
38class Disk {
39public:
Jeff Sharkey36801cc2015-03-13 16:09:20 -070040 Disk(const std::string& eventPath, dev_t device, const std::string& nickname, int flags);
Jeff Sharkeydeb24052015-03-02 21:01:40 -080041 virtual ~Disk();
42
Jeff Sharkey36801cc2015-03-13 16:09:20 -070043 enum Flags {
44 /* Flag that disk is adoptable */
45 kAdoptable = 1 << 0,
46 /* Flag that disk is considered primary when the user hasn't
47 * explicitly picked a primary storage location */
48 kDefaultPrimary = 1 << 1,
49 /* Flag that disk is SD card */
50 kSd = 1 << 2,
51 /* Flag that disk is USB disk */
52 kUsb = 1 << 3,
Jeff Sharkey5a6bfca2015-05-14 20:33:55 -070053 /* Flag that disk is EMMC internal */
54 kEmmc = 1 << 4,
Jeff Sharkey36801cc2015-03-13 16:09:20 -070055 };
56
Jeff Sharkeydeb24052015-03-02 21:01:40 -080057 const std::string& getId() { return mId; }
Jeff Sharkey36801cc2015-03-13 16:09:20 -070058 const std::string& getEventPath() { return mEventPath; }
Jeff Sharkeydeb24052015-03-02 21:01:40 -080059 const std::string& getSysPath() { return mSysPath; }
60 const std::string& getDevPath() { return mDevPath; }
61 dev_t getDevice() { return mDevice; }
62 uint64_t getSize() { return mSize; }
63 const std::string& getLabel() { return mLabel; }
Jeff Sharkey36801cc2015-03-13 16:09:20 -070064 int getFlags() { return mFlags; }
Jeff Sharkeydeb24052015-03-02 21:01:40 -080065
66 std::shared_ptr<VolumeBase> findVolume(const std::string& id);
67
Jeff Sharkeyc86ab6f2015-06-26 14:02:09 -070068 void listVolumes(VolumeBase::Type type, std::list<std::string>& list);
69
Jeff Sharkey36801cc2015-03-13 16:09:20 -070070 status_t create();
71 status_t destroy();
72
Jeff Sharkeydeb24052015-03-02 21:01:40 -080073 status_t readMetadata();
74 status_t readPartitions();
75
Jeff Sharkey9c484982015-03-31 10:35:33 -070076 status_t unmountAll();
77
Jeff Sharkeydeb24052015-03-02 21:01:40 -080078 status_t partitionPublic();
79 status_t partitionPrivate();
80 status_t partitionMixed(int8_t ratio);
81
Jeff Sharkeyce6a9132015-04-08 21:07:21 -070082 void notifyEvent(int msg);
83 void notifyEvent(int msg, const std::string& value);
84
Jeff Sharkeydeb24052015-03-02 21:01:40 -080085private:
86 /* ID that uniquely references this disk */
87 std::string mId;
Jeff Sharkey36801cc2015-03-13 16:09:20 -070088 /* Original event path */
89 std::string mEventPath;
Jeff Sharkeydeb24052015-03-02 21:01:40 -080090 /* Device path under sysfs */
91 std::string mSysPath;
92 /* Device path under dev */
93 std::string mDevPath;
94 /* Kernel device representing disk */
95 dev_t mDevice;
96 /* Size of disk, in bytes */
97 uint64_t mSize;
98 /* User-visible label, such as manufacturer */
99 std::string mLabel;
100 /* Current partitions on disk */
Jeff Sharkey36801cc2015-03-13 16:09:20 -0700101 std::vector<std::shared_ptr<VolumeBase>> mVolumes;
102 /* Nickname for this disk */
103 std::string mNickname;
104 /* Flags applicable to this disk */
105 int mFlags;
106 /* Flag indicating object is created */
107 bool mCreated;
Jeff Sharkeyce6a9132015-04-08 21:07:21 -0700108 /* Flag that we just partitioned and should format all volumes */
109 bool mJustPartitioned;
Jeff Sharkey36801cc2015-03-13 16:09:20 -0700110
111 void createPublicVolume(dev_t device);
Jeff Sharkey9c484982015-03-31 10:35:33 -0700112 void createPrivateVolume(dev_t device, const std::string& partGuid);
Jeff Sharkey36801cc2015-03-13 16:09:20 -0700113
114 void destroyAllVolumes();
Jeff Sharkeydeb24052015-03-02 21:01:40 -0800115
116 int getMaxMinors();
117
118 DISALLOW_COPY_AND_ASSIGN(Disk);
119};
120
121} // namespace vold
122} // namespace android
123
124#endif