blob: 9d69d6ab3ce48f4f067002f5d881c6aa8126ff0b [file] [log] [blame]
San Mehatf1b736b2009-10-10 17:22:08 -07001/*
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
Ken Sumrall29d8da82011-05-18 17:20:07 -070022#ifdef __cplusplus
San Mehatf1b736b2009-10-10 17:22:08 -070023#include <utils/List.h>
24#include <sysutils/SocketListener.h>
25
San Mehatf1b736b2009-10-10 17:22:08 -070026#include "Volume.h"
27
Kenny Rootacc9e7d2010-06-18 19:06:50 -070028/* 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
Kenny Rootcbacf782010-09-24 15:11:48 -070031typedef 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;
San Mehat88705162010-01-15 09:26:28 -080052
San Mehatf1b736b2009-10-10 17:22:08 -070053class VolumeManager {
54private:
55 static VolumeManager *sInstance;
56
57private:
58 SocketListener *mBroadcaster;
San Mehatf1b736b2009-10-10 17:22:08 -070059
60 VolumeCollection *mVolumes;
San Mehat88705162010-01-15 09:26:28 -080061 AsecIdCollection *mActiveContainers;
San Mehatd9a4e352010-03-12 13:32:47 -080062 bool mDebug;
San Mehatf1b736b2009-10-10 17:22:08 -070063
Mike Lockwooda28056b2010-10-28 15:21:24 -040064 // for adjusting /proc/sys/vm/dirty_ratio when UMS is active
65 int mUmsSharingCount;
66 int mSavedDirtyRatio;
67 int mUmsDirtyRatio;
Ken Sumrall3b170052011-07-11 15:38:57 -070068 int mVolManagerDisabled;
Mike Lockwooda28056b2010-10-28 15:21:24 -040069
San Mehatf1b736b2009-10-10 17:22:08 -070070public:
71 virtual ~VolumeManager();
72
73 int start();
74 int stop();
75
San Mehatfd7f5872009-10-12 11:32:47 -070076 void handleBlockEvent(NetlinkEvent *evt);
San Mehatf1b736b2009-10-10 17:22:08 -070077
78 int addVolume(Volume *v);
79
80 int listVolumes(SocketClient *cli);
San Mehat49e2bce2009-10-12 16:29:01 -070081 int mountVolume(const char *label);
Ken Sumrall0b8b5972011-08-31 16:14:23 -070082 int unmountVolume(const char *label, bool force, bool revert);
San Mehata2677e42009-12-13 10:40:18 -080083 int shareVolume(const char *label, const char *method);
84 int unshareVolume(const char *label, const char *method);
San Mehateba65e92010-01-29 05:15:16 -080085 int shareEnabled(const char *path, const char *method, bool *enabled);
Ken Sumrall9caab762013-06-11 19:10:20 -070086 int formatVolume(const char *label, bool wipe);
Ken Sumrall3b170052011-07-11 15:38:57 -070087 void disableVolumeManager(void) { mVolManagerDisabled = 1; }
Kenny Rootfb7c4d52010-06-30 18:48:41 -070088
89 /* ASEC */
Kenny Root344ca102012-04-03 17:23:01 -070090 int findAsec(const char *id, char *asecPath = NULL, size_t asecPathLen = 0,
91 const char **directory = NULL) const;
San Mehat8b8f71b2010-01-11 09:17:25 -080092 int createAsec(const char *id, unsigned numSectors, const char *fstype,
Kenny Root344ca102012-04-03 17:23:01 -070093 const char *key, const int ownerUid, bool isExternal);
San Mehata19b2502010-01-06 10:33:53 -080094 int finalizeAsec(const char *id);
Kenny Root344ca102012-04-03 17:23:01 -070095
96 /**
97 * Fixes ASEC permissions on a filesystem that has owners and permissions.
98 * This currently means EXT4-based ASEC containers.
99 *
100 * There is a single file that can be marked as "private" and will not have
101 * world-readable permission. The group for that file will be set to the gid
102 * supplied.
103 *
104 * Returns 0 on success.
105 */
106 int fixupAsecPermissions(const char *id, gid_t gid, const char* privateFilename);
San Mehat4ba89482010-02-18 09:00:18 -0800107 int destroyAsec(const char *id, bool force);
San Mehata19b2502010-01-06 10:33:53 -0800108 int mountAsec(const char *id, const char *key, int ownerUid);
San Mehat4ba89482010-02-18 09:00:18 -0800109 int unmountAsec(const char *id, bool force);
San Mehat048b0802010-01-23 08:17:06 -0800110 int renameAsec(const char *id1, const char *id2);
San Mehata19b2502010-01-06 10:33:53 -0800111 int getAsecMountPath(const char *id, char *buffer, int maxlen);
Dianne Hackborn736910c2011-06-27 13:37:07 -0700112 int getAsecFilesystemPath(const char *id, char *buffer, int maxlen);
San Mehatf1b736b2009-10-10 17:22:08 -0700113
Kenny Rootfb7c4d52010-06-30 18:48:41 -0700114 /* Loopback images */
Kenny Root508c0e12010-07-12 09:59:49 -0700115 int listMountedObbs(SocketClient* cli);
116 int mountObb(const char *fileName, const char *key, int ownerUid);
117 int unmountObb(const char *fileName, bool force);
118 int getObbMountPath(const char *id, char *buffer, int maxlen);
Kenny Rootfb7c4d52010-06-30 18:48:41 -0700119
Kenny Root93ecb382012-08-09 11:28:37 -0700120 Volume* getVolumeForFile(const char *fileName);
121
Kenny Rootfb7c4d52010-06-30 18:48:41 -0700122 /* Shared between ASEC and Loopback images */
123 int unmountLoopImage(const char *containerId, const char *loopId,
124 const char *fileName, const char *mountPoint, bool force);
125
San Mehatd9a4e352010-03-12 13:32:47 -0800126 void setDebug(bool enable);
127
San Mehat1a06eda2010-04-15 12:58:50 -0700128 // XXX: Post froyo this should be moved and cleaned up
129 int cleanupAsec(Volume *v, bool force);
San Mehat0cde53c2009-12-22 08:32:33 -0800130
San Mehatf1b736b2009-10-10 17:22:08 -0700131 void setBroadcaster(SocketListener *sl) { mBroadcaster = sl; }
132 SocketListener *getBroadcaster() { return mBroadcaster; }
133
134 static VolumeManager *Instance();
135
San Mehatd9a4e352010-03-12 13:32:47 -0800136 static char *asecHash(const char *id, char *buffer, size_t len);
San Mehat1a06eda2010-04-15 12:58:50 -0700137
Ken Sumrall29d8da82011-05-18 17:20:07 -0700138 Volume *lookupVolume(const char *label);
139 int getNumDirectVolumes(void);
140 int getDirectVolumeList(struct volume_info *vol_list);
Ken Sumrall425524d2012-06-14 20:55:28 -0700141 int unmountAllAsecsInDir(const char *directory);
Ken Sumrall29d8da82011-05-18 17:20:07 -0700142
Jeff Sharkey71ebe152013-09-17 17:24:38 -0700143 /*
144 * Ensure that all directories along given path exist, creating parent
145 * directories as needed. Validates that given path is absolute and that
146 * it contains no relative "." or ".." paths or symlinks. Last path segment
147 * is treated as filename and ignored, unless the path ends with "/". Also
148 * ensures that path belongs to a volume managed by vold.
149 */
150 int mkdirs(char* path);
151
San Mehatf1b736b2009-10-10 17:22:08 -0700152private:
153 VolumeManager();
Mike Lockwood99635f62010-06-25 23:04:04 -0400154 void readInitialState();
San Mehata19b2502010-01-06 10:33:53 -0800155 bool isMountpointMounted(const char *mp);
Kenny Root344ca102012-04-03 17:23:01 -0700156 bool isAsecInDirectory(const char *dir, const char *asec) const;
San Mehatf1b736b2009-10-10 17:22:08 -0700157};
Ken Sumrall29d8da82011-05-18 17:20:07 -0700158
159extern "C" {
160#endif /* __cplusplus */
Ken Sumrall319b1042011-06-14 14:01:55 -0700161#define UNMOUNT_NOT_MOUNTED_ERR -2
Ken Sumrall3b170052011-07-11 15:38:57 -0700162 int vold_disableVol(const char *label);
Ken Sumrall29d8da82011-05-18 17:20:07 -0700163 int vold_getNumDirectVolumes(void);
164 int vold_getDirectVolumeList(struct volume_info *v);
Ken Sumrall425524d2012-06-14 20:55:28 -0700165 int vold_unmountAllAsecs(void);
Ken Sumrall29d8da82011-05-18 17:20:07 -0700166#ifdef __cplusplus
167}
168#endif
169
San Mehatf1b736b2009-10-10 17:22:08 -0700170#endif