[deliverable/linux.git] / include / xen / grant_table.h

/******************************************************************************
 * grant_table.h
 *
 * Two sets of functionality:
 * 1. Granting foreign access to our memory reservation.
 * 2. Accessing others' memory reservations via grant references.
 * (i.e., mechanisms for both sender and recipient of grant references)
 *
 * Copyright (c) 2004-2005, K A Fraser
 * Copyright (c) 2005, Christopher Clark
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License version 2
 * as published by the Free Software Foundation; or, when distributed
 * separately from the Linux kernel or incorporated into other
 * software packages, subject to the following license:
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this source file (the "Software"), to deal in the Software without
 * restriction, including without limitation the rights to use, copy, modify,
 * merge, publish, distribute, sublicense, and/or sell copies of the Software,
 * and to permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * 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 __ASM_GNTTAB_H__
#define __ASM_GNTTAB_H__

#include <asm/page.h>

#include <xen/interface/xen.h>
#include <xen/interface/grant_table.h>

#include <asm/xen/hypervisor.h>

#include <xen/features.h>
#include <xen/page.h>
#include <linux/mm_types.h>
#include <linux/page-flags.h>
#include <linux/kernel.h>

#define GNTTAB_RESERVED_XENSTORE 1

/* NR_GRANT_FRAMES must be less than or equal to that configured in Xen */
#define NR_GRANT_FRAMES 4

struct gnttab_free_callback {
	struct gnttab_free_callback *next;
	void (*fn)(void *);
	void *arg;
	u16 count;
};

struct gntab_unmap_queue_data;

typedef void (*gnttab_unmap_refs_done)(int result, struct gntab_unmap_queue_data *data);

struct gntab_unmap_queue_data
{
	struct delayed_work	gnttab_work;
	void *data;
	gnttab_unmap_refs_done	done;
	struct gnttab_unmap_grant_ref *unmap_ops;
	struct gnttab_unmap_grant_ref *kunmap_ops;
	struct page **pages;
	unsigned int count;
	unsigned int age;
};

int gnttab_init(void);
int gnttab_suspend(void);
int gnttab_resume(void);

int gnttab_grant_foreign_access(domid_t domid, unsigned long frame,
				int readonly);

/*
 * End access through the given grant reference, iff the grant entry is no
 * longer in use.  Return 1 if the grant entry was freed, 0 if it is still in
 * use.
 */
int gnttab_end_foreign_access_ref(grant_ref_t ref, int readonly);

/*
 * Eventually end access through the given grant reference, and once that
 * access has been ended, free the given page too.  Access will be ended
 * immediately iff the grant entry is not in use, otherwise it will happen
 * some time later.  page may be 0, in which case no freeing will occur.
 */
void gnttab_end_foreign_access(grant_ref_t ref, int readonly,
			       unsigned long page);

int gnttab_grant_foreign_transfer(domid_t domid, unsigned long pfn);

unsigned long gnttab_end_foreign_transfer_ref(grant_ref_t ref);
unsigned long gnttab_end_foreign_transfer(grant_ref_t ref);

int gnttab_query_foreign_access(grant_ref_t ref);

/*
 * operations on reserved batches of grant references
 */
int gnttab_alloc_grant_references(u16 count, grant_ref_t *pprivate_head);

void gnttab_free_grant_reference(grant_ref_t ref);

void gnttab_free_grant_references(grant_ref_t head);

int gnttab_empty_grant_references(const grant_ref_t *pprivate_head);

int gnttab_claim_grant_reference(grant_ref_t *pprivate_head);

void gnttab_release_grant_reference(grant_ref_t *private_head,
				    grant_ref_t release);

void gnttab_request_free_callback(struct gnttab_free_callback *callback,
				  void (*fn)(void *), void *arg, u16 count);
void gnttab_cancel_free_callback(struct gnttab_free_callback *callback);

void gnttab_grant_foreign_access_ref(grant_ref_t ref, domid_t domid,
				     unsigned long frame, int readonly);

void gnttab_grant_foreign_transfer_ref(grant_ref_t, domid_t domid,
				       unsigned long pfn);

