1 /*
2 * zfcp device driver
3 *
4 * Debug traces for zfcp.
5 *
6 * Copyright IBM Corporation 2002, 2010
7 */
8
9 #define KMSG_COMPONENT "zfcp"
10 #define pr_fmt(fmt) KMSG_COMPONENT ": " fmt
11
12 #include <linux/ctype.h>
13 #include <linux/slab.h>
14 #include <asm/debug.h>
15 #include "zfcp_dbf.h"
16 #include "zfcp_ext.h"
17 #include "zfcp_fc.h"
18
19 static u32 dbfsize = 4;
20
21 module_param(dbfsize, uint, 0400);
22 MODULE_PARM_DESC(dbfsize,
23 "number of pages for each debug feature area (default 4)");
24
zfcp_dbf_plen(unsigned int offset)25 static inline unsigned int zfcp_dbf_plen(unsigned int offset)
26 {
27 return sizeof(struct zfcp_dbf_pay) + offset - ZFCP_DBF_PAY_MAX_REC;
28 }
29
30 static inline
zfcp_dbf_pl_write(struct zfcp_dbf * dbf,void * data,u16 length,char * area,u64 req_id)31 void zfcp_dbf_pl_write(struct zfcp_dbf *dbf, void *data, u16 length, char *area,
32 u64 req_id)
33 {
34 struct zfcp_dbf_pay *pl = &dbf->pay_buf;
35 u16 offset = 0, rec_length;
36
37 spin_lock(&dbf->pay_lock);
38 memset(pl, 0, sizeof(*pl));
39 pl->fsf_req_id = req_id;
40 memcpy(pl->area, area, ZFCP_DBF_TAG_LEN);
41
42 while (offset < length) {
43 rec_length = min((u16) ZFCP_DBF_PAY_MAX_REC,
44 (u16) (length - offset));
45 memcpy(pl->data, data + offset, rec_length);
46 debug_event(dbf->pay, 1, pl, zfcp_dbf_plen(rec_length));
47
48 offset += rec_length;
49 pl->counter++;
50 }
51
52 spin_unlock(&dbf->pay_lock);
53 }
54
55 /**
56 * zfcp_dbf_hba_fsf_res - trace event for fsf responses
57 * @tag: tag indicating which kind of unsolicited status has been received
58 * @req: request for which a response was received
59 */
zfcp_dbf_hba_fsf_res(char * tag,struct zfcp_fsf_req * req)60 void zfcp_dbf_hba_fsf_res(char *tag, struct zfcp_fsf_req *req)
61 {
62 struct zfcp_dbf *dbf = req->adapter->dbf;
63 struct fsf_qtcb_prefix *q_pref = &req->qtcb->prefix;
64 struct fsf_qtcb_header *q_head = &req->qtcb->header;
65 struct zfcp_dbf_hba *rec = &dbf->hba_buf;
66 unsigned long flags;
67
68 spin_lock_irqsave(&dbf->hba_lock, flags);
69 memset(rec, 0, sizeof(*rec));
70
71 memcpy(rec->tag, tag, ZFCP_DBF_TAG_LEN);
72 rec->id = ZFCP_DBF_HBA_RES;
73 rec->fsf_req_id = req->req_id;
74 rec->fsf_req_status = req->status;
75 rec->fsf_cmd = req->fsf_command;
76 rec->fsf_seq_no = req->seq_no;
77 rec->u.res.req_issued = req->issued;
78 rec->u.res.prot_status = q_pref->prot_status;
79 rec->u.res.fsf_status = q_head->fsf_status;
80
81 memcpy(rec->u.res.prot_status_qual, &q_pref->prot_status_qual,
82 FSF_PROT_STATUS_QUAL_SIZE);
83 memcpy(rec->u.res.fsf_status_qual, &q_head->fsf_status_qual,
84 FSF_STATUS_QUALIFIER_SIZE);
85
86 if (req->fsf_command != FSF_QTCB_FCP_CMND) {
87 rec->pl_len = q_head->log_length;
88 zfcp_dbf_pl_write(dbf, (char *)q_pref + q_head->log_start,
89 rec->pl_len, "fsf_res", req->req_id);
90 }
91
92 debug_event(dbf->hba, 1, rec, sizeof(*rec));
93 spin_unlock_irqrestore(&dbf->hba_lock, flags);
94 }
95
96 /**
97 * zfcp_dbf_hba_fsf_uss - trace event for an unsolicited status buffer
98 * @tag: tag indicating which kind of unsolicited status has been received
99 * @req: request providing the unsolicited status
100 */
zfcp_dbf_hba_fsf_uss(char * tag,struct zfcp_fsf_req * req)101 void zfcp_dbf_hba_fsf_uss(char *tag, struct zfcp_fsf_req *req)
102 {
103 struct zfcp_dbf *dbf = req->adapter->dbf;
104 struct fsf_status_read_buffer *srb = req->data;
105 struct zfcp_dbf_hba *rec = &dbf->hba_buf;
106 unsigned long flags;
107
108 spin_lock_irqsave(&dbf->hba_lock, flags);
109 memset(rec, 0, sizeof(*rec));
110
111 memcpy(rec->tag, tag, ZFCP_DBF_TAG_LEN);
112 rec->id = ZFCP_DBF_HBA_USS;
113 rec->fsf_req_id = req->req_id;
114 rec->fsf_req_status = req->status;
115 rec->fsf_cmd = req->fsf_command;
116
117 if (!srb)
118 goto log;
119
120 rec->u.uss.status_type = srb->status_type;
121 rec->u.uss.status_subtype = srb->status_subtype;
122 rec->u.uss.d_id = ntoh24(srb->d_id);
123 rec->u.uss.lun = srb->fcp_lun;
124 memcpy(&rec->u.uss.queue_designator, &srb->queue_designator,
125 sizeof(rec->u.uss.queue_designator));
126
127 /* status read buffer payload length */
128 rec->pl_len = (!srb->length) ? 0 : srb->length -
129 offsetof(struct fsf_status_read_buffer, payload);
130
131 if (rec->pl_len)
132 zfcp_dbf_pl_write(dbf, srb->payload.data, rec->pl_len,
133 "fsf_uss", req->req_id);
134 log:
135 debug_event(dbf->hba, 2, rec, sizeof(*rec));
136 spin_unlock_irqrestore(&dbf->hba_lock, flags);
137 }
138
139 /**
140 * zfcp_dbf_hba_bit_err - trace event for bit error conditions
141 * @tag: tag indicating which kind of unsolicited status has been received
142 * @req: request which caused the bit_error condition
143 */
zfcp_dbf_hba_bit_err(char * tag,struct zfcp_fsf_req * req)144 void zfcp_dbf_hba_bit_err(char *tag, struct zfcp_fsf_req *req)
145 {
146 struct zfcp_dbf *dbf = req->adapter->dbf;
147 struct zfcp_dbf_hba *rec = &dbf->hba_buf;
148 struct fsf_status_read_buffer *sr_buf = req->data;
149 unsigned long flags;
150
151 spin_lock_irqsave(&dbf->hba_lock, flags);
152 memset(rec, 0, sizeof(*rec));
153
154 memcpy(rec->tag, tag, ZFCP_DBF_TAG_LEN);
155 rec->id = ZFCP_DBF_HBA_BIT;
156 rec->fsf_req_id = req->req_id;
157 rec->fsf_req_status = req->status;
158 rec->fsf_cmd = req->fsf_command;
159 memcpy(&rec->u.be, &sr_buf->payload.bit_error,
160 sizeof(struct fsf_bit_error_payload));
161
162 debug_event(dbf->hba, 1, rec, sizeof(*rec));
163 spin_unlock_irqrestore(&dbf->hba_lock, flags);
164 }
165
zfcp_dbf_set_common(struct zfcp_dbf_rec * rec,struct zfcp_adapter * adapter,struct zfcp_port * port,struct scsi_device * sdev)166 static void zfcp_dbf_set_common(struct zfcp_dbf_rec *rec,
167 struct zfcp_adapter *adapter,
168 struct zfcp_port *port,
169 struct scsi_device *sdev)
170 {
171 rec->adapter_status = atomic_read(&adapter->status);
172 if (port) {
173 rec->port_status = atomic_read(&port->status);
174 rec->wwpn = port->wwpn;
175 rec->d_id = port->d_id;
176 }
177 if (sdev) {
178 rec->lun_status = atomic_read(&sdev_to_zfcp(sdev)->status);
179 rec->lun = zfcp_scsi_dev_lun(sdev);
180 }
181 }
182
183 /**
184 * zfcp_dbf_rec_trig - trace event related to triggered recovery
185 * @tag: identifier for event
186 * @adapter: adapter on which the erp_action should run
187 * @port: remote port involved in the erp_action
188 * @sdev: scsi device involved in the erp_action
189 * @want: wanted erp_action
190 * @need: required erp_action
191 *
192 * The adapter->erp_lock has to be held.
193 */
zfcp_dbf_rec_trig(char * tag,struct zfcp_adapter * adapter,struct zfcp_port * port,struct scsi_device * sdev,u8 want,u8 need)194 void zfcp_dbf_rec_trig(char *tag, struct zfcp_adapter *adapter,
195 struct zfcp_port *port, struct scsi_device *sdev,
196 u8 want, u8 need)
197 {
198 struct zfcp_dbf *dbf = adapter->dbf;
199 struct zfcp_dbf_rec *rec = &dbf->rec_buf;
200 struct list_head *entry;
201 unsigned long flags;
202
203 spin_lock_irqsave(&dbf->rec_lock, flags);
204 memset(rec, 0, sizeof(*rec));
205
206 rec->id = ZFCP_DBF_REC_TRIG;
207 memcpy(rec->tag, tag, ZFCP_DBF_TAG_LEN);
208 zfcp_dbf_set_common(rec, adapter, port, sdev);
209
210 list_for_each(entry, &adapter->erp_ready_head)
211 rec->u.trig.ready++;
212
213 list_for_each(entry, &adapter->erp_running_head)
214 rec->u.trig.running++;
215
216 rec->u.trig.want = want;
217 rec->u.trig.need = need;
218
219 debug_event(dbf->rec, 1, rec, sizeof(*rec));
220 spin_unlock_irqrestore(&dbf->rec_lock, flags);
221 }
222
223
224 /**
225 * zfcp_dbf_rec_run - trace event related to running recovery
226 * @tag: identifier for event
227 * @erp: erp_action running
228 */
zfcp_dbf_rec_run(char * tag,struct zfcp_erp_action * erp)229 void zfcp_dbf_rec_run(char *tag, struct zfcp_erp_action *erp)
230 {
231 struct zfcp_dbf *dbf = erp->adapter->dbf;
232 struct zfcp_dbf_rec *rec = &dbf->rec_buf;
233 unsigned long flags;
234
235 spin_lock_irqsave(&dbf->rec_lock, flags);
236 memset(rec, 0, sizeof(*rec));
237
238 rec->id = ZFCP_DBF_REC_RUN;
239 memcpy(rec->tag, tag, ZFCP_DBF_TAG_LEN);
240 zfcp_dbf_set_common(rec, erp->adapter, erp->port, erp->sdev);
241
242 rec->u.run.fsf_req_id = erp->fsf_req_id;
243 rec->u.run.rec_status = erp->status;
244 rec->u.run.rec_step = erp->step;
245 rec->u.run.rec_action = erp->action;
246
247 if (erp->sdev)
248 rec->u.run.rec_count =
249 atomic_read(&sdev_to_zfcp(erp->sdev)->erp_counter);
250 else if (erp->port)
251 rec->u.run.rec_count = atomic_read(&erp->port->erp_counter);
252 else
253 rec->u.run.rec_count = atomic_read(&erp->adapter->erp_counter);
254
255 debug_event(dbf->rec, 1, rec, sizeof(*rec));
256 spin_unlock_irqrestore(&dbf->rec_lock, flags);
257 }
258
259 static inline
zfcp_dbf_san(char * tag,struct zfcp_dbf * dbf,void * data,u8 id,u16 len,u64 req_id,u32 d_id)260 void zfcp_dbf_san(char *tag, struct zfcp_dbf *dbf, void *data, u8 id, u16 len,
261 u64 req_id, u32 d_id)
262 {
263 struct zfcp_dbf_san *rec = &dbf->san_buf;
264 u16 rec_len;
265 unsigned long flags;
266
267 spin_lock_irqsave(&dbf->san_lock, flags);
268 memset(rec, 0, sizeof(*rec));
269
270 rec->id = id;
271 rec->fsf_req_id = req_id;
272 rec->d_id = d_id;
273 rec_len = min(len, (u16)ZFCP_DBF_SAN_MAX_PAYLOAD);
274 memcpy(rec->payload, data, rec_len);
275 memcpy(rec->tag, tag, ZFCP_DBF_TAG_LEN);
276
277 debug_event(dbf->san, 1, rec, sizeof(*rec));
278 spin_unlock_irqrestore(&dbf->san_lock, flags);
279 }
280
281 /**
282 * zfcp_dbf_san_req - trace event for issued SAN request
283 * @tag: indentifier for event
284 * @fsf_req: request containing issued CT data
285 * d_id: destination ID
286 */
zfcp_dbf_san_req(char * tag,struct zfcp_fsf_req * fsf,u32 d_id)287 void zfcp_dbf_san_req(char *tag, struct zfcp_fsf_req *fsf, u32 d_id)
288 {
289 struct zfcp_dbf *dbf = fsf->adapter->dbf;
290 struct zfcp_fsf_ct_els *ct_els = fsf->data;
291 u16 length;
292
293 length = (u16)(ct_els->req->length + FC_CT_HDR_LEN);
294 zfcp_dbf_san(tag, dbf, sg_virt(ct_els->req), ZFCP_DBF_SAN_REQ, length,
295 fsf->req_id, d_id);
296 }
297
298 /**
299 * zfcp_dbf_san_res - trace event for received SAN request
300 * @tag: indentifier for event
301 * @fsf_req: request containing issued CT data
302 */
zfcp_dbf_san_res(char * tag,struct zfcp_fsf_req * fsf)303 void zfcp_dbf_san_res(char *tag, struct zfcp_fsf_req *fsf)
304 {
305 struct zfcp_dbf *dbf = fsf->adapter->dbf;
306 struct zfcp_fsf_ct_els *ct_els = fsf->data;
307 u16 length;
308
309 length = (u16)(ct_els->resp->length + FC_CT_HDR_LEN);
310 zfcp_dbf_san(tag, dbf, sg_virt(ct_els->resp), ZFCP_DBF_SAN_RES, length,
311 fsf->req_id, 0);
312 }
313
314 /**
315 * zfcp_dbf_san_in_els - trace event for incoming ELS
316 * @tag: indentifier for event
317 * @fsf_req: request containing issued CT data
318 */
zfcp_dbf_san_in_els(char * tag,struct zfcp_fsf_req * fsf)319 void zfcp_dbf_san_in_els(char *tag, struct zfcp_fsf_req *fsf)
320 {
321 struct zfcp_dbf *dbf = fsf->adapter->dbf;
322 struct fsf_status_read_buffer *srb =
323 (struct fsf_status_read_buffer *) fsf->data;
324 u16 length;
325
326 length = (u16)(srb->length -
327 offsetof(struct fsf_status_read_buffer, payload));
328 zfcp_dbf_san(tag, dbf, srb->payload.data, ZFCP_DBF_SAN_ELS, length,
329 fsf->req_id, ntoh24(srb->d_id));
330 }
331
332 /**
333 * zfcp_dbf_scsi - trace event for scsi commands
334 * @tag: identifier for event
335 * @sc: pointer to struct scsi_cmnd
336 * @fsf: pointer to struct zfcp_fsf_req
337 */
zfcp_dbf_scsi(char * tag,struct scsi_cmnd * sc,struct zfcp_fsf_req * fsf)338 void zfcp_dbf_scsi(char *tag, struct scsi_cmnd *sc, struct zfcp_fsf_req *fsf)
339 {
340 struct zfcp_adapter *adapter =
341 (struct zfcp_adapter *) sc->device->host->hostdata[0];
342 struct zfcp_dbf *dbf = adapter->dbf;
343 struct zfcp_dbf_scsi *rec = &dbf->scsi_buf;
344 struct fcp_resp_with_ext *fcp_rsp;
345 struct fcp_resp_rsp_info *fcp_rsp_info;
346 unsigned long flags;
347
348 spin_lock_irqsave(&dbf->scsi_lock, flags);
349 memset(rec, 0, sizeof(*rec));
350
351 memcpy(rec->tag, tag, ZFCP_DBF_TAG_LEN);
352 rec->id = ZFCP_DBF_SCSI_CMND;
353 rec->scsi_result = sc->result;
354 rec->scsi_retries = sc->retries;
355 rec->scsi_allowed = sc->allowed;
356 rec->scsi_id = sc->device->id;
357 rec->scsi_lun = sc->device->lun;
358 rec->host_scribble = (unsigned long)sc->host_scribble;
359
360 memcpy(rec->scsi_opcode, sc->cmnd,
361 min((int)sc->cmd_len, ZFCP_DBF_SCSI_OPCODE));
362
363 if (fsf) {
364 rec->fsf_req_id = fsf->req_id;
365 fcp_rsp = (struct fcp_resp_with_ext *)
366 &(fsf->qtcb->bottom.io.fcp_rsp);
367 memcpy(&rec->fcp_rsp, fcp_rsp, FCP_RESP_WITH_EXT);
368 if (fcp_rsp->resp.fr_flags & FCP_RSP_LEN_VAL) {
369 fcp_rsp_info = (struct fcp_resp_rsp_info *) &fcp_rsp[1];
370 rec->fcp_rsp_info = fcp_rsp_info->rsp_code;
371 }
372 if (fcp_rsp->resp.fr_flags & FCP_SNS_LEN_VAL) {
373 rec->pl_len = min((u16)SCSI_SENSE_BUFFERSIZE,
374 (u16)ZFCP_DBF_PAY_MAX_REC);
375 zfcp_dbf_pl_write(dbf, sc->sense_buffer, rec->pl_len,
376 "fcp_sns", fsf->req_id);
377 }
378 }
379
380 debug_event(dbf->scsi, 1, rec, sizeof(*rec));
381 spin_unlock_irqrestore(&dbf->scsi_lock, flags);
382 }
383
zfcp_dbf_reg(const char * name,int size,int rec_size)384 static debug_info_t *zfcp_dbf_reg(const char *name, int size, int rec_size)
385 {
386 struct debug_info *d;
387
388 d = debug_register(name, size, 1, rec_size);
389 if (!d)
390 return NULL;
391
392 debug_register_view(d, &debug_hex_ascii_view);
393 debug_set_level(d, 3);
394
395 return d;
396 }
397
zfcp_dbf_unregister(struct zfcp_dbf * dbf)398 static void zfcp_dbf_unregister(struct zfcp_dbf *dbf)
399 {
400 if (!dbf)
401 return;
402
403 debug_unregister(dbf->scsi);
404 debug_unregister(dbf->san);
405 debug_unregister(dbf->hba);
406 debug_unregister(dbf->pay);
407 debug_unregister(dbf->rec);
408 kfree(dbf);
409 }
410
411 /**
412 * zfcp_adapter_debug_register - registers debug feature for an adapter
413 * @adapter: pointer to adapter for which debug features should be registered
414 * return: -ENOMEM on error, 0 otherwise
415 */
zfcp_dbf_adapter_register(struct zfcp_adapter * adapter)416 int zfcp_dbf_adapter_register(struct zfcp_adapter *adapter)
417 {
418 char name[DEBUG_MAX_NAME_LEN];
419 struct zfcp_dbf *dbf;
420
421 dbf = kzalloc(sizeof(struct zfcp_dbf), GFP_KERNEL);
422 if (!dbf)
423 return -ENOMEM;
424
425 spin_lock_init(&dbf->pay_lock);
426 spin_lock_init(&dbf->hba_lock);
427 spin_lock_init(&dbf->san_lock);
428 spin_lock_init(&dbf->scsi_lock);
429 spin_lock_init(&dbf->rec_lock);
430
431 /* debug feature area which records recovery activity */
432 sprintf(name, "zfcp_%s_rec", dev_name(&adapter->ccw_device->dev));
433 dbf->rec = zfcp_dbf_reg(name, dbfsize, sizeof(struct zfcp_dbf_rec));
434 if (!dbf->rec)
435 goto err_out;
436
437 /* debug feature area which records HBA (FSF and QDIO) conditions */
438 sprintf(name, "zfcp_%s_hba", dev_name(&adapter->ccw_device->dev));
439 dbf->hba = zfcp_dbf_reg(name, dbfsize, sizeof(struct zfcp_dbf_hba));
440 if (!dbf->hba)
441 goto err_out;
442
443 /* debug feature area which records payload info */
444 sprintf(name, "zfcp_%s_pay", dev_name(&adapter->ccw_device->dev));
445 dbf->pay = zfcp_dbf_reg(name, dbfsize * 2, sizeof(struct zfcp_dbf_pay));
446 if (!dbf->pay)
447 goto err_out;
448
449 /* debug feature area which records SAN command failures and recovery */
450 sprintf(name, "zfcp_%s_san", dev_name(&adapter->ccw_device->dev));
451 dbf->san = zfcp_dbf_reg(name, dbfsize, sizeof(struct zfcp_dbf_san));
452 if (!dbf->san)
453 goto err_out;
454
455 /* debug feature area which records SCSI command failures and recovery */
456 sprintf(name, "zfcp_%s_scsi", dev_name(&adapter->ccw_device->dev));
457 dbf->scsi = zfcp_dbf_reg(name, dbfsize, sizeof(struct zfcp_dbf_scsi));
458 if (!dbf->scsi)
459 goto err_out;
460
461 adapter->dbf = dbf;
462
463 return 0;
464 err_out:
465 zfcp_dbf_unregister(dbf);
466 return -ENOMEM;
467 }
468
469 /**
470 * zfcp_adapter_debug_unregister - unregisters debug feature for an adapter
471 * @adapter: pointer to adapter for which debug features should be unregistered
472 */
zfcp_dbf_adapter_unregister(struct zfcp_adapter * adapter)473 void zfcp_dbf_adapter_unregister(struct zfcp_adapter *adapter)
474 {
475 struct zfcp_dbf *dbf = adapter->dbf;
476
477 adapter->dbf = NULL;
478 zfcp_dbf_unregister(dbf);
479 }
480
481