drivers/nvme/host/trace.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  * NVM Express device driver tracepoints
   4  * Copyright (c) 2018 Johannes Thumshirn, SUSE Linux GmbH
   5  */
   6
   7 #include <asm/unaligned.h>
   8 #include "trace.h"
   9
  10 static const char *nvme_trace_delete_sq(struct trace_seq *p, u8 *cdw10)
  11 {
  12         const char *ret = trace_seq_buffer_ptr(p);
  13         u16 sqid = get_unaligned_le16(cdw10);
  14
  15         trace_seq_printf(p, "sqid=%u", sqid);
  16         trace_seq_putc(p, 0);
  17
  18         return ret;
  19 }
  20
  21 static const char *nvme_trace_create_sq(struct trace_seq *p, u8 *cdw10)
  22 {
  23         const char *ret = trace_seq_buffer_ptr(p);
  24         u16 sqid = get_unaligned_le16(cdw10);
  25         u16 qsize = get_unaligned_le16(cdw10 + 2);
  26         u16 sq_flags = get_unaligned_le16(cdw10 + 4);
  27         u16 cqid = get_unaligned_le16(cdw10 + 6);
  28
  29
  30         trace_seq_printf(p, "sqid=%u, qsize=%u, sq_flags=0x%x, cqid=%u",
  31                          sqid, qsize, sq_flags, cqid);
  32         trace_seq_putc(p, 0);
  33
  34         return ret;
  35 }
  36
  37 static const char *nvme_trace_delete_cq(struct trace_seq *p, u8 *cdw10)
  38 {
  39         const char *ret = trace_seq_buffer_ptr(p);
  40         u16 cqid = get_unaligned_le16(cdw10);
  41
  42         trace_seq_printf(p, "cqid=%u", cqid);
  43         trace_seq_putc(p, 0);
  44
  45         return ret;
  46 }
  47
  48 static const char *nvme_trace_create_cq(struct trace_seq *p, u8 *cdw10)
  49 {
  50         const char *ret = trace_seq_buffer_ptr(p);
  51         u16 cqid = get_unaligned_le16(cdw10);
  52         u16 qsize = get_unaligned_le16(cdw10 + 2);
  53         u16 cq_flags = get_unaligned_le16(cdw10 + 4);
  54         u16 irq_vector = get_unaligned_le16(cdw10 + 6);
  55
  56         trace_seq_printf(p, "cqid=%u, qsize=%u, cq_flags=0x%x, irq_vector=%u",
  57                          cqid, qsize, cq_flags, irq_vector);
  58         trace_seq_putc(p, 0);
  59
  60         return ret;
  61 }
  62
  63 static const char *nvme_trace_admin_identify(struct trace_seq *p, u8 *cdw10)
  64 {
  65         const char *ret = trace_seq_buffer_ptr(p);
  66         u8 cns = cdw10[0];
  67         u16 ctrlid = get_unaligned_le16(cdw10 + 2);
  68
  69         trace_seq_printf(p, "cns=%u, ctrlid=%u", cns, ctrlid);
  70         trace_seq_putc(p, 0);
  71
  72         return ret;
  73 }
  74
  75 static const char *nvme_trace_admin_set_features(struct trace_seq *p,
  76                                                  u8 *cdw10)
  77 {
  78         const char *ret = trace_seq_buffer_ptr(p);
  79         u8 fid = cdw10[0];
  80         u8 sv = cdw10[3] & 0x8;
  81         u32 cdw11 = get_unaligned_le32(cdw10 + 4);
  82
  83         trace_seq_printf(p, "fid=0x%x, sv=0x%x, cdw11=0x%x", fid, sv, cdw11);
  84         trace_seq_putc(p, 0);
  85
  86         return ret;
  87 }
  88
  89 static const char *nvme_trace_admin_get_features(struct trace_seq *p,
  90                                                  u8 *cdw10)
  91 {
  92         const char *ret = trace_seq_buffer_ptr(p);
  93         u8 fid = cdw10[0];
  94         u8 sel = cdw10[1] & 0x7;
  95         u32 cdw11 = get_unaligned_le32(cdw10 + 4);
  96
  97         trace_seq_printf(p, "fid=0x%x, sel=0x%x, cdw11=0x%x", fid, sel, cdw11);
  98         trace_seq_putc(p, 0);
  99
 100         return ret;
 101 }
 102
 103 static const char *nvme_trace_get_lba_status(struct trace_seq *p,
 104                                              u8 *cdw10)
 105 {
 106         const char *ret = trace_seq_buffer_ptr(p);
 107         u64 slba = get_unaligned_le64(cdw10);
 108         u32 mndw = get_unaligned_le32(cdw10 + 8);
 109         u16 rl = get_unaligned_le16(cdw10 + 12);
 110         u8 atype = cdw10[15];
 111
 112         trace_seq_printf(p, "slba=0x%llx, mndw=0x%x, rl=0x%x, atype=%u",
 113                         slba, mndw, rl, atype);
 114         trace_seq_putc(p, 0);
 115
 116         return ret;
 117 }
 118
 119 static const char *nvme_trace_admin_format_nvm(struct trace_seq *p, u8 *cdw10)
 120 {
 121         const char *ret = trace_seq_buffer_ptr(p);
 122         u8 lbaf = cdw10[0] & 0xF;
 123         u8 mset = (cdw10[0] >> 4) & 0x1;
 124         u8 pi = (cdw10[0] >> 5) & 0x7;
 125         u8 pil = cdw10[1] & 0x1;
 126         u8 ses = (cdw10[1] >> 1) & 0x7;
 127
 128         trace_seq_printf(p, "lbaf=%u, mset=%u, pi=%u, pil=%u, ses=%u",
 129                         lbaf, mset, pi, pil, ses);
 130
 131         trace_seq_putc(p, 0);
 132
 133         return ret;
 134 }
 135
 136 static const char *nvme_trace_read_write(struct trace_seq *p, u8 *cdw10)
 137 {
 138         const char *ret = trace_seq_buffer_ptr(p);
 139         u64 slba = get_unaligned_le64(cdw10);
 140         u16 length = get_unaligned_le16(cdw10 + 8);
 141         u16 control = get_unaligned_le16(cdw10 + 10);
 142         u32 dsmgmt = get_unaligned_le32(cdw10 + 12);
 143         u32 reftag = get_unaligned_le32(cdw10 +  16);
 144
 145         trace_seq_printf(p,
 146                          "slba=%llu, len=%u, ctrl=0x%x, dsmgmt=%u, reftag=%u",
 147                          slba, length, control, dsmgmt, reftag);
 148         trace_seq_putc(p, 0);
 149
 150         return ret;
 151 }
 152
 153 static const char *nvme_trace_dsm(struct trace_seq *p, u8 *cdw10)
 154 {
 155         const char *ret = trace_seq_buffer_ptr(p);
 156
 157         trace_seq_printf(p, "nr=%u, attributes=%u",
 158                          get_unaligned_le32(cdw10),
 159                          get_unaligned_le32(cdw10 + 4));
 160         trace_seq_putc(p, 0);
 161
 162         return ret;
 163 }
 164
 165 static const char *nvme_trace_zone_mgmt_send(struct trace_seq *p, u8 *cdw10)
 166 {
 167         static const char * const zsa_strs[] = {
 168                 [0x01] = "close zone",
 169                 [0x02] = "finish zone",
 170                 [0x03] = "open zone",
 171                 [0x04] = "reset zone",
 172                 [0x05] = "offline zone",
 173                 [0x10] = "set zone descriptor extension"
 174         };
 175         const char *ret = trace_seq_buffer_ptr(p);
 176         u64 slba = get_unaligned_le64(cdw10);
 177         const char *zsa_str;
 178         u8 zsa = cdw10[12];
 179         u8 all = cdw10[13];
 180
 181         if (zsa < ARRAY_SIZE(zsa_strs) && zsa_strs[zsa])
 182                 zsa_str = zsa_strs[zsa];
 183         else
 184                 zsa_str = "reserved";
 185
 186         trace_seq_printf(p, "slba=%llu, zsa=%u:%s, all=%u",
 187                 slba, zsa, zsa_str, all);
 188         trace_seq_putc(p, 0);
 189
 190         return ret;
 191 }
 192
 193 static const char *nvme_trace_zone_mgmt_recv(struct trace_seq *p, u8 *cdw10)
 194 {
 195         static const char * const zrasf_strs[] = {
 196                 [0x00] = "list all zones",
 197                 [0x01] = "list the zones in the ZSE: Empty state",
 198                 [0x02] = "list the zones in the ZSIO: Implicitly Opened state",
 199                 [0x03] = "list the zones in the ZSEO: Explicitly Opened state",
 200                 [0x04] = "list the zones in the ZSC: Closed state",
 201                 [0x05] = "list the zones in the ZSF: Full state",
 202                 [0x06] = "list the zones in the ZSRO: Read Only state",
 203                 [0x07] = "list the zones in the ZSO: Offline state",
 204                 [0x09] = "list the zones that have the zone attribute"
 205         };
 206         const char *ret = trace_seq_buffer_ptr(p);
 207         u64 slba = get_unaligned_le64(cdw10);
 208         u32 numd = get_unaligned_le32(cdw10 + 8);
 209         u8 zra = cdw10[12];
 210         u8 zrasf = cdw10[13];
 211         const char *zrasf_str;
 212         u8 pr = cdw10[14];
 213
 214         if (zrasf < ARRAY_SIZE(zrasf_strs) && zrasf_strs[zrasf])
 215                 zrasf_str = zrasf_strs[zrasf];
 216         else
 217                 zrasf_str = "reserved";
 218
 219         trace_seq_printf(p, "slba=%llu, numd=%u, zra=%u, zrasf=%u:%s, pr=%u",
 220                 slba, numd, zra, zrasf, zrasf_str, pr);
 221         trace_seq_putc(p, 0);
 222
 223         return ret;
 224 }
 225
 226 static const char *nvme_trace_resv_reg(struct trace_seq *p, u8 *cdw10)
 227 {
 228         const char *ret = trace_seq_buffer_ptr(p);
 229         u8 rrega = cdw10[0] & 0x7;
 230         u8 iekey = (cdw10[0] >> 3) & 0x1;
 231         u8 ptpl = (cdw10[3] >> 6) & 0x3;
 232
 233         trace_seq_printf(p, "rrega=%u, iekey=%u, ptpl=%u",
 234                          rrega, iekey, ptpl);
 235         trace_seq_putc(p, 0);
 236
 237         return ret;
 238 }
 239
 240 static const char *nvme_trace_resv_acq(struct trace_seq *p, u8 *cdw10)
 241 {
 242         const char *ret = trace_seq_buffer_ptr(p);
 243         u8 racqa = cdw10[0] & 0x7;
 244         u8 iekey = (cdw10[0] >> 3) & 0x1;
 245         u8 rtype = cdw10[1];
 246
 247         trace_seq_printf(p, "racqa=%u, iekey=%u, rtype=%u",
 248                          racqa, iekey, rtype);
 249         trace_seq_putc(p, 0);
 250
 251         return ret;
 252 }
 253
 254 static const char *nvme_trace_resv_rel(struct trace_seq *p, u8 *cdw10)
 255 {
 256         const char *ret = trace_seq_buffer_ptr(p);
 257         u8 rrela = cdw10[0] & 0x7;
 258         u8 iekey = (cdw10[0] >> 3) & 0x1;
 259         u8 rtype = cdw10[1];
 260
 261         trace_seq_printf(p, "rrela=%u, iekey=%u, rtype=%u",
 262                          rrela, iekey, rtype);
 263         trace_seq_putc(p, 0);
 264
 265         return ret;
 266 }
 267
 268 static const char *nvme_trace_resv_report(struct trace_seq *p, u8 *cdw10)
 269 {
 270         const char *ret = trace_seq_buffer_ptr(p);
 271         u32 numd = get_unaligned_le32(cdw10);
 272         u8 eds = cdw10[4] & 0x1;
 273
 274         trace_seq_printf(p, "numd=%u, eds=%u", numd, eds);
 275         trace_seq_putc(p, 0);
 276
 277         return ret;
 278 }
 279
 280 static const char *nvme_trace_common(struct trace_seq *p, u8 *cdw10)
 281 {
 282         const char *ret = trace_seq_buffer_ptr(p);
 283
 284         trace_seq_printf(p, "cdw10=%*ph", 24, cdw10);
 285         trace_seq_putc(p, 0);
 286
 287         return ret;
 288 }
 289
 290 const char *nvme_trace_parse_admin_cmd(struct trace_seq *p,
 291                                        u8 opcode, u8 *cdw10)
 292 {
 293         switch (opcode) {
 294         case nvme_admin_delete_sq:
 295                 return nvme_trace_delete_sq(p, cdw10);
 296         case nvme_admin_create_sq:
 297                 return nvme_trace_create_sq(p, cdw10);
 298         case nvme_admin_delete_cq:
 299                 return nvme_trace_delete_cq(p, cdw10);
 300         case nvme_admin_create_cq:
 301                 return nvme_trace_create_cq(p, cdw10);
 302         case nvme_admin_identify:
 303                 return nvme_trace_admin_identify(p, cdw10);
 304         case nvme_admin_set_features:
 305                 return nvme_trace_admin_set_features(p, cdw10);
 306         case nvme_admin_get_features:
 307                 return nvme_trace_admin_get_features(p, cdw10);
 308         case nvme_admin_get_lba_status:
 309                 return nvme_trace_get_lba_status(p, cdw10);
 310         case nvme_admin_format_nvm:
 311                 return nvme_trace_admin_format_nvm(p, cdw10);
 312         default:
 313                 return nvme_trace_common(p, cdw10);
 314         }
 315 }
 316
 317 const char *nvme_trace_parse_nvm_cmd(struct trace_seq *p,
 318                                      u8 opcode, u8 *cdw10)
 319 {
 320         switch (opcode) {
 321         case nvme_cmd_read:
 322         case nvme_cmd_write:
 323         case nvme_cmd_write_zeroes:
 324         case nvme_cmd_zone_append:
 325                 return nvme_trace_read_write(p, cdw10);
 326         case nvme_cmd_dsm:
 327                 return nvme_trace_dsm(p, cdw10);
 328         case nvme_cmd_zone_mgmt_send:
 329                 return nvme_trace_zone_mgmt_send(p, cdw10);
 330         case nvme_cmd_zone_mgmt_recv:
 331                 return nvme_trace_zone_mgmt_recv(p, cdw10);
 332         case nvme_cmd_resv_register:
 333                 return nvme_trace_resv_reg(p, cdw10);
 334         case nvme_cmd_resv_acquire:
 335                 return nvme_trace_resv_acq(p, cdw10);
 336         case nvme_cmd_resv_release:
 337                 return nvme_trace_resv_rel(p, cdw10);
 338         case nvme_cmd_resv_report:
 339                 return nvme_trace_resv_report(p, cdw10);
 340         default:
 341                 return nvme_trace_common(p, cdw10);
 342         }
 343 }
 344
 345 static const char *nvme_trace_fabrics_property_set(struct trace_seq *p, u8 *spc)
 346 {
 347         const char *ret = trace_seq_buffer_ptr(p);
 348         u8 attrib = spc[0];
 349         u32 ofst = get_unaligned_le32(spc + 4);
 350         u64 value = get_unaligned_le64(spc + 8);
 351
 352         trace_seq_printf(p, "attrib=%u, ofst=0x%x, value=0x%llx",
 353                          attrib, ofst, value);
 354         trace_seq_putc(p, 0);
 355         return ret;
 356 }
 357
 358 static const char *nvme_trace_fabrics_connect(struct trace_seq *p, u8 *spc)
 359 {
 360         const char *ret = trace_seq_buffer_ptr(p);
 361         u16 recfmt = get_unaligned_le16(spc);
 362         u16 qid = get_unaligned_le16(spc + 2);
 363         u16 sqsize = get_unaligned_le16(spc + 4);
 364         u8 cattr = spc[6];
 365         u32 kato = get_unaligned_le32(spc + 8);
 366
 367         trace_seq_printf(p, "recfmt=%u, qid=%u, sqsize=%u, cattr=%u, kato=%u",
 368                          recfmt, qid, sqsize, cattr, kato);
 369         trace_seq_putc(p, 0);
 370         return ret;
 371 }
 372
 373 static const char *nvme_trace_fabrics_property_get(struct trace_seq *p, u8 *spc)
 374 {
 375         const char *ret = trace_seq_buffer_ptr(p);
 376         u8 attrib = spc[0];
 377         u32 ofst = get_unaligned_le32(spc + 4);
 378
 379         trace_seq_printf(p, "attrib=%u, ofst=0x%x", attrib, ofst);
 380         trace_seq_putc(p, 0);
 381         return ret;
 382 }
 383
 384 static const char *nvme_trace_fabrics_auth_send(struct trace_seq *p, u8 *spc)
 385 {
 386         const char *ret = trace_seq_buffer_ptr(p);
 387         u8 spsp0 = spc[1];
 388         u8 spsp1 = spc[2];
 389         u8 secp = spc[3];
 390         u32 tl = get_unaligned_le32(spc + 4);
 391
 392         trace_seq_printf(p, "spsp0=%02x, spsp1=%02x, secp=%02x, tl=%u",
 393                          spsp0, spsp1, secp, tl);
 394         trace_seq_putc(p, 0);
 395         return ret;
 396 }
 397
 398 static const char *nvme_trace_fabrics_auth_receive(struct trace_seq *p, u8 *spc)
 399 {
 400         const char *ret = trace_seq_buffer_ptr(p);
 401         u8 spsp0 = spc[1];
 402         u8 spsp1 = spc[2];
 403         u8 secp = spc[3];
 404         u32 al = get_unaligned_le32(spc + 4);
 405
 406         trace_seq_printf(p, "spsp0=%02x, spsp1=%02x, secp=%02x, al=%u",
 407                          spsp0, spsp1, secp, al);
 408         trace_seq_putc(p, 0);
 409         return ret;
 410 }
 411
 412 static const char *nvme_trace_fabrics_common(struct trace_seq *p, u8 *spc)
 413 {
 414         const char *ret = trace_seq_buffer_ptr(p);
 415
 416         trace_seq_printf(p, "specific=%*ph", 24, spc);
 417         trace_seq_putc(p, 0);
 418         return ret;
 419 }
 420
 421 const char *nvme_trace_parse_fabrics_cmd(struct trace_seq *p,
 422                 u8 fctype, u8 *spc)
 423 {
 424         switch (fctype) {
 425         case nvme_fabrics_type_property_set:
 426                 return nvme_trace_fabrics_property_set(p, spc);
 427         case nvme_fabrics_type_connect:
 428                 return nvme_trace_fabrics_connect(p, spc);
 429         case nvme_fabrics_type_property_get:
 430                 return nvme_trace_fabrics_property_get(p, spc);
 431         case nvme_fabrics_type_auth_send:
 432                 return nvme_trace_fabrics_auth_send(p, spc);
 433         case nvme_fabrics_type_auth_receive:
 434                 return nvme_trace_fabrics_auth_receive(p, spc);
 435         default:
 436                 return nvme_trace_fabrics_common(p, spc);
 437         }
 438 }
 439
 440 const char *nvme_trace_disk_name(struct trace_seq *p, char *name)
 441 {
 442         const char *ret = trace_seq_buffer_ptr(p);
 443
 444         if (*name)
 445                 trace_seq_printf(p, "disk=%s, ", name);
 446         trace_seq_putc(p, 0);
 447
 448         return ret;
 449 }
 450
 451 EXPORT_TRACEPOINT_SYMBOL_GPL(nvme_sq);