• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
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 "StubVolume.h"
21 #include "Utils.h"
22 #include "VolumeBase.h"
23 
24 #include <utils/Errors.h>
25 
26 #include <vector>
27 
28 namespace android {
29 namespace vold {
30 
31 class VolumeBase;
32 
33 /*
34  * Representation of detected physical media.
35  *
36  * Knows how to create volumes based on the partition tables found, and also
37  * how to repartition itself.
38  */
39 class Disk {
40   public:
41     Disk(const std::string& eventPath, dev_t device, const std::string& nickname, int flags);
42     virtual ~Disk();
43 
44     enum Flags {
45         /* Flag that disk is adoptable */
46         kAdoptable = 1 << 0,
47         /* Flag that disk is considered primary when the user hasn't
48          * explicitly picked a primary storage location */
49         kDefaultPrimary = 1 << 1,
50         /* Flag that disk is SD card */
51         kSd = 1 << 2,
52         /* Flag that disk is USB disk */
53         kUsb = 1 << 3,
54         /* Flag that disk is EMMC internal */
55         kEmmc = 1 << 4,
56         /* Flag that disk is Stub disk, i.e., disk that is managed from outside
57          * Android (e.g., ARC++). */
58         kStub = 1 << 5,
59     };
60 
getId()61     const std::string& getId() const { return mId; }
getEventPath()62     const std::string& getEventPath() const { return mEventPath; }
getSysPath()63     const std::string& getSysPath() const { return mSysPath; }
getDevPath()64     const std::string& getDevPath() const { return mDevPath; }
getDevice()65     dev_t getDevice() const { return mDevice; }
getSize()66     uint64_t getSize() const { return mSize; }
getLabel()67     const std::string& getLabel() const { return mLabel; }
getFlags()68     int getFlags() const { return mFlags; }
69 
70     std::shared_ptr<VolumeBase> findVolume(const std::string& id);
71 
72     void listVolumes(VolumeBase::Type type, std::list<std::string>& list) const;
73 
74     std::vector<std::shared_ptr<VolumeBase>> getVolumes() const;
75 
76     status_t create();
77     status_t destroy();
78 
79     status_t readMetadata();
80     status_t readPartitions();
81     void initializePartition(std::shared_ptr<StubVolume> vol);
82 
83     status_t unmountAll();
84 
85     status_t partitionPublic();
86     status_t partitionPrivate();
87     status_t partitionMixed(int8_t ratio);
88 
89   private:
90     /* ID that uniquely references this disk */
91     std::string mId;
92     /* Original event path */
93     std::string mEventPath;
94     /* Device path under sysfs */
95     std::string mSysPath;
96     /* Device path under dev */
97     std::string mDevPath;
98     /* Kernel device representing disk */
99     dev_t mDevice;
100     /* Size of disk, in bytes */
101     uint64_t mSize;
102     /* User-visible label, such as manufacturer */
103     std::string mLabel;
104     /* Current partitions on disk */
105     std::vector<std::shared_ptr<VolumeBase>> mVolumes;
106     /* Nickname for this disk */
107     std::string mNickname;
108     /* Flags applicable to this disk */
109     int mFlags;
110     /* Flag indicating object is created */
111     bool mCreated;
112     /* Flag that we just partitioned and should format all volumes */
113     bool mJustPartitioned;
114 
115     void createPublicVolume(dev_t device);
116     void createPrivateVolume(dev_t device, const std::string& partGuid);
117     void createStubVolume();
118 
119     void destroyAllVolumes();
120 
121     int getMaxMinors();
122 
isStub()123     bool isStub() { return mFlags & kStub; }
124 
125     DISALLOW_COPY_AND_ASSIGN(Disk);
126 };
127 
128 }  // namespace vold
129 }  // namespace android
130 
131 #endif
132