VolumeManager.cpp revision 3bb6020e461e8872e8df0775cba6eb32e06b93ec 
1/*
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#include <stdio.h>
18#include <stdlib.h>
19#include <string.h>
20#include <errno.h>
21#include <fcntl.h>
22#include <sys/stat.h>
23#include <sys/types.h>
24#include <sys/mount.h>
25
26#include <linux/kdev_t.h>
27
28#define LOG_TAG "Vold"
29
30#include <cutils/log.h>
31
32#include <sysutils/NetlinkEvent.h>
33
34#include "VolumeManager.h"
35#include "DirectVolume.h"
36#include "ResponseCode.h"
37#include "Loop.h"
38#include "Fat.h"
39#include "Devmapper.h"
40#include "Process.h"
41
42VolumeManager *VolumeManager::sInstance = NULL;
43
44VolumeManager *VolumeManager::Instance() {
45    if (!sInstance)
46        sInstance = new VolumeManager();
47    return sInstance;
48}
49
50VolumeManager::VolumeManager() {
51    mBlockDevices = new BlockDeviceCollection();
52    mVolumes = new VolumeCollection();
53    mActiveContainers = new AsecIdCollection();
54    mBroadcaster = NULL;
55    mUsbMassStorageConnected = false;
56}
57
58VolumeManager::~VolumeManager() {
59    delete mBlockDevices;
60    delete mVolumes;
61    delete mActiveContainers;
62}
63
64int VolumeManager::start() {
65    return 0;
66}
67
68int VolumeManager::stop() {
69    return 0;
70}
71
72int VolumeManager::addVolume(Volume *v) {
73    mVolumes->push_back(v);
74    return 0;
75}
76
77void VolumeManager::notifyUmsConnected(bool connected) {
78    char msg[255];
79
80    if (connected) {
81        mUsbMassStorageConnected = true;
82    } else {
83        mUsbMassStorageConnected = false;
84    }
85    snprintf(msg, sizeof(msg), "Share method ums now %s",
86             (connected ? "available" : "unavailable"));
87
88    getBroadcaster()->sendBroadcast(ResponseCode::ShareAvailabilityChange,
89                                    msg, false);
90}
91
92void VolumeManager::handleSwitchEvent(NetlinkEvent *evt) {
93    const char *devpath = evt->findParam("DEVPATH");
94    const char *name = evt->findParam("SWITCH_NAME");
95    const char *state = evt->findParam("SWITCH_STATE");
96
97    if (!name || !state) {
98        LOGW("Switch %s event missing name/state info", devpath);
99        return;
100    }
101
102    if (!strcmp(name, "usb_mass_storage")) {
103
104        if (!strcmp(state, "online"))  {
105            notifyUmsConnected(true);
106        } else {
107            notifyUmsConnected(false);
108        }
109    } else {
110        LOGW("Ignoring unknown switch '%s'", name);
111    }
112}
113
114void VolumeManager::handleBlockEvent(NetlinkEvent *evt) {
115    const char *devpath = evt->findParam("DEVPATH");
116
117    /* Lookup a volume to handle this device */
118    VolumeCollection::iterator it;
119    bool hit = false;
120    for (it = mVolumes->begin(); it != mVolumes->end(); ++it) {
121        if (!(*it)->handleBlockEvent(evt)) {
122#ifdef NETLINK_DEBUG
123            LOGD("Device '%s' event handled by volume %s\n", devpath, (*it)->getLabel());
124#endif
125            hit = true;
126            break;
127        }
128    }
129
130    if (!hit) {
131#ifdef NETLINK_DEBUG
132        LOGW("No volumes handled block event for '%s'", devpath);
133#endif
134    }
135}
136
137int VolumeManager::listVolumes(SocketClient *cli) {
138    VolumeCollection::iterator i;
139
140    for (i = mVolumes->begin(); i != mVolumes->end(); ++i) {
141        char *buffer;
142        asprintf(&buffer, "%s %s %d",
143                 (*i)->getLabel(), (*i)->getMountpoint(),
144                 (*i)->getState());
145        cli->sendMsg(ResponseCode::VolumeListResult, buffer, false);
146        free(buffer);
147    }
148    cli->sendMsg(ResponseCode::CommandOkay, "Volumes listed.", false);
149    return 0;
150}
151
152int VolumeManager::formatVolume(const char *label) {
153    Volume *v = lookupVolume(label);
154
155    if (!v) {
156        errno = ENOENT;
157        return -1;
158    }
159
160    return v->formatVol();
161}
162
163int VolumeManager::getAsecMountPath(const char *id, char *buffer, int maxlen) {
164
165    snprintf(buffer, maxlen, "%s/%s", Volume::ASECDIR, id);
166    return 0;
167}
168
169int VolumeManager::createAsec(const char *id, unsigned int numSectors,
170                              const char *fstype, const char *key, int ownerUid) {
171
172    if (numSectors < ((1024*1024)/512)) {
173        LOGE("Invalid container size specified (%d sectors)", numSectors);
174        errno = EINVAL;
175        return -1;
176    }
177
178    if (lookupVolume(id)) {
179        LOGE("ASEC id '%s' currently exists", id);
180        errno = EADDRINUSE;
181        return -1;
182    }
183
184    char asecFileName[255];
185    snprintf(asecFileName, sizeof(asecFileName), "%s/%s.asec", Volume::SEC_ASECDIR, id);
186
187    if (!access(asecFileName, F_OK)) {
188        LOGE("ASEC file '%s' currently exists - destroy it first! (%s)",
189             asecFileName, strerror(errno));
190        errno = EADDRINUSE;
191        return -1;
192    }
193
194    if (Loop::createImageFile(asecFileName, numSectors)) {
195        LOGE("ASEC image file creation failed (%s)", strerror(errno));
196        return -1;
197    }
198
199    char loopDevice[255];
200    if (Loop::create(asecFileName, loopDevice, sizeof(loopDevice))) {
201        LOGE("ASEC loop device creation failed (%s)", strerror(errno));
202        unlink(asecFileName);
203        return -1;
204    }
205
206    char dmDevice[255];
207    bool cleanupDm = false;
208
209    if (strcmp(key, "none")) {
210        if (Devmapper::create(id, loopDevice, key, numSectors, dmDevice,
211                             sizeof(dmDevice))) {
212            LOGE("ASEC device mapping failed (%s)", strerror(errno));
213            Loop::destroyByDevice(loopDevice);
214            unlink(asecFileName);
215            return -1;
216        }
217        cleanupDm = true;
218    } else {
219        strcpy(dmDevice, loopDevice);
220    }
221
222    if (Fat::format(dmDevice)) {
223        LOGE("ASEC FAT format failed (%s)", strerror(errno));
224        if (cleanupDm) {
225            Devmapper::destroy(id);
226        }
227        Loop::destroyByDevice(loopDevice);
228        unlink(asecFileName);
229        return -1;
230    }
231
232    char mountPoint[255];
233
234    snprintf(mountPoint, sizeof(mountPoint), "%s/%s", Volume::ASECDIR, id);
235    if (mkdir(mountPoint, 0777)) {
236        if (errno != EEXIST) {
237            LOGE("Mountpoint creation failed (%s)", strerror(errno));
238            if (cleanupDm) {
239                Devmapper::destroy(id);
240            }
241            Loop::destroyByDevice(loopDevice);
242            unlink(asecFileName);
243            return -1;
244        }
245    }
246
247    if (Fat::doMount(dmDevice, mountPoint, false, false, ownerUid,
248                     0, 0000, false)) {
249//                     0, 0007, false)) {
250        LOGE("ASEC FAT mount failed (%s)", strerror(errno));
251        if (cleanupDm) {
252            Devmapper::destroy(id);
253        }
254        Loop::destroyByDevice(loopDevice);
255        unlink(asecFileName);
256        return -1;
257    }
258
259    mActiveContainers->push_back(strdup(id));
260    return 0;
261}
262
263int VolumeManager::finalizeAsec(const char *id) {
264    char asecFileName[255];
265    char loopDevice[255];
266    char mountPoint[255];
267
268    snprintf(asecFileName, sizeof(asecFileName), "%s/%s.asec", Volume::SEC_ASECDIR, id);
269
270    if (Loop::lookupActive(asecFileName, loopDevice, sizeof(loopDevice))) {
271        LOGE("Unable to finalize %s (%s)", id, strerror(errno));
272        return -1;
273    }
274
275    snprintf(mountPoint, sizeof(mountPoint), "%s/%s", Volume::ASECDIR, id);
276    // XXX:
277    if (Fat::doMount(loopDevice, mountPoint, true, true, 0, 0, 0227, false)) {
278        LOGE("ASEC finalize mount failed (%s)", strerror(errno));
279        return -1;
280    }
281
282    LOGD("ASEC %s finalized", id);
283    return 0;
284}
285
286int VolumeManager::renameAsec(const char *id1, const char *id2) {
287    char *asecFilename1;
288    char *asecFilename2;
289    char mountPoint[255];
290
291    asprintf(&asecFilename1, "%s/%s.asec", Volume::SEC_ASECDIR, id1);
292    asprintf(&asecFilename2, "%s/%s.asec", Volume::SEC_ASECDIR, id2);
293
294    snprintf(mountPoint, sizeof(mountPoint), "%s/%s", Volume::ASECDIR, id1);
295    if (isMountpointMounted(mountPoint)) {
296        LOGW("Rename attempt when src mounted");
297        errno = EBUSY;
298        goto out_err;
299    }
300
301    if (!access(asecFilename2, F_OK)) {
302        LOGE("Rename attempt when dst exists");
303        errno = EADDRINUSE;
304        goto out_err;
305    }
306
307    if (rename(asecFilename1, asecFilename2)) {
308        LOGE("Rename of '%s' to '%s' failed (%s)", asecFilename1, asecFilename2, strerror(errno));
309        goto out_err;
310    }
311
312    free(asecFilename1);
313    free(asecFilename2);
314    return 0;
315
316out_err:
317    free(asecFilename1);
318    free(asecFilename2);
319    return -1;
320}
321
322#define ASEC_UNMOUNT_RETRIES 5
323int VolumeManager::unmountAsec(const char *id, bool force) {
324    char asecFileName[255];
325    char mountPoint[255];
326
327    snprintf(asecFileName, sizeof(asecFileName), "%s/%s.asec", Volume::SEC_ASECDIR, id);
328    snprintf(mountPoint, sizeof(mountPoint), "%s/%s", Volume::ASECDIR, id);
329
330    if (!isMountpointMounted(mountPoint)) {
331        LOGE("Unmount request for ASEC %s when not mounted", id);
332        errno = EINVAL;
333        return -1;
334    }
335
336    int i, rc;
337    for (i = 1; i <= ASEC_UNMOUNT_RETRIES; i++) {
338        rc = umount(mountPoint);
339        if (!rc) {
340            break;
341        }
342        if (rc && (errno == EINVAL || errno == ENOENT)) {
343            rc = 0;
344            break;
345        }
346        LOGW("ASEC %s unmount attempt %d failed (%s)",
347              id, i, strerror(errno));
348
349        int action = 0; // default is to just complain
350
351        if (force) {
352            if (i > (ASEC_UNMOUNT_RETRIES - 2))
353                action = 2; // SIGKILL
354            else if (i > (ASEC_UNMOUNT_RETRIES - 3))
355                action = 1; // SIGHUP
356        }
357
358        Process::killProcessesWithOpenFiles(mountPoint, action);
359        usleep(1000 * 1000);
360    }
361
362    if (rc) {
363        errno = EBUSY;
364        LOGE("Failed to unmount container %s (%s)", id, strerror(errno));
365        return -1;
366    }
367
368    if (rmdir(mountPoint)) {
369        LOGE("Failed to rmdir mountpoint (%s)", strerror(errno));
370    }
371
372    if (Devmapper::destroy(id) && errno != ENXIO) {
373        LOGE("Failed to destroy devmapper instance (%s)", strerror(errno));
374    }
375
376    char loopDevice[255];
377    if (!Loop::lookupActive(asecFileName, loopDevice, sizeof(loopDevice))) {
378        Loop::destroyByDevice(loopDevice);
379    }
380
381    AsecIdCollection::iterator it;
382    for (it = mActiveContainers->begin(); it != mActiveContainers->end(); ++it) {
383        if (!strcmp(*it, id)) {
384            free(*it);
385            mActiveContainers->erase(it);
386            break;
387        }
388    }
389    if (it == mActiveContainers->end()) {
390        LOGW("mActiveContainers is inconsistent!");
391    }
392    return 0;
393}
394
395int VolumeManager::destroyAsec(const char *id, bool force) {
396    char asecFileName[255];
397    char mountPoint[255];
398
399    snprintf(asecFileName, sizeof(asecFileName), "%s/%s.asec", Volume::SEC_ASECDIR, id);
400
401    if (isMountpointMounted(mountPoint)) {
402        LOGD("Unmounting container before destroy");
403        if (unmountAsec(id, force)) {
404            LOGE("Failed to unmount asec %s for destroy (%s)", id, strerror(errno));
405            return -1;
406        }
407    }
408
409    if (unlink(asecFileName)) {
410        LOGE("Failed to unlink asec '%s' (%s)", asecFileName, strerror(errno));
411        return -1;
412    }
413
414    LOGD("ASEC %s destroyed", id);
415    return 0;
416}
417
418int VolumeManager::mountAsec(const char *id, const char *key, int ownerUid) {
419    char asecFileName[255];
420    char mountPoint[255];
421
422    snprintf(asecFileName, sizeof(asecFileName), "%s/%s.asec", Volume::SEC_ASECDIR, id);
423    snprintf(mountPoint, sizeof(mountPoint), "%s/%s", Volume::ASECDIR, id);
424
425    if (isMountpointMounted(mountPoint)) {
426        LOGE("ASEC %s already mounted", id);
427        errno = EBUSY;
428        return -1;
429    }
430
431    char loopDevice[255];
432    if (Loop::lookupActive(asecFileName, loopDevice, sizeof(loopDevice))) {
433        if (Loop::create(asecFileName, loopDevice, sizeof(loopDevice))) {
434            LOGE("ASEC loop device creation failed (%s)", strerror(errno));
435            return -1;
436        }
437        LOGD("New loop device created at %s", loopDevice);
438    } else {
439        LOGD("Found active loopback for %s at %s", asecFileName, loopDevice);
440    }
441
442    char dmDevice[255];
443    bool cleanupDm = false;
444    if (strcmp(key, "none")) {
445        if (Devmapper::lookupActive(id, dmDevice, sizeof(dmDevice))) {
446            unsigned int nr_sec = 0;
447            int fd;
448
449            if ((fd = open(loopDevice, O_RDWR)) < 0) {
450                LOGE("Failed to open loopdevice (%s)", strerror(errno));
451                Loop::destroyByDevice(loopDevice);
452                return -1;
453            }
454
455            if (ioctl(fd, BLKGETSIZE, &nr_sec)) {
456                LOGE("Failed to get loop size (%s)", strerror(errno));
457                Loop::destroyByDevice(loopDevice);
458                close(fd);
459                return -1;
460            }
461            close(fd);
462            if (Devmapper::create(id, loopDevice, key, nr_sec,
463                                  dmDevice, sizeof(dmDevice))) {
464                LOGE("ASEC device mapping failed (%s)", strerror(errno));
465                Loop::destroyByDevice(loopDevice);
466                return -1;
467            }
468            LOGD("New devmapper instance created at %s", dmDevice);
469        } else {
470            LOGD("Found active devmapper for %s at %s", asecFileName, dmDevice);
471        }
472        cleanupDm = true;
473    } else {
474        strcpy(dmDevice, loopDevice);
475    }
476
477    if (mkdir(mountPoint, 0777)) {
478        if (errno != EEXIST) {
479            LOGE("Mountpoint creation failed (%s)", strerror(errno));
480            if (cleanupDm) {
481                Devmapper::destroy(id);
482            }
483            Loop::destroyByDevice(loopDevice);
484            return -1;
485        }
486    }
487
488    if (Fat::doMount(dmDevice, mountPoint, true, false, ownerUid, 0,
489                     0222, false)) {
490//                     0227, false)) {
491        LOGE("ASEC mount failed (%s)", strerror(errno));
492        if (cleanupDm) {
493            Devmapper::destroy(id);
494        }
495        Loop::destroyByDevice(loopDevice);
496        return -1;
497    }
498
499    mActiveContainers->push_back(strdup(id));
500    LOGD("ASEC %s mounted", id);
501    return 0;
502}
503
504int VolumeManager::mountVolume(const char *label) {
505    Volume *v = lookupVolume(label);
506
507    if (!v) {
508        errno = ENOENT;
509        return -1;
510    }
511
512    return v->mountVol();
513}
514
515int VolumeManager::shareAvailable(const char *method, bool *avail) {
516
517    if (strcmp(method, "ums")) {
518        errno = ENOSYS;
519        return -1;
520    }
521
522    if (mUsbMassStorageConnected)
523        *avail = true;
524    else
525        *avail = false;
526    return 0;
527}
528
529int VolumeManager::shareEnabled(const char *label, const char *method, bool *enabled) {
530    Volume *v = lookupVolume(label);
531
532    if (!v) {
533        errno = ENOENT;
534        return -1;
535    }
536
537    if (strcmp(method, "ums")) {
538        errno = ENOSYS;
539        return -1;
540    }
541
542    if (v->getState() != Volume::State_Shared) {
543        *enabled = false;
544    } else {
545        *enabled = true;
546    }
547    return 0;
548}
549
550int VolumeManager::simulate(const char *cmd, const char *arg) {
551
552    if (!strcmp(cmd, "ums")) {
553        if (!strcmp(arg, "connect")) {
554            notifyUmsConnected(true);
555        } else if (!strcmp(arg, "disconnect")) {
556            notifyUmsConnected(false);
557        } else {
558            errno = EINVAL;
559            return -1;
560        }
561    } else {
562        errno = EINVAL;
563        return -1;
564    }
565    return 0;
566}
567
568int VolumeManager::shareVolume(const char *label, const char *method) {
569    Volume *v = lookupVolume(label);
570
571    if (!v) {
572        errno = ENOENT;
573        return -1;
574    }
575
576    /*
577     * Eventually, we'll want to support additional share back-ends,
578     * some of which may work while the media is mounted. For now,
579     * we just support UMS
580     */
581    if (strcmp(method, "ums")) {
582        errno = ENOSYS;
583        return -1;
584    }
585
586    if (v->getState() == Volume::State_NoMedia) {
587        errno = ENODEV;
588        return -1;
589    }
590
591    if (v->getState() != Volume::State_Idle) {
592        // You need to unmount manually befoe sharing
593        errno = EBUSY;
594        return -1;
595    }
596
597    dev_t d = v->getDiskDevice();
598    if ((MAJOR(d) == 0) && (MINOR(d) == 0)) {
599        // This volume does not support raw disk access
600        errno = EINVAL;
601        return -1;
602    }
603
604    int fd;
605    char nodepath[255];
606    snprintf(nodepath,
607             sizeof(nodepath), "/dev/block/vold/%d:%d",
608             MAJOR(d), MINOR(d));
609
610    if ((fd = open("/sys/devices/platform/usb_mass_storage/lun0/file",
611                   O_WRONLY)) < 0) {
612        LOGE("Unable to open ums lunfile (%s)", strerror(errno));
613        return -1;
614    }
615
616    if (write(fd, nodepath, strlen(nodepath)) < 0) {
617        LOGE("Unable to write to ums lunfile (%s)", strerror(errno));
618        close(fd);
619        return -1;
620    }
621
622    close(fd);
623    v->handleVolumeShared();
624    return 0;
625}
626
627int VolumeManager::unshareVolume(const char *label, const char *method) {
628    Volume *v = lookupVolume(label);
629
630    if (!v) {
631        errno = ENOENT;
632        return -1;
633    }
634
635    if (strcmp(method, "ums")) {
636        errno = ENOSYS;
637        return -1;
638    }
639
640    if (v->getState() != Volume::State_Shared) {
641        errno = EINVAL;
642        return -1;
643    }
644
645    dev_t d = v->getDiskDevice();
646
647    int fd;
648    char nodepath[255];
649    snprintf(nodepath,
650             sizeof(nodepath), "/dev/block/vold/%d:%d",
651             MAJOR(d), MINOR(d));
652
653    if ((fd = open("/sys/devices/platform/usb_mass_storage/lun0/file", O_WRONLY)) < 0) {
654        LOGE("Unable to open ums lunfile (%s)", strerror(errno));
655        return -1;
656    }
657
658    char ch = 0;
659    if (write(fd, &ch, 1) < 0) {
660        LOGE("Unable to write to ums lunfile (%s)", strerror(errno));
661        close(fd);
662        return -1;
663    }
664
665    close(fd);
666    v->handleVolumeUnshared();
667    return 0;
668}
669
670int VolumeManager::unmountVolume(const char *label, bool force) {
671    Volume *v = lookupVolume(label);
672
673    if (!v) {
674        errno = ENOENT;
675        return -1;
676    }
677
678    if (v->getState() == Volume::State_NoMedia) {
679        errno = ENODEV;
680        return -1;
681    }
682
683    if (v->getState() != Volume::State_Mounted) {
684        LOGW("Attempt to unmount volume which isn't mounted (%d)\n",
685             v->getState());
686        errno = EBUSY;
687        return -1;
688    }
689
690    while(mActiveContainers->size()) {
691        AsecIdCollection::iterator it = mActiveContainers->begin();
692        LOGI("Unmounting ASEC %s (dependant on %s)", *it, v->getMountpoint());
693        if (unmountAsec(*it, force)) {
694            LOGE("Failed to unmount ASEC %s (%s) - unmount of %s may fail!", *it,
695                 strerror(errno), v->getMountpoint());
696        }
697    }
698
699    return v->unmountVol(force);
700}
701
702/*
703 * Looks up a volume by it's label or mount-point
704 */
705Volume *VolumeManager::lookupVolume(const char *label) {
706    VolumeCollection::iterator i;
707
708    for (i = mVolumes->begin(); i != mVolumes->end(); ++i) {
709        if (label[0] == '/') {
710            if (!strcmp(label, (*i)->getMountpoint()))
711                return (*i);
712        } else {
713            if (!strcmp(label, (*i)->getLabel()))
714                return (*i);
715        }
716    }
717    return NULL;
718}
719
720bool VolumeManager::isMountpointMounted(const char *mp)
721{
722    char device[256];
723    char mount_path[256];
724    char rest[256];
725    FILE *fp;
726    char line[1024];
727
728    if (!(fp = fopen("/proc/mounts", "r"))) {
729        LOGE("Error opening /proc/mounts (%s)", strerror(errno));
730        return false;
731    }
732
733    while(fgets(line, sizeof(line), fp)) {
734        line[strlen(line)-1] = '\0';
735        sscanf(line, "%255s %255s %255s\n", device, mount_path, rest);
736        if (!strcmp(mount_path, mp)) {
737            fclose(fp);
738            return true;
739        }
740
741    }
742
743    fclose(fp);
744    return false;
745}
746
747