zfcp_dbf.c 13.4 KB
Newer Older
1
/*
C
Christof Schmitt 已提交
2
 * zfcp device driver
3
 *
C
Christof Schmitt 已提交
4
 * Debug traces for zfcp.
5
 *
6
 * Copyright IBM Corporation 2002, 2010
7 8
 */

9 10 11
#define KMSG_COMPONENT "zfcp"
#define pr_fmt(fmt) KMSG_COMPONENT ": " fmt

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 20 21 22 23 24

static u32 dbfsize = 4;

module_param(dbfsize, uint, 0400);
MODULE_PARM_DESC(dbfsize,
		 "number of pages for each debug feature area (default 4)");

25
static inline unsigned int zfcp_dbf_plen(unsigned int offset)
26
{
27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49
	return sizeof(struct zfcp_dbf_pay) + offset - ZFCP_DBF_PAY_MAX_REC;
}

static inline
void zfcp_dbf_pl_write(struct zfcp_dbf *dbf, void *data, u16 length, char *area,
		       u64 req_id)
{
	struct zfcp_dbf_pay *pl = &dbf->pay_buf;
	u16 offset = 0, rec_length;

	spin_lock(&dbf->pay_lock);
	memset(pl, 0, sizeof(*pl));
	pl->fsf_req_id = req_id;
	memcpy(pl->area, area, ZFCP_DBF_TAG_LEN);

	while (offset < length) {
		rec_length = min((u16) ZFCP_DBF_PAY_MAX_REC,
				 (u16) (length - offset));
		memcpy(pl->data, data + offset, rec_length);
		debug_event(dbf->pay, 1, pl, zfcp_dbf_plen(rec_length));

		offset += rec_length;
		pl->counter++;
50
	}
51 52

	spin_unlock(&dbf->pay_lock);
53 54
}

55 56 57 58 59 60
/**
 * zfcp_dbf_hba_fsf_res - trace event for fsf responses
 * @tag: tag indicating which kind of unsolicited status has been received
 * @req: request for which a response was received
 */
void zfcp_dbf_hba_fsf_res(char *tag, struct zfcp_fsf_req *req)
61
{
62 63 64 65
	struct zfcp_dbf *dbf = req->adapter->dbf;
	struct fsf_qtcb_prefix *q_pref = &req->qtcb->prefix;
	struct fsf_qtcb_header *q_head = &req->qtcb->header;
	struct zfcp_dbf_hba *rec = &dbf->hba_buf;
66 67
	unsigned long flags;

S
Swen Schillig 已提交
68
	spin_lock_irqsave(&dbf->hba_lock, flags);
69
	memset(rec, 0, sizeof(*rec));
70

71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89
	memcpy(rec->tag, tag, ZFCP_DBF_TAG_LEN);
	rec->id = ZFCP_DBF_HBA_RES;
	rec->fsf_req_id = req->req_id;
	rec->fsf_req_status = req->status;
	rec->fsf_cmd = req->fsf_command;
	rec->fsf_seq_no = req->seq_no;
	rec->u.res.req_issued = req->issued;
	rec->u.res.prot_status = q_pref->prot_status;
	rec->u.res.fsf_status = q_head->fsf_status;

	memcpy(rec->u.res.prot_status_qual, &q_pref->prot_status_qual,
	       FSF_PROT_STATUS_QUAL_SIZE);
	memcpy(rec->u.res.fsf_status_qual, &q_head->fsf_status_qual,
	       FSF_STATUS_QUALIFIER_SIZE);

	if (req->fsf_command != FSF_QTCB_FCP_CMND) {
		rec->pl_len = q_head->log_length;
		zfcp_dbf_pl_write(dbf, (char *)q_pref + q_head->log_start,
				  rec->pl_len, "fsf_res", req->req_id);
90 91
	}

92
	debug_event(dbf->hba, 1, rec, sizeof(*rec));
S
Swen Schillig 已提交
93
	spin_unlock_irqrestore(&dbf->hba_lock, flags);
94 95
}

96
/**
97 98 99
 * zfcp_dbf_hba_fsf_uss - trace event for an unsolicited status buffer
 * @tag: tag indicating which kind of unsolicited status has been received
 * @req: request providing the unsolicited status
100
 */
