fscache.h 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503
  1. /* SPDX-License-Identifier: GPL-2.0-or-later */
  2. /* FS-Cache tracepoints
  3. *
  4. * Copyright (C) 2021 Red Hat, Inc. All Rights Reserved.
  5. * Written by David Howells ([email protected])
  6. */
  7. #undef TRACE_SYSTEM
  8. #define TRACE_SYSTEM fscache
  9. #if !defined(_TRACE_FSCACHE_H) || defined(TRACE_HEADER_MULTI_READ)
  10. #define _TRACE_FSCACHE_H
  11. #include <linux/fscache.h>
  12. #include <linux/tracepoint.h>
  13. /*
  14. * Define enums for tracing information.
  15. */
  16. #ifndef __FSCACHE_DECLARE_TRACE_ENUMS_ONCE_ONLY
  17. #define __FSCACHE_DECLARE_TRACE_ENUMS_ONCE_ONLY
  18. enum fscache_cache_trace {
  19. fscache_cache_collision,
  20. fscache_cache_get_acquire,
  21. fscache_cache_new_acquire,
  22. fscache_cache_put_alloc_volume,
  23. fscache_cache_put_cache,
  24. fscache_cache_put_prep_failed,
  25. fscache_cache_put_relinquish,
  26. fscache_cache_put_volume,
  27. };
  28. enum fscache_volume_trace {
  29. fscache_volume_collision,
  30. fscache_volume_get_cookie,
  31. fscache_volume_get_create_work,
  32. fscache_volume_get_hash_collision,
  33. fscache_volume_free,
  34. fscache_volume_new_acquire,
  35. fscache_volume_put_cookie,
  36. fscache_volume_put_create_work,
  37. fscache_volume_put_hash_collision,
  38. fscache_volume_put_relinquish,
  39. fscache_volume_see_create_work,
  40. fscache_volume_see_hash_wake,
  41. fscache_volume_wait_create_work,
  42. };
  43. enum fscache_cookie_trace {
  44. fscache_cookie_collision,
  45. fscache_cookie_discard,
  46. fscache_cookie_failed,
  47. fscache_cookie_get_attach_object,
  48. fscache_cookie_get_end_access,
  49. fscache_cookie_get_hash_collision,
  50. fscache_cookie_get_inval_work,
  51. fscache_cookie_get_lru,
  52. fscache_cookie_get_use_work,
  53. fscache_cookie_new_acquire,
  54. fscache_cookie_put_hash_collision,
  55. fscache_cookie_put_lru,
  56. fscache_cookie_put_object,
  57. fscache_cookie_put_over_queued,
  58. fscache_cookie_put_relinquish,
  59. fscache_cookie_put_withdrawn,
  60. fscache_cookie_put_work,
  61. fscache_cookie_see_active,
  62. fscache_cookie_see_lru_discard,
  63. fscache_cookie_see_lru_discard_clear,
  64. fscache_cookie_see_lru_do_one,
  65. fscache_cookie_see_relinquish,
  66. fscache_cookie_see_withdraw,
  67. fscache_cookie_see_work,
  68. };
  69. enum fscache_active_trace {
  70. fscache_active_use,
  71. fscache_active_use_modify,
  72. fscache_active_unuse,
  73. };
  74. enum fscache_access_trace {
  75. fscache_access_acquire_volume,
  76. fscache_access_acquire_volume_end,
  77. fscache_access_cache_pin,
  78. fscache_access_cache_unpin,
  79. fscache_access_invalidate_cookie,
  80. fscache_access_invalidate_cookie_end,
  81. fscache_access_io_end,
  82. fscache_access_io_not_live,
  83. fscache_access_io_read,
  84. fscache_access_io_resize,
  85. fscache_access_io_wait,
  86. fscache_access_io_write,
  87. fscache_access_lookup_cookie,
  88. fscache_access_lookup_cookie_end,
  89. fscache_access_lookup_cookie_end_failed,
  90. fscache_access_relinquish_volume,
  91. fscache_access_relinquish_volume_end,
  92. fscache_access_unlive,
  93. };
  94. #endif
  95. /*
  96. * Declare tracing information enums and their string mappings for display.
  97. */
  98. #define fscache_cache_traces \
  99. EM(fscache_cache_collision, "*COLLIDE*") \
  100. EM(fscache_cache_get_acquire, "GET acq ") \
  101. EM(fscache_cache_new_acquire, "NEW acq ") \
  102. EM(fscache_cache_put_alloc_volume, "PUT alvol") \
  103. EM(fscache_cache_put_cache, "PUT cache") \
  104. EM(fscache_cache_put_prep_failed, "PUT pfail") \
  105. EM(fscache_cache_put_relinquish, "PUT relnq") \
  106. E_(fscache_cache_put_volume, "PUT vol ")
  107. #define fscache_volume_traces \
  108. EM(fscache_volume_collision, "*COLLIDE*") \
  109. EM(fscache_volume_get_cookie, "GET cook ") \
  110. EM(fscache_volume_get_create_work, "GET creat") \
  111. EM(fscache_volume_get_hash_collision, "GET hcoll") \
  112. EM(fscache_volume_free, "FREE ") \
  113. EM(fscache_volume_new_acquire, "NEW acq ") \
  114. EM(fscache_volume_put_cookie, "PUT cook ") \
  115. EM(fscache_volume_put_create_work, "PUT creat") \
  116. EM(fscache_volume_put_hash_collision, "PUT hcoll") \
  117. EM(fscache_volume_put_relinquish, "PUT relnq") \
  118. EM(fscache_volume_see_create_work, "SEE creat") \
  119. EM(fscache_volume_see_hash_wake, "SEE hwake") \
  120. E_(fscache_volume_wait_create_work, "WAIT crea")
  121. #define fscache_cookie_traces \
  122. EM(fscache_cookie_collision, "*COLLIDE*") \
  123. EM(fscache_cookie_discard, "DISCARD ") \
  124. EM(fscache_cookie_failed, "FAILED ") \
  125. EM(fscache_cookie_get_attach_object, "GET attch") \
  126. EM(fscache_cookie_get_hash_collision, "GET hcoll") \
  127. EM(fscache_cookie_get_end_access, "GQ endac") \
  128. EM(fscache_cookie_get_inval_work, "GQ inval") \
  129. EM(fscache_cookie_get_lru, "GET lru ") \
  130. EM(fscache_cookie_get_use_work, "GQ use ") \
  131. EM(fscache_cookie_new_acquire, "NEW acq ") \
  132. EM(fscache_cookie_put_hash_collision, "PUT hcoll") \
  133. EM(fscache_cookie_put_lru, "PUT lru ") \
  134. EM(fscache_cookie_put_object, "PUT obj ") \
  135. EM(fscache_cookie_put_over_queued, "PQ overq") \
  136. EM(fscache_cookie_put_relinquish, "PUT relnq") \
  137. EM(fscache_cookie_put_withdrawn, "PUT wthdn") \
  138. EM(fscache_cookie_put_work, "PQ work ") \
  139. EM(fscache_cookie_see_active, "- activ") \
  140. EM(fscache_cookie_see_lru_discard, "- x-lru") \
  141. EM(fscache_cookie_see_lru_discard_clear,"- lrudc") \
  142. EM(fscache_cookie_see_lru_do_one, "- lrudo") \
  143. EM(fscache_cookie_see_relinquish, "- x-rlq") \
  144. EM(fscache_cookie_see_withdraw, "- x-wth") \
  145. E_(fscache_cookie_see_work, "- work ")
  146. #define fscache_active_traces \
  147. EM(fscache_active_use, "USE ") \
  148. EM(fscache_active_use_modify, "USE-m ") \
  149. E_(fscache_active_unuse, "UNUSE ")
  150. #define fscache_access_traces \
  151. EM(fscache_access_acquire_volume, "BEGIN acq_vol") \
  152. EM(fscache_access_acquire_volume_end, "END acq_vol") \
  153. EM(fscache_access_cache_pin, "PIN cache ") \
  154. EM(fscache_access_cache_unpin, "UNPIN cache ") \
  155. EM(fscache_access_invalidate_cookie, "BEGIN inval ") \
  156. EM(fscache_access_invalidate_cookie_end,"END inval ") \
  157. EM(fscache_access_io_end, "END io ") \
  158. EM(fscache_access_io_not_live, "END io_notl") \
  159. EM(fscache_access_io_read, "BEGIN io_read") \
  160. EM(fscache_access_io_resize, "BEGIN io_resz") \
  161. EM(fscache_access_io_wait, "WAIT io ") \
  162. EM(fscache_access_io_write, "BEGIN io_writ") \
  163. EM(fscache_access_lookup_cookie, "BEGIN lookup ") \
  164. EM(fscache_access_lookup_cookie_end, "END lookup ") \
  165. EM(fscache_access_lookup_cookie_end_failed,"END lookupf") \
  166. EM(fscache_access_relinquish_volume, "BEGIN rlq_vol") \
  167. EM(fscache_access_relinquish_volume_end,"END rlq_vol") \
  168. E_(fscache_access_unlive, "END unlive ")
  169. /*
  170. * Export enum symbols via userspace.
  171. */
  172. #undef EM
  173. #undef E_
  174. #define EM(a, b) TRACE_DEFINE_ENUM(a);
  175. #define E_(a, b) TRACE_DEFINE_ENUM(a);
  176. fscache_cache_traces;
  177. fscache_volume_traces;
  178. fscache_cookie_traces;
  179. fscache_access_traces;
  180. /*
  181. * Now redefine the EM() and E_() macros to map the enums to the strings that
  182. * will be printed in the output.
  183. */
  184. #undef EM
  185. #undef E_
  186. #define EM(a, b) { a, b },
  187. #define E_(a, b) { a, b }
  188. TRACE_EVENT(fscache_cache,
  189. TP_PROTO(unsigned int cache_debug_id,
  190. int usage,
  191. enum fscache_cache_trace where),
  192. TP_ARGS(cache_debug_id, usage, where),
  193. TP_STRUCT__entry(
  194. __field(unsigned int, cache )
  195. __field(int, usage )
  196. __field(enum fscache_cache_trace, where )
  197. ),
  198. TP_fast_assign(
  199. __entry->cache = cache_debug_id;
  200. __entry->usage = usage;
  201. __entry->where = where;
  202. ),
  203. TP_printk("C=%08x %s r=%d",
  204. __entry->cache,
  205. __print_symbolic(__entry->where, fscache_cache_traces),
  206. __entry->usage)
  207. );
  208. TRACE_EVENT(fscache_volume,
  209. TP_PROTO(unsigned int volume_debug_id,
  210. int usage,
  211. enum fscache_volume_trace where),
  212. TP_ARGS(volume_debug_id, usage, where),
  213. TP_STRUCT__entry(
  214. __field(unsigned int, volume )
  215. __field(int, usage )
  216. __field(enum fscache_volume_trace, where )
  217. ),
  218. TP_fast_assign(
  219. __entry->volume = volume_debug_id;
  220. __entry->usage = usage;
  221. __entry->where = where;
  222. ),
  223. TP_printk("V=%08x %s u=%d",
  224. __entry->volume,
  225. __print_symbolic(__entry->where, fscache_volume_traces),
  226. __entry->usage)
  227. );
  228. TRACE_EVENT(fscache_cookie,
  229. TP_PROTO(unsigned int cookie_debug_id,
  230. int ref,
  231. enum fscache_cookie_trace where),
  232. TP_ARGS(cookie_debug_id, ref, where),
  233. TP_STRUCT__entry(
  234. __field(unsigned int, cookie )
  235. __field(int, ref )
  236. __field(enum fscache_cookie_trace, where )
  237. ),
  238. TP_fast_assign(
  239. __entry->cookie = cookie_debug_id;
  240. __entry->ref = ref;
  241. __entry->where = where;
  242. ),
  243. TP_printk("c=%08x %s r=%d",
  244. __entry->cookie,
  245. __print_symbolic(__entry->where, fscache_cookie_traces),
  246. __entry->ref)
  247. );
  248. TRACE_EVENT(fscache_active,
  249. TP_PROTO(unsigned int cookie_debug_id,
  250. int ref,
  251. int n_active,
  252. int n_accesses,
  253. enum fscache_active_trace why),
  254. TP_ARGS(cookie_debug_id, ref, n_active, n_accesses, why),
  255. TP_STRUCT__entry(
  256. __field(unsigned int, cookie )
  257. __field(int, ref )
  258. __field(int, n_active )
  259. __field(int, n_accesses )
  260. __field(enum fscache_active_trace, why )
  261. ),
  262. TP_fast_assign(
  263. __entry->cookie = cookie_debug_id;
  264. __entry->ref = ref;
  265. __entry->n_active = n_active;
  266. __entry->n_accesses = n_accesses;
  267. __entry->why = why;
  268. ),
  269. TP_printk("c=%08x %s r=%d a=%d c=%d",
  270. __entry->cookie,
  271. __print_symbolic(__entry->why, fscache_active_traces),
  272. __entry->ref,
  273. __entry->n_accesses,
  274. __entry->n_active)
  275. );
  276. TRACE_EVENT(fscache_access_cache,
  277. TP_PROTO(unsigned int cache_debug_id,
  278. int ref,
  279. int n_accesses,
  280. enum fscache_access_trace why),
  281. TP_ARGS(cache_debug_id, ref, n_accesses, why),
  282. TP_STRUCT__entry(
  283. __field(unsigned int, cache )
  284. __field(int, ref )
  285. __field(int, n_accesses )
  286. __field(enum fscache_access_trace, why )
  287. ),
  288. TP_fast_assign(
  289. __entry->cache = cache_debug_id;
  290. __entry->ref = ref;
  291. __entry->n_accesses = n_accesses;
  292. __entry->why = why;
  293. ),
  294. TP_printk("C=%08x %s r=%d a=%d",
  295. __entry->cache,
  296. __print_symbolic(__entry->why, fscache_access_traces),
  297. __entry->ref,
  298. __entry->n_accesses)
  299. );
  300. TRACE_EVENT(fscache_access_volume,
  301. TP_PROTO(unsigned int volume_debug_id,
  302. unsigned int cookie_debug_id,
  303. int ref,
  304. int n_accesses,
  305. enum fscache_access_trace why),
  306. TP_ARGS(volume_debug_id, cookie_debug_id, ref, n_accesses, why),
  307. TP_STRUCT__entry(
  308. __field(unsigned int, volume )
  309. __field(unsigned int, cookie )
  310. __field(int, ref )
  311. __field(int, n_accesses )
  312. __field(enum fscache_access_trace, why )
  313. ),
  314. TP_fast_assign(
  315. __entry->volume = volume_debug_id;
  316. __entry->cookie = cookie_debug_id;
  317. __entry->ref = ref;
  318. __entry->n_accesses = n_accesses;
  319. __entry->why = why;
  320. ),
  321. TP_printk("V=%08x c=%08x %s r=%d a=%d",
  322. __entry->volume,
  323. __entry->cookie,
  324. __print_symbolic(__entry->why, fscache_access_traces),
  325. __entry->ref,
  326. __entry->n_accesses)
  327. );
  328. TRACE_EVENT(fscache_access,
  329. TP_PROTO(unsigned int cookie_debug_id,
  330. int ref,
  331. int n_accesses,
  332. enum fscache_access_trace why),
  333. TP_ARGS(cookie_debug_id, ref, n_accesses, why),
  334. TP_STRUCT__entry(
  335. __field(unsigned int, cookie )
  336. __field(int, ref )
  337. __field(int, n_accesses )
  338. __field(enum fscache_access_trace, why )
  339. ),
  340. TP_fast_assign(
  341. __entry->cookie = cookie_debug_id;
  342. __entry->ref = ref;
  343. __entry->n_accesses = n_accesses;
  344. __entry->why = why;
  345. ),
  346. TP_printk("c=%08x %s r=%d a=%d",
  347. __entry->cookie,
  348. __print_symbolic(__entry->why, fscache_access_traces),
  349. __entry->ref,
  350. __entry->n_accesses)
  351. );
  352. TRACE_EVENT(fscache_acquire,
  353. TP_PROTO(struct fscache_cookie *cookie),
  354. TP_ARGS(cookie),
  355. TP_STRUCT__entry(
  356. __field(unsigned int, cookie )
  357. __field(unsigned int, volume )
  358. __field(int, v_ref )
  359. __field(int, v_n_cookies )
  360. ),
  361. TP_fast_assign(
  362. __entry->cookie = cookie->debug_id;
  363. __entry->volume = cookie->volume->debug_id;
  364. __entry->v_ref = refcount_read(&cookie->volume->ref);
  365. __entry->v_n_cookies = atomic_read(&cookie->volume->n_cookies);
  366. ),
  367. TP_printk("c=%08x V=%08x vr=%d vc=%d",
  368. __entry->cookie,
  369. __entry->volume, __entry->v_ref, __entry->v_n_cookies)
  370. );
  371. TRACE_EVENT(fscache_relinquish,
  372. TP_PROTO(struct fscache_cookie *cookie, bool retire),
  373. TP_ARGS(cookie, retire),
  374. TP_STRUCT__entry(
  375. __field(unsigned int, cookie )
  376. __field(unsigned int, volume )
  377. __field(int, ref )
  378. __field(int, n_active )
  379. __field(u8, flags )
  380. __field(bool, retire )
  381. ),
  382. TP_fast_assign(
  383. __entry->cookie = cookie->debug_id;
  384. __entry->volume = cookie->volume->debug_id;
  385. __entry->ref = refcount_read(&cookie->ref);
  386. __entry->n_active = atomic_read(&cookie->n_active);
  387. __entry->flags = cookie->flags;
  388. __entry->retire = retire;
  389. ),
  390. TP_printk("c=%08x V=%08x r=%d U=%d f=%02x rt=%u",
  391. __entry->cookie, __entry->volume, __entry->ref,
  392. __entry->n_active, __entry->flags, __entry->retire)
  393. );
  394. TRACE_EVENT(fscache_invalidate,
  395. TP_PROTO(struct fscache_cookie *cookie, loff_t new_size),
  396. TP_ARGS(cookie, new_size),
  397. TP_STRUCT__entry(
  398. __field(unsigned int, cookie )
  399. __field(loff_t, new_size )
  400. ),
  401. TP_fast_assign(
  402. __entry->cookie = cookie->debug_id;
  403. __entry->new_size = new_size;
  404. ),
  405. TP_printk("c=%08x sz=%llx",
  406. __entry->cookie, __entry->new_size)
  407. );
  408. TRACE_EVENT(fscache_resize,
  409. TP_PROTO(struct fscache_cookie *cookie, loff_t new_size),
  410. TP_ARGS(cookie, new_size),
  411. TP_STRUCT__entry(
  412. __field(unsigned int, cookie )
  413. __field(loff_t, old_size )
  414. __field(loff_t, new_size )
  415. ),
  416. TP_fast_assign(
  417. __entry->cookie = cookie->debug_id;
  418. __entry->old_size = cookie->object_size;
  419. __entry->new_size = new_size;
  420. ),
  421. TP_printk("c=%08x os=%08llx sz=%08llx",
  422. __entry->cookie,
  423. __entry->old_size,
  424. __entry->new_size)
  425. );
  426. #endif /* _TRACE_FSCACHE_H */
  427. /* This part must be outside protection */
  428. #include <trace/define_trace.h>