[linux-2.6-block.git] / include / rdma / ib_umem.h

/*
 * Copyright (c) 2007 Cisco Systems.  All rights reserved.
 *
 * This software is available to you under a choice of one of two
 * licenses.  You may choose to be licensed under the terms of the GNU
 * General Public License (GPL) Version 2, available from the file
 * COPYING in the main directory of this source tree, or the
 * OpenIB.org BSD license below:
 *
 *     Redistribution and use in source and binary forms, with or
 *     without modification, are permitted provided that the following
 *     conditions are met:
 *
 *      - Redistributions of source code must retain the above
 *        copyright notice, this list of conditions and the following
 *        disclaimer.
 *
 *      - Redistributions in binary form must reproduce the above
 *        copyright notice, this list of conditions and the following
 *        disclaimer in the documentation and/or other materials
 *        provided with the distribution.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

#ifndef IB_UMEM_H
#define IB_UMEM_H

#include <linux/list.h>
#include <linux/scatterlist.h>
#include <linux/workqueue.h>
#include <rdma/ib_verbs.h>

struct ib_ucontext;
struct ib_umem_odp;

struct ib_umem {
	struct ib_ucontext     *context;
	struct mm_struct       *owning_mm;
	size_t			length;
	unsigned long		address;
	int			page_shift;
	u32 writable : 1;
	u32 is_odp : 1;
	struct work_struct	work;
	struct sg_table sg_head;
	int             nmap;
	unsigned int    sg_nents;
};

/* Returns the offset of the umem start relative to the first page. */
static inline int ib_umem_offset(struct ib_umem *umem)
{
	return umem->address & (BIT(umem->page_shift) - 1);
}

/* Returns the first page of an ODP umem. */
static inline unsigned long ib_umem_start(struct ib_umem *umem)
{
	return umem->address - ib_umem_offset(umem);
}

/* Returns the address of the page after the last one of an ODP umem. */
static inline unsigned long ib_umem_end(struct ib_umem *umem)
{
	return ALIGN(umem->address + umem->length, BIT(umem->page_shift));
}

static inline size_t ib_umem_num_pages(struct ib_umem *umem)
{
	return (ib_umem_end(umem) - ib_umem_start(umem)) >> umem->page_shift;
}

#ifdef CONFIG_INFINIBAND_USER_MEM

struct ib_umem *ib_umem_get(struct ib_udata *udata, unsigned long addr,
			    size_t size, int access, int dmasync);
void ib_umem_release(struct ib_umem *umem);
int ib_umem_page_count(struct ib_umem *umem);
int ib_umem_copy_from(void *dst, struct ib_umem *umem, size_t offset,
		      size_t length);
unsigned long ib_umem_find_best_pgsz(struct ib_umem *umem,
				     unsigned long pgsz_bitmap,
				     unsigned long virt);

#else /* CONFIG_INFINIBAND_USER_MEM */

#include <linux/err.h>

static inline struct ib_umem *ib_umem_get(struct ib_udata *udata,
					  unsigned long addr, size_t size,
					  int access, int dmasync)
{
	return ERR_PTR(-EINVAL);
}
static inline void ib_umem_release(struct ib_umem *umem) { }
static inline int ib_umem_page_count(struct ib_umem *umem) { return 0; }
static inline int ib_umem_copy_from(void *dst, struct ib_umem *umem, size_t offset,
		      		    size_t length) {
	return -EINVAL;
}
static inline int ib_umem_find_best_pgsz(struct ib_umem *umem,
					 unsigned long pgsz_bitmap,
					 unsigned long virt) {
	return -EINVAL;
}

#endif /* CONFIG_INFINIBAND_USER_MEM */

#endif /* IB_UMEM_H */
Commit	Line	Data
f7c6a7b5 RD	1	/*
	2	* Copyright (c) 2007 Cisco Systems. All rights reserved.
	3	*
	4	* This software is available to you under a choice of one of two
	5	* licenses. You may choose to be licensed under the terms of the GNU
	6	* General Public License (GPL) Version 2, available from the file
	7	* COPYING in the main directory of this source tree, or the
	8	* OpenIB.org BSD license below:
	9	*
	10	* Redistribution and use in source and binary forms, with or
	11	* without modification, are permitted provided that the following
	12	* conditions are met:
	13	*
	14	* - Redistributions of source code must retain the above
	15	* copyright notice, this list of conditions and the following
	16	* disclaimer.
	17	*
	18	* - Redistributions in binary form must reproduce the above
	19	* copyright notice, this list of conditions and the following
	20	* disclaimer in the documentation and/or other materials
	21	* provided with the distribution.
	22	*
	23	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
	24	* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
	25	* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
	26	* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
	27	* BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
	28	* ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
	29	* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
	30	* SOFTWARE.
	31	*/
	32
	33	#ifndef IB_UMEM_H
	34	#define IB_UMEM_H
	35
	36	#include <linux/list.h>
	37	#include <linux/scatterlist.h>
