VolumeManager.h revision 93ecb38daded7583a4a61f4f22519bb7a8a8c154
1f1b736bc5605e92e917ab27f5abf3ba839be2270San Mehat/* 2f1b736bc5605e92e917ab27f5abf3ba839be2270San Mehat * Copyright (C) 2008 The Android Open Source Project 3f1b736bc5605e92e917ab27f5abf3ba839be2270San Mehat * 4f1b736bc5605e92e917ab27f5abf3ba839be2270San Mehat * Licensed under the Apache License, Version 2.0 (the "License"); 5f1b736bc5605e92e917ab27f5abf3ba839be2270San Mehat * you may not use this file except in compliance with the License. 6f1b736bc5605e92e917ab27f5abf3ba839be2270San Mehat * You may obtain a copy of the License at 7f1b736bc5605e92e917ab27f5abf3ba839be2270San Mehat * 8f1b736bc5605e92e917ab27f5abf3ba839be2270San Mehat * http://www.apache.org/licenses/LICENSE-2.0 9f1b736bc5605e92e917ab27f5abf3ba839be2270San Mehat * 10f1b736bc5605e92e917ab27f5abf3ba839be2270San Mehat * Unless required by applicable law or agreed to in writing, software 11f1b736bc5605e92e917ab27f5abf3ba839be2270San Mehat * distributed under the License is distributed on an "AS IS" BASIS, 12f1b736bc5605e92e917ab27f5abf3ba839be2270San Mehat * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13f1b736bc5605e92e917ab27f5abf3ba839be2270San Mehat * See the License for the specific language governing permissions and 14f1b736bc5605e92e917ab27f5abf3ba839be2270San Mehat * limitations under the License. 15f1b736bc5605e92e917ab27f5abf3ba839be2270San Mehat */ 16f1b736bc5605e92e917ab27f5abf3ba839be2270San Mehat 17f1b736bc5605e92e917ab27f5abf3ba839be2270San Mehat#ifndef _VOLUMEMANAGER_H 18f1b736bc5605e92e917ab27f5abf3ba839be2270San Mehat#define _VOLUMEMANAGER_H 19f1b736bc5605e92e917ab27f5abf3ba839be2270San Mehat 20f1b736bc5605e92e917ab27f5abf3ba839be2270San Mehat#include <pthread.h> 21f1b736bc5605e92e917ab27f5abf3ba839be2270San Mehat 2229d8da8cefa99e436c13295d4c9bad060ca18a6dKen Sumrall#ifdef __cplusplus 23f1b736bc5605e92e917ab27f5abf3ba839be2270San Mehat#include <utils/List.h> 24f1b736bc5605e92e917ab27f5abf3ba839be2270San Mehat#include <sysutils/SocketListener.h> 25f1b736bc5605e92e917ab27f5abf3ba839be2270San Mehat 26f1b736bc5605e92e917ab27f5abf3ba839be2270San Mehat#include "Volume.h" 27f1b736bc5605e92e917ab27f5abf3ba839be2270San Mehat 28acc9e7dcca8978fc809fa5b4d9b819c515a980ffKenny Root/* The length of an MD5 hash when encoded into ASCII hex characters */ 29acc9e7dcca8978fc809fa5b4d9b819c515a980ffKenny Root#define MD5_ASCII_LENGTH_PLUS_NULL ((MD5_DIGEST_LENGTH*2)+1) 30acc9e7dcca8978fc809fa5b4d9b819c515a980ffKenny Root 31cbacf78eff70bd43bb899e164ec2ab409bc0904cKenny Roottypedef enum { ASEC, OBB } container_type_t; 32cbacf78eff70bd43bb899e164ec2ab409bc0904cKenny Root 33cbacf78eff70bd43bb899e164ec2ab409bc0904cKenny Rootclass ContainerData { 34cbacf78eff70bd43bb899e164ec2ab409bc0904cKenny Rootpublic: 35cbacf78eff70bd43bb899e164ec2ab409bc0904cKenny Root ContainerData(char* _id, container_type_t _type) 36cbacf78eff70bd43bb899e164ec2ab409bc0904cKenny Root : id(_id) 37cbacf78eff70bd43bb899e164ec2ab409bc0904cKenny Root , type(_type) 38cbacf78eff70bd43bb899e164ec2ab409bc0904cKenny Root {} 39cbacf78eff70bd43bb899e164ec2ab409bc0904cKenny Root 40cbacf78eff70bd43bb899e164ec2ab409bc0904cKenny Root ~ContainerData() { 41cbacf78eff70bd43bb899e164ec2ab409bc0904cKenny Root if (id != NULL) { 42cbacf78eff70bd43bb899e164ec2ab409bc0904cKenny Root free(id); 43cbacf78eff70bd43bb899e164ec2ab409bc0904cKenny Root id = NULL; 44cbacf78eff70bd43bb899e164ec2ab409bc0904cKenny Root } 45cbacf78eff70bd43bb899e164ec2ab409bc0904cKenny Root } 46cbacf78eff70bd43bb899e164ec2ab409bc0904cKenny Root 47cbacf78eff70bd43bb899e164ec2ab409bc0904cKenny Root char *id; 48cbacf78eff70bd43bb899e164ec2ab409bc0904cKenny Root container_type_t type; 49cbacf78eff70bd43bb899e164ec2ab409bc0904cKenny Root}; 50cbacf78eff70bd43bb899e164ec2ab409bc0904cKenny Root 51cbacf78eff70bd43bb899e164ec2ab409bc0904cKenny Roottypedef android::List<ContainerData*> AsecIdCollection; 5288705166ab82057090a070c6d4200c3d9db76f11San Mehat 53f1b736bc5605e92e917ab27f5abf3ba839be2270San Mehatclass VolumeManager { 54f1b736bc5605e92e917ab27f5abf3ba839be2270San Mehatprivate: 55f1b736bc5605e92e917ab27f5abf3ba839be2270San Mehat static VolumeManager *sInstance; 56f1b736bc5605e92e917ab27f5abf3ba839be2270San Mehat 57f1b736bc5605e92e917ab27f5abf3ba839be2270San Mehatprivate: 58f1b736bc5605e92e917ab27f5abf3ba839be2270San Mehat SocketListener *mBroadcaster; 59f1b736bc5605e92e917ab27f5abf3ba839be2270San Mehat 60f1b736bc5605e92e917ab27f5abf3ba839be2270San Mehat VolumeCollection *mVolumes; 6188705166ab82057090a070c6d4200c3d9db76f11San Mehat AsecIdCollection *mActiveContainers; 62d9a4e358614a0c5f60cc76c0636ee4bb02004a32San Mehat bool mDebug; 63f1b736bc5605e92e917ab27f5abf3ba839be2270San Mehat 64a28056b38275003895ff5d9576681aca01544822Mike Lockwood // for adjusting /proc/sys/vm/dirty_ratio when UMS is active 65a28056b38275003895ff5d9576681aca01544822Mike Lockwood int mUmsSharingCount; 66a28056b38275003895ff5d9576681aca01544822Mike Lockwood int mSavedDirtyRatio; 67a28056b38275003895ff5d9576681aca01544822Mike Lockwood int mUmsDirtyRatio; 683b17005083be230509480ea65ae67c237142fadaKen Sumrall int mVolManagerDisabled; 69a28056b38275003895ff5d9576681aca01544822Mike Lockwood 70f1b736bc5605e92e917ab27f5abf3ba839be2270San Mehatpublic: 71f1b736bc5605e92e917ab27f5abf3ba839be2270San Mehat virtual ~VolumeManager(); 72f1b736bc5605e92e917ab27f5abf3ba839be2270San Mehat 73f1b736bc5605e92e917ab27f5abf3ba839be2270San Mehat int start(); 74f1b736bc5605e92e917ab27f5abf3ba839be2270San Mehat int stop(); 75f1b736bc5605e92e917ab27f5abf3ba839be2270San Mehat 76fd7f5875129adfe2845f4f3fffb17db3a89eea25San Mehat void handleBlockEvent(NetlinkEvent *evt); 77f1b736bc5605e92e917ab27f5abf3ba839be2270San Mehat 78f1b736bc5605e92e917ab27f5abf3ba839be2270San Mehat int addVolume(Volume *v); 79f1b736bc5605e92e917ab27f5abf3ba839be2270San Mehat 80f1b736bc5605e92e917ab27f5abf3ba839be2270San Mehat int listVolumes(SocketClient *cli); 8149e2bce5b74129c26a35e25d4693cbfe98c4688eSan Mehat int mountVolume(const char *label); 820b8b59719357fb80c330442787f7d5b1e332263bKen Sumrall int unmountVolume(const char *label, bool force, bool revert); 83a2677e4ad01f250b0765f04adf0acfa6627efc98San Mehat int shareVolume(const char *label, const char *method); 84a2677e4ad01f250b0765f04adf0acfa6627efc98San Mehat int unshareVolume(const char *label, const char *method); 85eba65e9d438a05f1c5dfd0f8d31bc463a5d08eeeSan Mehat int shareEnabled(const char *path, const char *method, bool *enabled); 86a2677e4ad01f250b0765f04adf0acfa6627efc98San Mehat int formatVolume(const char *label); 873b17005083be230509480ea65ae67c237142fadaKen Sumrall void disableVolumeManager(void) { mVolManagerDisabled = 1; } 88fb7c4d5a8a1031cf0e493ff182dcf458e5fe8c77Kenny Root 89fb7c4d5a8a1031cf0e493ff182dcf458e5fe8c77Kenny Root /* ASEC */ 90344ca10856f3d3087a3288ce8f91ad83665d93fbKenny Root int findAsec(const char *id, char *asecPath = NULL, size_t asecPathLen = 0, 91344ca10856f3d3087a3288ce8f91ad83665d93fbKenny Root const char **directory = NULL) const; 928b8f71b1d760411279f3b07a5c97709f052c689eSan Mehat int createAsec(const char *id, unsigned numSectors, const char *fstype, 93344ca10856f3d3087a3288ce8f91ad83665d93fbKenny Root const char *key, const int ownerUid, bool isExternal); 94a19b250bd273455933ca3502cf2c2e0a803aff77San Mehat int finalizeAsec(const char *id); 95344ca10856f3d3087a3288ce8f91ad83665d93fbKenny Root 96344ca10856f3d3087a3288ce8f91ad83665d93fbKenny Root /** 97344ca10856f3d3087a3288ce8f91ad83665d93fbKenny Root * Fixes ASEC permissions on a filesystem that has owners and permissions. 98344ca10856f3d3087a3288ce8f91ad83665d93fbKenny Root * This currently means EXT4-based ASEC containers. 99344ca10856f3d3087a3288ce8f91ad83665d93fbKenny Root * 100344ca10856f3d3087a3288ce8f91ad83665d93fbKenny Root * There is a single file that can be marked as "private" and will not have 101344ca10856f3d3087a3288ce8f91ad83665d93fbKenny Root * world-readable permission. The group for that file will be set to the gid 102344ca10856f3d3087a3288ce8f91ad83665d93fbKenny Root * supplied. 103344ca10856f3d3087a3288ce8f91ad83665d93fbKenny Root * 104344ca10856f3d3087a3288ce8f91ad83665d93fbKenny Root * Returns 0 on success. 105344ca10856f3d3087a3288ce8f91ad83665d93fbKenny Root */ 106344ca10856f3d3087a3288ce8f91ad83665d93fbKenny Root int fixupAsecPermissions(const char *id, gid_t gid, const char* privateFilename); 1074ba8948dc16463053e21cda5744f519a555080d0San Mehat int destroyAsec(const char *id, bool force); 108a19b250bd273455933ca3502cf2c2e0a803aff77San Mehat int mountAsec(const char *id, const char *key, int ownerUid); 1094ba8948dc16463053e21cda5744f519a555080d0San Mehat int unmountAsec(const char *id, bool force); 110048b0801fcd6fcfbb8fa812284c751181e4821b8San Mehat int renameAsec(const char *id1, const char *id2); 111a19b250bd273455933ca3502cf2c2e0a803aff77San Mehat int getAsecMountPath(const char *id, char *buffer, int maxlen); 112736910ca99a40b9add4353bf619e778c40938948Dianne Hackborn int getAsecFilesystemPath(const char *id, char *buffer, int maxlen); 113f1b736bc5605e92e917ab27f5abf3ba839be2270San Mehat 114fb7c4d5a8a1031cf0e493ff182dcf458e5fe8c77Kenny Root /* Loopback images */ 115508c0e1605b795bbb51cb47d955b89f3df26ca94Kenny Root int listMountedObbs(SocketClient* cli); 116508c0e1605b795bbb51cb47d955b89f3df26ca94Kenny Root int mountObb(const char *fileName, const char *key, int ownerUid); 117508c0e1605b795bbb51cb47d955b89f3df26ca94Kenny Root int unmountObb(const char *fileName, bool force); 118508c0e1605b795bbb51cb47d955b89f3df26ca94Kenny Root int getObbMountPath(const char *id, char *buffer, int maxlen); 119fb7c4d5a8a1031cf0e493ff182dcf458e5fe8c77Kenny Root 12093ecb38daded7583a4a61f4f22519bb7a8a8c154Kenny Root Volume* getVolumeForFile(const char *fileName); 12193ecb38daded7583a4a61f4f22519bb7a8a8c154Kenny Root 122fb7c4d5a8a1031cf0e493ff182dcf458e5fe8c77Kenny Root /* Shared between ASEC and Loopback images */ 123fb7c4d5a8a1031cf0e493ff182dcf458e5fe8c77Kenny Root int unmountLoopImage(const char *containerId, const char *loopId, 124fb7c4d5a8a1031cf0e493ff182dcf458e5fe8c77Kenny Root const char *fileName, const char *mountPoint, bool force); 125fb7c4d5a8a1031cf0e493ff182dcf458e5fe8c77Kenny Root 126d9a4e358614a0c5f60cc76c0636ee4bb02004a32San Mehat void setDebug(bool enable); 127d9a4e358614a0c5f60cc76c0636ee4bb02004a32San Mehat 1281a06edaf4db4e9c520624bcc06e0e13ee470d90eSan Mehat // XXX: Post froyo this should be moved and cleaned up 1291a06edaf4db4e9c520624bcc06e0e13ee470d90eSan Mehat int cleanupAsec(Volume *v, bool force); 1300cde53ce7b44ce189d0bc6fa81c0036e096deb51San Mehat 131f1b736bc5605e92e917ab27f5abf3ba839be2270San Mehat void setBroadcaster(SocketListener *sl) { mBroadcaster = sl; } 132f1b736bc5605e92e917ab27f5abf3ba839be2270San Mehat SocketListener *getBroadcaster() { return mBroadcaster; } 133f1b736bc5605e92e917ab27f5abf3ba839be2270San Mehat 134f1b736bc5605e92e917ab27f5abf3ba839be2270San Mehat static VolumeManager *Instance(); 135f1b736bc5605e92e917ab27f5abf3ba839be2270San Mehat 136d9a4e358614a0c5f60cc76c0636ee4bb02004a32San Mehat static char *asecHash(const char *id, char *buffer, size_t len); 1371a06edaf4db4e9c520624bcc06e0e13ee470d90eSan Mehat 13829d8da8cefa99e436c13295d4c9bad060ca18a6dKen Sumrall Volume *lookupVolume(const char *label); 13929d8da8cefa99e436c13295d4c9bad060ca18a6dKen Sumrall int getNumDirectVolumes(void); 14029d8da8cefa99e436c13295d4c9bad060ca18a6dKen Sumrall int getDirectVolumeList(struct volume_info *vol_list); 141425524dba1552ab3d2ad39e205e65d0a2af997f2Ken Sumrall int unmountAllAsecsInDir(const char *directory); 14229d8da8cefa99e436c13295d4c9bad060ca18a6dKen Sumrall 143f1b736bc5605e92e917ab27f5abf3ba839be2270San Mehatprivate: 144f1b736bc5605e92e917ab27f5abf3ba839be2270San Mehat VolumeManager(); 14599635f6c289fe2528c226403ea215c917ce86037Mike Lockwood void readInitialState(); 146a19b250bd273455933ca3502cf2c2e0a803aff77San Mehat bool isMountpointMounted(const char *mp); 147344ca10856f3d3087a3288ce8f91ad83665d93fbKenny Root bool isAsecInDirectory(const char *dir, const char *asec) const; 148f1b736bc5605e92e917ab27f5abf3ba839be2270San Mehat}; 14929d8da8cefa99e436c13295d4c9bad060ca18a6dKen Sumrall 15029d8da8cefa99e436c13295d4c9bad060ca18a6dKen Sumrallextern "C" { 15129d8da8cefa99e436c13295d4c9bad060ca18a6dKen Sumrall#endif /* __cplusplus */ 152319b1043bbbd410aa2d572d88b5936f26072d026Ken Sumrall#define UNMOUNT_NOT_MOUNTED_ERR -2 1533b17005083be230509480ea65ae67c237142fadaKen Sumrall int vold_disableVol(const char *label); 15429d8da8cefa99e436c13295d4c9bad060ca18a6dKen Sumrall int vold_getNumDirectVolumes(void); 15529d8da8cefa99e436c13295d4c9bad060ca18a6dKen Sumrall int vold_getDirectVolumeList(struct volume_info *v); 156425524dba1552ab3d2ad39e205e65d0a2af997f2Ken Sumrall int vold_unmountAllAsecs(void); 15729d8da8cefa99e436c13295d4c9bad060ca18a6dKen Sumrall#ifdef __cplusplus 15829d8da8cefa99e436c13295d4c9bad060ca18a6dKen Sumrall} 15929d8da8cefa99e436c13295d4c9bad060ca18a6dKen Sumrall#endif 16029d8da8cefa99e436c13295d4c9bad060ca18a6dKen Sumrall 161f1b736bc5605e92e917ab27f5abf3ba839be2270San Mehat#endif 162