2 * Authors: Kent Overstreet <kmo@daterainc.com>
3 * Gabriel de Perthuis <g2p.code@gmail.com>
4 * Jacob Malevich <jam@datera.io>
9 #include <nih/option.h>
10 #include <nih/command.h>
12 #include <nih/logging.h>
26 #include <sys/ioctl.h>
27 #include <sys/types.h>
29 #include <uuid/uuid.h>
31 #include <bcache.h> //libbcache
33 #define PACKAGE_NAME "bcacheadm"
34 #define PACKAGE_VERSION "1.0"
35 #define PACKAGE_BUGREPORT "bugreport"
39 /* make-bcache globals */
42 char *cache_devices[MAX_DEVS];
43 int tier_mapping[MAX_DEVS];
44 unsigned replacement_policy_mapping[MAX_DEVS];
45 char *backing_devices[MAX_DEVS];
46 char *backing_dev_labels[MAX_DEVS];
47 size_t i, nr_backing_devices = 0, nr_cache_devices = 0;
48 unsigned block_size = 0;
49 unsigned bucket_sizes[MAX_DEVS];
50 int num_bucket_sizes = 0;
51 int writeback = 0, writearound = 0, discard = 0, wipe_bcache = 0;
52 unsigned replication_set = 0;
53 char *replacement_policy = 0;
54 uint64_t data_offset = BDEV_DATA_START_DEFAULT;
56 struct cache_sb *cache_set_sb = NULL;
57 const char *cache_set_uuid = 0;
58 const char *csum_type = 0;
59 char *metadata_replicas = 0;
60 char *data_replicas = 0;
64 bool force_remove = false;
67 bool modify_list_attrs = false;
68 static const char *modify_set_uuid = NULL;
69 static const char *modify_dev_uuid = NULL;
71 /* query-dev globals */
72 bool force_csum = false;
73 bool uuid_only = false;
74 bool query_brief = false;
80 char *cset_dir = "/sys/fs/bcache";
81 bool list_devs = false;
84 bool status_all = false;
86 /* capacity globals */
87 static const char *capacity_uuid = NULL;
88 bool capacity_devs = false;
91 bool stats_all = false;
92 bool stats_list = false;
93 static const char *stats_uuid = NULL;
94 static const char *stats_dev_uuid = NULL;
95 static const char *stats_cache_num = NULL;
96 bool stats_five_min = false;
97 bool stats_hour = false;
98 bool stats_day = false;
99 bool stats_total = false;
101 /* set_failed globals */
102 static const char *dev_failed_uuid = NULL;
104 /* make-bcache option setters */
105 static int set_block_size(NihOption *option, const char *arg)
107 block_size = hatoi_validate(arg, "block size");
111 static int set_cache(NihOption *option, const char *arg)
114 cache_devices[nr_cache_devices] = strdup(arg);
116 tier_mapping[nr_cache_devices] = 0;
118 int ntier = atoi(tier);
119 if(ntier == 0 || ntier == 1)
120 tier_mapping[nr_cache_devices] = ntier;
122 printf("Invalid tier %s\n", tier);
125 if (!replacement_policy)
126 replacement_policy_mapping[nr_cache_devices] = 0;
130 while (replacement_policies[i] != NULL) {
131 if (!strcmp(replacement_policy,
132 replacement_policies[i])) {
133 replacement_policy_mapping[nr_cache_devices] = i;
139 if (replacement_policies[i] == NULL)
140 printf("Invalid replacement policy: %s\n",
150 static int set_bdev(NihOption *option, const char *arg)
155 backing_dev_labels[nr_backing_devices] = strdup(label);
157 backing_devices[nr_backing_devices] = strdup(arg);
159 nr_backing_devices++;
165 static int set_bucket_sizes(NihOption *option, const char *arg)
167 bucket_sizes[num_bucket_sizes]=hatoi_validate(arg, "bucket size");
173 static int set_udev(NihOption *option, const char *arg)
175 if (strcmp("udev", arg)) {
176 printf("Invalid output format %s\n", arg);
185 static NihOption make_bcache_options[] = {
186 // {int shortoption, char* longoption, char* help, NihOptionGroup, char* argname, void *value, NihOptionSetter}
187 {'C', "cache", N_("Format a cache device"), NULL, "dev", NULL, set_cache},
188 {'B', "bdev", N_("Format a backing device"), NULL, "dev", NULL, set_bdev},
189 {'l', "label", N_("label"), NULL, "label", &label, NULL},
190 //Only one bucket_size supported until a list of bucket sizes is parsed correctly
191 {'b', "bucket", N_("bucket size"), NULL, "size", NULL, set_bucket_sizes},
192 //Does the default setter automatically convert strings to an int?
193 {'w', "block", N_("block size (hard sector size of SSD, often 2k"), NULL,"size", NULL, set_block_size},
194 {'t', "tier", N_("tier of subsequent devices"), NULL,"#", &tier, NULL},
195 {'p', "cache_replacement_policy", N_("one of (lru|fifo|random)"), NULL,"policy", &replacement_policy, NULL},
196 {'o', "data_offset", N_("data offset in sectors"), NULL,"offset", &data_offset, NULL},
198 {0, "cset-uuid", N_("UUID for the cache set"), NULL, "uuid", &cache_set_uuid, NULL},
199 {0, "csum-type", N_("One of (none|crc32c|crc64)"), NULL, "type", &csum_type, NULL },
200 {0, "replication-set",N_("replication set of subsequent devices"), NULL, NULL, &replication_set, NULL },
201 {0, "meta-replicas",N_("number of metadata replicas"), NULL, "#", &metadata_replicas, NULL},
202 {0, "data-replicas",N_("number of data replicas"), NULL, "#", &data_replicas, NULL },
204 {0, "wipe-bcache", N_("destroy existing bcache data if present"), NULL, NULL, &wipe_bcache, NULL},
205 {0, "discard", N_("enable discards"), NULL, NULL, &discard, NULL},
206 {0, "writeback", N_("enable writeback"), NULL, NULL, &writeback, NULL},
207 {0, "writearound", N_("enable writearound"), NULL, NULL, &writearound, NULL},
212 static NihOption probe_bcache_options[] = {
213 {'o', "udev", N_("udev"), NULL, NULL, NULL, set_udev},
217 static NihOption bcache_register_options[] = {
221 static NihOption bcache_unregister_options[] = {
225 static NihOption bcache_add_device_options[] = {
229 static NihOption bcache_rm_device_options[] = {
230 {'f', "force", N_("force cache removal"), NULL, NULL, &force_remove, NULL},
234 static NihOption bcache_modify_options[] = {
235 {'l', "list", N_("list attributes"), NULL, NULL, &modify_list_attrs, NULL},
236 {'u', "set", N_("cacheset uuid"), NULL, "UUID", &modify_set_uuid, NULL},
237 {'d', "dev", N_("device uuid"), NULL, "UUID", &modify_dev_uuid, NULL},
241 static NihOption query_devs_options[] = {
242 {'f', "force_csum", N_("force_csum"), NULL, NULL, &force_csum, NULL},
243 {'u', "uuid-only", N_("only print out the uuid for the devices, not the whole superblock"), NULL, NULL, &uuid_only, NULL},
244 {'b', "brief", N_("only print out the cluster,server,and disk uuids"), NULL, NULL, &query_brief, NULL},
248 static NihOption list_cachesets_options[] = {
249 {'d', "dir", N_("directory"), NULL, NULL, &cset_dir, NULL},
250 {0, "list-devs", N_("list all devices in the cache sets as well"), NULL, NULL, &list_devs, NULL},
254 static NihOption status_options[] = {
255 {'a', "all", N_("all"), NULL, NULL, &status_all, NULL},
259 static NihOption capacity_options[] = {
260 {'u', "set", N_("cache_set UUID"), NULL, "UUID", &capacity_uuid, NULL},
261 {'d', "devs", N_("dev UUID"), NULL, NULL, &capacity_devs, NULL},
265 static NihOption stats_options[] = {
266 {'a', "all", N_("all"), NULL, NULL, &stats_all, NULL},
267 {'l', "list", N_("list"), NULL, NULL, &stats_list, NULL},
268 {'u', "set", N_("cache_set UUID"), NULL, "UUID", &stats_uuid, NULL},
269 {'d', "dev", N_("dev UUID"), NULL, "UUID", &stats_dev_uuid, NULL},
270 {'c', "cache", N_("cache number (starts from 0)"), NULL, "CACHE#", &stats_cache_num, NULL},
271 {0, "five-min-stats", N_("stats accumulated in last 5 minutes"), NULL, NULL, &stats_five_min, NULL},
272 {0, "hour-stats", N_("stats accumulated in last hour"), NULL, NULL, &stats_hour, NULL},
273 {0, "day-stats", N_("stats accumulated in last day"), NULL, NULL, &stats_day, NULL},
274 {0, "total-stats", N_("stats accumulated in total"), NULL, NULL, &stats_total, NULL},
278 static NihOption set_failed_options[] = {
279 {'d', "dev", N_("dev UUID"), NULL, "UUID", &dev_failed_uuid, NULL},
283 static NihOption options[] = {
289 int make_bcache(NihCommand *command, char *const *args)
291 int cache_dev_fd[devs];
293 int backing_dev_fd[devs];
297 cache_set_sb = calloc(1, sizeof(*cache_set_sb) +
298 sizeof(struct cache_member) * devs);
300 uuid_generate(cache_set_sb->set_uuid.b);
302 if (cache_set_uuid) {
303 if(uuid_parse(cache_set_uuid, cache_set_sb->user_uuid.b)) {
304 fprintf(stderr, "Bad uuid\n");
308 uuid_generate(cache_set_sb->user_uuid.b);
312 memcpy(cache_set_sb->label, label, sizeof(cache_set_sb->label));
315 SET_CACHE_PREFERRED_CSUM_TYPE(cache_set_sb,
316 read_string_list_or_die(csum_type, csum_types,
319 SET_CACHE_PREFERRED_CSUM_TYPE(cache_set_sb, BCH_CSUM_CRC32C);
322 if (metadata_replicas) {
323 SET_CACHE_SET_META_REPLICAS_WANT(cache_set_sb,
324 strtoul_or_die(metadata_replicas,
325 CACHE_SET_META_REPLICAS_WANT_MAX,
328 SET_CACHE_SET_META_REPLICAS_WANT(cache_set_sb, 1);
332 SET_CACHE_SET_DATA_REPLICAS_WANT(cache_set_sb,
333 strtoul_or_die(data_replicas,
334 CACHE_SET_DATA_REPLICAS_WANT_MAX,
337 SET_CACHE_SET_DATA_REPLICAS_WANT(cache_set_sb, 1);
341 fprintf(stderr, "Please specify -C or -B\n");
345 if (!bucket_sizes[0])
346 bucket_sizes[0] = 1024;
348 for (i = 0; i < nr_cache_devices; i++)
349 next_cache_device(cache_set_sb,
352 replacement_policy_mapping[i],
355 if (!cache_set_sb->nr_in_set && !nr_backing_devices) {
356 fprintf(stderr, "Please supply a device\n");
362 if (bucket_sizes[i] < block_size) {
364 "Bucket size cannot be smaller than block size\n");
368 } while (i < num_bucket_sizes);
371 for (i = 0; i < cache_set_sb->nr_in_set; i++)
372 block_size = max(block_size,
373 get_blocksize(cache_devices[i]));
375 for (i = 0; i < nr_backing_devices; i++)
376 block_size = max(block_size,
377 get_blocksize(backing_devices[i]));
380 for (i = 0; i < cache_set_sb->nr_in_set; i++)
381 cache_dev_fd[i] = dev_open(cache_devices[i], wipe_bcache);
383 for (i = 0; i < nr_backing_devices; i++)
384 backing_dev_fd[i] = dev_open(backing_devices[i], wipe_bcache);
386 write_cache_sbs(cache_dev_fd, cache_set_sb, block_size,
387 bucket_sizes, num_bucket_sizes);
390 cache_mode = CACHE_MODE_WRITEBACK;
391 else if (writearound)
392 cache_mode = CACHE_MODE_WRITEAROUND;
394 cache_mode = CACHE_MODE_WRITETHROUGH;
396 for (i = 0; i < nr_backing_devices; i++)
397 write_backingdev_sb(backing_dev_fd[i],
398 block_size, bucket_sizes,
399 cache_mode, data_offset,
400 backing_dev_labels[i],
401 cache_set_sb->user_uuid,
402 cache_set_sb->set_uuid);
408 int probe_bcache(NihCommand *command, char *const *args)
413 for (i = 0; args[i] != NULL; i++) {
414 err = probe(args[i], udev);
416 printf("probe_bcache error: %s\n", err);
424 int bcache_register(NihCommand *command, char *const *args)
428 err = register_bcache(args);
430 printf("bcache_register error: %s\n", err);
437 int bcache_unregister(NihCommand *command, char *const *args)
441 err = unregister_bcache(args);
443 printf("bcache_unregister error: %s\n", err);
450 int bcache_add_devices(NihCommand *command, char *const *args)
454 err = add_devices(args);
456 printf("bcache_add_devices error: %s\n", err);
463 int bcache_rm_device(NihCommand *command, char *const *args)
467 err = remove_device(args[0], force_remove);
469 printf("bcache_rm_devices error: %s\n", err);
476 int bcache_modify(NihCommand *command, char *const *args)
480 char *attr = args[0];
484 if (modify_list_attrs) {
489 if (!modify_set_uuid) {
490 printf("Must provide a cacheset uuid\n");
494 snprintf(path, MAX_PATH, "%s/%s", cset_dir, modify_set_uuid);
497 printf("Must provide the name of an attribute to modify\n");
501 enum sysfs_attr type = sysfs_attr_type(attr);
505 else if(type == INTERNAL_ATTR)
506 strcat(path, "/internal");
507 else if(type == CACHE_ATTR) {
508 if(modify_dev_uuid) {
509 /* searches all cache# for a matching uuid,
510 * path gets modified to the correct cache path */
511 char subdir[10] = "/cache";
512 err = find_matching_uuid(path, subdir,
515 printf("Failed to find "
516 "matching dev %s\n", err);
519 strcat(path, subdir);
522 printf("Must provide a device uuid\n");
525 /* SET_ATTRs are just in the current dir */
532 printf("Must provide a value to change the attribute to\n");
536 fd = open(path, O_WRONLY);
538 printf("Unable to open modify attr with path %s\n", path);
542 write(fd, val, strlen(val));
550 int bcache_list_cachesets(NihCommand *command, char *const *args)
553 err = list_cachesets(cset_dir, list_devs);
555 printf("bcache_list_cachesets error :%s\n", err);
562 int bcache_query_devs(NihCommand *command, char *const *args)
567 printf("%-10s%-40s%-40s%-40s\n", "dev name", "disk uuid",
568 "server uuid", "cluster uuid");
570 for (i = 0; args[i] != NULL; i++) {
572 struct cache_sb *sb = query_dev(args[i], force_csum,
573 !query_brief, uuid_only, dev_uuid);
576 printf("error opening the superblock for %s\n",
582 printf("%s\n", dev_uuid);
583 } else if (query_brief) {
584 char set_uuid_str[40], dev_uuid_str[40];
585 char *clus_uuid = (char *)sb->label;
587 uuid_unparse(sb->set_uuid.b, set_uuid_str);
588 uuid_unparse(sb->disk_uuid.b, dev_uuid_str);
589 if (!strcmp(clus_uuid, ""))
592 printf("%-10s%-40s%-40s%-40s\n", args[i],
603 int bcache_status(NihCommand *command, char *const *args)
605 int i, dev_count = 0, seq;
606 struct cache_sb *seq_sb = NULL;
607 char cache_path[MAX_PATH];
608 char *dev_names[MAX_DEVS];
609 char *dev_uuids[MAX_DEVS];
613 for (i = 0; args[i] != NULL; i++) {
614 struct cache_sb *sb = query_dev(args[i], false, false,
618 printf("Unable to open superblock, bad path\n");
622 if (!seq_sb || sb->seq > seq) {
630 printf("Unable to find a superblock\n");
633 uuid_unparse(seq_sb->set_uuid.b, set_uuid);
634 printf("%-50s%-15s%-4s\n", "uuid", "state", "tier");
637 snprintf(intbuf, 4, "%d", i);
638 snprintf(cache_path, MAX_PATH, "%s/%s/%s", cset_dir, set_uuid,
642 * Get a list of all the devices from sysfs first, then
643 * compare it to the list we get back from the most up
644 * to date superblock. If there are any devices in the superblock
645 * that are not in sysfs, print out 'NOT PRESENT'
652 if(((cache_dir = opendir(cache_path)) == NULL) &&
653 dev_count < MAX_DEVS)
656 if((len = readlink(cache_path, buf, sizeof(buf) - 1)) != -1) {
662 dev_names[dev_count] = dev_name(buf);
663 snprintf(dev_path, MAX_PATH, "%s/%s", "/dev",
664 dev_names[dev_count]);
665 sb = query_dev(dev_path, false, false,
668 printf("error reading %s\n", dev_path);
673 dev_uuids[dev_count] = strdup(dev_uuid);
675 dev_uuids[dev_count] = strdup("Nothing");
676 dev_names[dev_count] = strdup("Nothing");
679 cache_path[strlen(cache_path) - strlen(intbuf)] = 0;
682 snprintf(intbuf, 4, "%d", dev_count);
683 strcat(cache_path, intbuf);
686 for (i = 0; i < seq_sb->nr_in_set; i++) {
688 struct cache_member *m = seq_sb->members + i;
692 uuid_unparse(m->uuid.b, uuid_str);
694 for (j = 0; j < dev_count; j++) {
695 if (!strcmp(uuid_str, dev_uuids[j])) {
696 snprintf(dev_state, MAX_PATH, "%s",
697 cache_state[CACHE_STATE(m)]);
699 } else if (j == dev_count - 1) {
700 if (!strcmp(cache_state[CACHE_STATE(m)], "active"))
701 snprintf(dev_state, MAX_PATH, "%s", "missing");
703 snprintf(dev_state, MAX_PATH, "%s",
704 cache_state[CACHE_STATE(m)]);
709 printf("%-50s%-15s%-4llu\n", uuid_str, dev_state,
715 for (i = 0; i < dev_count; i++) {
723 int bcache_capacity(NihCommand *command, char *const *args)
725 char *err = "Must provide a cacheset uuid";
729 err = bcache_get_capacity(cset_dir, capacity_uuid, capacity_devs);
736 printf("bcache_capacity failed with error: %s\n", err);
741 static char *stats_subdir(char* stats_dir)
746 strcat(tmp, "cache");
747 err = find_matching_uuid(stats_dir, tmp, stats_dev_uuid);
750 } else if(stats_cache_num) {
751 strcat(tmp, "cache");
752 strcat(tmp, stats_cache_num);
753 } else if (stats_five_min)
754 strcat(tmp, "stats_five_minute");
756 strcat(tmp, "stats_hour");
758 strcat(tmp, "stats_day");
759 else if (stats_total)
760 strcat(tmp, "stats_total");
764 strcat(stats_dir, tmp);
770 int bcache_stats(NihCommand *command, char *const *args)
773 char stats_dir[MAX_PATH];
775 struct dirent *ent = NULL;
780 snprintf(stats_dir, MAX_PATH, "%s/%s", cset_dir, stats_uuid);
781 err = stats_subdir(stats_dir);
785 dir = opendir(stats_dir);
787 err = "Failed to open dir";
791 err = "Must provide a cacheset uuid";
795 if(stats_list || stats_all) {
796 while ((ent = readdir(dir)) != NULL) {
797 err = read_stat_dir(dir, stats_dir, ent->d_name, buf);
801 printf("%s\n", ent->d_name);
803 printf("\t%s\n", buf);
807 for (i = 0; args[i] != NULL; i++) {
808 err = read_stat_dir(dir, stats_dir, args[i], buf);
819 printf("bcache_stats error: %s\n", err);
823 int bcache_set_failed(NihCommand *command, char *const *args)
827 if (!dev_failed_uuid) {
828 printf("Pass in a dev uuid\n");
832 err = device_set_failed(dev_failed_uuid);
834 printf("bcache_set_failed_ioctl error: %s\n", err);
841 static NihCommand commands[] = {
842 {"format", N_("format <list of drives>"),
843 "Format one or a list of devices with bcache datastructures."
844 " You need to do this before you create a volume",
845 N_("format drive[s] with bcache"),
846 NULL, make_bcache_options, make_bcache},
847 {"probe", N_("probe <list of devices>"),
848 "Does a blkid_probe on a device",
849 N_("Does a blkid_probe on a device"),
850 NULL, probe_bcache_options, probe_bcache},
851 {"register", N_("register <list of devices>"),
852 "Registers a list of devices",
853 N_("Registers a list of devices"),
854 NULL, bcache_register_options, bcache_register},
855 {"unregister", N_("unregister <list of devices>"),
856 "Unregisters a list of devices",
857 N_("Unregisters a list of devices"),
858 NULL, bcache_unregister_options, bcache_unregister},
859 {"add-devs", N_("add-devs --tier=# <list of devices>"),
860 "Adds a list of devices to a cacheset",
861 N_("Adds a list of devices to a cacheset"),
862 NULL, bcache_add_device_options, bcache_add_devices},
863 {"rm-dev", N_("rm-dev <dev>"),
864 "Removes a device from its cacheset",
865 N_("Removes a device from its cacheset"),
866 NULL, bcache_rm_device_options, bcache_rm_device},
867 {"modify", N_("modify --set=UUID (dev=UUID) name value"),
868 "Modifies attributes related to the cacheset",
869 N_("Modifies attributes related to the cacheset"),
870 NULL, bcache_modify_options, bcache_modify},
871 {"list-cachesets", N_("list-cachesets"),
872 "Lists cachesets in /sys/fs/bcache",
873 N_("Lists cachesets in /sys/fs/bcache"),
874 NULL, list_cachesets_options, bcache_list_cachesets},
875 {"query-devs", N_("query <list of devices>"),
876 "Gives info about the superblock of a list of devices",
877 N_("show superblock on each of the listed drive"),
878 NULL, query_devs_options, bcache_query_devs},
879 {"status", N_("status <list of devices>"),
880 "Finds the status of the most up to date superblock",
881 N_("Finds the status of the most up to date superblock"),
882 NULL, status_options, bcache_status},
883 {"capacity", N_("capacity --set=UUID"),
884 "Shows the capacity of the cacheset",
885 N_("Shows the capacity of the cacheset"),
886 NULL, capacity_options, bcache_capacity},
887 {"stats", N_("stats <list of devices>"),
888 "List various bcache statistics",
889 N_("List various bcache statistics"),
890 NULL, stats_options, bcache_stats},
891 {"set-failed", N_("set-failed --dev=UUID"),
892 "Sets a device to the FAILED state",
893 N_("Sets a device to the FAILED state"),
894 NULL, set_failed_options, bcache_set_failed},
899 int main(int argc, char *argv[])
902 nih_main_init (argv[0]);
904 nih_option_set_synopsis (_("Manage bcache devices"));
905 nih_option_set_help (
906 _("Helps you manage bcache devices"));
908 ret = nih_command_parser (NULL, argc, argv, options, commands);