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