Skip to contentSkip to conversation

USB: storage: use sg_miter_* APIs to access scsi buffer

PATCH In review Ming Lei 2 participants 3 messages Oct 29, 2013 – Nov 1, 2013

Subsystems (2)
lore
Share & tools
lore

Ming Lei

author
#0 lore raw

PATCH 2/2 USB: storage: use sg_miter_* APIs to access scsi buffer

We have sg_miter_* APIs for accessing scsi sg buffer, so use them to make code clean and bug free.

Cc Matthew Dharm <[email protected]>
Cc Alan Stern <[email protected]>
Cc Greg Kroah-Hartman <[email protected]>
---
 drivers/usb/storage/protocol.c |   82 ++++++++++++++--------------------------
 1 file changed, 28 insertions(+), 54 deletions(-)
drivers/usb/storage/protocol.c +28 -54
index 5dfb4c3..01697e5 100644
@@ -135,69 +135,43 @@ unsigned int usb_stor_access_xfer_buf(unsigned char *buffer,
 	unsigned int buflen, struct scsi_cmnd *srb, struct scatterlist **sgptr,
 	unsigned int *offset, enum xfer_buf_dir dir)
 {
-	unsigned int cnt;
+	unsigned int cnt = 0;
 	struct scatterlist *sg = *sgptr;
+	struct sg_mapping_iter miter;
+	unsigned int nents = scsi_sg_count(srb);
 
-	/* We have to go through the list one entry
-	 * at a time.  Each s-g entry contains some number of pages, and
-	 * each page has to be kmap()'ed separately.  If the page is already
-	 * in kernel-addressable memory then kmap() will return its address.
-	 * If the page is not directly accessible -- such as a user buffer
-	 * located in high memory -- then kmap() will map it to a temporary
-	 * position in the kernel's virtual address space.
-	 */
-
-	if (!sg)
+	if (sg)
+		nents -= sg - scsi_sglist(srb);
+	else
 		sg = scsi_sglist(srb);
 
-	/* This loop handles a single s-g list entry, which may
-	 * include multiple pages.  Find the initial page structure
-	 * and the starting offset within the page, and update
-	 * the *offset and **sgptr values for the next loop.
-	 */
-	cnt = 0;
-	while (cnt < buflen && sg) {
-		struct page *page = sg_page(sg) +
-				((sg->offset + *offset) >> PAGE_SHIFT);
-		unsigned int poff = (sg->offset + *offset) & (PAGE_SIZE-1);
-		unsigned int sglen = sg->length - *offset;
-
-		if (sglen > buflen - cnt) {
-
-			/* Transfer ends within this s-g entry */
-			sglen = buflen - cnt;
-			*offset += sglen;
-		} else {
+	if (dir == FROM_XFER_BUF)
+		sg_miter_start(&miter, sg, nents, SG_MITER_FROM_SG);
+	else
+		sg_miter_start(&miter, sg, nents, SG_MITER_TO_SG);
 
-			/* Transfer continues to next s-g entry */
-			*offset = 0;
-			sg = sg_next(sg);
-		}
+	if (!sg_miter_skip(&miter, *offset))
+		return cnt;
+
+	while (sg_miter_next(&miter) && cnt < buflen) {
+		unsigned int len = min(miter.length, buflen - cnt);
+
+		if (dir == FROM_XFER_BUF)
+			memcpy(buffer + cnt, miter.addr, len);
+		else
+			memcpy(miter.addr, buffer + cnt, len);
 
-		/* Transfer the data for all the pages in this
-			* s-g entry.  For each page: call kmap(), do the
-			* transfer, and call kunmap() immediately after. */
-		while (sglen > 0) {
-			unsigned int plen = min(sglen, (unsigned int)
-					PAGE_SIZE - poff);
-			unsigned char *ptr = kmap(page);
-
-			if (dir == TO_XFER_BUF)
-				memcpy(ptr + poff, buffer + cnt, plen);
-			else
-				memcpy(buffer + cnt, ptr + poff, plen);
-			kunmap(page);
-
-			/* Start at the beginning of the next page */
-			poff = 0;
-			++page;
-			cnt += plen;
-			sglen -= plen;
+		if (*offset + len < miter.piter.sg->length) {
+			*offset += len;
+			*sgptr = miter.piter.sg;
+		} else {
+			*offset = 0;
+			*sgptr = sg_next(miter.piter.sg);
 		}
+		cnt += len;
 	}
-	*sgptr = sg;
+	sg_miter_stop(&miter);
 
-	/* Return the amount actually transferred */
 	return cnt;
 }
 EXPORT_SYMBOL_GPL(usb_stor_access_xfer_buf);
Signature · 1 line
1.7.9.5
maintainer
#1 lore raw
Quoted 2 lines · Ming Lei

We have sg_miter_* APIs for accessing scsi sg buffer, so use them to make code clean and bug free.

Hmmm. You could simply call sg_copy_buffer, if you didn't mind the quadratic penalty for the sg_miter_skip operations.

Quoted 14 lines
drivers/usb/storage/protocol.c +3 -3
@@ -135,69 +135,43 @@ unsigned int usb_stor_access_xfer_buf(unsigned char *buffer,
 	unsigned int buflen, struct scsi_cmnd *srb, struct scatterlist **sgptr,
 	unsigned int *offset, enum xfer_buf_dir dir)
 {
-	unsigned int cnt;
+	unsigned int cnt = 0;
 	struct scatterlist *sg = *sgptr;
+	struct sg_mapping_iter miter;
+	unsigned int nents = scsi_sg_count(srb);
 
-	/* We have to go through the list one entry
-	 * at a time.  Each s-g entry contains some number of pages, and

drivers/usb/storage/protocol.c unsigned int usb_stor_access_xfer_buf(unsigned char *buffer, · line 144

Quoted 10 lines
drivers/usb/storage/protocol.c +2 -8
-	 * each page has to be kmap()'ed separately.  If the page is already
-	 * in kernel-addressable memory then kmap() will return its address.
-	 * If the page is not directly accessible -- such as a user buffer
-	 * located in high memory -- then kmap() will map it to a temporary
-	 * position in the kernel's virtual address space.
-	 */
-
-	if (!sg)
+	if (sg)
+		nents -= sg - scsi_sglist(srb);

This is definitely wrong. Scatterlist entries are not always stored in a linear array. To do this properly, you would have to make the caller keep track of the current value of nents.

Or better yet, have the caller store and pass the sg_mapping_iter structure rather than sgptr and offset.

Quoted 15 lines
drivers/usb/storage/protocol.c +1 -12
+	else
 		sg = scsi_sglist(srb);
 
-	/* This loop handles a single s-g list entry, which may
-	 * include multiple pages.  Find the initial page structure
-	 * and the starting offset within the page, and update
-	 * the *offset and **sgptr values for the next loop.
-	 */
-	cnt = 0;
-	while (cnt < buflen && sg) {
-		struct page *page = sg_page(sg) +
-				((sg->offset + *offset) >> PAGE_SHIFT);
-		unsigned int poff = (sg->offset + *offset) & (PAGE_SIZE-1);
-		unsigned int sglen = sg->length - *offset;
-

drivers/usb/storage/protocol.c unsigned int usb_stor_access_xfer_buf(unsigned char *buffer, · line 151

Quoted 10 lines
drivers/usb/storage/protocol.c +4 -6
-		if (sglen > buflen - cnt) {
-
-			/* Transfer ends within this s-g entry */
-			sglen = buflen - cnt;
-			*offset += sglen;
-		} else {
+	if (dir == FROM_XFER_BUF)
+		sg_miter_start(&miter, sg, nents, SG_MITER_FROM_SG);
+	else
+		sg_miter_start(&miter, sg, nents, SG_MITER_TO_SG);

I find this style somewhat annoying. Maybe the compiler is smart enough to optimize it, maybe not. In any case, I would prefer to see

	if (dir == FROM_XFER_BUF)
		sgdir = SG_MITER_FROM_SG;
	else
		sgdir = SG_MITER_TO_SG;
	sg_miter_start(&miter, nents, sgdir);

Or even:

	sg_miter_start(&miter, nents, (dir == FROM_XFER_BUF ?
			SG_MITER_FROM_SG : SG_MITER_TO_SG));
Quoted 37 lines
drivers/usb/storage/protocol.c +13 -23
-			/* Transfer continues to next s-g entry */
-			*offset = 0;
-			sg = sg_next(sg);
-		}
+	if (!sg_miter_skip(&miter, *offset))
+		return cnt;
+
+	while (sg_miter_next(&miter) && cnt < buflen) {
+		unsigned int len = min(miter.length, buflen - cnt);
+
+		if (dir == FROM_XFER_BUF)
+			memcpy(buffer + cnt, miter.addr, len);
+		else
+			memcpy(miter.addr, buffer + cnt, len);
 
-		/* Transfer the data for all the pages in this
-			* s-g entry.  For each page: call kmap(), do the
-			* transfer, and call kunmap() immediately after. */
-		while (sglen > 0) {
-			unsigned int plen = min(sglen, (unsigned int)
-					PAGE_SIZE - poff);
-			unsigned char *ptr = kmap(page);
-
-			if (dir == TO_XFER_BUF)
-				memcpy(ptr + poff, buffer + cnt, plen);
-			else
-				memcpy(buffer + cnt, ptr + poff, plen);
-			kunmap(page);
-
-			/* Start at the beginning of the next page */
-			poff = 0;
-			++page;
-			cnt += plen;
-			sglen -= plen;
+		if (*offset + len < miter.piter.sg->length) {
+			*offset += len;
+			*sgptr = miter.piter.sg;

drivers/usb/storage/protocol.c unsigned int usb_stor_access_xfer_buf(unsigned char *buffer, · line 200

Quoted 10 lines
drivers/usb/storage/protocol.c +5 -2
+		} else {
+			*offset = 0;
+			*sgptr = sg_next(miter.piter.sg);
 		}
+		cnt += len;
 	}
-	*sgptr = sg;
+	sg_miter_stop(&miter);
 
-	/* Return the amount actually transferred */

Why remove this comment?

drivers/usb/storage/protocol.c unsigned int usb_stor_access_xfer_buf(unsigned char *buffer, · line 177

Quoted 3 lines
drivers/usb/storage/protocol.c +0 -0
 	return cnt;
 }
 EXPORT_SYMBOL_GPL(usb_stor_access_xfer_buf);

Alan Stern

author
#2 lore raw
Quoted 7 lines · Alan Stern
Quoted 2 lines · Ming Lei

We have sg_miter_* APIs for accessing scsi sg buffer, so use them to make code clean and bug free.

Hmmm. You could simply call sg_copy_buffer, if you didn't mind the quadratic penalty for the sg_miter_skip operations.

I don't want to change all current callers now.

Quoted 30 lines
Quoted 15 lines
drivers/usb/storage/protocol.c +3 -3
@@ -135,69 +135,43 @@ unsigned int usb_stor_access_xfer_buf(unsigned char *buffer,
      unsigned int buflen, struct scsi_cmnd *srb, struct scatterlist **sgptr,
      unsigned int *offset, enum xfer_buf_dir dir)
 {
-     unsigned int cnt;
+     unsigned int cnt = 0;
      struct scatterlist *sg = *sgptr;
+     struct sg_mapping_iter miter;
+     unsigned int nents = scsi_sg_count(srb);
 
-     /* We have to go through the list one entry
-      * at a time.  Each s-g entry contains some number of pages, and

drivers/usb/storage/protocol.c unsigned int usb_stor_access_xfer_buf(unsigned char *buffer, · line 144

Quoted 10 lines
drivers/usb/storage/protocol.c +2 -8
-      * each page has to be kmap()'ed separately.  If the page is already
-      * in kernel-addressable memory then kmap() will return its address.
-      * If the page is not directly accessible -- such as a user buffer
-      * located in high memory -- then kmap() will map it to a temporary
-      * position in the kernel's virtual address space.
-      */
-
-     if (!sg)
+     if (sg)
+             nents -= sg - scsi_sglist(srb);

This is definitely wrong. Scatterlist entries are not always stored in a linear array. To do this properly, you would have to make the caller keep track of the current value of nents.

Quoted 2 lines

Or better yet, have the caller store and pass the sg_mapping_iter structure rather than sgptr and offset.

You are right, but looks we can use sg_nents(), which is easier, :-)

Quoted 36 lines
Quoted 16 lines
drivers/usb/storage/protocol.c +1 -12
+     else
              sg = scsi_sglist(srb);
 
-     /* This loop handles a single s-g list entry, which may
-      * include multiple pages.  Find the initial page structure
-      * and the starting offset within the page, and update
-      * the *offset and **sgptr values for the next loop.
-      */
-     cnt = 0;
-     while (cnt < buflen && sg) {
-             struct page *page = sg_page(sg) +
-                             ((sg->offset + *offset) >> PAGE_SHIFT);
-             unsigned int poff = (sg->offset + *offset) & (PAGE_SIZE-1);
-             unsigned int sglen = sg->length - *offset;
-

drivers/usb/storage/protocol.c unsigned int usb_stor_access_xfer_buf(unsigned char *buffer, · line 151

Quoted 10 lines
drivers/usb/storage/protocol.c +4 -6
-             if (sglen > buflen - cnt) {
-
-                     /* Transfer ends within this s-g entry */
-                     sglen = buflen - cnt;
-                     *offset += sglen;
-             } else {
+     if (dir == FROM_XFER_BUF)
+             sg_miter_start(&miter, sg, nents, SG_MITER_FROM_SG);
+     else
+             sg_miter_start(&miter, sg, nents, SG_MITER_TO_SG);

I find this style somewhat annoying. Maybe the compiler is smart enough to optimize it, maybe not. In any case, I would prefer to see

        if (dir == FROM_XFER_BUF)
                sgdir = SG_MITER_FROM_SG;
        else
                sgdir = SG_MITER_TO_SG;
        sg_miter_start(&miter, nents, sgdir);
Quoted 4 lines

Or even:

        sg_miter_start(&miter, nents, (dir == FROM_XFER_BUF ?
                        SG_MITER_FROM_SG : SG_MITER_TO_SG));

Looks the above is fine.

Quoted 47 lines
Quoted 47 lines
drivers/usb/storage/protocol.c +18 -24
-                     /* Transfer continues to next s-g entry */
-                     *offset = 0;
-                     sg = sg_next(sg);
-             }
+     if (!sg_miter_skip(&miter, *offset))
+             return cnt;
+
+     while (sg_miter_next(&miter) && cnt < buflen) {
+             unsigned int len = min(miter.length, buflen - cnt);
+
+             if (dir == FROM_XFER_BUF)
+                     memcpy(buffer + cnt, miter.addr, len);
+             else
+                     memcpy(miter.addr, buffer + cnt, len);
 
-             /* Transfer the data for all the pages in this
-                     * s-g entry.  For each page: call kmap(), do the
-                     * transfer, and call kunmap() immediately after. */
-             while (sglen > 0) {
-                     unsigned int plen = min(sglen, (unsigned int)
-                                     PAGE_SIZE - poff);
-                     unsigned char *ptr = kmap(page);
-
-                     if (dir == TO_XFER_BUF)
-                             memcpy(ptr + poff, buffer + cnt, plen);
-                     else
-                             memcpy(buffer + cnt, ptr + poff, plen);
-                     kunmap(page);
-
-                     /* Start at the beginning of the next page */
-                     poff = 0;
-                     ++page;
-                     cnt += plen;
-                     sglen -= plen;
+             if (*offset + len < miter.piter.sg->length) {
+                     *offset += len;
+                     *sgptr = miter.piter.sg;
+             } else {
+                     *offset = 0;
+                     *sgptr = sg_next(miter.piter.sg);
              }
+             cnt += len;
      }
-     *sgptr = sg;
+     sg_miter_stop(&miter);
 
Quoted 3 lines

drivers/usb/storage/protocol.c unsigned int usb_stor_access_xfer_buf(unsigned char *buffer, · line 200

Quoted 1 line
drivers/usb/storage/protocol.c +0 -1
-     /* Return the amount actually transferred */

Why remove this comment?

With this patch, the comment becomes uncessary since the code is very simple and it is obvious.

Thanks,
--
Ming Lei