2 * SPDX-License-Identifier: BSD-2-Clause
4 * Copyright (c) 1997, 1998, 1999, 2002 Kenneth D. Merry.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. The name of the author may not be used to endorse or promote products
13 * derived from this software without specific prior written permission.
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 #include <sys/types.h>
29 #include <sys/param.h>
41 #include <cam/scsi/scsi_all.h>
42 #include <cam/cam_ccb.h>
43 #include <cam/scsi/scsi_pass.h>
47 static const char *nonrewind_devs[] = {
51 char cam_errbuf[CAM_ERRBUF_SIZE];
53 static struct cam_device *cam_real_open_device(const char *path, int flags,
54 struct cam_device *device,
55 const char *given_path,
56 const char *given_dev_name,
57 int given_unit_number);
58 static struct cam_device *cam_lookup_pass(const char *dev_name, int unit,
59 int flags, const char *given_path,
60 struct cam_device *device);
63 * Send a ccb to a passthrough device.
66 cam_send_ccb(struct cam_device *device, union ccb *ccb)
68 return(ioctl(device->fd, CAMIOCOMMAND, ccb));
72 * Malloc a CCB, zero out the header and set its path, target and lun ids.
75 cam_getccb(struct cam_device *dev)
79 ccb = calloc(1, sizeof(*ccb));
81 ccb->ccb_h.path_id = dev->path_id;
82 ccb->ccb_h.target_id = dev->target_id;
83 ccb->ccb_h.target_lun = dev->target_lun;
93 cam_freeccb(union ccb *ccb)
99 * Take a device name or path passed in by the user, and attempt to figure
100 * out the device name and unit number. Some possible device name formats are:
105 * Some peripheral drivers create separate device nodes with 'n' prefix for
106 * non-rewind operations. Currently only sa(4) tape driver has this feature.
107 * We extract pure peripheral name as device name for this special case.
109 * Input parameters: device name/path, length of devname string
110 * Output: device name, unit number
111 * Return values: returns 0 for success, -1 for failure
114 cam_get_device(const char *path, char *dev_name, int devnamelen, int *unit)
116 char *tmpstr, *tmpstr2;
122 snprintf(cam_errbuf, nitems(cam_errbuf),
123 "%s: device pathname was NULL", __func__);
128 * Resolve the given path to a real device path in case we are given
129 * an alias or other symbolic link. If the path cannot be resolved
130 * then try to parse it as is.
132 newpath = realpath(path, NULL);
134 newpath = strdup(path);
141 * Check to see whether we have an absolute pathname.
143 if (*tmpstr == '/') {
145 tmpstr = strrchr(tmpstr2, '/');
146 /* We know that tmpstr2 contains a '/', so strrchr can't fail */
147 assert(tmpstr != NULL && *tmpstr != '\0');
151 if (*tmpstr == '\0') {
152 snprintf(cam_errbuf, nitems(cam_errbuf),
153 "%s: no text after slash", __func__);
159 * Check to see whether the user has given us a nonrewound tape
162 if (*tmpstr == 'n' || *tmpstr == 'e') {
163 for (i = 0; i < sizeof(nonrewind_devs)/sizeof(char *); i++) {
164 int len = strlen(nonrewind_devs[i]);
165 if (strncmp(tmpstr + 1, nonrewind_devs[i], len) == 0) {
166 if (isdigit(tmpstr[len + 1])) {
175 * We should now have just a device name and unit number.
176 * That means that there must be at least 2 characters.
177 * If we only have 1, we don't have a valid device name.
179 if (strlen(tmpstr) < 2) {
180 snprintf(cam_errbuf, nitems(cam_errbuf),
181 "%s: must have both device name and unit number",
188 * If the first character of the string is a digit, then the user
189 * has probably given us all numbers. Point out the error.
191 if (isdigit(*tmpstr)) {
192 snprintf(cam_errbuf, nitems(cam_errbuf),
193 "%s: device name cannot begin with a number",
200 * At this point, if the last character of the string isn't a
201 * number, we know the user either didn't give us a device number,
202 * or he gave us a device name/number format we don't recognize.
204 if (!isdigit(tmpstr[strlen(tmpstr) - 1])) {
205 snprintf(cam_errbuf, nitems(cam_errbuf),
206 "%s: unable to find device unit number", __func__);
212 * Attempt to figure out where the device name ends and the unit
213 * number begins. As long as unit_offset is at least 1 less than
214 * the length of the string, we can still potentially have a device
215 * name at the front of the string. When we get to something that
216 * isn't a digit, we've hit the device name. Because of the check
217 * above, we know that this cannot happen when unit_offset == 1.
218 * Therefore it is okay to decrement unit_offset -- it won't cause
219 * us to go past the end of the character array.
221 for (unit_offset = 1;
222 (unit_offset < (strlen(tmpstr)))
223 && (isdigit(tmpstr[strlen(tmpstr) - unit_offset])); unit_offset++);
228 * Grab the unit number.
230 *unit = atoi(&tmpstr[strlen(tmpstr) - unit_offset]);
233 * Put a null in place of the first number of the unit number so
234 * that all we have left is the device name.
236 tmpstr[strlen(tmpstr) - unit_offset] = '\0';
238 strlcpy(dev_name, tmpstr, devnamelen);
240 /* Clean up allocated memory */
248 * Backwards compatible wrapper for the real open routine. This translates
249 * a pathname into a device name and unit number for use with the real open
253 cam_open_device(const char *path, int flags)
256 char dev_name[DEV_IDLEN + 1];
259 * cam_get_device() has already put an error message in cam_errbuf,
260 * so we don't need to.
262 if (cam_get_device(path, dev_name, sizeof(dev_name), &unit) == -1)
265 return(cam_lookup_pass(dev_name, unit, flags, path, NULL));
269 * Open the passthrough device for a given bus, target and lun, if the
270 * passthrough device exists.
273 cam_open_btl(path_id_t path_id, target_id_t target_id, lun_id_t target_lun,
274 int flags, struct cam_device *device)
277 struct periph_match_pattern *match_pat;
280 if ((fd = open(XPT_DEVICE, O_RDWR)) < 0) {
281 snprintf(cam_errbuf, nitems(cam_errbuf),
282 "%s: couldn't open %s\n%s: %s", __func__, XPT_DEVICE,
283 __func__, strerror(errno));
287 bzero(&ccb, sizeof(union ccb));
288 ccb.ccb_h.func_code = XPT_DEV_MATCH;
289 ccb.ccb_h.path_id = CAM_XPT_PATH_ID;
290 ccb.ccb_h.target_id = CAM_TARGET_WILDCARD;
291 ccb.ccb_h.target_lun = CAM_LUN_WILDCARD;
293 /* Setup the result buffer */
294 bufsize = sizeof(struct dev_match_result);
295 ccb.cdm.match_buf_len = bufsize;
296 ccb.cdm.matches = (struct dev_match_result *)malloc(bufsize);
297 if (ccb.cdm.matches == NULL) {
298 snprintf(cam_errbuf, nitems(cam_errbuf),
299 "%s: couldn't malloc match buffer", __func__);
303 ccb.cdm.num_matches = 0;
305 /* Setup the pattern buffer */
306 ccb.cdm.num_patterns = 1;
307 ccb.cdm.pattern_buf_len = sizeof(struct dev_match_pattern);
308 ccb.cdm.patterns = (struct dev_match_pattern *)malloc(
309 sizeof(struct dev_match_pattern));
310 if (ccb.cdm.patterns == NULL) {
311 snprintf(cam_errbuf, nitems(cam_errbuf),
312 "%s: couldn't malloc pattern buffer", __func__);
313 free(ccb.cdm.matches);
314 ccb.cdm.matches = NULL;
318 ccb.cdm.patterns[0].type = DEV_MATCH_PERIPH;
319 match_pat = &ccb.cdm.patterns[0].pattern.periph_pattern;
322 * We're looking for the passthrough device associated with this
323 * particular bus/target/lun.
325 sprintf(match_pat->periph_name, "pass");
326 match_pat->path_id = path_id;
327 match_pat->target_id = target_id;
328 match_pat->target_lun = target_lun;
329 /* Now set the flags to indicate what we're looking for. */
330 match_pat->flags = PERIPH_MATCH_PATH | PERIPH_MATCH_TARGET |
331 PERIPH_MATCH_LUN | PERIPH_MATCH_NAME;
333 if (ioctl(fd, CAMIOCOMMAND, &ccb) == -1) {
334 snprintf(cam_errbuf, nitems(cam_errbuf),
335 "%s: CAMIOCOMMAND ioctl failed\n"
336 "%s: %s", __func__, __func__, strerror(errno));
341 * Check for an outright error.
343 if ((ccb.ccb_h.status != CAM_REQ_CMP)
344 || ((ccb.cdm.status != CAM_DEV_MATCH_LAST)
345 && (ccb.cdm.status != CAM_DEV_MATCH_MORE))) {
346 snprintf(cam_errbuf, nitems(cam_errbuf),
347 "%s: CAM error %#x, CDM error %d "
348 "returned from XPT_DEV_MATCH ccb", __func__,
349 ccb.ccb_h.status, ccb.cdm.status);
353 if (ccb.cdm.status == CAM_DEV_MATCH_MORE) {
354 snprintf(cam_errbuf, nitems(cam_errbuf),
355 "%s: CDM reported more than one"
356 " passthrough device at %d:%d:%jx!!\n",
357 __func__, path_id, target_id, (uintmax_t)target_lun);
361 if (ccb.cdm.num_matches == 0) {
362 snprintf(cam_errbuf, nitems(cam_errbuf),
363 "%s: no passthrough device found at"
364 " %d:%d:%jx", __func__, path_id, target_id,
365 (uintmax_t)target_lun);
369 switch(ccb.cdm.matches[0].type) {
370 case DEV_MATCH_PERIPH: {
373 struct periph_match_result *periph_result;
375 periph_result = &ccb.cdm.matches[0].result.periph_result;
376 pass_unit = periph_result->unit_number;
377 free(ccb.cdm.matches);
378 ccb.cdm.matches = NULL;
379 free(ccb.cdm.patterns);
380 ccb.cdm.patterns = NULL;
382 sprintf(dev_path, "/dev/pass%d", pass_unit);
383 return(cam_real_open_device(dev_path, flags, device, NULL,
385 break; /* NOTREACHED */
388 snprintf(cam_errbuf, nitems(cam_errbuf),
389 "%s: asked for a peripheral match, but"
390 " got a bus or device match", __func__);
392 break; /* NOTREACHED */
396 free(ccb.cdm.matches);
397 ccb.cdm.matches = NULL;
398 free(ccb.cdm.patterns);
399 ccb.cdm.patterns = NULL;
405 cam_open_spec_device(const char *dev_name, int unit, int flags,
406 struct cam_device *device)
408 return(cam_lookup_pass(dev_name, unit, flags, NULL, device));
412 cam_open_pass(const char *path, int flags, struct cam_device *device)
414 return(cam_real_open_device(path, flags, device, path, NULL, 0));
417 static struct cam_device *
418 cam_lookup_pass(const char *dev_name, int unit, int flags,
419 const char *given_path, struct cam_device *device)
426 * The flags argument above only applies to the actual passthrough
427 * device open, not our open of the given device to find the
428 * passthrough device.
430 if ((fd = open(XPT_DEVICE, O_RDWR)) < 0) {
431 snprintf(cam_errbuf, nitems(cam_errbuf),
432 "%s: couldn't open %s\n%s: %s", __func__, XPT_DEVICE,
433 __func__, strerror(errno));
437 /* This isn't strictly necessary for the GETPASSTHRU ioctl. */
438 ccb.ccb_h.func_code = XPT_GDEVLIST;
440 /* These two are necessary for the GETPASSTHRU ioctl to work. */
441 strlcpy(ccb.cgdl.periph_name, dev_name, sizeof(ccb.cgdl.periph_name));
442 ccb.cgdl.unit_number = unit;
445 * Attempt to get the passthrough device. This ioctl will fail if
446 * the device name is null, if the device doesn't exist, or if the
447 * passthrough driver isn't in the kernel.
449 if (ioctl(fd, CAMGETPASSTHRU, &ccb) == -1) {
453 * If we get ENOENT from the transport layer version of
454 * the CAMGETPASSTHRU ioctl, it means one of two things:
455 * either the device name/unit number passed in doesn't
456 * exist, or the passthrough driver isn't in the kernel.
458 if (errno == ENOENT) {
459 snprintf(tmpstr, sizeof(tmpstr),
460 "\n%s: either the pass driver isn't in "
461 "your kernel\n%s: or %s%d doesn't exist",
462 __func__, __func__, dev_name, unit);
464 snprintf(cam_errbuf, nitems(cam_errbuf),
465 "%s: CAMGETPASSTHRU ioctl failed\n"
466 "%s: %s%s", __func__, __func__, strerror(errno),
467 (errno == ENOENT) ? tmpstr : "");
476 * If the ioctl returned the right status, but we got an error back
477 * in the ccb, that means that the kernel found the device the user
478 * passed in, but was unable to find the passthrough device for
479 * the device the user gave us.
481 if (ccb.cgdl.status == CAM_GDEVLIST_ERROR) {
482 snprintf(cam_errbuf, nitems(cam_errbuf),
483 "%s: device %s%d does not exist!",
484 __func__, dev_name, unit);
488 sprintf(dev_path, "/dev/%s%d", ccb.cgdl.periph_name,
489 ccb.cgdl.unit_number);
491 return(cam_real_open_device(dev_path, flags, device, NULL,
496 * Open a given device. The path argument isn't strictly necessary, but it
497 * is copied into the cam_device structure as a convenience to the user.
499 static struct cam_device *
500 cam_real_open_device(const char *path, int flags, struct cam_device *device,
501 const char *given_path, const char *given_dev_name,
502 int given_unit_number)
505 int fd = -1, malloced_device = 0;
508 * See if the user wants us to malloc a device for him.
510 if (device == NULL) {
511 if ((device = (struct cam_device *)malloc(
512 sizeof(struct cam_device))) == NULL) {
513 snprintf(cam_errbuf, nitems(cam_errbuf),
514 "%s: device structure malloc"
515 " failed\n%s: %s", __func__, __func__,
524 * If the user passed in a path, save it for him.
526 if (given_path != NULL)
527 strlcpy(device->device_path, given_path,
528 sizeof(device->device_path));
530 device->device_path[0] = '\0';
533 * If the user passed in a device name and unit number pair, save
536 if (given_dev_name != NULL)
537 strlcpy(device->given_dev_name, given_dev_name,
538 sizeof(device->given_dev_name));
540 device->given_dev_name[0] = '\0';
541 device->given_unit_number = given_unit_number;
543 if ((fd = open(path, flags)) < 0) {
544 snprintf(cam_errbuf, nitems(cam_errbuf),
545 "%s: couldn't open passthrough device %s\n"
546 "%s: %s", __func__, path, __func__,
553 bzero(&ccb, sizeof(union ccb));
556 * Unlike the transport layer version of the GETPASSTHRU ioctl,
557 * we don't have to set any fields.
559 ccb.ccb_h.func_code = XPT_GDEVLIST;
562 * We're only doing this to get some information on the device in
563 * question. Otherwise, we'd have to pass in yet another
564 * parameter: the passthrough driver unit number.
566 if (ioctl(fd, CAMGETPASSTHRU, &ccb) == -1) {
568 * At this point we know the passthrough device must exist
569 * because we just opened it above. The only way this
570 * ioctl can fail is if the ccb size is wrong.
572 snprintf(cam_errbuf, nitems(cam_errbuf),
573 "%s: CAMGETPASSTHRU ioctl failed\n"
574 "%s: %s", __func__, __func__, strerror(errno));
579 * If the ioctl returned the right status, but we got an error back
580 * in the ccb, that means that the kernel found the device the user
581 * passed in, but was unable to find the passthrough device for
582 * the device the user gave us.
584 if (ccb.cgdl.status == CAM_GDEVLIST_ERROR) {
585 snprintf(cam_errbuf, nitems(cam_errbuf),
586 "%s: passthrough device does not exist!", __func__);
590 device->dev_unit_num = ccb.cgdl.unit_number;
591 strlcpy(device->device_name, ccb.cgdl.periph_name,
592 sizeof(device->device_name));
593 device->path_id = ccb.ccb_h.path_id;
594 device->target_id = ccb.ccb_h.target_id;
595 device->target_lun = ccb.ccb_h.target_lun;
597 ccb.ccb_h.func_code = XPT_PATH_INQ;
598 if (ioctl(fd, CAMIOCOMMAND, &ccb) == -1) {
599 snprintf(cam_errbuf, nitems(cam_errbuf),
600 "%s: Path Inquiry CCB failed\n"
601 "%s: %s", __func__, __func__, strerror(errno));
604 strlcpy(device->sim_name, ccb.cpi.dev_name, sizeof(device->sim_name));
605 device->sim_unit_number = ccb.cpi.unit_number;
606 device->bus_id = ccb.cpi.bus_id;
609 * It doesn't really matter what is in the payload for a getdev
610 * CCB, the kernel doesn't look at it.
612 ccb.ccb_h.func_code = XPT_GDEV_TYPE;
613 if (ioctl(fd, CAMIOCOMMAND, &ccb) == -1) {
614 snprintf(cam_errbuf, nitems(cam_errbuf),
615 "%s: Get Device Type CCB failed\n"
616 "%s: %s", __func__, __func__, strerror(errno));
619 device->pd_type = SID_TYPE(&ccb.cgd.inq_data);
620 bcopy(&ccb.cgd.inq_data, &device->inq_data,
621 sizeof(struct scsi_inquiry_data));
622 device->serial_num_len = ccb.cgd.serial_num_len;
623 bcopy(&ccb.cgd.serial_num, &device->serial_num, device->serial_num_len);
626 * Zero the payload, the kernel does look at the flags.
628 CCB_CLEAR_ALL_EXCEPT_HDR(&ccb.cts);
631 * Get transfer settings for this device.
633 ccb.ccb_h.func_code = XPT_GET_TRAN_SETTINGS;
635 ccb.cts.type = CTS_TYPE_CURRENT_SETTINGS;
637 if (ioctl(fd, CAMIOCOMMAND, &ccb) == -1) {
638 snprintf(cam_errbuf, nitems(cam_errbuf),
639 "%s: Get Transfer Settings CCB failed\n"
640 "%s: %s", __func__, __func__, strerror(errno));
643 if (ccb.cts.transport == XPORT_SPI) {
644 struct ccb_trans_settings_spi *spi =
645 &ccb.cts.xport_specific.spi;
646 device->sync_period = spi->sync_period;
647 device->sync_offset = spi->sync_offset;
648 device->bus_width = spi->bus_width;
650 device->sync_period = 0;
651 device->sync_offset = 0;
652 device->bus_width = 0;
669 cam_close_device(struct cam_device *dev)
674 cam_close_spec_device(dev);
680 cam_close_spec_device(struct cam_device *dev)
692 cam_path_string(struct cam_device *dev, char *str, int len)
695 snprintf(str, len, "No path");
699 snprintf(str, len, "(%s%d:%s%d:%d:%d:%jx): ",
700 (dev->device_name[0] != '\0') ? dev->device_name : "pass",
702 (dev->sim_name[0] != '\0') ? dev->sim_name : "unknown",
703 dev->sim_unit_number,
706 (uintmax_t)dev->target_lun);
712 * Malloc/duplicate a CAM device structure.
715 cam_device_dup(struct cam_device *device)
717 struct cam_device *newdev;
719 if (device == NULL) {
720 snprintf(cam_errbuf, nitems(cam_errbuf),
721 "%s: device is NULL", __func__);
725 newdev = malloc(sizeof(struct cam_device));
726 if (newdev == NULL) {
727 snprintf(cam_errbuf, nitems(cam_errbuf),
728 "%s: couldn't malloc CAM device structure", __func__);
732 bcopy(device, newdev, sizeof(struct cam_device));
738 * Copy a CAM device structure.
741 cam_device_copy(struct cam_device *src, struct cam_device *dst)
745 snprintf(cam_errbuf, nitems(cam_errbuf),
746 "%s: source device struct was NULL", __func__);
751 snprintf(cam_errbuf, nitems(cam_errbuf),
752 "%s: destination device struct was NULL", __func__);
756 bcopy(src, dst, sizeof(struct cam_device));