e8edc6e0	38	#include <linux/workqueue.h>
b0ea0fa5	39	#include <rdma/ib_verbs.h>
f7c6a7b5 RD	40
f7c6a7b5 RD	41	struct ib_ucontext;
8ada2c1c	42	struct ib_umem_odp;
f7c6a7b5 RD	43
	44	struct ib_umem {
	45	struct ib_ucontext *context;
d4b4dd1b	46	struct mm_struct *owning_mm;
f7c6a7b5	47	size_t length;
406f9e5f	48	unsigned long address;
3e7e1193	49	int page_shift;
597ecc5a	50	u32 writable : 1;
597ecc5a	51	u32 is_odp : 1;
1bf66a30	52	struct work_struct work;
eeb8461e YH	53	struct sg_table sg_head;
eeb8461e YH	54	int nmap;
d10bcf94	55	unsigned int sg_nents;
f7c6a7b5 RD	56	};
f7c6a7b5 RD	57
406f9e5f HE	58	/* Returns the offset of the umem start relative to the first page. */
	59	static inline int ib_umem_offset(struct ib_umem *umem)
	60	{
3e7e1193	61	return umem->address & (BIT(umem->page_shift) - 1);
406f9e5f HE	62	}
	63
	64	/* Returns the first page of an ODP umem. */
	65	static inline unsigned long ib_umem_start(struct ib_umem *umem)
	66	{
	67	return umem->address - ib_umem_offset(umem);
	68	}
	69
	70	/* Returns the address of the page after the last one of an ODP umem. */
	71	static inline unsigned long ib_umem_end(struct ib_umem *umem)
	72	{
403cd12e	73	return ALIGN(umem->address + umem->length, BIT(umem->page_shift));
406f9e5f HE	74	}
	75
	76	static inline size_t ib_umem_num_pages(struct ib_umem *umem)
	77	{
403cd12e	78	return (ib_umem_end(umem) - ib_umem_start(umem)) >> umem->page_shift;
406f9e5f HE	79	}
406f9e5f HE	80
f7c6a7b5 RD	81	#ifdef CONFIG_INFINIBAND_USER_MEM
f7c6a7b5 RD	82
b0ea0fa5	83	struct ib_umem ib_umem_get(struct ib_udata udata, unsigned long addr,
cb9fbc5c	84	size_t size, int access, int dmasync);
f7c6a7b5 RD	85	void ib_umem_release(struct ib_umem *umem);
f7c6a7b5 RD	86	int ib_umem_page_count(struct ib_umem *umem);
c5d76f13 HE	87	int ib_umem_copy_from(void dst, struct ib_umem umem, size_t offset,
c5d76f13 HE	88	size_t length);
4a353399 SS	89	unsigned long ib_umem_find_best_pgsz(struct ib_umem *umem,
	90	unsigned long pgsz_bitmap,
	91	unsigned long virt);
f7c6a7b5 RD	92
	93	#else /* CONFIG_INFINIBAND_USER_MEM */
	94
	95	#include <linux/err.h>
	96
b0ea0fa5	97	static inline struct ib_umem ib_umem_get(struct ib_udata udata,
f7c6a7b5	98	unsigned long addr, size_t size,
b0ea0fa5 JG	99	int access, int dmasync)
b0ea0fa5 JG	100	{
f7c6a7b5 RD	101	return ERR_PTR(-EINVAL);
	102	}
	103	static inline void ib_umem_release(struct ib_umem *umem) { }
	104	static inline int ib_umem_page_count(struct ib_umem *umem) { return 0; }
c1395a2a HE	105	static inline int ib_umem_copy_from(void dst, struct ib_umem umem, size_t offset,
	106	size_t length) {
	107	return -EINVAL;
	108	}
4a353399 SS	109	static inline int ib_umem_find_best_pgsz(struct ib_umem *umem,
	110	unsigned long pgsz_bitmap,
	111	unsigned long virt) {
	112	return -EINVAL;
	113	}
	114
f7c6a7b5 RD	115	#endif /* CONFIG_INFINIBAND_USER_MEM */
	116
	117	#endif /* IB_UMEM_H */