1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691
|
/*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public
* License v2 as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public
* License along with this program; if not, write to the
* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 021110-1307, USA.
*/
#include "kerncompat.h"
#include <sys/ioctl.h>
#include <sys/stat.h>
#include <sys/xattr.h>
#include <stdlib.h>
#include <string.h>
#include <unistd.h>
#include <fcntl.h>
#include <dirent.h>
#include <errno.h>
#include <stdbool.h>
#include <uuid/uuid.h>
#include "libbtrfsutil/btrfsutil.h"
#include "kernel-shared/uapi/btrfs.h"
#include "kernel-shared/uapi/btrfs_tree.h"
#include "common/defs.h"
#include "common/messages.h"
#include "common/open-utils.h"
#include "common/utils.h"
#include "common/help.h"
#include "common/filesystem-utils.h"
#include "cmds/commands.h"
#include "cmds/props.h"
#define XATTR_BTRFS_PREFIX "btrfs."
#define XATTR_BTRFS_PREFIX_LEN (sizeof(XATTR_BTRFS_PREFIX) - 1)
/*
* Defined as synonyms in attr/xattr.h
*/
#ifndef ENOATTR
#define ENOATTR ENODATA
#endif
static int subvolume_clear_received_uuid(const char *path)
{
struct btrfs_ioctl_received_subvol_args args = {};
int ret;
int fd;
fd = open(path, O_RDONLY | O_NOATIME);
if (fd == -1)
return -errno;
ret = ioctl(fd, BTRFS_IOC_SET_RECEIVED_SUBVOL, &args);
if (ret == -1) {
close(fd);
return -errno;
}
close(fd);
return 0;
}
static int prop_read_only(enum prop_object_type type,
const char *object,
const char *name,
const char *value,
bool force)
{
enum btrfs_util_error err;
bool read_only;
if (value) {
struct btrfs_util_subvolume_info info = {};
bool is_ro = false;
bool do_clear_received_uuid = false;
if (!strcmp(value, "true")) {
read_only = true;
} else if (!strcmp(value, "false")) {
read_only = false;
} else {
error("invalid value for property: %s", value);
return -EINVAL;
}
err = btrfs_util_subvolume_get_read_only(object, &is_ro);
if (err) {
error_btrfs_util(err);
return -errno;
}
/* No change if already read-only */
if (is_ro && read_only)
return 0;
err = btrfs_util_subvolume_get_info(object, 0, &info);
if (err)
warning("cannot read subvolume info");
if (is_ro && !uuid_is_null(info.received_uuid)) {
pr_verbose(LOG_INFO, "ro->rw switch but has set receive_uuid");
if (force) {
do_clear_received_uuid = true;
} else {
error(
"cannot flip ro->rw with received_uuid set, use force option -f if you really want unset the read-only status."
" The value of received_uuid is used for incremental send, consider making a snapshot instead."
" Read more at btrfs-subvolume(8) and Subvolume flags.");
return -EPERM;
}
}
if (!is_ro && !uuid_is_null(info.received_uuid))
warning("read-write subvolume with received_uuid, this is bad");
err = btrfs_util_subvolume_set_read_only(object, read_only);
if (err) {
error_btrfs_util(err);
return -errno;
}
if (do_clear_received_uuid) {
int ret;
char uuid_str[BTRFS_UUID_UNPARSED_SIZE];
uuid_unparse(info.received_uuid, uuid_str);
pr_verbose(LOG_INFO, "force used, clearing received_uuid, previously %s",
uuid_str);
ret = subvolume_clear_received_uuid(object);
if (ret < 0)
warning("failed to clear received_uuid: %m");
}
} else {
err = btrfs_util_subvolume_get_read_only(object, &read_only);
if (err) {
error_btrfs_util(err);
return -errno;
}
pr_verbose(LOG_DEFAULT, "ro=%s\n", read_only ? "true" : "false");
}
return 0;
}
static int prop_label(enum prop_object_type type,
const char *object,
const char *name,
const char *value,
bool force)
{
int ret;
if (value) {
ret = set_label((char *) object, (char *) value);
} else {
char label[BTRFS_LABEL_SIZE];
ret = get_label((char *) object, label);
if (!ret)
pr_verbose(LOG_DEFAULT, "label=%s\n", label);
}
return ret;
}
static int prop_compression(enum prop_object_type type,
const char *object,
const char *name,
const char *value,
bool force)
{
int ret;
ssize_t sret;
int fd = -1;
char *buf = NULL;
char *xattr_name = NULL;
int open_flags = value ? O_RDWR : O_RDONLY;
fd = btrfs_open_path(object, open_flags == O_RDWR, false);
if (fd < 0) {
ret = fd;
goto out;
}
xattr_name = malloc(XATTR_BTRFS_PREFIX_LEN + strlen(name) + 1);
if (!xattr_name) {
ret = -ENOMEM;
goto out;
}
memcpy(xattr_name, XATTR_BTRFS_PREFIX, XATTR_BTRFS_PREFIX_LEN);
memcpy(xattr_name + XATTR_BTRFS_PREFIX_LEN, name, strlen(name));
xattr_name[XATTR_BTRFS_PREFIX_LEN + strlen(name)] = '\0';
if (value) {
sret = fsetxattr(fd, xattr_name, value, strlen(value), 0);
} else {
sret = fgetxattr(fd, xattr_name, NULL, 0);
}
if (sret < 0) {
ret = -errno;
if (ret != -ENOATTR)
error("failed to %s compression for %s: %m",
value ? "set" : "get", object);
else
ret = 0;
goto out;
}
if (!value) {
size_t len = sret;
buf = malloc(len);
if (!buf) {
ret = -ENOMEM;
goto out;
}
sret = fgetxattr(fd, xattr_name, buf, len);
if (sret < 0) {
ret = -errno;
error("failed to get compression for %s: %m", object);
goto out;
}
pr_verbose(LOG_DEFAULT, "compression=%.*s\n", (int)len, buf);
}
ret = 0;
out:
free(xattr_name);
free(buf);
if (fd >= 0)
close(fd);
return ret;
}
const struct prop_handler prop_handlers[] = {
{
.name ="ro",
.desc = "read-only status of a subvolume",
.read_only = 0,
.types = prop_object_subvol,
.handler = prop_read_only
},
{
.name = "label",
.desc = "label of the filesystem",
.read_only = 0,
.types = prop_object_dev | prop_object_root,
.handler = prop_label
},
{
.name = "compression",
.desc = "compression algorithm for the file or directory",
.read_only = 0,
.types = prop_object_inode,
.handler = prop_compression
},
{NULL, NULL, 0, 0, NULL}
};
static const char * const property_cmd_group_usage[] = {
"btrfs property get/set/list [-t <type>] <object> [<name>] [value]",
NULL
};
static int parse_prop(const char *arg, const struct prop_handler *props,
const struct prop_handler **prop_ret)
{
const struct prop_handler *prop = props;
for (; prop->name; prop++) {
if (!strcmp(prop->name, arg)) {
*prop_ret = prop;
return 0;
}
}
return -1;
}
static int check_btrfs_object(const char *object)
{
int ret;
u8 fsid[BTRFS_FSID_SIZE];
struct stat st;
ret = stat(object, &st);
if (ret < 0)
return 0;
/*
* Don't try to read fsid on char devices, this will fail anyway. In
* some cases opening the device can trigger some system events (like a
* watchdog) so do only stat.
*/
if ((st.st_mode & S_IFMT) == S_IFCHR || (st.st_mode & S_IFMT) == S_IFIFO)
return 0;
ret = get_fsid(object, fsid, 0);
if (ret < 0)
ret = 0;
else
ret = 1;
return ret;
}
static int check_is_root(const char *object)
{
int ret;
u8 fsid[BTRFS_FSID_SIZE];
u8 fsid2[BTRFS_FSID_SIZE];
char *tmp = NULL;
char *rp;
rp = realpath(object, NULL);
if (!rp) {
ret = -errno;
goto out;
}
if (!strcmp(rp, "/")) {
ret = 0;
goto out;
}
tmp = malloc(strlen(object) + 5);
if (!tmp) {
ret = -ENOMEM;
goto out;
}
strcpy(tmp, object);
if (tmp[strlen(tmp) - 1] != '/')
strcat(tmp, "/");
strcat(tmp, "..");
ret = get_fsid(object, fsid, 0);
if (ret < 0) {
errno = -ret;
error("get_fsid for %s failed: %m", object);
goto out;
}
ret = get_fsid(tmp, fsid2, 1);
if (ret == -ENOTTY) {
ret = 0;
goto out;
} else if (ret == -ENOTDIR) {
ret = 1;
goto out;
} else if (ret < 0) {
errno = -ret;
error("get_fsid for %s failed: %m", tmp);
goto out;
}
if (memcmp(fsid, fsid2, BTRFS_FSID_SIZE)) {
ret = 0;
goto out;
}
ret = 1;
out:
free(tmp);
free(rp);
return ret;
}
static int count_bits(int v)
{
unsigned int tmp = (unsigned int)v;
int cnt = 0;
while (tmp) {
if (tmp & 1)
cnt++;
tmp >>= 1;
}
return cnt;
}
static int autodetect_object_types(const char *object, int *types_out)
{
int ret;
int is_btrfs_object;
int types = 0;
struct stat st;
is_btrfs_object = check_btrfs_object(object);
ret = stat(object, &st);
if (ret < 0) {
ret = -errno;
goto out;
}
if (is_btrfs_object) {
types |= prop_object_inode;
if (st.st_ino == BTRFS_FIRST_FREE_OBJECTID)
types |= prop_object_subvol;
ret = check_is_root(object);
if (ret < 0)
goto out;
if (!ret)
types |= prop_object_root;
}
if (S_ISBLK(st.st_mode))
types |= prop_object_dev;
ret = 0;
*types_out = types;
out:
return ret;
}
static int dump_prop(const struct prop_handler *prop,
const char *object,
int types,
int type,
int name_and_help)
{
int ret = 0;
if ((types & type) && (prop->types & type)) {
if (!name_and_help)
ret = prop->handler(type, object, prop->name, NULL, false);
else
pr_verbose(LOG_DEFAULT, "%-20s%s\n", prop->name, prop->desc);
}
return ret;
}
static int dump_props(int types, const char *object, int name_and_help)
{
int ret;
int i;
int j;
const struct prop_handler *prop;
for (i = 0; prop_handlers[i].name; i++) {
prop = &prop_handlers[i];
for (j = 1; j < __prop_object_max; j <<= 1) {
ret = dump_prop(prop, object, types, j, name_and_help);
if (ret < 0) {
ret = 1;
goto out;
}
}
}
ret = 0;
out:
return ret;
}
static int setget_prop(int types, const char *object,
const char *name, const char *value, bool force)
{
int ret;
const struct prop_handler *prop = NULL;
ret = parse_prop(name, prop_handlers, &prop);
if (ret == -1) {
error("unknown property: %s", name);
return 1;
}
types &= prop->types;
if (!types) {
error("object is not compatible with property: %s", prop->name);
return 1;
}
if (count_bits(types) > 1) {
error("type of object is ambiguous, please use option -t");
return 1;
}
if (value && prop->read_only) {
error("property is read-only property: %s",
prop->name);
return 1;
}
ret = prop->handler(types, object, name, value, force);
if (ret < 0)
ret = 1;
else
ret = 0;
return ret;
}
static int parse_args(const struct cmd_struct *cmd, int argc, char **argv,
int *types, char **object,
char **name, char **value, int min_nonopt_args,
bool *force)
{
int ret;
char *type_str = NULL;
int max_nonopt_args = 1;
*force = false;
optind = 1;
while (1) {
int c = getopt(argc, argv, "ft:");
if (c < 0)
break;
switch (c) {
case 'f':
/* TODO: do not accept for get/list */
*force = true;
break;
case 't':
type_str = optarg;
break;
default:
usage_unknown_option(cmd, argv);
}
}
if (name)
max_nonopt_args++;
if (value)
max_nonopt_args++;
if (check_argc_min(argc - optind, min_nonopt_args) ||
check_argc_max(argc - optind, max_nonopt_args))
return 1;
*types = 0;
if (type_str) {
if (!strcmp(type_str, "s") || !strcmp(type_str, "subvol")) {
*types = prop_object_subvol;
} else if (!strcmp(type_str, "f") ||
!strcmp(type_str, "filesystem")) {
*types = prop_object_root;
} else if (!strcmp(type_str, "i") ||
!strcmp(type_str, "inode")) {
*types = prop_object_inode;
} else if (!strcmp(type_str, "d") ||
!strcmp(type_str, "device")) {
*types = prop_object_dev;
} else {
error("invalid object type: %s", type_str);
return 1;
}
}
*object = argv[optind++];
if (optind < argc)
*name = argv[optind++];
if (optind < argc)
*value = argv[optind++];
if (!*types) {
ret = autodetect_object_types(*object, types);
if (ret < 0) {
errno = -ret;
error("failed to detect object type: %m");
return 1;
}
if (!*types) {
error("object is not a btrfs object: %s", *object);
return 1;
}
}
return 0;
}
static const char * const cmd_property_get_usage[] = {
"btrfs property get [-t <type>] <object> [<name>]",
"Get a property value of a btrfs object",
"Get a property value of a btrfs object. If no name is specified, all",
"properties for the given object are printed.",
"A filesystem object can be the filesystem itself, a subvolume,",
"an inode or a device. The option -t can be used to explicitly",
"specify what type of object you meant. This is only needed when a",
"property could be set for more than one object type.",
"",
"Possible values for type are: inode, subvol, filesystem, device.",
"They can be abbreviated to the first letter, i/s/f/d",
"",
OPTLINE("-t <TYPE>", "list properties for the given object type (inode, subvol, filesystem, device)"),
NULL
};
static int cmd_property_get(const struct cmd_struct *cmd,
int argc, char **argv)
{
int ret;
char *object = NULL;
char *name = NULL;
int types = 0;
bool force;
if (parse_args(cmd, argc, argv, &types, &object, &name, NULL, 1, &force))
return 1;
if (name)
ret = setget_prop(types, object, name, NULL, force);
else
ret = dump_props(types, object, 0);
return ret;
}
static DEFINE_SIMPLE_COMMAND(property_get, "get");
static const char * const cmd_property_set_usage[] = {
"btrfs property set [-f] [-t <type>] <object> <name> <value>",
"Set a property on a btrfs object",
"Set a property on a btrfs object where object is a path to file or",
"directory and can also represent the filesystem or device based on the type",
"",
OPTLINE("-t <TYPE>", "list properties for the given object type (inode, subvol, filesystem, device)"),
OPTLINE("-f", "force the change, could potentially break something"),
NULL
};
static int cmd_property_set(const struct cmd_struct *cmd,
int argc, char **argv)
{
int ret;
char *object = NULL;
char *name = NULL;
char *value = NULL;
int types = 0;
bool force = false;
if (parse_args(cmd, argc, argv, &types, &object, &name, &value, 3, &force))
return 1;
ret = setget_prop(types, object, name, value, force);
return ret;
}
static DEFINE_SIMPLE_COMMAND(property_set, "set");
static const char * const cmd_property_list_usage[] = {
"btrfs property list [-t <type>] <object>",
"Lists available properties with their descriptions for the given object",
"Lists available properties with their descriptions for the given object",
"See the help of 'btrfs property get' for a description of",
"objects and object types.",
"",
OPTLINE("-t <TYPE>", "list properties for the given object type (inode, subvol, filesystem, device)"),
NULL
};
static int cmd_property_list(const struct cmd_struct *cmd,
int argc, char **argv)
{
int ret;
char *object = NULL;
int types = 0;
bool force;
if (parse_args(cmd, argc, argv, &types, &object, NULL, NULL, 1, &force))
return 1;
ret = dump_props(types, object, 1);
return ret;
}
static DEFINE_SIMPLE_COMMAND(property_list, "list");
static const char property_cmd_group_info[] =
"modify properties of filesystem objects";
static const struct cmd_group property_cmd_group = {
property_cmd_group_usage, property_cmd_group_info, {
&cmd_struct_property_get,
&cmd_struct_property_set,
&cmd_struct_property_list,
NULL
}
};
DEFINE_GROUP_COMMAND_TOKEN(property);
|