static inline void
gnttab_set_map_op(struct gnttab_map_grant_ref *map, phys_addr_t addr,
		  uint32_t flags, grant_ref_t ref, domid_t domid)
{
	if (flags & GNTMAP_contains_pte)
		map->host_addr = addr;
	else if (xen_feature(XENFEAT_auto_translated_physmap))
		map->host_addr = __pa(addr);
	else
		map->host_addr = addr;

	map->flags = flags;
	map->ref = ref;
	map->dom = domid;
}

static inline void
gnttab_set_unmap_op(struct gnttab_unmap_grant_ref *unmap, phys_addr_t addr,
		    uint32_t flags, grant_handle_t handle)
{
	if (flags & GNTMAP_contains_pte)
		unmap->host_addr = addr;
	else if (xen_feature(XENFEAT_auto_translated_physmap))
		unmap->host_addr = __pa(addr);
	else
		unmap->host_addr = addr;

	unmap->handle = handle;
	unmap->dev_bus_addr = 0;
}

int arch_gnttab_init(unsigned long nr_shared);
int arch_gnttab_map_shared(xen_pfn_t *frames, unsigned long nr_gframes,
			   unsigned long max_nr_gframes,
			   void **__shared);
void arch_gnttab_unmap(void *shared, unsigned long nr_gframes);

struct grant_frames {
	xen_pfn_t *pfn;
	unsigned int count;
	void *vaddr;
};
extern struct grant_frames xen_auto_xlat_grant_frames;
unsigned int gnttab_max_grant_frames(void);
int gnttab_setup_auto_xlat_frames(phys_addr_t addr);
void gnttab_free_auto_xlat_frames(void);

#define gnttab_map_vaddr(map) ((void *)(map.host_virt_addr))

int gnttab_alloc_pages(int nr_pages, struct page **pages);
void gnttab_free_pages(int nr_pages, struct page **pages);

int gnttab_map_refs(struct gnttab_map_grant_ref *map_ops,
		    struct gnttab_map_grant_ref *kmap_ops,
		    struct page **pages, unsigned int count);
int gnttab_unmap_refs(struct gnttab_unmap_grant_ref *unmap_ops,
		      struct gnttab_unmap_grant_ref *kunmap_ops,
		      struct page **pages, unsigned int count);
void gnttab_unmap_refs_async(struct gntab_unmap_queue_data* item);
int gnttab_unmap_refs_sync(struct gntab_unmap_queue_data *item);


/* Perform a batch of grant map/copy operations. Retry every batch slot
 * for which the hypervisor returns GNTST_eagain. This is typically due
 * to paged out target frames.
 *
 * Will retry for 1, 2, ... 255 ms, i.e. 256 times during 32 seconds.
 *
 * Return value in each iand every status field of the batch guaranteed
 * to not be GNTST_eagain.
 */
void gnttab_batch_map(struct gnttab_map_grant_ref *batch, unsigned count);
void gnttab_batch_copy(struct gnttab_copy *batch, unsigned count);


struct xen_page_foreign {
	domid_t domid;
	grant_ref_t gref;
};

static inline struct xen_page_foreign *xen_page_foreign(struct page *page)
{
	if (!PageForeign(page))
		return NULL;
#if BITS_PER_LONG < 64
	return (struct xen_page_foreign *)page->private;
#else
	BUILD_BUG_ON(sizeof(struct xen_page_foreign) > BITS_PER_LONG);
	return (struct xen_page_foreign *)&page->private;
#endif
}

/* Split Linux page in chunk of the size of the grant and call fn
 *
 * Parameters of fn:
 *	gfn: guest frame number
 *	offset: offset in the grant
 *	len: length of the data in the grant.
 *	data: internal information
 */
typedef void (*xen_grant_fn_t)(unsigned long gfn, unsigned int offset,
			       unsigned int len, void *data);

void gnttab_foreach_grant_in_range(struct page *page,
				   unsigned int offset,
				   unsigned int len,
				   xen_grant_fn_t fn,
				   void *data);

