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_DIRTY_TIME_EXPIRED, "I_DIRTY_TIME_EXPIRED"}, \
24 {I_REFERENCED, "I_REFERENCED"} \
27 /* enums need to be exported to user space */
30 #define EM(a,b) TRACE_DEFINE_ENUM(a);
31 #define EMe(a,b) TRACE_DEFINE_ENUM(a);
33 #define WB_WORK_REASON \
34 EM( WB_REASON_BACKGROUND, "background") \
35 EM( WB_REASON_VMSCAN, "vmscan") \
36 EM( WB_REASON_SYNC, "sync") \
37 EM( WB_REASON_PERIODIC, "periodic") \
38 EM( WB_REASON_LAPTOP_TIMER, "laptop_timer") \
39 EM( WB_REASON_FREE_MORE_MEM, "free_more_memory") \
40 EM( WB_REASON_FS_FREE_SPACE, "fs_free_space") \
41 EMe(WB_REASON_FORKER_THREAD, "forker_thread")
46 * Now redefine the EM() and EMe() macros to map the enums to the strings
47 * that will be printed in the output.
51 #define EM(a,b) { a, b },
52 #define EMe(a,b) { a, b }
54 struct wb_writeback_work;
56 TRACE_EVENT(writeback_dirty_page,
58 TP_PROTO(struct page *page, struct address_space *mapping),
60 TP_ARGS(page, mapping),
63 __array(char, name, 32)
64 __field(unsigned long, ino)
65 __field(pgoff_t, index)
69 strncpy(__entry->name,
70 mapping ? dev_name(inode_to_bdi(mapping->host)->dev) : "(unknown)", 32);
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 strncpy(__entry->name,
100 bdi->dev ? dev_name(bdi->dev) : "(unknown)", 32);
101 __entry->ino = inode->i_ino;
102 __entry->state = inode->i_state;
103 __entry->flags = flags;
106 TP_printk("bdi %s: ino=%lu state=%s flags=%s",
109 show_inode_state(__entry->state),
110 show_inode_state(__entry->flags)
114 DEFINE_EVENT(writeback_dirty_inode_template, writeback_mark_inode_dirty,
116 TP_PROTO(struct inode *inode, int flags),
118 TP_ARGS(inode, flags)
121 DEFINE_EVENT(writeback_dirty_inode_template, writeback_dirty_inode_start,
123 TP_PROTO(struct inode *inode, int flags),
125 TP_ARGS(inode, flags)
128 DEFINE_EVENT(writeback_dirty_inode_template, writeback_dirty_inode,
130 TP_PROTO(struct inode *inode, int flags),
132 TP_ARGS(inode, flags)
135 #ifdef CREATE_TRACE_POINTS
136 #ifdef CONFIG_CGROUP_WRITEBACK
138 static inline unsigned int __trace_wb_assign_cgroup(struct bdi_writeback *wb)
140 return wb->memcg_css->cgroup->kn->id.ino;
143 static inline unsigned int __trace_wbc_assign_cgroup(struct writeback_control *wbc)
146 return __trace_wb_assign_cgroup(wbc->wb);
150 #else /* CONFIG_CGROUP_WRITEBACK */
152 static inline unsigned int __trace_wb_assign_cgroup(struct bdi_writeback *wb)
157 static inline unsigned int __trace_wbc_assign_cgroup(struct writeback_control *wbc)
162 #endif /* CONFIG_CGROUP_WRITEBACK */
163 #endif /* CREATE_TRACE_POINTS */
165 DECLARE_EVENT_CLASS(writeback_write_inode_template,
167 TP_PROTO(struct inode *inode, struct writeback_control *wbc),
172 __array(char, name, 32)
173 __field(unsigned long, ino)
174 __field(int, sync_mode)
175 __field(unsigned int, cgroup_ino)
179 strncpy(__entry->name,
180 dev_name(inode_to_bdi(inode)->dev), 32);
181 __entry->ino = inode->i_ino;
182 __entry->sync_mode = wbc->sync_mode;
183 __entry->cgroup_ino = __trace_wbc_assign_cgroup(wbc);
186 TP_printk("bdi %s: ino=%lu sync_mode=%d cgroup_ino=%u",
194 DEFINE_EVENT(writeback_write_inode_template, writeback_write_inode_start,
196 TP_PROTO(struct inode *inode, struct writeback_control *wbc),
201 DEFINE_EVENT(writeback_write_inode_template, writeback_write_inode,
203 TP_PROTO(struct inode *inode, struct writeback_control *wbc),
208 DECLARE_EVENT_CLASS(writeback_work_class,
209 TP_PROTO(struct bdi_writeback *wb, struct wb_writeback_work *work),
212 __array(char, name, 32)
213 __field(long, nr_pages)
214 __field(dev_t, sb_dev)
215 __field(int, sync_mode)
216 __field(int, for_kupdate)
217 __field(int, range_cyclic)
218 __field(int, for_background)
220 __field(unsigned int, cgroup_ino)
223 strncpy(__entry->name,
224 wb->bdi->dev ? dev_name(wb->bdi->dev) : "(unknown)", 32);
225 __entry->nr_pages = work->nr_pages;
226 __entry->sb_dev = work->sb ? work->sb->s_dev : 0;
227 __entry->sync_mode = work->sync_mode;
228 __entry->for_kupdate = work->for_kupdate;
229 __entry->range_cyclic = work->range_cyclic;
230 __entry->for_background = work->for_background;
231 __entry->reason = work->reason;
232 __entry->cgroup_ino = __trace_wb_assign_cgroup(wb);
234 TP_printk("bdi %s: sb_dev %d:%d nr_pages=%ld sync_mode=%d "
235 "kupdate=%d range_cyclic=%d background=%d reason=%s cgroup_ino=%u",
237 MAJOR(__entry->sb_dev), MINOR(__entry->sb_dev),
240 __entry->for_kupdate,
241 __entry->range_cyclic,
242 __entry->for_background,
243 __print_symbolic(__entry->reason, WB_WORK_REASON),
247 #define DEFINE_WRITEBACK_WORK_EVENT(name) \
248 DEFINE_EVENT(writeback_work_class, name, \
249 TP_PROTO(struct bdi_writeback *wb, struct wb_writeback_work *work), \
251 DEFINE_WRITEBACK_WORK_EVENT(writeback_queue);
252 DEFINE_WRITEBACK_WORK_EVENT(writeback_exec);
253 DEFINE_WRITEBACK_WORK_EVENT(writeback_start);
254 DEFINE_WRITEBACK_WORK_EVENT(writeback_written);
255 DEFINE_WRITEBACK_WORK_EVENT(writeback_wait);
257 TRACE_EVENT(writeback_pages_written,
258 TP_PROTO(long pages_written),
259 TP_ARGS(pages_written),
264 __entry->pages = pages_written;
266 TP_printk("%ld", __entry->pages)
269 DECLARE_EVENT_CLASS(writeback_class,
270 TP_PROTO(struct bdi_writeback *wb),
273 __array(char, name, 32)
274 __field(unsigned int, cgroup_ino)
277 strncpy(__entry->name, dev_name(wb->bdi->dev), 32);
278 __entry->cgroup_ino = __trace_wb_assign_cgroup(wb);
280 TP_printk("bdi %s: cgroup_ino=%u",
285 #define DEFINE_WRITEBACK_EVENT(name) \
286 DEFINE_EVENT(writeback_class, name, \
287 TP_PROTO(struct bdi_writeback *wb), \
290 DEFINE_WRITEBACK_EVENT(writeback_nowork);
291 DEFINE_WRITEBACK_EVENT(writeback_wake_background);
293 TRACE_EVENT(writeback_bdi_register,
294 TP_PROTO(struct backing_dev_info *bdi),
297 __array(char, name, 32)
300 strncpy(__entry->name, dev_name(bdi->dev), 32);
307 DECLARE_EVENT_CLASS(wbc_class,
308 TP_PROTO(struct writeback_control *wbc, struct backing_dev_info *bdi),
311 __array(char, name, 32)
312 __field(long, nr_to_write)
313 __field(long, pages_skipped)
314 __field(int, sync_mode)
315 __field(int, for_kupdate)
316 __field(int, for_background)
317 __field(int, for_reclaim)
318 __field(int, range_cyclic)
319 __field(long, range_start)
320 __field(long, range_end)
321 __field(unsigned int, cgroup_ino)
325 strncpy(__entry->name, dev_name(bdi->dev), 32);
326 __entry->nr_to_write = wbc->nr_to_write;
327 __entry->pages_skipped = wbc->pages_skipped;
328 __entry->sync_mode = wbc->sync_mode;
329 __entry->for_kupdate = wbc->for_kupdate;
330 __entry->for_background = wbc->for_background;
331 __entry->for_reclaim = wbc->for_reclaim;
332 __entry->range_cyclic = wbc->range_cyclic;
333 __entry->range_start = (long)wbc->range_start;
334 __entry->range_end = (long)wbc->range_end;
335 __entry->cgroup_ino = __trace_wbc_assign_cgroup(wbc);
338 TP_printk("bdi %s: towrt=%ld skip=%ld mode=%d kupd=%d "
339 "bgrd=%d reclm=%d cyclic=%d "
340 "start=0x%lx end=0x%lx cgroup_ino=%u",
342 __entry->nr_to_write,
343 __entry->pages_skipped,
345 __entry->for_kupdate,
346 __entry->for_background,
347 __entry->for_reclaim,
348 __entry->range_cyclic,
349 __entry->range_start,
355 #define DEFINE_WBC_EVENT(name) \
356 DEFINE_EVENT(wbc_class, name, \
357 TP_PROTO(struct writeback_control *wbc, struct backing_dev_info *bdi), \
359 DEFINE_WBC_EVENT(wbc_writepage);
361 TRACE_EVENT(writeback_queue_io,
362 TP_PROTO(struct bdi_writeback *wb,
363 struct wb_writeback_work *work,
365 TP_ARGS(wb, work, moved),
367 __array(char, name, 32)
368 __field(unsigned long, older)
372 __field(unsigned int, cgroup_ino)
375 unsigned long *older_than_this = work->older_than_this;
376 strncpy(__entry->name, dev_name(wb->bdi->dev), 32);
377 __entry->older = older_than_this ? *older_than_this : 0;
378 __entry->age = older_than_this ?
379 (jiffies - *older_than_this) * 1000 / HZ : -1;
380 __entry->moved = moved;
381 __entry->reason = work->reason;
382 __entry->cgroup_ino = __trace_wb_assign_cgroup(wb);
384 TP_printk("bdi %s: older=%lu age=%ld enqueue=%d reason=%s cgroup_ino=%u",
386 __entry->older, /* older_than_this in jiffies */
387 __entry->age, /* older_than_this in relative milliseconds */
389 __print_symbolic(__entry->reason, WB_WORK_REASON),
394 TRACE_EVENT(global_dirty_state,
396 TP_PROTO(unsigned long background_thresh,
397 unsigned long dirty_thresh
400 TP_ARGS(background_thresh,
405 __field(unsigned long, nr_dirty)
406 __field(unsigned long, nr_writeback)
407 __field(unsigned long, nr_unstable)
408 __field(unsigned long, background_thresh)
409 __field(unsigned long, dirty_thresh)
410 __field(unsigned long, dirty_limit)
411 __field(unsigned long, nr_dirtied)
412 __field(unsigned long, nr_written)
416 __entry->nr_dirty = global_node_page_state(NR_FILE_DIRTY);
417 __entry->nr_writeback = global_node_page_state(NR_WRITEBACK);
418 __entry->nr_unstable = global_node_page_state(NR_UNSTABLE_NFS);
419 __entry->nr_dirtied = global_node_page_state(NR_DIRTIED);
420 __entry->nr_written = global_node_page_state(NR_WRITTEN);
421 __entry->background_thresh = background_thresh;
422 __entry->dirty_thresh = dirty_thresh;
423 __entry->dirty_limit = global_wb_domain.dirty_limit;
426 TP_printk("dirty=%lu writeback=%lu unstable=%lu "
427 "bg_thresh=%lu thresh=%lu limit=%lu "
428 "dirtied=%lu written=%lu",
430 __entry->nr_writeback,
431 __entry->nr_unstable,
432 __entry->background_thresh,
433 __entry->dirty_thresh,
434 __entry->dirty_limit,
440 #define KBps(x) ((x) << (PAGE_SHIFT - 10))
442 TRACE_EVENT(bdi_dirty_ratelimit,
444 TP_PROTO(struct bdi_writeback *wb,
445 unsigned long dirty_rate,
446 unsigned long task_ratelimit),
448 TP_ARGS(wb, dirty_rate, task_ratelimit),
451 __array(char, bdi, 32)
452 __field(unsigned long, write_bw)
453 __field(unsigned long, avg_write_bw)
454 __field(unsigned long, dirty_rate)
455 __field(unsigned long, dirty_ratelimit)
456 __field(unsigned long, task_ratelimit)
457 __field(unsigned long, balanced_dirty_ratelimit)
458 __field(unsigned int, cgroup_ino)
462 strlcpy(__entry->bdi, dev_name(wb->bdi->dev), 32);
463 __entry->write_bw = KBps(wb->write_bandwidth);
464 __entry->avg_write_bw = KBps(wb->avg_write_bandwidth);
465 __entry->dirty_rate = KBps(dirty_rate);
466 __entry->dirty_ratelimit = KBps(wb->dirty_ratelimit);
467 __entry->task_ratelimit = KBps(task_ratelimit);
468 __entry->balanced_dirty_ratelimit =
469 KBps(wb->balanced_dirty_ratelimit);
470 __entry->cgroup_ino = __trace_wb_assign_cgroup(wb);
474 "write_bw=%lu awrite_bw=%lu dirty_rate=%lu "
475 "dirty_ratelimit=%lu task_ratelimit=%lu "
476 "balanced_dirty_ratelimit=%lu cgroup_ino=%u",
478 __entry->write_bw, /* write bandwidth */
479 __entry->avg_write_bw, /* avg write bandwidth */
480 __entry->dirty_rate, /* bdi dirty rate */
481 __entry->dirty_ratelimit, /* base ratelimit */
482 __entry->task_ratelimit, /* ratelimit with position control */
483 __entry->balanced_dirty_ratelimit, /* the balanced ratelimit */
488 TRACE_EVENT(balance_dirty_pages,
490 TP_PROTO(struct bdi_writeback *wb,
491 unsigned long thresh,
492 unsigned long bg_thresh,
494 unsigned long bdi_thresh,
495 unsigned long bdi_dirty,
496 unsigned long dirty_ratelimit,
497 unsigned long task_ratelimit,
498 unsigned long dirtied,
499 unsigned long period,
501 unsigned long start_time),
503 TP_ARGS(wb, thresh, bg_thresh, dirty, bdi_thresh, bdi_dirty,
504 dirty_ratelimit, task_ratelimit,
505 dirtied, period, pause, start_time),
508 __array( char, bdi, 32)
509 __field(unsigned long, limit)
510 __field(unsigned long, setpoint)
511 __field(unsigned long, dirty)
512 __field(unsigned long, bdi_setpoint)
513 __field(unsigned long, bdi_dirty)
514 __field(unsigned long, dirty_ratelimit)
515 __field(unsigned long, task_ratelimit)
516 __field(unsigned int, dirtied)
517 __field(unsigned int, dirtied_pause)
518 __field(unsigned long, paused)
519 __field( long, pause)
520 __field(unsigned long, period)
521 __field( long, think)
522 __field(unsigned int, cgroup_ino)
526 unsigned long freerun = (thresh + bg_thresh) / 2;
527 strlcpy(__entry->bdi, dev_name(wb->bdi->dev), 32);
529 __entry->limit = global_wb_domain.dirty_limit;
530 __entry->setpoint = (global_wb_domain.dirty_limit +
532 __entry->dirty = dirty;
533 __entry->bdi_setpoint = __entry->setpoint *
534 bdi_thresh / (thresh + 1);
535 __entry->bdi_dirty = bdi_dirty;
536 __entry->dirty_ratelimit = KBps(dirty_ratelimit);
537 __entry->task_ratelimit = KBps(task_ratelimit);
538 __entry->dirtied = dirtied;
539 __entry->dirtied_pause = current->nr_dirtied_pause;
540 __entry->think = current->dirty_paused_when == 0 ? 0 :
541 (long)(jiffies - current->dirty_paused_when) * 1000/HZ;
542 __entry->period = period * 1000 / HZ;
543 __entry->pause = pause * 1000 / HZ;
544 __entry->paused = (jiffies - start_time) * 1000 / HZ;
545 __entry->cgroup_ino = __trace_wb_assign_cgroup(wb);
550 "limit=%lu setpoint=%lu dirty=%lu "
551 "bdi_setpoint=%lu bdi_dirty=%lu "
552 "dirty_ratelimit=%lu task_ratelimit=%lu "
553 "dirtied=%u dirtied_pause=%u "
554 "paused=%lu pause=%ld period=%lu think=%ld cgroup_ino=%u",
559 __entry->bdi_setpoint,
561 __entry->dirty_ratelimit,
562 __entry->task_ratelimit,
564 __entry->dirtied_pause,
565 __entry->paused, /* ms */
566 __entry->pause, /* ms */
567 __entry->period, /* ms */
568 __entry->think, /* ms */
573 TRACE_EVENT(writeback_sb_inodes_requeue,
575 TP_PROTO(struct inode *inode),
579 __array(char, name, 32)
580 __field(unsigned long, ino)
581 __field(unsigned long, state)
582 __field(unsigned long, dirtied_when)
583 __field(unsigned int, cgroup_ino)
587 strncpy(__entry->name,
588 dev_name(inode_to_bdi(inode)->dev), 32);
589 __entry->ino = inode->i_ino;
590 __entry->state = inode->i_state;
591 __entry->dirtied_when = inode->dirtied_when;
592 __entry->cgroup_ino = __trace_wb_assign_cgroup(inode_to_wb(inode));
595 TP_printk("bdi %s: ino=%lu state=%s dirtied_when=%lu age=%lu cgroup_ino=%u",
598 show_inode_state(__entry->state),
599 __entry->dirtied_when,
600 (jiffies - __entry->dirtied_when) / HZ,
605 DECLARE_EVENT_CLASS(writeback_congest_waited_template,
607 TP_PROTO(unsigned int usec_timeout, unsigned int usec_delayed),
609 TP_ARGS(usec_timeout, usec_delayed),
612 __field( unsigned int, usec_timeout )
613 __field( unsigned int, usec_delayed )
617 __entry->usec_timeout = usec_timeout;
618 __entry->usec_delayed = usec_delayed;
621 TP_printk("usec_timeout=%u usec_delayed=%u",
622 __entry->usec_timeout,
623 __entry->usec_delayed)
626 DEFINE_EVENT(writeback_congest_waited_template, writeback_congestion_wait,
628 TP_PROTO(unsigned int usec_timeout, unsigned int usec_delayed),
630 TP_ARGS(usec_timeout, usec_delayed)
633 DEFINE_EVENT(writeback_congest_waited_template, writeback_wait_iff_congested,
635 TP_PROTO(unsigned int usec_timeout, unsigned int usec_delayed),
637 TP_ARGS(usec_timeout, usec_delayed)
640 DECLARE_EVENT_CLASS(writeback_single_inode_template,
642 TP_PROTO(struct inode *inode,
643 struct writeback_control *wbc,
644 unsigned long nr_to_write
647 TP_ARGS(inode, wbc, nr_to_write),
650 __array(char, name, 32)
651 __field(unsigned long, ino)
652 __field(unsigned long, state)
653 __field(unsigned long, dirtied_when)
654 __field(unsigned long, writeback_index)
655 __field(long, nr_to_write)
656 __field(unsigned long, wrote)
657 __field(unsigned int, cgroup_ino)
661 strncpy(__entry->name,
662 dev_name(inode_to_bdi(inode)->dev), 32);
663 __entry->ino = inode->i_ino;
664 __entry->state = inode->i_state;
665 __entry->dirtied_when = inode->dirtied_when;
666 __entry->writeback_index = inode->i_mapping->writeback_index;
667 __entry->nr_to_write = nr_to_write;
668 __entry->wrote = nr_to_write - wbc->nr_to_write;
669 __entry->cgroup_ino = __trace_wbc_assign_cgroup(wbc);
672 TP_printk("bdi %s: ino=%lu state=%s dirtied_when=%lu age=%lu "
673 "index=%lu to_write=%ld wrote=%lu cgroup_ino=%u",
676 show_inode_state(__entry->state),
677 __entry->dirtied_when,
678 (jiffies - __entry->dirtied_when) / HZ,
679 __entry->writeback_index,
680 __entry->nr_to_write,
686 DEFINE_EVENT(writeback_single_inode_template, writeback_single_inode_start,
687 TP_PROTO(struct inode *inode,
688 struct writeback_control *wbc,
689 unsigned long nr_to_write),
690 TP_ARGS(inode, wbc, nr_to_write)
693 DEFINE_EVENT(writeback_single_inode_template, writeback_single_inode,
694 TP_PROTO(struct inode *inode,
695 struct writeback_control *wbc,
696 unsigned long nr_to_write),
697 TP_ARGS(inode, wbc, nr_to_write)
700 DECLARE_EVENT_CLASS(writeback_inode_template,
701 TP_PROTO(struct inode *inode),
706 __field( dev_t, dev )
707 __field(unsigned long, ino )
708 __field(unsigned long, state )
709 __field( __u16, mode )
710 __field(unsigned long, dirtied_when )
714 __entry->dev = inode->i_sb->s_dev;
715 __entry->ino = inode->i_ino;
716 __entry->state = inode->i_state;
717 __entry->mode = inode->i_mode;
718 __entry->dirtied_when = inode->dirtied_when;
721 TP_printk("dev %d,%d ino %lu dirtied %lu state %s mode 0%o",
722 MAJOR(__entry->dev), MINOR(__entry->dev),
723 __entry->ino, __entry->dirtied_when,
724 show_inode_state(__entry->state), __entry->mode)
727 DEFINE_EVENT(writeback_inode_template, writeback_lazytime,
728 TP_PROTO(struct inode *inode),
733 DEFINE_EVENT(writeback_inode_template, writeback_lazytime_iput,
734 TP_PROTO(struct inode *inode),
739 DEFINE_EVENT(writeback_inode_template, writeback_dirty_inode_enqueue,
741 TP_PROTO(struct inode *inode),
747 * Inode writeback list tracking.
750 DEFINE_EVENT(writeback_inode_template, sb_mark_inode_writeback,
751 TP_PROTO(struct inode *inode),
755 DEFINE_EVENT(writeback_inode_template, sb_clear_inode_writeback,
756 TP_PROTO(struct inode *inode),
760 #endif /* _TRACE_WRITEBACK_H */
762 /* This part must be outside protection */
763 #include <trace/define_trace.h>