101
void zfcp_dbf_hba_fsf_uss(char *tag, struct zfcp_fsf_req *req)
102
{
103 104 105
	struct zfcp_dbf *dbf = req->adapter->dbf;
	struct fsf_status_read_buffer *srb = req->data;
	struct zfcp_dbf_hba *rec = &dbf->hba_buf;
106 107
	unsigned long flags;

S
Swen Schillig 已提交
108
	spin_lock_irqsave(&dbf->hba_lock, flags);
109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135
	memset(rec, 0, sizeof(*rec));

	memcpy(rec->tag, tag, ZFCP_DBF_TAG_LEN);
	rec->id = ZFCP_DBF_HBA_USS;
	rec->fsf_req_id = req->req_id;
	rec->fsf_req_status = req->status;
	rec->fsf_cmd = req->fsf_command;

	if (!srb)
		goto log;

	rec->u.uss.status_type = srb->status_type;
	rec->u.uss.status_subtype = srb->status_subtype;
	rec->u.uss.d_id = ntoh24(srb->d_id);
	rec->u.uss.lun = srb->fcp_lun;
	memcpy(&rec->u.uss.queue_designator, &srb->queue_designator,
	       sizeof(rec->u.uss.queue_designator));

	/* status read buffer payload length */
	rec->pl_len = (!srb->length) ? 0 : srb->length -
			offsetof(struct fsf_status_read_buffer, payload);

	if (rec->pl_len)
		zfcp_dbf_pl_write(dbf, srb->payload.data, rec->pl_len,
				  "fsf_uss", req->req_id);
log:
	debug_event(dbf->hba, 2, rec, sizeof(*rec));
S
Swen Schillig 已提交
136
	spin_unlock_irqrestore(&dbf->hba_lock, flags);
137 138
}

139
/**
140 141 142
 * zfcp_dbf_hba_bit_err - trace event for bit error conditions
 * @tag: tag indicating which kind of unsolicited status has been received
 * @req: request which caused the bit_error condition
143
 */
144
void zfcp_dbf_hba_bit_err(char *tag, struct zfcp_fsf_req *req)
145
{
146 147
	struct zfcp_dbf *dbf = req->adapter->dbf;
	struct zfcp_dbf_hba *rec = &dbf->hba_buf;
148 149 150
	struct fsf_status_read_buffer *sr_buf = req->data;
	unsigned long flags;

S
Swen Schillig 已提交
151
	spin_lock_irqsave(&dbf->hba_lock, flags);
152
	memset(rec, 0, sizeof(*rec));
153

154 155 156 157 158 159 160 161 162 163
	memcpy(rec->tag, tag, ZFCP_DBF_TAG_LEN);
	rec->id = ZFCP_DBF_HBA_BIT;
	rec->fsf_req_id = req->req_id;
	rec->fsf_req_status = req->status;
	rec->fsf_cmd = req->fsf_command;
	memcpy(&rec->u.be, &sr_buf->payload.bit_error,
	       sizeof(struct fsf_bit_error_payload));

	debug_event(dbf->hba, 1, rec, sizeof(*rec));
	spin_unlock_irqrestore(&dbf->hba_lock, flags);
164 165
}

166 167 168 169
static void zfcp_dbf_set_common(struct zfcp_dbf_rec *rec,
				struct zfcp_adapter *adapter,
				struct zfcp_port *port,
				struct scsi_device *sdev)
170
{
171 172 173 174 175 176 177 178 179
	rec->adapter_status = atomic_read(&adapter->status);
	if (port) {
		rec->port_status = atomic_read(&port->status);
		rec->wwpn = port->wwpn;
		rec->d_id = port->d_id;
	}
	if (sdev) {
		rec->lun_status = atomic_read(&sdev_to_zfcp(sdev)->status);
		rec->lun = zfcp_scsi_dev_lun(sdev);
180 181 182
	}
}

183
/**
184 185 186 187 188 189 190 191 192
 * zfcp_dbf_rec_trig - trace event related to triggered recovery
 * @tag: identifier for event
 * @adapter: adapter on which the erp_action should run
 * @port: remote port involved in the erp_action
 * @sdev: scsi device involved in the erp_action
 * @want: wanted erp_action
 * @need: required erp_action
 *
 * The adapter->erp_lock has to be held.
193
 */
194 195 196
void zfcp_dbf_rec_trig(char *tag, struct zfcp_adapter *adapter,
		       struct zfcp_port *port, struct scsi_device *sdev,
		       u8 want, u8 need)