/* Helper to get to call fn only on the first "grant chunk" */
static inline void gnttab_for_one_grant(struct page *page, unsigned int offset,
					unsigned len, xen_grant_fn_t fn,
					void *data)
{
	/* The first request is limited to the size of one grant */
	len = min_t(unsigned int, XEN_PAGE_SIZE - (offset & ~XEN_PAGE_MASK),
		    len);

	gnttab_foreach_grant_in_range(page, offset, len, fn, data);
}

/* Get the number of grant in a specified region
 *
 * start: Offset from the beginning of the first page
 * len: total length of data (can cross multiple page)
 */
static inline unsigned int gnttab_count_grant(unsigned int start,
					      unsigned int len)
{
	return XEN_PFN_UP(xen_offset_in_page(start) + len);
}

#endif /* __ASM_GNTTAB_H__ */
Commit	Line	Data
ad9a8612 JF	1	/******************************************************************************
	2	* grant_table.h
	3	*
	4	* Two sets of functionality:
	5	* 1. Granting foreign access to our memory reservation.
	6	* 2. Accessing others' memory reservations via grant references.
	7	* (i.e., mechanisms for both sender and recipient of grant references)
	8	*
	9	* Copyright (c) 2004-2005, K A Fraser
	10	* Copyright (c) 2005, Christopher Clark
	11	*
	12	* This program is free software; you can redistribute it and/or
	13	* modify it under the terms of the GNU General Public License version 2
	14	* as published by the Free Software Foundation; or, when distributed
	15	* separately from the Linux kernel or incorporated into other
	16	* software packages, subject to the following license:
	17	*
	18	* Permission is hereby granted, free of charge, to any person obtaining a copy
	19	* of this source file (the "Software"), to deal in the Software without
	20	* restriction, including without limitation the rights to use, copy, modify,
	21	* merge, publish, distribute, sublicense, and/or sell copies of the Software,
	22	* and to permit persons to whom the Software is furnished to do so, subject to
	23	* the following conditions:
	24	*
	25	* The above copyright notice and this permission notice shall be included in
	26	* all copies or substantial portions of the Software.
	27	*
	28	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	29	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	30	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
	31	* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	32	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
	33	* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
	34	* IN THE SOFTWARE.
	35	*/
	36
	37	#ifndef __ASM_GNTTAB_H__
	38	#define __ASM_GNTTAB_H__
	39
f0774532 IC	40	#include <asm/page.h>
	41
	42	#include <xen/interface/xen.h>
ad9a8612	43	#include <xen/interface/grant_table.h>
f0774532 IC	44
f0774532 IC	45	#include <asm/xen/hypervisor.h>
ad9a8612	46
f0774532	47	#include <xen/features.h>
008c320a	48	#include <xen/page.h>
8da7633f JH	49	#include <linux/mm_types.h>
8da7633f JH	50	#include <linux/page-flags.h>
008c320a	51	#include <linux/kernel.h>
f0774532	52
d2fb4c51 DDG	53	#define GNTTAB_RESERVED_XENSTORE 1
d2fb4c51 DDG	54
ad9a8612 JF	55	/* NR_GRANT_FRAMES must be less than or equal to that configured in Xen */
	56	#define NR_GRANT_FRAMES 4
	57
	58	struct gnttab_free_callback {
	59	struct gnttab_free_callback *next;
	60	void (fn)(void );
	61	void *arg;
	62	u16 count;
	63	};
	64
3f9f1c67 JH	65	struct gntab_unmap_queue_data;
	66
	67	typedef void (gnttab_unmap_refs_done)(int result, struct gntab_unmap_queue_data data);
	68
	69	struct gntab_unmap_queue_data
	70	{
	71	struct delayed_work gnttab_work;
	72	void *data;
	73	gnttab_unmap_refs_done done;
	74	struct gnttab_unmap_grant_ref *unmap_ops;
	75	struct gnttab_unmap_grant_ref *kunmap_ops;
	76	struct page **pages;
	77	unsigned int count;
	78	unsigned int age;
	79	};
	80
183d03cc	81	int gnttab_init(void);
0e91398f JF	82	int gnttab_suspend(void);
	83	int gnttab_resume(void);
	84
