History

scsi: ufs: Use __print_symbolic() for UFS trace string print

__print_symbolic() is designed for exporting the print formatting table to userspace and allows parsing tool, such as trace-cmd and perf, to analyze trace log according to this print formatting table, meanwhile, by using __print_symbolic()s, save space in the trace ring buffer. original print format: print fmt: "%s: %s: HDR:%s, CDB:%s", __get_str(str), __get_str(dev_name), __print_hex(REC->hdr, sizeof(REC->hdr)), __print_hex(REC->tsf, sizeof(REC->tsf)) after this change: print fmt: "%s: %s: HDR:%s, CDB:%s", print_symbolic(REC->str_t, {0, "send"}, {1, "complete"}, {2, "dev_complete"}, {3, "query_send"}, {4, "query_complete"}, {5, "query_complete_err"}, {6, "tm_send"}, {7, "tm_complete"}, {8, "tm_complete_err"}), __get_str(dev_name), __print_hex(REC->hdr, sizeof(REC->hdr)), __print_hex(REC->tsf, sizeof(REC->tsf)) Note: This patch just converts current __get_str(str) to __print_symbolic(), the original tracing log will not be affected by this change, so it doesn't break what current parsers expect.

Bean Huo committed 5 years ago

Commit 28fa68f1 parent c7c730a3 files · +69 −43Browse files

Unified · Split

3 files
  1. drivers/scsi/ufs/ufs.h +10 −0
  2. drivers/scsi/ufs/ufshcd.c +24 −24
  3. include/trace/events/ufs.h +35 −19
