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 DECLARE_EVENT_CLASS(writeback_page_template,
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 DEFINE_EVENT(writeback_page_template, writeback_dirty_page,
84 TP_PROTO(struct page *page, struct address_space *mapping),
86 TP_ARGS(page, mapping)
89 DEFINE_EVENT(writeback_page_template, wait_on_page_writeback,
91 TP_PROTO(struct page *page, struct address_space *mapping),
93 TP_ARGS(page, mapping)
96 DECLARE_EVENT_CLASS(writeback_dirty_inode_template,
98 TP_PROTO(struct inode *inode, int flags),
100 TP_ARGS(inode, flags),
103 __array(char, name, 32)
104 __field(unsigned long, ino)
105 __field(unsigned long, state)
106 __field(unsigned long, flags)
110 struct backing_dev_info *bdi = inode_to_bdi(inode);
112 /* may be called for files on pseudo FSes w/ unregistered bdi */
113 strncpy(__entry->name,
114 bdi->dev ? dev_name(bdi->dev) : "(unknown)", 32);
115 __entry->ino = inode->i_ino;
116 __entry->state = inode->i_state;
117 __entry->flags = flags;
120 TP_printk("bdi %s: ino=%lu state=%s flags=%s",
123 show_inode_state(__entry->state),
124 show_inode_state(__entry->flags)
128 DEFINE_EVENT(writeback_dirty_inode_template, writeback_mark_inode_dirty,
130 TP_PROTO(struct inode *inode, int flags),
132 TP_ARGS(inode, flags)
135 DEFINE_EVENT(writeback_dirty_inode_template, writeback_dirty_inode_start,
137 TP_PROTO(struct inode *inode, int flags),
139 TP_ARGS(inode, flags)
142 DEFINE_EVENT(writeback_dirty_inode_template, writeback_dirty_inode,
144 TP_PROTO(struct inode *inode, int flags),
146 TP_ARGS(inode, flags)
149 #ifdef CREATE_TRACE_POINTS
150 #ifdef CONFIG_CGROUP_WRITEBACK
152 static inline unsigned int __trace_wb_assign_cgroup(struct bdi_writeback *wb)
154 return wb->memcg_css->cgroup->kn->id.ino;
157 static inline unsigned int __trace_wbc_assign_cgroup(struct writeback_control *wbc)
160 return __trace_wb_assign_cgroup(wbc->wb);
164 #else /* CONFIG_CGROUP_WRITEBACK */
166 static inline unsigned int __trace_wb_assign_cgroup(struct bdi_writeback *wb)
171 static inline unsigned int __trace_wbc_assign_cgroup(struct writeback_control *wbc)
176 #endif /* CONFIG_CGROUP_WRITEBACK */
177 #endif /* CREATE_TRACE_POINTS */
179 DECLARE_EVENT_CLASS(writeback_write_inode_template,
181 TP_PROTO(struct inode *inode, struct writeback_control *wbc),
186 __array(char, name, 32)
187 __field(unsigned long, ino)
188 __field(int, sync_mode)
189 __field(unsigned int, cgroup_ino)
193 strncpy(__entry->name,
194 dev_name(inode_to_bdi(inode)->dev), 32);
195 __entry->ino = inode->i_ino;
196 __entry->sync_mode = wbc->sync_mode;
197 __entry->cgroup_ino = __trace_wbc_assign_cgroup(wbc);
200 TP_printk("bdi %s: ino=%lu sync_mode=%d cgroup_ino=%u",
208 DEFINE_EVENT(writeback_write_inode_template, writeback_write_inode_start,
210 TP_PROTO(struct inode *inode, struct writeback_control *wbc),
215 DEFINE_EVENT(writeback_write_inode_template, writeback_write_inode,
217 TP_PROTO(struct inode *inode, struct writeback_control *wbc),
222 DECLARE_EVENT_CLASS(writeback_work_class,
223 TP_PROTO(struct bdi_writeback *wb, struct wb_writeback_work *work),
226 __array(char, name, 32)
227 __field(long, nr_pages)
228 __field(dev_t, sb_dev)
229 __field(int, sync_mode)
230 __field(int, for_kupdate)
231 __field(int, range_cyclic)
232 __field(int, for_background)
234 __field(unsigned int, cgroup_ino)
237 strncpy(__entry->name,
238 wb->bdi->dev ? dev_name(wb->bdi->dev) : "(unknown)", 32);
239 __entry->nr_pages = work->nr_pages;
240 __entry->sb_dev = work->sb ? work->sb->s_dev : 0;
241 __entry->sync_mode = work->sync_mode;
242 __entry->for_kupdate = work->for_kupdate;
243 __entry->range_cyclic = work->range_cyclic;
244 __entry->for_background = work->for_background;
245 __entry->reason = work->reason;
246 __entry->cgroup_ino = __trace_wb_assign_cgroup(wb);
248 TP_printk("bdi %s: sb_dev %d:%d nr_pages=%ld sync_mode=%d "
249 "kupdate=%d range_cyclic=%d background=%d reason=%s cgroup_ino=%u",
251 MAJOR(__entry->sb_dev), MINOR(__entry->sb_dev),
254 __entry->for_kupdate,
255 __entry->range_cyclic,
256 __entry->for_background,
257 __print_symbolic(__entry->reason, WB_WORK_REASON),
261 #define DEFINE_WRITEBACK_WORK_EVENT(name) \
262 DEFINE_EVENT(writeback_work_class, name, \
263 TP_PROTO(struct bdi_writeback *wb, struct wb_writeback_work *work), \
265 DEFINE_WRITEBACK_WORK_EVENT(writeback_queue);
266 DEFINE_WRITEBACK_WORK_EVENT(writeback_exec);
267 DEFINE_WRITEBACK_WORK_EVENT(writeback_start);
268 DEFINE_WRITEBACK_WORK_EVENT(writeback_written);
269 DEFINE_WRITEBACK_WORK_EVENT(writeback_wait);
271 TRACE_EVENT(writeback_pages_written,
272 TP_PROTO(long pages_written),
273 TP_ARGS(pages_written),
278 __entry->pages = pages_written;
280 TP_printk("%ld", __entry->pages)
283 DECLARE_EVENT_CLASS(writeback_class,
284 TP_PROTO(struct bdi_writeback *wb),
287 __array(char, name, 32)
288 __field(unsigned int, cgroup_ino)
291 strncpy(__entry->name, dev_name(wb->bdi->dev), 32);
292 __entry->cgroup_ino = __trace_wb_assign_cgroup(wb);
294 TP_printk("bdi %s: cgroup_ino=%u",
299 #define DEFINE_WRITEBACK_EVENT(name) \
300 DEFINE_EVENT(writeback_class, name, \
301 TP_PROTO(struct bdi_writeback *wb), \
304 DEFINE_WRITEBACK_EVENT(writeback_wake_background);
306 TRACE_EVENT(writeback_bdi_register,
307 TP_PROTO(struct backing_dev_info *bdi),
310 __array(char, name, 32)
313 strncpy(__entry->name, dev_name(bdi->dev), 32);
320 DECLARE_EVENT_CLASS(wbc_class,
321 TP_PROTO(struct writeback_control *wbc, struct backing_dev_info *bdi),
324 __array(char, name, 32)
325 __field(long, nr_to_write)
326 __field(long, pages_skipped)
327 __field(int, sync_mode)
328 __field(int, for_kupdate)
329 __field(int, for_background)
330 __field(int, for_reclaim)
331 __field(int, range_cyclic)
332 __field(long, range_start)
333 __field(long, range_end)
334 __field(unsigned int, cgroup_ino)
338 strncpy(__entry->name, dev_name(bdi->dev), 32);
339 __entry->nr_to_write = wbc->nr_to_write;
340 __entry->pages_skipped = wbc->pages_skipped;
341 __entry->sync_mode = wbc->sync_mode;
342 __entry->for_kupdate = wbc->for_kupdate;
343 __entry->for_background = wbc->for_background;
344 __entry->for_reclaim = wbc->for_reclaim;
345 __entry->range_cyclic = wbc->range_cyclic;
346 __entry->range_start = (long)wbc->range_start;
347 __entry->range_end = (long)wbc->range_end;
348 __entry->cgroup_ino = __trace_wbc_assign_cgroup(wbc);
351 TP_printk("bdi %s: towrt=%ld skip=%ld mode=%d kupd=%d "
352 "bgrd=%d reclm=%d cyclic=%d "
353 "start=0x%lx end=0x%lx cgroup_ino=%u",
355 __entry->nr_to_write,
356 __entry->pages_skipped,
358 __entry->for_kupdate,
359 __entry->for_background,
360 __entry->for_reclaim,
361 __entry->range_cyclic,
362 __entry->range_start,
368 #define DEFINE_WBC_EVENT(name) \
369 DEFINE_EVENT(wbc_class, name, \
370 TP_PROTO(struct writeback_control *wbc, struct backing_dev_info *bdi), \
372 DEFINE_WBC_EVENT(wbc_writepage);
374 TRACE_EVENT(writeback_queue_io,
375 TP_PROTO(struct bdi_writeback *wb,
376 struct wb_writeback_work *work,
378 TP_ARGS(wb, work, moved),
380 __array(char, name, 32)
381 __field(unsigned long, older)
385 __field(unsigned int, cgroup_ino)
388 unsigned long *older_than_this = work->older_than_this;
389 strncpy(__entry->name, dev_name(wb->bdi->dev), 32);
390 __entry->older = older_than_this ? *older_than_this : 0;
391 __entry->age = older_than_this ?
392 (jiffies - *older_than_this) * 1000 / HZ : -1;
393 __entry->moved = moved;
394 __entry->reason = work->reason;
395 __entry->cgroup_ino = __trace_wb_assign_cgroup(wb);
397 TP_printk("bdi %s: older=%lu age=%ld enqueue=%d reason=%s cgroup_ino=%u",
399 __entry->older, /* older_than_this in jiffies */
400 __entry->age, /* older_than_this in relative milliseconds */
402 __print_symbolic(__entry->reason, WB_WORK_REASON),
407 TRACE_EVENT(global_dirty_state,
409 TP_PROTO(unsigned long background_thresh,
410 unsigned long dirty_thresh
413 TP_ARGS(background_thresh,
418 __field(unsigned long, nr_dirty)
419 __field(unsigned long, nr_writeback)
420 __field(unsigned long, nr_unstable)
421 __field(unsigned long, background_thresh)
422 __field(unsigned long, dirty_thresh)
423 __field(unsigned long, dirty_limit)
424 __field(unsigned long, nr_dirtied)
425 __field(unsigned long, nr_written)
429 __entry->nr_dirty = global_node_page_state(NR_FILE_DIRTY);
430 __entry->nr_writeback = global_node_page_state(NR_WRITEBACK);
431 __entry->nr_unstable = global_node_page_state(NR_UNSTABLE_NFS);
432 __entry->nr_dirtied = global_node_page_state(NR_DIRTIED);
433 __entry->nr_written = global_node_page_state(NR_WRITTEN);
434 __entry->background_thresh = background_thresh;
435 __entry->dirty_thresh = dirty_thresh;
436 __entry->dirty_limit = global_wb_domain.dirty_limit;
439 TP_printk("dirty=%lu writeback=%lu unstable=%lu "
440 "bg_thresh=%lu thresh=%lu limit=%lu "
441 "dirtied=%lu written=%lu",
443 __entry->nr_writeback,
444 __entry->nr_unstable,
445 __entry->background_thresh,
446 __entry->dirty_thresh,
447 __entry->dirty_limit,
453 #define KBps(x) ((x) << (PAGE_SHIFT - 10))
455 TRACE_EVENT(bdi_dirty_ratelimit,
457 TP_PROTO(struct bdi_writeback *wb,
458 unsigned long dirty_rate,
459 unsigned long task_ratelimit),
461 TP_ARGS(wb, dirty_rate, task_ratelimit),
464 __array(char, bdi, 32)
465 __field(unsigned long, write_bw)
466 __field(unsigned long, avg_write_bw)
467 __field(unsigned long, dirty_rate)
468 __field(unsigned long, dirty_ratelimit)
469 __field(unsigned long, task_ratelimit)
470 __field(unsigned long, balanced_dirty_ratelimit)
471 __field(unsigned int, cgroup_ino)
475 strlcpy(__entry->bdi, dev_name(wb->bdi->dev), 32);
476 __entry->write_bw = KBps(wb->write_bandwidth);
477 __entry->avg_write_bw = KBps(wb->avg_write_bandwidth);
478 __entry->dirty_rate = KBps(dirty_rate);
479 __entry->dirty_ratelimit = KBps(wb->dirty_ratelimit);
480 __entry->task_ratelimit = KBps(task_ratelimit);
481 __entry->balanced_dirty_ratelimit =
482 KBps(wb->balanced_dirty_ratelimit);
483 __entry->cgroup_ino = __trace_wb_assign_cgroup(wb);
487 "write_bw=%lu awrite_bw=%lu dirty_rate=%lu "
488 "dirty_ratelimit=%lu task_ratelimit=%lu "
489 "balanced_dirty_ratelimit=%lu cgroup_ino=%u",
491 __entry->write_bw, /* write bandwidth */
492 __entry->avg_write_bw, /* avg write bandwidth */
493 __entry->dirty_rate, /* bdi dirty rate */
494 __entry->dirty_ratelimit, /* base ratelimit */
495 __entry->task_ratelimit, /* ratelimit with position control */
496 __entry->balanced_dirty_ratelimit, /* the balanced ratelimit */
501 TRACE_EVENT(balance_dirty_pages,
503 TP_PROTO(struct bdi_writeback *wb,
504 unsigned long thresh,
505 unsigned long bg_thresh,
507 unsigned long bdi_thresh,
508 unsigned long bdi_dirty,
509 unsigned long dirty_ratelimit,
510 unsigned long task_ratelimit,
511 unsigned long dirtied,
512 unsigned long period,
514 unsigned long start_time),
516 TP_ARGS(wb, thresh, bg_thresh, dirty, bdi_thresh, bdi_dirty,
517 dirty_ratelimit, task_ratelimit,
518 dirtied, period, pause, start_time),
521 __array( char, bdi, 32)
522 __field(unsigned long, limit)
523 __field(unsigned long, setpoint)
524 __field(unsigned long, dirty)
525 __field(unsigned long, bdi_setpoint)
526 __field(unsigned long, bdi_dirty)
527 __field(unsigned long, dirty_ratelimit)
528 __field(unsigned long, task_ratelimit)
529 __field(unsigned int, dirtied)
530 __field(unsigned int, dirtied_pause)
531 __field(unsigned long, paused)
532 __field( long, pause)
533 __field(unsigned long, period)
534 __field( long, think)
535 __field(unsigned int, cgroup_ino)
539 unsigned long freerun = (thresh + bg_thresh) / 2;
540 strlcpy(__entry->bdi, dev_name(wb->bdi->dev), 32);
542 __entry->limit = global_wb_domain.dirty_limit;
543 __entry->setpoint = (global_wb_domain.dirty_limit +
545 __entry->dirty = dirty;
546 __entry->bdi_setpoint = __entry->setpoint *
547 bdi_thresh / (thresh + 1);
548 __entry->bdi_dirty = bdi_dirty;
549 __entry->dirty_ratelimit = KBps(dirty_ratelimit);
550 __entry->task_ratelimit = KBps(task_ratelimit);
551 __entry->dirtied = dirtied;
552 __entry->dirtied_pause = current->nr_dirtied_pause;
553 __entry->think = current->dirty_paused_when == 0 ? 0 :
554 (long)(jiffies - current->dirty_paused_when) * 1000/HZ;
555 __entry->period = period * 1000 / HZ;
556 __entry->pause = pause * 1000 / HZ;
557 __entry->paused = (jiffies - start_time) * 1000 / HZ;
558 __entry->cgroup_ino = __trace_wb_assign_cgroup(wb);
563 "limit=%lu setpoint=%lu dirty=%lu "
564 "bdi_setpoint=%lu bdi_dirty=%lu "
565 "dirty_ratelimit=%lu task_ratelimit=%lu "
566 "dirtied=%u dirtied_pause=%u "
567 "paused=%lu pause=%ld period=%lu think=%ld cgroup_ino=%u",
572 __entry->bdi_setpoint,
574 __entry->dirty_ratelimit,
575 __entry->task_ratelimit,
577 __entry->dirtied_pause,
578 __entry->paused, /* ms */
579 __entry->pause, /* ms */
580 __entry->period, /* ms */
581 __entry->think, /* ms */
586 TRACE_EVENT(writeback_sb_inodes_requeue,
588 TP_PROTO(struct inode *inode),
592 __array(char, name, 32)
593 __field(unsigned long, ino)
594 __field(unsigned long, state)
595 __field(unsigned long, dirtied_when)
596 __field(unsigned int, cgroup_ino)
600 strncpy(__entry->name,
601 dev_name(inode_to_bdi(inode)->dev), 32);
602 __entry->ino = inode->i_ino;
603 __entry->state = inode->i_state;
604 __entry->dirtied_when = inode->dirtied_when;
605 __entry->cgroup_ino = __trace_wb_assign_cgroup(inode_to_wb(inode));
608 TP_printk("bdi %s: ino=%lu state=%s dirtied_when=%lu age=%lu cgroup_ino=%u",
611 show_inode_state(__entry->state),
612 __entry->dirtied_when,
613 (jiffies - __entry->dirtied_when) / HZ,
618 DECLARE_EVENT_CLASS(writeback_congest_waited_template,
620 TP_PROTO(unsigned int usec_timeout, unsigned int usec_delayed),
622 TP_ARGS(usec_timeout, usec_delayed),
625 __field( unsigned int, usec_timeout )
626 __field( unsigned int, usec_delayed )
630 __entry->usec_timeout = usec_timeout;
631 __entry->usec_delayed = usec_delayed;
634 TP_printk("usec_timeout=%u usec_delayed=%u",
635 __entry->usec_timeout,
636 __entry->usec_delayed)
639 DEFINE_EVENT(writeback_congest_waited_template, writeback_congestion_wait,
641 TP_PROTO(unsigned int usec_timeout, unsigned int usec_delayed),
643 TP_ARGS(usec_timeout, usec_delayed)
646 DEFINE_EVENT(writeback_congest_waited_template, writeback_wait_iff_congested,
648 TP_PROTO(unsigned int usec_timeout, unsigned int usec_delayed),
650 TP_ARGS(usec_timeout, usec_delayed)
653 DECLARE_EVENT_CLASS(writeback_single_inode_template,
655 TP_PROTO(struct inode *inode,
656 struct writeback_control *wbc,
657 unsigned long nr_to_write
660 TP_ARGS(inode, wbc, nr_to_write),
663 __array(char, name, 32)
664 __field(unsigned long, ino)
665 __field(unsigned long, state)
666 __field(unsigned long, dirtied_when)
667 __field(unsigned long, writeback_index)
668 __field(long, nr_to_write)
669 __field(unsigned long, wrote)
670 __field(unsigned int, cgroup_ino)
674 strncpy(__entry->name,
675 dev_name(inode_to_bdi(inode)->dev), 32);
676 __entry->ino = inode->i_ino;
677 __entry->state = inode->i_state;
678 __entry->dirtied_when = inode->dirtied_when;
679 __entry->writeback_index = inode->i_mapping->writeback_index;
680 __entry->nr_to_write = nr_to_write;
681 __entry->wrote = nr_to_write - wbc->nr_to_write;
682 __entry->cgroup_ino = __trace_wbc_assign_cgroup(wbc);
685 TP_printk("bdi %s: ino=%lu state=%s dirtied_when=%lu age=%lu "
686 "index=%lu to_write=%ld wrote=%lu cgroup_ino=%u",
689 show_inode_state(__entry->state),
690 __entry->dirtied_when,
691 (jiffies - __entry->dirtied_when) / HZ,
692 __entry->writeback_index,
693 __entry->nr_to_write,
699 DEFINE_EVENT(writeback_single_inode_template, writeback_single_inode_start,
700 TP_PROTO(struct inode *inode,
701 struct writeback_control *wbc,
702 unsigned long nr_to_write),
703 TP_ARGS(inode, wbc, nr_to_write)
706 DEFINE_EVENT(writeback_single_inode_template, writeback_single_inode,
707 TP_PROTO(struct inode *inode,
708 struct writeback_control *wbc,
709 unsigned long nr_to_write),
710 TP_ARGS(inode, wbc, nr_to_write)
713 DECLARE_EVENT_CLASS(writeback_inode_template,
714 TP_PROTO(struct inode *inode),
719 __field( dev_t, dev )
720 __field(unsigned long, ino )
721 __field(unsigned long, state )
722 __field( __u16, mode )
723 __field(unsigned long, dirtied_when )
727 __entry->dev = inode->i_sb->s_dev;
728 __entry->ino = inode->i_ino;
729 __entry->state = inode->i_state;
730 __entry->mode = inode->i_mode;
731 __entry->dirtied_when = inode->dirtied_when;
734 TP_printk("dev %d,%d ino %lu dirtied %lu state %s mode 0%o",
735 MAJOR(__entry->dev), MINOR(__entry->dev),
736 __entry->ino, __entry->dirtied_when,
737 show_inode_state(__entry->state), __entry->mode)
740 DEFINE_EVENT(writeback_inode_template, writeback_lazytime,
741 TP_PROTO(struct inode *inode),
746 DEFINE_EVENT(writeback_inode_template, writeback_lazytime_iput,
747 TP_PROTO(struct inode *inode),
752 DEFINE_EVENT(writeback_inode_template, writeback_dirty_inode_enqueue,
754 TP_PROTO(struct inode *inode),
760 * Inode writeback list tracking.
763 DEFINE_EVENT(writeback_inode_template, sb_mark_inode_writeback,
764 TP_PROTO(struct inode *inode),
768 DEFINE_EVENT(writeback_inode_template, sb_clear_inode_writeback,
769 TP_PROTO(struct inode *inode),
773 #endif /* _TRACE_WRITEBACK_H */
775 /* This part must be outside protection */
776 #include <trace/define_trace.h>