[linux-block.git] / fs / iomap / trace.h

/* SPDX-License-Identifier: GPL-2.0 */
/*
 * Copyright (c) 2009-2021 Christoph Hellwig
 *
 * NOTE: none of these tracepoints shall be considered a stable kernel ABI
 * as they can change at any time.
 *
 * Current conventions for printing numbers measuring specific units:
 *
 * offset: byte offset into a subcomponent of a file operation
 * pos: file offset, in bytes
 * length: length of a file operation, in bytes
 * ino: inode number
 *
 * Numbers describing space allocations should be formatted in hexadecimal.
 */
#undef TRACE_SYSTEM
#define TRACE_SYSTEM iomap

#if !defined(_IOMAP_TRACE_H) || defined(TRACE_HEADER_MULTI_READ)
#define _IOMAP_TRACE_H

#include <linux/tracepoint.h>

struct inode;

DECLARE_EVENT_CLASS(iomap_readpage_class,
	TP_PROTO(struct inode *inode, int nr_pages),
	TP_ARGS(inode, nr_pages),
	TP_STRUCT__entry(
		__field(dev_t, dev)
		__field(u64, ino)
		__field(int, nr_pages)
	),
	TP_fast_assign(
		__entry->dev = inode->i_sb->s_dev;
		__entry->ino = inode->i_ino;
		__entry->nr_pages = nr_pages;
	),
	TP_printk("dev %d:%d ino 0x%llx nr_pages %d",
		  MAJOR(__entry->dev), MINOR(__entry->dev),
		  __entry->ino,
		  __entry->nr_pages)
)

#define DEFINE_READPAGE_EVENT(name)		\
DEFINE_EVENT(iomap_readpage_class, name,	\
	TP_PROTO(struct inode *inode, int nr_pages), \
	TP_ARGS(inode, nr_pages))
DEFINE_READPAGE_EVENT(iomap_readpage);
DEFINE_READPAGE_EVENT(iomap_readahead);

DECLARE_EVENT_CLASS(iomap_range_class,
	TP_PROTO(struct inode *inode, loff_t off, u64 len),
	TP_ARGS(inode, off, len),
	TP_STRUCT__entry(
		__field(dev_t, dev)
		__field(u64, ino)
		__field(loff_t, size)
		__field(loff_t, offset)
		__field(u64, length)
	),
	TP_fast_assign(
		__entry->dev = inode->i_sb->s_dev;
		__entry->ino = inode->i_ino;
		__entry->size = i_size_read(inode);
		__entry->offset = off;
		__entry->length = len;
	),
	TP_printk("dev %d:%d ino 0x%llx size 0x%llx offset 0x%llx length 0x%llx",
		  MAJOR(__entry->dev), MINOR(__entry->dev),
		  __entry->ino,
		  __entry->size,
		  __entry->offset,
		  __entry->length)
)

#define DEFINE_RANGE_EVENT(name)		\
DEFINE_EVENT(iomap_range_class, name,	\
	TP_PROTO(struct inode *inode, loff_t off, u64 len),\
	TP_ARGS(inode, off, len))
DEFINE_RANGE_EVENT(iomap_writepage);
DEFINE_RANGE_EVENT(iomap_release_folio);
DEFINE_RANGE_EVENT(iomap_invalidate_folio);
DEFINE_RANGE_EVENT(iomap_dio_invalidate_fail);
DEFINE_RANGE_EVENT(iomap_dio_rw_queued);

#define IOMAP_TYPE_STRINGS \
	{ IOMAP_HOLE,		"HOLE" }, \
	{ IOMAP_DELALLOC,	"DELALLOC" }, \
	{ IOMAP_MAPPED,		"MAPPED" }, \
	{ IOMAP_UNWRITTEN,	"UNWRITTEN" }, \
	{ IOMAP_INLINE,		"INLINE" }

