svn commit: r251837 - in head/sys/cam: . scsi

Scott Long scottl at FreeBSD.org
Mon Jun 17 08:57:10 UTC 2013


Author: scottl
Date: Mon Jun 17 08:57:09 2013
New Revision: 251837
URL: http://svnweb.freebsd.org/changeset/base/251837

Log:
  Add infrastructure for doing compatibility shims, as has been sorely
  needed for the last 10 years.  Far too much of the internal API is
  exposed, and every small adjustment causes applications to stop working.
  To kick this off, bump the API version to 0x17 as should have been done
  with r246713, but add shims to compensate.  Thanks to the shims, there
  should be no visible change in application behavior.
  
  I have plans to do a significant overhaul of the API to harnen it for
  the future, but until then, I welcome others to add shims for older
  versions of the API.
  
  Obtained from:	Netflix

Added:
  head/sys/cam/cam_compat.c   (contents, props changed)
  head/sys/cam/cam_compat.h   (contents, props changed)
Modified:
  head/sys/cam/cam_ccb.h
  head/sys/cam/cam_xpt.c
  head/sys/cam/scsi/scsi_pass.c

Modified: head/sys/cam/cam_ccb.h
==============================================================================
--- head/sys/cam/cam_ccb.h	Mon Jun 17 08:53:55 2013	(r251836)
+++ head/sys/cam/cam_ccb.h	Mon Jun 17 08:57:09 2013	(r251837)
@@ -541,7 +541,7 @@ struct ccb_dev_match {
 /*
  * Definitions for the path inquiry CCB fields.
  */
-#define CAM_VERSION	0x16	/* Hex value for current version */
+#define CAM_VERSION	0x17	/* Hex value for current version */
 
 typedef enum {
 	PI_MDP_ABLE	= 0x80,	/* Supports MDP message */

Added: head/sys/cam/cam_compat.c
==============================================================================
--- /dev/null	00:00:00 1970	(empty, because file is newly added)
+++ head/sys/cam/cam_compat.c	Mon Jun 17 08:57:09 2013	(r251837)
@@ -0,0 +1,89 @@
+/*-
+ * CAM ioctl compatibility shims
+ *
+ * Copyright (c) 2013 Scott Long
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions, and the following disclaimer,
+ *    without modification, immediately at the beginning of the file.
+ * 2. The name of the author may not be used to endorse or promote products
+ *    derived from this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
+ * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+ * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+ * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+ * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+ * SUCH DAMAGE.
+ *
+ */
+
+#include <sys/cdefs.h>
+__FBSDID("$FreeBSD$");
+
+#include <sys/param.h>
+#include <sys/systm.h>
+#include <sys/types.h>
+#include <sys/kernel.h>
+#include <sys/conf.h>
+#include <sys/fcntl.h>
+
+#include <sys/lock.h>
+#include <sys/mutex.h>
+#include <sys/sysctl.h>
+#include <sys/kthread.h>
+
+#include <cam/cam.h>
+#include <cam/cam_ccb.h>
+#include <cam/cam_compat.h>
+
+#include <cam/scsi/scsi_pass.h>
+
+#include "opt_cam.h"
+
+int
+cam_compat_ioctl(struct cdev *dev, u_long *cmd, caddr_t *addr, int *flag, struct thread *td)
+{
+	int error;
+
+	switch (*cmd) {
+	case CAMIOCOMMAND_0x16:
+	{
+		union ccb *ccb;
+
+		ccb = (union ccb *)*addr;
+		if (ccb->ccb_h.flags & CAM_SG_LIST_PHYS_0x16) {
+			ccb->ccb_h.flags &= ~CAM_SG_LIST_PHYS_0x16;
+			ccb->ccb_h.flags |= CAM_DATA_SG_PADDR;
+		}
+		if (ccb->ccb_h.flags & CAM_DATA_PHYS_0x16) {
+			ccb->ccb_h.flags &= ~CAM_DATA_PHYS_0x16;
+			ccb->ccb_h.flags |= CAM_DATA_PADDR;
+		}
+		if (ccb->ccb_h.flags & CAM_SCATTER_VALID_0x16) {
+			ccb->ccb_h.flags &= CAM_SCATTER_VALID_0x16;
+			ccb->ccb_h.flags |= CAM_DATA_SG;
+		}
+		*cmd = CAMIOCOMMAND;
+		error = EAGAIN;
+		break;
+	}
+	case CAMGETPASSTHRU_0x16:
+		*cmd = CAMGETPASSTHRU;
+		error = EAGAIN;
+		break;
+	default:
+		error = ENOTTY;
+	}
+
+	return (error);
+}

Added: head/sys/cam/cam_compat.h
==============================================================================
--- /dev/null	00:00:00 1970	(empty, because file is newly added)
+++ head/sys/cam/cam_compat.h	Mon Jun 17 08:57:09 2013	(r251837)
@@ -0,0 +1,48 @@
+/*-
+ * CAM ioctl compatibility shims
+ *
+ * Copyright (c) 2013 Scott Long
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions, and the following disclaimer,
+ *    without modification, immediately at the beginning of the file.
+ * 2. The name of the author may not be used to endorse or promote products
+ *    derived from this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
+ * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+ * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+ * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+ * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+ * SUCH DAMAGE.
+ *
+ * $FreeBSD$
+ */
+
+#ifndef _CAM_CAM_COMPAT_H
+#define _CAM_CAM_COMPAT_H
+
+int cam_compat_ioctl(struct cdev *dev, u_long *cmd, caddr_t *addr, int *flag, struct thread *td);
+
+/* Version 0x16 compatibility */
+#define CAM_VERSION_0x16	0x16
+
+/* The size of the union ccb didn't change when going to 0x17 */
+#define CAMIOCOMMAND_0x16	_IOWR(CAM_VERSION_0x16, 2, union ccb)
+#define CAMGETPASSTHRU_0x16	_IOWR(CAM_VERSION_0x16, 3, union ccb)
+
+#define CAM_SCATTER_VALID_0x16	0x10
+#define CAM_SG_LIST_PHYS_0x16	0x40000
+#define CAM_DATA_PHYS_0x16	0x20000
+
+#endif
+

Modified: head/sys/cam/cam_xpt.c
==============================================================================
--- head/sys/cam/cam_xpt.c	Mon Jun 17 08:53:55 2013	(r251836)
+++ head/sys/cam/cam_xpt.c	Mon Jun 17 08:57:09 2013	(r251837)
@@ -58,6 +58,7 @@ __FBSDID("$FreeBSD$");
 #include <cam/cam_xpt_periph.h>
 #include <cam/cam_xpt_internal.h>
 #include <cam/cam_debug.h>
+#include <cam/cam_compat.h>
 
 #include <cam/scsi/scsi_all.h>
 #include <cam/scsi/scsi_message.h>
@@ -180,6 +181,7 @@ PERIPHDRIVER_DECLARE(xpt, xpt_driver);
 static d_open_t xptopen;
 static d_close_t xptclose;
 static d_ioctl_t xptioctl;
+static d_ioctl_t xptdoioctl;
 
 static struct cdevsw xpt_cdevsw = {
 	.d_version =	D_VERSION,
@@ -395,6 +397,19 @@ xptioctl(struct cdev *dev, u_long cmd, c
 {
 	int error;
 
+	if ((error = xptdoioctl(dev, cmd, addr, flag, td)) == ENOTTY) {
+		error = cam_compat_ioctl(dev, &cmd, &addr, &flag, td);
+		if (error == EAGAIN)
+			return (xptdoioctl(dev, cmd, addr, flag, td));
+	}
+	return (error);
+}
+	
+static int
+xptdoioctl(struct cdev *dev, u_long cmd, caddr_t addr, int flag, struct thread *td)
+{
+	int error;
+
 	error = 0;
 
 	switch(cmd) {

Modified: head/sys/cam/scsi/scsi_pass.c
==============================================================================
--- head/sys/cam/scsi/scsi_pass.c	Mon Jun 17 08:53:55 2013	(r251836)
+++ head/sys/cam/scsi/scsi_pass.c	Mon Jun 17 08:57:09 2013	(r251837)
@@ -48,6 +48,7 @@ __FBSDID("$FreeBSD$");
 #include <cam/cam_xpt_periph.h>
 #include <cam/cam_debug.h>
 #include <cam/cam_sim.h>
+#include <cam/cam_compat.h>
 
 #include <cam/scsi/scsi_all.h>
 #include <cam/scsi/scsi_pass.h>
@@ -87,6 +88,7 @@ struct pass_softc {
 static	d_open_t	passopen;
 static	d_close_t	passclose;
 static	d_ioctl_t	passioctl;
+static	d_ioctl_t	passdoioctl;
 
 static	periph_init_t	passinit;
 static	periph_ctor_t	passregister;
@@ -575,6 +577,19 @@ passdone(struct cam_periph *periph, unio
 static int
 passioctl(struct cdev *dev, u_long cmd, caddr_t addr, int flag, struct thread *td)
 {
+	int error;
+
+	if ((error = passdoioctl(dev, cmd, addr, flag, td)) == ENOTTY) {
+		error = cam_compat_ioctl(dev, &cmd, &addr, &flag, td);
+		if (error == EAGAIN)
+			return (passdoioctl(dev, cmd, addr, flag, td));
+	}
+	return (error);
+}
+
+static int
+passdoioctl(struct cdev *dev, u_long cmd, caddr_t addr, int flag, struct thread *td)
+{
 	struct	cam_periph *periph;
 	struct	pass_softc *softc;
 	int	error;


More information about the svn-src-head mailing list