ad9a8612 JF	85	int gnttab_grant_foreign_access(domid_t domid, unsigned long frame,
ad9a8612 JF	86	int readonly);
9438ce9d	87
ad9a8612 JF	88	/*
	89	* End access through the given grant reference, iff the grant entry is no
	90	* longer in use. Return 1 if the grant entry was freed, 0 if it is still in
	91	* use.
	92	*/
	93	int gnttab_end_foreign_access_ref(grant_ref_t ref, int readonly);
	94
	95	/*
	96	* Eventually end access through the given grant reference, and once that
	97	* access has been ended, free the given page too. Access will be ended
	98	* immediately iff the grant entry is not in use, otherwise it will happen
	99	* some time later. page may be 0, in which case no freeing will occur.
	100	*/
	101	void gnttab_end_foreign_access(grant_ref_t ref, int readonly,
	102	unsigned long page);
	103
	104	int gnttab_grant_foreign_transfer(domid_t domid, unsigned long pfn);
	105
	106	unsigned long gnttab_end_foreign_transfer_ref(grant_ref_t ref);
	107	unsigned long gnttab_end_foreign_transfer(grant_ref_t ref);
	108
	109	int gnttab_query_foreign_access(grant_ref_t ref);
	110
	111	/*
	112	* operations on reserved batches of grant references
	113	*/
	114	int gnttab_alloc_grant_references(u16 count, grant_ref_t *pprivate_head);
	115
	116	void gnttab_free_grant_reference(grant_ref_t ref);
	117
	118	void gnttab_free_grant_references(grant_ref_t head);
	119
	120	int gnttab_empty_grant_references(const grant_ref_t *pprivate_head);
	121
	122	int gnttab_claim_grant_reference(grant_ref_t *pprivate_head);
	123
	124	void gnttab_release_grant_reference(grant_ref_t *private_head,
	125	grant_ref_t release);
	126
	127	void gnttab_request_free_callback(struct gnttab_free_callback *callback,
	128	void (fn)(void ), void *arg, u16 count);
	129	void gnttab_cancel_free_callback(struct gnttab_free_callback *callback);
	130
	131	void gnttab_grant_foreign_access_ref(grant_ref_t ref, domid_t domid,
	132	unsigned long frame, int readonly);
	133
	134	void gnttab_grant_foreign_transfer_ref(grant_ref_t, domid_t domid,
	135	unsigned long pfn);
	136
f0774532 IC	137	static inline void
	138	gnttab_set_map_op(struct gnttab_map_grant_ref *map, phys_addr_t addr,
	139	uint32_t flags, grant_ref_t ref, domid_t domid)
	140	{
	141	if (flags & GNTMAP_contains_pte)
	142	map->host_addr = addr;
	143	else if (xen_feature(XENFEAT_auto_translated_physmap))
	144	map->host_addr = __pa(addr);
	145	else
	146	map->host_addr = addr;
	147
	148	map->flags = flags;
	149	map->ref = ref;
	150	map->dom = domid;
	151	}
	152
	153	static inline void
	154	gnttab_set_unmap_op(struct gnttab_unmap_grant_ref *unmap, phys_addr_t addr,
	155	uint32_t flags, grant_handle_t handle)
	156	{
	157	if (flags & GNTMAP_contains_pte)
	158	unmap->host_addr = addr;
	159	else if (xen_feature(XENFEAT_auto_translated_physmap))
	160	unmap->host_addr = __pa(addr);
	161	else
	162	unmap->host_addr = addr;
	163
	164	unmap->handle = handle;
	165	unmap->dev_bus_addr = 0;
	166	}
	167
438b33c7	168	int arch_gnttab_init(unsigned long nr_shared);
ef32f892	169	int arch_gnttab_map_shared(xen_pfn_t *frames, unsigned long nr_gframes,
8d3d2106	170	unsigned long max_nr_gframes,
0f9f5a95	171	void **__shared);
85ff6acb	172	void arch_gnttab_unmap(void *shared, unsigned long nr_gframes);
8d3d2106	173
efaf30a3 KRW	174	struct grant_frames {
	175	xen_pfn_t *pfn;
	176	unsigned int count;
	177	void *vaddr;
	178	};
	179	extern struct grant_frames xen_auto_xlat_grant_frames;
