blob: 55673508628f85d102fb9a8b012d7d5c21214362 [file] [log] [blame]
Greg Kroah-Hartmanb2441312017-11-01 15:07:57 +01001// SPDX-License-Identifier: GPL-2.0
Kent Overstreetcafe5632013-03-23 16:11:31 -07002/*
3 * bcache sysfs interfaces
4 *
5 * Copyright 2010, 2011 Kent Overstreet <kent.overstreet@gmail.com>
6 * Copyright 2012 Google, Inc.
7 */
8
9#include "bcache.h"
10#include "sysfs.h"
11#include "btree.h"
12#include "request.h"
Kent Overstreet279afba2013-06-05 06:21:07 -070013#include "writeback.h"
Kent Overstreetcafe5632013-03-23 16:11:31 -070014
Kent Overstreetc37511b2013-04-26 15:39:55 -070015#include <linux/blkdev.h>
Kent Overstreetcafe5632013-03-23 16:11:31 -070016#include <linux/sort.h>
Ingo Molnare6017572017-02-01 16:36:40 +010017#include <linux/sched/clock.h>
Kent Overstreetcafe5632013-03-23 16:11:31 -070018
19static const char * const cache_replacement_policies[] = {
20 "lru",
21 "fifo",
22 "random",
23 NULL
24};
25
Kent Overstreet77c320e2013-07-11 19:42:51 -070026static const char * const error_actions[] = {
27 "unregister",
28 "panic",
29 NULL
30};
31
Kent Overstreetcafe5632013-03-23 16:11:31 -070032write_attribute(attach);
33write_attribute(detach);
34write_attribute(unregister);
35write_attribute(stop);
36write_attribute(clear_stats);
37write_attribute(trigger_gc);
38write_attribute(prune_cache);
39write_attribute(flash_vol_create);
40
41read_attribute(bucket_size);
42read_attribute(block_size);
43read_attribute(nbuckets);
44read_attribute(tree_depth);
45read_attribute(root_usage_percent);
46read_attribute(priority_stats);
47read_attribute(btree_cache_size);
48read_attribute(btree_cache_max_chain);
49read_attribute(cache_available_percent);
50read_attribute(written);
51read_attribute(btree_written);
52read_attribute(metadata_written);
53read_attribute(active_journal_entries);
54
55sysfs_time_stats_attribute(btree_gc, sec, ms);
56sysfs_time_stats_attribute(btree_split, sec, us);
57sysfs_time_stats_attribute(btree_sort, ms, us);
58sysfs_time_stats_attribute(btree_read, ms, us);
Kent Overstreetcafe5632013-03-23 16:11:31 -070059
60read_attribute(btree_nodes);
61read_attribute(btree_used_percent);
62read_attribute(average_key_size);
63read_attribute(dirty_data);
64read_attribute(bset_tree_stats);
65
66read_attribute(state);
67read_attribute(cache_read_races);
Tang Junhuia728eac2018-02-07 11:41:39 -080068read_attribute(reclaim);
69read_attribute(flush_write);
70read_attribute(retry_flush_write);
Kent Overstreetcafe5632013-03-23 16:11:31 -070071read_attribute(writeback_keys_done);
72read_attribute(writeback_keys_failed);
73read_attribute(io_errors);
74read_attribute(congested);
75rw_attribute(congested_read_threshold_us);
76rw_attribute(congested_write_threshold_us);
77
78rw_attribute(sequential_cutoff);
Kent Overstreetcafe5632013-03-23 16:11:31 -070079rw_attribute(data_csum);
80rw_attribute(cache_mode);
81rw_attribute(writeback_metadata);
82rw_attribute(writeback_running);
83rw_attribute(writeback_percent);
84rw_attribute(writeback_delay);
85rw_attribute(writeback_rate);
86
87rw_attribute(writeback_rate_update_seconds);
Michael Lyle1d316e62017-10-13 16:35:36 -070088rw_attribute(writeback_rate_i_term_inverse);
Kent Overstreetcafe5632013-03-23 16:11:31 -070089rw_attribute(writeback_rate_p_term_inverse);
Michael Lyle1d316e62017-10-13 16:35:36 -070090rw_attribute(writeback_rate_minimum);
Kent Overstreetcafe5632013-03-23 16:11:31 -070091read_attribute(writeback_rate_debug);
92
Kent Overstreet72c27062013-06-05 06:24:39 -070093read_attribute(stripe_size);
94read_attribute(partial_stripes_expensive);
95
Kent Overstreetcafe5632013-03-23 16:11:31 -070096rw_attribute(synchronous);
97rw_attribute(journal_delay_ms);
98rw_attribute(discard);
99rw_attribute(running);
100rw_attribute(label);
101rw_attribute(readahead);
Kent Overstreet77c320e2013-07-11 19:42:51 -0700102rw_attribute(errors);
Kent Overstreetcafe5632013-03-23 16:11:31 -0700103rw_attribute(io_error_limit);
104rw_attribute(io_error_halflife);
105rw_attribute(verify);
Kent Overstreet5ceaaad2013-09-10 14:27:42 -0700106rw_attribute(bypass_torture_test);
Kent Overstreetcafe5632013-03-23 16:11:31 -0700107rw_attribute(key_merging_disabled);
108rw_attribute(gc_always_rewrite);
Kent Overstreet280481d2013-10-24 16:36:03 -0700109rw_attribute(expensive_debug_checks);
Kent Overstreetcafe5632013-03-23 16:11:31 -0700110rw_attribute(cache_replacement_policy);
111rw_attribute(btree_shrinker_disabled);
112rw_attribute(copy_gc_enabled);
113rw_attribute(size);
114
115SHOW(__bch_cached_dev)
116{
117 struct cached_dev *dc = container_of(kobj, struct cached_dev,
118 disk.kobj);
119 const char *states[] = { "no cache", "clean", "dirty", "inconsistent" };
120
121#define var(stat) (dc->stat)
122
123 if (attr == &sysfs_cache_mode)
Kent Overstreet169ef1c2013-03-28 12:50:55 -0600124 return bch_snprint_string_list(buf, PAGE_SIZE,
125 bch_cache_modes + 1,
126 BDEV_CACHE_MODE(&dc->sb));
Kent Overstreetcafe5632013-03-23 16:11:31 -0700127
128 sysfs_printf(data_csum, "%i", dc->disk.data_csum);
129 var_printf(verify, "%i");
Kent Overstreet5ceaaad2013-09-10 14:27:42 -0700130 var_printf(bypass_torture_test, "%i");
Kent Overstreetcafe5632013-03-23 16:11:31 -0700131 var_printf(writeback_metadata, "%i");
132 var_printf(writeback_running, "%i");
133 var_print(writeback_delay);
134 var_print(writeback_percent);
Kent Overstreet16749c22013-11-11 13:58:34 -0800135 sysfs_hprint(writeback_rate, dc->writeback_rate.rate << 9);
Kent Overstreetcafe5632013-03-23 16:11:31 -0700136
137 var_print(writeback_rate_update_seconds);
Michael Lyle1d316e62017-10-13 16:35:36 -0700138 var_print(writeback_rate_i_term_inverse);
Kent Overstreetcafe5632013-03-23 16:11:31 -0700139 var_print(writeback_rate_p_term_inverse);
Michael Lyle1d316e62017-10-13 16:35:36 -0700140 var_print(writeback_rate_minimum);
Kent Overstreetcafe5632013-03-23 16:11:31 -0700141
142 if (attr == &sysfs_writeback_rate_debug) {
Kent Overstreet16749c22013-11-11 13:58:34 -0800143 char rate[20];
Kent Overstreetcafe5632013-03-23 16:11:31 -0700144 char dirty[20];
Kent Overstreetcafe5632013-03-23 16:11:31 -0700145 char target[20];
Kent Overstreet16749c22013-11-11 13:58:34 -0800146 char proportional[20];
Michael Lyle1d316e62017-10-13 16:35:36 -0700147 char integral[20];
Kent Overstreet16749c22013-11-11 13:58:34 -0800148 char change[20];
149 s64 next_io;
150
151 bch_hprint(rate, dc->writeback_rate.rate << 9);
152 bch_hprint(dirty, bcache_dev_sectors_dirty(&dc->disk) << 9);
Kent Overstreet169ef1c2013-03-28 12:50:55 -0600153 bch_hprint(target, dc->writeback_rate_target << 9);
Kent Overstreet16749c22013-11-11 13:58:34 -0800154 bch_hprint(proportional,dc->writeback_rate_proportional << 9);
Michael Lyle1d316e62017-10-13 16:35:36 -0700155 bch_hprint(integral, dc->writeback_rate_integral_scaled << 9);
Kent Overstreet16749c22013-11-11 13:58:34 -0800156 bch_hprint(change, dc->writeback_rate_change << 9);
157
158 next_io = div64_s64(dc->writeback_rate.next - local_clock(),
159 NSEC_PER_MSEC);
Kent Overstreetcafe5632013-03-23 16:11:31 -0700160
161 return sprintf(buf,
Kent Overstreet16749c22013-11-11 13:58:34 -0800162 "rate:\t\t%s/sec\n"
Kent Overstreetcafe5632013-03-23 16:11:31 -0700163 "dirty:\t\t%s\n"
Kent Overstreet16749c22013-11-11 13:58:34 -0800164 "target:\t\t%s\n"
165 "proportional:\t%s\n"
Michael Lyle1d316e62017-10-13 16:35:36 -0700166 "integral:\t%s\n"
Kent Overstreet16749c22013-11-11 13:58:34 -0800167 "change:\t\t%s/sec\n"
168 "next io:\t%llims\n",
169 rate, dirty, target, proportional,
Michael Lyle1d316e62017-10-13 16:35:36 -0700170 integral, change, next_io);
Kent Overstreetcafe5632013-03-23 16:11:31 -0700171 }
172
173 sysfs_hprint(dirty_data,
Kent Overstreet279afba2013-06-05 06:21:07 -0700174 bcache_dev_sectors_dirty(&dc->disk) << 9);
Kent Overstreetcafe5632013-03-23 16:11:31 -0700175
Kent Overstreet2d679fc2013-08-17 02:13:15 -0700176 sysfs_hprint(stripe_size, dc->disk.stripe_size << 9);
Kent Overstreet72c27062013-06-05 06:24:39 -0700177 var_printf(partial_stripes_expensive, "%u");
178
Kent Overstreetcafe5632013-03-23 16:11:31 -0700179 var_hprint(sequential_cutoff);
180 var_hprint(readahead);
181
182 sysfs_print(running, atomic_read(&dc->running));
183 sysfs_print(state, states[BDEV_STATE(&dc->sb)]);
184
185 if (attr == &sysfs_label) {
186 memcpy(buf, dc->sb.label, SB_LABEL_SIZE);
187 buf[SB_LABEL_SIZE + 1] = '\0';
188 strcat(buf, "\n");
189 return strlen(buf);
190 }
191
192#undef var
193 return 0;
194}
195SHOW_LOCKED(bch_cached_dev)
196
197STORE(__cached_dev)
198{
199 struct cached_dev *dc = container_of(kobj, struct cached_dev,
200 disk.kobj);
Tang Junhui7f4fc932018-02-07 11:41:45 -0800201 ssize_t v;
Kent Overstreetcafe5632013-03-23 16:11:31 -0700202 struct cache_set *c;
Gabriel de Perthuisab9e1402013-06-09 00:54:48 +0200203 struct kobj_uevent_env *env;
Kent Overstreetcafe5632013-03-23 16:11:31 -0700204
205#define d_strtoul(var) sysfs_strtoul(var, dc->var)
Kent Overstreet16749c22013-11-11 13:58:34 -0800206#define d_strtoul_nonzero(var) sysfs_strtoul_clamp(var, dc->var, 1, INT_MAX)
Kent Overstreetcafe5632013-03-23 16:11:31 -0700207#define d_strtoi_h(var) sysfs_hatoi(var, dc->var)
208
209 sysfs_strtoul(data_csum, dc->disk.data_csum);
210 d_strtoul(verify);
Kent Overstreet5ceaaad2013-09-10 14:27:42 -0700211 d_strtoul(bypass_torture_test);
Kent Overstreetcafe5632013-03-23 16:11:31 -0700212 d_strtoul(writeback_metadata);
213 d_strtoul(writeback_running);
214 d_strtoul(writeback_delay);
Kent Overstreet16749c22013-11-11 13:58:34 -0800215
Kent Overstreetcafe5632013-03-23 16:11:31 -0700216 sysfs_strtoul_clamp(writeback_percent, dc->writeback_percent, 0, 40);
217
Kent Overstreet16749c22013-11-11 13:58:34 -0800218 sysfs_strtoul_clamp(writeback_rate,
219 dc->writeback_rate.rate, 1, INT_MAX);
220
Coly Li7a5e3ec2018-02-07 11:41:44 -0800221 sysfs_strtoul_clamp(writeback_rate_update_seconds,
222 dc->writeback_rate_update_seconds,
223 1, WRITEBACK_RATE_UPDATE_SECS_MAX);
Michael Lyle1d316e62017-10-13 16:35:36 -0700224 d_strtoul(writeback_rate_i_term_inverse);
Kent Overstreet16749c22013-11-11 13:58:34 -0800225 d_strtoul_nonzero(writeback_rate_p_term_inverse);
Kent Overstreetcafe5632013-03-23 16:11:31 -0700226
Kent Overstreetcafe5632013-03-23 16:11:31 -0700227 d_strtoi_h(sequential_cutoff);
228 d_strtoi_h(readahead);
229
230 if (attr == &sysfs_clear_stats)
231 bch_cache_accounting_clear(&dc->accounting);
232
233 if (attr == &sysfs_running &&
234 strtoul_or_return(buf))
235 bch_cached_dev_run(dc);
236
237 if (attr == &sysfs_cache_mode) {
Tony Asleson77fa1002017-09-06 14:25:57 +0800238 v = bch_read_string_list(buf, bch_cache_modes + 1);
Kent Overstreetcafe5632013-03-23 16:11:31 -0700239
240 if (v < 0)
241 return v;
242
243 if ((unsigned) v != BDEV_CACHE_MODE(&dc->sb)) {
244 SET_BDEV_CACHE_MODE(&dc->sb, v);
245 bch_write_bdev_super(dc, NULL);
246 }
247 }
248
249 if (attr == &sysfs_label) {
Gabriel de Perthuisaee6f1c2013-09-23 23:17:28 -0700250 if (size > SB_LABEL_SIZE)
251 return -EINVAL;
252 memcpy(dc->sb.label, buf, size);
253 if (size < SB_LABEL_SIZE)
254 dc->sb.label[size] = '\0';
255 if (size && dc->sb.label[size - 1] == '\n')
256 dc->sb.label[size - 1] = '\0';
Kent Overstreetcafe5632013-03-23 16:11:31 -0700257 bch_write_bdev_super(dc, NULL);
258 if (dc->disk.c) {
259 memcpy(dc->disk.c->uuids[dc->disk.id].label,
260 buf, SB_LABEL_SIZE);
261 bch_uuid_write(dc->disk.c);
262 }
Gabriel de Perthuisab9e1402013-06-09 00:54:48 +0200263 env = kzalloc(sizeof(struct kobj_uevent_env), GFP_KERNEL);
Dan Carpenterd2a65ce2013-07-05 09:05:46 +0300264 if (!env)
265 return -ENOMEM;
Gabriel de Perthuisab9e1402013-06-09 00:54:48 +0200266 add_uevent_var(env, "DRIVER=bcache");
267 add_uevent_var(env, "CACHED_UUID=%pU", dc->sb.uuid),
268 add_uevent_var(env, "CACHED_LABEL=%s", buf);
269 kobject_uevent_env(
270 &disk_to_dev(dc->disk.disk)->kobj, KOBJ_CHANGE, env->envp);
271 kfree(env);
Kent Overstreetcafe5632013-03-23 16:11:31 -0700272 }
273
274 if (attr == &sysfs_attach) {
Tang Junhui73ac1052018-02-07 11:41:46 -0800275 uint8_t set_uuid[16];
276
277 if (bch_parse_uuid(buf, set_uuid) < 16)
Kent Overstreetcafe5632013-03-23 16:11:31 -0700278 return -EINVAL;
279
Tang Junhui7f4fc932018-02-07 11:41:45 -0800280 v = -ENOENT;
Kent Overstreetcafe5632013-03-23 16:11:31 -0700281 list_for_each_entry(c, &bch_cache_sets, list) {
Tang Junhui73ac1052018-02-07 11:41:46 -0800282 v = bch_cached_dev_attach(dc, c, set_uuid);
Kent Overstreetcafe5632013-03-23 16:11:31 -0700283 if (!v)
284 return size;
285 }
286
287 pr_err("Can't attach %s: cache set not found", buf);
Tang Junhui7f4fc932018-02-07 11:41:45 -0800288 return v;
Kent Overstreetcafe5632013-03-23 16:11:31 -0700289 }
290
291 if (attr == &sysfs_detach && dc->disk.c)
292 bch_cached_dev_detach(dc);
293
294 if (attr == &sysfs_stop)
295 bcache_device_stop(&dc->disk);
296
297 return size;
298}
299
300STORE(bch_cached_dev)
301{
302 struct cached_dev *dc = container_of(kobj, struct cached_dev,
303 disk.kobj);
304
305 mutex_lock(&bch_register_lock);
306 size = __cached_dev_store(kobj, attr, buf, size);
307
308 if (attr == &sysfs_writeback_running)
309 bch_writeback_queue(dc);
310
311 if (attr == &sysfs_writeback_percent)
Coly Li3fd47bf2018-03-18 17:36:16 -0700312 if (!test_and_set_bit(BCACHE_DEV_WB_RUNNING, &dc->disk.flags))
313 schedule_delayed_work(&dc->writeback_rate_update,
Kent Overstreetcafe5632013-03-23 16:11:31 -0700314 dc->writeback_rate_update_seconds * HZ);
315
316 mutex_unlock(&bch_register_lock);
317 return size;
318}
319
320static struct attribute *bch_cached_dev_files[] = {
321 &sysfs_attach,
322 &sysfs_detach,
323 &sysfs_stop,
324#if 0
325 &sysfs_data_csum,
326#endif
327 &sysfs_cache_mode,
328 &sysfs_writeback_metadata,
329 &sysfs_writeback_running,
330 &sysfs_writeback_delay,
331 &sysfs_writeback_percent,
332 &sysfs_writeback_rate,
333 &sysfs_writeback_rate_update_seconds,
Michael Lyle1d316e62017-10-13 16:35:36 -0700334 &sysfs_writeback_rate_i_term_inverse,
Kent Overstreetcafe5632013-03-23 16:11:31 -0700335 &sysfs_writeback_rate_p_term_inverse,
Kent Overstreetcafe5632013-03-23 16:11:31 -0700336 &sysfs_writeback_rate_debug,
337 &sysfs_dirty_data,
Kent Overstreet72c27062013-06-05 06:24:39 -0700338 &sysfs_stripe_size,
339 &sysfs_partial_stripes_expensive,
Kent Overstreetcafe5632013-03-23 16:11:31 -0700340 &sysfs_sequential_cutoff,
Kent Overstreetcafe5632013-03-23 16:11:31 -0700341 &sysfs_clear_stats,
342 &sysfs_running,
343 &sysfs_state,
344 &sysfs_label,
345 &sysfs_readahead,
346#ifdef CONFIG_BCACHE_DEBUG
347 &sysfs_verify,
Kent Overstreet5ceaaad2013-09-10 14:27:42 -0700348 &sysfs_bypass_torture_test,
Kent Overstreetcafe5632013-03-23 16:11:31 -0700349#endif
350 NULL
351};
352KTYPE(bch_cached_dev);
353
354SHOW(bch_flash_dev)
355{
356 struct bcache_device *d = container_of(kobj, struct bcache_device,
357 kobj);
358 struct uuid_entry *u = &d->c->uuids[d->id];
359
360 sysfs_printf(data_csum, "%i", d->data_csum);
361 sysfs_hprint(size, u->sectors << 9);
362
363 if (attr == &sysfs_label) {
364 memcpy(buf, u->label, SB_LABEL_SIZE);
365 buf[SB_LABEL_SIZE + 1] = '\0';
366 strcat(buf, "\n");
367 return strlen(buf);
368 }
369
370 return 0;
371}
372
373STORE(__bch_flash_dev)
374{
375 struct bcache_device *d = container_of(kobj, struct bcache_device,
376 kobj);
377 struct uuid_entry *u = &d->c->uuids[d->id];
378
379 sysfs_strtoul(data_csum, d->data_csum);
380
381 if (attr == &sysfs_size) {
382 uint64_t v;
383 strtoi_h_or_return(buf, v);
384
385 u->sectors = v >> 9;
386 bch_uuid_write(d->c);
387 set_capacity(d->disk, u->sectors);
388 }
389
390 if (attr == &sysfs_label) {
391 memcpy(u->label, buf, SB_LABEL_SIZE);
392 bch_uuid_write(d->c);
393 }
394
395 if (attr == &sysfs_unregister) {
Kent Overstreetc4d951d2013-08-21 17:49:09 -0700396 set_bit(BCACHE_DEV_DETACHING, &d->flags);
Kent Overstreetcafe5632013-03-23 16:11:31 -0700397 bcache_device_stop(d);
398 }
399
400 return size;
401}
402STORE_LOCKED(bch_flash_dev)
403
404static struct attribute *bch_flash_dev_files[] = {
405 &sysfs_unregister,
406#if 0
407 &sysfs_data_csum,
408#endif
409 &sysfs_label,
410 &sysfs_size,
411 NULL
412};
413KTYPE(bch_flash_dev);
414
Kent Overstreetf67342d2013-11-11 19:25:55 -0800415struct bset_stats_op {
416 struct btree_op op;
417 size_t nodes;
418 struct bset_stats stats;
419};
420
John Sheucb851142014-03-17 23:13:56 -0700421static int bch_btree_bset_stats(struct btree_op *b_op, struct btree *b)
Kent Overstreetf67342d2013-11-11 19:25:55 -0800422{
423 struct bset_stats_op *op = container_of(b_op, struct bset_stats_op, op);
424
425 op->nodes++;
426 bch_btree_keys_stats(&b->keys, &op->stats);
427
428 return MAP_CONTINUE;
429}
430
Kent Overstreet35723242014-01-10 18:53:02 -0800431static int bch_bset_print_stats(struct cache_set *c, char *buf)
Kent Overstreetf67342d2013-11-11 19:25:55 -0800432{
433 struct bset_stats_op op;
434 int ret;
435
436 memset(&op, 0, sizeof(op));
437 bch_btree_op_init(&op.op, -1);
438
John Sheucb851142014-03-17 23:13:56 -0700439 ret = bch_btree_map_nodes(&op.op, c, &ZERO_KEY, bch_btree_bset_stats);
Kent Overstreetf67342d2013-11-11 19:25:55 -0800440 if (ret < 0)
441 return ret;
442
443 return snprintf(buf, PAGE_SIZE,
444 "btree nodes: %zu\n"
445 "written sets: %zu\n"
446 "unwritten sets: %zu\n"
447 "written key bytes: %zu\n"
448 "unwritten key bytes: %zu\n"
449 "floats: %zu\n"
450 "failed: %zu\n",
451 op.nodes,
452 op.stats.sets_written, op.stats.sets_unwritten,
453 op.stats.bytes_written, op.stats.bytes_unwritten,
454 op.stats.floats, op.stats.failed);
455}
456
John Sheucb851142014-03-17 23:13:56 -0700457static unsigned bch_root_usage(struct cache_set *c)
458{
459 unsigned bytes = 0;
460 struct bkey *k;
461 struct btree *b;
462 struct btree_iter iter;
463
464 goto lock_root;
465
466 do {
467 rw_unlock(false, b);
468lock_root:
469 b = c->root;
470 rw_lock(false, b, b->level);
471 } while (b != c->root);
472
473 for_each_key_filter(&b->keys, k, &iter, bch_ptr_bad)
474 bytes += bkey_bytes(k);
475
476 rw_unlock(false, b);
477
478 return (bytes * 100) / btree_bytes(c);
479}
480
481static size_t bch_cache_size(struct cache_set *c)
482{
483 size_t ret = 0;
484 struct btree *b;
485
486 mutex_lock(&c->bucket_lock);
487 list_for_each_entry(b, &c->btree_cache, list)
488 ret += 1 << (b->keys.page_order + PAGE_SHIFT);
489
490 mutex_unlock(&c->bucket_lock);
491 return ret;
492}
493
494static unsigned bch_cache_max_chain(struct cache_set *c)
495{
496 unsigned ret = 0;
497 struct hlist_head *h;
498
499 mutex_lock(&c->bucket_lock);
500
501 for (h = c->bucket_hash;
502 h < c->bucket_hash + (1 << BUCKET_HASH_BITS);
503 h++) {
504 unsigned i = 0;
505 struct hlist_node *p;
506
507 hlist_for_each(p, h)
508 i++;
509
510 ret = max(ret, i);
511 }
512
513 mutex_unlock(&c->bucket_lock);
514 return ret;
515}
516
517static unsigned bch_btree_used(struct cache_set *c)
518{
519 return div64_u64(c->gc_stats.key_bytes * 100,
520 (c->gc_stats.nodes ?: 1) * btree_bytes(c));
521}
522
523static unsigned bch_average_key_size(struct cache_set *c)
524{
525 return c->gc_stats.nkeys
526 ? div64_u64(c->gc_stats.data, c->gc_stats.nkeys)
527 : 0;
528}
529
Kent Overstreetcafe5632013-03-23 16:11:31 -0700530SHOW(__bch_cache_set)
531{
Kent Overstreetcafe5632013-03-23 16:11:31 -0700532 struct cache_set *c = container_of(kobj, struct cache_set, kobj);
533
534 sysfs_print(synchronous, CACHE_SYNC(&c->sb));
535 sysfs_print(journal_delay_ms, c->journal_delay_ms);
536 sysfs_hprint(bucket_size, bucket_bytes(c));
537 sysfs_hprint(block_size, block_bytes(c));
538 sysfs_print(tree_depth, c->root->level);
John Sheucb851142014-03-17 23:13:56 -0700539 sysfs_print(root_usage_percent, bch_root_usage(c));
Kent Overstreetcafe5632013-03-23 16:11:31 -0700540
John Sheucb851142014-03-17 23:13:56 -0700541 sysfs_hprint(btree_cache_size, bch_cache_size(c));
542 sysfs_print(btree_cache_max_chain, bch_cache_max_chain(c));
Kent Overstreetcafe5632013-03-23 16:11:31 -0700543 sysfs_print(cache_available_percent, 100 - c->gc_stats.in_use);
544
545 sysfs_print_time_stats(&c->btree_gc_time, btree_gc, sec, ms);
546 sysfs_print_time_stats(&c->btree_split_time, btree_split, sec, us);
Kent Overstreet67539e82013-09-10 22:53:34 -0700547 sysfs_print_time_stats(&c->sort.time, btree_sort, ms, us);
Kent Overstreetcafe5632013-03-23 16:11:31 -0700548 sysfs_print_time_stats(&c->btree_read_time, btree_read, ms, us);
Kent Overstreetcafe5632013-03-23 16:11:31 -0700549
John Sheucb851142014-03-17 23:13:56 -0700550 sysfs_print(btree_used_percent, bch_btree_used(c));
Kent Overstreetcafe5632013-03-23 16:11:31 -0700551 sysfs_print(btree_nodes, c->gc_stats.nodes);
John Sheucb851142014-03-17 23:13:56 -0700552 sysfs_hprint(average_key_size, bch_average_key_size(c));
Kent Overstreetcafe5632013-03-23 16:11:31 -0700553
554 sysfs_print(cache_read_races,
555 atomic_long_read(&c->cache_read_races));
556
Tang Junhuia728eac2018-02-07 11:41:39 -0800557 sysfs_print(reclaim,
558 atomic_long_read(&c->reclaim));
559
560 sysfs_print(flush_write,
561 atomic_long_read(&c->flush_write));
562
563 sysfs_print(retry_flush_write,
564 atomic_long_read(&c->retry_flush_write));
565
Kent Overstreetcafe5632013-03-23 16:11:31 -0700566 sysfs_print(writeback_keys_done,
567 atomic_long_read(&c->writeback_keys_done));
568 sysfs_print(writeback_keys_failed,
569 atomic_long_read(&c->writeback_keys_failed));
570
Kent Overstreet77c320e2013-07-11 19:42:51 -0700571 if (attr == &sysfs_errors)
572 return bch_snprint_string_list(buf, PAGE_SIZE, error_actions,
573 c->on_error);
574
Kent Overstreetcafe5632013-03-23 16:11:31 -0700575 /* See count_io_errors for why 88 */
576 sysfs_print(io_error_halflife, c->error_decay * 88);
Coly Li7ba0d832018-02-07 11:41:42 -0800577 sysfs_print(io_error_limit, c->error_limit);
Kent Overstreetcafe5632013-03-23 16:11:31 -0700578
579 sysfs_hprint(congested,
580 ((uint64_t) bch_get_congested(c)) << 9);
581 sysfs_print(congested_read_threshold_us,
582 c->congested_read_threshold_us);
583 sysfs_print(congested_write_threshold_us,
584 c->congested_write_threshold_us);
585
586 sysfs_print(active_journal_entries, fifo_used(&c->journal.pin));
587 sysfs_printf(verify, "%i", c->verify);
588 sysfs_printf(key_merging_disabled, "%i", c->key_merging_disabled);
Kent Overstreet280481d2013-10-24 16:36:03 -0700589 sysfs_printf(expensive_debug_checks,
590 "%i", c->expensive_debug_checks);
Kent Overstreetcafe5632013-03-23 16:11:31 -0700591 sysfs_printf(gc_always_rewrite, "%i", c->gc_always_rewrite);
592 sysfs_printf(btree_shrinker_disabled, "%i", c->shrinker_disabled);
593 sysfs_printf(copy_gc_enabled, "%i", c->copy_gc_enabled);
594
595 if (attr == &sysfs_bset_tree_stats)
596 return bch_bset_print_stats(c, buf);
597
598 return 0;
599}
600SHOW_LOCKED(bch_cache_set)
601
602STORE(__bch_cache_set)
603{
604 struct cache_set *c = container_of(kobj, struct cache_set, kobj);
605
606 if (attr == &sysfs_unregister)
607 bch_cache_set_unregister(c);
608
609 if (attr == &sysfs_stop)
610 bch_cache_set_stop(c);
611
612 if (attr == &sysfs_synchronous) {
613 bool sync = strtoul_or_return(buf);
614
615 if (sync != CACHE_SYNC(&c->sb)) {
616 SET_CACHE_SYNC(&c->sb, sync);
617 bcache_write_super(c);
618 }
619 }
620
621 if (attr == &sysfs_flash_vol_create) {
622 int r;
623 uint64_t v;
624 strtoi_h_or_return(buf, v);
625
626 r = bch_flash_dev_create(c, v);
627 if (r)
628 return r;
629 }
630
631 if (attr == &sysfs_clear_stats) {
632 atomic_long_set(&c->writeback_keys_done, 0);
633 atomic_long_set(&c->writeback_keys_failed, 0);
634
635 memset(&c->gc_stats, 0, sizeof(struct gc_stat));
636 bch_cache_accounting_clear(&c->accounting);
637 }
638
Tang Junhui0b43f492017-09-06 14:25:55 +0800639 if (attr == &sysfs_trigger_gc) {
640 /*
641 * Garbage collection thread only works when sectors_to_gc < 0,
642 * when users write to sysfs entry trigger_gc, most of time
643 * they want to forcibly triger gargage collection. Here -1 is
644 * set to c->sectors_to_gc, to make gc_should_run() give a
645 * chance to permit gc thread to run. "give a chance" means
646 * before going into gc_should_run(), there is still chance
647 * that c->sectors_to_gc being set to other positive value. So
648 * writing sysfs entry trigger_gc won't always make sure gc
649 * thread takes effect.
650 */
651 atomic_set(&c->sectors_to_gc, -1);
Kent Overstreet72a44512013-10-24 17:19:26 -0700652 wake_up_gc(c);
Tang Junhui0b43f492017-09-06 14:25:55 +0800653 }
Kent Overstreetcafe5632013-03-23 16:11:31 -0700654
655 if (attr == &sysfs_prune_cache) {
656 struct shrink_control sc;
657 sc.gfp_mask = GFP_KERNEL;
658 sc.nr_to_scan = strtoul_or_return(buf);
Dave Chinner7dc19d52013-08-28 10:18:11 +1000659 c->shrink.scan_objects(&c->shrink, &sc);
Kent Overstreetcafe5632013-03-23 16:11:31 -0700660 }
661
662 sysfs_strtoul(congested_read_threshold_us,
663 c->congested_read_threshold_us);
664 sysfs_strtoul(congested_write_threshold_us,
665 c->congested_write_threshold_us);
666
Kent Overstreet77c320e2013-07-11 19:42:51 -0700667 if (attr == &sysfs_errors) {
668 ssize_t v = bch_read_string_list(buf, error_actions);
669
670 if (v < 0)
671 return v;
672
673 c->on_error = v;
674 }
675
Kent Overstreetcafe5632013-03-23 16:11:31 -0700676 if (attr == &sysfs_io_error_limit)
Coly Li7ba0d832018-02-07 11:41:42 -0800677 c->error_limit = strtoul_or_return(buf);
Kent Overstreetcafe5632013-03-23 16:11:31 -0700678
679 /* See count_io_errors() for why 88 */
680 if (attr == &sysfs_io_error_halflife)
681 c->error_decay = strtoul_or_return(buf) / 88;
682
683 sysfs_strtoul(journal_delay_ms, c->journal_delay_ms);
684 sysfs_strtoul(verify, c->verify);
685 sysfs_strtoul(key_merging_disabled, c->key_merging_disabled);
Kent Overstreet280481d2013-10-24 16:36:03 -0700686 sysfs_strtoul(expensive_debug_checks, c->expensive_debug_checks);
Kent Overstreetcafe5632013-03-23 16:11:31 -0700687 sysfs_strtoul(gc_always_rewrite, c->gc_always_rewrite);
688 sysfs_strtoul(btree_shrinker_disabled, c->shrinker_disabled);
689 sysfs_strtoul(copy_gc_enabled, c->copy_gc_enabled);
690
691 return size;
692}
693STORE_LOCKED(bch_cache_set)
694
695SHOW(bch_cache_set_internal)
696{
697 struct cache_set *c = container_of(kobj, struct cache_set, internal);
698 return bch_cache_set_show(&c->kobj, attr, buf);
699}
700
701STORE(bch_cache_set_internal)
702{
703 struct cache_set *c = container_of(kobj, struct cache_set, internal);
704 return bch_cache_set_store(&c->kobj, attr, buf, size);
705}
706
707static void bch_cache_set_internal_release(struct kobject *k)
708{
709}
710
711static struct attribute *bch_cache_set_files[] = {
712 &sysfs_unregister,
713 &sysfs_stop,
714 &sysfs_synchronous,
715 &sysfs_journal_delay_ms,
716 &sysfs_flash_vol_create,
717
718 &sysfs_bucket_size,
719 &sysfs_block_size,
720 &sysfs_tree_depth,
721 &sysfs_root_usage_percent,
722 &sysfs_btree_cache_size,
723 &sysfs_cache_available_percent,
724
725 &sysfs_average_key_size,
Kent Overstreetcafe5632013-03-23 16:11:31 -0700726
Kent Overstreet77c320e2013-07-11 19:42:51 -0700727 &sysfs_errors,
Kent Overstreetcafe5632013-03-23 16:11:31 -0700728 &sysfs_io_error_limit,
729 &sysfs_io_error_halflife,
730 &sysfs_congested,
731 &sysfs_congested_read_threshold_us,
732 &sysfs_congested_write_threshold_us,
733 &sysfs_clear_stats,
734 NULL
735};
736KTYPE(bch_cache_set);
737
738static struct attribute *bch_cache_set_internal_files[] = {
739 &sysfs_active_journal_entries,
740
741 sysfs_time_stats_attribute_list(btree_gc, sec, ms)
742 sysfs_time_stats_attribute_list(btree_split, sec, us)
743 sysfs_time_stats_attribute_list(btree_sort, ms, us)
744 sysfs_time_stats_attribute_list(btree_read, ms, us)
Kent Overstreetcafe5632013-03-23 16:11:31 -0700745
746 &sysfs_btree_nodes,
747 &sysfs_btree_used_percent,
748 &sysfs_btree_cache_max_chain,
749
750 &sysfs_bset_tree_stats,
751 &sysfs_cache_read_races,
Tang Junhuia728eac2018-02-07 11:41:39 -0800752 &sysfs_reclaim,
753 &sysfs_flush_write,
754 &sysfs_retry_flush_write,
Kent Overstreetcafe5632013-03-23 16:11:31 -0700755 &sysfs_writeback_keys_done,
756 &sysfs_writeback_keys_failed,
757
758 &sysfs_trigger_gc,
759 &sysfs_prune_cache,
760#ifdef CONFIG_BCACHE_DEBUG
761 &sysfs_verify,
762 &sysfs_key_merging_disabled,
Kent Overstreet280481d2013-10-24 16:36:03 -0700763 &sysfs_expensive_debug_checks,
Kent Overstreetcafe5632013-03-23 16:11:31 -0700764#endif
765 &sysfs_gc_always_rewrite,
766 &sysfs_btree_shrinker_disabled,
767 &sysfs_copy_gc_enabled,
768 NULL
769};
770KTYPE(bch_cache_set_internal);
771
Peter Foley58f913d2017-10-13 16:35:28 -0700772static int __bch_cache_cmp(const void *l, const void *r)
773{
774 return *((uint16_t *)r) - *((uint16_t *)l);
775}
776
Kent Overstreetcafe5632013-03-23 16:11:31 -0700777SHOW(__bch_cache)
778{
779 struct cache *ca = container_of(kobj, struct cache, kobj);
780
781 sysfs_hprint(bucket_size, bucket_bytes(ca));
782 sysfs_hprint(block_size, block_bytes(ca));
783 sysfs_print(nbuckets, ca->sb.nbuckets);
784 sysfs_print(discard, ca->discard);
785 sysfs_hprint(written, atomic_long_read(&ca->sectors_written) << 9);
786 sysfs_hprint(btree_written,
787 atomic_long_read(&ca->btree_sectors_written) << 9);
788 sysfs_hprint(metadata_written,
789 (atomic_long_read(&ca->meta_sectors_written) +
790 atomic_long_read(&ca->btree_sectors_written)) << 9);
791
792 sysfs_print(io_errors,
793 atomic_read(&ca->io_errors) >> IO_ERROR_SHIFT);
794
Kent Overstreetcafe5632013-03-23 16:11:31 -0700795 if (attr == &sysfs_cache_replacement_policy)
Kent Overstreet169ef1c2013-03-28 12:50:55 -0600796 return bch_snprint_string_list(buf, PAGE_SIZE,
797 cache_replacement_policies,
798 CACHE_REPLACEMENT(&ca->sb));
Kent Overstreetcafe5632013-03-23 16:11:31 -0700799
800 if (attr == &sysfs_priority_stats) {
Kent Overstreet15754022014-02-25 17:34:21 -0800801 struct bucket *b;
802 size_t n = ca->sb.nbuckets, i;
803 size_t unused = 0, available = 0, dirty = 0, meta = 0;
Kent Overstreetcafe5632013-03-23 16:11:31 -0700804 uint64_t sum = 0;
Kent Overstreetbbc77aa2013-05-28 21:53:19 -0700805 /* Compute 31 quantiles */
806 uint16_t q[31], *p, *cached;
Kent Overstreetcafe5632013-03-23 16:11:31 -0700807 ssize_t ret;
808
809 cached = p = vmalloc(ca->sb.nbuckets * sizeof(uint16_t));
810 if (!p)
811 return -ENOMEM;
812
813 mutex_lock(&ca->set->bucket_lock);
Kent Overstreet15754022014-02-25 17:34:21 -0800814 for_each_bucket(b, ca) {
815 if (!GC_SECTORS_USED(b))
816 unused++;
817 if (GC_MARK(b) == GC_MARK_RECLAIMABLE)
818 available++;
819 if (GC_MARK(b) == GC_MARK_DIRTY)
820 dirty++;
821 if (GC_MARK(b) == GC_MARK_METADATA)
822 meta++;
823 }
824
Kent Overstreetcafe5632013-03-23 16:11:31 -0700825 for (i = ca->sb.first_bucket; i < n; i++)
826 p[i] = ca->buckets[i].prio;
827 mutex_unlock(&ca->set->bucket_lock);
828
Peter Foley58f913d2017-10-13 16:35:28 -0700829 sort(p, n, sizeof(uint16_t), __bch_cache_cmp, NULL);
Kent Overstreetcafe5632013-03-23 16:11:31 -0700830
831 while (n &&
832 !cached[n - 1])
833 --n;
834
835 unused = ca->sb.nbuckets - n;
836
837 while (cached < p + n &&
838 *cached == BTREE_PRIO)
Kent Overstreet15754022014-02-25 17:34:21 -0800839 cached++, n--;
Kent Overstreetcafe5632013-03-23 16:11:31 -0700840
841 for (i = 0; i < n; i++)
842 sum += INITIAL_PRIO - cached[i];
843
844 if (n)
845 do_div(sum, n);
846
Kent Overstreetbbc77aa2013-05-28 21:53:19 -0700847 for (i = 0; i < ARRAY_SIZE(q); i++)
848 q[i] = INITIAL_PRIO - cached[n * (i + 1) /
849 (ARRAY_SIZE(q) + 1)];
Kent Overstreetcafe5632013-03-23 16:11:31 -0700850
851 vfree(p);
852
Kent Overstreetbbc77aa2013-05-28 21:53:19 -0700853 ret = scnprintf(buf, PAGE_SIZE,
854 "Unused: %zu%%\n"
Kent Overstreet15754022014-02-25 17:34:21 -0800855 "Clean: %zu%%\n"
856 "Dirty: %zu%%\n"
Kent Overstreetbbc77aa2013-05-28 21:53:19 -0700857 "Metadata: %zu%%\n"
858 "Average: %llu\n"
859 "Sectors per Q: %zu\n"
860 "Quantiles: [",
861 unused * 100 / (size_t) ca->sb.nbuckets,
Kent Overstreet15754022014-02-25 17:34:21 -0800862 available * 100 / (size_t) ca->sb.nbuckets,
863 dirty * 100 / (size_t) ca->sb.nbuckets,
864 meta * 100 / (size_t) ca->sb.nbuckets, sum,
Kent Overstreetbbc77aa2013-05-28 21:53:19 -0700865 n * ca->sb.bucket_size / (ARRAY_SIZE(q) + 1));
Kent Overstreetcafe5632013-03-23 16:11:31 -0700866
Kent Overstreetbbc77aa2013-05-28 21:53:19 -0700867 for (i = 0; i < ARRAY_SIZE(q); i++)
868 ret += scnprintf(buf + ret, PAGE_SIZE - ret,
869 "%u ", q[i]);
870 ret--;
Kent Overstreetcafe5632013-03-23 16:11:31 -0700871
Kent Overstreetbbc77aa2013-05-28 21:53:19 -0700872 ret += scnprintf(buf + ret, PAGE_SIZE - ret, "]\n");
873
Kent Overstreetcafe5632013-03-23 16:11:31 -0700874 return ret;
875 }
876
877 return 0;
878}
879SHOW_LOCKED(bch_cache)
880
881STORE(__bch_cache)
882{
883 struct cache *ca = container_of(kobj, struct cache, kobj);
884
885 if (attr == &sysfs_discard) {
886 bool v = strtoul_or_return(buf);
887
888 if (blk_queue_discard(bdev_get_queue(ca->bdev)))
889 ca->discard = v;
890
891 if (v != CACHE_DISCARD(&ca->sb)) {
892 SET_CACHE_DISCARD(&ca->sb, v);
893 bcache_write_super(ca->set);
894 }
895 }
896
897 if (attr == &sysfs_cache_replacement_policy) {
Kent Overstreet169ef1c2013-03-28 12:50:55 -0600898 ssize_t v = bch_read_string_list(buf, cache_replacement_policies);
Kent Overstreetcafe5632013-03-23 16:11:31 -0700899
900 if (v < 0)
901 return v;
902
903 if ((unsigned) v != CACHE_REPLACEMENT(&ca->sb)) {
904 mutex_lock(&ca->set->bucket_lock);
905 SET_CACHE_REPLACEMENT(&ca->sb, v);
906 mutex_unlock(&ca->set->bucket_lock);
907
908 bcache_write_super(ca->set);
909 }
910 }
911
Kent Overstreetcafe5632013-03-23 16:11:31 -0700912 if (attr == &sysfs_clear_stats) {
913 atomic_long_set(&ca->sectors_written, 0);
914 atomic_long_set(&ca->btree_sectors_written, 0);
915 atomic_long_set(&ca->meta_sectors_written, 0);
916 atomic_set(&ca->io_count, 0);
917 atomic_set(&ca->io_errors, 0);
918 }
919
920 return size;
921}
922STORE_LOCKED(bch_cache)
923
924static struct attribute *bch_cache_files[] = {
925 &sysfs_bucket_size,
926 &sysfs_block_size,
927 &sysfs_nbuckets,
928 &sysfs_priority_stats,
929 &sysfs_discard,
930 &sysfs_written,
931 &sysfs_btree_written,
932 &sysfs_metadata_written,
933 &sysfs_io_errors,
934 &sysfs_clear_stats,
Kent Overstreetcafe5632013-03-23 16:11:31 -0700935 &sysfs_cache_replacement_policy,
936 NULL
937};
938KTYPE(bch_cache);