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