trace.h

  1/* SPDX-License-Identifier: GPL-2.0 */
  2/*
  3 * Copyright (c) 2009-2021 Christoph Hellwig
  4 *
  5 * NOTE: none of these tracepoints shall be considered a stable kernel ABI
  6 * as they can change at any time.
  7 *
  8 * Current conventions for printing numbers measuring specific units:
  9 *
 10 * offset: byte offset into a subcomponent of a file operation
 11 * pos: file offset, in bytes
 12 * length: length of a file operation, in bytes
 13 * ino: inode number
 14 *
 15 * Numbers describing space allocations should be formatted in hexadecimal.
 16 */
 17#undef TRACE_SYSTEM
 18#define TRACE_SYSTEM iomap
 19
 20#if !defined(_IOMAP_TRACE_H) || defined(TRACE_HEADER_MULTI_READ)
 21#define _IOMAP_TRACE_H
 22
 23#include <linux/tracepoint.h>
 24
 25struct inode;
 26
 27DECLARE_EVENT_CLASS(iomap_readpage_class,
 28	TP_PROTO(struct inode *inode, int nr_pages),
 29	TP_ARGS(inode, nr_pages),
 30	TP_STRUCT__entry(
 31		__field(dev_t, dev)
 32		__field(u64, ino)
 33		__field(int, nr_pages)
 34	),
 35	TP_fast_assign(
 36		__entry->dev = inode->i_sb->s_dev;
 37		__entry->ino = inode->i_ino;
 38		__entry->nr_pages = nr_pages;
 39	),
 40	TP_printk("dev %d:%d ino 0x%llx nr_pages %d",
 41		  MAJOR(__entry->dev), MINOR(__entry->dev),
 42		  __entry->ino,
 43		  __entry->nr_pages)
 44)
 45
 46#define DEFINE_READPAGE_EVENT(name)		\
 47DEFINE_EVENT(iomap_readpage_class, name,	\
 48	TP_PROTO(struct inode *inode, int nr_pages), \
 49	TP_ARGS(inode, nr_pages))
 50DEFINE_READPAGE_EVENT(iomap_readpage);
 51DEFINE_READPAGE_EVENT(iomap_readahead);
 52
 53DECLARE_EVENT_CLASS(iomap_range_class,
 54	TP_PROTO(struct inode *inode, loff_t off, u64 len),
 55	TP_ARGS(inode, off, len),
 56	TP_STRUCT__entry(
 57		__field(dev_t, dev)
 58		__field(u64, ino)
 59		__field(loff_t, size)
 60		__field(loff_t, offset)
 61		__field(u64, length)
 62	),
 63	TP_fast_assign(
 64		__entry->dev = inode->i_sb->s_dev;
 65		__entry->ino = inode->i_ino;
 66		__entry->size = i_size_read(inode);
 67		__entry->offset = off;
 68		__entry->length = len;
 69	),
 70	TP_printk("dev %d:%d ino 0x%llx size 0x%llx offset 0x%llx length 0x%llx",
 71		  MAJOR(__entry->dev), MINOR(__entry->dev),
 72		  __entry->ino,
 73		  __entry->size,
 74		  __entry->offset,
 75		  __entry->length)
 76)
 77
 78#define DEFINE_RANGE_EVENT(name)		\
 79DEFINE_EVENT(iomap_range_class, name,	\
 80	TP_PROTO(struct inode *inode, loff_t off, u64 len),\
 81	TP_ARGS(inode, off, len))
 82DEFINE_RANGE_EVENT(iomap_writeback_folio);
 83DEFINE_RANGE_EVENT(iomap_release_folio);
 84DEFINE_RANGE_EVENT(iomap_invalidate_folio);
 85DEFINE_RANGE_EVENT(iomap_dio_invalidate_fail);
 86DEFINE_RANGE_EVENT(iomap_dio_rw_queued);
 87DEFINE_RANGE_EVENT(iomap_zero_iter);
 88
 89#define IOMAP_TYPE_STRINGS \
 90	{ IOMAP_HOLE,		"HOLE" }, \
 91	{ IOMAP_DELALLOC,	"DELALLOC" }, \
 92	{ IOMAP_MAPPED,		"MAPPED" }, \
 93	{ IOMAP_UNWRITTEN,	"UNWRITTEN" }, \
 94	{ IOMAP_INLINE,		"INLINE" }
 95
 96#define IOMAP_FLAGS_STRINGS \
 97	{ IOMAP_WRITE,		"WRITE" }, \
 98	{ IOMAP_ZERO,		"ZERO" }, \
 99	{ IOMAP_REPORT,		"REPORT" }, \