197
{
198 199
	struct zfcp_dbf *dbf = adapter->dbf;
	struct zfcp_dbf_rec *rec = &dbf->rec_buf;
200
	struct list_head *entry;
201 202
	unsigned long flags;

S
Swen Schillig 已提交
203
	spin_lock_irqsave(&dbf->rec_lock, flags);
204
	memset(rec, 0, sizeof(*rec));
S
Swen Schillig 已提交
205

206 207 208
	rec->id = ZFCP_DBF_REC_TRIG;
	memcpy(rec->tag, tag, ZFCP_DBF_TAG_LEN);
	zfcp_dbf_set_common(rec, adapter, port, sdev);
209

210 211
	list_for_each(entry, &adapter->erp_ready_head)
		rec->u.trig.ready++;
212

213 214
	list_for_each(entry, &adapter->erp_running_head)
		rec->u.trig.running++;
215

216 217
	rec->u.trig.want = want;
	rec->u.trig.need = need;
218

219 220
	debug_event(dbf->rec, 1, rec, sizeof(*rec));
	spin_unlock_irqrestore(&dbf->rec_lock, flags);
221 222
}

223

224
/**
225 226 227
 * zfcp_dbf_rec_run - trace event related to running recovery
 * @tag: identifier for event
 * @erp: erp_action running
228
 */
229
void zfcp_dbf_rec_run(char *tag, struct zfcp_erp_action *erp)
230
{
231 232
	struct zfcp_dbf *dbf = erp->adapter->dbf;
	struct zfcp_dbf_rec *rec = &dbf->rec_buf;
233 234
	unsigned long flags;

S
Swen Schillig 已提交
235
	spin_lock_irqsave(&dbf->rec_lock, flags);
236
	memset(rec, 0, sizeof(*rec));
237

238 239 240
	rec->id = ZFCP_DBF_REC_RUN;
	memcpy(rec->tag, tag, ZFCP_DBF_TAG_LEN);
	zfcp_dbf_set_common(rec, erp->adapter, erp->port, erp->sdev);
241

242 243 244 245 246 247 248 249 250 251 252 253 254 255
	rec->u.run.fsf_req_id = erp->fsf_req_id;
	rec->u.run.rec_status = erp->status;
	rec->u.run.rec_step = erp->step;
	rec->u.run.rec_action = erp->action;

	if (erp->sdev)
		rec->u.run.rec_count =
			atomic_read(&sdev_to_zfcp(erp->sdev)->erp_counter);
	else if (erp->port)
		rec->u.run.rec_count = atomic_read(&erp->port->erp_counter);
	else
		rec->u.run.rec_count = atomic_read(&erp->adapter->erp_counter);

	debug_event(dbf->rec, 1, rec, sizeof(*rec));
S
Swen Schillig 已提交
256
	spin_unlock_irqrestore(&dbf->rec_lock, flags);
257 258
}

259 260 261
static inline
void zfcp_dbf_san(char *tag, struct zfcp_dbf *dbf, void *data, u8 id, u16 len,
		  u64 req_id, u32 d_id)
262
{
263 264
	struct zfcp_dbf_san *rec = &dbf->san_buf;
	u16 rec_len;
265
	unsigned long flags;
266

S
Swen Schillig 已提交
267
	spin_lock_irqsave(&dbf->san_lock, flags);
268
	memset(rec, 0, sizeof(*rec));
269

270 271 272 273 274 275
	rec->id = id;
	rec->fsf_req_id = req_id;
	rec->d_id = d_id;
	rec_len = min(len, (u16)ZFCP_DBF_SAN_MAX_PAYLOAD);
	memcpy(rec->payload, data, rec_len);
	memcpy(rec->tag, tag, ZFCP_DBF_TAG_LEN);
276

277
	debug_event(dbf->san, 1, rec, sizeof(*rec));
S
Swen Schillig 已提交
278
	spin_unlock_irqrestore(&dbf->san_lock, flags);
279 280
}

281
/**
282 283 284 285
 * zfcp_dbf_san_req - trace event for issued SAN request
 * @tag: indentifier for event
 * @fsf_req: request containing issued CT data
 * d_id: destination ID
286
 */
287
void zfcp_dbf_san_req(char *tag, struct zfcp_fsf_req *fsf, u32 d_id)
288
{
289 290 291
	struct zfcp_dbf *dbf = fsf->adapter->dbf;
	struct zfcp_fsf_ct_els *ct_els = fsf->data;
	u16 length;
292

293 294 295
	length = (u16)(ct_els->req->length + FC_CT_HDR_LEN);
	zfcp_dbf_san(tag, dbf, sg_virt(ct_els->req), ZFCP_DBF_SAN_REQ, length,
		     fsf->req_id, d_id);
296 297
}