drivers/scsi/ufs/ufs.h+10−0
@@ -545,6 +545,16 @@ struct ufs_dev_info { · 544 unmodified lines
545545 u8 b_presrv_uspc_en;
546546 };
547547
548+/*
549+ * This enum is used in string mapping in include/trace/events/ufs.h.
550+ */
551+enum ufs_trace_str_t {
552+ UFS_CMD_SEND, UFS_CMD_COMP, UFS_DEV_COMP,
553+ UFS_QUERY_SEND, UFS_QUERY_COMP, UFS_QUERY_ERR,
554+ UFS_TM_SEND, UFS_TM_COMP, UFS_TM_ERR
555+};
556+
557+
548558 /**
549559 * ufs_is_valid_unit_desc_lun - checks if the given LUN has a unit descriptor
550560 * @dev_info: pointer of instance of struct ufs_dev_info
drivers/scsi/ufs/ufshcd.c+24−24
@@ -305,53 +305,53 @@ static void ufshcd_scsi_block_requests(struct ufs_hba *hba) · 304 unmodified lines
305305 }
306306
307307 static void ufshcd_add_cmd_upiu_trace(struct ufs_hba *hba, unsigned int tag,
308− const char *str)
308+ enum ufs_trace_str_t str_t)
309309 {
310310 struct utp_upiu_req *rq = hba->lrb[tag].ucd_req_ptr;
311311
312− trace_ufshcd_upiu(dev_name(hba->dev), str, &rq->header, &rq->sc.cdb);
312+ trace_ufshcd_upiu(dev_name(hba->dev), str_t, &rq->header, &rq->sc.cdb);
313313 }
314314
315315 static void ufshcd_add_query_upiu_trace(struct ufs_hba *hba, unsigned int tag,
316− const char *str)
316+ enum ufs_trace_str_t str_t)
317317 {
318318 struct utp_upiu_req *rq = hba->lrb[tag].ucd_req_ptr;
319319
320− trace_ufshcd_upiu(dev_name(hba->dev), str, &rq->header, &rq->qr);
320+ trace_ufshcd_upiu(dev_name(hba->dev), str_t, &rq->header, &rq->qr);
321321 }
322322
323323 static void ufshcd_add_tm_upiu_trace(struct ufs_hba *hba, unsigned int tag,
324− const char *str)
324+ enum ufs_trace_str_t str_t)
325325 {
326326 int off = (int)tag - hba->nutrs;
327327 struct utp_task_req_desc *descp = &hba->utmrdl_base_addr[off];
328328
329− trace_ufshcd_upiu(dev_name(hba->dev), str, &descp->req_header,
329+ trace_ufshcd_upiu(dev_name(hba->dev), str_t, &descp->req_header,
330330 &descp->input_param1);
331331 }
332332
333333 static void ufshcd_add_uic_command_trace(struct ufs_hba *hba,
334334 struct uic_command *ucmd,
335− const char *str)
335+ enum ufs_trace_str_t str_t)
336336 {
337337 u32 cmd;
338338
339339 if (!trace_ufshcd_uic_command_enabled())
340340 return;
341341
342− if (!strcmp(str, "send"))
342+ if (str_t == UFS_CMD_SEND)
343343 cmd = ucmd->command;
344344 else
345345 cmd = ufshcd_readl(hba, REG_UIC_COMMAND);
346346
347− trace_ufshcd_uic_command(dev_name(hba->dev), str, cmd,
347+ trace_ufshcd_uic_command(dev_name(hba->dev), str_t, cmd,
348348 ufshcd_readl(hba, REG_UIC_COMMAND_ARG_1),
349349 ufshcd_readl(hba, REG_UIC_COMMAND_ARG_2),
350350 ufshcd_readl(hba, REG_UIC_COMMAND_ARG_3));
351351 }
352352
353−static void ufshcd_add_command_trace(struct ufs_hba *hba,
354− unsigned int tag, const char *str)
353+static void ufshcd_add_command_trace(struct ufs_hba *hba, unsigned int tag,
354+ enum ufs_trace_str_t str_t)
355355 {
356356 sector_t lba = -1;
357357 u8 opcode = 0, group_id = 0;
@@ -363,13 +363,13 @@ static void ufshcd_add_command_trace(struct ufs_hba *hba, · 5 unmodified lines
363363 if (!trace_ufshcd_command_enabled()) {
364364 /* trace UPIU W/O tracing command */
365365 if (cmd)
366− ufshcd_add_cmd_upiu_trace(hba, tag, str);
366+ ufshcd_add_cmd_upiu_trace(hba, tag, str_t);
367367 return;
368368 }
369369
370370 if (cmd) { /* data phase exists */
371371 /* trace UPIU also */
372− ufshcd_add_cmd_upiu_trace(hba, tag, str);
372+ ufshcd_add_cmd_upiu_trace(hba, tag, str_t);
373373 opcode = cmd->cmnd[0];
374374 if ((opcode == READ_10) || (opcode == WRITE_10)) {
375375 /*
@@ -392,7 +392,7 @@ static void ufshcd_add_command_trace(struct ufs_hba *hba, · 16 unmodified lines
392392
393393 intr = ufshcd_readl(hba, REG_INTERRUPT_STATUS);
394394 doorbell = ufshcd_readl(hba, REG_UTP_TRANSFER_REQ_DOOR_BELL);
395− trace_ufshcd_command(dev_name(hba->dev), str, tag,
395+ trace_ufshcd_command(dev_name(hba->dev), str_t, tag,
396396 doorbell, transfer_len, intr, lba, opcode, group_id);
397397 }
398398
@@ -2001,7 +2001,7 @@ void ufshcd_send_command(struct ufs_hba *hba, unsigned int task_tag) · 1602 unmodified lines
20012001 lrbp->issue_time_stamp = ktime_get();
20022002 lrbp->compl_time_stamp = ktime_set(0, 0);
20032003 ufshcd_vops_setup_xfer_req(hba, task_tag, (lrbp->cmd ? true : false));
2004− ufshcd_add_command_trace(hba, task_tag, "send");
2004+ ufshcd_add_command_trace(hba, task_tag, UFS_CMD_SEND);
20052005 ufshcd_clk_scaling_start_busy(hba);
20062006 __set_bit(task_tag, &hba->outstanding_reqs);
20072007 ufshcd_writel(hba, 1 << task_tag, REG_UTP_TRANSFER_REQ_DOOR_BELL);
@@ -2137,7 +2137,7 @@ ufshcd_dispatch_uic_cmd(struct ufs_hba *hba, struct uic_command *uic_cmd) · 129 unmodified lines
21372137 ufshcd_writel(hba, uic_cmd->argument2, REG_UIC_COMMAND_ARG_2);
21382138 ufshcd_writel(hba, uic_cmd->argument3, REG_UIC_COMMAND_ARG_3);
21392139
2140− ufshcd_add_uic_command_trace(hba, uic_cmd, "send");
2140+ ufshcd_add_uic_command_trace(hba, uic_cmd, UFS_CMD_SEND);
21412141
21422142 /* Write UIC Cmd */
21432143 ufshcd_writel(hba, uic_cmd->command & COMMAND_OPCODE_MASK,
@@ -2856,7 +2856,7 @@ static int ufshcd_exec_dev_cmd(struct ufs_hba *hba, · 712 unmodified lines
28562856
28572857 hba->dev_cmd.complete = &wait;
28582858
2859− ufshcd_add_query_upiu_trace(hba, tag, "query_send");
2859+ ufshcd_add_query_upiu_trace(hba, tag, UFS_QUERY_SEND);
28602860 /* Make sure descriptors are ready before ringing the doorbell */
28612861 wmb();
28622862 spin_lock_irqsave(hba->host->host_lock, flags);
@@ -2867,7 +2867,7 @@ static int ufshcd_exec_dev_cmd(struct ufs_hba *hba, · 4 unmodified lines
28672867
28682868 out:
28692869 ufshcd_add_query_upiu_trace(hba, tag,
2870− err ? "query_complete_err" : "query_complete");
2870+ err ? UFS_QUERY_ERR : UFS_QUERY_COMP);
28712871
28722872 out_put_tag:
28732873 blk_put_request(req);
@@ -5030,7 +5030,7 @@ static irqreturn_t ufshcd_uic_cmd_compl(struct ufs_hba *hba, u32 intr_status) · 2156 unmodified lines
50305030
50315031 if (retval == IRQ_HANDLED)
50325032 ufshcd_add_uic_command_trace(hba, hba->active_uic_cmd,
5033− "complete");
5033+ UFS_CMD_COMP);
50345034 return retval;
50355035 }
50365036
@@ -5054,7 +5054,7 @@ static void __ufshcd_transfer_req_compl(struct ufs_hba *hba, · 17 unmodified lines
50545054 lrbp->compl_time_stamp = ktime_get();
50555055 cmd = lrbp->cmd;
50565056 if (cmd) {
5057− ufshcd_add_command_trace(hba, index, "complete");
5057+ ufshcd_add_command_trace(hba, index, UFS_CMD_COMP);
50585058 result = ufshcd_transfer_rsp_status(hba, lrbp);
50595059 scsi_dma_unmap(cmd);
50605060 cmd->result = result;
@@ -5068,7 +5068,7 @@ static void __ufshcd_transfer_req_compl(struct ufs_hba *hba, · 7 unmodified lines
50685068 lrbp->command_type == UTP_CMD_TYPE_UFS_STORAGE) {
50695069 if (hba->dev_cmd.complete) {
50705070 ufshcd_add_command_trace(hba, index,
5071− "dev_complete");
5071+ UFS_DEV_COMP);
50725072 complete(hba->dev_cmd.complete);
50735073 update_scaling = true;
50745074 }
@@ -6371,7 +6371,7 @@ static int __ufshcd_issue_tm_cmd(struct ufs_hba *hba, · 1296 unmodified lines
63716371
63726372 spin_unlock_irqrestore(host->host_lock, flags);
63736373
6374− ufshcd_add_tm_upiu_trace(hba, task_tag, "tm_send");
6374+ ufshcd_add_tm_upiu_trace(hba, task_tag, UFS_TM_SEND);
63756375
63766376 /* wait until the task management command is completed */
63776377 err = wait_for_completion_io_timeout(&wait,
@@ -6382,7 +6382,7 @@ static int __ufshcd_issue_tm_cmd(struct ufs_hba *hba, · 4 unmodified lines
63826382 * use-after-free.
63836383 */
63846384 req->end_io_data = NULL;
6385− ufshcd_add_tm_upiu_trace(hba, task_tag, "tm_complete_err");
6385+ ufshcd_add_tm_upiu_trace(hba, task_tag, UFS_TM_ERR);
63866386 dev_err(hba->dev, "%s: task management cmd 0x%.2x timed-out\n",
63876387 __func__, tm_function);
63886388 if (ufshcd_clear_tm_cmd(hba, free_slot))
@@ -6393,7 +6393,7 @@ static int __ufshcd_issue_tm_cmd(struct ufs_hba *hba, · 4 unmodified lines
63936393 err = 0;
63946394 memcpy(treq, hba->utmrdl_base_addr + free_slot, sizeof(*treq));
63956395
6396− ufshcd_add_tm_upiu_trace(hba, task_tag, "tm_complete");
6396+ ufshcd_add_tm_upiu_trace(hba, task_tag, UFS_TM_COMP);
63976397 }
63986398
63996399 spin_lock_irqsave(hba->host->host_lock, flags);
include/trace/events/ufs.h+35−19
@@ -37,6 +37,17 @@ · 36 unmodified lines
3737 EM(REQ_CLKS_OFF, "REQ_CLKS_OFF") \
3838 EMe(REQ_CLKS_ON, "REQ_CLKS_ON")
3939
40+#define UFS_CMD_TRACE_STRINGS \
41+ EM(UFS_CMD_SEND, "send_req") \
42+ EM(UFS_CMD_COMP, "complete_rsp") \
43+ EM(UFS_DEV_COMP, "dev_complete") \
44+ EM(UFS_QUERY_SEND, "query_send") \
45+ EM(UFS_QUERY_COMP, "query_complete") \
46+ EM(UFS_QUERY_ERR, "query_complete_err") \
47+ EM(UFS_TM_SEND, "tm_send") \
48+ EM(UFS_TM_COMP, "tm_complete") \
49+ EMe(UFS_TM_ERR, "tm_complete_err")
50+
4051 /* Enums require being exported to userspace, for user tool parsing */
4152 #undef EM
4253 #undef EMe
@@ -46,6 +57,7 @@ · 3 unmodified lines
4657 UFS_LINK_STATES;
4758 UFS_PWR_MODES;
4859 UFSCHD_CLK_GATING_STATES;
60+UFS_CMD_TRACE_STRINGS
4961
5062 /*
5163 * Now redefine the EM() and EMe() macros to map the enums to the strings
@@ -56,6 +68,9 @@ UFSCHD_CLK_GATING_STATES; · 4 unmodified lines
5668 #define EM(a, b) {a, b},
5769 #define EMe(a, b) {a, b}
5870
71+#define show_ufs_cmd_trace_str(str_t) \
72+ __print_symbolic(str_t, UFS_CMD_TRACE_STRINGS)
73+
5974 TRACE_EVENT(ufshcd_clk_gating,
6075
6176 TP_PROTO(const char *dev_name, int state),
@@ -223,16 +238,16 @@ DEFINE_EVENT(ufshcd_template, ufshcd_init, · 161 unmodified lines
223238 TP_ARGS(dev_name, err, usecs, dev_state, link_state));
224239
225240 TRACE_EVENT(ufshcd_command,
226− TP_PROTO(const char *dev_name, const char *str, unsigned int tag,
227− u32 doorbell, int transfer_len, u32 intr, u64 lba,
228− u8 opcode, u8 group_id),
241+ TP_PROTO(const char *dev_name, enum ufs_trace_str_t str_t,
242+ unsigned int tag, u32 doorbell, int transfer_len, u32 intr,
243+ u64 lba, u8 opcode, u8 group_id),
229244
230− TP_ARGS(dev_name, str, tag, doorbell, transfer_len,
245+ TP_ARGS(dev_name, str_t, tag, doorbell, transfer_len,
231246 intr, lba, opcode, group_id),
232247
233248 TP_STRUCT__entry(
234249 __string(dev_name, dev_name)
235− __string(str, str)
250+ __field(enum ufs_trace_str_t, str_t)
236251 __field(unsigned int, tag)
237252 __field(u32, doorbell)
238253 __field(int, transfer_len)
@@ -244,7 +259,7 @@ TRACE_EVENT(ufshcd_command, · 5 unmodified lines
244259
245260 TP_fast_assign(
246261 __assign_str(dev_name, dev_name);
247− __assign_str(str, str);
262+ __entry->str_t = str_t;
248263 __entry->tag = tag;
249264 __entry->doorbell = doorbell;
250265 __entry->transfer_len = transfer_len;
@@ -256,22 +271,22 @@ TRACE_EVENT(ufshcd_command, · 5 unmodified lines
256271
257272 TP_printk(
258273 "%s: %s: tag: %u, DB: 0x%x, size: %d, IS: %u, LBA: %llu, opcode: 0x%x (%s), group_id: 0x%x",
259− __get_str(str), __get_str(dev_name), __entry->tag,
260− __entry->doorbell, __entry->transfer_len,
274+ show_ufs_cmd_trace_str(__entry->str_t), __get_str(dev_name),
275+ __entry->tag, __entry->doorbell, __entry->transfer_len,
261276 __entry->intr, __entry->lba, (u32)__entry->opcode,
262277 str_opcode(__entry->opcode), (u32)__entry->group_id
263278 )
264279 );
265280
266281 TRACE_EVENT(ufshcd_uic_command,
267− TP_PROTO(const char *dev_name, const char *str, u32 cmd,
282+ TP_PROTO(const char *dev_name, enum ufs_trace_str_t str_t, u32 cmd,
268283 u32 arg1, u32 arg2, u32 arg3),
269284
270− TP_ARGS(dev_name, str, cmd, arg1, arg2, arg3),
285+ TP_ARGS(dev_name, str_t, cmd, arg1, arg2, arg3),
271286
272287 TP_STRUCT__entry(
273288 __string(dev_name, dev_name)
274− __string(str, str)
289+ __field(enum ufs_trace_str_t, str_t)
275290 __field(u32, cmd)
276291 __field(u32, arg1)
277292 __field(u32, arg2)
@@ -280,7 +295,7 @@ TRACE_EVENT(ufshcd_uic_command, · 2 unmodified lines
280295
281296 TP_fast_assign(
282297 __assign_str(dev_name, dev_name);
283− __assign_str(str, str);
298+ __entry->str_t = str_t;
284299 __entry->cmd = cmd;
285300 __entry->arg1 = arg1;
286301 __entry->arg2 = arg2;
@@ -289,33 +304,34 @@ TRACE_EVENT(ufshcd_uic_command, · 2 unmodified lines
289304
290305 TP_printk(
291306 "%s: %s: cmd: 0x%x, arg1: 0x%x, arg2: 0x%x, arg3: 0x%x",
292− __get_str(str), __get_str(dev_name), __entry->cmd,
293− __entry->arg1, __entry->arg2, __entry->arg3
307+ show_ufs_cmd_trace_str(__entry->str_t), __get_str(dev_name),
308+ __entry->cmd, __entry->arg1, __entry->arg2, __entry->arg3
294309 )
295310 );
296311
297312 TRACE_EVENT(ufshcd_upiu,
298− TP_PROTO(const char *dev_name, const char *str, void *hdr, void *tsf),
313+ TP_PROTO(const char *dev_name, enum ufs_trace_str_t str_t, void *hdr,
314+ void *tsf),
299315
300− TP_ARGS(dev_name, str, hdr, tsf),
316+ TP_ARGS(dev_name, str_t, hdr, tsf),
301317
302318 TP_STRUCT__entry(
303319 __string(dev_name, dev_name)
304− __string(str, str)
320+ __field(enum ufs_trace_str_t, str_t)
305321 __array(unsigned char, hdr, 12)
306322 __array(unsigned char, tsf, 16)
307323 ),
308324
309325 TP_fast_assign(
310326 __assign_str(dev_name, dev_name);
311− __assign_str(str, str);
327+ __entry->str_t = str_t;
312328 memcpy(__entry->hdr, hdr, sizeof(__entry->hdr));
313329 memcpy(__entry->tsf, tsf, sizeof(__entry->tsf));
314330 ),
315331
316332 TP_printk(
317333 "%s: %s: HDR:%s, CDB:%s",
318− __get_str(str), __get_str(dev_name),
334+ show_ufs_cmd_trace_str(__entry->str_t), __get_str(dev_name),
319335 __print_hex(__entry->hdr, sizeof(__entry->hdr)),
320336 __print_hex(__entry->tsf, sizeof(__entry->tsf))
321337 )

Keyboard shortcuts

General

Show keyboard shortcuts
?
Focus the current search
/

Issues and pull requests

Open filters
f

Issues, pull requests and Inbox

Select next item
j↓
Select previous item
k↑
Open selected item
Enter
Dismiss filters or clear selection
Esc

Repository code

Go to file
t