/* * Copyright (C) 2011 Karel Zak * Originally from Ted's losetup.c * * losetup.c - setup and control loop devices */ #include #include #include #include #include #include #include #include #include #include #include "c.h" #include "tt.h" #include "nls.h" #include "strutils.h" #include "loopdev.h" #include "closestream.h" #include "optutils.h" #include "xalloc.h" #include "canonicalize.h" enum { A_CREATE = 1, /* setup a new device */ A_DELETE, /* delete given device(s) */ A_DELETE_ALL, /* delete all devices */ A_SHOW, /* list devices */ A_SHOW_ONE, /* print info about one device */ A_FIND_FREE, /* find first unused */ A_SET_CAPACITY, /* set device capacity */ }; enum { COL_NAME = 0, COL_AUTOCLR, COL_BACK_FILE, COL_BACK_INO, COL_BACK_MAJMIN, COL_MAJMIN, COL_OFFSET, COL_PARTSCAN, COL_RO, COL_SIZELIMIT, }; struct tt *tt; struct colinfo { const char *name; double whint; int flags; const char *help; }; static struct colinfo infos[] = { [COL_AUTOCLR] = { "AUTOCLEAR", 1, TT_FL_RIGHT, N_("autoclear flag set")}, [COL_BACK_FILE] = { "BACK-FILE", 0.3, 0, N_("device backing file")}, [COL_BACK_INO] = { "BACK-INO", 4, TT_FL_RIGHT, N_("backing file inode number")}, [COL_BACK_MAJMIN] = { "BACK-MAJ:MIN", 6, 0, N_("backing file major:minor device number")}, [COL_NAME] = { "NAME", 0.25, 0, N_("loop device name")}, [COL_OFFSET] = { "OFFSET", 5, TT_FL_RIGHT, N_("offset from the beginning")}, [COL_PARTSCAN] = { "PARTSCAN", 1, TT_FL_RIGHT, N_("partscan flag set")}, [COL_RO] = { "RO", 1, TT_FL_RIGHT, N_("read-only device")}, [COL_SIZELIMIT] = { "SIZELIMIT", 5, TT_FL_RIGHT, N_("size limit of the file in bytes")}, [COL_MAJMIN] = { "MAJ:MIN", 3, 0, N_("loop device major:minor number")}, }; #define NCOLS ARRAY_SIZE(infos) static int columns[NCOLS] = {-1}; static int ncolumns; static int verbose; static int get_column_id(int num) { assert(ARRAY_SIZE(columns) == NCOLS); assert(num < ncolumns); assert(columns[num] < (int) NCOLS); return columns[num]; } static struct colinfo *get_column_info(int num) { return &infos[ get_column_id(num) ]; } static int column_name_to_id(const char *name, size_t namesz) { size_t i; for (i = 0; i < NCOLS; i++) { const char *cn = infos[i].name; if (!strncasecmp(name, cn, namesz) && !*(cn + namesz)) return i; } warnx(_("unknown column: %s"), name); return -1; } static int printf_loopdev(struct loopdev_cxt *lc) { uint64_t x; dev_t dev = 0; ino_t ino = 0; char *fname = NULL; uint32_t type; fname = loopcxt_get_backing_file(lc); if (!fname) return -EINVAL; if (loopcxt_get_backing_devno(lc, &dev) == 0) loopcxt_get_backing_inode(lc, &ino); if (!dev && !ino) { /* * Probably non-root user (no permissions to * call LOOP_GET_STATUS ioctls). */ printf("%s: []: (%s)", loopcxt_get_device(lc), fname); if (loopcxt_get_offset(lc, &x) == 0 && x) printf(_(", offset %ju"), x); if (loopcxt_get_sizelimit(lc, &x) == 0 && x) printf(_(", sizelimit %ju"), x); printf("\n"); return 0; } printf("%s: [%04d]:%" PRIu64 " (%s)", loopcxt_get_device(lc), (int) dev, ino, fname); if (loopcxt_get_offset(lc, &x) == 0 && x) printf(_(", offset %ju"), x); if (loopcxt_get_sizelimit(lc, &x) == 0 && x) printf(_(", sizelimit %ju"), x); if (loopcxt_get_encrypt_type(lc, &type) == 0) { const char *e = loopcxt_get_crypt_name(lc); if ((!e || !*e) && type == 1) e = "XOR"; if (e && *e) printf(_(", encryption %s (type %u)"), e, type); } printf("\n"); return 0; } static int show_all_loops(struct loopdev_cxt *lc, const char *file, uint64_t offset, int flags) { struct stat sbuf, *st = &sbuf; if (loopcxt_init_iterator(lc, LOOPITER_FL_USED)) return -1; if (!file || stat(file, st)) st = NULL; while (loopcxt_next(lc) == 0) { if (file && !loopcxt_is_used(lc, st, file, offset, flags)) { char *canonized; int ret; canonized = canonicalize_path(file); ret = loopcxt_is_used(lc, st, canonized, offset, flags); free(canonized); if (!ret) continue; } printf_loopdev(lc); } loopcxt_deinit_iterator(lc); return 0; } static int delete_loop(struct loopdev_cxt *lc) { if (loopcxt_delete_device(lc)) warn(_("%s: detach failed"), loopcxt_get_device(lc)); else return 0; return -1; } static int delete_all_loops(struct loopdev_cxt *lc) { int res = 0; if (loopcxt_init_iterator(lc, LOOPITER_FL_USED)) return -1; while (loopcxt_next(lc) == 0) res += delete_loop(lc); loopcxt_deinit_iterator(lc); return res; } static int set_tt_data(struct loopdev_cxt *lc, struct tt_line *ln) { int i; for (i = 0; i < ncolumns; i++) { const char *p = NULL; char *np = NULL; uint64_t x = 0; switch(get_column_id(i)) { case COL_NAME: p = loopcxt_get_device(lc); if (p) tt_line_set_data(ln, i, xstrdup(p)); break; case COL_BACK_FILE: p = loopcxt_get_backing_file(lc); if (p) tt_line_set_data(ln, i, xstrdup(p)); break; case COL_OFFSET: if (loopcxt_get_offset(lc, &x) == 0) xasprintf(&np, "%jd", x); if (np) tt_line_set_data(ln, i, np); break; case COL_SIZELIMIT: if (loopcxt_get_sizelimit(lc, &x) == 0) xasprintf(&np, "%jd", x); if (np) tt_line_set_data(ln, i, np); break; case COL_BACK_MAJMIN: { dev_t dev = 0; if (loopcxt_get_backing_devno(lc, &dev) == 0 && dev) xasprintf(&np, "%8u:%-3u", major(dev), minor(dev)); if (np) tt_line_set_data(ln, i, np); break; } case COL_MAJMIN: { struct stat st; if (loopcxt_get_device(lc) && stat(loopcxt_get_device(lc), &st) == 0 && S_ISBLK(st.st_mode) && major(st.st_rdev) == LOOPDEV_MAJOR) xasprintf(&np, "%3u:%-3u", major(st.st_rdev), minor(st.st_rdev)); if (np) tt_line_set_data(ln, i, np); break; } case COL_BACK_INO: { ino_t ino = 0; if (loopcxt_get_backing_inode(lc, &ino) == 0 && ino) xasprintf(&np, "%ju", ino); if (np) tt_line_set_data(ln, i, np); break; } case COL_AUTOCLR: tt_line_set_data(ln, i, xstrdup(loopcxt_is_autoclear(lc) ? "1" : "0")); break; case COL_RO: tt_line_set_data(ln, i, xstrdup(loopcxt_is_readonly(lc) ? "1" : "0")); break; case COL_PARTSCAN: tt_line_set_data(ln, i, xstrdup(loopcxt_is_partscan(lc) ? "1" : "0")); break; default: return -EINVAL; } } return 0; } static int make_table(struct loopdev_cxt *lc, const char *file, uint64_t offset, int flags, int tt_flags) { struct stat sbuf, *st = &sbuf; struct tt_line *ln; int i; if (!(tt = tt_new_table(tt_flags))) errx(EXIT_FAILURE, _("failed to initialize output table")); for (i = 0; i < ncolumns; i++) { struct colinfo *ci = get_column_info(i); if (!tt_define_column(tt, ci->name, ci->whint, ci->flags)) warn(_("failed to initialize output column")); } /* only one loopdev requested (already assigned to loopdev_cxt) */ if (loopcxt_get_device(lc)) { ln = tt_add_line(tt, NULL); if (set_tt_data(lc, ln)) return -EINVAL; return 0; } /* list all loopdevs */ if (loopcxt_init_iterator(lc, LOOPITER_FL_USED)) return -1; if (!file || stat(file, st)) st = NULL; while (loopcxt_next(lc) == 0) { if (file && !loopcxt_is_used(lc, st, file, offset, flags)) continue; ln = tt_add_line(tt, NULL); if (set_tt_data(lc, ln)) return -EINVAL; } loopcxt_deinit_iterator(lc); return 0; } static void usage(FILE *out) { size_t i; fputs(USAGE_HEADER, out); fprintf(out, _(" %1$s [options] []\n" " %1$s [options] -f | \n"), program_invocation_short_name); fputs(USAGE_OPTIONS, out); fputs(_(" -a, --all list all used devices\n" " -d, --detach [...] detach one or more devices\n" " -D, --detach-all detach all used devices\n" " -f, --find find first unused device\n" " -c, --set-capacity resize device\n" " -j, --associated list all devices associated with \n"), out); fputs(USAGE_SEPARATOR, out); fputs(_(" -o, --offset start at offset into file\n"), out); fputs(_(" --sizelimit device limited to bytes of the file\n"), out); fputs(_(" -P, --partscan create partitioned loop device\n"), out); fputs(_(" -r, --read-only setup read-only loop device\n"), out); fputs(_(" --show print device name after setup (with -f)\n"), out); fputs(_(" -v, --verbose verbose mode\n"), out); fputs(USAGE_SEPARATOR, out); fputs(_(" -l, --list list info about all or specified\n"), out); fputs(_(" -O, --output specify columns to output for --list\n"), out); fputs(_(" -n, --noheadings don't print headings for --list ouput\n"), out); fputs(_(" --raw use raw --list output format\n"), out); fputs(USAGE_SEPARATOR, out); fputs(USAGE_HELP, out); fputs(USAGE_VERSION, out); fputs(_("\nAvailable --list columns:\n"), out); for (i = 0; i < NCOLS; i++) fprintf(out, " %12s %s\n", infos[i].name, _(infos[i].help)); fprintf(out, USAGE_MAN_TAIL("losetup(8)")); exit(out == stderr ? EXIT_FAILURE : EXIT_SUCCESS); } static void warn_size(const char *filename, uint64_t size) { struct stat st; if (!size) { if (stat(filename, &st) || S_ISBLK(st.st_mode)) return; size = st.st_size; } if (size < 512) warnx(_("%s: warning: file smaller than 512 bytes, the loop device " "maybe be useless or invisible for system tools."), filename); else if (size % 512) warnx(_("%s: warning: file does not fit into a 512-byte sector " "the end of the file will be ignored."), filename); } int main(int argc, char **argv) { struct loopdev_cxt lc; int act = 0, flags = 0, c; char *file = NULL; uint64_t offset = 0, sizelimit = 0; int res = 0, showdev = 0, lo_flags = 0, tt_flags = 0; char *outarg = NULL; int list = 0; enum { OPT_SIZELIMIT = CHAR_MAX + 1, OPT_SHOW, OPT_RAW }; static const struct option longopts[] = { { "all", 0, 0, 'a' }, { "set-capacity", 1, 0, 'c' }, { "detach", 1, 0, 'd' }, { "detach-all", 0, 0, 'D' }, { "encryption", 1, 0, 'e' }, { "find", 0, 0, 'f' }, { "help", 0, 0, 'h' }, { "associated", 1, 0, 'j' }, { "list", 0, 0, 'l' }, { "noheadings", 0, 0, 'n' }, { "offset", 1, 0, 'o' }, { "output", 1, 0, 'O' }, { "sizelimit", 1, 0, OPT_SIZELIMIT }, { "pass-fd", 1, 0, 'p' }, { "partscan", 0, 0, 'P' }, { "read-only", 0, 0, 'r' }, { "raw", 0, 0, OPT_RAW }, { "show", 0, 0, OPT_SHOW }, { "verbose", 0, 0, 'v' }, { "version", 0, 0, 'V' }, { NULL, 0, 0, 0 } }; static const ul_excl_t excl[] = { /* rows and cols in ASCII order */ { 'D','a','c','d','f','j' }, { 'D','c','d','f','l' }, { 'D','c','d','f','O' }, { 0 } }; int excl_st[ARRAY_SIZE(excl)] = UL_EXCL_STATUS_INIT; setlocale(LC_ALL, ""); bindtextdomain(PACKAGE, LOCALEDIR); textdomain(PACKAGE); atexit(close_stdout); if (loopcxt_init(&lc, 0)) err(EXIT_FAILURE, _("failed to initialize loopcxt")); while ((c = getopt_long(argc, argv, "ac:d:De:E:fhj:lno:O:p:PrvV", longopts, NULL)) != -1) { err_exclusive_options(c, longopts, excl, excl_st); switch (c) { case 'a': act = A_SHOW; break; case 'c': act = A_SET_CAPACITY; if (loopcxt_set_device(&lc, optarg)) err(EXIT_FAILURE, _("%s: failed to use device"), optarg); break; case 'r': lo_flags |= LO_FLAGS_READ_ONLY; break; case 'd': act = A_DELETE; if (loopcxt_set_device(&lc, optarg)) err(EXIT_FAILURE, _("%s: failed to use device"), optarg); break; case 'D': act = A_DELETE_ALL; break; case 'E': case 'e': errx(EXIT_FAILURE, _("encryption not supported, use cryptsetup(8) instead")); break; case 'f': act = A_FIND_FREE; break; case 'h': usage(stdout); break; case 'j': act = A_SHOW; file = optarg; break; case 'l': list = 1; break; case 'n': tt_flags |= TT_FL_NOHEADINGS; break; case OPT_RAW: tt_flags |= TT_FL_RAW; break; case 'o': offset = strtosize_or_err(optarg, _("failed to parse offset")); flags |= LOOPDEV_FL_OFFSET; break; case 'O': outarg = optarg; list = 1; break; case 'p': warn(_("--pass-fd is no longer supported")); break; case 'P': lo_flags |= LO_FLAGS_PARTSCAN; break; case OPT_SHOW: showdev = 1; break; case 'v': verbose = 1; break; case 'V': printf(UTIL_LINUX_VERSION); return EXIT_SUCCESS; case OPT_SIZELIMIT: /* --sizelimit */ sizelimit = strtosize_or_err(optarg, _("failed to parse size")); flags |= LOOPDEV_FL_SIZELIMIT; break; default: usage(stderr); } } /* default is --list --all */ if (argc == 1) { act = A_SHOW; list = 1; } /* default --list output columns */ if (list && !ncolumns) { columns[ncolumns++] = COL_NAME; columns[ncolumns++] = COL_SIZELIMIT; columns[ncolumns++] = COL_OFFSET; columns[ncolumns++] = COL_AUTOCLR; columns[ncolumns++] = COL_RO; columns[ncolumns++] = COL_BACK_FILE; } if (act == A_FIND_FREE && optind < argc) { /* * losetup -f */ act = A_CREATE; file = argv[optind++]; } if (list && !act && optind == argc) /* * losetup --list defaults to --all */ act = A_SHOW; if (!act && optind + 1 == argc) { /* * losetup [--list] */ act = A_SHOW_ONE; if (loopcxt_set_device(&lc, argv[optind])) err(EXIT_FAILURE, _("%s: failed to use device"), argv[optind]); optind++; } if (!act) { /* * losetup */ act = A_CREATE; if (optind >= argc) errx(EXIT_FAILURE, _("no loop device specified")); if (loopcxt_set_device(&lc, argv[optind])) err(EXIT_FAILURE, _("%s: failed to use device"), argv[optind]); optind++; if (optind >= argc) errx(EXIT_FAILURE, _("no file specified")); file = argv[optind++]; } if (act != A_CREATE && (sizelimit || lo_flags || showdev)) errx(EXIT_FAILURE, _("the options %s are allowed during loop device setup only"), "--{sizelimit,read-only,show}"); if ((flags & LOOPDEV_FL_OFFSET) && act != A_CREATE && (act != A_SHOW || !file)) errx(EXIT_FAILURE, _("the option --offset is not allowed in this context")); if (outarg && string_add_to_idarray(outarg, columns, ARRAY_SIZE(columns), &ncolumns, column_name_to_id) < 0) return EXIT_FAILURE; switch (act) { case A_CREATE: { int hasdev = loopcxt_has_device(&lc); do { /* Note that loopcxt_{find_unused,set_device}() resets * loopcxt struct. */ if (!hasdev && (res = loopcxt_find_unused(&lc))) { warnx(_("cannot find an unused loop device")); break; } if (flags & LOOPDEV_FL_OFFSET) loopcxt_set_offset(&lc, offset); if (flags & LOOPDEV_FL_SIZELIMIT) loopcxt_set_sizelimit(&lc, sizelimit); if (lo_flags) loopcxt_set_flags(&lc, lo_flags); if ((res = loopcxt_set_backing_file(&lc, file))) { warn(_("%s: failed to use backing file"), file); break; } errno = 0; res = loopcxt_setup_device(&lc); if (res == 0) break; /* success */ if (errno != EBUSY) { warn(_("%s: failed to set up loop device"), hasdev && loopcxt_get_fd(&lc) < 0 ? loopcxt_get_device(&lc) : file); break; } } while (hasdev == 0); if (res == 0) { if (showdev) printf("%s\n", loopcxt_get_device(&lc)); warn_size(file, sizelimit); } break; } case A_DELETE: res = delete_loop(&lc); while (optind < argc) { if (loopcxt_set_device(&lc, argv[optind])) warn(_("%s: failed to use device"), argv[optind]); optind++; res += delete_loop(&lc); } break; case A_DELETE_ALL: res = delete_all_loops(&lc); break; case A_FIND_FREE: if (loopcxt_find_unused(&lc)) warn(_("cannot find an unused loop device")); else printf("%s\n", loopcxt_get_device(&lc)); break; case A_SHOW: if (list) res = make_table(&lc, file, offset, flags, tt_flags); else res = show_all_loops(&lc, file, offset, flags); break; case A_SHOW_ONE: if (list) res = make_table( &lc, NULL, 0, 0, tt_flags); else res = printf_loopdev(&lc); if (res) warn("%s", loopcxt_get_device(&lc)); break; case A_SET_CAPACITY: res = loopcxt_set_capacity(&lc); if (res) warn(_("%s: set capacity failed"), loopcxt_get_device(&lc)); break; default: usage(stderr); break; } if (tt) { if (!res) tt_print_table(tt); tt_free_table(tt); } loopcxt_deinit(&lc); return res ? EXIT_FAILURE : EXIT_SUCCESS; }