100	{ IOMAP_FAULT,		"FAULT" }, \
101	{ IOMAP_DIRECT,		"DIRECT" }, \
102	{ IOMAP_NOWAIT,		"NOWAIT" }, \
103	{ IOMAP_OVERWRITE_ONLY,	"OVERWRITE_ONLY" }, \
104	{ IOMAP_UNSHARE,	"UNSHARE" }, \
105	{ IOMAP_DAX,		"DAX" }, \
106	{ IOMAP_ATOMIC,		"ATOMIC" }, \
107	{ IOMAP_DONTCACHE,	"DONTCACHE" }
108
109#define IOMAP_F_FLAGS_STRINGS \
110	{ IOMAP_F_NEW,		"NEW" }, \
111	{ IOMAP_F_DIRTY,	"DIRTY" }, \
112	{ IOMAP_F_SHARED,	"SHARED" }, \
113	{ IOMAP_F_MERGED,	"MERGED" }, \
114	{ IOMAP_F_BUFFER_HEAD,	"BH" }, \
115	{ IOMAP_F_XATTR,	"XATTR" }, \
116	{ IOMAP_F_BOUNDARY,	"BOUNDARY" }, \
117	{ IOMAP_F_ANON_WRITE,	"ANON_WRITE" }, \
118	{ IOMAP_F_ATOMIC_BIO,	"ATOMIC_BIO" }, \
119	{ IOMAP_F_PRIVATE,	"PRIVATE" }, \
120	{ IOMAP_F_SIZE_CHANGED,	"SIZE_CHANGED" }, \
121	{ IOMAP_F_STALE,	"STALE" }
122
123
124#define IOMAP_DIO_STRINGS \
125	{IOMAP_DIO_FORCE_WAIT,		"DIO_FORCE_WAIT" }, \
126	{IOMAP_DIO_OVERWRITE_ONLY,	"DIO_OVERWRITE_ONLY" }, \
127	{IOMAP_DIO_PARTIAL,		"DIO_PARTIAL" }, \
128	{IOMAP_DIO_FSBLOCK_ALIGNED,	"DIO_FSBLOCK_ALIGNED" }
129
130DECLARE_EVENT_CLASS(iomap_class,
131	TP_PROTO(struct inode *inode, struct iomap *iomap),
132	TP_ARGS(inode, iomap),
133	TP_STRUCT__entry(
134		__field(dev_t, dev)
135		__field(u64, ino)
136		__field(u64, addr)
137		__field(loff_t, offset)
138		__field(u64, length)
139		__field(u16, type)
140		__field(u16, flags)
141		__field(dev_t, bdev)
142	),
143	TP_fast_assign(
144		__entry->dev = inode->i_sb->s_dev;
145		__entry->ino = inode->i_ino;
146		__entry->addr = iomap->addr;
147		__entry->offset = iomap->offset;
148		__entry->length = iomap->length;
149		__entry->type = iomap->type;
150		__entry->flags = iomap->flags;
151		__entry->bdev = iomap->bdev ? iomap->bdev->bd_dev : 0;
152	),
153	TP_printk("dev %d:%d ino 0x%llx bdev %d:%d addr 0x%llx offset 0x%llx "
154		  "length 0x%llx type %s (0x%x) flags %s (0x%x)",
155		  MAJOR(__entry->dev), MINOR(__entry->dev),
156		  __entry->ino,
157		  MAJOR(__entry->bdev), MINOR(__entry->bdev),
158		  __entry->addr,
159		  __entry->offset,
160		  __entry->length,
161		  __print_symbolic(__entry->type, IOMAP_TYPE_STRINGS),
162		  __entry->type,
163		  __print_flags(__entry->flags, "|", IOMAP_F_FLAGS_STRINGS),
164		  __entry->flags)
165)
166
167#define DEFINE_IOMAP_EVENT(name)		\
168DEFINE_EVENT(iomap_class, name,	\
169	TP_PROTO(struct inode *inode, struct iomap *iomap), \
170	TP_ARGS(inode, iomap))
171DEFINE_IOMAP_EVENT(iomap_iter_dstmap);
172DEFINE_IOMAP_EVENT(iomap_iter_srcmap);
173
174TRACE_EVENT(iomap_add_to_ioend,
175	TP_PROTO(struct inode *inode, u64 pos, unsigned int dirty_len,
176		 struct iomap *iomap),
177	TP_ARGS(inode, pos, dirty_len, iomap),
178	TP_STRUCT__entry(
179		__field(dev_t, dev)
180		__field(u64, ino)
181		__field(u64, pos)
182		__field(u64, dirty_len)
183		__field(u64, addr)
184		__field(loff_t, offset)
185		__field(u64, length)
186		__field(u16, type)
187		__field(u16, flags)
188		__field(dev_t, bdev)
189	),
190	TP_fast_assign(
191		__entry->dev = inode->i_sb->s_dev;
192		__entry->ino = inode->i_ino;
193		__entry->pos = pos;
194		__entry->dirty_len = dirty_len;
195		__entry->addr = iomap->addr;
196		__entry->offset = iomap->offset;
197		__entry->length = iomap->length;
198		__entry->type = iomap->type;
199		__entry->flags = iomap->flags;
200		__entry->bdev = iomap->bdev ? iomap->bdev->bd_dev : 0;
201	),
202	TP_printk("dev %d:%d ino 0x%llx bdev %d:%d pos 0x%llx dirty len 0x%llx "
203		  "addr 0x%llx offset 0x%llx length 0x%llx type %s (0x%x) flags %s (0x%x)",
204		  MAJOR(__entry->dev), MINOR(__entry->dev),
205		  __entry->ino,
206		  MAJOR(__entry->bdev), MINOR(__entry->bdev),
207		  __entry->pos,
208		  __entry->dirty_len,
209		  __entry->addr,
210		  __entry->offset,
211		  __entry->length,
212		  __print_symbolic(__entry->type, IOMAP_TYPE_STRINGS),
213		  __entry->type,
214		  __print_flags(__entry->flags, "|", IOMAP_F_FLAGS_STRINGS),
215		  __entry->flags)
216);
217
218TRACE_EVENT(iomap_iter,
219	TP_PROTO(struct iomap_iter *iter, const void *ops,
220		 unsigned long caller),
221	TP_ARGS(iter, ops, caller),
222	TP_STRUCT__entry(
223		__field(dev_t, dev)
224		__field(u64, ino)
225		__field(loff_t, pos)
226		__field(u64, length)
227		__field(int, status)
228		__field(unsigned int, flags)
229		__field(const void *, ops)
230		__field(unsigned long, caller)
231	),
232	TP_fast_assign(
233		__entry->dev = iter->inode->i_sb->s_dev;
234		__entry->ino = iter->inode->i_ino;
235		__entry->pos = iter->pos;
236		__entry->length = iomap_length(iter);
237		__entry->status = iter->status;
238		__entry->flags = iter->flags;
239		__entry->ops = ops;
240		__entry->caller = caller;
241	),
242	TP_printk("dev %d:%d ino 0x%llx pos 0x%llx length 0x%llx status %d flags %s (0x%x) ops %ps caller %pS",
243		  MAJOR(__entry->dev), MINOR(__entry->dev),
244		   __entry->ino,
245		   __entry->pos,
246		   __entry->length,
247		   __entry->status,
248		   __print_flags(__entry->flags, "|", IOMAP_FLAGS_STRINGS),
249		   __entry->flags,
250		   __entry->ops,
251		   (void *)__entry->caller)
252);
253
254TRACE_EVENT(iomap_dio_rw_begin,
255	TP_PROTO(struct kiocb *iocb, struct iov_iter *iter,
256		 unsigned int dio_flags, size_t done_before),
257	TP_ARGS(iocb, iter, dio_flags, done_before),
258	TP_STRUCT__entry(
259		__field(dev_t,	dev)
260		__field(ino_t,	ino)
261		__field(loff_t, isize)
262		__field(loff_t, pos)
263		__field(size_t,	count)
264		__field(size_t,	done_before)
265		__field(int,	ki_flags)
266		__field(unsigned int,	dio_flags)
267		__field(bool,	aio)
268	),
269	TP_fast_assign(
270		__entry->dev = file_inode(iocb->ki_filp)->i_sb->s_dev;
271		__entry->ino = file_inode(iocb->ki_filp)->i_ino;
272		__entry->isize = file_inode(iocb->ki_filp)->i_size;
273		__entry->pos = iocb->ki_pos;
274		__entry->count = iov_iter_count(iter);
275		__entry->done_before = done_before;
276		__entry->ki_flags = iocb->ki_flags;
277		__entry->dio_flags = dio_flags;
278		__entry->aio = !is_sync_kiocb(iocb);
279	),
280	TP_printk("dev %d:%d ino 0x%lx size 0x%llx offset 0x%llx length 0x%zx done_before 0x%zx flags %s dio_flags %s aio %d",
281		  MAJOR(__entry->dev), MINOR(__entry->dev),
282		  __entry->ino,
283		  __entry->isize,
284		  __entry->pos,
285		  __entry->count,
286		  __entry->done_before,
287		  __print_flags(__entry->ki_flags, "|", TRACE_IOCB_STRINGS),
288		  __print_flags(__entry->dio_flags, "|", IOMAP_DIO_STRINGS),
289		  __entry->aio)
290);
291
292TRACE_EVENT(iomap_dio_complete,
293	TP_PROTO(struct kiocb *iocb, int error, ssize_t ret),
294	TP_ARGS(iocb, error, ret),
295	TP_STRUCT__entry(
296		__field(dev_t,	dev)
297		__field(ino_t,	ino)
298		__field(loff_t, isize)
299		__field(loff_t, pos)
300		__field(int,	ki_flags)
301		__field(bool,	aio)
302		__field(int,	error)
303		__field(ssize_t, ret)
304	),
305	TP_fast_assign(
306		__entry->dev = file_inode(iocb->ki_filp)->i_sb->s_dev;
307		__entry->ino = file_inode(iocb->ki_filp)->i_ino;
308		__entry->isize = file_inode(iocb->ki_filp)->i_size;
309		__entry->pos = iocb->ki_pos;
310		__entry->ki_flags = iocb->ki_flags;
311		__entry->aio = !is_sync_kiocb(iocb);
312		__entry->error = error;
313		__entry->ret = ret;
314	),
315	TP_printk("dev %d:%d ino 0x%lx size 0x%llx offset 0x%llx flags %s aio %d error %d ret %zd",
316		  MAJOR(__entry->dev), MINOR(__entry->dev),
317		  __entry->ino,
318		  __entry->isize,
319		  __entry->pos,
320		  __print_flags(__entry->ki_flags, "|", TRACE_IOCB_STRINGS),
321		  __entry->aio,
322		  __entry->error,
323		  __entry->ret)
324);
325
326#endif /* _IOMAP_TRACE_H */
327
328#undef TRACE_INCLUDE_PATH
329#define TRACE_INCLUDE_PATH .
330#define TRACE_INCLUDE_FILE trace
331#include <trace/define_trace.h>