298
/**
299 300 301
 * zfcp_dbf_san_res - trace event for received SAN request
 * @tag: indentifier for event
 * @fsf_req: request containing issued CT data
302
 */
303
void zfcp_dbf_san_res(char *tag, struct zfcp_fsf_req *fsf)
304
{
305 306 307
	struct zfcp_dbf *dbf = fsf->adapter->dbf;
	struct zfcp_fsf_ct_els *ct_els = fsf->data;
	u16 length;
308

309 310 311
	length = (u16)(ct_els->resp->length + FC_CT_HDR_LEN);
	zfcp_dbf_san(tag, dbf, sg_virt(ct_els->resp), ZFCP_DBF_SAN_RES, length,
		     fsf->req_id, 0);
312 313
}

314
/**
315 316 317
 * zfcp_dbf_san_in_els - trace event for incoming ELS
 * @tag: indentifier for event
 * @fsf_req: request containing issued CT data
318
 */
319
void zfcp_dbf_san_in_els(char *tag, struct zfcp_fsf_req *fsf)
320
{
321 322 323 324 325 326 327 328 329
	struct zfcp_dbf *dbf = fsf->adapter->dbf;
	struct fsf_status_read_buffer *srb =
		(struct fsf_status_read_buffer *) fsf->data;
	u16 length;

	length = (u16)(srb->length -
			offsetof(struct fsf_status_read_buffer, payload));
	zfcp_dbf_san(tag, dbf, srb->payload.data, ZFCP_DBF_SAN_ELS, length,
		     fsf->req_id, ntoh24(srb->d_id));
330 331
}

332 333 334 335 336 337 338
/**
 * zfcp_dbf_scsi - trace event for scsi commands
 * @tag: identifier for event
 * @sc: pointer to struct scsi_cmnd
 * @fsf: pointer to struct zfcp_fsf_req
 */
void zfcp_dbf_scsi(char *tag, struct scsi_cmnd *sc, struct zfcp_fsf_req *fsf)
339
{
340 341 342 343
	struct zfcp_adapter *adapter =
		(struct zfcp_adapter *) sc->device->host->hostdata[0];
	struct zfcp_dbf *dbf = adapter->dbf;
	struct zfcp_dbf_scsi *rec = &dbf->scsi_buf;
344
	struct fcp_resp_with_ext *fcp_rsp;
345 346
	struct fcp_resp_rsp_info *fcp_rsp_info;
	unsigned long flags;
347

S
Swen Schillig 已提交
348
	spin_lock_irqsave(&dbf->scsi_lock, flags);
349
	memset(rec, 0, sizeof(*rec));
350

351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377
	memcpy(rec->tag, tag, ZFCP_DBF_TAG_LEN);
	rec->id = ZFCP_DBF_SCSI_CMND;
	rec->scsi_result = sc->result;
	rec->scsi_retries = sc->retries;
	rec->scsi_allowed = sc->allowed;
	rec->scsi_id = sc->device->id;
	rec->scsi_lun = sc->device->lun;
	rec->host_scribble = (unsigned long)sc->host_scribble;

	memcpy(rec->scsi_opcode, sc->cmnd,
	       min((int)sc->cmd_len, ZFCP_DBF_SCSI_OPCODE));

	if (fsf) {
		rec->fsf_req_id = fsf->req_id;
		fcp_rsp = (struct fcp_resp_with_ext *)
				&(fsf->qtcb->bottom.io.fcp_rsp);
		memcpy(&rec->fcp_rsp, fcp_rsp, FCP_RESP_WITH_EXT);
		if (fcp_rsp->resp.fr_flags & FCP_RSP_LEN_VAL) {
			fcp_rsp_info = (struct fcp_resp_rsp_info *) &fcp_rsp[1];
			rec->fcp_rsp_info = fcp_rsp_info->rsp_code;
		}
		if (fcp_rsp->resp.fr_flags & FCP_SNS_LEN_VAL) {
			rec->pl_len = min((u16)SCSI_SENSE_BUFFERSIZE,
					  (u16)ZFCP_DBF_PAY_MAX_REC);
			zfcp_dbf_pl_write(dbf, sc->sense_buffer, rec->pl_len,
					  "fcp_sns", fsf->req_id);
		}
378 379
	}

380 381 382
	debug_event(adapter->dbf->scsi, 1, rec, sizeof(*rec));
	spin_unlock_irqrestore(&dbf->scsi_lock, flags);
}
383

384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399
static debug_info_t *zfcp_dbf_reg(const char *name, int level,
				  struct debug_view *view, int size)
{
	struct debug_info *d;

