3 * debug feature declarations
5 * Copyright IBM Corp. 2008, 2010
11 #include <scsi/fc/fc_fcp.h>
16 #define ZFCP_DBF_TAG_LEN 7
18 #define ZFCP_DBF_INVALID_LUN 0xFFFFFFFFFFFFFFFFull
21 * struct zfcp_dbf_rec_trigger - trace record for triggered recovery action
22 * @ready: number of ready recovery actions
23 * @running: number of running recovery actions
24 * @want: wanted recovery action
25 * @need: needed recovery action
27 struct zfcp_dbf_rec_trigger
{
35 * struct zfcp_dbf_rec_running - trace record for running recovery
36 * @fsf_req_id: request id for fsf requests
37 * @rec_status: status of the fsf request
38 * @rec_step: current step of the recovery action
39 * rec_count: recovery counter
41 struct zfcp_dbf_rec_running
{
50 * enum zfcp_dbf_rec_id - recovery trace record id
51 * @ZFCP_DBF_REC_TRIG: triggered recovery identifier
52 * @ZFCP_DBF_REC_RUN: running recovery identifier
54 enum zfcp_dbf_rec_id
{
55 ZFCP_DBF_REC_TRIG
= 1,
60 * struct zfcp_dbf_rec - trace record for error recovery actions
61 * @id: unique number of recovery record type
62 * @tag: identifier string specifying the location of initiation
63 * @lun: logical unit number
64 * @wwpn: word wide port number
65 * @d_id: destination ID
66 * @adapter_status: current status of the adapter
67 * @port_status: current status of the port
68 * @lun_status: current status of the lun
69 * @u.trig: structure zfcp_dbf_rec_trigger
70 * @u.run: structure zfcp_dbf_rec_running
74 char tag
[ZFCP_DBF_TAG_LEN
];
82 struct zfcp_dbf_rec_trigger trig
;
83 struct zfcp_dbf_rec_running run
;
88 * enum zfcp_dbf_san_id - SAN trace record identifier
89 * @ZFCP_DBF_SAN_REQ: request trace record id
90 * @ZFCP_DBF_SAN_RES: response trace record id
91 * @ZFCP_DBF_SAN_ELS: extended link service record id
93 enum zfcp_dbf_san_id
{
99 /** struct zfcp_dbf_san - trace record for SAN requests and responses
100 * @id: unique number of recovery record type
101 * @tag: identifier string specifying the location of initiation
102 * @fsf_req_id: request id for fsf requests
103 * @payload: unformatted information related to request/response
104 * @d_id: destination id
106 struct zfcp_dbf_san
{
108 char tag
[ZFCP_DBF_TAG_LEN
];
111 #define ZFCP_DBF_SAN_MAX_PAYLOAD (FC_CT_HDR_LEN + 32)
112 char payload
[ZFCP_DBF_SAN_MAX_PAYLOAD
];
116 * struct zfcp_dbf_hba_res - trace record for hba responses
117 * @req_issued: timestamp when request was issued
118 * @prot_status: protocol status
119 * @prot_status_qual: protocol status qualifier
120 * @fsf_status: fsf status
121 * @fsf_status_qual: fsf status qualifier
123 struct zfcp_dbf_hba_res
{
126 u8 prot_status_qual
[FSF_PROT_STATUS_QUAL_SIZE
];
128 u8 fsf_status_qual
[FSF_STATUS_QUALIFIER_SIZE
];
132 * struct zfcp_dbf_hba_uss - trace record for unsolicited status
133 * @status_type: type of unsolicited status
134 * @status_subtype: subtype of unsolicited status
135 * @d_id: destination ID
136 * @lun: logical unit number
137 * @queue_designator: queue designator
139 struct zfcp_dbf_hba_uss
{
144 u64 queue_designator
;
148 * enum zfcp_dbf_hba_id - HBA trace record identifier
149 * @ZFCP_DBF_HBA_RES: response trace record
150 * @ZFCP_DBF_HBA_USS: unsolicited status trace record
151 * @ZFCP_DBF_HBA_BIT: bit error trace record
153 enum zfcp_dbf_hba_id
{
154 ZFCP_DBF_HBA_RES
= 1,
155 ZFCP_DBF_HBA_USS
= 2,
156 ZFCP_DBF_HBA_BIT
= 3,
160 * struct zfcp_dbf_hba - common trace record for HBA records
161 * @id: unique number of recovery record type
162 * @tag: identifier string specifying the location of initiation
163 * @fsf_req_id: request id for fsf requests
164 * @fsf_req_status: status of fsf request
165 * @fsf_cmd: fsf command
166 * @fsf_seq_no: fsf sequence number
167 * @pl_len: length of payload stored as zfcp_dbf_pay
168 * @u: record type specific data
170 struct zfcp_dbf_hba
{
172 char tag
[ZFCP_DBF_TAG_LEN
];
179 struct zfcp_dbf_hba_res res
;
180 struct zfcp_dbf_hba_uss uss
;
181 struct fsf_bit_error_payload be
;
186 * enum zfcp_dbf_scsi_id - scsi trace record identifier
187 * @ZFCP_DBF_SCSI_CMND: scsi command trace record
189 enum zfcp_dbf_scsi_id
{
190 ZFCP_DBF_SCSI_CMND
= 1,
194 * struct zfcp_dbf_scsi - common trace record for SCSI records
195 * @id: unique number of recovery record type
196 * @tag: identifier string specifying the location of initiation
197 * @scsi_id: scsi device id
198 * @scsi_lun: scsi device logical unit number
199 * @scsi_result: scsi result
200 * @scsi_retries: current retry number of scsi request
201 * @scsi_allowed: allowed retries
202 * @fcp_rsp_info: FCP response info
203 * @scsi_opcode: scsi opcode
204 * @fsf_req_id: request id of fsf request
205 * @host_scribble: LLD specific data attached to SCSI request
206 * @pl_len: length of paload stored as zfcp_dbf_pay
207 * @fsf_rsp: response for fsf request
209 struct zfcp_dbf_scsi
{
211 char tag
[ZFCP_DBF_TAG_LEN
];
218 #define ZFCP_DBF_SCSI_OPCODE 16
219 u8 scsi_opcode
[ZFCP_DBF_SCSI_OPCODE
];
223 struct fcp_resp_with_ext fcp_rsp
;
227 * struct zfcp_dbf_pay - trace record for unformatted payload information
228 * @area: area this record is originated from
229 * @counter: ascending record number
230 * @fsf_req_id: request id of fsf request
231 * @data: unformatted data
233 struct zfcp_dbf_pay
{
235 char area
[ZFCP_DBF_TAG_LEN
];
237 #define ZFCP_DBF_PAY_MAX_REC 0x100
238 char data
[ZFCP_DBF_PAY_MAX_REC
];
242 * struct zfcp_dbf - main dbf trace structure
243 * @pay: reference to payload trace area
244 * @rec: reference to recovery trace area
245 * @hba: reference to hba trace area
246 * @san: reference to san trace area
247 * @scsi: reference to scsi trace area
248 * @pay_lock: lock protecting payload trace buffer
249 * @rec_lock: lock protecting recovery trace buffer
250 * @hba_lock: lock protecting hba trace buffer
251 * @san_lock: lock protecting san trace buffer
252 * @scsi_lock: lock protecting scsi trace buffer
253 * @pay_buf: pre-allocated buffer for payload
254 * @rec_buf: pre-allocated buffer for recovery
255 * @hba_buf: pre-allocated buffer for hba
256 * @san_buf: pre-allocated buffer for san
257 * @scsi_buf: pre-allocated buffer for scsi
269 spinlock_t scsi_lock
;
270 struct zfcp_dbf_pay pay_buf
;
271 struct zfcp_dbf_rec rec_buf
;
272 struct zfcp_dbf_hba hba_buf
;
273 struct zfcp_dbf_san san_buf
;
274 struct zfcp_dbf_scsi scsi_buf
;
278 void zfcp_dbf_hba_fsf_resp(char *tag
, int level
, struct zfcp_fsf_req
*req
)
280 if (level
<= req
->adapter
->dbf
->hba
->level
)
281 zfcp_dbf_hba_fsf_res(tag
, req
);
285 * zfcp_dbf_hba_fsf_response - trace event for request completion
286 * @req: request that has been completed
289 void zfcp_dbf_hba_fsf_response(struct zfcp_fsf_req
*req
)
291 struct fsf_qtcb
*qtcb
= req
->qtcb
;
293 if ((qtcb
->prefix
.prot_status
!= FSF_PROT_GOOD
) &&
294 (qtcb
->prefix
.prot_status
!= FSF_PROT_FSF_STATUS_PRESENTED
)) {
295 zfcp_dbf_hba_fsf_resp("fs_perr", 1, req
);
297 } else if (qtcb
->header
.fsf_status
!= FSF_GOOD
) {
298 zfcp_dbf_hba_fsf_resp("fs_ferr", 1, req
);
300 } else if ((req
->fsf_command
== FSF_QTCB_OPEN_PORT_WITH_DID
) ||
301 (req
->fsf_command
== FSF_QTCB_OPEN_LUN
)) {
302 zfcp_dbf_hba_fsf_resp("fs_open", 4, req
);
304 } else if (qtcb
->header
.log_length
) {
305 zfcp_dbf_hba_fsf_resp("fs_qtcb", 5, req
);
308 zfcp_dbf_hba_fsf_resp("fs_norm", 6, req
);
313 void _zfcp_dbf_scsi(char *tag
, int level
, struct scsi_cmnd
*scmd
,
314 struct zfcp_fsf_req
*req
)
316 struct zfcp_adapter
*adapter
= (struct zfcp_adapter
*)
317 scmd
->device
->host
->hostdata
[0];
319 if (level
<= adapter
->dbf
->scsi
->level
)
320 zfcp_dbf_scsi(tag
, scmd
, req
);
324 * zfcp_dbf_scsi_result - trace event for SCSI command completion
325 * @scmd: SCSI command pointer
326 * @req: FSF request used to issue SCSI command
329 void zfcp_dbf_scsi_result(struct scsi_cmnd
*scmd
, struct zfcp_fsf_req
*req
)
331 if (scmd
->result
!= 0)
332 _zfcp_dbf_scsi("rsl_err", 3, scmd
, req
);
333 else if (scmd
->retries
> 0)
334 _zfcp_dbf_scsi("rsl_ret", 4, scmd
, req
);
336 _zfcp_dbf_scsi("rsl_nor", 6, scmd
, req
);
340 * zfcp_dbf_scsi_fail_send - trace event for failure to send SCSI command
341 * @scmd: SCSI command pointer
344 void zfcp_dbf_scsi_fail_send(struct scsi_cmnd
*scmd
)
346 _zfcp_dbf_scsi("rsl_fai", 4, scmd
, NULL
);
350 * zfcp_dbf_scsi_abort - trace event for SCSI command abort
351 * @tag: tag indicating success or failure of abort operation
352 * @scmd: SCSI command to be aborted
353 * @fsf_req: request containing abort (might be NULL)
356 void zfcp_dbf_scsi_abort(char *tag
, struct scsi_cmnd
*scmd
,
357 struct zfcp_fsf_req
*fsf_req
)
359 _zfcp_dbf_scsi(tag
, 1, scmd
, fsf_req
);
363 * zfcp_dbf_scsi_devreset - trace event for Logical Unit or Target Reset
364 * @tag: tag indicating success or failure of reset operation
365 * @scmnd: SCSI command which caused this error recovery
366 * @flag: indicates type of reset (Target Reset, Logical Unit Reset)
369 void zfcp_dbf_scsi_devreset(char *tag
, struct scsi_cmnd
*scmnd
, u8 flag
)
371 char tmp_tag
[ZFCP_DBF_TAG_LEN
];
373 if (flag
== FCP_TMF_TGT_RESET
)
374 memcpy(tmp_tag
, "tr_", 3);
376 memcpy(tmp_tag
, "lr_", 3);
378 memcpy(&tmp_tag
[3], tag
, 4);
379 _zfcp_dbf_scsi(tmp_tag
, 1, scmnd
, NULL
);
382 #endif /* ZFCP_DBF_H */