#define IOMAP_FLAGS_STRINGS \
	{ IOMAP_WRITE,		"WRITE" }, \
	{ IOMAP_ZERO,		"ZERO" }, \
	{ IOMAP_REPORT,		"REPORT" }, \
	{ IOMAP_FAULT,		"FAULT" }, \
	{ IOMAP_DIRECT,		"DIRECT" }, \
	{ IOMAP_NOWAIT,		"NOWAIT" }

#define IOMAP_F_FLAGS_STRINGS \
	{ IOMAP_F_NEW,		"NEW" }, \
	{ IOMAP_F_DIRTY,	"DIRTY" }, \
	{ IOMAP_F_SHARED,	"SHARED" }, \
	{ IOMAP_F_MERGED,	"MERGED" }, \
	{ IOMAP_F_BUFFER_HEAD,	"BH" }, \
	{ IOMAP_F_SIZE_CHANGED,	"SIZE_CHANGED" }

#define IOMAP_DIO_STRINGS \
	{IOMAP_DIO_FORCE_WAIT,	"DIO_FORCE_WAIT" }, \
	{IOMAP_DIO_OVERWRITE_ONLY, "DIO_OVERWRITE_ONLY" }, \
	{IOMAP_DIO_PARTIAL,	"DIO_PARTIAL" }

DECLARE_EVENT_CLASS(iomap_class,
	TP_PROTO(struct inode *inode, struct iomap *iomap),
	TP_ARGS(inode, iomap),
	TP_STRUCT__entry(
		__field(dev_t, dev)
		__field(u64, ino)
		__field(u64, addr)
		__field(loff_t, offset)
		__field(u64, length)
		__field(u16, type)
		__field(u16, flags)
		__field(dev_t, bdev)
	),
	TP_fast_assign(
		__entry->dev = inode->i_sb->s_dev;
		__entry->ino = inode->i_ino;
		__entry->addr = iomap->addr;
		__entry->offset = iomap->offset;
		__entry->length = iomap->length;
		__entry->type = iomap->type;
		__entry->flags = iomap->flags;
		__entry->bdev = iomap->bdev ? iomap->bdev->bd_dev : 0;
	),
	TP_printk("dev %d:%d ino 0x%llx bdev %d:%d addr 0x%llx offset 0x%llx "
		  "length 0x%llx type %s flags %s",
		  MAJOR(__entry->dev), MINOR(__entry->dev),
		  __entry->ino,
		  MAJOR(__entry->bdev), MINOR(__entry->bdev),
		  __entry->addr,
		  __entry->offset,
		  __entry->length,
		  __print_symbolic(__entry->type, IOMAP_TYPE_STRINGS),
		  __print_flags(__entry->flags, "|", IOMAP_F_FLAGS_STRINGS))
)

#define DEFINE_IOMAP_EVENT(name)		\
DEFINE_EVENT(iomap_class, name,	\
	TP_PROTO(struct inode *inode, struct iomap *iomap), \
	TP_ARGS(inode, iomap))
DEFINE_IOMAP_EVENT(iomap_iter_dstmap);
DEFINE_IOMAP_EVENT(iomap_iter_srcmap);
DEFINE_IOMAP_EVENT(iomap_writepage_map);

TRACE_EVENT(iomap_iter,
	TP_PROTO(struct iomap_iter *iter, const void *ops,
		 unsigned long caller),
	TP_ARGS(iter, ops, caller),
	TP_STRUCT__entry(
		__field(dev_t, dev)
		__field(u64, ino)
		__field(loff_t, pos)
		__field(u64, length)
		__field(unsigned int, flags)
		__field(const void *, ops)
		__field(unsigned long, caller)
	),
	TP_fast_assign(
		__entry->dev = iter->inode->i_sb->s_dev;
		__entry->ino = iter->inode->i_ino;
		__entry->pos = iter->pos;
		__entry->length = iomap_length(iter);
		__entry->flags = iter->flags;
		__entry->ops = ops;
		__entry->caller = caller;
	),
	TP_printk("dev %d:%d ino 0x%llx pos 0x%llx length 0x%llx flags %s (0x%x) ops %ps caller %pS",
		  MAJOR(__entry->dev), MINOR(__entry->dev),
		   __entry->ino,
		   __entry->pos,
		   __entry->length,
		   __print_flags(__entry->flags, "|", IOMAP_FLAGS_STRINGS),
		   __entry->flags,
		   __entry->ops,
		   (void *)__entry->caller)
);

