3 * debug feature declarations
5 * Copyright IBM Corp. 2008, 2015
11 #include <scsi/fc/fc_fcp.h>
16 #define ZFCP_DBF_TAG_LEN 7
18 #define ZFCP_DBF_INVALID_LUN 0xFFFFFFFFFFFFFFFFull
20 enum zfcp_dbf_pseudo_erp_act_type {
21 ZFCP_PSEUDO_ERP_ACTION_RPORT_ADD = 0xff,
22 ZFCP_PSEUDO_ERP_ACTION_RPORT_DEL = 0xfe,
26 * struct zfcp_dbf_rec_trigger - trace record for triggered recovery action
27 * @ready: number of ready recovery actions
28 * @running: number of running recovery actions
29 * @want: wanted recovery action
30 * @need: needed recovery action
32 struct zfcp_dbf_rec_trigger {
40 * struct zfcp_dbf_rec_running - trace record for running recovery
41 * @fsf_req_id: request id for fsf requests
42 * @rec_status: status of the fsf request
43 * @rec_step: current step of the recovery action
44 * rec_count: recovery counter
46 struct zfcp_dbf_rec_running {
55 * enum zfcp_dbf_rec_id - recovery trace record id
56 * @ZFCP_DBF_REC_TRIG: triggered recovery identifier
57 * @ZFCP_DBF_REC_RUN: running recovery identifier
59 enum zfcp_dbf_rec_id {
60 ZFCP_DBF_REC_TRIG = 1,
65 * struct zfcp_dbf_rec - trace record for error recovery actions
66 * @id: unique number of recovery record type
67 * @tag: identifier string specifying the location of initiation
68 * @lun: logical unit number
69 * @wwpn: word wide port number
70 * @d_id: destination ID
71 * @adapter_status: current status of the adapter
72 * @port_status: current status of the port
73 * @lun_status: current status of the lun
74 * @u.trig: structure zfcp_dbf_rec_trigger
75 * @u.run: structure zfcp_dbf_rec_running
79 char tag[ZFCP_DBF_TAG_LEN];
87 struct zfcp_dbf_rec_trigger trig;
88 struct zfcp_dbf_rec_running run;
93 * enum zfcp_dbf_san_id - SAN trace record identifier
94 * @ZFCP_DBF_SAN_REQ: request trace record id
95 * @ZFCP_DBF_SAN_RES: response trace record id
96 * @ZFCP_DBF_SAN_ELS: extended link service record id
98 enum zfcp_dbf_san_id {
100 ZFCP_DBF_SAN_RES = 2,
101 ZFCP_DBF_SAN_ELS = 3,
104 /** struct zfcp_dbf_san - trace record for SAN requests and responses
105 * @id: unique number of recovery record type
106 * @tag: identifier string specifying the location of initiation
107 * @fsf_req_id: request id for fsf requests
108 * @payload: unformatted information related to request/response
109 * @d_id: destination id
111 struct zfcp_dbf_san {
113 char tag[ZFCP_DBF_TAG_LEN];
116 #define ZFCP_DBF_SAN_MAX_PAYLOAD (FC_CT_HDR_LEN + 32)
117 char payload[ZFCP_DBF_SAN_MAX_PAYLOAD];
121 * struct zfcp_dbf_hba_res - trace record for hba responses
122 * @req_issued: timestamp when request was issued
123 * @prot_status: protocol status
124 * @prot_status_qual: protocol status qualifier
125 * @fsf_status: fsf status
126 * @fsf_status_qual: fsf status qualifier
128 struct zfcp_dbf_hba_res {
131 u8 prot_status_qual[FSF_PROT_STATUS_QUAL_SIZE];
133 u8 fsf_status_qual[FSF_STATUS_QUALIFIER_SIZE];
137 * struct zfcp_dbf_hba_uss - trace record for unsolicited status
138 * @status_type: type of unsolicited status
139 * @status_subtype: subtype of unsolicited status
140 * @d_id: destination ID
141 * @lun: logical unit number
142 * @queue_designator: queue designator
144 struct zfcp_dbf_hba_uss {
149 u64 queue_designator;
153 * enum zfcp_dbf_hba_id - HBA trace record identifier
154 * @ZFCP_DBF_HBA_RES: response trace record
155 * @ZFCP_DBF_HBA_USS: unsolicited status trace record
156 * @ZFCP_DBF_HBA_BIT: bit error trace record
158 enum zfcp_dbf_hba_id {
159 ZFCP_DBF_HBA_RES = 1,
160 ZFCP_DBF_HBA_USS = 2,
161 ZFCP_DBF_HBA_BIT = 3,
162 ZFCP_DBF_HBA_BASIC = 4,
166 * struct zfcp_dbf_hba - common trace record for HBA records
167 * @id: unique number of recovery record type
168 * @tag: identifier string specifying the location of initiation
169 * @fsf_req_id: request id for fsf requests
170 * @fsf_req_status: status of fsf request
171 * @fsf_cmd: fsf command
172 * @fsf_seq_no: fsf sequence number
173 * @pl_len: length of payload stored as zfcp_dbf_pay
174 * @u: record type specific data
176 struct zfcp_dbf_hba {
178 char tag[ZFCP_DBF_TAG_LEN];
185 struct zfcp_dbf_hba_res res;
186 struct zfcp_dbf_hba_uss uss;
187 struct fsf_bit_error_payload be;
192 * enum zfcp_dbf_scsi_id - scsi trace record identifier
193 * @ZFCP_DBF_SCSI_CMND: scsi command trace record
195 enum zfcp_dbf_scsi_id {
196 ZFCP_DBF_SCSI_CMND = 1,
200 * struct zfcp_dbf_scsi - common trace record for SCSI records
201 * @id: unique number of recovery record type
202 * @tag: identifier string specifying the location of initiation
203 * @scsi_id: scsi device id
204 * @scsi_lun: scsi device logical unit number
205 * @scsi_result: scsi result
206 * @scsi_retries: current retry number of scsi request
207 * @scsi_allowed: allowed retries
208 * @fcp_rsp_info: FCP response info
209 * @scsi_opcode: scsi opcode
210 * @fsf_req_id: request id of fsf request
211 * @host_scribble: LLD specific data attached to SCSI request
212 * @pl_len: length of paload stored as zfcp_dbf_pay
213 * @fsf_rsp: response for fsf request
215 struct zfcp_dbf_scsi {
217 char tag[ZFCP_DBF_TAG_LEN];
224 #define ZFCP_DBF_SCSI_OPCODE 16
225 u8 scsi_opcode[ZFCP_DBF_SCSI_OPCODE];
229 struct fcp_resp_with_ext fcp_rsp;
233 * struct zfcp_dbf_pay - trace record for unformatted payload information
234 * @area: area this record is originated from
235 * @counter: ascending record number
236 * @fsf_req_id: request id of fsf request
237 * @data: unformatted data
239 struct zfcp_dbf_pay {
241 char area[ZFCP_DBF_TAG_LEN];
243 #define ZFCP_DBF_PAY_MAX_REC 0x100
244 char data[ZFCP_DBF_PAY_MAX_REC];
248 * struct zfcp_dbf - main dbf trace structure
249 * @pay: reference to payload trace area
250 * @rec: reference to recovery trace area
251 * @hba: reference to hba trace area
252 * @san: reference to san trace area
253 * @scsi: reference to scsi trace area
254 * @pay_lock: lock protecting payload trace buffer
255 * @rec_lock: lock protecting recovery trace buffer
256 * @hba_lock: lock protecting hba trace buffer
257 * @san_lock: lock protecting san trace buffer
258 * @scsi_lock: lock protecting scsi trace buffer
259 * @pay_buf: pre-allocated buffer for payload
260 * @rec_buf: pre-allocated buffer for recovery
261 * @hba_buf: pre-allocated buffer for hba
262 * @san_buf: pre-allocated buffer for san
263 * @scsi_buf: pre-allocated buffer for scsi
275 spinlock_t scsi_lock;
276 struct zfcp_dbf_pay pay_buf;
277 struct zfcp_dbf_rec rec_buf;
278 struct zfcp_dbf_hba hba_buf;
279 struct zfcp_dbf_san san_buf;
280 struct zfcp_dbf_scsi scsi_buf;
284 void zfcp_dbf_hba_fsf_resp(char *tag, int level, struct zfcp_fsf_req *req)
286 if (debug_level_enabled(req->adapter->dbf->hba, level))
287 zfcp_dbf_hba_fsf_res(tag, req);
291 * zfcp_dbf_hba_fsf_response - trace event for request completion
292 * @req: request that has been completed
295 void zfcp_dbf_hba_fsf_response(struct zfcp_fsf_req *req)
297 struct fsf_qtcb *qtcb = req->qtcb;
299 if ((qtcb->prefix.prot_status != FSF_PROT_GOOD) &&
300 (qtcb->prefix.prot_status != FSF_PROT_FSF_STATUS_PRESENTED)) {
301 zfcp_dbf_hba_fsf_resp("fs_perr", 1, req);
303 } else if (qtcb->header.fsf_status != FSF_GOOD) {
304 zfcp_dbf_hba_fsf_resp("fs_ferr", 1, req);
306 } else if ((req->fsf_command == FSF_QTCB_OPEN_PORT_WITH_DID) ||
307 (req->fsf_command == FSF_QTCB_OPEN_LUN)) {
308 zfcp_dbf_hba_fsf_resp("fs_open", 4, req);
310 } else if (qtcb->header.log_length) {
311 zfcp_dbf_hba_fsf_resp("fs_qtcb", 5, req);
314 zfcp_dbf_hba_fsf_resp("fs_norm", 6, req);
319 void _zfcp_dbf_scsi(char *tag, int level, struct scsi_cmnd *scmd,
320 struct zfcp_fsf_req *req)
322 struct zfcp_adapter *adapter = (struct zfcp_adapter *)
323 scmd->device->host->hostdata[0];
325 if (debug_level_enabled(adapter->dbf->scsi, level))
326 zfcp_dbf_scsi(tag, scmd, req);
330 * zfcp_dbf_scsi_result - trace event for SCSI command completion
331 * @scmd: SCSI command pointer
332 * @req: FSF request used to issue SCSI command
335 void zfcp_dbf_scsi_result(struct scsi_cmnd *scmd, struct zfcp_fsf_req *req)
337 if (scmd->result != 0)
338 _zfcp_dbf_scsi("rsl_err", 3, scmd, req);
339 else if (scmd->retries > 0)
340 _zfcp_dbf_scsi("rsl_ret", 4, scmd, req);
342 _zfcp_dbf_scsi("rsl_nor", 6, scmd, req);
346 * zfcp_dbf_scsi_fail_send - trace event for failure to send SCSI command
347 * @scmd: SCSI command pointer
350 void zfcp_dbf_scsi_fail_send(struct scsi_cmnd *scmd)
352 _zfcp_dbf_scsi("rsl_fai", 4, scmd, NULL);
356 * zfcp_dbf_scsi_abort - trace event for SCSI command abort
357 * @tag: tag indicating success or failure of abort operation
358 * @scmd: SCSI command to be aborted
359 * @fsf_req: request containing abort (might be NULL)
362 void zfcp_dbf_scsi_abort(char *tag, struct scsi_cmnd *scmd,
363 struct zfcp_fsf_req *fsf_req)
365 _zfcp_dbf_scsi(tag, 1, scmd, fsf_req);
369 * zfcp_dbf_scsi_devreset - trace event for Logical Unit or Target Reset
370 * @tag: tag indicating success or failure of reset operation
371 * @scmnd: SCSI command which caused this error recovery
372 * @flag: indicates type of reset (Target Reset, Logical Unit Reset)
375 void zfcp_dbf_scsi_devreset(char *tag, struct scsi_cmnd *scmnd, u8 flag)
377 char tmp_tag[ZFCP_DBF_TAG_LEN];
379 if (flag == FCP_TMF_TGT_RESET)
380 memcpy(tmp_tag, "tr_", 3);
382 memcpy(tmp_tag, "lr_", 3);
384 memcpy(&tmp_tag[3], tag, 4);
385 _zfcp_dbf_scsi(tmp_tag, 1, scmnd, NULL);
388 #endif /* ZFCP_DBF_H */