1 /* SPDX-License-Identifier: GPL-2.0-or-later */
2 /* CacheFiles tracepoints
4 * Copyright (C) 2021 Red Hat, Inc. All Rights Reserved.
5 * Written by David Howells (dhowells@redhat.com)
8 #define TRACE_SYSTEM cachefiles
10 #if !defined(_TRACE_CACHEFILES_H) || defined(TRACE_HEADER_MULTI_READ)
11 #define _TRACE_CACHEFILES_H
13 #include <linux/tracepoint.h>
16 * Define enums for tracing information.
18 #ifndef __CACHEFILES_DECLARE_TRACE_ENUMS_ONCE_ONLY
19 #define __CACHEFILES_DECLARE_TRACE_ENUMS_ONCE_ONLY
21 enum cachefiles_obj_ref_trace {
22 cachefiles_obj_get_ioreq,
24 cachefiles_obj_put_alloc_fail,
25 cachefiles_obj_put_detach,
26 cachefiles_obj_put_ioreq,
27 cachefiles_obj_see_clean_commit,
28 cachefiles_obj_see_clean_delete,
29 cachefiles_obj_see_clean_drop_tmp,
30 cachefiles_obj_see_lookup_cookie,
31 cachefiles_obj_see_lookup_failed,
32 cachefiles_obj_see_withdraw_cookie,
33 cachefiles_obj_see_withdrawal,
36 enum fscache_why_object_killed {
37 FSCACHE_OBJECT_IS_STALE,
38 FSCACHE_OBJECT_IS_WEIRD,
39 FSCACHE_OBJECT_INVALIDATED,
40 FSCACHE_OBJECT_NO_SPACE,
41 FSCACHE_OBJECT_WAS_RETIRED,
42 FSCACHE_OBJECT_WAS_CULLED,
43 FSCACHE_VOLUME_IS_WEIRD,
46 enum cachefiles_coherency_trace {
47 cachefiles_coherency_check_aux,
48 cachefiles_coherency_check_content,
49 cachefiles_coherency_check_dirty,
50 cachefiles_coherency_check_len,
51 cachefiles_coherency_check_objsize,
52 cachefiles_coherency_check_ok,
53 cachefiles_coherency_check_type,
54 cachefiles_coherency_check_xattr,
55 cachefiles_coherency_set_fail,
56 cachefiles_coherency_set_ok,
57 cachefiles_coherency_vol_check_cmp,
58 cachefiles_coherency_vol_check_ok,
59 cachefiles_coherency_vol_check_xattr,
60 cachefiles_coherency_vol_set_fail,
61 cachefiles_coherency_vol_set_ok,
64 enum cachefiles_trunc_trace {
65 cachefiles_trunc_dio_adjust,
66 cachefiles_trunc_expand_tmpfile,
67 cachefiles_trunc_shrink,
70 enum cachefiles_prepare_read_trace {
71 cachefiles_trace_read_after_eof,
72 cachefiles_trace_read_found_hole,
73 cachefiles_trace_read_found_part,
74 cachefiles_trace_read_have_data,
75 cachefiles_trace_read_no_data,
76 cachefiles_trace_read_no_file,
77 cachefiles_trace_read_seek_error,
78 cachefiles_trace_read_seek_nxio,
81 enum cachefiles_error_trace {
82 cachefiles_trace_fallocate_error,
83 cachefiles_trace_getxattr_error,
84 cachefiles_trace_link_error,
85 cachefiles_trace_lookup_error,
86 cachefiles_trace_mkdir_error,
87 cachefiles_trace_notify_change_error,
88 cachefiles_trace_open_error,
89 cachefiles_trace_read_error,
90 cachefiles_trace_remxattr_error,
91 cachefiles_trace_rename_error,
92 cachefiles_trace_seek_error,
93 cachefiles_trace_setxattr_error,
94 cachefiles_trace_statfs_error,
95 cachefiles_trace_tmpfile_error,
96 cachefiles_trace_trunc_error,
97 cachefiles_trace_unlink_error,
98 cachefiles_trace_write_error,
104 * Define enum -> string mappings for display.
106 #define cachefiles_obj_kill_traces \
107 EM(FSCACHE_OBJECT_IS_STALE, "stale") \
108 EM(FSCACHE_OBJECT_IS_WEIRD, "weird") \
109 EM(FSCACHE_OBJECT_INVALIDATED, "inval") \
110 EM(FSCACHE_OBJECT_NO_SPACE, "no_space") \
111 EM(FSCACHE_OBJECT_WAS_RETIRED, "was_retired") \
112 EM(FSCACHE_OBJECT_WAS_CULLED, "was_culled") \
113 E_(FSCACHE_VOLUME_IS_WEIRD, "volume_weird")
115 #define cachefiles_obj_ref_traces \
116 EM(cachefiles_obj_get_ioreq, "GET ioreq") \
117 EM(cachefiles_obj_new, "NEW obj") \
118 EM(cachefiles_obj_put_alloc_fail, "PUT alloc_fail") \
119 EM(cachefiles_obj_put_detach, "PUT detach") \
120 EM(cachefiles_obj_put_ioreq, "PUT ioreq") \
121 EM(cachefiles_obj_see_clean_commit, "SEE clean_commit") \
122 EM(cachefiles_obj_see_clean_delete, "SEE clean_delete") \
123 EM(cachefiles_obj_see_clean_drop_tmp, "SEE clean_drop_tmp") \
124 EM(cachefiles_obj_see_lookup_cookie, "SEE lookup_cookie") \
125 EM(cachefiles_obj_see_lookup_failed, "SEE lookup_failed") \
126 EM(cachefiles_obj_see_withdraw_cookie, "SEE withdraw_cookie") \
127 E_(cachefiles_obj_see_withdrawal, "SEE withdrawal")
129 #define cachefiles_coherency_traces \
130 EM(cachefiles_coherency_check_aux, "BAD aux ") \
131 EM(cachefiles_coherency_check_content, "BAD cont") \
132 EM(cachefiles_coherency_check_dirty, "BAD dirt") \
133 EM(cachefiles_coherency_check_len, "BAD len ") \
134 EM(cachefiles_coherency_check_objsize, "BAD osiz") \
135 EM(cachefiles_coherency_check_ok, "OK ") \
136 EM(cachefiles_coherency_check_type, "BAD type") \
137 EM(cachefiles_coherency_check_xattr, "BAD xatt") \
138 EM(cachefiles_coherency_set_fail, "SET fail") \
139 EM(cachefiles_coherency_set_ok, "SET ok ") \
140 EM(cachefiles_coherency_vol_check_cmp, "VOL BAD cmp ") \
141 EM(cachefiles_coherency_vol_check_ok, "VOL OK ") \
142 EM(cachefiles_coherency_vol_check_xattr,"VOL BAD xatt") \
143 EM(cachefiles_coherency_vol_set_fail, "VOL SET fail") \
144 E_(cachefiles_coherency_vol_set_ok, "VOL SET ok ")
146 #define cachefiles_trunc_traces \
147 EM(cachefiles_trunc_dio_adjust, "DIOADJ") \
148 EM(cachefiles_trunc_expand_tmpfile, "EXPTMP") \
149 E_(cachefiles_trunc_shrink, "SHRINK")
151 #define cachefiles_prepare_read_traces \
152 EM(cachefiles_trace_read_after_eof, "after-eof ") \
153 EM(cachefiles_trace_read_found_hole, "found-hole") \
154 EM(cachefiles_trace_read_found_part, "found-part") \
155 EM(cachefiles_trace_read_have_data, "have-data ") \
156 EM(cachefiles_trace_read_no_data, "no-data ") \
157 EM(cachefiles_trace_read_no_file, "no-file ") \
158 EM(cachefiles_trace_read_seek_error, "seek-error") \
159 E_(cachefiles_trace_read_seek_nxio, "seek-enxio")
161 #define cachefiles_error_traces \
162 EM(cachefiles_trace_fallocate_error, "fallocate") \
163 EM(cachefiles_trace_getxattr_error, "getxattr") \
164 EM(cachefiles_trace_link_error, "link") \
165 EM(cachefiles_trace_lookup_error, "lookup") \
166 EM(cachefiles_trace_mkdir_error, "mkdir") \
167 EM(cachefiles_trace_notify_change_error, "notify_change") \
168 EM(cachefiles_trace_open_error, "open") \
169 EM(cachefiles_trace_read_error, "read") \
170 EM(cachefiles_trace_remxattr_error, "remxattr") \
171 EM(cachefiles_trace_rename_error, "rename") \
172 EM(cachefiles_trace_seek_error, "seek") \
173 EM(cachefiles_trace_setxattr_error, "setxattr") \
174 EM(cachefiles_trace_statfs_error, "statfs") \
175 EM(cachefiles_trace_tmpfile_error, "tmpfile") \
176 EM(cachefiles_trace_trunc_error, "trunc") \
177 EM(cachefiles_trace_unlink_error, "unlink") \
178 E_(cachefiles_trace_write_error, "write")
182 * Export enum symbols via userspace.
186 #define EM(a, b) TRACE_DEFINE_ENUM(a);
187 #define E_(a, b) TRACE_DEFINE_ENUM(a);
189 cachefiles_obj_kill_traces;
190 cachefiles_obj_ref_traces;
191 cachefiles_coherency_traces;
192 cachefiles_trunc_traces;
193 cachefiles_prepare_read_traces;
194 cachefiles_error_traces;
197 * Now redefine the EM() and E_() macros to map the enums to the strings that
198 * will be printed in the output.
202 #define EM(a, b) { a, b },
203 #define E_(a, b) { a, b }
206 TRACE_EVENT(cachefiles_ref,
207 TP_PROTO(unsigned int object_debug_id,
208 unsigned int cookie_debug_id,
210 enum cachefiles_obj_ref_trace why),
212 TP_ARGS(object_debug_id, cookie_debug_id, usage, why),
214 /* Note that obj may be NULL */
216 __field(unsigned int, obj )
217 __field(unsigned int, cookie )
218 __field(enum cachefiles_obj_ref_trace, why )
223 __entry->obj = object_debug_id;
224 __entry->cookie = cookie_debug_id;
225 __entry->usage = usage;
229 TP_printk("c=%08x o=%08x u=%d %s",
230 __entry->cookie, __entry->obj, __entry->usage,
231 __print_symbolic(__entry->why, cachefiles_obj_ref_traces))
234 TRACE_EVENT(cachefiles_lookup,
235 TP_PROTO(struct cachefiles_object *obj,
239 TP_ARGS(obj, dir, de),
242 __field(unsigned int, obj )
243 __field(short, error )
244 __field(unsigned long, dino )
245 __field(unsigned long, ino )
249 __entry->obj = obj ? obj->debug_id : 0;
250 __entry->dino = d_backing_inode(dir)->i_ino;
251 __entry->ino = (!IS_ERR(de) && d_backing_inode(de) ?
252 d_backing_inode(de)->i_ino : 0);
253 __entry->error = IS_ERR(de) ? PTR_ERR(de) : 0;
256 TP_printk("o=%08x dB=%lx B=%lx e=%d",
257 __entry->obj, __entry->dino, __entry->ino, __entry->error)
260 TRACE_EVENT(cachefiles_mkdir,
261 TP_PROTO(struct dentry *dir, struct dentry *subdir),
263 TP_ARGS(dir, subdir),
266 __field(unsigned int, dir )
267 __field(unsigned int, subdir )
271 __entry->dir = d_backing_inode(dir)->i_ino;
272 __entry->subdir = d_backing_inode(subdir)->i_ino;
275 TP_printk("dB=%x sB=%x",
280 TRACE_EVENT(cachefiles_tmpfile,
281 TP_PROTO(struct cachefiles_object *obj, struct inode *backer),
283 TP_ARGS(obj, backer),
286 __field(unsigned int, obj )
287 __field(unsigned int, backer )
291 __entry->obj = obj->debug_id;
292 __entry->backer = backer->i_ino;
295 TP_printk("o=%08x B=%x",
300 TRACE_EVENT(cachefiles_link,
301 TP_PROTO(struct cachefiles_object *obj, struct inode *backer),
303 TP_ARGS(obj, backer),
306 __field(unsigned int, obj )
307 __field(unsigned int, backer )
311 __entry->obj = obj->debug_id;
312 __entry->backer = backer->i_ino;
315 TP_printk("o=%08x B=%x",
320 TRACE_EVENT(cachefiles_unlink,
321 TP_PROTO(struct cachefiles_object *obj,
323 enum fscache_why_object_killed why),
325 TP_ARGS(obj, ino, why),
327 /* Note that obj may be NULL */
329 __field(unsigned int, obj )
330 __field(unsigned int, ino )
331 __field(enum fscache_why_object_killed, why )
335 __entry->obj = obj ? obj->debug_id : UINT_MAX;
340 TP_printk("o=%08x B=%x w=%s",
341 __entry->obj, __entry->ino,
342 __print_symbolic(__entry->why, cachefiles_obj_kill_traces))
345 TRACE_EVENT(cachefiles_rename,
346 TP_PROTO(struct cachefiles_object *obj,
348 enum fscache_why_object_killed why),
350 TP_ARGS(obj, ino, why),
352 /* Note that obj may be NULL */
354 __field(unsigned int, obj )
355 __field(unsigned int, ino )
356 __field(enum fscache_why_object_killed, why )
360 __entry->obj = obj ? obj->debug_id : UINT_MAX;
365 TP_printk("o=%08x B=%x w=%s",
366 __entry->obj, __entry->ino,
367 __print_symbolic(__entry->why, cachefiles_obj_kill_traces))
370 TRACE_EVENT(cachefiles_coherency,
371 TP_PROTO(struct cachefiles_object *obj,
373 enum cachefiles_content content,
374 enum cachefiles_coherency_trace why),
376 TP_ARGS(obj, ino, content, why),
378 /* Note that obj may be NULL */
380 __field(unsigned int, obj )
381 __field(enum cachefiles_coherency_trace, why )
382 __field(enum cachefiles_content, content )
387 __entry->obj = obj->debug_id;
389 __entry->content = content;
393 TP_printk("o=%08x %s B=%llx c=%u",
395 __print_symbolic(__entry->why, cachefiles_coherency_traces),
400 TRACE_EVENT(cachefiles_vol_coherency,
401 TP_PROTO(struct cachefiles_volume *volume,
403 enum cachefiles_coherency_trace why),
405 TP_ARGS(volume, ino, why),
407 /* Note that obj may be NULL */
409 __field(unsigned int, vol )
410 __field(enum cachefiles_coherency_trace, why )
415 __entry->vol = volume->vcookie->debug_id;
420 TP_printk("V=%08x %s B=%llx",
422 __print_symbolic(__entry->why, cachefiles_coherency_traces),
426 TRACE_EVENT(cachefiles_prep_read,
427 TP_PROTO(struct netfs_read_subrequest *sreq,
428 enum netfs_read_source source,
429 enum cachefiles_prepare_read_trace why,
432 TP_ARGS(sreq, source, why, cache_inode),
435 __field(unsigned int, rreq )
436 __field(unsigned short, index )
437 __field(unsigned short, flags )
438 __field(enum netfs_read_source, source )
439 __field(enum cachefiles_prepare_read_trace, why )
440 __field(size_t, len )
441 __field(loff_t, start )
442 __field(unsigned int, netfs_inode )
443 __field(unsigned int, cache_inode )
447 __entry->rreq = sreq->rreq->debug_id;
448 __entry->index = sreq->debug_index;
449 __entry->flags = sreq->flags;
450 __entry->source = source;
452 __entry->len = sreq->len;
453 __entry->start = sreq->start;
454 __entry->netfs_inode = sreq->rreq->inode->i_ino;
455 __entry->cache_inode = cache_inode;
458 TP_printk("R=%08x[%u] %s %s f=%02x s=%llx %zx ni=%x B=%x",
459 __entry->rreq, __entry->index,
460 __print_symbolic(__entry->source, netfs_sreq_sources),
461 __print_symbolic(__entry->why, cachefiles_prepare_read_traces),
463 __entry->start, __entry->len,
464 __entry->netfs_inode, __entry->cache_inode)
467 TRACE_EVENT(cachefiles_read,
468 TP_PROTO(struct cachefiles_object *obj,
469 struct inode *backer,
473 TP_ARGS(obj, backer, start, len),
476 __field(unsigned int, obj )
477 __field(unsigned int, backer )
478 __field(size_t, len )
479 __field(loff_t, start )
483 __entry->obj = obj->debug_id;
484 __entry->backer = backer->i_ino;
485 __entry->start = start;
489 TP_printk("o=%08x B=%x s=%llx l=%zx",
496 TRACE_EVENT(cachefiles_write,
497 TP_PROTO(struct cachefiles_object *obj,
498 struct inode *backer,
502 TP_ARGS(obj, backer, start, len),
505 __field(unsigned int, obj )
506 __field(unsigned int, backer )
507 __field(size_t, len )
508 __field(loff_t, start )
512 __entry->obj = obj->debug_id;
513 __entry->backer = backer->i_ino;
514 __entry->start = start;
518 TP_printk("o=%08x B=%x s=%llx l=%zx",
525 TRACE_EVENT(cachefiles_trunc,
526 TP_PROTO(struct cachefiles_object *obj, struct inode *backer,
527 loff_t from, loff_t to, enum cachefiles_trunc_trace why),
529 TP_ARGS(obj, backer, from, to, why),
532 __field(unsigned int, obj )
533 __field(unsigned int, backer )
534 __field(enum cachefiles_trunc_trace, why )
535 __field(loff_t, from )
540 __entry->obj = obj->debug_id;
541 __entry->backer = backer->i_ino;
542 __entry->from = from;
547 TP_printk("o=%08x B=%x %s l=%llx->%llx",
550 __print_symbolic(__entry->why, cachefiles_trunc_traces),
555 TRACE_EVENT(cachefiles_mark_active,
556 TP_PROTO(struct cachefiles_object *obj,
557 struct inode *inode),
561 /* Note that obj may be NULL */
563 __field(unsigned int, obj )
564 __field(ino_t, inode )
568 __entry->obj = obj ? obj->debug_id : 0;
569 __entry->inode = inode->i_ino;
572 TP_printk("o=%08x B=%lx",
573 __entry->obj, __entry->inode)
576 TRACE_EVENT(cachefiles_mark_failed,
577 TP_PROTO(struct cachefiles_object *obj,
578 struct inode *inode),
582 /* Note that obj may be NULL */
584 __field(unsigned int, obj )
585 __field(ino_t, inode )
589 __entry->obj = obj ? obj->debug_id : 0;
590 __entry->inode = inode->i_ino;
593 TP_printk("o=%08x B=%lx",
594 __entry->obj, __entry->inode)
597 TRACE_EVENT(cachefiles_mark_inactive,
598 TP_PROTO(struct cachefiles_object *obj,
599 struct inode *inode),
603 /* Note that obj may be NULL */
605 __field(unsigned int, obj )
606 __field(ino_t, inode )
610 __entry->obj = obj ? obj->debug_id : 0;
611 __entry->inode = inode->i_ino;
614 TP_printk("o=%08x B=%lx",
615 __entry->obj, __entry->inode)
618 TRACE_EVENT(cachefiles_vfs_error,
619 TP_PROTO(struct cachefiles_object *obj, struct inode *backer,
620 int error, enum cachefiles_error_trace where),
622 TP_ARGS(obj, backer, error, where),
625 __field(unsigned int, obj )
626 __field(unsigned int, backer )
627 __field(enum cachefiles_error_trace, where )
628 __field(short, error )
632 __entry->obj = obj ? obj->debug_id : 0;
633 __entry->backer = backer->i_ino;
634 __entry->error = error;
635 __entry->where = where;
638 TP_printk("o=%08x B=%x %s e=%d",
641 __print_symbolic(__entry->where, cachefiles_error_traces),
645 TRACE_EVENT(cachefiles_io_error,
646 TP_PROTO(struct cachefiles_object *obj, struct inode *backer,
647 int error, enum cachefiles_error_trace where),
649 TP_ARGS(obj, backer, error, where),
652 __field(unsigned int, obj )
653 __field(unsigned int, backer )
654 __field(enum cachefiles_error_trace, where )
655 __field(short, error )
659 __entry->obj = obj ? obj->debug_id : 0;
660 __entry->backer = backer->i_ino;
661 __entry->error = error;
662 __entry->where = where;
665 TP_printk("o=%08x B=%x %s e=%d",
668 __print_symbolic(__entry->where, cachefiles_error_traces),
672 #endif /* _TRACE_CACHEFILES_H */
674 /* This part must be outside protection */
675 #include <trace/define_trace.h>