xref: /openbmc/linux/fs/f2fs/debug.c (revision 4beec1d7)
1 /*
2  * f2fs debugging statistics
3  *
4  * Copyright (c) 2012 Samsung Electronics Co., Ltd.
5  *             http://www.samsung.com/
6  * Copyright (c) 2012 Linux Foundation
7  * Copyright (c) 2012 Greg Kroah-Hartman <gregkh@linuxfoundation.org>
8  *
9  * This program is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License version 2 as
11  * published by the Free Software Foundation.
12  */
13 
14 #include <linux/fs.h>
15 #include <linux/backing-dev.h>
16 #include <linux/f2fs_fs.h>
17 #include <linux/blkdev.h>
18 #include <linux/debugfs.h>
19 #include <linux/seq_file.h>
20 
21 #include "f2fs.h"
22 #include "node.h"
23 #include "segment.h"
24 #include "gc.h"
25 
26 static LIST_HEAD(f2fs_stat_list);
27 static struct dentry *f2fs_debugfs_root;
28 static DEFINE_MUTEX(f2fs_stat_mutex);
29 
30 static void update_general_status(struct f2fs_sb_info *sbi)
31 {
32 	struct f2fs_stat_info *si = F2FS_STAT(sbi);
33 	int i;
34 
35 	/* validation check of the segment numbers */
36 	si->hit_largest = atomic64_read(&sbi->read_hit_largest);
37 	si->hit_cached = atomic64_read(&sbi->read_hit_cached);
38 	si->hit_rbtree = atomic64_read(&sbi->read_hit_rbtree);
39 	si->hit_total = si->hit_largest + si->hit_cached + si->hit_rbtree;
40 	si->total_ext = atomic64_read(&sbi->total_hit_ext);
41 	si->ext_tree = atomic_read(&sbi->total_ext_tree);
42 	si->zombie_tree = atomic_read(&sbi->total_zombie_tree);
43 	si->ext_node = atomic_read(&sbi->total_ext_node);
44 	si->ndirty_node = get_pages(sbi, F2FS_DIRTY_NODES);
45 	si->ndirty_dent = get_pages(sbi, F2FS_DIRTY_DENTS);
46 	si->ndirty_meta = get_pages(sbi, F2FS_DIRTY_META);
47 	si->ndirty_data = get_pages(sbi, F2FS_DIRTY_DATA);
48 	si->ndirty_imeta = get_pages(sbi, F2FS_DIRTY_IMETA);
49 	si->ndirty_dirs = sbi->ndirty_inode[DIR_INODE];
50 	si->ndirty_files = sbi->ndirty_inode[FILE_INODE];
51 	si->ndirty_all = sbi->ndirty_inode[DIRTY_META];
52 	si->inmem_pages = get_pages(sbi, F2FS_INMEM_PAGES);
53 	si->nr_wb_cp_data = get_pages(sbi, F2FS_WB_CP_DATA);
54 	si->nr_wb_data = get_pages(sbi, F2FS_WB_DATA);
55 	si->total_count = (int)sbi->user_block_count / sbi->blocks_per_seg;
56 	si->rsvd_segs = reserved_segments(sbi);
57 	si->overp_segs = overprovision_segments(sbi);
58 	si->valid_count = valid_user_blocks(sbi);
59 	si->discard_blks = discard_blocks(sbi);
60 	si->valid_node_count = valid_node_count(sbi);
61 	si->valid_inode_count = valid_inode_count(sbi);
62 	si->inline_xattr = atomic_read(&sbi->inline_xattr);
63 	si->inline_inode = atomic_read(&sbi->inline_inode);
64 	si->inline_dir = atomic_read(&sbi->inline_dir);
65 	si->orphans = sbi->im[ORPHAN_INO].ino_num;
66 	si->utilization = utilization(sbi);
67 
68 	si->free_segs = free_segments(sbi);
69 	si->free_secs = free_sections(sbi);
70 	si->prefree_count = prefree_segments(sbi);
71 	si->dirty_count = dirty_segments(sbi);
72 	si->node_pages = NODE_MAPPING(sbi)->nrpages;
73 	si->meta_pages = META_MAPPING(sbi)->nrpages;
74 	si->nats = NM_I(sbi)->nat_cnt;
75 	si->dirty_nats = NM_I(sbi)->dirty_nat_cnt;
76 	si->sits = MAIN_SEGS(sbi);
77 	si->dirty_sits = SIT_I(sbi)->dirty_sentries;
78 	si->free_nids = NM_I(sbi)->nid_cnt[FREE_NID_LIST];
79 	si->alloc_nids = NM_I(sbi)->nid_cnt[ALLOC_NID_LIST];
80 	si->bg_gc = sbi->bg_gc;
81 	si->util_free = (int)(free_user_blocks(sbi) >> sbi->log_blocks_per_seg)
82 		* 100 / (int)(sbi->user_block_count >> sbi->log_blocks_per_seg)
83 		/ 2;
84 	si->util_valid = (int)(written_block_count(sbi) >>
85 						sbi->log_blocks_per_seg)
86 		* 100 / (int)(sbi->user_block_count >> sbi->log_blocks_per_seg)
87 		/ 2;
88 	si->util_invalid = 50 - si->util_free - si->util_valid;
89 	for (i = CURSEG_HOT_DATA; i <= CURSEG_COLD_NODE; i++) {
90 		struct curseg_info *curseg = CURSEG_I(sbi, i);
91 		si->curseg[i] = curseg->segno;
92 		si->cursec[i] = curseg->segno / sbi->segs_per_sec;
93 		si->curzone[i] = si->cursec[i] / sbi->secs_per_zone;
94 	}
95 
96 	for (i = 0; i < 2; i++) {
97 		si->segment_count[i] = sbi->segment_count[i];
98 		si->block_count[i] = sbi->block_count[i];
99 	}
100 
101 	si->inplace_count = atomic_read(&sbi->inplace_count);
102 }
103 
104 /*
105  * This function calculates BDF of every segments
106  */
107 static void update_sit_info(struct f2fs_sb_info *sbi)
108 {
109 	struct f2fs_stat_info *si = F2FS_STAT(sbi);
110 	unsigned long long blks_per_sec, hblks_per_sec, total_vblocks;
111 	unsigned long long bimodal, dist;
112 	unsigned int segno, vblocks;
113 	int ndirty = 0;
114 
115 	bimodal = 0;
116 	total_vblocks = 0;
117 	blks_per_sec = sbi->segs_per_sec * sbi->blocks_per_seg;
118 	hblks_per_sec = blks_per_sec / 2;
119 	for (segno = 0; segno < MAIN_SEGS(sbi); segno += sbi->segs_per_sec) {
120 		vblocks = get_valid_blocks(sbi, segno, sbi->segs_per_sec);
121 		dist = abs(vblocks - hblks_per_sec);
122 		bimodal += dist * dist;
123 
124 		if (vblocks > 0 && vblocks < blks_per_sec) {
125 			total_vblocks += vblocks;
126 			ndirty++;
127 		}
128 	}
129 	dist = div_u64(MAIN_SECS(sbi) * hblks_per_sec * hblks_per_sec, 100);
130 	si->bimodal = div64_u64(bimodal, dist);
131 	if (si->dirty_count)
132 		si->avg_vblocks = div_u64(total_vblocks, ndirty);
133 	else
134 		si->avg_vblocks = 0;
135 }
136 
137 /*
138  * This function calculates memory footprint.
139  */
140 static void update_mem_info(struct f2fs_sb_info *sbi)
141 {
142 	struct f2fs_stat_info *si = F2FS_STAT(sbi);
143 	unsigned npages;
144 	int i;
145 
146 	if (si->base_mem)
147 		goto get_cache;
148 
149 	si->base_mem = sizeof(struct f2fs_sb_info) + sbi->sb->s_blocksize;
150 	si->base_mem += 2 * sizeof(struct f2fs_inode_info);
151 	si->base_mem += sizeof(*sbi->ckpt);
152 	si->base_mem += sizeof(struct percpu_counter) * NR_COUNT_TYPE;
153 
154 	/* build sm */
155 	si->base_mem += sizeof(struct f2fs_sm_info);
156 
157 	/* build sit */
158 	si->base_mem += sizeof(struct sit_info);
159 	si->base_mem += MAIN_SEGS(sbi) * sizeof(struct seg_entry);
160 	si->base_mem += f2fs_bitmap_size(MAIN_SEGS(sbi));
161 	si->base_mem += 2 * SIT_VBLOCK_MAP_SIZE * MAIN_SEGS(sbi);
162 	if (f2fs_discard_en(sbi))
163 		si->base_mem += SIT_VBLOCK_MAP_SIZE * MAIN_SEGS(sbi);
164 	si->base_mem += SIT_VBLOCK_MAP_SIZE;
165 	if (sbi->segs_per_sec > 1)
166 		si->base_mem += MAIN_SECS(sbi) * sizeof(struct sec_entry);
167 	si->base_mem += __bitmap_size(sbi, SIT_BITMAP);
168 
169 	/* build free segmap */
170 	si->base_mem += sizeof(struct free_segmap_info);
171 	si->base_mem += f2fs_bitmap_size(MAIN_SEGS(sbi));
172 	si->base_mem += f2fs_bitmap_size(MAIN_SECS(sbi));
173 
174 	/* build curseg */
175 	si->base_mem += sizeof(struct curseg_info) * NR_CURSEG_TYPE;
176 	si->base_mem += PAGE_SIZE * NR_CURSEG_TYPE;
177 
178 	/* build dirty segmap */
179 	si->base_mem += sizeof(struct dirty_seglist_info);
180 	si->base_mem += NR_DIRTY_TYPE * f2fs_bitmap_size(MAIN_SEGS(sbi));
181 	si->base_mem += f2fs_bitmap_size(MAIN_SECS(sbi));
182 
183 	/* build nm */
184 	si->base_mem += sizeof(struct f2fs_nm_info);
185 	si->base_mem += __bitmap_size(sbi, NAT_BITMAP);
186 
187 get_cache:
188 	si->cache_mem = 0;
189 
190 	/* build gc */
191 	if (sbi->gc_thread)
192 		si->cache_mem += sizeof(struct f2fs_gc_kthread);
193 
194 	/* build merge flush thread */
195 	if (SM_I(sbi)->cmd_control_info)
196 		si->cache_mem += sizeof(struct flush_cmd_control);
197 
198 	/* free nids */
199 	si->cache_mem += (NM_I(sbi)->nid_cnt[FREE_NID_LIST] +
200 				NM_I(sbi)->nid_cnt[ALLOC_NID_LIST]) *
201 				sizeof(struct free_nid);
202 	si->cache_mem += NM_I(sbi)->nat_cnt * sizeof(struct nat_entry);
203 	si->cache_mem += NM_I(sbi)->dirty_nat_cnt *
204 					sizeof(struct nat_entry_set);
205 	si->cache_mem += si->inmem_pages * sizeof(struct inmem_pages);
206 	for (i = 0; i <= ORPHAN_INO; i++)
207 		si->cache_mem += sbi->im[i].ino_num * sizeof(struct ino_entry);
208 	si->cache_mem += atomic_read(&sbi->total_ext_tree) *
209 						sizeof(struct extent_tree);
210 	si->cache_mem += atomic_read(&sbi->total_ext_node) *
211 						sizeof(struct extent_node);
212 
213 	si->page_mem = 0;
214 	npages = NODE_MAPPING(sbi)->nrpages;
215 	si->page_mem += (unsigned long long)npages << PAGE_SHIFT;
216 	npages = META_MAPPING(sbi)->nrpages;
217 	si->page_mem += (unsigned long long)npages << PAGE_SHIFT;
218 }
219 
220 static int stat_show(struct seq_file *s, void *v)
221 {
222 	struct f2fs_stat_info *si;
223 	int i = 0;
224 	int j;
225 
226 	mutex_lock(&f2fs_stat_mutex);
227 	list_for_each_entry(si, &f2fs_stat_list, stat_list) {
228 		update_general_status(si->sbi);
229 
230 		seq_printf(s, "\n=====[ partition info(%pg). #%d, %s]=====\n",
231 			si->sbi->sb->s_bdev, i++,
232 			f2fs_readonly(si->sbi->sb) ? "RO": "RW");
233 		seq_printf(s, "[SB: 1] [CP: 2] [SIT: %d] [NAT: %d] ",
234 			   si->sit_area_segs, si->nat_area_segs);
235 		seq_printf(s, "[SSA: %d] [MAIN: %d",
236 			   si->ssa_area_segs, si->main_area_segs);
237 		seq_printf(s, "(OverProv:%d Resv:%d)]\n\n",
238 			   si->overp_segs, si->rsvd_segs);
239 		if (test_opt(si->sbi, DISCARD))
240 			seq_printf(s, "Utilization: %u%% (%u valid blocks, %u discard blocks)\n",
241 				si->utilization, si->valid_count, si->discard_blks);
242 		else
243 			seq_printf(s, "Utilization: %u%% (%u valid blocks)\n",
244 				si->utilization, si->valid_count);
245 
246 		seq_printf(s, "  - Node: %u (Inode: %u, ",
247 			   si->valid_node_count, si->valid_inode_count);
248 		seq_printf(s, "Other: %u)\n  - Data: %u\n",
249 			   si->valid_node_count - si->valid_inode_count,
250 			   si->valid_count - si->valid_node_count);
251 		seq_printf(s, "  - Inline_xattr Inode: %u\n",
252 			   si->inline_xattr);
253 		seq_printf(s, "  - Inline_data Inode: %u\n",
254 			   si->inline_inode);
255 		seq_printf(s, "  - Inline_dentry Inode: %u\n",
256 			   si->inline_dir);
257 		seq_printf(s, "  - Orphan Inode: %u\n",
258 			   si->orphans);
259 		seq_printf(s, "\nMain area: %d segs, %d secs %d zones\n",
260 			   si->main_area_segs, si->main_area_sections,
261 			   si->main_area_zones);
262 		seq_printf(s, "  - COLD  data: %d, %d, %d\n",
263 			   si->curseg[CURSEG_COLD_DATA],
264 			   si->cursec[CURSEG_COLD_DATA],
265 			   si->curzone[CURSEG_COLD_DATA]);
266 		seq_printf(s, "  - WARM  data: %d, %d, %d\n",
267 			   si->curseg[CURSEG_WARM_DATA],
268 			   si->cursec[CURSEG_WARM_DATA],
269 			   si->curzone[CURSEG_WARM_DATA]);
270 		seq_printf(s, "  - HOT   data: %d, %d, %d\n",
271 			   si->curseg[CURSEG_HOT_DATA],
272 			   si->cursec[CURSEG_HOT_DATA],
273 			   si->curzone[CURSEG_HOT_DATA]);
274 		seq_printf(s, "  - Dir   dnode: %d, %d, %d\n",
275 			   si->curseg[CURSEG_HOT_NODE],
276 			   si->cursec[CURSEG_HOT_NODE],
277 			   si->curzone[CURSEG_HOT_NODE]);
278 		seq_printf(s, "  - File   dnode: %d, %d, %d\n",
279 			   si->curseg[CURSEG_WARM_NODE],
280 			   si->cursec[CURSEG_WARM_NODE],
281 			   si->curzone[CURSEG_WARM_NODE]);
282 		seq_printf(s, "  - Indir nodes: %d, %d, %d\n",
283 			   si->curseg[CURSEG_COLD_NODE],
284 			   si->cursec[CURSEG_COLD_NODE],
285 			   si->curzone[CURSEG_COLD_NODE]);
286 		seq_printf(s, "\n  - Valid: %d\n  - Dirty: %d\n",
287 			   si->main_area_segs - si->dirty_count -
288 			   si->prefree_count - si->free_segs,
289 			   si->dirty_count);
290 		seq_printf(s, "  - Prefree: %d\n  - Free: %d (%d)\n\n",
291 			   si->prefree_count, si->free_segs, si->free_secs);
292 		seq_printf(s, "CP calls: %d (BG: %d)\n",
293 				si->cp_count, si->bg_cp_count);
294 		seq_printf(s, "GC calls: %d (BG: %d)\n",
295 			   si->call_count, si->bg_gc);
296 		seq_printf(s, "  - data segments : %d (%d)\n",
297 				si->data_segs, si->bg_data_segs);
298 		seq_printf(s, "  - node segments : %d (%d)\n",
299 				si->node_segs, si->bg_node_segs);
300 		seq_printf(s, "Try to move %d blocks (BG: %d)\n", si->tot_blks,
301 				si->bg_data_blks + si->bg_node_blks);
302 		seq_printf(s, "  - data blocks : %d (%d)\n", si->data_blks,
303 				si->bg_data_blks);
304 		seq_printf(s, "  - node blocks : %d (%d)\n", si->node_blks,
305 				si->bg_node_blks);
306 		seq_puts(s, "\nExtent Cache:\n");
307 		seq_printf(s, "  - Hit Count: L1-1:%llu L1-2:%llu L2:%llu\n",
308 				si->hit_largest, si->hit_cached,
309 				si->hit_rbtree);
310 		seq_printf(s, "  - Hit Ratio: %llu%% (%llu / %llu)\n",
311 				!si->total_ext ? 0 :
312 				div64_u64(si->hit_total * 100, si->total_ext),
313 				si->hit_total, si->total_ext);
314 		seq_printf(s, "  - Inner Struct Count: tree: %d(%d), node: %d\n",
315 				si->ext_tree, si->zombie_tree, si->ext_node);
316 		seq_puts(s, "\nBalancing F2FS Async:\n");
317 		seq_printf(s, "  - inmem: %4d, wb_cp_data: %4d, wb_data: %4d\n",
318 			   si->inmem_pages, si->nr_wb_cp_data, si->nr_wb_data);
319 		seq_printf(s, "  - nodes: %4d in %4d\n",
320 			   si->ndirty_node, si->node_pages);
321 		seq_printf(s, "  - dents: %4d in dirs:%4d (%4d)\n",
322 			   si->ndirty_dent, si->ndirty_dirs, si->ndirty_all);
323 		seq_printf(s, "  - datas: %4d in files:%4d\n",
324 			   si->ndirty_data, si->ndirty_files);
325 		seq_printf(s, "  - meta: %4d in %4d\n",
326 			   si->ndirty_meta, si->meta_pages);
327 		seq_printf(s, "  - imeta: %4d\n",
328 			   si->ndirty_imeta);
329 		seq_printf(s, "  - NATs: %9d/%9d\n  - SITs: %9d/%9d\n",
330 			   si->dirty_nats, si->nats, si->dirty_sits, si->sits);
331 		seq_printf(s, "  - free_nids: %9d, alloc_nids: %9d\n",
332 			   si->free_nids, si->alloc_nids);
333 		seq_puts(s, "\nDistribution of User Blocks:");
334 		seq_puts(s, " [ valid | invalid | free ]\n");
335 		seq_puts(s, "  [");
336 
337 		for (j = 0; j < si->util_valid; j++)
338 			seq_putc(s, '-');
339 		seq_putc(s, '|');
340 
341 		for (j = 0; j < si->util_invalid; j++)
342 			seq_putc(s, '-');
343 		seq_putc(s, '|');
344 
345 		for (j = 0; j < si->util_free; j++)
346 			seq_putc(s, '-');
347 		seq_puts(s, "]\n\n");
348 		seq_printf(s, "IPU: %u blocks\n", si->inplace_count);
349 		seq_printf(s, "SSR: %u blocks in %u segments\n",
350 			   si->block_count[SSR], si->segment_count[SSR]);
351 		seq_printf(s, "LFS: %u blocks in %u segments\n",
352 			   si->block_count[LFS], si->segment_count[LFS]);
353 
354 		/* segment usage info */
355 		update_sit_info(si->sbi);
356 		seq_printf(s, "\nBDF: %u, avg. vblocks: %u\n",
357 			   si->bimodal, si->avg_vblocks);
358 
359 		/* memory footprint */
360 		update_mem_info(si->sbi);
361 		seq_printf(s, "\nMemory: %llu KB\n",
362 			(si->base_mem + si->cache_mem + si->page_mem) >> 10);
363 		seq_printf(s, "  - static: %llu KB\n",
364 				si->base_mem >> 10);
365 		seq_printf(s, "  - cached: %llu KB\n",
366 				si->cache_mem >> 10);
367 		seq_printf(s, "  - paged : %llu KB\n",
368 				si->page_mem >> 10);
369 	}
370 	mutex_unlock(&f2fs_stat_mutex);
371 	return 0;
372 }
373 
374 static int stat_open(struct inode *inode, struct file *file)
375 {
376 	return single_open(file, stat_show, inode->i_private);
377 }
378 
379 static const struct file_operations stat_fops = {
380 	.owner = THIS_MODULE,
381 	.open = stat_open,
382 	.read = seq_read,
383 	.llseek = seq_lseek,
384 	.release = single_release,
385 };
386 
387 int f2fs_build_stats(struct f2fs_sb_info *sbi)
388 {
389 	struct f2fs_super_block *raw_super = F2FS_RAW_SUPER(sbi);
390 	struct f2fs_stat_info *si;
391 
392 	si = kzalloc(sizeof(struct f2fs_stat_info), GFP_KERNEL);
393 	if (!si)
394 		return -ENOMEM;
395 
396 	si->all_area_segs = le32_to_cpu(raw_super->segment_count);
397 	si->sit_area_segs = le32_to_cpu(raw_super->segment_count_sit);
398 	si->nat_area_segs = le32_to_cpu(raw_super->segment_count_nat);
399 	si->ssa_area_segs = le32_to_cpu(raw_super->segment_count_ssa);
400 	si->main_area_segs = le32_to_cpu(raw_super->segment_count_main);
401 	si->main_area_sections = le32_to_cpu(raw_super->section_count);
402 	si->main_area_zones = si->main_area_sections /
403 				le32_to_cpu(raw_super->secs_per_zone);
404 	si->sbi = sbi;
405 	sbi->stat_info = si;
406 
407 	atomic64_set(&sbi->total_hit_ext, 0);
408 	atomic64_set(&sbi->read_hit_rbtree, 0);
409 	atomic64_set(&sbi->read_hit_largest, 0);
410 	atomic64_set(&sbi->read_hit_cached, 0);
411 
412 	atomic_set(&sbi->inline_xattr, 0);
413 	atomic_set(&sbi->inline_inode, 0);
414 	atomic_set(&sbi->inline_dir, 0);
415 	atomic_set(&sbi->inplace_count, 0);
416 
417 	mutex_lock(&f2fs_stat_mutex);
418 	list_add_tail(&si->stat_list, &f2fs_stat_list);
419 	mutex_unlock(&f2fs_stat_mutex);
420 
421 	return 0;
422 }
423 
424 void f2fs_destroy_stats(struct f2fs_sb_info *sbi)
425 {
426 	struct f2fs_stat_info *si = F2FS_STAT(sbi);
427 
428 	mutex_lock(&f2fs_stat_mutex);
429 	list_del(&si->stat_list);
430 	mutex_unlock(&f2fs_stat_mutex);
431 
432 	kfree(si);
433 }
434 
435 int __init f2fs_create_root_stats(void)
436 {
437 	struct dentry *file;
438 
439 	f2fs_debugfs_root = debugfs_create_dir("f2fs", NULL);
440 	if (!f2fs_debugfs_root)
441 		return -ENOMEM;
442 
443 	file = debugfs_create_file("status", S_IRUGO, f2fs_debugfs_root,
444 			NULL, &stat_fops);
445 	if (!file) {
446 		debugfs_remove(f2fs_debugfs_root);
447 		f2fs_debugfs_root = NULL;
448 		return -ENOMEM;
449 	}
450 
451 	return 0;
452 }
453 
454 void f2fs_destroy_root_stats(void)
455 {
456 	if (!f2fs_debugfs_root)
457 		return;
458 
459 	debugfs_remove_recursive(f2fs_debugfs_root);
460 	f2fs_debugfs_root = NULL;
461 }
462