TRACE_EVENT(iomap_dio_rw_begin,
	TP_PROTO(struct kiocb *iocb, struct iov_iter *iter,
		 unsigned int dio_flags, size_t done_before),
	TP_ARGS(iocb, iter, dio_flags, done_before),
	TP_STRUCT__entry(
		__field(dev_t,	dev)
		__field(ino_t,	ino)
		__field(loff_t, isize)
		__field(loff_t, pos)
		__field(size_t,	count)
		__field(size_t,	done_before)
		__field(int,	ki_flags)
		__field(unsigned int,	dio_flags)
		__field(bool,	aio)
	),
	TP_fast_assign(
		__entry->dev = file_inode(iocb->ki_filp)->i_sb->s_dev;
		__entry->ino = file_inode(iocb->ki_filp)->i_ino;
		__entry->isize = file_inode(iocb->ki_filp)->i_size;
		__entry->pos = iocb->ki_pos;
		__entry->count = iov_iter_count(iter);
		__entry->done_before = done_before;
		__entry->ki_flags = iocb->ki_flags;
		__entry->dio_flags = dio_flags;
		__entry->aio = !is_sync_kiocb(iocb);
	),
	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",
		  MAJOR(__entry->dev), MINOR(__entry->dev),
		  __entry->ino,
		  __entry->isize,
		  __entry->pos,
		  __entry->count,
		  __entry->done_before,
		  __print_flags(__entry->ki_flags, "|", TRACE_IOCB_STRINGS),
		  __print_flags(__entry->dio_flags, "|", IOMAP_DIO_STRINGS),
		  __entry->aio)
);

TRACE_EVENT(iomap_dio_complete,
	TP_PROTO(struct kiocb *iocb, int error, ssize_t ret),
	TP_ARGS(iocb, error, ret),
	TP_STRUCT__entry(
		__field(dev_t,	dev)
		__field(ino_t,	ino)
		__field(loff_t, isize)
		__field(loff_t, pos)
		__field(int,	ki_flags)
		__field(bool,	aio)
		__field(int,	error)
		__field(ssize_t, ret)
	),
	TP_fast_assign(
		__entry->dev = file_inode(iocb->ki_filp)->i_sb->s_dev;
		__entry->ino = file_inode(iocb->ki_filp)->i_ino;
		__entry->isize = file_inode(iocb->ki_filp)->i_size;
		__entry->pos = iocb->ki_pos;
		__entry->ki_flags = iocb->ki_flags;
		__entry->aio = !is_sync_kiocb(iocb);
		__entry->error = error;
		__entry->ret = ret;
	),
	TP_printk("dev %d:%d ino 0x%lx size 0x%llx offset 0x%llx flags %s aio %d error %d ret %zd",
		  MAJOR(__entry->dev), MINOR(__entry->dev),
		  __entry->ino,
		  __entry->isize,
		  __entry->pos,
		  __print_flags(__entry->ki_flags, "|", TRACE_IOCB_STRINGS),
		  __entry->aio,
		  __entry->error,
		  __entry->ret)
);

#endif /* _IOMAP_TRACE_H */

