CommandListener.cpp revision b5e680ac377619286d4b8566a3b736fcf0ee7bb0 
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 <stdlib.h>
18#include <sys/socket.h>
19#include <sys/types.h>
20#include <netinet/in.h>
21#include <arpa/inet.h>
22#include <dirent.h>
23#include <errno.h>
24#include <fcntl.h>
25#include <fs_mgr.h>
26#include <stdio.h>
27#include <string.h>
28#include <stdint.h>
29#include <inttypes.h>
30
31#define LOG_TAG "VoldCmdListener"
32
33#include <base/stringprintf.h>
34#include <cutils/fs.h>
35#include <cutils/log.h>
36
37#include <sysutils/SocketClient.h>
38#include <private/android_filesystem_config.h>
39
40#include "CommandListener.h"
41#include "VolumeManager.h"
42#include "VolumeBase.h"
43#include "ResponseCode.h"
44#include "Process.h"
45#include "Loop.h"
46#include "Devmapper.h"
47#include "Ext4Crypt.h"
48#include "cryptfs.h"
49#include "fstrim.h"
50#include "MoveTask.h"
51
52#define DUMP_ARGS 0
53
54CommandListener::CommandListener() :
55                 FrameworkListener("vold", true) {
56    registerCmd(new DumpCmd());
57    registerCmd(new VolumeCmd());
58    registerCmd(new AsecCmd());
59    registerCmd(new ObbCmd());
60    registerCmd(new StorageCmd());
61    registerCmd(new FstrimCmd());
62}
63
64#if DUMP_ARGS
65void CommandListener::dumpArgs(int argc, char **argv, int argObscure) {
66    char buffer[4096];
67    char *p = buffer;
68
69    memset(buffer, 0, sizeof(buffer));
70    int i;
71    for (i = 0; i < argc; i++) {
72        unsigned int len = strlen(argv[i]) + 1; // Account for space
73        if (i == argObscure) {
74            len += 2; // Account for {}
75        }
76        if (((p - buffer) + len) < (sizeof(buffer)-1)) {
77            if (i == argObscure) {
78                *p++ = '{';
79                *p++ = '}';
80                *p++ = ' ';
81                continue;
82            }
83            strcpy(p, argv[i]);
84            p+= strlen(argv[i]);
85            if (i != (argc -1)) {
86                *p++ = ' ';
87            }
88        }
89    }
90    SLOGD("%s", buffer);
91}
92#else
93void CommandListener::dumpArgs(int /*argc*/, char ** /*argv*/, int /*argObscure*/) { }
94#endif
95
96int CommandListener::sendGenericOkFail(SocketClient *cli, int cond) {
97    if (!cond) {
98        return cli->sendMsg(ResponseCode::CommandOkay, "Command succeeded", false);
99    } else {
100        return cli->sendMsg(ResponseCode::OperationFailed, "Command failed", false);
101    }
102}
103
104CommandListener::DumpCmd::DumpCmd() :
105                 VoldCommand("dump") {
106}
107
108int CommandListener::DumpCmd::runCommand(SocketClient *cli,
109                                         int /*argc*/, char ** /*argv*/) {
110    cli->sendMsg(0, "Dumping loop status", false);
111    if (Loop::dumpState(cli)) {
112        cli->sendMsg(ResponseCode::CommandOkay, "Loop dump failed", true);
113    }
114    cli->sendMsg(0, "Dumping DM status", false);
115    if (Devmapper::dumpState(cli)) {
116        cli->sendMsg(ResponseCode::CommandOkay, "Devmapper dump failed", true);
117    }
118    cli->sendMsg(0, "Dumping mounted filesystems", false);
119    FILE *fp = fopen("/proc/mounts", "r");
120    if (fp) {
121        char line[1024];
122        while (fgets(line, sizeof(line), fp)) {
123            line[strlen(line)-1] = '\0';
124            cli->sendMsg(0, line, false);;
125        }
126        fclose(fp);
127    }
128
129    cli->sendMsg(ResponseCode::CommandOkay, "dump complete", false);
130    return 0;
131}
132
133CommandListener::VolumeCmd::VolumeCmd() :
134                 VoldCommand("volume") {
135}
136
137int CommandListener::VolumeCmd::runCommand(SocketClient *cli,
138                                           int argc, char **argv) {
139    dumpArgs(argc, argv, -1);
140
141    if (argc < 2) {
142        cli->sendMsg(ResponseCode::CommandSyntaxError, "Missing Argument", false);
143        return 0;
144    }
145
146    VolumeManager *vm = VolumeManager::Instance();
147    std::lock_guard<std::mutex> lock(vm->getLock());
148
149    // TODO: tease out methods not directly related to volumes
150
151    std::string cmd(argv[1]);
152    if (cmd == "reset") {
153        return sendGenericOkFail(cli, vm->reset());
154
155    } else if (cmd == "shutdown") {
156        return sendGenericOkFail(cli, vm->shutdown());
157
158    } else if (cmd == "debug") {
159        return sendGenericOkFail(cli, vm->setDebug(true));
160
161    } else if (cmd == "partition" && argc > 3) {
162        // partition [diskId] [public|private|mixed] [ratio]
163        std::string id(argv[2]);
164        auto disk = vm->findDisk(id);
165        if (disk == nullptr) {
166            return cli->sendMsg(ResponseCode::CommandSyntaxError, "Unknown disk", false);
167        }
168
169        std::string type(argv[3]);
170        if (type == "public") {
171            return sendGenericOkFail(cli, disk->partitionPublic());
172        } else if (type == "private") {
173            return sendGenericOkFail(cli, disk->partitionPrivate());
174        } else if (type == "mixed") {
175            if (argc < 4) {
176                return cli->sendMsg(ResponseCode::CommandSyntaxError, nullptr, false);
177            }
178            int frac = atoi(argv[4]);
179            return sendGenericOkFail(cli, disk->partitionMixed(frac));
180        } else {
181            return cli->sendMsg(ResponseCode::CommandSyntaxError, nullptr, false);
182        }
183
184    } else if (cmd == "mkdirs" && argc > 2) {
185        // mkdirs [path]
186        return sendGenericOkFail(cli, vm->mkdirs(argv[2]));
187
188    } else if (cmd == "user_added" && argc > 3) {
189        // user_added [user] [serial]
190        return sendGenericOkFail(cli, vm->onUserAdded(atoi(argv[2]), atoi(argv[3])));
191
192    } else if (cmd == "user_removed" && argc > 2) {
193        // user_removed [user]
194        return sendGenericOkFail(cli, vm->onUserRemoved(atoi(argv[2])));
195
196    } else if (cmd == "user_started" && argc > 2) {
197        // user_started [user]
198        return sendGenericOkFail(cli, vm->onUserStarted(atoi(argv[2])));
199
200    } else if (cmd == "user_stopped" && argc > 2) {
201        // user_stopped [user]
202        return sendGenericOkFail(cli, vm->onUserStopped(atoi(argv[2])));
203
204    } else if (cmd == "mount" && argc > 2) {
205        // mount [volId] [flags] [user]
206        std::string id(argv[2]);
207        auto vol = vm->findVolume(id);
208        if (vol == nullptr) {
209            return cli->sendMsg(ResponseCode::CommandSyntaxError, "Unknown volume", false);
210        }
211
212        int mountFlags = (argc > 3) ? atoi(argv[3]) : 0;
213        userid_t mountUserId = (argc > 4) ? atoi(argv[4]) : -1;
214
215        vol->setMountFlags(mountFlags);
216        vol->setMountUserId(mountUserId);
217
218        int res = vol->mount();
219        if (mountFlags & android::vold::VolumeBase::MountFlags::kPrimary) {
220            vm->setPrimary(vol);
221        }
222        return sendGenericOkFail(cli, res);
223
224    } else if (cmd == "unmount" && argc > 2) {
225        // unmount [volId]
226        std::string id(argv[2]);
227        auto vol = vm->findVolume(id);
228        if (vol == nullptr) {
229            return cli->sendMsg(ResponseCode::CommandSyntaxError, "Unknown volume", false);
230        }
231
232        return sendGenericOkFail(cli, vol->unmount());
233
234    } else if (cmd == "format" && argc > 3) {
235        // format [volId] [fsType|auto]
236        std::string id(argv[2]);
237        std::string fsType(argv[3]);
238        auto vol = vm->findVolume(id);
239        if (vol == nullptr) {
240            return cli->sendMsg(ResponseCode::CommandSyntaxError, "Unknown volume", false);
241        }
242
243        return sendGenericOkFail(cli, vol->format(fsType));
244
245    } else if (cmd == "move_storage" && argc > 3) {
246        // move_storage [fromVolId] [toVolId]
247        auto fromVol = vm->findVolume(std::string(argv[2]));
248        auto toVol = vm->findVolume(std::string(argv[3]));
249        if (fromVol == nullptr || toVol == nullptr) {
250            return cli->sendMsg(ResponseCode::CommandSyntaxError, "Unknown volume", false);
251        }
252
253        (new android::vold::MoveTask(fromVol, toVol))->start();
254        return sendGenericOkFail(cli, 0);
255
256    } else if (cmd == "benchmark" && argc > 2) {
257        // benchmark [volId]
258        std::string id(argv[2]);
259        nsecs_t res = vm->benchmarkVolume(id);
260        return cli->sendMsg(ResponseCode::CommandOkay,
261                android::base::StringPrintf("%" PRId64, res).c_str(), false);
262
263    } else if (cmd == "forget_partition" && argc > 2) {
264        // forget_partition [partGuid]
265        std::string partGuid(argv[2]);
266        return sendGenericOkFail(cli, vm->forgetPartition(partGuid));
267    }
268
269    return cli->sendMsg(ResponseCode::CommandSyntaxError, nullptr, false);
270}
271
272CommandListener::StorageCmd::StorageCmd() :
273                 VoldCommand("storage") {
274}
275
276int CommandListener::StorageCmd::runCommand(SocketClient *cli,
277                                                      int argc, char **argv) {
278    /* Guarantied to be initialized by vold's main() before the CommandListener is active */
279    extern struct fstab *fstab;
280
281    dumpArgs(argc, argv, -1);
282
283    if (argc < 2) {
284        cli->sendMsg(ResponseCode::CommandSyntaxError, "Missing Argument", false);
285        return 0;
286    }
287
288    if (!strcmp(argv[1], "mountall")) {
289        if (argc != 2) {
290            cli->sendMsg(ResponseCode::CommandSyntaxError, "Usage: mountall", false);
291            return 0;
292        }
293        fs_mgr_mount_all(fstab);
294        cli->sendMsg(ResponseCode::CommandOkay, "Mountall ran successfully", false);
295        return 0;
296    }
297    if (!strcmp(argv[1], "users")) {
298        DIR *dir;
299        struct dirent *de;
300
301        if (argc < 3) {
302            cli->sendMsg(ResponseCode::CommandSyntaxError, "Missing Argument: user <mountpoint>", false);
303            return 0;
304        }
305        if (!(dir = opendir("/proc"))) {
306            cli->sendMsg(ResponseCode::OperationFailed, "Failed to open /proc", true);
307            return 0;
308        }
309
310        while ((de = readdir(dir))) {
311            int pid = Process::getPid(de->d_name);
312
313            if (pid < 0) {
314                continue;
315            }
316
317            char processName[255];
318            Process::getProcessName(pid, processName, sizeof(processName));
319
320            if (Process::checkFileDescriptorSymLinks(pid, argv[2]) ||
321                Process::checkFileMaps(pid, argv[2]) ||
322                Process::checkSymLink(pid, argv[2], "cwd") ||
323                Process::checkSymLink(pid, argv[2], "root") ||
324                Process::checkSymLink(pid, argv[2], "exe")) {
325
326                char msg[1024];
327                snprintf(msg, sizeof(msg), "%d %s", pid, processName);
328                cli->sendMsg(ResponseCode::StorageUsersListResult, msg, false);
329            }
330        }
331        closedir(dir);
332        cli->sendMsg(ResponseCode::CommandOkay, "Storage user list complete", false);
333    } else {
334        cli->sendMsg(ResponseCode::CommandSyntaxError, "Unknown storage cmd", false);
335    }
336    return 0;
337}
338
339CommandListener::AsecCmd::AsecCmd() :
340                 VoldCommand("asec") {
341}
342
343void CommandListener::AsecCmd::listAsecsInDirectory(SocketClient *cli, const char *directory) {
344    DIR *d = opendir(directory);
345
346    if (!d) {
347        cli->sendMsg(ResponseCode::OperationFailed, "Failed to open asec dir", true);
348        return;
349    }
350
351    size_t dirent_len = offsetof(struct dirent, d_name) +
352            fpathconf(dirfd(d), _PC_NAME_MAX) + 1;
353
354    struct dirent *dent = (struct dirent *) malloc(dirent_len);
355    if (dent == NULL) {
356        cli->sendMsg(ResponseCode::OperationFailed, "Failed to allocate memory", true);
357        return;
358    }
359
360    struct dirent *result;
361
362    while (!readdir_r(d, dent, &result) && result != NULL) {
363        if (dent->d_name[0] == '.')
364            continue;
365        if (dent->d_type != DT_REG)
366            continue;
367        size_t name_len = strlen(dent->d_name);
368        if (name_len > 5 && name_len < 260 &&
369                !strcmp(&dent->d_name[name_len - 5], ".asec")) {
370            char id[255];
371            memset(id, 0, sizeof(id));
372            strlcpy(id, dent->d_name, name_len - 4);
373            cli->sendMsg(ResponseCode::AsecListResult, id, false);
374        }
375    }
376    closedir(d);
377
378    free(dent);
379}
380
381int CommandListener::AsecCmd::runCommand(SocketClient *cli,
382                                                      int argc, char **argv) {
383    if (argc < 2) {
384        cli->sendMsg(ResponseCode::CommandSyntaxError, "Missing Argument", false);
385        return 0;
386    }
387
388    VolumeManager *vm = VolumeManager::Instance();
389    int rc = 0;
390
391    if (!strcmp(argv[1], "list")) {
392        dumpArgs(argc, argv, -1);
393
394        listAsecsInDirectory(cli, VolumeManager::SEC_ASECDIR_EXT);
395        listAsecsInDirectory(cli, VolumeManager::SEC_ASECDIR_INT);
396    } else if (!strcmp(argv[1], "create")) {
397        dumpArgs(argc, argv, 5);
398        if (argc != 8) {
399            cli->sendMsg(ResponseCode::CommandSyntaxError,
400                    "Usage: asec create <container-id> <size_mb> <fstype> <key> <ownerUid> "
401                    "<isExternal>", false);
402            return 0;
403        }
404
405        unsigned int numSectors = (atoi(argv[3]) * (1024 * 1024)) / 512;
406        const bool isExternal = (atoi(argv[7]) == 1);
407        rc = vm->createAsec(argv[2], numSectors, argv[4], argv[5], atoi(argv[6]), isExternal);
408    } else if (!strcmp(argv[1], "resize")) {
409        dumpArgs(argc, argv, -1);
410        if (argc != 5) {
411            cli->sendMsg(ResponseCode::CommandSyntaxError, "Usage: asec resize <container-id> <size_mb> <key>", false);
412            return 0;
413        }
414        unsigned int numSectors = (atoi(argv[3]) * (1024 * 1024)) / 512;
415        rc = vm->resizeAsec(argv[2], numSectors, argv[4]);
416    } else if (!strcmp(argv[1], "finalize")) {
417        dumpArgs(argc, argv, -1);
418        if (argc != 3) {
419            cli->sendMsg(ResponseCode::CommandSyntaxError, "Usage: asec finalize <container-id>", false);
420            return 0;
421        }
422        rc = vm->finalizeAsec(argv[2]);
423    } else if (!strcmp(argv[1], "fixperms")) {
424        dumpArgs(argc, argv, -1);
425        if  (argc != 5) {
426            cli->sendMsg(ResponseCode::CommandSyntaxError, "Usage: asec fixperms <container-id> <gid> <filename>", false);
427            return 0;
428        }
429
430        char *endptr;
431        gid_t gid = (gid_t) strtoul(argv[3], &endptr, 10);
432        if (*endptr != '\0') {
433            cli->sendMsg(ResponseCode::CommandSyntaxError, "Usage: asec fixperms <container-id> <gid> <filename>", false);
434            return 0;
435        }
436
437        rc = vm->fixupAsecPermissions(argv[2], gid, argv[4]);
438    } else if (!strcmp(argv[1], "destroy")) {
439        dumpArgs(argc, argv, -1);
440        if (argc < 3) {
441            cli->sendMsg(ResponseCode::CommandSyntaxError, "Usage: asec destroy <container-id> [force]", false);
442            return 0;
443        }
444        bool force = false;
445        if (argc > 3 && !strcmp(argv[3], "force")) {
446            force = true;
447        }
448        rc = vm->destroyAsec(argv[2], force);
449    } else if (!strcmp(argv[1], "mount")) {
450        dumpArgs(argc, argv, 3);
451        if (argc != 6) {
452            cli->sendMsg(ResponseCode::CommandSyntaxError,
453                    "Usage: asec mount <namespace-id> <key> <ownerUid> <ro|rw>", false);
454            return 0;
455        }
456        bool readOnly = true;
457        if (!strcmp(argv[5], "rw")) {
458            readOnly = false;
459        }
460        rc = vm->mountAsec(argv[2], argv[3], atoi(argv[4]), readOnly);
461    } else if (!strcmp(argv[1], "unmount")) {
462        dumpArgs(argc, argv, -1);
463        if (argc < 3) {
464            cli->sendMsg(ResponseCode::CommandSyntaxError, "Usage: asec unmount <container-id> [force]", false);
465            return 0;
466        }
467        bool force = false;
468        if (argc > 3 && !strcmp(argv[3], "force")) {
469            force = true;
470        }
471        rc = vm->unmountAsec(argv[2], force);
472    } else if (!strcmp(argv[1], "rename")) {
473        dumpArgs(argc, argv, -1);
474        if (argc != 4) {
475            cli->sendMsg(ResponseCode::CommandSyntaxError,
476                    "Usage: asec rename <old_id> <new_id>", false);
477            return 0;
478        }
479        rc = vm->renameAsec(argv[2], argv[3]);
480    } else if (!strcmp(argv[1], "path")) {
481        dumpArgs(argc, argv, -1);
482        if (argc != 3) {
483            cli->sendMsg(ResponseCode::CommandSyntaxError, "Usage: asec path <container-id>", false);
484            return 0;
485        }
486        char path[255];
487
488        if (!(rc = vm->getAsecMountPath(argv[2], path, sizeof(path)))) {
489            cli->sendMsg(ResponseCode::AsecPathResult, path, false);
490            return 0;
491        }
492    } else if (!strcmp(argv[1], "fspath")) {
493        dumpArgs(argc, argv, -1);
494        if (argc != 3) {
495            cli->sendMsg(ResponseCode::CommandSyntaxError, "Usage: asec fspath <container-id>", false);
496            return 0;
497        }
498        char path[255];
499
500        if (!(rc = vm->getAsecFilesystemPath(argv[2], path, sizeof(path)))) {
501            cli->sendMsg(ResponseCode::AsecPathResult, path, false);
502            return 0;
503        }
504    } else {
505        dumpArgs(argc, argv, -1);
506        cli->sendMsg(ResponseCode::CommandSyntaxError, "Unknown asec cmd", false);
507    }
508
509    if (!rc) {
510        cli->sendMsg(ResponseCode::CommandOkay, "asec operation succeeded", false);
511    } else {
512        rc = ResponseCode::convertFromErrno();
513        cli->sendMsg(rc, "asec operation failed", true);
514    }
515
516    return 0;
517}
518
519CommandListener::ObbCmd::ObbCmd() :
520                 VoldCommand("obb") {
521}
522
523int CommandListener::ObbCmd::runCommand(SocketClient *cli,
524                                                      int argc, char **argv) {
525    if (argc < 2) {
526        cli->sendMsg(ResponseCode::CommandSyntaxError, "Missing Argument", false);
527        return 0;
528    }
529
530    VolumeManager *vm = VolumeManager::Instance();
531    int rc = 0;
532
533    if (!strcmp(argv[1], "list")) {
534        dumpArgs(argc, argv, -1);
535
536        rc = vm->listMountedObbs(cli);
537    } else if (!strcmp(argv[1], "mount")) {
538            dumpArgs(argc, argv, 3);
539            if (argc != 5) {
540                cli->sendMsg(ResponseCode::CommandSyntaxError,
541                        "Usage: obb mount <filename> <key> <ownerGid>", false);
542                return 0;
543            }
544            rc = vm->mountObb(argv[2], argv[3], atoi(argv[4]));
545    } else if (!strcmp(argv[1], "unmount")) {
546        dumpArgs(argc, argv, -1);
547        if (argc < 3) {
548            cli->sendMsg(ResponseCode::CommandSyntaxError, "Usage: obb unmount <source file> [force]", false);
549            return 0;
550        }
551        bool force = false;
552        if (argc > 3 && !strcmp(argv[3], "force")) {
553            force = true;
554        }
555        rc = vm->unmountObb(argv[2], force);
556    } else if (!strcmp(argv[1], "path")) {
557        dumpArgs(argc, argv, -1);
558        if (argc != 3) {
559            cli->sendMsg(ResponseCode::CommandSyntaxError, "Usage: obb path <source file>", false);
560            return 0;
561        }
562        char path[255];
563
564        if (!(rc = vm->getObbMountPath(argv[2], path, sizeof(path)))) {
565            cli->sendMsg(ResponseCode::AsecPathResult, path, false);
566            return 0;
567        }
568    } else {
569        dumpArgs(argc, argv, -1);
570        cli->sendMsg(ResponseCode::CommandSyntaxError, "Unknown obb cmd", false);
571    }
572
573    if (!rc) {
574        cli->sendMsg(ResponseCode::CommandOkay, "obb operation succeeded", false);
575    } else {
576        rc = ResponseCode::convertFromErrno();
577        cli->sendMsg(rc, "obb operation failed", true);
578    }
579
580    return 0;
581}
582
583CommandListener::FstrimCmd::FstrimCmd() :
584                 VoldCommand("fstrim") {
585}
586int CommandListener::FstrimCmd::runCommand(SocketClient *cli,
587                                                      int argc, char **argv) {
588    if ((cli->getUid() != 0) && (cli->getUid() != AID_SYSTEM)) {
589        cli->sendMsg(ResponseCode::CommandNoPermission, "No permission to run fstrim commands", false);
590        return 0;
591    }
592
593    if (argc < 2) {
594        cli->sendMsg(ResponseCode::CommandSyntaxError, "Missing Argument", false);
595        return 0;
596    }
597
598    int rc = 0;
599
600    if (!strcmp(argv[1], "dotrim")) {
601        if (argc != 2) {
602            cli->sendMsg(ResponseCode::CommandSyntaxError, "Usage: fstrim dotrim", false);
603            return 0;
604        }
605        dumpArgs(argc, argv, -1);
606        rc = fstrim_filesystems(0);
607    } else if (!strcmp(argv[1], "dodtrim")) {
608        if (argc != 2) {
609            cli->sendMsg(ResponseCode::CommandSyntaxError, "Usage: fstrim dodtrim", false);
610            return 0;
611        }
612        dumpArgs(argc, argv, -1);
613        rc = fstrim_filesystems(1);   /* Do Deep Discard trim */
614    } else {
615        dumpArgs(argc, argv, -1);
616        cli->sendMsg(ResponseCode::CommandSyntaxError, "Unknown fstrim cmd", false);
617    }
618
619    // Always report that the command succeeded and return the error code.
620    // The caller will check the return value to see what the error was.
621    char msg[255];
622    snprintf(msg, sizeof(msg), "%d", rc);
623    cli->sendMsg(ResponseCode::CommandOkay, msg, false);
624
625    return 0;
626}
627