VolumeManager.cpp revision 96956ed0e220cb62a4a96136976ded0d8c2d9075 
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    snprintf(mountPoint, sizeof(mountPoint), "%s/%s", Volume::ASECDIR, id2);
302    if (isMountpointMounted(mountPoint)) {
303        LOGW("Rename attempt when dst mounted");
304        errno = EBUSY;
305        goto out_err;
306    }
307
308    if (!access(asecFilename2, F_OK)) {
309        LOGE("Rename attempt when dst exists");
310        errno = EADDRINUSE;
311        goto out_err;
312    }
313
314    if (rename(asecFilename1, asecFilename2)) {
315        LOGE("Rename of '%s' to '%s' failed (%s)", asecFilename1, asecFilename2, strerror(errno));
316        goto out_err;
317    }
318
319    free(asecFilename1);
320    free(asecFilename2);
321    return 0;
322
323out_err:
324    free(asecFilename1);
325    free(asecFilename2);
326    return -1;
327}
328
329#define ASEC_UNMOUNT_RETRIES 5
330int VolumeManager::unmountAsec(const char *id, bool force) {
331    char asecFileName[255];
332    char mountPoint[255];
333
334    snprintf(asecFileName, sizeof(asecFileName), "%s/%s.asec", Volume::SEC_ASECDIR, id);
335    snprintf(mountPoint, sizeof(mountPoint), "%s/%s", Volume::ASECDIR, id);
336
337    if (!isMountpointMounted(mountPoint)) {
338        LOGE("Unmount request for ASEC %s when not mounted", id);
339        errno = EINVAL;
340        return -1;
341    }
342
343    int i, rc;
344    for (i = 1; i <= ASEC_UNMOUNT_RETRIES; i++) {
345        rc = umount(mountPoint);
346        if (!rc) {
347            break;
348        }
349        if (rc && (errno == EINVAL || errno == ENOENT)) {
350            rc = 0;
351            break;
352        }
353        LOGW("ASEC %s unmount attempt %d failed (%s)",
354              id, i, strerror(errno));
355
356        int action = 0; // default is to just complain
357
358        if (force) {
359            if (i > (ASEC_UNMOUNT_RETRIES - 2))
360                action = 2; // SIGKILL
361            else if (i > (ASEC_UNMOUNT_RETRIES - 3))
362                action = 1; // SIGHUP
363        }
364
365        Process::killProcessesWithOpenFiles(mountPoint, action);
366        usleep(1000 * 1000);
367    }
368
369    if (rc) {
370        errno = EBUSY;
371        LOGE("Failed to unmount container %s (%s)", id, strerror(errno));
372        return -1;
373    }
374
375    if (rmdir(mountPoint)) {
376        LOGE("Failed to rmdir mountpoint (%s)", strerror(errno));
377    }
378
379    if (Devmapper::destroy(id) && errno != ENXIO) {
380        LOGE("Failed to destroy devmapper instance (%s)", strerror(errno));
381    }
382
383    char loopDevice[255];
384    if (!Loop::lookupActive(asecFileName, loopDevice, sizeof(loopDevice))) {
385        Loop::destroyByDevice(loopDevice);
386    }
387
388    AsecIdCollection::iterator it;
389    for (it = mActiveContainers->begin(); it != mActiveContainers->end(); ++it) {
390        if (!strcmp(*it, id)) {
391            free(*it);
392            mActiveContainers->erase(it);
393            break;
394        }
395    }
396    if (it == mActiveContainers->end()) {
397        LOGW("mActiveContainers is inconsistent!");
398    }
399    return 0;
400}
401
402int VolumeManager::destroyAsec(const char *id, bool force) {
403    char asecFileName[255];
404    char mountPoint[255];
405
406    snprintf(asecFileName, sizeof(asecFileName), "%s/%s.asec", Volume::SEC_ASECDIR, id);
407
408    if (isMountpointMounted(mountPoint)) {
409        LOGD("Unmounting container before destroy");
410        if (unmountAsec(id, force)) {
411            LOGE("Failed to unmount asec %s for destroy (%s)", id, strerror(errno));
412            return -1;
413        }
414    }
415
416    if (unlink(asecFileName)) {
417        LOGE("Failed to unlink asec '%s' (%s)", asecFileName, strerror(errno));
418        return -1;
419    }
420
421    LOGD("ASEC %s destroyed", id);
422    return 0;
423}
424
425int VolumeManager::mountAsec(const char *id, const char *key, int ownerUid) {
426    char asecFileName[255];
427    char mountPoint[255];
428
429    snprintf(asecFileName, sizeof(asecFileName), "%s/%s.asec", Volume::SEC_ASECDIR, id);
430    snprintf(mountPoint, sizeof(mountPoint), "%s/%s", Volume::ASECDIR, id);
431
432    if (isMountpointMounted(mountPoint)) {
433        LOGE("ASEC %s already mounted", id);
434        errno = EBUSY;
435        return -1;
436    }
437
438    char loopDevice[255];
439    if (Loop::lookupActive(asecFileName, loopDevice, sizeof(loopDevice))) {
440        if (Loop::create(asecFileName, loopDevice, sizeof(loopDevice))) {
441            LOGE("ASEC loop device creation failed (%s)", strerror(errno));
442            return -1;
443        }
444        LOGD("New loop device created at %s", loopDevice);
445    } else {
446        LOGD("Found active loopback for %s at %s", asecFileName, loopDevice);
447    }
448
449    char dmDevice[255];
450    bool cleanupDm = false;
451    if (strcmp(key, "none")) {
452        if (Devmapper::lookupActive(id, dmDevice, sizeof(dmDevice))) {
453            unsigned int nr_sec = 0;
454            int fd;
455
456            if ((fd = open(loopDevice, O_RDWR)) < 0) {
457                LOGE("Failed to open loopdevice (%s)", strerror(errno));
458                Loop::destroyByDevice(loopDevice);
459                return -1;
460            }
461
462            if (ioctl(fd, BLKGETSIZE, &nr_sec)) {
463                LOGE("Failed to get loop size (%s)", strerror(errno));
464                Loop::destroyByDevice(loopDevice);
465                close(fd);
466                return -1;
467            }
468            close(fd);
469            if (Devmapper::create(id, loopDevice, key, nr_sec,
470                                  dmDevice, sizeof(dmDevice))) {
471                LOGE("ASEC device mapping failed (%s)", strerror(errno));
472                Loop::destroyByDevice(loopDevice);
473                return -1;
474            }
475            LOGD("New devmapper instance created at %s", dmDevice);
476        } else {
477            LOGD("Found active devmapper for %s at %s", asecFileName, dmDevice);
478        }
479        cleanupDm = true;
480    } else {
481        strcpy(dmDevice, loopDevice);
482    }
483
484    if (mkdir(mountPoint, 0777)) {
485        if (errno != EEXIST) {
486            LOGE("Mountpoint creation failed (%s)", strerror(errno));
487            if (cleanupDm) {
488                Devmapper::destroy(id);
489            }
490            Loop::destroyByDevice(loopDevice);
491            return -1;
492        }
493    }
494
495    if (Fat::doMount(dmDevice, mountPoint, true, false, ownerUid, 0,
496                     0222, false)) {
497//                     0227, false)) {
498        LOGE("ASEC mount failed (%s)", strerror(errno));
499        if (cleanupDm) {
500            Devmapper::destroy(id);
501        }
502        Loop::destroyByDevice(loopDevice);
503        return -1;
504    }
505
506    mActiveContainers->push_back(strdup(id));
507    LOGD("ASEC %s mounted", id);
508    return 0;
509}
510
511int VolumeManager::mountVolume(const char *label) {
512    Volume *v = lookupVolume(label);
513
514    if (!v) {
515        errno = ENOENT;
516        return -1;
517    }
518
519    return v->mountVol();
520}
521
522int VolumeManager::shareAvailable(const char *method, bool *avail) {
523
524    if (strcmp(method, "ums")) {
525        errno = ENOSYS;
526        return -1;
527    }
528
529    if (mUsbMassStorageConnected)
530        *avail = true;
531    else
532        *avail = false;
533    return 0;
534}
535
536int VolumeManager::shareEnabled(const char *label, const char *method, bool *enabled) {
537    Volume *v = lookupVolume(label);
538
539    if (!v) {
540        errno = ENOENT;
541        return -1;
542    }
543
544    if (strcmp(method, "ums")) {
545        errno = ENOSYS;
546        return -1;
547    }
548
549    if (v->getState() != Volume::State_Shared) {
550        *enabled = false;
551    } else {
552        *enabled = true;
553    }
554    return 0;
555}
556
557int VolumeManager::simulate(const char *cmd, const char *arg) {
558
559    if (!strcmp(cmd, "ums")) {
560        if (!strcmp(arg, "connect")) {
561            notifyUmsConnected(true);
562        } else if (!strcmp(arg, "disconnect")) {
563            notifyUmsConnected(false);
564        } else {
565            errno = EINVAL;
566            return -1;
567        }
568    } else {
569        errno = EINVAL;
570        return -1;
571    }
572    return 0;
573}
574
575int VolumeManager::shareVolume(const char *label, const char *method) {
576    Volume *v = lookupVolume(label);
577
578    if (!v) {
579        errno = ENOENT;
580        return -1;
581    }
582
583    /*
584     * Eventually, we'll want to support additional share back-ends,
585     * some of which may work while the media is mounted. For now,
586     * we just support UMS
587     */
588    if (strcmp(method, "ums")) {
589        errno = ENOSYS;
590        return -1;
591    }
592
593    if (v->getState() == Volume::State_NoMedia) {
594        errno = ENODEV;
595        return -1;
596    }
597
598    if (v->getState() != Volume::State_Idle) {
599        // You need to unmount manually befoe sharing
600        errno = EBUSY;
601        return -1;
602    }
603
604    dev_t d = v->getDiskDevice();
605    if ((MAJOR(d) == 0) && (MINOR(d) == 0)) {
606        // This volume does not support raw disk access
607        errno = EINVAL;
608        return -1;
609    }
610
611    int fd;
612    char nodepath[255];
613    snprintf(nodepath,
614             sizeof(nodepath), "/dev/block/vold/%d:%d",
615             MAJOR(d), MINOR(d));
616
617    if ((fd = open("/sys/devices/platform/usb_mass_storage/lun0/file",
618                   O_WRONLY)) < 0) {
619        LOGE("Unable to open ums lunfile (%s)", strerror(errno));
620        return -1;
621    }
622
623    if (write(fd, nodepath, strlen(nodepath)) < 0) {
624        LOGE("Unable to write to ums lunfile (%s)", strerror(errno));
625        close(fd);
626        return -1;
627    }
628
629    close(fd);
630    v->handleVolumeShared();
631    return 0;
632}
633
634int VolumeManager::unshareVolume(const char *label, const char *method) {
635    Volume *v = lookupVolume(label);
636
637    if (!v) {
638        errno = ENOENT;
639        return -1;
640    }
641
642    if (strcmp(method, "ums")) {
643        errno = ENOSYS;
644        return -1;
645    }
646
647    if (v->getState() != Volume::State_Shared) {
648        errno = EINVAL;
649        return -1;
650    }
651
652    dev_t d = v->getDiskDevice();
653
654    int fd;
655    char nodepath[255];
656    snprintf(nodepath,
657             sizeof(nodepath), "/dev/block/vold/%d:%d",
658             MAJOR(d), MINOR(d));
659
660    if ((fd = open("/sys/devices/platform/usb_mass_storage/lun0/file", O_WRONLY)) < 0) {
661        LOGE("Unable to open ums lunfile (%s)", strerror(errno));
662        return -1;
663    }
664
665    char ch = 0;
666    if (write(fd, &ch, 1) < 0) {
667        LOGE("Unable to write to ums lunfile (%s)", strerror(errno));
668        close(fd);
669        return -1;
670    }
671
672    close(fd);
673    v->handleVolumeUnshared();
674    return 0;
675}
676
677int VolumeManager::unmountVolume(const char *label, bool force) {
678    Volume *v = lookupVolume(label);
679
680    if (!v) {
681        errno = ENOENT;
682        return -1;
683    }
684
685    if (v->getState() == Volume::State_NoMedia) {
686        errno = ENODEV;
687        return -1;
688    }
689
690    if (v->getState() != Volume::State_Mounted) {
691        LOGW("Attempt to unmount volume which isn't mounted (%d)\n",
692             v->getState());
693        errno = EBUSY;
694        return -1;
695    }
696
697    while(mActiveContainers->size()) {
698        AsecIdCollection::iterator it = mActiveContainers->begin();
699        LOGI("Unmounting ASEC %s (dependant on %s)", *it, v->getMountpoint());
700        if (unmountAsec(*it, force)) {
701            LOGE("Failed to unmount ASEC %s (%s)", *it, strerror(errno), v->getMountpoint());
702            return -1;
703        }
704    }
705
706    return v->unmountVol(force);
707}
708
709/*
710 * Looks up a volume by it's label or mount-point
711 */
712Volume *VolumeManager::lookupVolume(const char *label) {
713    VolumeCollection::iterator i;
714
715    for (i = mVolumes->begin(); i != mVolumes->end(); ++i) {
716        if (label[0] == '/') {
717            if (!strcmp(label, (*i)->getMountpoint()))
718                return (*i);
719        } else {
720            if (!strcmp(label, (*i)->getLabel()))
721                return (*i);
722        }
723    }
724    return NULL;
725}
726
727bool VolumeManager::isMountpointMounted(const char *mp)
728{
729    char device[256];
730    char mount_path[256];
731    char rest[256];
732    FILE *fp;
733    char line[1024];
734
735    if (!(fp = fopen("/proc/mounts", "r"))) {
736        LOGE("Error opening /proc/mounts (%s)", strerror(errno));
737        return false;
738    }
739
740    while(fgets(line, sizeof(line), fp)) {
741        line[strlen(line)-1] = '\0';
742        sscanf(line, "%255s %255s %255s\n", device, mount_path, rest);
743        if (!strcmp(mount_path, mp)) {
744            fclose(fp);
745            return true;
746        }
747
748    }
749
750    fclose(fp);
751    return false;
752}
753
754