1 /* 2 * zfcp device driver 3 * debug feature declarations 4 * 5 * Copyright IBM Corp. 2008, 2015 6 */ 7 8 #ifndef ZFCP_DBF_H 9 #define ZFCP_DBF_H 10 11 #include <scsi/fc/fc_fcp.h> 12 #include "zfcp_ext.h" 13 #include "zfcp_fsf.h" 14 #include "zfcp_def.h" 15 16 #define ZFCP_DBF_TAG_LEN 7 17 18 #define ZFCP_DBF_INVALID_LUN 0xFFFFFFFFFFFFFFFFull 19 20 enum zfcp_dbf_pseudo_erp_act_type { 21 ZFCP_PSEUDO_ERP_ACTION_RPORT_ADD = 0xff, 22 ZFCP_PSEUDO_ERP_ACTION_RPORT_DEL = 0xfe, 23 }; 24 25 /** 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 31 */ 32 struct zfcp_dbf_rec_trigger { 33 u32 ready; 34 u32 running; 35 u8 want; 36 u8 need; 37 } __packed; 38 39 /** 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 45 */ 46 struct zfcp_dbf_rec_running { 47 u64 fsf_req_id; 48 u32 rec_status; 49 u16 rec_step; 50 u8 rec_action; 51 u8 rec_count; 52 } __packed; 53 54 /** 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 58 */ 59 enum zfcp_dbf_rec_id { 60 ZFCP_DBF_REC_TRIG = 1, 61 ZFCP_DBF_REC_RUN = 2, 62 }; 63 64 /** 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 76 */ 77 struct zfcp_dbf_rec { 78 u8 id; 79 char tag[ZFCP_DBF_TAG_LEN]; 80 u64 lun; 81 u64 wwpn; 82 u32 d_id; 83 u32 adapter_status; 84 u32 port_status; 85 u32 lun_status; 86 union { 87 struct zfcp_dbf_rec_trigger trig; 88 struct zfcp_dbf_rec_running run; 89 } u; 90 } __packed; 91 92 /** 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 97 */ 98 enum zfcp_dbf_san_id { 99 ZFCP_DBF_SAN_REQ = 1, 100 ZFCP_DBF_SAN_RES = 2, 101 ZFCP_DBF_SAN_ELS = 3, 102 }; 103 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 110 */ 111 struct zfcp_dbf_san { 112 u8 id; 113 char tag[ZFCP_DBF_TAG_LEN]; 114 u64 fsf_req_id; 115 u32 d_id; 116 #define ZFCP_DBF_SAN_MAX_PAYLOAD (FC_CT_HDR_LEN + 32) 117 char payload[ZFCP_DBF_SAN_MAX_PAYLOAD]; 118 } __packed; 119 120 /** 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 127 */ 128 struct zfcp_dbf_hba_res { 129 u64 req_issued; 130 u32 prot_status; 131 u8 prot_status_qual[FSF_PROT_STATUS_QUAL_SIZE]; 132 u32 fsf_status; 133 u8 fsf_status_qual[FSF_STATUS_QUALIFIER_SIZE]; 134 } __packed; 135 136 /** 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 143 */ 144 struct zfcp_dbf_hba_uss { 145 u32 status_type; 146 u32 status_subtype; 147 u32 d_id; 148 u64 lun; 149 u64 queue_designator; 150 } __packed; 151 152 /** 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 157 */ 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, 163 }; 164 165 /** 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 175 */ 176 struct zfcp_dbf_hba { 177 u8 id; 178 char tag[ZFCP_DBF_TAG_LEN]; 179 u64 fsf_req_id; 180 u32 fsf_req_status; 181 u32 fsf_cmd; 182 u32 fsf_seq_no; 183 u16 pl_len; 184 union { 185 struct zfcp_dbf_hba_res res; 186 struct zfcp_dbf_hba_uss uss; 187 struct fsf_bit_error_payload be; 188 } u; 189 } __packed; 190 191 /** 192 * enum zfcp_dbf_scsi_id - scsi trace record identifier 193 * @ZFCP_DBF_SCSI_CMND: scsi command trace record 194 */ 195 enum zfcp_dbf_scsi_id { 196 ZFCP_DBF_SCSI_CMND = 1, 197 }; 198 199 /** 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 214 */ 215 struct zfcp_dbf_scsi { 216 u8 id; 217 char tag[ZFCP_DBF_TAG_LEN]; 218 u32 scsi_id; 219 u32 scsi_lun; 220 u32 scsi_result; 221 u8 scsi_retries; 222 u8 scsi_allowed; 223 u8 fcp_rsp_info; 224 #define ZFCP_DBF_SCSI_OPCODE 16 225 u8 scsi_opcode[ZFCP_DBF_SCSI_OPCODE]; 226 u64 fsf_req_id; 227 u64 host_scribble; 228 u16 pl_len; 229 struct fcp_resp_with_ext fcp_rsp; 230 } __packed; 231 232 /** 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 238 */ 239 struct zfcp_dbf_pay { 240 u8 counter; 241 char area[ZFCP_DBF_TAG_LEN]; 242 u64 fsf_req_id; 243 #define ZFCP_DBF_PAY_MAX_REC 0x100 244 char data[ZFCP_DBF_PAY_MAX_REC]; 245 } __packed; 246 247 /** 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 264 */ 265 struct zfcp_dbf { 266 debug_info_t *pay; 267 debug_info_t *rec; 268 debug_info_t *hba; 269 debug_info_t *san; 270 debug_info_t *scsi; 271 spinlock_t pay_lock; 272 spinlock_t rec_lock; 273 spinlock_t hba_lock; 274 spinlock_t san_lock; 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; 281 }; 282 283 static inline 284 void zfcp_dbf_hba_fsf_resp(char *tag, int level, struct zfcp_fsf_req *req) 285 { 286 if (debug_level_enabled(req->adapter->dbf->hba, level)) 287 zfcp_dbf_hba_fsf_res(tag, req); 288 } 289 290 /** 291 * zfcp_dbf_hba_fsf_response - trace event for request completion 292 * @req: request that has been completed 293 */ 294 static inline 295 void zfcp_dbf_hba_fsf_response(struct zfcp_fsf_req *req) 296 { 297 struct fsf_qtcb *qtcb = req->qtcb; 298 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); 302 303 } else if (qtcb->header.fsf_status != FSF_GOOD) { 304 zfcp_dbf_hba_fsf_resp("fs_ferr", 1, req); 305 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); 309 310 } else if (qtcb->header.log_length) { 311 zfcp_dbf_hba_fsf_resp("fs_qtcb", 5, req); 312 313 } else { 314 zfcp_dbf_hba_fsf_resp("fs_norm", 6, req); 315 } 316 } 317 318 static inline 319 void _zfcp_dbf_scsi(char *tag, int level, struct scsi_cmnd *scmd, 320 struct zfcp_fsf_req *req) 321 { 322 struct zfcp_adapter *adapter = (struct zfcp_adapter *) 323 scmd->device->host->hostdata[0]; 324 325 if (debug_level_enabled(adapter->dbf->scsi, level)) 326 zfcp_dbf_scsi(tag, scmd, req); 327 } 328 329 /** 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 333 */ 334 static inline 335 void zfcp_dbf_scsi_result(struct scsi_cmnd *scmd, struct zfcp_fsf_req *req) 336 { 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); 341 else 342 _zfcp_dbf_scsi("rsl_nor", 6, scmd, req); 343 } 344 345 /** 346 * zfcp_dbf_scsi_fail_send - trace event for failure to send SCSI command 347 * @scmd: SCSI command pointer 348 */ 349 static inline 350 void zfcp_dbf_scsi_fail_send(struct scsi_cmnd *scmd) 351 { 352 _zfcp_dbf_scsi("rsl_fai", 4, scmd, NULL); 353 } 354 355 /** 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) 360 */ 361 static inline 362 void zfcp_dbf_scsi_abort(char *tag, struct scsi_cmnd *scmd, 363 struct zfcp_fsf_req *fsf_req) 364 { 365 _zfcp_dbf_scsi(tag, 1, scmd, fsf_req); 366 } 367 368 /** 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) 373 */ 374 static inline 375 void zfcp_dbf_scsi_devreset(char *tag, struct scsi_cmnd *scmnd, u8 flag) 376 { 377 char tmp_tag[ZFCP_DBF_TAG_LEN]; 378 379 if (flag == FCP_TMF_TGT_RESET) 380 memcpy(tmp_tag, "tr_", 3); 381 else 382 memcpy(tmp_tag, "lr_", 3); 383 384 memcpy(&tmp_tag[3], tag, 4); 385 _zfcp_dbf_scsi(tmp_tag, 1, scmnd, NULL); 386 } 387 388 #endif /* ZFCP_DBF_H */ 389