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 #ifdef _KERNEL
 109 SYSCTL_NODE(_kern, OID_AUTO, cam, CTLFLAG_RD, 0, "CAM Subsystem");
 110
 111 #ifndef CAM_DEFAULT_SORT_IO_QUEUES
 112 #define CAM_DEFAULT_SORT_IO_QUEUES 1
 113 #endif
 114
 115 int cam_sort_io_queues = CAM_DEFAULT_SORT_IO_QUEUES;
 116 SYSCTL_INT(_kern_cam, OID_AUTO, sort_io_queues, CTLFLAG_RWTUN,
 117     &cam_sort_io_queues, 0, "Sort IO queues to try and optimise disk access patterns");
 118 #endif
 119
 120 void
 121 cam_strvis(u_int8_t *dst, const u_int8_t *src, int srclen, int dstlen)
 122 {
 123
 124         /* Trim leading/trailing spaces, nulls. */
 125         while (srclen > 0 && src[0] == ' ')
 126                 src++, srclen--;
 127         while (srclen > 0
 128             && (src[srclen-1] == ' ' || src[srclen-1] == '\0'))
 129                 srclen--;
 130
 131         while (srclen > 0 && dstlen > 1) {
 132                 u_int8_t *cur_pos = dst;
 133
 134                 if (*src < 0x20 || *src >= 0x80) {
 135                         /* SCSI-II Specifies that these should never occur. */
 136                         /* non-printable character */
 137                         if (dstlen > 4) {
 138                                 *cur_pos++ = '\\';
 139                                 *cur_pos++ = ((*src & 0300) >> 6) + '0';
 140                                 *cur_pos++ = ((*src & 0070) >> 3) + '0';
 141                                 *cur_pos++ = ((*src & 0007) >> 0) + '0';
 142                         } else {
 143                                 *cur_pos++ = '?';
 144                         }
 145                 } else {
 146                         /* normal character */
 147                         *cur_pos++ = *src;
 148                 }
 149                 src++;
 150                 srclen--;
 151                 dstlen -= cur_pos - dst;
 152                 dst = cur_pos;
 153         }
 154         *dst = '\0';
 155 }
 156
 157 void
 158 cam_strvis_sbuf(struct sbuf *sb, const u_int8_t *src, int srclen,
 159                 uint32_t flags)
 160 {
 161
 162         /* Trim leading/trailing spaces, nulls. */
 163         while (srclen > 0 && src[0] == ' ')
 164                 src++, srclen--;
 165         while (srclen > 0
 166             && (src[srclen-1] == ' ' || src[srclen-1] == '\0'))
 167                 srclen--;
 168
 169         while (srclen > 0) {
 170                 if (*src < 0x20 || *src >= 0x80) {
 171                         /* SCSI-II Specifies that these should never occur. */
 172                         /* non-printable character */
 173                         switch (flags & CAM_STRVIS_FLAG_NONASCII_MASK) {
 174                         case CAM_STRVIS_FLAG_NONASCII_ESC:
 175                                 sbuf_printf(sb, "\\%c%c%c",
 176                                     ((*src & 0300) >> 6) + '0',
 177                                     ((*src & 0070) >> 3) + '0',
 178                                     ((*src & 0007) >> 0) + '0');
 179                                 break;
 180                         case CAM_STRVIS_FLAG_NONASCII_RAW:
 181                                 /*
 182                                  * If we run into a NUL, just transform it
 183                                  * into a space.
 184                                  */
 185                                 if (*src != 0x00)
 186                                         sbuf_putc(sb, *src);
 187                                 else
 188                                         sbuf_putc(sb, ' ');
 189                                 break;
 190                         case CAM_STRVIS_FLAG_NONASCII_SPC:
 191                                 sbuf_putc(sb, ' ');
 192                                 break;
 193                         case CAM_STRVIS_FLAG_NONASCII_TRIM:
 194                         default:
 195                                 break;
 196                         }
 197                 } else {
 198                         /* normal character */
 199                         sbuf_putc(sb, *src);
 200                 }
 201                 src++;
 202                 srclen--;
 203         }
 204 }
 205
 206
 207 /*
 208  * Compare string with pattern, returning 0 on match.
 209  * Short pattern matches trailing blanks in name,
 210  * wildcard '*' in pattern matches rest of name,
 211  * wildcard '?' matches a single non-space character.
 212  */
 213 int
 214 cam_strmatch(const u_int8_t *str, const u_int8_t *pattern, int str_len)
 215 {
 216
 217         while (*pattern != '\0'&& str_len > 0) {
 218
 219                 if (*pattern == '*') {
 220                         return (0);
 221                 }
 222                 if ((*pattern != *str)
 223                  && (*pattern != '?' || *str == ' ')) {
 224                         return (1);
 225                 }
 226                 pattern++;
 227                 str++;
 228                 str_len--;
 229         }
 230         while (str_len > 0 && *str == ' ') {
 231                 str++;
 232                 str_len--;
 233         }
 234         if (str_len > 0 && *str == 0)
 235                 str_len = 0;
 236
 237         return (str_len);
 238 }
 239
 240 caddr_t
 241 cam_quirkmatch(caddr_t target, caddr_t quirk_table, int num_entries,
 242                int entry_size, cam_quirkmatch_t *comp_func)
 243 {
 244         for (; num_entries > 0; num_entries--, quirk_table += entry_size) {
 245                 if ((*comp_func)(target, quirk_table) == 0)
 246                         return (quirk_table);
 247         }
 248         return (NULL);
 249 }
 250
 251 const struct cam_status_entry*
 252 cam_fetch_status_entry(cam_status status)
 253 {
 254         status &= CAM_STATUS_MASK;
 255         return (bsearch(&status, &cam_status_table,
 256                         nitems(cam_status_table),
 257                         sizeof(*cam_status_table),
 258                         camstatusentrycomp));
 259 }
 260
 261 static int
 262 camstatusentrycomp(const void *key, const void *member)
 263 {
 264         cam_status status;
 265         const struct cam_status_entry *table_entry;
 266
 267         status = *(const cam_status *)key;
 268         table_entry = (const struct cam_status_entry *)member;
 269
 270         return (status - table_entry->status_code);
 271 }
 272
 273
 274 #ifdef _KERNEL
 275 char *
 276 cam_error_string(union ccb *ccb, char *str, int str_len,
 277                  cam_error_string_flags flags,
 278                  cam_error_proto_flags proto_flags)
 279 #else /* !_KERNEL */
 280 char *
 281 cam_error_string(struct cam_device *device, union ccb *ccb, char *str,
 282                  int str_len, cam_error_string_flags flags,
 283                  cam_error_proto_flags proto_flags)
 284 #endif /* _KERNEL/!_KERNEL */
 285 {
 286         char path_str[64];
 287         struct sbuf sb;
 288
 289         if ((ccb == NULL)
 290          || (str == NULL)
 291          || (str_len <= 0))
 292                 return(NULL);
 293
 294         if (flags == CAM_ESF_NONE)
 295                 return(NULL);
 296
 297         switch (ccb->ccb_h.func_code) {
 298                 case XPT_ATA_IO:
 299                         switch (proto_flags & CAM_EPF_LEVEL_MASK) {
 300                         case CAM_EPF_NONE:
 301                                 break;
 302                         case CAM_EPF_ALL:
 303                         case CAM_EPF_NORMAL:
 304                                 proto_flags |= CAM_EAF_PRINT_RESULT;
 305                                 /* FALLTHROUGH */
 306                         case CAM_EPF_MINIMAL:
 307                                 proto_flags |= CAM_EAF_PRINT_STATUS;
 308                                 /* FALLTHROUGH */
 309                         default:
 310                                 break;
 311                         }
 312                         break;
 313                 case XPT_SCSI_IO:
 314                         switch (proto_flags & CAM_EPF_LEVEL_MASK) {
 315                         case CAM_EPF_NONE:
 316                                 break;
 317                         case CAM_EPF_ALL:
 318                         case CAM_EPF_NORMAL:
 319                                 proto_flags |= CAM_ESF_PRINT_SENSE;
 320                                 /* FALLTHROUGH */
 321                         case CAM_EPF_MINIMAL:
 322                                 proto_flags |= CAM_ESF_PRINT_STATUS;
 323                                 /* FALLTHROUGH */
 324                         default:
 325                                 break;
 326                         }
 327                         break;
 328                 case XPT_SMP_IO:
 329                         switch (proto_flags & CAM_EPF_LEVEL_MASK) {
 330                         case CAM_EPF_NONE:
 331                                 break;
 332                         case CAM_EPF_ALL:
 333                                 proto_flags |= CAM_ESMF_PRINT_FULL_CMD;
 334                                 /* FALLTHROUGH */
 335                         case CAM_EPF_NORMAL:
 336                         case CAM_EPF_MINIMAL:
 337                                 proto_flags |= CAM_ESMF_PRINT_STATUS;
 338                                 /* FALLTHROUGH */
 339                         default:
 340                                 break;
 341                         }
 342                         break;
 343                 default:
 344                         break;
 345         }
 346 #ifdef _KERNEL
 347         xpt_path_string(ccb->csio.ccb_h.path, path_str, sizeof(path_str));
 348 #else /* !_KERNEL */
 349         cam_path_string(device, path_str, sizeof(path_str));
 350 #endif /* _KERNEL/!_KERNEL */
 351
 352         sbuf_new(&sb, str, str_len, 0);
 353
 354         if (flags & CAM_ESF_COMMAND) {
 355                 sbuf_cat(&sb, path_str);
 356                 switch (ccb->ccb_h.func_code) {
 357                 case XPT_ATA_IO:
 358                         ata_command_sbuf(&ccb->ataio, &sb);
 359                         sbuf_printf(&sb, "\n");
 360                         break;
 361                 case XPT_SCSI_IO:
 362 #ifdef _KERNEL
 363                         scsi_command_string(&ccb->csio, &sb);
 364 #else /* !_KERNEL */
 365                         scsi_command_string(device, &ccb->csio, &sb);
 366 #endif /* _KERNEL/!_KERNEL */
 367                         sbuf_printf(&sb, "\n");
 368                         break;
 369                 case XPT_SMP_IO:
 370                         smp_command_sbuf(&ccb->smpio, &sb, path_str, 79 -
 371                                          strlen(path_str), (proto_flags &
 372                                          CAM_ESMF_PRINT_FULL_CMD) ? 79 : 0);
 373                         sbuf_printf(&sb, "\n");
 374                         break;
 375                 default:
 376                         break;
 377                 }
 378         }
 379
 380         if (flags & CAM_ESF_CAM_STATUS) {
 381                 cam_status status;
 382                 const struct cam_status_entry *entry;
 383
 384                 sbuf_cat(&sb, path_str);
 385
 386                 status = ccb->ccb_h.status & CAM_STATUS_MASK;
 387
 388                 entry = cam_fetch_status_entry(status);
 389
 390                 if (entry == NULL)
 391                         sbuf_printf(&sb, "CAM status: Unknown (%#x)\n",
 392                                     ccb->ccb_h.status);
 393                 else
 394                         sbuf_printf(&sb, "CAM status: %s\n",
 395                                     entry->status_text);
 396         }
 397
 398         if (flags & CAM_ESF_PROTO_STATUS) {
 399
 400                 switch (ccb->ccb_h.func_code) {
 401                 case XPT_ATA_IO:
 402                         if ((ccb->ccb_h.status & CAM_STATUS_MASK) !=
 403                              CAM_ATA_STATUS_ERROR)
 404                                 break;
 405                         if (proto_flags & CAM_EAF_PRINT_STATUS) {
 406                                 sbuf_cat(&sb, path_str);
 407                                 ata_status_sbuf(&ccb->ataio, &sb);
 408                                 sbuf_printf(&sb, "\n");
 409                         }
 410                         if (proto_flags & CAM_EAF_PRINT_RESULT) {
 411                                 sbuf_cat(&sb, path_str);
 412                                 sbuf_printf(&sb, "RES: ");
 413                                 ata_res_sbuf(&ccb->ataio.res, &sb);
 414                                 sbuf_printf(&sb, "\n");
 415                         }
 416
 417                         break;
 418                 case XPT_SCSI_IO:
 419                         if ((ccb->ccb_h.status & CAM_STATUS_MASK) !=
 420                              CAM_SCSI_STATUS_ERROR)
 421                                 break;
 422
 423                         if (proto_flags & CAM_ESF_PRINT_STATUS) {
 424                                 sbuf_cat(&sb, path_str);
 425                                 sbuf_printf(&sb, "SCSI status: %s\n",
 426                                             scsi_status_string(&ccb->csio));
 427                         }
 428
 429                         if ((proto_flags & CAM_ESF_PRINT_SENSE)
 430                          && (ccb->csio.scsi_status == SCSI_STATUS_CHECK_COND)
 431                          && (ccb->ccb_h.status & CAM_AUTOSNS_VALID)) {
 432
 433 #ifdef _KERNEL
 434                                 scsi_sense_sbuf(&ccb->csio, &sb,
 435                                                 SSS_FLAG_NONE);
 436 #else /* !_KERNEL */
 437                                 scsi_sense_sbuf(device, &ccb->csio, &sb,
 438                                                 SSS_FLAG_NONE);
 439 #endif /* _KERNEL/!_KERNEL */
 440                         }
 441                         break;
 442                 case XPT_SMP_IO:
 443                         if ((ccb->ccb_h.status & CAM_STATUS_MASK) !=
 444                              CAM_SMP_STATUS_ERROR)
 445                                 break;
 446
 447                         if (proto_flags & CAM_ESF_PRINT_STATUS) {
 448                                 sbuf_cat(&sb, path_str);
 449                                 sbuf_printf(&sb, "SMP status: %s (%#x)\n",
 450                                     smp_error_desc(ccb->smpio.smp_response[2]),
 451                                                    ccb->smpio.smp_response[2]);
 452                         }
 453                         /* There is no SMP equivalent to SCSI sense. */
 454                         break;
 455                 default:
 456                         break;
 457                 }
 458         }
 459
 460         sbuf_finish(&sb);
 461
 462         return(sbuf_data(&sb));
 463 }
 464
 465 #ifdef _KERNEL
 466
 467 void
 468 cam_error_print(union ccb *ccb, cam_error_string_flags flags,
 469                 cam_error_proto_flags proto_flags)
 470 {
 471         char str[512];
 472
 473         printf("%s", cam_error_string(ccb, str, sizeof(str), flags,
 474                proto_flags));
 475 }
 476
 477 #else /* !_KERNEL */
 478
 479 void
 480 cam_error_print(struct cam_device *device, union ccb *ccb,
 481                 cam_error_string_flags flags, cam_error_proto_flags proto_flags,
 482                 FILE *ofile)
 483 {
 484         char str[512];
 485
 486         if ((device == NULL) || (ccb == NULL) || (ofile == NULL))
 487                 return;
 488
 489         fprintf(ofile, "%s", cam_error_string(device, ccb, str, sizeof(str),
 490                 flags, proto_flags));
 491 }
 492
 493 #endif /* _KERNEL/!_KERNEL */
 494
 495 /*
 496  * Common calculate geometry fuction
 497  *
 498  * Caller should set ccg->volume_size and block_size.
 499  * The extended parameter should be zero if extended translation
 500  * should not be used.
 501  */
 502 void
 503 cam_calc_geometry(struct ccb_calc_geometry *ccg, int extended)
 504 {
 505         uint32_t size_mb, secs_per_cylinder;
 506
 507         if (ccg->block_size == 0) {
 508                 ccg->ccb_h.status = CAM_REQ_CMP_ERR;
 509                 return;
 510         }
 511         size_mb = (1024L * 1024L) / ccg->block_size;
 512         if (size_mb == 0) {
 513                 ccg->ccb_h.status = CAM_REQ_CMP_ERR;
 514                 return;
 515         }
 516         size_mb = ccg->volume_size / size_mb;
 517         if (size_mb > 1024 && extended) {
 518                 ccg->heads = 255;
 519                 ccg->secs_per_track = 63;
 520         } else {
 521                 ccg->heads = 64;
 522                 ccg->secs_per_track = 32;
 523         }
 524         secs_per_cylinder = ccg->heads * ccg->secs_per_track;
 525         if (secs_per_cylinder == 0) {
 526                 ccg->ccb_h.status = CAM_REQ_CMP_ERR;
 527                 return;
 528         }
 529         ccg->cylinders = ccg->volume_size / secs_per_cylinder;
 530         ccg->ccb_h.status = CAM_REQ_CMP;
 531 }