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