From: "Christian König" <christian.koenig@amd.com>
To: Logan Gunthorpe <logang@deltatee.com>,
<linux-kernel@vger.kernel.org>, <linux-crypto@vger.kernel.org>,
<linux-media@vger.kernel.org>, <dri-devel@lists.freedesktop.org>,
<intel-gfx@lists.freedesktop.org>, <linux-raid@vger.kernel.org>,
<linux-mmc@vger.kernel.org>, <linux-nvdimm@ml01.01.org>,
<linux-scsi@vger.kernel.org>, <open-iscsi@googlegroups.com>,
<megaraidlinux.pdl@broadcom.com>, <sparmaintainer@unisys.com>,
<devel@driverdev.osuosl.org>, <target-devel@vger.kernel.org>,
<netdev@vger.kernel.org>, <linux-rdma@vger.kernel.org>,
<dm-devel@redhat.com>
Cc: Jens Axboe <axboe@kernel.dk>,
"James E.J. Bottomley" <jejb@linux.vnet.ibm.com>,
"Martin K. Petersen" <martin.petersen@oracle.com>,
Matthew Wilcox <mawilcox@microsoft.com>,
Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
Ross Zwisler <ross.zwisler@linux.intel.com>,
Dan Williams <dan.j.williams@intel.com>,
Stephen Bates <sbates@raithlin.com>,
Christoph Hellwig <hch@lst.de>
Subject: Re: [PATCH v2 01/21] scatterlist: Introduce sg_map helper functions
Date: Wed, 26 Apr 2017 10:59:17 +0200 [thread overview]
Message-ID: <5dfc5bf5-482c-b5bb-029c-7cee80925f37@amd.com> (raw)
In-Reply-To: <1493144468-22493-2-git-send-email-logang@deltatee.com>
Am 25.04.2017 um 20:20 schrieb Logan Gunthorpe:
> This patch introduces functions which kmap the pages inside an sgl.
> These functions replace a common pattern of kmap(sg_page(sg)) that is
> used in more than 50 places within the kernel.
>
> The motivation for this work is to eventually safely support sgls that
> contain io memory. In order for that to work, any access to the contents
> of an iomem SGL will need to be done with iomemcpy or hit some warning.
> (The exact details of how this will work have yet to be worked out.)
> Having all the kmaps in one place is just a first step in that
> direction. Additionally, seeing this helps cut down the users of sg_page,
> it should make any effort to go to struct-page-less DMAs a little
> easier (should that idea ever swing back into favour again).
>
> A flags option is added to select between a regular or atomic mapping so
> these functions can replace kmap(sg_page or kmap_atomic(sg_page.
> Future work may expand this to have flags for using page_address or
> vmap. We include a flag to require the function not to fail to
> support legacy code that has no easy error path. Much further in the
> future, there may be a flag to allocate memory and copy the data
> from/to iomem.
>
> We also add the semantic that sg_map can fail to create a mapping,
> despite the fact that the current code this is replacing is assumed to
> never fail and the current version of these functions cannot fail. This
> is to support iomem which may either have to fail to create the mapping or
> allocate memory as a bounce buffer which itself can fail.
>
> Also, in terms of cleanup, a few of the existing kmap(sg_page) users
> play things a bit loose in terms of whether they apply sg->offset
> so using these helper functions should help avoid such issues.
>
> Signed-off-by: Logan Gunthorpe <logang@deltatee.com>
> ---
Good to know that somebody is working on this. Those problems troubled
us as well.
Patch is Acked-by: Christian König <christian.koenig@amd.com>.
Regards,
Christian.
> include/linux/scatterlist.h | 85 +++++++++++++++++++++++++++++++++++++++++++++
> 1 file changed, 85 insertions(+)
>
> diff --git a/include/linux/scatterlist.h b/include/linux/scatterlist.h
> index cb3c8fe..fad170b 100644
> --- a/include/linux/scatterlist.h
> +++ b/include/linux/scatterlist.h
> @@ -5,6 +5,7 @@
> #include <linux/types.h>
> #include <linux/bug.h>
> #include <linux/mm.h>
> +#include <linux/highmem.h>
> #include <asm/io.h>
>
> struct scatterlist {
> @@ -126,6 +127,90 @@ static inline struct page *sg_page(struct scatterlist *sg)
> return (struct page *)((sg)->page_link & ~0x3);
> }
>
> +#define SG_KMAP (1 << 0) /* create a mapping with kmap */
> +#define SG_KMAP_ATOMIC (1 << 1) /* create a mapping with kmap_atomic */
> +#define SG_MAP_MUST_NOT_FAIL (1 << 2) /* indicate sg_map should not fail */
> +
> +/**
> + * sg_map - kmap a page inside an sgl
> + * @sg: SG entry
> + * @offset: Offset into entry
> + * @flags: Flags for creating the mapping
> + *
> + * Description:
> + * Use this function to map a page in the scatterlist at the specified
> + * offset. sg->offset is already added for you. Note: the semantics of
> + * this function are that it may fail. Thus, its output should be checked
> + * with IS_ERR and PTR_ERR. Otherwise, a pointer to the specified offset
> + * in the mapped page is returned.
> + *
> + * Flags can be any of:
> + * * SG_KMAP - Use kmap to create the mapping
> + * * SG_KMAP_ATOMIC - Use kmap_atomic to map the page atommically.
> + * Thus, the rules of that function apply: the
> + * cpu may not sleep until it is unmaped.
> + * * SG_MAP_MUST_NOT_FAIL - Indicate that sg_map must not fail.
> + * If it does, it will issue a BUG_ON instead.
> + * This is intended for legacy code only, it
> + * is not to be used in new code.
> + *
> + * Also, consider carefully whether this function is appropriate. It is
> + * largely not recommended for new code and if the sgl came from another
> + * subsystem and you don't know what kind of memory might be in the list
> + * then you definitely should not call it. Non-mappable memory may be in
> + * the sgl and thus this function may fail unexpectedly. Consider using
> + * sg_copy_to_buffer instead.
> + **/
> +static inline void *sg_map(struct scatterlist *sg, size_t offset, int flags)
> +{
> + struct page *pg;
> + unsigned int pg_off;
> + void *ret;
> +
> + offset += sg->offset;
> + pg = nth_page(sg_page(sg), offset >> PAGE_SHIFT);
> + pg_off = offset_in_page(offset);
> +
> + if (flags & SG_KMAP_ATOMIC)
> + ret = kmap_atomic(pg) + pg_off;
> + else if (flags & SG_KMAP)
> + ret = kmap(pg) + pg_off;
> + else
> + ret = ERR_PTR(-EINVAL);
> +
> + /*
> + * In theory, this can't happen yet. Once we start adding
> + * unmapable memory, it also shouldn't happen unless developers
> + * start putting unmappable struct pages in sgls and passing
> + * it to code that doesn't support it.
> + */
> + BUG_ON(flags & SG_MAP_MUST_NOT_FAIL && IS_ERR(ret));
> +
> + return ret;
> +}
> +
> +/**
> + * sg_unmap - unmap a page that was mapped with sg_map_offset
> + * @sg: SG entry
> + * @addr: address returned by sg_map_offset
> + * @offset: Offset into entry (same as specified for sg_map)
> + * @flags: Flags, which are the same specified for sg_map
> + *
> + * Description:
> + * Unmap the page that was mapped with sg_map_offset
> + **/
> +static inline void sg_unmap(struct scatterlist *sg, void *addr,
> + size_t offset, int flags)
> +{
> + struct page *pg = nth_page(sg_page(sg), offset >> PAGE_SHIFT);
> + unsigned int pg_off = offset_in_page(offset);
> +
> + if (flags & SG_KMAP_ATOMIC)
> + kunmap_atomic(addr - sg->offset - pg_off);
> + else if (flags & SG_KMAP)
> + kunmap(pg);
> +}
> +
> /**
> * sg_set_buf - Set sg entry to point at given data
> * @sg: SG entry
next prev parent reply other threads:[~2017-04-26 9:01 UTC|newest]
Thread overview: 46+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-04-25 18:20 [PATCH v2 00/21] Introduce common scatterlist map function Logan Gunthorpe
2017-04-25 18:20 ` [PATCH v2 01/21] scatterlist: Introduce sg_map helper functions Logan Gunthorpe
2017-04-26 7:44 ` Christoph Hellwig
2017-04-26 18:11 ` Logan Gunthorpe
2017-04-27 6:53 ` Christoph Hellwig
2017-04-27 15:27 ` Jason Gunthorpe
2017-04-27 15:57 ` Logan Gunthorpe
2017-04-27 15:44 ` Logan Gunthorpe
2017-04-27 20:13 ` Logan Gunthorpe
2017-04-26 8:59 ` Christian König [this message]
2017-04-26 23:30 ` Logan Gunthorpe
2017-04-25 18:20 ` [PATCH v2 02/21] libiscsi: Add an internal error code Logan Gunthorpe
2017-04-26 7:48 ` Christoph Hellwig
2017-04-25 18:20 ` [PATCH v2 03/21] libiscsi: Make use of new the sg_map helper function Logan Gunthorpe
2017-04-25 18:20 ` [PATCH v2 04/21] target: Make use of the new sg_map function at 16 call sites Logan Gunthorpe
2017-04-25 18:20 ` [PATCH v2 05/21] drm/i915: Make use of the new sg_map helper function Logan Gunthorpe
2017-04-25 18:20 ` [PATCH v2 06/21] crypto: hifn_795x: " Logan Gunthorpe
2017-04-25 18:20 ` [PATCH v2 07/21] crypto: shash, caam: " Logan Gunthorpe
2017-04-27 3:56 ` Herbert Xu
2017-04-27 15:45 ` Logan Gunthorpe
2017-04-28 6:30 ` Herbert Xu
2017-04-28 16:53 ` Logan Gunthorpe
2017-04-28 17:51 ` Herbert Xu
2017-04-28 19:01 ` Logan Gunthorpe
2017-04-25 18:20 ` [PATCH v2 08/21] dm-crypt: Make use of the new sg_map helper in 4 call sites Logan Gunthorpe
2017-04-25 18:20 ` [PATCH v2 09/21] staging: unisys: visorbus: Make use of the new sg_map helper function Logan Gunthorpe
2017-04-25 18:20 ` [PATCH v2 10/21] RDS: " Logan Gunthorpe
2017-04-25 18:20 ` [PATCH v2 11/21] scsi: ipr, pmcraid, isci: Make use of the new sg_map helper Logan Gunthorpe
2017-04-25 18:20 ` [PATCH v2 12/21] scsi: hisi_sas, mvsas, gdth: Make use of the new sg_map helper function Logan Gunthorpe
2017-04-25 18:21 ` [PATCH v2 13/21] scsi: arcmsr, ips, megaraid: " Logan Gunthorpe
2017-04-25 18:21 ` [PATCH v2 14/21] scsi: libfc, csiostor: Change to sg_copy_buffer in two drivers Logan Gunthorpe
2017-04-25 18:21 ` [PATCH v2 15/21] xen-blkfront: Make use of the new sg_map helper function Logan Gunthorpe
2017-04-26 7:37 ` Roger Pau Monné
2017-04-27 20:19 ` Logan Gunthorpe
2017-04-27 20:53 ` Jason Gunthorpe
2017-04-27 21:53 ` Logan Gunthorpe
2017-04-27 22:11 ` Jason Gunthorpe
2017-04-27 23:03 ` Logan Gunthorpe
2017-04-27 23:20 ` Jason Gunthorpe
2017-04-27 23:29 ` Logan Gunthorpe
2017-04-25 18:21 ` [PATCH v2 16/21] mmc: sdhci: " Logan Gunthorpe
2017-04-25 18:21 ` [PATCH v2 17/21] mmc: spi: " Logan Gunthorpe
2017-04-25 18:21 ` [PATCH v2 18/21] mmc: tmio: " Logan Gunthorpe
2017-04-25 18:21 ` [PATCH v2 19/21] mmc: sdricoh_cs: " Logan Gunthorpe
2017-04-25 18:21 ` [PATCH v2 20/21] mmc: tifm_sd: " Logan Gunthorpe
2017-04-25 18:21 ` [PATCH v2 21/21] memstick: " Logan Gunthorpe
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=5dfc5bf5-482c-b5bb-029c-7cee80925f37@amd.com \
--to=christian.koenig@amd.com \
--cc=axboe@kernel.dk \
--cc=dan.j.williams@intel.com \
--cc=devel@driverdev.osuosl.org \
--cc=dm-devel@redhat.com \
--cc=dri-devel@lists.freedesktop.org \
--cc=gregkh@linuxfoundation.org \
--cc=hch@lst.de \
--cc=intel-gfx@lists.freedesktop.org \
--cc=jejb@linux.vnet.ibm.com \
--cc=linux-crypto@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-media@vger.kernel.org \
--cc=linux-mmc@vger.kernel.org \
--cc=linux-nvdimm@ml01.01.org \
--cc=linux-raid@vger.kernel.org \
--cc=linux-rdma@vger.kernel.org \
--cc=linux-scsi@vger.kernel.org \
--cc=logang@deltatee.com \
--cc=martin.petersen@oracle.com \
--cc=mawilcox@microsoft.com \
--cc=megaraidlinux.pdl@broadcom.com \
--cc=netdev@vger.kernel.org \
--cc=open-iscsi@googlegroups.com \
--cc=ross.zwisler@linux.intel.com \
--cc=sbates@raithlin.com \
--cc=sparmaintainer@unisys.com \
--cc=target-devel@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).