1 /* SPDX-License-Identifier: GPL-2.0 */
3 #define TRACE_SYSTEM writeback
5 #if !defined(_TRACE_WRITEBACK_H) || defined(TRACE_HEADER_MULTI_READ)
6 #define _TRACE_WRITEBACK_H
8 #include <linux/tracepoint.h>
9 #include <linux/backing-dev.h>
10 #include <linux/writeback.h>
12 #define show_inode_state(state) \
13 __print_flags(state, "|", \
14 {I_DIRTY_SYNC, "I_DIRTY_SYNC"}, \
15 {I_DIRTY_DATASYNC, "I_DIRTY_DATASYNC"}, \
16 {I_DIRTY_PAGES, "I_DIRTY_PAGES"}, \
18 {I_WILL_FREE, "I_WILL_FREE"}, \
19 {I_FREEING, "I_FREEING"}, \
20 {I_CLEAR, "I_CLEAR"}, \
22 {I_DIRTY_TIME, "I_DIRTY_TIME"}, \
23 {I_REFERENCED, "I_REFERENCED"} \
26 /* enums need to be exported to user space */
29 #define EM(a,b) TRACE_DEFINE_ENUM(a);
30 #define EMe(a,b) TRACE_DEFINE_ENUM(a);
32 #define WB_WORK_REASON \
33 EM( WB_REASON_BACKGROUND, "background") \
34 EM( WB_REASON_VMSCAN, "vmscan") \
35 EM( WB_REASON_SYNC, "sync") \
36 EM( WB_REASON_PERIODIC, "periodic") \
37 EM( WB_REASON_LAPTOP_TIMER, "laptop_timer") \
38 EM( WB_REASON_FREE_MORE_MEM, "free_more_memory") \
39 EM( WB_REASON_FS_FREE_SPACE, "fs_free_space") \
40 EMe(WB_REASON_FORKER_THREAD, "forker_thread")
45 * Now redefine the EM() and EMe() macros to map the enums to the strings
46 * that will be printed in the output.
50 #define EM(a,b) { a, b },
51 #define EMe(a,b) { a, b }
53 struct wb_writeback_work;
55 TRACE_EVENT(writeback_dirty_page,
57 TP_PROTO(struct page *page, struct address_space *mapping),
59 TP_ARGS(page, mapping),
62 __array(char, name, 32)
63 __field(unsigned long, ino)
64 __field(pgoff_t, index)
68 strscpy_pad(__entry->name,
69 bdi_dev_name(mapping ? inode_to_bdi(mapping->host) :
71 __entry->ino = mapping ? mapping->host->i_ino : 0;
72 __entry->index = page->index;
75 TP_printk("bdi %s: ino=%lu index=%lu",
82 DECLARE_EVENT_CLASS(writeback_dirty_inode_template,
84 TP_PROTO(struct inode *inode, int flags),
86 TP_ARGS(inode, flags),
89 __array(char, name, 32)
90 __field(unsigned long, ino)
91 __field(unsigned long, state)
92 __field(unsigned long, flags)
96 struct backing_dev_info *bdi = inode_to_bdi(inode);
98 /* may be called for files on pseudo FSes w/ unregistered bdi */
99 strscpy_pad(__entry->name, bdi_dev_name(bdi), 32);
100 __entry->ino = inode->i_ino;
101 __entry->state = inode->i_state;
102 __entry->flags = flags;
105 TP_printk("bdi %s: ino=%lu state=%s flags=%s",
108 show_inode_state(__entry->state),
109 show_inode_state(__entry->flags)
113 DEFINE_EVENT(writeback_dirty_inode_template, writeback_mark_inode_dirty,
115 TP_PROTO(struct inode *inode, int flags),
117 TP_ARGS(inode, flags)
120 DEFINE_EVENT(writeback_dirty_inode_template, writeback_dirty_inode_start,
122 TP_PROTO(struct inode *inode, int flags),
124 TP_ARGS(inode, flags)
127 DEFINE_EVENT(writeback_dirty_inode_template, writeback_dirty_inode,
129 TP_PROTO(struct inode *inode, int flags),
131 TP_ARGS(inode, flags)
134 #ifdef CREATE_TRACE_POINTS
135 #ifdef CONFIG_CGROUP_WRITEBACK
137 static inline unsigned int __trace_wb_assign_cgroup(struct bdi_writeback *wb)
139 return wb->memcg_css->cgroup->kn->id.ino;
142 static inline unsigned int __trace_wbc_assign_cgroup(struct writeback_control *wbc)
145 return __trace_wb_assign_cgroup(wbc->wb);
149 #else /* CONFIG_CGROUP_WRITEBACK */
151 static inline unsigned int __trace_wb_assign_cgroup(struct bdi_writeback *wb)
156 static inline unsigned int __trace_wbc_assign_cgroup(struct writeback_control *wbc)
161 #endif /* CONFIG_CGROUP_WRITEBACK */
162 #endif /* CREATE_TRACE_POINTS */
164 DECLARE_EVENT_CLASS(writeback_write_inode_template,
166 TP_PROTO(struct inode *inode, struct writeback_control *wbc),
171 __array(char, name, 32)
172 __field(unsigned long, ino)
173 __field(int, sync_mode)
174 __field(unsigned int, cgroup_ino)
178 strscpy_pad(__entry->name,
179 bdi_dev_name(inode_to_bdi(inode)), 32);
180 __entry->ino = inode->i_ino;
181 __entry->sync_mode = wbc->sync_mode;
182 __entry->cgroup_ino = __trace_wbc_assign_cgroup(wbc);
185 TP_printk("bdi %s: ino=%lu sync_mode=%d cgroup_ino=%u",
193 DEFINE_EVENT(writeback_write_inode_template, writeback_write_inode_start,
195 TP_PROTO(struct inode *inode, struct writeback_control *wbc),
200 DEFINE_EVENT(writeback_write_inode_template, writeback_write_inode,
202 TP_PROTO(struct inode *inode, struct writeback_control *wbc),
207 DECLARE_EVENT_CLASS(writeback_work_class,
208 TP_PROTO(struct bdi_writeback *wb, struct wb_writeback_work *work),
211 __array(char, name, 32)
212 __field(long, nr_pages)
213 __field(dev_t, sb_dev)
214 __field(int, sync_mode)
215 __field(int, for_kupdate)
216 __field(int, range_cyclic)
217 __field(int, for_background)
219 __field(unsigned int, cgroup_ino)
222 strscpy_pad(__entry->name, bdi_dev_name(wb->bdi), 32);
223 __entry->nr_pages = work->nr_pages;
224 __entry->sb_dev = work->sb ? work->sb->s_dev : 0;
225 __entry->sync_mode = work->sync_mode;
226 __entry->for_kupdate = work->for_kupdate;
227 __entry->range_cyclic = work->range_cyclic;
228 __entry->for_background = work->for_background;
229 __entry->reason = work->reason;
230 __entry->cgroup_ino = __trace_wb_assign_cgroup(wb);
232 TP_printk("bdi %s: sb_dev %d:%d nr_pages=%ld sync_mode=%d "
233 "kupdate=%d range_cyclic=%d background=%d reason=%s cgroup_ino=%u",
235 MAJOR(__entry->sb_dev), MINOR(__entry->sb_dev),
238 __entry->for_kupdate,
239 __entry->range_cyclic,
240 __entry->for_background,
241 __print_symbolic(__entry->reason, WB_WORK_REASON),
245 #define DEFINE_WRITEBACK_WORK_EVENT(name) \
246 DEFINE_EVENT(writeback_work_class, name, \
247 TP_PROTO(struct bdi_writeback *wb, struct wb_writeback_work *work), \
249 DEFINE_WRITEBACK_WORK_EVENT(writeback_queue);
250 DEFINE_WRITEBACK_WORK_EVENT(writeback_exec);
251 DEFINE_WRITEBACK_WORK_EVENT(writeback_start);
252 DEFINE_WRITEBACK_WORK_EVENT(writeback_written);
253 DEFINE_WRITEBACK_WORK_EVENT(writeback_wait);
255 TRACE_EVENT(writeback_pages_written,
256 TP_PROTO(long pages_written),
257 TP_ARGS(pages_written),
262 __entry->pages = pages_written;
264 TP_printk("%ld", __entry->pages)
267 DECLARE_EVENT_CLASS(writeback_class,
268 TP_PROTO(struct bdi_writeback *wb),
271 __array(char, name, 32)
272 __field(unsigned int, cgroup_ino)
275 strscpy_pad(__entry->name, bdi_dev_name(wb->bdi), 32);
276 __entry->cgroup_ino = __trace_wb_assign_cgroup(wb);
278 TP_printk("bdi %s: cgroup_ino=%u",
283 #define DEFINE_WRITEBACK_EVENT(name) \
284 DEFINE_EVENT(writeback_class, name, \
285 TP_PROTO(struct bdi_writeback *wb), \
288 DEFINE_WRITEBACK_EVENT(writeback_wake_background);
290 TRACE_EVENT(writeback_bdi_register,
291 TP_PROTO(struct backing_dev_info *bdi),
294 __array(char, name, 32)
297 strscpy_pad(__entry->name, bdi_dev_name(bdi), 32);
304 DECLARE_EVENT_CLASS(wbc_class,
305 TP_PROTO(struct writeback_control *wbc, struct backing_dev_info *bdi),
308 __array(char, name, 32)
309 __field(long, nr_to_write)
310 __field(long, pages_skipped)
311 __field(int, sync_mode)
312 __field(int, for_kupdate)
313 __field(int, for_background)
314 __field(int, for_reclaim)
315 __field(int, range_cyclic)
316 __field(long, range_start)
317 __field(long, range_end)
318 __field(unsigned int, cgroup_ino)
322 strscpy_pad(__entry->name, bdi_dev_name(bdi), 32);
323 __entry->nr_to_write = wbc->nr_to_write;
324 __entry->pages_skipped = wbc->pages_skipped;
325 __entry->sync_mode = wbc->sync_mode;
326 __entry->for_kupdate = wbc->for_kupdate;
327 __entry->for_background = wbc->for_background;
328 __entry->for_reclaim = wbc->for_reclaim;
329 __entry->range_cyclic = wbc->range_cyclic;
330 __entry->range_start = (long)wbc->range_start;
331 __entry->range_end = (long)wbc->range_end;
332 __entry->cgroup_ino = __trace_wbc_assign_cgroup(wbc);
335 TP_printk("bdi %s: towrt=%ld skip=%ld mode=%d kupd=%d "
336 "bgrd=%d reclm=%d cyclic=%d "
337 "start=0x%lx end=0x%lx cgroup_ino=%u",
339 __entry->nr_to_write,
340 __entry->pages_skipped,
342 __entry->for_kupdate,
343 __entry->for_background,
344 __entry->for_reclaim,
345 __entry->range_cyclic,
346 __entry->range_start,
352 #define DEFINE_WBC_EVENT(name) \
353 DEFINE_EVENT(wbc_class, name, \
354 TP_PROTO(struct writeback_control *wbc, struct backing_dev_info *bdi), \
356 DEFINE_WBC_EVENT(wbc_writepage);
358 TRACE_EVENT(writeback_queue_io,
359 TP_PROTO(struct bdi_writeback *wb,
360 struct wb_writeback_work *work,
361 unsigned long dirtied_before,
363 TP_ARGS(wb, work, dirtied_before, moved),
365 __array(char, name, 32)
366 __field(unsigned long, older)
370 __field(unsigned int, cgroup_ino)
373 strscpy_pad(__entry->name, bdi_dev_name(wb->bdi), 32);
374 __entry->older = dirtied_before;
375 __entry->age = (jiffies - dirtied_before) * 1000 / HZ;
376 __entry->moved = moved;
377 __entry->reason = work->reason;
378 __entry->cgroup_ino = __trace_wb_assign_cgroup(wb);
380 TP_printk("bdi %s: older=%lu age=%ld enqueue=%d reason=%s cgroup_ino=%u",
382 __entry->older, /* dirtied_before in jiffies */
383 __entry->age, /* dirtied_before in relative milliseconds */
385 __print_symbolic(__entry->reason, WB_WORK_REASON),
390 TRACE_EVENT(global_dirty_state,
392 TP_PROTO(unsigned long background_thresh,
393 unsigned long dirty_thresh
396 TP_ARGS(background_thresh,
401 __field(unsigned long, nr_dirty)
402 __field(unsigned long, nr_writeback)
403 __field(unsigned long, nr_unstable)
404 __field(unsigned long, background_thresh)
405 __field(unsigned long, dirty_thresh)
406 __field(unsigned long, dirty_limit)
407 __field(unsigned long, nr_dirtied)
408 __field(unsigned long, nr_written)
412 __entry->nr_dirty = global_node_page_state(NR_FILE_DIRTY);
413 __entry->nr_writeback = global_node_page_state(NR_WRITEBACK);
414 __entry->nr_unstable = global_node_page_state(NR_UNSTABLE_NFS);
415 __entry->nr_dirtied = global_node_page_state(NR_DIRTIED);
416 __entry->nr_written = global_node_page_state(NR_WRITTEN);
417 __entry->background_thresh = background_thresh;
418 __entry->dirty_thresh = dirty_thresh;
419 __entry->dirty_limit = global_wb_domain.dirty_limit;
422 TP_printk("dirty=%lu writeback=%lu unstable=%lu "
423 "bg_thresh=%lu thresh=%lu limit=%lu "
424 "dirtied=%lu written=%lu",
426 __entry->nr_writeback,
427 __entry->nr_unstable,
428 __entry->background_thresh,
429 __entry->dirty_thresh,
430 __entry->dirty_limit,
436 #define KBps(x) ((x) << (PAGE_SHIFT - 10))
438 TRACE_EVENT(bdi_dirty_ratelimit,
440 TP_PROTO(struct bdi_writeback *wb,
441 unsigned long dirty_rate,
442 unsigned long task_ratelimit),
444 TP_ARGS(wb, dirty_rate, task_ratelimit),
447 __array(char, bdi, 32)
448 __field(unsigned long, write_bw)
449 __field(unsigned long, avg_write_bw)
450 __field(unsigned long, dirty_rate)
451 __field(unsigned long, dirty_ratelimit)
452 __field(unsigned long, task_ratelimit)
453 __field(unsigned long, balanced_dirty_ratelimit)
454 __field(unsigned int, cgroup_ino)
458 strscpy_pad(__entry->bdi, bdi_dev_name(wb->bdi), 32);
459 __entry->write_bw = KBps(wb->write_bandwidth);
460 __entry->avg_write_bw = KBps(wb->avg_write_bandwidth);
461 __entry->dirty_rate = KBps(dirty_rate);
462 __entry->dirty_ratelimit = KBps(wb->dirty_ratelimit);
463 __entry->task_ratelimit = KBps(task_ratelimit);
464 __entry->balanced_dirty_ratelimit =
465 KBps(wb->balanced_dirty_ratelimit);
466 __entry->cgroup_ino = __trace_wb_assign_cgroup(wb);
470 "write_bw=%lu awrite_bw=%lu dirty_rate=%lu "
471 "dirty_ratelimit=%lu task_ratelimit=%lu "
472 "balanced_dirty_ratelimit=%lu cgroup_ino=%u",
474 __entry->write_bw, /* write bandwidth */
475 __entry->avg_write_bw, /* avg write bandwidth */
476 __entry->dirty_rate, /* bdi dirty rate */
477 __entry->dirty_ratelimit, /* base ratelimit */
478 __entry->task_ratelimit, /* ratelimit with position control */
479 __entry->balanced_dirty_ratelimit, /* the balanced ratelimit */
484 TRACE_EVENT(balance_dirty_pages,
486 TP_PROTO(struct bdi_writeback *wb,
487 unsigned long thresh,
488 unsigned long bg_thresh,
490 unsigned long bdi_thresh,
491 unsigned long bdi_dirty,
492 unsigned long dirty_ratelimit,
493 unsigned long task_ratelimit,
494 unsigned long dirtied,
495 unsigned long period,
497 unsigned long start_time),
499 TP_ARGS(wb, thresh, bg_thresh, dirty, bdi_thresh, bdi_dirty,
500 dirty_ratelimit, task_ratelimit,
501 dirtied, period, pause, start_time),
504 __array( char, bdi, 32)
505 __field(unsigned long, limit)
506 __field(unsigned long, setpoint)
507 __field(unsigned long, dirty)
508 __field(unsigned long, bdi_setpoint)
509 __field(unsigned long, bdi_dirty)
510 __field(unsigned long, dirty_ratelimit)
511 __field(unsigned long, task_ratelimit)
512 __field(unsigned int, dirtied)
513 __field(unsigned int, dirtied_pause)
514 __field(unsigned long, paused)
515 __field( long, pause)
516 __field(unsigned long, period)
517 __field( long, think)
518 __field(unsigned int, cgroup_ino)
522 unsigned long freerun = (thresh + bg_thresh) / 2;
523 strscpy_pad(__entry->bdi, bdi_dev_name(wb->bdi), 32);
525 __entry->limit = global_wb_domain.dirty_limit;
526 __entry->setpoint = (global_wb_domain.dirty_limit +
528 __entry->dirty = dirty;
529 __entry->bdi_setpoint = __entry->setpoint *
530 bdi_thresh / (thresh + 1);
531 __entry->bdi_dirty = bdi_dirty;
532 __entry->dirty_ratelimit = KBps(dirty_ratelimit);
533 __entry->task_ratelimit = KBps(task_ratelimit);
534 __entry->dirtied = dirtied;
535 __entry->dirtied_pause = current->nr_dirtied_pause;
536 __entry->think = current->dirty_paused_when == 0 ? 0 :
537 (long)(jiffies - current->dirty_paused_when) * 1000/HZ;
538 __entry->period = period * 1000 / HZ;
539 __entry->pause = pause * 1000 / HZ;
540 __entry->paused = (jiffies - start_time) * 1000 / HZ;
541 __entry->cgroup_ino = __trace_wb_assign_cgroup(wb);
546 "limit=%lu setpoint=%lu dirty=%lu "
547 "bdi_setpoint=%lu bdi_dirty=%lu "
548 "dirty_ratelimit=%lu task_ratelimit=%lu "
549 "dirtied=%u dirtied_pause=%u "
550 "paused=%lu pause=%ld period=%lu think=%ld cgroup_ino=%u",
555 __entry->bdi_setpoint,
557 __entry->dirty_ratelimit,
558 __entry->task_ratelimit,
560 __entry->dirtied_pause,
561 __entry->paused, /* ms */
562 __entry->pause, /* ms */
563 __entry->period, /* ms */
564 __entry->think, /* ms */
569 TRACE_EVENT(writeback_sb_inodes_requeue,
571 TP_PROTO(struct inode *inode),
575 __array(char, name, 32)
576 __field(unsigned long, ino)
577 __field(unsigned long, state)
578 __field(unsigned long, dirtied_when)
579 __field(unsigned int, cgroup_ino)
583 strscpy_pad(__entry->name,
584 bdi_dev_name(inode_to_bdi(inode)), 32);
585 __entry->ino = inode->i_ino;
586 __entry->state = inode->i_state;
587 __entry->dirtied_when = inode->dirtied_when;
588 __entry->cgroup_ino = __trace_wb_assign_cgroup(inode_to_wb(inode));
591 TP_printk("bdi %s: ino=%lu state=%s dirtied_when=%lu age=%lu cgroup_ino=%u",
594 show_inode_state(__entry->state),
595 __entry->dirtied_when,
596 (jiffies - __entry->dirtied_when) / HZ,
601 DECLARE_EVENT_CLASS(writeback_congest_waited_template,
603 TP_PROTO(unsigned int usec_timeout, unsigned int usec_delayed),
605 TP_ARGS(usec_timeout, usec_delayed),
608 __field( unsigned int, usec_timeout )
609 __field( unsigned int, usec_delayed )
613 __entry->usec_timeout = usec_timeout;
614 __entry->usec_delayed = usec_delayed;
617 TP_printk("usec_timeout=%u usec_delayed=%u",
618 __entry->usec_timeout,
619 __entry->usec_delayed)
622 DEFINE_EVENT(writeback_congest_waited_template, writeback_congestion_wait,
624 TP_PROTO(unsigned int usec_timeout, unsigned int usec_delayed),
626 TP_ARGS(usec_timeout, usec_delayed)
629 DEFINE_EVENT(writeback_congest_waited_template, writeback_wait_iff_congested,
631 TP_PROTO(unsigned int usec_timeout, unsigned int usec_delayed),
633 TP_ARGS(usec_timeout, usec_delayed)
636 DECLARE_EVENT_CLASS(writeback_single_inode_template,
638 TP_PROTO(struct inode *inode,
639 struct writeback_control *wbc,
640 unsigned long nr_to_write
643 TP_ARGS(inode, wbc, nr_to_write),
646 __array(char, name, 32)
647 __field(unsigned long, ino)
648 __field(unsigned long, state)
649 __field(unsigned long, dirtied_when)
650 __field(unsigned long, writeback_index)
651 __field(long, nr_to_write)
652 __field(unsigned long, wrote)
653 __field(unsigned int, cgroup_ino)
657 strscpy_pad(__entry->name,
658 bdi_dev_name(inode_to_bdi(inode)), 32);
659 __entry->ino = inode->i_ino;
660 __entry->state = inode->i_state;
661 __entry->dirtied_when = inode->dirtied_when;
662 __entry->writeback_index = inode->i_mapping->writeback_index;
663 __entry->nr_to_write = nr_to_write;
664 __entry->wrote = nr_to_write - wbc->nr_to_write;
665 __entry->cgroup_ino = __trace_wbc_assign_cgroup(wbc);
668 TP_printk("bdi %s: ino=%lu state=%s dirtied_when=%lu age=%lu "
669 "index=%lu to_write=%ld wrote=%lu cgroup_ino=%u",
672 show_inode_state(__entry->state),
673 __entry->dirtied_when,
674 (jiffies - __entry->dirtied_when) / HZ,
675 __entry->writeback_index,
676 __entry->nr_to_write,
682 DEFINE_EVENT(writeback_single_inode_template, writeback_single_inode_start,
683 TP_PROTO(struct inode *inode,
684 struct writeback_control *wbc,
685 unsigned long nr_to_write),
686 TP_ARGS(inode, wbc, nr_to_write)
689 DEFINE_EVENT(writeback_single_inode_template, writeback_single_inode,
690 TP_PROTO(struct inode *inode,
691 struct writeback_control *wbc,
692 unsigned long nr_to_write),
693 TP_ARGS(inode, wbc, nr_to_write)
696 DECLARE_EVENT_CLASS(writeback_inode_template,
697 TP_PROTO(struct inode *inode),
702 __field( dev_t, dev )
703 __field(unsigned long, ino )
704 __field(unsigned long, state )
705 __field( __u16, mode )
706 __field(unsigned long, dirtied_when )
710 __entry->dev = inode->i_sb->s_dev;
711 __entry->ino = inode->i_ino;
712 __entry->state = inode->i_state;
713 __entry->mode = inode->i_mode;
714 __entry->dirtied_when = inode->dirtied_when;
717 TP_printk("dev %d,%d ino %lu dirtied %lu state %s mode 0%o",
718 MAJOR(__entry->dev), MINOR(__entry->dev),
719 __entry->ino, __entry->dirtied_when,
720 show_inode_state(__entry->state), __entry->mode)
723 DEFINE_EVENT(writeback_inode_template, writeback_lazytime,
724 TP_PROTO(struct inode *inode),
729 DEFINE_EVENT(writeback_inode_template, writeback_lazytime_iput,
730 TP_PROTO(struct inode *inode),
735 DEFINE_EVENT(writeback_inode_template, writeback_dirty_inode_enqueue,
737 TP_PROTO(struct inode *inode),
743 * Inode writeback list tracking.
746 DEFINE_EVENT(writeback_inode_template, sb_mark_inode_writeback,
747 TP_PROTO(struct inode *inode),
751 DEFINE_EVENT(writeback_inode_template, sb_clear_inode_writeback,
752 TP_PROTO(struct inode *inode),
756 #endif /* _TRACE_WRITEBACK_H */
758 /* This part must be outside protection */
759 #include <trace/define_trace.h>