183d03cc	180	unsigned int gnttab_max_grant_frames(void);
47c54205	181	int gnttab_setup_auto_xlat_frames(phys_addr_t addr);
efaf30a3	182	void gnttab_free_auto_xlat_frames(void);
183d03cc	183
ad9a8612 JF	184	#define gnttab_map_vaddr(map) ((void *)(map.host_virt_addr))
ad9a8612 JF	185
ff4b156f DV	186	int gnttab_alloc_pages(int nr_pages, struct page **pages);
	187	void gnttab_free_pages(int nr_pages, struct page **pages);
	188
289b777e	189	int gnttab_map_refs(struct gnttab_map_grant_ref *map_ops,
e85fc980	190	struct gnttab_map_grant_ref *kmap_ops,
289b777e SS	191	struct page **pages, unsigned int count);
289b777e SS	192	int gnttab_unmap_refs(struct gnttab_unmap_grant_ref *unmap_ops,
853d0289	193	struct gnttab_unmap_grant_ref *kunmap_ops,
2fc136ee	194	struct page **pages, unsigned int count);
3f9f1c67	195	void gnttab_unmap_refs_async(struct gntab_unmap_queue_data* item);
b44166cd	196	int gnttab_unmap_refs_sync(struct gntab_unmap_queue_data *item);
3f9f1c67	197
289b777e	198
c571898f ALC	199	/* Perform a batch of grant map/copy operations. Retry every batch slot
	200	* for which the hypervisor returns GNTST_eagain. This is typically due
	201	* to paged out target frames.
	202	*
	203	* Will retry for 1, 2, ... 255 ms, i.e. 256 times during 32 seconds.
	204	*
	205	* Return value in each iand every status field of the batch guaranteed
	206	* to not be GNTST_eagain.
	207	*/
	208	void gnttab_batch_map(struct gnttab_map_grant_ref *batch, unsigned count);
	209	void gnttab_batch_copy(struct gnttab_copy *batch, unsigned count);
	210
8da7633f JH	211
	212	struct xen_page_foreign {
	213	domid_t domid;
	214	grant_ref_t gref;
	215	};
	216
	217	static inline struct xen_page_foreign xen_page_foreign(struct page page)
	218	{
	219	if (!PageForeign(page))
	220	return NULL;
	221	#if BITS_PER_LONG < 64
	222	return (struct xen_page_foreign *)page->private;
	223	#else
	224	BUILD_BUG_ON(sizeof(struct xen_page_foreign) > BITS_PER_LONG);
	225	return (struct xen_page_foreign *)&page->private;
	226	#endif
	227	}
	228
008c320a JG	229	/* Split Linux page in chunk of the size of the grant and call fn
	230	*
	231	* Parameters of fn:
	232	* gfn: guest frame number
	233	* offset: offset in the grant
	234	* len: length of the data in the grant.
	235	* data: internal information
	236	*/
	237	typedef void (*xen_grant_fn_t)(unsigned long gfn, unsigned int offset,
	238	unsigned int len, void *data);
	239
	240	void gnttab_foreach_grant_in_range(struct page *page,
	241	unsigned int offset,
	242	unsigned int len,
	243	xen_grant_fn_t fn,
	244	void *data);
	245
	246	/* Helper to get to call fn only on the first "grant chunk" */
	247	static inline void gnttab_for_one_grant(struct page *page, unsigned int offset,
	248	unsigned len, xen_grant_fn_t fn,
	249	void *data)
	250	{
	251	/* The first request is limited to the size of one grant */
	252	len = min_t(unsigned int, XEN_PAGE_SIZE - (offset & ~XEN_PAGE_MASK),
	253	len);
	254
	255	gnttab_foreach_grant_in_range(page, offset, len, fn, data);
	256	}
	257
	258	/* Get the number of grant in a specified region
	259	*
	260	* start: Offset from the beginning of the first page
	261	* len: total length of data (can cross multiple page)
	262	*/
	263	static inline unsigned int gnttab_count_grant(unsigned int start,
	264	unsigned int len)
	265	{
	266	return XEN_PFN_UP(xen_offset_in_page(start) + len);
	267	}
	268
ad9a8612	269	#endif /* __ASM_GNTTAB_H__ */