4 * Debug traces for zfcp.
6 * Copyright IBM Corp. 2002, 2015
9 #define KMSG_COMPONENT "zfcp"
10 #define pr_fmt(fmt) KMSG_COMPONENT ": " fmt
12 #include <linux/module.h>
13 #include <linux/ctype.h>
14 #include <linux/slab.h>
15 #include <asm/debug.h>
20 static u32 dbfsize = 4;
22 module_param(dbfsize, uint, 0400);
23 MODULE_PARM_DESC(dbfsize,
24 "number of pages for each debug feature area (default 4)");
26 static inline unsigned int zfcp_dbf_plen(unsigned int offset)
28 return sizeof(struct zfcp_dbf_pay) + offset - ZFCP_DBF_PAY_MAX_REC;
32 void zfcp_dbf_pl_write(struct zfcp_dbf *dbf, void *data, u16 length, char *area,
35 struct zfcp_dbf_pay *pl = &dbf->pay_buf;
36 u16 offset = 0, rec_length;
38 spin_lock(&dbf->pay_lock);
39 memset(pl, 0, sizeof(*pl));
40 pl->fsf_req_id = req_id;
41 memcpy(pl->area, area, ZFCP_DBF_TAG_LEN);
43 while (offset < length) {
44 rec_length = min((u16) ZFCP_DBF_PAY_MAX_REC,
45 (u16) (length - offset));
46 memcpy(pl->data, data + offset, rec_length);
47 debug_event(dbf->pay, 1, pl, zfcp_dbf_plen(rec_length));
53 spin_unlock(&dbf->pay_lock);
57 * zfcp_dbf_hba_fsf_res - trace event for fsf responses
58 * @tag: tag indicating which kind of unsolicited status has been received
59 * @req: request for which a response was received
61 void zfcp_dbf_hba_fsf_res(char *tag, int level, struct zfcp_fsf_req *req)
63 struct zfcp_dbf *dbf = req->adapter->dbf;
64 struct fsf_qtcb_prefix *q_pref = &req->qtcb->prefix;
65 struct fsf_qtcb_header *q_head = &req->qtcb->header;
66 struct zfcp_dbf_hba *rec = &dbf->hba_buf;
69 spin_lock_irqsave(&dbf->hba_lock, flags);
70 memset(rec, 0, sizeof(*rec));
72 memcpy(rec->tag, tag, ZFCP_DBF_TAG_LEN);
73 rec->id = ZFCP_DBF_HBA_RES;
74 rec->fsf_req_id = req->req_id;
75 rec->fsf_req_status = req->status;
76 rec->fsf_cmd = req->fsf_command;
77 rec->fsf_seq_no = req->seq_no;
78 rec->u.res.req_issued = req->issued;
79 rec->u.res.prot_status = q_pref->prot_status;
80 rec->u.res.fsf_status = q_head->fsf_status;
81 rec->u.res.port_handle = q_head->port_handle;
82 rec->u.res.lun_handle = q_head->lun_handle;
84 memcpy(rec->u.res.prot_status_qual, &q_pref->prot_status_qual,
85 FSF_PROT_STATUS_QUAL_SIZE);
86 memcpy(rec->u.res.fsf_status_qual, &q_head->fsf_status_qual,
87 FSF_STATUS_QUALIFIER_SIZE);
89 if (req->fsf_command != FSF_QTCB_FCP_CMND) {
90 rec->pl_len = q_head->log_length;
91 zfcp_dbf_pl_write(dbf, (char *)q_pref + q_head->log_start,
92 rec->pl_len, "fsf_res", req->req_id);
95 debug_event(dbf->hba, level, rec, sizeof(*rec));
96 spin_unlock_irqrestore(&dbf->hba_lock, flags);
100 * zfcp_dbf_hba_fsf_uss - trace event for an unsolicited status buffer
101 * @tag: tag indicating which kind of unsolicited status has been received
102 * @req: request providing the unsolicited status
104 void zfcp_dbf_hba_fsf_uss(char *tag, struct zfcp_fsf_req *req)
106 struct zfcp_dbf *dbf = req->adapter->dbf;
107 struct fsf_status_read_buffer *srb = req->data;
108 struct zfcp_dbf_hba *rec = &dbf->hba_buf;
111 spin_lock_irqsave(&dbf->hba_lock, flags);
112 memset(rec, 0, sizeof(*rec));
114 memcpy(rec->tag, tag, ZFCP_DBF_TAG_LEN);
115 rec->id = ZFCP_DBF_HBA_USS;
116 rec->fsf_req_id = req->req_id;
117 rec->fsf_req_status = req->status;
118 rec->fsf_cmd = req->fsf_command;
123 rec->u.uss.status_type = srb->status_type;
124 rec->u.uss.status_subtype = srb->status_subtype;
125 rec->u.uss.d_id = ntoh24(srb->d_id);
126 rec->u.uss.lun = srb->fcp_lun;
127 memcpy(&rec->u.uss.queue_designator, &srb->queue_designator,
128 sizeof(rec->u.uss.queue_designator));
130 /* status read buffer payload length */
131 rec->pl_len = (!srb->length) ? 0 : srb->length -
132 offsetof(struct fsf_status_read_buffer, payload);
135 zfcp_dbf_pl_write(dbf, srb->payload.data, rec->pl_len,
136 "fsf_uss", req->req_id);
138 debug_event(dbf->hba, 2, rec, sizeof(*rec));
139 spin_unlock_irqrestore(&dbf->hba_lock, flags);
143 * zfcp_dbf_hba_bit_err - trace event for bit error conditions
144 * @tag: tag indicating which kind of unsolicited status has been received
145 * @req: request which caused the bit_error condition
147 void zfcp_dbf_hba_bit_err(char *tag, struct zfcp_fsf_req *req)
149 struct zfcp_dbf *dbf = req->adapter->dbf;
150 struct zfcp_dbf_hba *rec = &dbf->hba_buf;
151 struct fsf_status_read_buffer *sr_buf = req->data;
154 spin_lock_irqsave(&dbf->hba_lock, flags);
155 memset(rec, 0, sizeof(*rec));
157 memcpy(rec->tag, tag, ZFCP_DBF_TAG_LEN);
158 rec->id = ZFCP_DBF_HBA_BIT;
159 rec->fsf_req_id = req->req_id;
160 rec->fsf_req_status = req->status;
161 rec->fsf_cmd = req->fsf_command;
162 memcpy(&rec->u.be, &sr_buf->payload.bit_error,
163 sizeof(struct fsf_bit_error_payload));
165 debug_event(dbf->hba, 1, rec, sizeof(*rec));
166 spin_unlock_irqrestore(&dbf->hba_lock, flags);
170 * zfcp_dbf_hba_def_err - trace event for deferred error messages
171 * @adapter: pointer to struct zfcp_adapter
172 * @req_id: request id which caused the deferred error message
173 * @scount: number of sbals incl. the signaling sbal
174 * @pl: array of all involved sbals
176 void zfcp_dbf_hba_def_err(struct zfcp_adapter *adapter, u64 req_id, u16 scount,
179 struct zfcp_dbf *dbf = adapter->dbf;
180 struct zfcp_dbf_pay *payload = &dbf->pay_buf;
187 spin_lock_irqsave(&dbf->pay_lock, flags);
188 memset(payload, 0, sizeof(*payload));
190 memcpy(payload->area, "def_err", 7);
191 payload->fsf_req_id = req_id;
192 payload->counter = 0;
193 length = min((u16)sizeof(struct qdio_buffer),
194 (u16)ZFCP_DBF_PAY_MAX_REC);
196 while (payload->counter < scount && (char *)pl[payload->counter]) {
197 memcpy(payload->data, (char *)pl[payload->counter], length);
198 debug_event(dbf->pay, 1, payload, zfcp_dbf_plen(length));
202 spin_unlock_irqrestore(&dbf->pay_lock, flags);
206 * zfcp_dbf_hba_basic - trace event for basic adapter events
207 * @adapter: pointer to struct zfcp_adapter
209 void zfcp_dbf_hba_basic(char *tag, struct zfcp_adapter *adapter)
211 struct zfcp_dbf *dbf = adapter->dbf;
212 struct zfcp_dbf_hba *rec = &dbf->hba_buf;
215 spin_lock_irqsave(&dbf->hba_lock, flags);
216 memset(rec, 0, sizeof(*rec));
218 memcpy(rec->tag, tag, ZFCP_DBF_TAG_LEN);
219 rec->id = ZFCP_DBF_HBA_BASIC;
221 debug_event(dbf->hba, 1, rec, sizeof(*rec));
222 spin_unlock_irqrestore(&dbf->hba_lock, flags);
225 static void zfcp_dbf_set_common(struct zfcp_dbf_rec *rec,
226 struct zfcp_adapter *adapter,
227 struct zfcp_port *port,
228 struct scsi_device *sdev)
230 rec->adapter_status = atomic_read(&adapter->status);
232 rec->port_status = atomic_read(&port->status);
233 rec->wwpn = port->wwpn;
234 rec->d_id = port->d_id;
237 rec->lun_status = atomic_read(&sdev_to_zfcp(sdev)->status);
238 rec->lun = zfcp_scsi_dev_lun(sdev);
240 rec->lun = ZFCP_DBF_INVALID_LUN;
244 * zfcp_dbf_rec_trig - trace event related to triggered recovery
245 * @tag: identifier for event
246 * @adapter: adapter on which the erp_action should run
247 * @port: remote port involved in the erp_action
248 * @sdev: scsi device involved in the erp_action
249 * @want: wanted erp_action
250 * @need: required erp_action
252 * The adapter->erp_lock has to be held.
254 void zfcp_dbf_rec_trig(char *tag, struct zfcp_adapter *adapter,
255 struct zfcp_port *port, struct scsi_device *sdev,
258 struct zfcp_dbf *dbf = adapter->dbf;
259 struct zfcp_dbf_rec *rec = &dbf->rec_buf;
260 struct list_head *entry;
263 spin_lock_irqsave(&dbf->rec_lock, flags);
264 memset(rec, 0, sizeof(*rec));
266 rec->id = ZFCP_DBF_REC_TRIG;
267 memcpy(rec->tag, tag, ZFCP_DBF_TAG_LEN);
268 zfcp_dbf_set_common(rec, adapter, port, sdev);
270 list_for_each(entry, &adapter->erp_ready_head)
273 list_for_each(entry, &adapter->erp_running_head)
274 rec->u.trig.running++;
276 rec->u.trig.want = want;
277 rec->u.trig.need = need;
279 debug_event(dbf->rec, 1, rec, sizeof(*rec));
280 spin_unlock_irqrestore(&dbf->rec_lock, flags);
285 * zfcp_dbf_rec_run - trace event related to running recovery
286 * @tag: identifier for event
287 * @erp: erp_action running
289 void zfcp_dbf_rec_run(char *tag, struct zfcp_erp_action *erp)
291 struct zfcp_dbf *dbf = erp->adapter->dbf;
292 struct zfcp_dbf_rec *rec = &dbf->rec_buf;
295 spin_lock_irqsave(&dbf->rec_lock, flags);
296 memset(rec, 0, sizeof(*rec));
298 rec->id = ZFCP_DBF_REC_RUN;
299 memcpy(rec->tag, tag, ZFCP_DBF_TAG_LEN);
300 zfcp_dbf_set_common(rec, erp->adapter, erp->port, erp->sdev);
302 rec->u.run.fsf_req_id = erp->fsf_req_id;
303 rec->u.run.rec_status = erp->status;
304 rec->u.run.rec_step = erp->step;
305 rec->u.run.rec_action = erp->action;
308 rec->u.run.rec_count =
309 atomic_read(&sdev_to_zfcp(erp->sdev)->erp_counter);
311 rec->u.run.rec_count = atomic_read(&erp->port->erp_counter);
313 rec->u.run.rec_count = atomic_read(&erp->adapter->erp_counter);
315 debug_event(dbf->rec, 1, rec, sizeof(*rec));
316 spin_unlock_irqrestore(&dbf->rec_lock, flags);
320 * zfcp_dbf_rec_run_wka - trace wka port event with info like running recovery
321 * @tag: identifier for event
322 * @wka_port: well known address port
323 * @req_id: request ID to correlate with potential HBA trace record
325 void zfcp_dbf_rec_run_wka(char *tag, struct zfcp_fc_wka_port *wka_port,
328 struct zfcp_dbf *dbf = wka_port->adapter->dbf;
329 struct zfcp_dbf_rec *rec = &dbf->rec_buf;
332 spin_lock_irqsave(&dbf->rec_lock, flags);
333 memset(rec, 0, sizeof(*rec));
335 rec->id = ZFCP_DBF_REC_RUN;
336 memcpy(rec->tag, tag, ZFCP_DBF_TAG_LEN);
337 rec->port_status = wka_port->status;
338 rec->d_id = wka_port->d_id;
339 rec->lun = ZFCP_DBF_INVALID_LUN;
341 rec->u.run.fsf_req_id = req_id;
342 rec->u.run.rec_status = ~0;
343 rec->u.run.rec_step = ~0;
344 rec->u.run.rec_action = ~0;
345 rec->u.run.rec_count = ~0;
347 debug_event(dbf->rec, 1, rec, sizeof(*rec));
348 spin_unlock_irqrestore(&dbf->rec_lock, flags);
352 void zfcp_dbf_san(char *tag, struct zfcp_dbf *dbf, void *data, u8 id, u16 len,
353 u64 req_id, u32 d_id)
355 struct zfcp_dbf_san *rec = &dbf->san_buf;
359 spin_lock_irqsave(&dbf->san_lock, flags);
360 memset(rec, 0, sizeof(*rec));
363 rec->fsf_req_id = req_id;
365 rec_len = min(len, (u16)ZFCP_DBF_SAN_MAX_PAYLOAD);
366 memcpy(rec->payload, data, rec_len);
367 memcpy(rec->tag, tag, ZFCP_DBF_TAG_LEN);
369 debug_event(dbf->san, 1, rec, sizeof(*rec));
370 spin_unlock_irqrestore(&dbf->san_lock, flags);
374 * zfcp_dbf_san_req - trace event for issued SAN request
375 * @tag: indentifier for event
376 * @fsf_req: request containing issued CT data
377 * d_id: destination ID
379 void zfcp_dbf_san_req(char *tag, struct zfcp_fsf_req *fsf, u32 d_id)
381 struct zfcp_dbf *dbf = fsf->adapter->dbf;
382 struct zfcp_fsf_ct_els *ct_els = fsf->data;
385 length = (u16)(ct_els->req->length);
386 zfcp_dbf_san(tag, dbf, sg_virt(ct_els->req), ZFCP_DBF_SAN_REQ, length,
391 * zfcp_dbf_san_res - trace event for received SAN request
392 * @tag: indentifier for event
393 * @fsf_req: request containing issued CT data
395 void zfcp_dbf_san_res(char *tag, struct zfcp_fsf_req *fsf)
397 struct zfcp_dbf *dbf = fsf->adapter->dbf;
398 struct zfcp_fsf_ct_els *ct_els = fsf->data;
401 length = (u16)(ct_els->resp->length);
402 zfcp_dbf_san(tag, dbf, sg_virt(ct_els->resp), ZFCP_DBF_SAN_RES, length,
403 fsf->req_id, ct_els->d_id);
407 * zfcp_dbf_san_in_els - trace event for incoming ELS
408 * @tag: indentifier for event
409 * @fsf_req: request containing issued CT data
411 void zfcp_dbf_san_in_els(char *tag, struct zfcp_fsf_req *fsf)
413 struct zfcp_dbf *dbf = fsf->adapter->dbf;
414 struct fsf_status_read_buffer *srb =
415 (struct fsf_status_read_buffer *) fsf->data;
418 length = (u16)(srb->length -
419 offsetof(struct fsf_status_read_buffer, payload));
420 zfcp_dbf_san(tag, dbf, srb->payload.data, ZFCP_DBF_SAN_ELS, length,
421 fsf->req_id, ntoh24(srb->d_id));
425 * zfcp_dbf_scsi - trace event for scsi commands
426 * @tag: identifier for event
427 * @sc: pointer to struct scsi_cmnd
428 * @fsf: pointer to struct zfcp_fsf_req
430 void zfcp_dbf_scsi(char *tag, int level, struct scsi_cmnd *sc,
431 struct zfcp_fsf_req *fsf)
433 struct zfcp_adapter *adapter =
434 (struct zfcp_adapter *) sc->device->host->hostdata[0];
435 struct zfcp_dbf *dbf = adapter->dbf;
436 struct zfcp_dbf_scsi *rec = &dbf->scsi_buf;
437 struct fcp_resp_with_ext *fcp_rsp;
438 struct fcp_resp_rsp_info *fcp_rsp_info;
441 spin_lock_irqsave(&dbf->scsi_lock, flags);
442 memset(rec, 0, sizeof(*rec));
444 memcpy(rec->tag, tag, ZFCP_DBF_TAG_LEN);
445 rec->id = ZFCP_DBF_SCSI_CMND;
446 rec->scsi_result = sc->result;
447 rec->scsi_retries = sc->retries;
448 rec->scsi_allowed = sc->allowed;
449 rec->scsi_id = sc->device->id;
450 rec->scsi_lun = sc->device->lun;
451 rec->host_scribble = (unsigned long)sc->host_scribble;
453 memcpy(rec->scsi_opcode, sc->cmnd,
454 min((int)sc->cmd_len, ZFCP_DBF_SCSI_OPCODE));
457 rec->fsf_req_id = fsf->req_id;
458 fcp_rsp = (struct fcp_resp_with_ext *)
459 &(fsf->qtcb->bottom.io.fcp_rsp);
460 memcpy(&rec->fcp_rsp, fcp_rsp, FCP_RESP_WITH_EXT);
461 if (fcp_rsp->resp.fr_flags & FCP_RSP_LEN_VAL) {
462 fcp_rsp_info = (struct fcp_resp_rsp_info *) &fcp_rsp[1];
463 rec->fcp_rsp_info = fcp_rsp_info->rsp_code;
465 if (fcp_rsp->resp.fr_flags & FCP_SNS_LEN_VAL) {
466 rec->pl_len = min((u16)SCSI_SENSE_BUFFERSIZE,
467 (u16)ZFCP_DBF_PAY_MAX_REC);
468 zfcp_dbf_pl_write(dbf, sc->sense_buffer, rec->pl_len,
469 "fcp_sns", fsf->req_id);
473 debug_event(dbf->scsi, level, rec, sizeof(*rec));
474 spin_unlock_irqrestore(&dbf->scsi_lock, flags);
477 static debug_info_t *zfcp_dbf_reg(const char *name, int size, int rec_size)
479 struct debug_info *d;
481 d = debug_register(name, size, 1, rec_size);
485 debug_register_view(d, &debug_hex_ascii_view);
486 debug_set_level(d, 3);
491 static void zfcp_dbf_unregister(struct zfcp_dbf *dbf)
496 debug_unregister(dbf->scsi);
497 debug_unregister(dbf->san);
498 debug_unregister(dbf->hba);
499 debug_unregister(dbf->pay);
500 debug_unregister(dbf->rec);
505 * zfcp_adapter_debug_register - registers debug feature for an adapter
506 * @adapter: pointer to adapter for which debug features should be registered
507 * return: -ENOMEM on error, 0 otherwise
509 int zfcp_dbf_adapter_register(struct zfcp_adapter *adapter)
511 char name[DEBUG_MAX_NAME_LEN];
512 struct zfcp_dbf *dbf;
514 dbf = kzalloc(sizeof(struct zfcp_dbf), GFP_KERNEL);
518 spin_lock_init(&dbf->pay_lock);
519 spin_lock_init(&dbf->hba_lock);
520 spin_lock_init(&dbf->san_lock);
521 spin_lock_init(&dbf->scsi_lock);
522 spin_lock_init(&dbf->rec_lock);
524 /* debug feature area which records recovery activity */
525 sprintf(name, "zfcp_%s_rec", dev_name(&adapter->ccw_device->dev));
526 dbf->rec = zfcp_dbf_reg(name, dbfsize, sizeof(struct zfcp_dbf_rec));
530 /* debug feature area which records HBA (FSF and QDIO) conditions */
531 sprintf(name, "zfcp_%s_hba", dev_name(&adapter->ccw_device->dev));
532 dbf->hba = zfcp_dbf_reg(name, dbfsize, sizeof(struct zfcp_dbf_hba));
536 /* debug feature area which records payload info */
537 sprintf(name, "zfcp_%s_pay", dev_name(&adapter->ccw_device->dev));
538 dbf->pay = zfcp_dbf_reg(name, dbfsize * 2, sizeof(struct zfcp_dbf_pay));
542 /* debug feature area which records SAN command failures and recovery */
543 sprintf(name, "zfcp_%s_san", dev_name(&adapter->ccw_device->dev));
544 dbf->san = zfcp_dbf_reg(name, dbfsize, sizeof(struct zfcp_dbf_san));
548 /* debug feature area which records SCSI command failures and recovery */
549 sprintf(name, "zfcp_%s_scsi", dev_name(&adapter->ccw_device->dev));
550 dbf->scsi = zfcp_dbf_reg(name, dbfsize, sizeof(struct zfcp_dbf_scsi));
558 zfcp_dbf_unregister(dbf);
563 * zfcp_adapter_debug_unregister - unregisters debug feature for an adapter
564 * @adapter: pointer to adapter for which debug features should be unregistered
566 void zfcp_dbf_adapter_unregister(struct zfcp_adapter *adapter)
568 struct zfcp_dbf *dbf = adapter->dbf;
571 zfcp_dbf_unregister(dbf);