xref: /openbmc/linux/include/trace/events/scsi.h (revision e3b9f1e8)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 #undef TRACE_SYSTEM
3 #define TRACE_SYSTEM scsi
4 
5 #if !defined(_TRACE_SCSI_H) || defined(TRACE_HEADER_MULTI_READ)
6 #define _TRACE_SCSI_H
7 
8 #include <scsi/scsi_cmnd.h>
9 #include <scsi/scsi_host.h>
10 #include <linux/tracepoint.h>
11 #include <linux/trace_seq.h>
12 
13 #define scsi_opcode_name(opcode)	{ opcode, #opcode }
14 #define show_opcode_name(val)					\
15 	__print_symbolic(val,					\
16 		scsi_opcode_name(TEST_UNIT_READY),		\
17 		scsi_opcode_name(REZERO_UNIT),			\
18 		scsi_opcode_name(REQUEST_SENSE),		\
19 		scsi_opcode_name(FORMAT_UNIT),			\
20 		scsi_opcode_name(READ_BLOCK_LIMITS),		\
21 		scsi_opcode_name(REASSIGN_BLOCKS),		\
22 		scsi_opcode_name(INITIALIZE_ELEMENT_STATUS),	\
23 		scsi_opcode_name(READ_6),			\
24 		scsi_opcode_name(WRITE_6),			\
25 		scsi_opcode_name(SEEK_6),			\
26 		scsi_opcode_name(READ_REVERSE),			\
27 		scsi_opcode_name(WRITE_FILEMARKS),		\
28 		scsi_opcode_name(SPACE),			\
29 		scsi_opcode_name(INQUIRY),			\
30 		scsi_opcode_name(RECOVER_BUFFERED_DATA),	\
31 		scsi_opcode_name(MODE_SELECT),			\
32 		scsi_opcode_name(RESERVE),			\
33 		scsi_opcode_name(RELEASE),			\
34 		scsi_opcode_name(COPY),				\
35 		scsi_opcode_name(ERASE),			\
36 		scsi_opcode_name(MODE_SENSE),			\
37 		scsi_opcode_name(START_STOP),			\
38 		scsi_opcode_name(RECEIVE_DIAGNOSTIC),		\
39 		scsi_opcode_name(SEND_DIAGNOSTIC),		\
40 		scsi_opcode_name(ALLOW_MEDIUM_REMOVAL),		\
41 		scsi_opcode_name(SET_WINDOW),			\
42 		scsi_opcode_name(READ_CAPACITY),		\
43 		scsi_opcode_name(READ_10),			\
44 		scsi_opcode_name(WRITE_10),			\
45 		scsi_opcode_name(SEEK_10),			\
46 		scsi_opcode_name(POSITION_TO_ELEMENT),		\
47 		scsi_opcode_name(WRITE_VERIFY),			\
48 		scsi_opcode_name(VERIFY),			\
49 		scsi_opcode_name(SEARCH_HIGH),			\
50 		scsi_opcode_name(SEARCH_EQUAL),			\
51 		scsi_opcode_name(SEARCH_LOW),			\
52 		scsi_opcode_name(SET_LIMITS),			\
53 		scsi_opcode_name(PRE_FETCH),			\
54 		scsi_opcode_name(READ_POSITION),		\
55 		scsi_opcode_name(SYNCHRONIZE_CACHE),		\
56 		scsi_opcode_name(LOCK_UNLOCK_CACHE),		\
57 		scsi_opcode_name(READ_DEFECT_DATA),		\
58 		scsi_opcode_name(MEDIUM_SCAN),			\
59 		scsi_opcode_name(COMPARE),			\
60 		scsi_opcode_name(COPY_VERIFY),			\
61 		scsi_opcode_name(WRITE_BUFFER),			\
62 		scsi_opcode_name(READ_BUFFER),			\
63 		scsi_opcode_name(UPDATE_BLOCK),			\
64 		scsi_opcode_name(READ_LONG),			\
65 		scsi_opcode_name(WRITE_LONG),			\
66 		scsi_opcode_name(CHANGE_DEFINITION),		\
67 		scsi_opcode_name(WRITE_SAME),			\
68 		scsi_opcode_name(UNMAP),			\
69 		scsi_opcode_name(READ_TOC),			\
70 		scsi_opcode_name(LOG_SELECT),			\
71 		scsi_opcode_name(LOG_SENSE),			\
72 		scsi_opcode_name(XDWRITEREAD_10),		\
73 		scsi_opcode_name(MODE_SELECT_10),		\
74 		scsi_opcode_name(RESERVE_10),			\
75 		scsi_opcode_name(RELEASE_10),			\
76 		scsi_opcode_name(MODE_SENSE_10),		\
77 		scsi_opcode_name(PERSISTENT_RESERVE_IN),	\
78 		scsi_opcode_name(PERSISTENT_RESERVE_OUT),	\
79 		scsi_opcode_name(VARIABLE_LENGTH_CMD),		\
80 		scsi_opcode_name(REPORT_LUNS),			\
81 		scsi_opcode_name(MAINTENANCE_IN),		\
82 		scsi_opcode_name(MAINTENANCE_OUT),		\
83 		scsi_opcode_name(MOVE_MEDIUM),			\
84 		scsi_opcode_name(EXCHANGE_MEDIUM),		\
85 		scsi_opcode_name(READ_12),			\
86 		scsi_opcode_name(WRITE_12),			\
87 		scsi_opcode_name(WRITE_VERIFY_12),		\
88 		scsi_opcode_name(SEARCH_HIGH_12),		\
89 		scsi_opcode_name(SEARCH_EQUAL_12),		\
90 		scsi_opcode_name(SEARCH_LOW_12),		\
91 		scsi_opcode_name(READ_ELEMENT_STATUS),		\
92 		scsi_opcode_name(SEND_VOLUME_TAG),		\
93 		scsi_opcode_name(WRITE_LONG_2),			\
94 		scsi_opcode_name(READ_16),			\
95 		scsi_opcode_name(WRITE_16),			\
96 		scsi_opcode_name(VERIFY_16),			\
97 		scsi_opcode_name(WRITE_SAME_16),		\
98 		scsi_opcode_name(ZBC_OUT),			\
99 		scsi_opcode_name(ZBC_IN),			\
100 		scsi_opcode_name(SERVICE_ACTION_IN_16),		\
101 		scsi_opcode_name(READ_32),			\
102 		scsi_opcode_name(WRITE_32),			\
103 		scsi_opcode_name(WRITE_SAME_32),		\
104 		scsi_opcode_name(ATA_16),			\
105 		scsi_opcode_name(ATA_12))
106 
107 #define scsi_hostbyte_name(result)	{ result, #result }
108 #define show_hostbyte_name(val)					\
109 	__print_symbolic(val,					\
110 		scsi_hostbyte_name(DID_OK),			\
111 		scsi_hostbyte_name(DID_NO_CONNECT),		\
112 		scsi_hostbyte_name(DID_BUS_BUSY),		\
113 		scsi_hostbyte_name(DID_TIME_OUT),		\
114 		scsi_hostbyte_name(DID_BAD_TARGET),		\
115 		scsi_hostbyte_name(DID_ABORT),			\
116 		scsi_hostbyte_name(DID_PARITY),			\
117 		scsi_hostbyte_name(DID_ERROR),			\
118 		scsi_hostbyte_name(DID_RESET),			\
119 		scsi_hostbyte_name(DID_BAD_INTR),		\
120 		scsi_hostbyte_name(DID_PASSTHROUGH),		\
121 		scsi_hostbyte_name(DID_SOFT_ERROR),		\
122 		scsi_hostbyte_name(DID_IMM_RETRY),		\
123 		scsi_hostbyte_name(DID_REQUEUE),		\
124 		scsi_hostbyte_name(DID_TRANSPORT_DISRUPTED),	\
125 		scsi_hostbyte_name(DID_TRANSPORT_FAILFAST))
126 
127 #define scsi_driverbyte_name(result)	{ result, #result }
128 #define show_driverbyte_name(val)				\
129 	__print_symbolic(val,					\
130 		scsi_driverbyte_name(DRIVER_OK),		\
131 		scsi_driverbyte_name(DRIVER_BUSY),		\
132 		scsi_driverbyte_name(DRIVER_SOFT),		\
133 		scsi_driverbyte_name(DRIVER_MEDIA),		\
134 		scsi_driverbyte_name(DRIVER_ERROR),		\
135 		scsi_driverbyte_name(DRIVER_INVALID),		\
136 		scsi_driverbyte_name(DRIVER_TIMEOUT),		\
137 		scsi_driverbyte_name(DRIVER_HARD),		\
138 		scsi_driverbyte_name(DRIVER_SENSE))
139 
140 #define scsi_msgbyte_name(result)	{ result, #result }
141 #define show_msgbyte_name(val)					\
142 	__print_symbolic(val,					\
143 		scsi_msgbyte_name(COMMAND_COMPLETE),		\
144 		scsi_msgbyte_name(EXTENDED_MESSAGE),		\
145 		scsi_msgbyte_name(SAVE_POINTERS),		\
146 		scsi_msgbyte_name(RESTORE_POINTERS),		\
147 		scsi_msgbyte_name(DISCONNECT),			\
148 		scsi_msgbyte_name(INITIATOR_ERROR),		\
149 		scsi_msgbyte_name(ABORT_TASK_SET),		\
150 		scsi_msgbyte_name(MESSAGE_REJECT),		\
151 		scsi_msgbyte_name(NOP),				\
152 		scsi_msgbyte_name(MSG_PARITY_ERROR),		\
153 		scsi_msgbyte_name(LINKED_CMD_COMPLETE),		\
154 		scsi_msgbyte_name(LINKED_FLG_CMD_COMPLETE),	\
155 		scsi_msgbyte_name(TARGET_RESET),		\
156 		scsi_msgbyte_name(ABORT_TASK),			\
157 		scsi_msgbyte_name(CLEAR_TASK_SET),		\
158 		scsi_msgbyte_name(INITIATE_RECOVERY),		\
159 		scsi_msgbyte_name(RELEASE_RECOVERY),		\
160 		scsi_msgbyte_name(CLEAR_ACA),			\
161 		scsi_msgbyte_name(LOGICAL_UNIT_RESET),		\
162 		scsi_msgbyte_name(SIMPLE_QUEUE_TAG),		\
163 		scsi_msgbyte_name(HEAD_OF_QUEUE_TAG),		\
164 		scsi_msgbyte_name(ORDERED_QUEUE_TAG),		\
165 		scsi_msgbyte_name(IGNORE_WIDE_RESIDUE),		\
166 		scsi_msgbyte_name(ACA),				\
167 		scsi_msgbyte_name(QAS_REQUEST),			\
168 		scsi_msgbyte_name(BUS_DEVICE_RESET),		\
169 		scsi_msgbyte_name(ABORT))
170 
171 #define scsi_statusbyte_name(result)	{ result, #result }
172 #define show_statusbyte_name(val)				\
173 	__print_symbolic(val,					\
174 		scsi_statusbyte_name(SAM_STAT_GOOD),		\
175 		scsi_statusbyte_name(SAM_STAT_CHECK_CONDITION),	\
176 		scsi_statusbyte_name(SAM_STAT_CONDITION_MET),	\
177 		scsi_statusbyte_name(SAM_STAT_BUSY),		\
178 		scsi_statusbyte_name(SAM_STAT_INTERMEDIATE),	\
179 		scsi_statusbyte_name(SAM_STAT_INTERMEDIATE_CONDITION_MET), \
180 		scsi_statusbyte_name(SAM_STAT_RESERVATION_CONFLICT),	\
181 		scsi_statusbyte_name(SAM_STAT_COMMAND_TERMINATED),	\
182 		scsi_statusbyte_name(SAM_STAT_TASK_SET_FULL),	\
183 		scsi_statusbyte_name(SAM_STAT_ACA_ACTIVE),	\
184 		scsi_statusbyte_name(SAM_STAT_TASK_ABORTED))
185 
186 #define scsi_prot_op_name(result)	{ result, #result }
187 #define show_prot_op_name(val)					\
188 	__print_symbolic(val,					\
189 		scsi_prot_op_name(SCSI_PROT_NORMAL),		\
190 		scsi_prot_op_name(SCSI_PROT_READ_INSERT),	\
191 		scsi_prot_op_name(SCSI_PROT_WRITE_STRIP),	\
192 		scsi_prot_op_name(SCSI_PROT_READ_STRIP),	\
193 		scsi_prot_op_name(SCSI_PROT_WRITE_INSERT),	\
194 		scsi_prot_op_name(SCSI_PROT_READ_PASS),		\
195 		scsi_prot_op_name(SCSI_PROT_WRITE_PASS))
196 
197 const char *scsi_trace_parse_cdb(struct trace_seq*, unsigned char*, int);
198 #define __parse_cdb(cdb, len) scsi_trace_parse_cdb(p, cdb, len)
199 
200 TRACE_EVENT(scsi_dispatch_cmd_start,
201 
202 	TP_PROTO(struct scsi_cmnd *cmd),
203 
204 	TP_ARGS(cmd),
205 
206 	TP_STRUCT__entry(
207 		__field( unsigned int,	host_no	)
208 		__field( unsigned int,	channel	)
209 		__field( unsigned int,	id	)
210 		__field( unsigned int,	lun	)
211 		__field( unsigned int,	opcode	)
212 		__field( unsigned int,	cmd_len )
213 		__field( unsigned int,	data_sglen )
214 		__field( unsigned int,	prot_sglen )
215 		__field( unsigned char,	prot_op )
216 		__dynamic_array(unsigned char,	cmnd, cmd->cmd_len)
217 	),
218 
219 	TP_fast_assign(
220 		__entry->host_no	= cmd->device->host->host_no;
221 		__entry->channel	= cmd->device->channel;
222 		__entry->id		= cmd->device->id;
223 		__entry->lun		= cmd->device->lun;
224 		__entry->opcode		= cmd->cmnd[0];
225 		__entry->cmd_len	= cmd->cmd_len;
226 		__entry->data_sglen	= scsi_sg_count(cmd);
227 		__entry->prot_sglen	= scsi_prot_sg_count(cmd);
228 		__entry->prot_op	= scsi_get_prot_op(cmd);
229 		memcpy(__get_dynamic_array(cmnd), cmd->cmnd, cmd->cmd_len);
230 	),
231 
232 	TP_printk("host_no=%u channel=%u id=%u lun=%u data_sgl=%u prot_sgl=%u" \
233 		  " prot_op=%s cmnd=(%s %s raw=%s)",
234 		  __entry->host_no, __entry->channel, __entry->id,
235 		  __entry->lun, __entry->data_sglen, __entry->prot_sglen,
236 		  show_prot_op_name(__entry->prot_op),
237 		  show_opcode_name(__entry->opcode),
238 		  __parse_cdb(__get_dynamic_array(cmnd), __entry->cmd_len),
239 		  __print_hex(__get_dynamic_array(cmnd), __entry->cmd_len))
240 );
241 
242 TRACE_EVENT(scsi_dispatch_cmd_error,
243 
244 	TP_PROTO(struct scsi_cmnd *cmd, int rtn),
245 
246 	TP_ARGS(cmd, rtn),
247 
248 	TP_STRUCT__entry(
249 		__field( unsigned int,	host_no	)
250 		__field( unsigned int,	channel	)
251 		__field( unsigned int,	id	)
252 		__field( unsigned int,	lun	)
253 		__field( int,		rtn	)
254 		__field( unsigned int,	opcode	)
255 		__field( unsigned int,	cmd_len )
256 		__field( unsigned int,	data_sglen )
257 		__field( unsigned int,	prot_sglen )
258 		__field( unsigned char,	prot_op )
259 		__dynamic_array(unsigned char,	cmnd, cmd->cmd_len)
260 	),
261 
262 	TP_fast_assign(
263 		__entry->host_no	= cmd->device->host->host_no;
264 		__entry->channel	= cmd->device->channel;
265 		__entry->id		= cmd->device->id;
266 		__entry->lun		= cmd->device->lun;
267 		__entry->rtn		= rtn;
268 		__entry->opcode		= cmd->cmnd[0];
269 		__entry->cmd_len	= cmd->cmd_len;
270 		__entry->data_sglen	= scsi_sg_count(cmd);
271 		__entry->prot_sglen	= scsi_prot_sg_count(cmd);
272 		__entry->prot_op	= scsi_get_prot_op(cmd);
273 		memcpy(__get_dynamic_array(cmnd), cmd->cmnd, cmd->cmd_len);
274 	),
275 
276 	TP_printk("host_no=%u channel=%u id=%u lun=%u data_sgl=%u prot_sgl=%u" \
277 		  " prot_op=%s cmnd=(%s %s raw=%s) rtn=%d",
278 		  __entry->host_no, __entry->channel, __entry->id,
279 		  __entry->lun, __entry->data_sglen, __entry->prot_sglen,
280 		  show_prot_op_name(__entry->prot_op),
281 		  show_opcode_name(__entry->opcode),
282 		  __parse_cdb(__get_dynamic_array(cmnd), __entry->cmd_len),
283 		  __print_hex(__get_dynamic_array(cmnd), __entry->cmd_len),
284 		  __entry->rtn)
285 );
286 
287 DECLARE_EVENT_CLASS(scsi_cmd_done_timeout_template,
288 
289 	TP_PROTO(struct scsi_cmnd *cmd),
290 
291 	TP_ARGS(cmd),
292 
293 	TP_STRUCT__entry(
294 		__field( unsigned int,	host_no	)
295 		__field( unsigned int,	channel	)
296 		__field( unsigned int,	id	)
297 		__field( unsigned int,	lun	)
298 		__field( int,		result	)
299 		__field( unsigned int,	opcode	)
300 		__field( unsigned int,	cmd_len )
301 		__field( unsigned int,	data_sglen )
302 		__field( unsigned int,	prot_sglen )
303 		__field( unsigned char,	prot_op )
304 		__dynamic_array(unsigned char,	cmnd, cmd->cmd_len)
305 	),
306 
307 	TP_fast_assign(
308 		__entry->host_no	= cmd->device->host->host_no;
309 		__entry->channel	= cmd->device->channel;
310 		__entry->id		= cmd->device->id;
311 		__entry->lun		= cmd->device->lun;
312 		__entry->result		= cmd->result;
313 		__entry->opcode		= cmd->cmnd[0];
314 		__entry->cmd_len	= cmd->cmd_len;
315 		__entry->data_sglen	= scsi_sg_count(cmd);
316 		__entry->prot_sglen	= scsi_prot_sg_count(cmd);
317 		__entry->prot_op	= scsi_get_prot_op(cmd);
318 		memcpy(__get_dynamic_array(cmnd), cmd->cmnd, cmd->cmd_len);
319 	),
320 
321 	TP_printk("host_no=%u channel=%u id=%u lun=%u data_sgl=%u " \
322 		  "prot_sgl=%u prot_op=%s cmnd=(%s %s raw=%s) result=(driver=" \
323 		  "%s host=%s message=%s status=%s)",
324 		  __entry->host_no, __entry->channel, __entry->id,
325 		  __entry->lun, __entry->data_sglen, __entry->prot_sglen,
326 		  show_prot_op_name(__entry->prot_op),
327 		  show_opcode_name(__entry->opcode),
328 		  __parse_cdb(__get_dynamic_array(cmnd), __entry->cmd_len),
329 		  __print_hex(__get_dynamic_array(cmnd), __entry->cmd_len),
330 		  show_driverbyte_name(((__entry->result) >> 24) & 0xff),
331 		  show_hostbyte_name(((__entry->result) >> 16) & 0xff),
332 		  show_msgbyte_name(((__entry->result) >> 8) & 0xff),
333 		  show_statusbyte_name(__entry->result & 0xff))
334 );
335 
336 DEFINE_EVENT(scsi_cmd_done_timeout_template, scsi_dispatch_cmd_done,
337 	     TP_PROTO(struct scsi_cmnd *cmd),
338 	     TP_ARGS(cmd));
339 
340 DEFINE_EVENT(scsi_cmd_done_timeout_template, scsi_dispatch_cmd_timeout,
341 	     TP_PROTO(struct scsi_cmnd *cmd),
342 	     TP_ARGS(cmd));
343 
344 TRACE_EVENT(scsi_eh_wakeup,
345 
346 	TP_PROTO(struct Scsi_Host *shost),
347 
348 	TP_ARGS(shost),
349 
350 	TP_STRUCT__entry(
351 		__field( unsigned int,	host_no	)
352 	),
353 
354 	TP_fast_assign(
355 		__entry->host_no	= shost->host_no;
356 	),
357 
358 	TP_printk("host_no=%u", __entry->host_no)
359 );
360 
361 #endif /*  _TRACE_SCSI_H */
362 
363 /* This part must be outside protection */
364 #include <trace/define_trace.h>
365