xref: /linux/fs/iomap/trace.h (revision b5d760d53ac2e36825fbbb8d1f54ad9ce6138f7b)
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 
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);
51 DEFINE_READPAGE_EVENT(iomap_readahead);
52 
53 DECLARE_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)		\
79 DEFINE_EVENT(iomap_range_class, name,	\
80 	TP_PROTO(struct inode *inode, loff_t off, u64 len),\
81 	TP_ARGS(inode, off, len))
82 DEFINE_RANGE_EVENT(iomap_writeback_folio);
83 DEFINE_RANGE_EVENT(iomap_release_folio);
84 DEFINE_RANGE_EVENT(iomap_invalidate_folio);
85 DEFINE_RANGE_EVENT(iomap_dio_invalidate_fail);
86 DEFINE_RANGE_EVENT(iomap_dio_rw_queued);
87 
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 	{ IOMAP_OVERWRITE_ONLY,	"OVERWRITE_ONLY" }, \
103 	{ IOMAP_UNSHARE,	"UNSHARE" }, \
104 	{ IOMAP_DAX,		"DAX" }, \
105 	{ IOMAP_ATOMIC,		"ATOMIC" }, \
106 	{ IOMAP_DONTCACHE,	"DONTCACHE" }
107 
108 #define IOMAP_F_FLAGS_STRINGS \
109 	{ IOMAP_F_NEW,		"NEW" }, \
110 	{ IOMAP_F_DIRTY,	"DIRTY" }, \
111 	{ IOMAP_F_SHARED,	"SHARED" }, \
112 	{ IOMAP_F_MERGED,	"MERGED" }, \
113 	{ IOMAP_F_BUFFER_HEAD,	"BH" }, \
114 	{ IOMAP_F_XATTR,	"XATTR" }, \
115 	{ IOMAP_F_BOUNDARY,	"BOUNDARY" }, \
116 	{ IOMAP_F_ANON_WRITE,	"ANON_WRITE" }, \
117 	{ IOMAP_F_ATOMIC_BIO,	"ATOMIC_BIO" }, \
118 	{ IOMAP_F_PRIVATE,	"PRIVATE" }, \
119 	{ IOMAP_F_SIZE_CHANGED,	"SIZE_CHANGED" }, \
120 	{ IOMAP_F_STALE,	"STALE" }
121 
122 
123 #define IOMAP_DIO_STRINGS \
124 	{IOMAP_DIO_FORCE_WAIT,	"DIO_FORCE_WAIT" }, \
125 	{IOMAP_DIO_OVERWRITE_ONLY, "DIO_OVERWRITE_ONLY" }, \
126 	{IOMAP_DIO_PARTIAL,	"DIO_PARTIAL" }
127 
128 DECLARE_EVENT_CLASS(iomap_class,
129 	TP_PROTO(struct inode *inode, struct iomap *iomap),
130 	TP_ARGS(inode, iomap),
131 	TP_STRUCT__entry(
132 		__field(dev_t, dev)
133 		__field(u64, ino)
134 		__field(u64, addr)
135 		__field(loff_t, offset)
136 		__field(u64, length)
137 		__field(u16, type)
138 		__field(u16, flags)
139 		__field(dev_t, bdev)
140 	),
141 	TP_fast_assign(
142 		__entry->dev = inode->i_sb->s_dev;
143 		__entry->ino = inode->i_ino;
144 		__entry->addr = iomap->addr;
145 		__entry->offset = iomap->offset;
146 		__entry->length = iomap->length;
147 		__entry->type = iomap->type;
148 		__entry->flags = iomap->flags;
149 		__entry->bdev = iomap->bdev ? iomap->bdev->bd_dev : 0;
150 	),
151 	TP_printk("dev %d:%d ino 0x%llx bdev %d:%d addr 0x%llx offset 0x%llx "
152 		  "length 0x%llx type %s (0x%x) flags %s (0x%x)",
153 		  MAJOR(__entry->dev), MINOR(__entry->dev),
154 		  __entry->ino,
155 		  MAJOR(__entry->bdev), MINOR(__entry->bdev),
156 		  __entry->addr,
157 		  __entry->offset,
158 		  __entry->length,
159 		  __print_symbolic(__entry->type, IOMAP_TYPE_STRINGS),
160 		  __entry->type,
161 		  __print_flags(__entry->flags, "|", IOMAP_F_FLAGS_STRINGS),
162 		  __entry->flags)
163 )
164 
165 #define DEFINE_IOMAP_EVENT(name)		\
166 DEFINE_EVENT(iomap_class, name,	\
167 	TP_PROTO(struct inode *inode, struct iomap *iomap), \
168 	TP_ARGS(inode, iomap))
169 DEFINE_IOMAP_EVENT(iomap_iter_dstmap);
170 DEFINE_IOMAP_EVENT(iomap_iter_srcmap);
171 
172 TRACE_EVENT(iomap_add_to_ioend,
173 	TP_PROTO(struct inode *inode, u64 pos, unsigned int dirty_len,
174 		 struct iomap *iomap),
175 	TP_ARGS(inode, pos, dirty_len, iomap),
176 	TP_STRUCT__entry(
177 		__field(dev_t, dev)
178 		__field(u64, ino)
179 		__field(u64, pos)
180 		__field(u64, dirty_len)
181 		__field(u64, addr)
182 		__field(loff_t, offset)
183 		__field(u64, length)
184 		__field(u16, type)
185 		__field(u16, flags)
186 		__field(dev_t, bdev)
187 	),
188 	TP_fast_assign(
189 		__entry->dev = inode->i_sb->s_dev;
190 		__entry->ino = inode->i_ino;
191 		__entry->pos = pos;
192 		__entry->dirty_len = dirty_len;
193 		__entry->addr = iomap->addr;
194 		__entry->offset = iomap->offset;
195 		__entry->length = iomap->length;
196 		__entry->type = iomap->type;
197 		__entry->flags = iomap->flags;
198 		__entry->bdev = iomap->bdev ? iomap->bdev->bd_dev : 0;
199 	),
200 	TP_printk("dev %d:%d ino 0x%llx bdev %d:%d pos 0x%llx dirty len 0x%llx "
201 		  "addr 0x%llx offset 0x%llx length 0x%llx type %s (0x%x) flags %s (0x%x)",
202 		  MAJOR(__entry->dev), MINOR(__entry->dev),
203 		  __entry->ino,
204 		  MAJOR(__entry->bdev), MINOR(__entry->bdev),
205 		  __entry->pos,
206 		  __entry->dirty_len,
207 		  __entry->addr,
208 		  __entry->offset,
209 		  __entry->length,
210 		  __print_symbolic(__entry->type, IOMAP_TYPE_STRINGS),
211 		  __entry->type,
212 		  __print_flags(__entry->flags, "|", IOMAP_F_FLAGS_STRINGS),
213 		  __entry->flags)
214 );
215 
216 TRACE_EVENT(iomap_iter,
217 	TP_PROTO(struct iomap_iter *iter, const void *ops,
218 		 unsigned long caller),
219 	TP_ARGS(iter, ops, caller),
220 	TP_STRUCT__entry(
221 		__field(dev_t, dev)
222 		__field(u64, ino)
223 		__field(loff_t, pos)
224 		__field(u64, length)
225 		__field(int, status)
226 		__field(unsigned int, flags)
227 		__field(const void *, ops)
228 		__field(unsigned long, caller)
229 	),
230 	TP_fast_assign(
231 		__entry->dev = iter->inode->i_sb->s_dev;
232 		__entry->ino = iter->inode->i_ino;
233 		__entry->pos = iter->pos;
234 		__entry->length = iomap_length(iter);
235 		__entry->status = iter->status;
236 		__entry->flags = iter->flags;
237 		__entry->ops = ops;
238 		__entry->caller = caller;
239 	),
240 	TP_printk("dev %d:%d ino 0x%llx pos 0x%llx length 0x%llx status %d flags %s (0x%x) ops %ps caller %pS",
241 		  MAJOR(__entry->dev), MINOR(__entry->dev),
242 		   __entry->ino,
243 		   __entry->pos,
244 		   __entry->length,
245 		   __entry->status,
246 		   __print_flags(__entry->flags, "|", IOMAP_FLAGS_STRINGS),
247 		   __entry->flags,
248 		   __entry->ops,
249 		   (void *)__entry->caller)
250 );
251 
252 TRACE_EVENT(iomap_dio_rw_begin,
253 	TP_PROTO(struct kiocb *iocb, struct iov_iter *iter,
254 		 unsigned int dio_flags, size_t done_before),
255 	TP_ARGS(iocb, iter, dio_flags, done_before),
256 	TP_STRUCT__entry(
257 		__field(dev_t,	dev)
258 		__field(ino_t,	ino)
259 		__field(loff_t, isize)
260 		__field(loff_t, pos)
261 		__field(size_t,	count)
262 		__field(size_t,	done_before)
263 		__field(int,	ki_flags)
264 		__field(unsigned int,	dio_flags)
265 		__field(bool,	aio)
266 	),
267 	TP_fast_assign(
268 		__entry->dev = file_inode(iocb->ki_filp)->i_sb->s_dev;
269 		__entry->ino = file_inode(iocb->ki_filp)->i_ino;
270 		__entry->isize = file_inode(iocb->ki_filp)->i_size;
271 		__entry->pos = iocb->ki_pos;
272 		__entry->count = iov_iter_count(iter);
273 		__entry->done_before = done_before;
274 		__entry->ki_flags = iocb->ki_flags;
275 		__entry->dio_flags = dio_flags;
276 		__entry->aio = !is_sync_kiocb(iocb);
277 	),
278 	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",
279 		  MAJOR(__entry->dev), MINOR(__entry->dev),
280 		  __entry->ino,
281 		  __entry->isize,
282 		  __entry->pos,
283 		  __entry->count,
284 		  __entry->done_before,
285 		  __print_flags(__entry->ki_flags, "|", TRACE_IOCB_STRINGS),
286 		  __print_flags(__entry->dio_flags, "|", IOMAP_DIO_STRINGS),
287 		  __entry->aio)
288 );
289 
290 TRACE_EVENT(iomap_dio_complete,
291 	TP_PROTO(struct kiocb *iocb, int error, ssize_t ret),
292 	TP_ARGS(iocb, error, ret),
293 	TP_STRUCT__entry(
294 		__field(dev_t,	dev)
295 		__field(ino_t,	ino)
296 		__field(loff_t, isize)
297 		__field(loff_t, pos)
298 		__field(int,	ki_flags)
299 		__field(bool,	aio)
300 		__field(int,	error)
301 		__field(ssize_t, ret)
302 	),
303 	TP_fast_assign(
304 		__entry->dev = file_inode(iocb->ki_filp)->i_sb->s_dev;
305 		__entry->ino = file_inode(iocb->ki_filp)->i_ino;
306 		__entry->isize = file_inode(iocb->ki_filp)->i_size;
307 		__entry->pos = iocb->ki_pos;
308 		__entry->ki_flags = iocb->ki_flags;
309 		__entry->aio = !is_sync_kiocb(iocb);
310 		__entry->error = error;
311 		__entry->ret = ret;
312 	),
313 	TP_printk("dev %d:%d ino 0x%lx size 0x%llx offset 0x%llx flags %s aio %d error %d ret %zd",
314 		  MAJOR(__entry->dev), MINOR(__entry->dev),
315 		  __entry->ino,
316 		  __entry->isize,
317 		  __entry->pos,
318 		  __print_flags(__entry->ki_flags, "|", TRACE_IOCB_STRINGS),
319 		  __entry->aio,
320 		  __entry->error,
321 		  __entry->ret)
322 );
323 
324 #endif /* _IOMAP_TRACE_H */
325 
326 #undef TRACE_INCLUDE_PATH
327 #define TRACE_INCLUDE_PATH .
328 #define TRACE_INCLUDE_FILE trace
329 #include <trace/define_trace.h>
330