ib_fmr_pool.h revision 331772 
1/*
2 * Copyright (c) 2004 Topspin Corporation.  All rights reserved.
3 * Copyright (c) 2005 Sun Microsystems, Inc. All rights reserved.
4 *
5 * This software is available to you under a choice of one of two
6 * licenses.  You may choose to be licensed under the terms of the GNU
7 * General Public License (GPL) Version 2, available from the file
8 * COPYING in the main directory of this source tree, or the
9 * OpenIB.org BSD license below:
10 *
11 *     Redistribution and use in source and binary forms, with or
12 *     without modification, are permitted provided that the following
13 *     conditions are met:
14 *
15 *      - Redistributions of source code must retain the above
16 *        copyright notice, this list of conditions and the following
17 *        disclaimer.
18 *
19 *      - Redistributions in binary form must reproduce the above
20 *        copyright notice, this list of conditions and the following
21 *        disclaimer in the documentation and/or other materials
22 *        provided with the distribution.
23 *
24 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
25 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
26 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
27 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
28 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
29 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
30 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
31 * SOFTWARE.
32 *
33 * $FreeBSD: stable/11/sys/ofed/include/rdma/ib_fmr_pool.h 331772 2018-03-30 18:17:33Z hselasky $
34 */
35
36#if !defined(IB_FMR_POOL_H)
37#define IB_FMR_POOL_H
38
39#include <rdma/ib_verbs.h>
40
41struct ib_fmr_pool;
42
43/**
44 * struct ib_fmr_pool_param - Parameters for creating FMR pool
45 * @max_pages_per_fmr:Maximum number of pages per map request.
46 * @page_shift: Log2 of sizeof "pages" mapped by this fmr
47 * @access:Access flags for FMRs in pool.
48 * @pool_size:Number of FMRs to allocate for pool.
49 * @dirty_watermark:Flush is triggered when @dirty_watermark dirty
50 *     FMRs are present.
51 * @flush_function:Callback called when unmapped FMRs are flushed and
52 *     more FMRs are possibly available for mapping
53 * @flush_arg:Context passed to user's flush function.
54 * @cache:If set, FMRs may be reused after unmapping for identical map
55 *     requests.
56 */
57struct ib_fmr_pool_param {
58	int                     max_pages_per_fmr;
59	int                     page_shift;
60	enum ib_access_flags    access;
61	int                     pool_size;
62	int                     dirty_watermark;
63	void                  (*flush_function)(struct ib_fmr_pool *pool,
64						void               *arg);
65	void                   *flush_arg;
66	unsigned                cache:1;
67};
68
69struct ib_pool_fmr {
70	struct ib_fmr      *fmr;
71	struct ib_fmr_pool *pool;
72	struct list_head    list;
73	struct hlist_node   cache_node;
74	int                 ref_count;
75	int                 remap_count;
76	u64                 io_virtual_address;
77	int                 page_list_len;
78	u64                 page_list[0];
79};
80
81struct ib_fmr_pool *ib_create_fmr_pool(struct ib_pd             *pd,
82				       struct ib_fmr_pool_param *params);
83
84void ib_destroy_fmr_pool(struct ib_fmr_pool *pool);
85
86int ib_flush_fmr_pool(struct ib_fmr_pool *pool);
87
88struct ib_pool_fmr *ib_fmr_pool_map_phys(struct ib_fmr_pool *pool_handle,
89					 u64                *page_list,
90					 int                 list_len,
91					 u64                 io_virtual_address);
92
93int ib_fmr_pool_unmap(struct ib_pool_fmr *fmr);
94
95#endif /* IB_FMR_POOL_H */
96