	d = debug_register(name, dbfsize, level, size);
	if (!d)
		return NULL;

	debug_register_view(d, &debug_hex_ascii_view);
	debug_register_view(d, view);
	debug_set_level(d, level);

	return d;
}

400 401 402 403 404
/**
 * zfcp_adapter_debug_register - registers debug feature for an adapter
 * @adapter: pointer to adapter for which debug features should be registered
 * return: -ENOMEM on error, 0 otherwise
 */
S
Swen Schillig 已提交
405
int zfcp_dbf_adapter_register(struct zfcp_adapter *adapter)
406 407
{
	char dbf_name[DEBUG_MAX_NAME_LEN];
408 409
	struct zfcp_dbf *dbf;

410
	dbf = kzalloc(sizeof(struct zfcp_dbf), GFP_KERNEL);
411 412 413
	if (!dbf)
		return -ENOMEM;

S
Swen Schillig 已提交
414 415
	dbf->adapter = adapter;

416
	spin_lock_init(&dbf->pay_lock);
S
Swen Schillig 已提交
417 418 419 420
	spin_lock_init(&dbf->hba_lock);
	spin_lock_init(&dbf->san_lock);
	spin_lock_init(&dbf->scsi_lock);
	spin_lock_init(&dbf->rec_lock);
421

422
	/* debug feature area which records recovery activity */
C
Christof Schmitt 已提交
423
	sprintf(dbf_name, "zfcp_%s_rec", dev_name(&adapter->ccw_device->dev));
424
	dbf->rec = zfcp_dbf_reg(dbf_name, 3, NULL, sizeof(struct zfcp_dbf_rec));
S
Swen Schillig 已提交
425 426
	if (!dbf->rec)
		goto err_out;
427

428
	/* debug feature area which records HBA (FSF and QDIO) conditions */
C
Christof Schmitt 已提交
429
	sprintf(dbf_name, "zfcp_%s_hba", dev_name(&adapter->ccw_device->dev));
430
	dbf->hba = zfcp_dbf_reg(dbf_name, 3, NULL, sizeof(struct zfcp_dbf_hba));
S
Swen Schillig 已提交
431 432
	if (!dbf->hba)
		goto err_out;
433

434 435 436 437 438 439 440
	/* debug feature area which records payload info */
	sprintf(dbf_name, "zfcp_%s_pay", dev_name(&adapter->ccw_device->dev));
	dbf->pay = zfcp_dbf_reg(dbf_name, 3, NULL,
				sizeof(struct zfcp_dbf_pay));
	if (!dbf->pay)
		goto err_out;

441
	/* debug feature area which records SAN command failures and recovery */
C
Christof Schmitt 已提交
442
	sprintf(dbf_name, "zfcp_%s_san", dev_name(&adapter->ccw_device->dev));
443
	dbf->san = zfcp_dbf_reg(dbf_name, 3, NULL, sizeof(struct zfcp_dbf_san));
S
Swen Schillig 已提交
444 445
	if (!dbf->san)
		goto err_out;
446 447

	/* debug feature area which records SCSI command failures and recovery */
C
Christof Schmitt 已提交
448
	sprintf(dbf_name, "zfcp_%s_scsi", dev_name(&adapter->ccw_device->dev));
449 450
	dbf->scsi = zfcp_dbf_reg(dbf_name, 3, NULL,
				 sizeof(struct zfcp_dbf_scsi));
S
Swen Schillig 已提交
451 452
	if (!dbf->scsi)
		goto err_out;
453

454
	adapter->dbf = dbf;
455 456
	return 0;

S
Swen Schillig 已提交
457 458
err_out:
	zfcp_dbf_adapter_unregister(dbf);
459 460 461 462 463
	return -ENOMEM;
}

/**
 * zfcp_adapter_debug_unregister - unregisters debug feature for an adapter
S
Swen Schillig 已提交
464
 * @dbf: pointer to dbf for which debug features should be unregistered
465
 */
S
Swen Schillig 已提交
466
void zfcp_dbf_adapter_unregister(struct zfcp_dbf *dbf)
467
{
468 469
	if (!dbf)
		return;
S
Swen Schillig 已提交
470 471 472
	debug_unregister(dbf->scsi);
	debug_unregister(dbf->san);
	debug_unregister(dbf->hba);
473
	debug_unregister(dbf->pay);
S
Swen Schillig 已提交
474 475 476
	debug_unregister(dbf->rec);
	dbf->adapter->dbf = NULL;
	kfree(dbf);
477
}
S
Swen Schillig 已提交
478