sys/cam/cam.c

   1 /*-
   2  * Generic utility routines for the Common Access Method layer.
   3  *
   4  * Copyright (c) 1997 Justin T. Gibbs.
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions, and the following disclaimer,
  12  *    without modification, immediately at the beginning of the file.
  13  * 2. The name of the author may not be used to endorse or promote products
  14  *    derived from this software without specific prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
  20  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26  * SUCH DAMAGE.
  27  */
  28
  29 #include <sys/cdefs.h>
  30 __FBSDID("$FreeBSD$");
  31
  32 #include <sys/param.h>
  33 #ifdef _KERNEL
  34 #include <sys/systm.h>
  35 #include <sys/kernel.h>
  36 #include <sys/sysctl.h>
  37 #else /* _KERNEL */
  38 #include <stdlib.h>
  39 #include <stdio.h>
  40 #include <string.h>
  41 #include <camlib.h>
  42 #endif /* _KERNEL */
  43
  44 #include <cam/cam.h>
  45 #include <cam/cam_ccb.h>
  46 #include <cam/scsi/scsi_all.h>
  47 #include <cam/scsi/smp_all.h>
  48 #include <sys/sbuf.h>
  49
  50 #ifdef _KERNEL
  51 #include <sys/libkern.h>
  52 #include <cam/cam_queue.h>
  53 #include <cam/cam_xpt.h>
  54
  55 FEATURE(scbus, "SCSI devices support");
  56
  57 #endif
  58
  59 static int      camstatusentrycomp(const void *key, const void *member);
  60
  61 const struct cam_status_entry cam_status_table[] = {
  62         { CAM_REQ_INPROG,        "CCB request is in progress"                },
  63         { CAM_REQ_CMP,           "CCB request completed without error"       },
  64         { CAM_REQ_ABORTED,       "CCB request aborted by the host"           },
  65         { CAM_UA_ABORT,          "Unable to abort CCB request"               },
  66         { CAM_REQ_CMP_ERR,       "CCB request completed with an error"       },
  67         { CAM_BUSY,              "CAM subsystem is busy"                     },
  68         { CAM_REQ_INVALID,       "CCB request was invalid"                   },
  69         { CAM_PATH_INVALID,      "Supplied Path ID is invalid"               },
  70         { CAM_DEV_NOT_THERE,     "Device Not Present"                        },
  71         { CAM_UA_TERMIO,         "Unable to terminate I/O CCB request"       },
  72         { CAM_SEL_TIMEOUT,       "Selection Timeout"                         },
  73         { CAM_CMD_TIMEOUT,       "Command timeout"                           },
  74         { CAM_SCSI_STATUS_ERROR, "SCSI Status Error"                         },
  75         { CAM_MSG_REJECT_REC,    "Message Reject Reveived"                   },
  76         { CAM_SCSI_BUS_RESET,    "SCSI Bus Reset Sent/Received"              },
  77         { CAM_UNCOR_PARITY,      "Uncorrectable parity/CRC error"            },
  78         { CAM_AUTOSENSE_FAIL,    "Auto-Sense Retrieval Failed"               },
  79         { CAM_NO_HBA,            "No HBA Detected"                           },
  80         { CAM_DATA_RUN_ERR,      "Data Overrun error"                        },
  81         { CAM_UNEXP_BUSFREE,     "Unexpected Bus Free"                       },
  82         { CAM_SEQUENCE_FAIL,     "Target Bus Phase Sequence Failure"         },
  83         { CAM_CCB_LEN_ERR,       "CCB length supplied is inadequate"         },
  84         { CAM_PROVIDE_FAIL,      "Unable to provide requested capability"    },
  85         { CAM_BDR_SENT,          "SCSI BDR Message Sent"                     },
  86         { CAM_REQ_TERMIO,        "CCB request terminated by the host"        },
  87         { CAM_UNREC_HBA_ERROR,   "Unrecoverable Host Bus Adapter Error"      },
  88         { CAM_REQ_TOO_BIG,       "The request was too large for this host"   },
  89         { CAM_REQUEUE_REQ,       "Unconditionally Re-queue Request",         },
  90         { CAM_ATA_STATUS_ERROR,  "ATA Status Error"                          },
  91         { CAM_SCSI_IT_NEXUS_LOST,"Initiator/Target Nexus Lost"               },
  92         { CAM_SMP_STATUS_ERROR,  "SMP Status Error"                          },
  93         { CAM_IDE,               "Initiator Detected Error Message Received" },
  94         { CAM_RESRC_UNAVAIL,     "Resource Unavailable"                      },
  95         { CAM_UNACKED_EVENT,     "Unacknowledged Event by Host"              },
  96         { CAM_MESSAGE_RECV,      "Message Received in Host Target Mode"      },
  97         { CAM_INVALID_CDB,       "Invalid CDB received in Host Target Mode"  },
  98         { CAM_LUN_INVALID,       "Invalid Lun"                               },
  99         { CAM_TID_INVALID,       "Invalid Target ID"                         },
 100         { CAM_FUNC_NOTAVAIL,     "Function Not Available"                    },
 101         { CAM_NO_NEXUS,          "Nexus Not Established"                     },
 102         { CAM_IID_INVALID,       "Invalid Initiator ID"                      },
 103         { CAM_CDB_RECVD,         "CDB Received"                              },
 104         { CAM_LUN_ALRDY_ENA,     "LUN Already Enabled for Target Mode"       },
 105         { CAM_SCSI_BUSY,         "SCSI Bus Busy"                             },
 106 };
 107
 108 const int num_cam_status_entries =
 109     sizeof(cam_status_table)/sizeof(*cam_status_table);
 110
 111 #ifdef _KERNEL
 112 SYSCTL_NODE(_kern, OID_AUTO, cam, CTLFLAG_RD, 0, "CAM Subsystem");
 113
 114 #ifndef CAM_DEFAULT_SORT_IO_QUEUES
 115 #define CAM_DEFAULT_SORT_IO_QUEUES 1
 116 #endif
 117
 118 int cam_sort_io_queues = CAM_DEFAULT_SORT_IO_QUEUES;
 119 TUNABLE_INT("kern.cam.sort_io_queues", &cam_sort_io_queues);
 120 SYSCTL_INT(_kern_cam, OID_AUTO, sort_io_queues, CTLFLAG_RWTUN,
 121     &cam_sort_io_queues, 0, "Sort IO queues to try and optimise disk access patterns");
 122 #endif
 123
 124 void
 125 cam_strvis(u_int8_t *dst, const u_int8_t *src, int srclen, int dstlen)
 126 {
 127
 128         /* Trim leading/trailing spaces, nulls. */
 129         while (srclen > 0 && src[0] == ' ')
 130                 src++, srclen--;
 131         while (srclen > 0
 132             && (src[srclen-1] == ' ' || src[srclen-1] == '\0'))
 133                 srclen--;
 134
 135         while (srclen > 0 && dstlen > 1) {
 136                 u_int8_t *cur_pos = dst;
 137
 138                 if (*src < 0x20 || *src >= 0x80) {
 139                         /* SCSI-II Specifies that these should never occur. */
 140                         /* non-printable character */
 141                         if (dstlen > 4) {
 142                                 *cur_pos++ = '\\';
 143                                 *cur_pos++ = ((*src & 0300) >> 6) + '0';
 144                                 *cur_pos++ = ((*src & 0070) >> 3) + '0';
 145                                 *cur_pos++ = ((*src & 0007) >> 0) + '0';
 146                         } else {
 147                                 *cur_pos++ = '?';
 148                         }
 149                 } else {
 150                         /* normal character */
 151                         *cur_pos++ = *src;
 152                 }
 153                 src++;
 154                 srclen--;
 155                 dstlen -= cur_pos - dst;
 156                 dst = cur_pos;
 157         }
 158         *dst = '\0';
 159 }
 160
 161 void
 162 cam_strvis_sbuf(struct sbuf *sb, const u_int8_t *src, int srclen,
 163                 uint32_t flags)
 164 {
 165
 166         /* Trim leading/trailing spaces, nulls. */
 167         while (srclen > 0 && src[0] == ' ')
 168                 src++, srclen--;
 169         while (srclen > 0
 170             && (src[srclen-1] == ' ' || src[srclen-1] == '\0'))
 171                 srclen--;
 172
 173         while (srclen > 0) {
 174                 if (*src < 0x20 || *src >= 0x80) {
 175                         /* SCSI-II Specifies that these should never occur. */
 176                         /* non-printable character */
 177                         switch (flags & CAM_STRVIS_FLAG_NONASCII_MASK) {
 178                         case CAM_STRVIS_FLAG_NONASCII_ESC:
 179                                 sbuf_printf(sb, "\\%c%c%c",
 180                                     ((*src & 0300) >> 6) + '0',
 181                                     ((*src & 0070) >> 3) + '0',
 182                                     ((*src & 0007) >> 0) + '0');
 183                                 break;
 184                         case CAM_STRVIS_FLAG_NONASCII_RAW:
 185                                 /*
 186                                  * If we run into a NUL, just transform it
 187                                  * into a space.
 188                                  */
 189                                 if (*src != 0x00)
 190                                         sbuf_putc(sb, *src);
 191                                 else
 192                                         sbuf_putc(sb, ' ');
 193                                 break;
 194                         case CAM_STRVIS_FLAG_NONASCII_SPC:
 195                                 sbuf_putc(sb, ' ');
 196                                 break;
 197                         case CAM_STRVIS_FLAG_NONASCII_TRIM:
 198                         default:
 199                                 break;
 200                         }
 201                 } else {
 202                         /* normal character */
 203                         sbuf_putc(sb, *src);
 204                 }
 205                 src++;
 206                 srclen--;
 207         }
 208 }
 209
 210
 211 /*
 212  * Compare string with pattern, returning 0 on match.
 213  * Short pattern matches trailing blanks in name,
 214  * wildcard '*' in pattern matches rest of name,
 215  * wildcard '?' matches a single non-space character.
 216  */
 217 int
 218 cam_strmatch(const u_int8_t *str, const u_int8_t *pattern, int str_len)
 219 {
 220
 221         while (*pattern != '\0'&& str_len > 0) {
 222
 223                 if (*pattern == '*') {
 224                         return (0);
 225                 }
 226                 if ((*pattern != *str)
 227                  && (*pattern != '?' || *str == ' ')) {
 228                         return (1);
 229                 }
 230                 pattern++;
 231                 str++;
 232                 str_len--;
 233         }
 234         while (str_len > 0 && *str == ' ') {
 235                 str++;
 236                 str_len--;
 237         }
 238         if (str_len > 0 && *str == 0)
 239                 str_len = 0;
 240
 241         return (str_len);
 242 }
 243
 244 caddr_t
 245 cam_quirkmatch(caddr_t target, caddr_t quirk_table, int num_entries,
 246                int entry_size, cam_quirkmatch_t *comp_func)
 247 {
 248         for (; num_entries > 0; num_entries--, quirk_table += entry_size) {
 249                 if ((*comp_func)(target, quirk_table) == 0)
 250                         return (quirk_table);
 251         }
 252         return (NULL);
 253 }
 254
 255 const struct cam_status_entry*
 256 cam_fetch_status_entry(cam_status status)
 257 {
 258         status &= CAM_STATUS_MASK;
 259         return (bsearch(&status, &cam_status_table,
 260                         num_cam_status_entries,
 261                         sizeof(*cam_status_table),
 262                         camstatusentrycomp));
 263 }
 264
 265 static int
 266 camstatusentrycomp(const void *key, const void *member)
 267 {
 268         cam_status status;
 269         const struct cam_status_entry *table_entry;
 270
 271         status = *(const cam_status *)key;
 272         table_entry = (const struct cam_status_entry *)member;
 273
 274         return (status - table_entry->status_code);
 275 }
 276
 277
 278 #ifdef _KERNEL
 279 char *
 280 cam_error_string(union ccb *ccb, char *str, int str_len,
 281                  cam_error_string_flags flags,
 282                  cam_error_proto_flags proto_flags)
 283 #else /* !_KERNEL */
 284 char *
 285 cam_error_string(struct cam_device *device, union ccb *ccb, char *str,
 286                  int str_len, cam_error_string_flags flags,
 287                  cam_error_proto_flags proto_flags)
 288 #endif /* _KERNEL/!_KERNEL */
 289 {
 290         char path_str[64];
 291         struct sbuf sb;
 292
 293         if ((ccb == NULL)
 294          || (str == NULL)
 295          || (str_len <= 0))
 296                 return(NULL);
 297
 298         if (flags == CAM_ESF_NONE)
 299                 return(NULL);
 300
 301         switch (ccb->ccb_h.func_code) {
 302                 case XPT_ATA_IO:
 303                         switch (proto_flags & CAM_EPF_LEVEL_MASK) {
 304                         case CAM_EPF_NONE:
 305                                 break;
 306                         case CAM_EPF_ALL:
 307                         case CAM_EPF_NORMAL:
 308                                 proto_flags |= CAM_EAF_PRINT_RESULT;
 309                                 /* FALLTHROUGH */
 310                         case CAM_EPF_MINIMAL:
 311                                 proto_flags |= CAM_EAF_PRINT_STATUS;
 312                                 /* FALLTHROUGH */
 313                         default:
 314                                 break;
 315                         }
 316                         break;
 317                 case XPT_SCSI_IO:
 318                         switch (proto_flags & CAM_EPF_LEVEL_MASK) {
 319                         case CAM_EPF_NONE:
 320                                 break;
 321                         case CAM_EPF_ALL:
 322                         case CAM_EPF_NORMAL:
 323                                 proto_flags |= CAM_ESF_PRINT_SENSE;
 324                                 /* FALLTHROUGH */
 325                         case CAM_EPF_MINIMAL:
 326                                 proto_flags |= CAM_ESF_PRINT_STATUS;
 327                                 /* FALLTHROUGH */
 328                         default:
 329                                 break;
 330                         }
 331                         break;
 332                 case XPT_SMP_IO:
 333                         switch (proto_flags & CAM_EPF_LEVEL_MASK) {
 334                         case CAM_EPF_NONE:
 335                                 break;
 336                         case CAM_EPF_ALL:
 337                                 proto_flags |= CAM_ESMF_PRINT_FULL_CMD;
 338                                 /* FALLTHROUGH */
 339                         case CAM_EPF_NORMAL:
 340                         case CAM_EPF_MINIMAL:
 341                                 proto_flags |= CAM_ESMF_PRINT_STATUS;
 342                                 /* FALLTHROUGH */
 343                         default:
 344                                 break;
 345                         }
 346                         break;
 347                 default:
 348                         break;
 349         }
 350 #ifdef _KERNEL
 351         xpt_path_string(ccb->csio.ccb_h.path, path_str, sizeof(path_str));
 352 #else /* !_KERNEL */
 353         cam_path_string(device, path_str, sizeof(path_str));
 354 #endif /* _KERNEL/!_KERNEL */
 355
 356         sbuf_new(&sb, str, str_len, 0);
 357
 358         if (flags & CAM_ESF_COMMAND) {
 359                 sbuf_cat(&sb, path_str);
 360                 switch (ccb->ccb_h.func_code) {
 361                 case XPT_ATA_IO:
 362                         ata_command_sbuf(&ccb->ataio, &sb);
 363                         sbuf_printf(&sb, "\n");
 364                         break;
 365                 case XPT_SCSI_IO:
 366 #ifdef _KERNEL
 367                         scsi_command_string(&ccb->csio, &sb);
 368 #else /* !_KERNEL */
 369                         scsi_command_string(device, &ccb->csio, &sb);
 370 #endif /* _KERNEL/!_KERNEL */
 371                         sbuf_printf(&sb, "\n");
 372                         break;
 373                 case XPT_SMP_IO:
 374                         smp_command_sbuf(&ccb->smpio, &sb, path_str, 79 -
 375                                          strlen(path_str), (proto_flags &
 376                                          CAM_ESMF_PRINT_FULL_CMD) ? 79 : 0);
 377                         sbuf_printf(&sb, "\n");
 378                         break;
 379                 default:
 380                         break;
 381                 }
 382         }
 383
 384         if (flags & CAM_ESF_CAM_STATUS) {
 385                 cam_status status;
 386                 const struct cam_status_entry *entry;
 387
 388                 sbuf_cat(&sb, path_str);
 389
 390                 status = ccb->ccb_h.status & CAM_STATUS_MASK;
 391
 392                 entry = cam_fetch_status_entry(status);
 393
 394                 if (entry == NULL)
 395                         sbuf_printf(&sb, "CAM status: Unknown (%#x)\n",
 396                                     ccb->ccb_h.status);
 397                 else
 398                         sbuf_printf(&sb, "CAM status: %s\n",
 399                                     entry->status_text);
 400         }
 401
 402         if (flags & CAM_ESF_PROTO_STATUS) {
 403
 404                 switch (ccb->ccb_h.func_code) {
 405                 case XPT_ATA_IO:
 406                         if ((ccb->ccb_h.status & CAM_STATUS_MASK) !=
 407                              CAM_ATA_STATUS_ERROR)
 408                                 break;
 409                         if (proto_flags & CAM_EAF_PRINT_STATUS) {
 410                                 sbuf_cat(&sb, path_str);
 411                                 ata_status_sbuf(&ccb->ataio, &sb);
 412                                 sbuf_printf(&sb, "\n");
 413                         }
 414                         if (proto_flags & CAM_EAF_PRINT_RESULT) {
 415                                 sbuf_cat(&sb, path_str);
 416                                 ata_res_sbuf(&ccb->ataio, &sb);
 417                                 sbuf_printf(&sb, "\n");
 418                         }
 419
 420                         break;
 421                 case XPT_SCSI_IO:
 422                         if ((ccb->ccb_h.status & CAM_STATUS_MASK) !=
 423                              CAM_SCSI_STATUS_ERROR)
 424                                 break;
 425
 426                         if (proto_flags & CAM_ESF_PRINT_STATUS) {
 427                                 sbuf_cat(&sb, path_str);
 428                                 sbuf_printf(&sb, "SCSI status: %s\n",
 429                                             scsi_status_string(&ccb->csio));
 430                         }
 431
 432                         if ((proto_flags & CAM_ESF_PRINT_SENSE)
 433                          && (ccb->csio.scsi_status == SCSI_STATUS_CHECK_COND)
 434                          && (ccb->ccb_h.status & CAM_AUTOSNS_VALID)) {
 435
 436 #ifdef _KERNEL
 437                                 scsi_sense_sbuf(&ccb->csio, &sb,
 438                                                 SSS_FLAG_NONE);
 439 #else /* !_KERNEL */
 440                                 scsi_sense_sbuf(device, &ccb->csio, &sb,
 441                                                 SSS_FLAG_NONE);
 442 #endif /* _KERNEL/!_KERNEL */
 443                         }
 444                         break;
 445                 case XPT_SMP_IO:
 446                         if ((ccb->ccb_h.status & CAM_STATUS_MASK) !=
 447                              CAM_SMP_STATUS_ERROR)
 448                                 break;
 449
 450                         if (proto_flags & CAM_ESF_PRINT_STATUS) {
 451                                 sbuf_cat(&sb, path_str);
 452                                 sbuf_printf(&sb, "SMP status: %s (%#x)\n",
 453                                     smp_error_desc(ccb->smpio.smp_response[2]),
 454                                                    ccb->smpio.smp_response[2]);
 455                         }
 456                         /* There is no SMP equivalent to SCSI sense. */
 457                         break;
 458                 default:
 459                         break;
 460                 }
 461         }
 462
 463         sbuf_finish(&sb);
 464
 465         return(sbuf_data(&sb));
 466 }
 467
 468 #ifdef _KERNEL
 469
 470 void
 471 cam_error_print(union ccb *ccb, cam_error_string_flags flags,
 472                 cam_error_proto_flags proto_flags)
 473 {
 474         char str[512];
 475
 476         printf("%s", cam_error_string(ccb, str, sizeof(str), flags,
 477                proto_flags));
 478 }
 479
 480 #else /* !_KERNEL */
 481
 482 void
 483 cam_error_print(struct cam_device *device, union ccb *ccb,
 484                 cam_error_string_flags flags, cam_error_proto_flags proto_flags,
 485                 FILE *ofile)
 486 {
 487         char str[512];
 488
 489         if ((device == NULL) || (ccb == NULL) || (ofile == NULL))
 490                 return;
 491
 492         fprintf(ofile, "%s", cam_error_string(device, ccb, str, sizeof(str),
 493                 flags, proto_flags));
 494 }
 495
 496 #endif /* _KERNEL/!_KERNEL */
 497
 498 /*
 499  * Common calculate geometry fuction
 500  *
 501  * Caller should set ccg->volume_size and block_size.
 502  * The extended parameter should be zero if extended translation
 503  * should not be used.
 504  */
 505 void
 506 cam_calc_geometry(struct ccb_calc_geometry *ccg, int extended)
 507 {
 508         uint32_t size_mb, secs_per_cylinder;
 509
 510         if (ccg->block_size == 0) {
 511                 ccg->ccb_h.status = CAM_REQ_CMP_ERR;
 512                 return;
 513         }
 514         size_mb = (1024L * 1024L) / ccg->block_size;
 515         if (size_mb == 0) {
 516                 ccg->ccb_h.status = CAM_REQ_CMP_ERR;
 517                 return;
 518         }
 519         size_mb = ccg->volume_size / size_mb;
 520         if (size_mb > 1024 && extended) {
 521                 ccg->heads = 255;
 522                 ccg->secs_per_track = 63;
 523         } else {
 524                 ccg->heads = 64;
 525                 ccg->secs_per_track = 32;
 526         }
 527         secs_per_cylinder = ccg->heads * ccg->secs_per_track;
 528         if (secs_per_cylinder == 0) {
 529                 ccg->ccb_h.status = CAM_REQ_CMP_ERR;
 530                 return;
 531         }
 532         ccg->cylinders = ccg->volume_size / secs_per_cylinder;
 533         ccg->ccb_h.status = CAM_REQ_CMP;
 534 }