1/* 2 * Copyright (c) 2005 Topspin Communications. All rights reserved. 3 * Copyright (c) 2005, 2006 Cisco Systems. All rights reserved. 4 * Copyright (c) 2005 Mellanox Technologies. All rights reserved. 5 * Copyright (c) 2005 Voltaire, Inc. All rights reserved. 6 * Copyright (c) 2005 PathScale, Inc. All rights reserved. 7 * 8 * This software is available to you under a choice of one of two 9 * licenses. You may choose to be licensed under the terms of the GNU 10 * General Public License (GPL) Version 2, available from the file 11 * COPYING in the main directory of this source tree, or the 12 * OpenIB.org BSD license below: 13 * 14 * Redistribution and use in source and binary forms, with or 15 * without modification, are permitted provided that the following 16 * conditions are met: 17 * 18 * - Redistributions of source code must retain the above 19 * copyright notice, this list of conditions and the following 20 * disclaimer. 21 * 22 * - Redistributions in binary form must reproduce the above 23 * copyright notice, this list of conditions and the following 24 * disclaimer in the documentation and/or other materials 25 * provided with the distribution. 26 * 27 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 28 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 29 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND 30 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS 31 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN 32 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN 33 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 34 * SOFTWARE. 35 */ 36 37#ifndef UVERBS_H 38#define UVERBS_H 39 40#include <linux/kref.h> 41#include <linux/idr.h> 42#include <linux/mutex.h> 43#include <linux/completion.h> 44#include <linux/cdev.h> 45 46#include <rdma/ib_verbs.h> 47#include <rdma/ib_umem.h> 48#include <rdma/ib_user_verbs.h> 49 50/* 51 * Our lifetime rules for these structs are the following: 52 * 53 * struct ib_uverbs_device: One reference is held by the module and 54 * released in ib_uverbs_remove_one(). Another reference is taken by 55 * ib_uverbs_open() each time the character special file is opened, 56 * and released in ib_uverbs_release_file() when the file is released. 57 * 58 * struct ib_uverbs_file: One reference is held by the VFS and 59 * released when the file is closed. Another reference is taken when 60 * an asynchronous event queue file is created and released when the 61 * event file is closed. 62 * 63 * struct ib_uverbs_event_file: One reference is held by the VFS and 64 * released when the file is closed. For asynchronous event files, 65 * another reference is held by the corresponding main context file 66 * and released when that file is closed. For completion event files, 67 * a reference is taken when a CQ is created that uses the file, and 68 * released when the CQ is destroyed. 69 */ 70 71struct ib_uverbs_device { 72 struct kref ref; 73 int num_comp_vectors; 74 struct completion comp; 75 struct device *dev; 76 struct ib_device *ib_dev; 77 int devnum; 78 struct cdev cdev; 79}; 80 81struct ib_uverbs_event_file { 82 struct kref ref; 83 int is_async; 84 struct ib_uverbs_file *uverbs_file; 85 spinlock_t lock; 86 int is_closed; 87 wait_queue_head_t poll_wait; 88 struct fasync_struct *async_queue; 89 struct list_head event_list; 90}; 91 92struct ib_uverbs_file { 93 struct kref ref; 94 struct mutex mutex; 95 struct ib_uverbs_device *device; 96 struct ib_ucontext *ucontext; 97 struct ib_event_handler event_handler; 98 struct ib_uverbs_event_file *async_file; 99}; 100 101struct ib_uverbs_event { 102 union { 103 struct ib_uverbs_async_event_desc async; 104 struct ib_uverbs_comp_event_desc comp; 105 } desc; 106 struct list_head list; 107 struct list_head obj_list; 108 u32 *counter; 109}; 110 111struct ib_uverbs_mcast_entry { 112 struct list_head list; 113 union ib_gid gid; 114 u16 lid; 115}; 116 117struct ib_uevent_object { 118 struct ib_uobject uobject; 119 struct list_head event_list; 120 u32 events_reported; 121}; 122 123struct ib_uqp_object { 124 struct ib_uevent_object uevent; 125 struct list_head mcast_list; 126}; 127 128struct ib_ucq_object { 129 struct ib_uobject uobject; 130 struct ib_uverbs_file *uverbs_file; 131 struct list_head comp_list; 132 struct list_head async_list; 133 u32 comp_events_reported; 134 u32 async_events_reported; 135}; 136 137extern spinlock_t ib_uverbs_idr_lock; 138extern struct idr ib_uverbs_pd_idr; 139extern struct idr ib_uverbs_mr_idr; 140extern struct idr ib_uverbs_mw_idr; 141extern struct idr ib_uverbs_ah_idr; 142extern struct idr ib_uverbs_cq_idr; 143extern struct idr ib_uverbs_qp_idr; 144extern struct idr ib_uverbs_srq_idr; 145 146void idr_remove_uobj(struct idr *idp, struct ib_uobject *uobj); 147 148struct file *ib_uverbs_alloc_event_file(struct ib_uverbs_file *uverbs_file, 149 int is_async); 150struct ib_uverbs_event_file *ib_uverbs_lookup_comp_file(int fd); 151 152void ib_uverbs_release_ucq(struct ib_uverbs_file *file, 153 struct ib_uverbs_event_file *ev_file, 154 struct ib_ucq_object *uobj); 155void ib_uverbs_release_uevent(struct ib_uverbs_file *file, 156 struct ib_uevent_object *uobj); 157 158void ib_uverbs_comp_handler(struct ib_cq *cq, void *cq_context); 159void ib_uverbs_cq_event_handler(struct ib_event *event, void *context_ptr); 160void ib_uverbs_qp_event_handler(struct ib_event *event, void *context_ptr); 161void ib_uverbs_srq_event_handler(struct ib_event *event, void *context_ptr); 162void ib_uverbs_event_handler(struct ib_event_handler *handler, 163 struct ib_event *event); 164 165#define IB_UVERBS_DECLARE_CMD(name) \ 166 ssize_t ib_uverbs_##name(struct ib_uverbs_file *file, \ 167 const char __user *buf, int in_len, \ 168 int out_len) 169 170IB_UVERBS_DECLARE_CMD(get_context); 171IB_UVERBS_DECLARE_CMD(query_device); 172IB_UVERBS_DECLARE_CMD(query_port); 173IB_UVERBS_DECLARE_CMD(alloc_pd); 174IB_UVERBS_DECLARE_CMD(dealloc_pd); 175IB_UVERBS_DECLARE_CMD(reg_mr); 176IB_UVERBS_DECLARE_CMD(dereg_mr); 177IB_UVERBS_DECLARE_CMD(create_comp_channel); 178IB_UVERBS_DECLARE_CMD(create_cq); 179IB_UVERBS_DECLARE_CMD(resize_cq); 180IB_UVERBS_DECLARE_CMD(poll_cq); 181IB_UVERBS_DECLARE_CMD(req_notify_cq); 182IB_UVERBS_DECLARE_CMD(destroy_cq); 183IB_UVERBS_DECLARE_CMD(create_qp); 184IB_UVERBS_DECLARE_CMD(query_qp); 185IB_UVERBS_DECLARE_CMD(modify_qp); 186IB_UVERBS_DECLARE_CMD(destroy_qp); 187IB_UVERBS_DECLARE_CMD(post_send); 188IB_UVERBS_DECLARE_CMD(post_recv); 189IB_UVERBS_DECLARE_CMD(post_srq_recv); 190IB_UVERBS_DECLARE_CMD(create_ah); 191IB_UVERBS_DECLARE_CMD(destroy_ah); 192IB_UVERBS_DECLARE_CMD(attach_mcast); 193IB_UVERBS_DECLARE_CMD(detach_mcast); 194IB_UVERBS_DECLARE_CMD(create_srq); 195IB_UVERBS_DECLARE_CMD(modify_srq); 196IB_UVERBS_DECLARE_CMD(query_srq); 197IB_UVERBS_DECLARE_CMD(destroy_srq); 198 199#endif /* UVERBS_H */ 200