netfs.h 9.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322
  1. /* SPDX-License-Identifier: GPL-2.0-or-later */
  2. /* Network filesystem support module 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 netfs
  9. #if !defined(_TRACE_NETFS_H) || defined(TRACE_HEADER_MULTI_READ)
  10. #define _TRACE_NETFS_H
  11. #include <linux/tracepoint.h>
  12. /*
  13. * Define enums for tracing information.
  14. */
  15. #define netfs_read_traces \
  16. EM(netfs_read_trace_expanded, "EXPANDED ") \
  17. EM(netfs_read_trace_readahead, "READAHEAD") \
  18. EM(netfs_read_trace_readpage, "READPAGE ") \
  19. E_(netfs_read_trace_write_begin, "WRITEBEGN")
  20. #define netfs_rreq_origins \
  21. EM(NETFS_READAHEAD, "RA") \
  22. EM(NETFS_READPAGE, "RP") \
  23. E_(NETFS_READ_FOR_WRITE, "RW")
  24. #define netfs_rreq_traces \
  25. EM(netfs_rreq_trace_assess, "ASSESS ") \
  26. EM(netfs_rreq_trace_copy, "COPY ") \
  27. EM(netfs_rreq_trace_done, "DONE ") \
  28. EM(netfs_rreq_trace_free, "FREE ") \
  29. EM(netfs_rreq_trace_resubmit, "RESUBMT") \
  30. EM(netfs_rreq_trace_unlock, "UNLOCK ") \
  31. E_(netfs_rreq_trace_unmark, "UNMARK ")
  32. #define netfs_sreq_sources \
  33. EM(NETFS_FILL_WITH_ZEROES, "ZERO") \
  34. EM(NETFS_DOWNLOAD_FROM_SERVER, "DOWN") \
  35. EM(NETFS_READ_FROM_CACHE, "READ") \
  36. E_(NETFS_INVALID_READ, "INVL") \
  37. #define netfs_sreq_traces \
  38. EM(netfs_sreq_trace_download_instead, "RDOWN") \
  39. EM(netfs_sreq_trace_free, "FREE ") \
  40. EM(netfs_sreq_trace_prepare, "PREP ") \
  41. EM(netfs_sreq_trace_resubmit_short, "SHORT") \
  42. EM(netfs_sreq_trace_submit, "SUBMT") \
  43. EM(netfs_sreq_trace_terminated, "TERM ") \
  44. EM(netfs_sreq_trace_write, "WRITE") \
  45. EM(netfs_sreq_trace_write_skip, "SKIP ") \
  46. E_(netfs_sreq_trace_write_term, "WTERM")
  47. #define netfs_failures \
  48. EM(netfs_fail_check_write_begin, "check-write-begin") \
  49. EM(netfs_fail_copy_to_cache, "copy-to-cache") \
  50. EM(netfs_fail_read, "read") \
  51. EM(netfs_fail_short_read, "short-read") \
  52. E_(netfs_fail_prepare_write, "prep-write")
  53. #define netfs_rreq_ref_traces \
  54. EM(netfs_rreq_trace_get_hold, "GET HOLD ") \
  55. EM(netfs_rreq_trace_get_subreq, "GET SUBREQ ") \
  56. EM(netfs_rreq_trace_put_complete, "PUT COMPLT ") \
  57. EM(netfs_rreq_trace_put_discard, "PUT DISCARD") \
  58. EM(netfs_rreq_trace_put_failed, "PUT FAILED ") \
  59. EM(netfs_rreq_trace_put_hold, "PUT HOLD ") \
  60. EM(netfs_rreq_trace_put_subreq, "PUT SUBREQ ") \
  61. EM(netfs_rreq_trace_put_zero_len, "PUT ZEROLEN") \
  62. E_(netfs_rreq_trace_new, "NEW ")
  63. #define netfs_sreq_ref_traces \
  64. EM(netfs_sreq_trace_get_copy_to_cache, "GET COPY2C ") \
  65. EM(netfs_sreq_trace_get_resubmit, "GET RESUBMIT") \
  66. EM(netfs_sreq_trace_get_short_read, "GET SHORTRD") \
  67. EM(netfs_sreq_trace_new, "NEW ") \
  68. EM(netfs_sreq_trace_put_clear, "PUT CLEAR ") \
  69. EM(netfs_sreq_trace_put_failed, "PUT FAILED ") \
  70. EM(netfs_sreq_trace_put_merged, "PUT MERGED ") \
  71. EM(netfs_sreq_trace_put_no_copy, "PUT NO COPY") \
  72. E_(netfs_sreq_trace_put_terminated, "PUT TERM ")
  73. #ifndef __NETFS_DECLARE_TRACE_ENUMS_ONCE_ONLY
  74. #define __NETFS_DECLARE_TRACE_ENUMS_ONCE_ONLY
  75. #undef EM
  76. #undef E_
  77. #define EM(a, b) a,
  78. #define E_(a, b) a
  79. enum netfs_read_trace { netfs_read_traces } __mode(byte);
  80. enum netfs_rreq_trace { netfs_rreq_traces } __mode(byte);
  81. enum netfs_sreq_trace { netfs_sreq_traces } __mode(byte);
  82. enum netfs_failure { netfs_failures } __mode(byte);
  83. enum netfs_rreq_ref_trace { netfs_rreq_ref_traces } __mode(byte);
  84. enum netfs_sreq_ref_trace { netfs_sreq_ref_traces } __mode(byte);
  85. #endif
  86. /*
  87. * Export enum symbols via userspace.
  88. */
  89. #undef EM
  90. #undef E_
  91. #define EM(a, b) TRACE_DEFINE_ENUM(a);
  92. #define E_(a, b) TRACE_DEFINE_ENUM(a);
  93. netfs_read_traces;
  94. netfs_rreq_origins;
  95. netfs_rreq_traces;
  96. netfs_sreq_sources;
  97. netfs_sreq_traces;
  98. netfs_failures;
  99. netfs_rreq_ref_traces;
  100. netfs_sreq_ref_traces;
  101. /*
  102. * Now redefine the EM() and E_() macros to map the enums to the strings that
  103. * will be printed in the output.
  104. */
  105. #undef EM
  106. #undef E_
  107. #define EM(a, b) { a, b },
  108. #define E_(a, b) { a, b }
  109. TRACE_EVENT(netfs_read,
  110. TP_PROTO(struct netfs_io_request *rreq,
  111. loff_t start, size_t len,
  112. enum netfs_read_trace what),
  113. TP_ARGS(rreq, start, len, what),
  114. TP_STRUCT__entry(
  115. __field(unsigned int, rreq )
  116. __field(unsigned int, cookie )
  117. __field(loff_t, start )
  118. __field(size_t, len )
  119. __field(enum netfs_read_trace, what )
  120. __field(unsigned int, netfs_inode )
  121. ),
  122. TP_fast_assign(
  123. __entry->rreq = rreq->debug_id;
  124. __entry->cookie = rreq->cache_resources.debug_id;
  125. __entry->start = start;
  126. __entry->len = len;
  127. __entry->what = what;
  128. __entry->netfs_inode = rreq->inode->i_ino;
  129. ),
  130. TP_printk("R=%08x %s c=%08x ni=%x s=%llx %zx",
  131. __entry->rreq,
  132. __print_symbolic(__entry->what, netfs_read_traces),
  133. __entry->cookie,
  134. __entry->netfs_inode,
  135. __entry->start, __entry->len)
  136. );
  137. TRACE_EVENT(netfs_rreq,
  138. TP_PROTO(struct netfs_io_request *rreq,
  139. enum netfs_rreq_trace what),
  140. TP_ARGS(rreq, what),
  141. TP_STRUCT__entry(
  142. __field(unsigned int, rreq )
  143. __field(unsigned int, flags )
  144. __field(enum netfs_io_origin, origin )
  145. __field(enum netfs_rreq_trace, what )
  146. ),
  147. TP_fast_assign(
  148. __entry->rreq = rreq->debug_id;
  149. __entry->flags = rreq->flags;
  150. __entry->origin = rreq->origin;
  151. __entry->what = what;
  152. ),
  153. TP_printk("R=%08x %s %s f=%02x",
  154. __entry->rreq,
  155. __print_symbolic(__entry->origin, netfs_rreq_origins),
  156. __print_symbolic(__entry->what, netfs_rreq_traces),
  157. __entry->flags)
  158. );
  159. TRACE_EVENT(netfs_sreq,
  160. TP_PROTO(struct netfs_io_subrequest *sreq,
  161. enum netfs_sreq_trace what),
  162. TP_ARGS(sreq, what),
  163. TP_STRUCT__entry(
  164. __field(unsigned int, rreq )
  165. __field(unsigned short, index )
  166. __field(short, error )
  167. __field(unsigned short, flags )
  168. __field(enum netfs_io_source, source )
  169. __field(enum netfs_sreq_trace, what )
  170. __field(size_t, len )
  171. __field(size_t, transferred )
  172. __field(loff_t, start )
  173. ),
  174. TP_fast_assign(
  175. __entry->rreq = sreq->rreq->debug_id;
  176. __entry->index = sreq->debug_index;
  177. __entry->error = sreq->error;
  178. __entry->flags = sreq->flags;
  179. __entry->source = sreq->source;
  180. __entry->what = what;
  181. __entry->len = sreq->len;
  182. __entry->transferred = sreq->transferred;
  183. __entry->start = sreq->start;
  184. ),
  185. TP_printk("R=%08x[%u] %s %s f=%02x s=%llx %zx/%zx e=%d",
  186. __entry->rreq, __entry->index,
  187. __print_symbolic(__entry->source, netfs_sreq_sources),
  188. __print_symbolic(__entry->what, netfs_sreq_traces),
  189. __entry->flags,
  190. __entry->start, __entry->transferred, __entry->len,
  191. __entry->error)
  192. );
  193. TRACE_EVENT(netfs_failure,
  194. TP_PROTO(struct netfs_io_request *rreq,
  195. struct netfs_io_subrequest *sreq,
  196. int error, enum netfs_failure what),
  197. TP_ARGS(rreq, sreq, error, what),
  198. TP_STRUCT__entry(
  199. __field(unsigned int, rreq )
  200. __field(short, index )
  201. __field(short, error )
  202. __field(unsigned short, flags )
  203. __field(enum netfs_io_source, source )
  204. __field(enum netfs_failure, what )
  205. __field(size_t, len )
  206. __field(size_t, transferred )
  207. __field(loff_t, start )
  208. ),
  209. TP_fast_assign(
  210. __entry->rreq = rreq->debug_id;
  211. __entry->index = sreq ? sreq->debug_index : -1;
  212. __entry->error = error;
  213. __entry->flags = sreq ? sreq->flags : 0;
  214. __entry->source = sreq ? sreq->source : NETFS_INVALID_READ;
  215. __entry->what = what;
  216. __entry->len = sreq ? sreq->len : rreq->len;
  217. __entry->transferred = sreq ? sreq->transferred : 0;
  218. __entry->start = sreq ? sreq->start : 0;
  219. ),
  220. TP_printk("R=%08x[%d] %s f=%02x s=%llx %zx/%zx %s e=%d",
  221. __entry->rreq, __entry->index,
  222. __print_symbolic(__entry->source, netfs_sreq_sources),
  223. __entry->flags,
  224. __entry->start, __entry->transferred, __entry->len,
  225. __print_symbolic(__entry->what, netfs_failures),
  226. __entry->error)
  227. );
  228. TRACE_EVENT(netfs_rreq_ref,
  229. TP_PROTO(unsigned int rreq_debug_id, int ref,
  230. enum netfs_rreq_ref_trace what),
  231. TP_ARGS(rreq_debug_id, ref, what),
  232. TP_STRUCT__entry(
  233. __field(unsigned int, rreq )
  234. __field(int, ref )
  235. __field(enum netfs_rreq_ref_trace, what )
  236. ),
  237. TP_fast_assign(
  238. __entry->rreq = rreq_debug_id;
  239. __entry->ref = ref;
  240. __entry->what = what;
  241. ),
  242. TP_printk("R=%08x %s r=%u",
  243. __entry->rreq,
  244. __print_symbolic(__entry->what, netfs_rreq_ref_traces),
  245. __entry->ref)
  246. );
  247. TRACE_EVENT(netfs_sreq_ref,
  248. TP_PROTO(unsigned int rreq_debug_id, unsigned int subreq_debug_index,
  249. int ref, enum netfs_sreq_ref_trace what),
  250. TP_ARGS(rreq_debug_id, subreq_debug_index, ref, what),
  251. TP_STRUCT__entry(
  252. __field(unsigned int, rreq )
  253. __field(unsigned int, subreq )
  254. __field(int, ref )
  255. __field(enum netfs_sreq_ref_trace, what )
  256. ),
  257. TP_fast_assign(
  258. __entry->rreq = rreq_debug_id;
  259. __entry->subreq = subreq_debug_index;
  260. __entry->ref = ref;
  261. __entry->what = what;
  262. ),
  263. TP_printk("R=%08x[%x] %s r=%u",
  264. __entry->rreq,
  265. __entry->subreq,
  266. __print_symbolic(__entry->what, netfs_sreq_ref_traces),
  267. __entry->ref)
  268. );
  269. #undef EM
  270. #undef E_
  271. #endif /* _TRACE_NETFS_H */
  272. /* This part must be outside protection */
  273. #include <trace/define_trace.h>