#undef TRACE_INCLUDE_PATH
#define TRACE_INCLUDE_PATH .
#define TRACE_INCLUDE_FILE trace
#include <trace/define_trace.h>
Commit	Line	Data
9e91c572 CH	1	/* SPDX-License-Identifier: GPL-2.0 */
9e91c572 CH	2	/*
f4b896c2	3	* Copyright (c) 2009-2021 Christoph Hellwig
9e91c572	4	*
d9d381f3	5	* NOTE: none of these tracepoints shall be considered a stable kernel ABI
9e91c572	6	* as they can change at any time.
03b8df8d DW	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.
9e91c572 CH	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
	25	struct inode;
	26
	27	DECLARE_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) \
	47	DEFINE_EVENT(iomap_readpage_class, name, \
	48	TP_PROTO(struct inode *inode, int nr_pages), \
	49	TP_ARGS(inode, nr_pages))
	50	DEFINE_READPAGE_EVENT(iomap_readpage);
9d24a13a	51	DEFINE_READPAGE_EVENT(iomap_readahead);
9e91c572	52
1ac99452	53	DECLARE_EVENT_CLASS(iomap_range_class,
03b8df8d	54	TP_PROTO(struct inode *inode, loff_t off, u64 len),
1ac99452	55	TP_ARGS(inode, off, len),
9e91c572 CH	56	TP_STRUCT__entry(
	57	__field(dev_t, dev)
	58	__field(u64, ino)
9e91c572	59	__field(loff_t, size)
03b8df8d DW	60	__field(loff_t, offset)
03b8df8d DW	61	__field(u64, length)
9e91c572 CH	62	),
	63	TP_fast_assign(
	64	__entry->dev = inode->i_sb->s_dev;
	65	__entry->ino = inode->i_ino;
9e91c572 CH	66	__entry->size = i_size_read(inode);
	67	__entry->offset = off;
	68	__entry->length = len;
	69	),
03b8df8d	70	TP_printk("dev %d:%d ino 0x%llx size 0x%llx offset 0x%llx length 0x%llx",
9e91c572 CH	71	MAJOR(__entry->dev), MINOR(__entry->dev),
9e91c572 CH	72	__entry->ino,
9e91c572 CH	73	__entry->size,
	74	__entry->offset,
	75	__entry->length)
	76	)
	77
1ac99452 MWO	78	#define DEFINE_RANGE_EVENT(name) \
1ac99452 MWO	79	DEFINE_EVENT(iomap_range_class, name, \
03b8df8d	80	TP_PROTO(struct inode *inode, loff_t off, u64 len),\
1ac99452 MWO	81	TP_ARGS(inode, off, len))
1ac99452 MWO	82	DEFINE_RANGE_EVENT(iomap_writepage);
8597447d	83	DEFINE_RANGE_EVENT(iomap_release_folio);
d82354f6	84	DEFINE_RANGE_EVENT(iomap_invalidate_folio);
60263d58	85	DEFINE_RANGE_EVENT(iomap_dio_invalidate_fail);
3fd41721	86	DEFINE_RANGE_EVENT(iomap_dio_rw_queued);
9e91c572	87
6334b91e DW	88	#define IOMAP_TYPE_STRINGS \
	89	{ IOMAP_HOLE, "HOLE" }, \
	90	{ IOMAP_DELALLOC, "DELALLOC" }, \
	91	{ IOMAP_MAPPED, "MAPPED" }, \
	92	{ IOMAP_UNWRITTEN, "UNWRITTEN" }, \
	93	{ IOMAP_INLINE, "INLINE" }
	94
	95	#define IOMAP_FLAGS_STRINGS \
	96	{ IOMAP_WRITE, "WRITE" }, \
	97	{ IOMAP_ZERO, "ZERO" }, \
	98	{ IOMAP_REPORT, "REPORT" }, \
	99	{ IOMAP_FAULT, "FAULT" }, \
	100	{ IOMAP_DIRECT, "DIRECT" }, \
	101	{ IOMAP_NOWAIT, "NOWAIT" }
	102
	103	#define IOMAP_F_FLAGS_STRINGS \
	104	{ IOMAP_F_NEW, "NEW" }, \
	105	{ IOMAP_F_DIRTY, "DIRTY" }, \
	106	{ IOMAP_F_SHARED, "SHARED" }, \
	107	{ IOMAP_F_MERGED, "MERGED" }, \
	108	{ IOMAP_F_BUFFER_HEAD, "BH" }, \
	109	{ IOMAP_F_SIZE_CHANGED, "SIZE_CHANGED" }
	110
3fd41721 RHI	111	#define IOMAP_DIO_STRINGS \
	112	{IOMAP_DIO_FORCE_WAIT, "DIO_FORCE_WAIT" }, \
	113	{IOMAP_DIO_OVERWRITE_ONLY, "DIO_OVERWRITE_ONLY" }, \
	114	{IOMAP_DIO_PARTIAL, "DIO_PARTIAL" }
	115
6334b91e DW	116	DECLARE_EVENT_CLASS(iomap_class,
	117	TP_PROTO(struct inode inode, struct iomap iomap),
	118	TP_ARGS(inode, iomap),
	119	TP_STRUCT__entry(
	120	__field(dev_t, dev)
	121	__field(u64, ino)
	122	__field(u64, addr)
	123	__field(loff_t, offset)
	124	__field(u64, length)
	125	__field(u16, type)
	126	__field(u16, flags)
	127	__field(dev_t, bdev)
	128	),
	129	TP_fast_assign(
	130	__entry->dev = inode->i_sb->s_dev;
	131	__entry->ino = inode->i_ino;
	132	__entry->addr = iomap->addr;
	133	__entry->offset = iomap->offset;
	134	__entry->length = iomap->length;
	135	__entry->type = iomap->type;
	136	__entry->flags = iomap->flags;
	137	__entry->bdev = iomap->bdev ? iomap->bdev->bd_dev : 0;
	138	),
03b8df8d DW	139	TP_printk("dev %d:%d ino 0x%llx bdev %d:%d addr 0x%llx offset 0x%llx "
03b8df8d DW	140	"length 0x%llx type %s flags %s",
6334b91e DW	141	MAJOR(__entry->dev), MINOR(__entry->dev),
	142	__entry->ino,
	143	MAJOR(__entry->bdev), MINOR(__entry->bdev),
	144	__entry->addr,
	145	__entry->offset,
	146	__entry->length,
	147	__print_symbolic(__entry->type, IOMAP_TYPE_STRINGS),
	148	__print_flags(__entry->flags, "\|", IOMAP_F_FLAGS_STRINGS))
	149	)
	150
	151	#define DEFINE_IOMAP_EVENT(name) \
	152	DEFINE_EVENT(iomap_class, name, \
	153	TP_PROTO(struct inode inode, struct iomap iomap), \
	154	TP_ARGS(inode, iomap))
f4b896c2 CH	155	DEFINE_IOMAP_EVENT(iomap_iter_dstmap);
f4b896c2 CH	156	DEFINE_IOMAP_EVENT(iomap_iter_srcmap);
adc9c2e5	157	DEFINE_IOMAP_EVENT(iomap_writepage_map);
6334b91e	158
f4b896c2 CH	159	TRACE_EVENT(iomap_iter,
	160	TP_PROTO(struct iomap_iter iter, const void ops,
	161	unsigned long caller),
	162	TP_ARGS(iter, ops, caller),
	163	TP_STRUCT__entry(
	164	__field(dev_t, dev)
	165	__field(u64, ino)
	166	__field(loff_t, pos)
03b8df8d	167	__field(u64, length)
f4b896c2 CH	168	__field(unsigned int, flags)
	169	__field(const void *, ops)
	170	__field(unsigned long, caller)
	171	),
	172	TP_fast_assign(
	173	__entry->dev = iter->inode->i_sb->s_dev;
	174	__entry->ino = iter->inode->i_ino;
	175	__entry->pos = iter->pos;
	176	__entry->length = iomap_length(iter);
	177	__entry->flags = iter->flags;
	178	__entry->ops = ops;
	179	__entry->caller = caller;
	180	),
03b8df8d	181	TP_printk("dev %d:%d ino 0x%llx pos 0x%llx length 0x%llx flags %s (0x%x) ops %ps caller %pS",
f4b896c2 CH	182	MAJOR(__entry->dev), MINOR(__entry->dev),
	183	__entry->ino,
	184	__entry->pos,
	185	__entry->length,
	186	__print_flags(__entry->flags, "\|", IOMAP_FLAGS_STRINGS),
	187	__entry->flags,
	188	__entry->ops,
	189	(void *)__entry->caller)
	190	);
	191
3fd41721 RHI	192	TRACE_EVENT(iomap_dio_rw_begin,
	193	TP_PROTO(struct kiocb iocb, struct iov_iter iter,
	194	unsigned int dio_flags, size_t done_before),
	195	TP_ARGS(iocb, iter, dio_flags, done_before),
	196	TP_STRUCT__entry(
	197	__field(dev_t, dev)
	198	__field(ino_t, ino)
	199	__field(loff_t, isize)
	200	__field(loff_t, pos)
	201	__field(size_t, count)
	202	__field(size_t, done_before)
	203	__field(int, ki_flags)
	204	__field(unsigned int, dio_flags)
	205	__field(bool, aio)
	206	),
	207	TP_fast_assign(
	208	__entry->dev = file_inode(iocb->ki_filp)->i_sb->s_dev;
	209	__entry->ino = file_inode(iocb->ki_filp)->i_ino;
	210	__entry->isize = file_inode(iocb->ki_filp)->i_size;
	211	__entry->pos = iocb->ki_pos;
	212	__entry->count = iov_iter_count(iter);
	213	__entry->done_before = done_before;
	214	__entry->ki_flags = iocb->ki_flags;
	215	__entry->dio_flags = dio_flags;
	216	__entry->aio = !is_sync_kiocb(iocb);
	217	),
	218	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",
	219	MAJOR(__entry->dev), MINOR(__entry->dev),
	220	__entry->ino,
	221	__entry->isize,
	222	__entry->pos,
	223	__entry->count,
	224	__entry->done_before,
	225	__print_flags(__entry->ki_flags, "\|", TRACE_IOCB_STRINGS),
	226	__print_flags(__entry->dio_flags, "\|", IOMAP_DIO_STRINGS),
	227	__entry->aio)
	228	);
	229
	230	TRACE_EVENT(iomap_dio_complete,
	231	TP_PROTO(struct kiocb *iocb, int error, ssize_t ret),
	232	TP_ARGS(iocb, error, ret),
	233	TP_STRUCT__entry(
	234	__field(dev_t, dev)
	235	__field(ino_t, ino)
	236	__field(loff_t, isize)
	237	__field(loff_t, pos)
	238	__field(int, ki_flags)
	239	__field(bool, aio)
	240	__field(int, error)
	241	__field(ssize_t, ret)
	242	),
	243	TP_fast_assign(
	244	__entry->dev = file_inode(iocb->ki_filp)->i_sb->s_dev;
	245	__entry->ino = file_inode(iocb->ki_filp)->i_ino;
	246	__entry->isize = file_inode(iocb->ki_filp)->i_size;
	247	__entry->pos = iocb->ki_pos;
	248	__entry->ki_flags = iocb->ki_flags;
	249	__entry->aio = !is_sync_kiocb(iocb);
	250	__entry->error = error;
	251	__entry->ret = ret;
	252	),
	253	TP_printk("dev %d:%d ino 0x%lx size 0x%llx offset 0x%llx flags %s aio %d error %d ret %zd",
	254	MAJOR(__entry->dev), MINOR(__entry->dev),
	255	__entry->ino,
256	__entry->isize,
257	__entry->pos,
258	__print_flags(__entry->ki_flags, "\|", TRACE_IOCB_STRINGS),
259	__entry->aio,
260	__entry->error,
261	__entry->ret)
262	);
263
9e91c572 CH	264	#endif /* _IOMAP_TRACE_H */
	265
	266	#undef TRACE_INCLUDE_PATH
	267	#define TRACE_INCLUDE_PATH .
	268	#define TRACE_INCLUDE_FILE trace
	269	#include <trace/define_trace.h>