uverbs.h 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322
  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. #ifndef UVERBS_H
  37. #define UVERBS_H
  38. #include <linux/kref.h>
  39. #include <linux/idr.h>
  40. #include <linux/mutex.h>
  41. #include <linux/completion.h>
  42. #include <linux/cdev.h>
  43. #include <rdma/ib_verbs.h>
  44. #include <rdma/ib_umem.h>
  45. #include <rdma/ib_user_verbs.h>
  46. #include <rdma/uverbs_std_types.h>
  47. #define UVERBS_MODULE_NAME ib_uverbs
  48. #include <rdma/uverbs_named_ioctl.h>
  49. static inline void
  50. ib_uverbs_init_udata(struct ib_udata *udata,
  51. const void __user *ibuf,
  52. void __user *obuf,
  53. size_t ilen, size_t olen)
  54. {
  55. udata->inbuf = ibuf;
  56. udata->outbuf = obuf;
  57. udata->inlen = ilen;
  58. udata->outlen = olen;
  59. }
  60. static inline void
  61. ib_uverbs_init_udata_buf_or_null(struct ib_udata *udata,
  62. const void __user *ibuf,
  63. void __user *obuf,
  64. size_t ilen, size_t olen)
  65. {
  66. ib_uverbs_init_udata(udata,
  67. ilen ? ibuf : NULL, olen ? obuf : NULL,
  68. ilen, olen);
  69. }
  70. /*
  71. * Our lifetime rules for these structs are the following:
  72. *
  73. * struct ib_uverbs_device: One reference is held by the module and
  74. * released in ib_uverbs_remove_one(). Another reference is taken by
  75. * ib_uverbs_open() each time the character special file is opened,
  76. * and released in ib_uverbs_release_file() when the file is released.
  77. *
  78. * struct ib_uverbs_file: One reference is held by the VFS and
  79. * released when the file is closed. Another reference is taken when
  80. * an asynchronous event queue file is created and released when the
  81. * event file is closed.
  82. *
  83. * struct ib_uverbs_event_queue: Base structure for
  84. * struct ib_uverbs_async_event_file and struct ib_uverbs_completion_event_file.
  85. * One reference is held by the VFS and released when the file is closed.
  86. * For asynchronous event files, another reference is held by the corresponding
  87. * main context file and released when that file is closed. For completion
  88. * event files, a reference is taken when a CQ is created that uses the file,
  89. * and released when the CQ is destroyed.
  90. */
  91. struct ib_uverbs_device {
  92. atomic_t refcount;
  93. u32 num_comp_vectors;
  94. struct completion comp;
  95. struct device dev;
  96. /* First group for device attributes, NULL terminated array */
  97. const struct attribute_group *groups[2];
  98. struct ib_device __rcu *ib_dev;
  99. int devnum;
  100. struct cdev cdev;
  101. struct rb_root xrcd_tree;
  102. struct mutex xrcd_tree_mutex;
  103. struct srcu_struct disassociate_srcu;
  104. struct mutex lists_mutex; /* protect lists */
  105. struct list_head uverbs_file_list;
  106. struct uverbs_api *uapi;
  107. };
  108. struct ib_uverbs_event_queue {
  109. spinlock_t lock;
  110. int is_closed;
  111. wait_queue_head_t poll_wait;
  112. struct fasync_struct *async_queue;
  113. struct list_head event_list;
  114. };
  115. struct ib_uverbs_async_event_file {
  116. struct ib_uobject uobj;
  117. struct ib_uverbs_event_queue ev_queue;
  118. struct ib_event_handler event_handler;
  119. };
  120. struct ib_uverbs_completion_event_file {
  121. struct ib_uobject uobj;
  122. struct ib_uverbs_event_queue ev_queue;
  123. };
  124. struct ib_uverbs_file {
  125. struct kref ref;
  126. struct ib_uverbs_device *device;
  127. struct mutex ucontext_lock;
  128. /*
  129. * ucontext must be accessed via ib_uverbs_get_ucontext() or with
  130. * ucontext_lock held
  131. */
  132. struct ib_ucontext *ucontext;
  133. struct ib_uverbs_async_event_file *default_async_file;
  134. struct list_head list;
  135. /*
  136. * To access the uobjects list hw_destroy_rwsem must be held for write
  137. * OR hw_destroy_rwsem held for read AND uobjects_lock held.
  138. * hw_destroy_rwsem should be called across any destruction of the HW
  139. * object of an associated uobject.
  140. */
  141. struct rw_semaphore hw_destroy_rwsem;
  142. spinlock_t uobjects_lock;
  143. struct list_head uobjects;
  144. struct mutex umap_lock;
  145. struct list_head umaps;
  146. struct page *disassociate_page;
  147. struct xarray idr;
  148. };
  149. struct ib_uverbs_event {
  150. union {
  151. struct ib_uverbs_async_event_desc async;
  152. struct ib_uverbs_comp_event_desc comp;
  153. } desc;
  154. struct list_head list;
  155. struct list_head obj_list;
  156. u32 *counter;
  157. };
  158. struct ib_uverbs_mcast_entry {
  159. struct list_head list;
  160. union ib_gid gid;
  161. u16 lid;
  162. };
  163. struct ib_uevent_object {
  164. struct ib_uobject uobject;
  165. struct ib_uverbs_async_event_file *event_file;
  166. /* List member for ib_uverbs_async_event_file list */
  167. struct list_head event_list;
  168. u32 events_reported;
  169. };
  170. struct ib_uxrcd_object {
  171. struct ib_uobject uobject;
  172. atomic_t refcnt;
  173. };
  174. struct ib_usrq_object {
  175. struct ib_uevent_object uevent;
  176. struct ib_uxrcd_object *uxrcd;
  177. };
  178. struct ib_uqp_object {
  179. struct ib_uevent_object uevent;
  180. /* lock for mcast list */
  181. struct mutex mcast_lock;
  182. struct list_head mcast_list;
  183. struct ib_uxrcd_object *uxrcd;
  184. };
  185. struct ib_uwq_object {
  186. struct ib_uevent_object uevent;
  187. };
  188. struct ib_ucq_object {
  189. struct ib_uevent_object uevent;
  190. struct list_head comp_list;
  191. u32 comp_events_reported;
  192. };
  193. extern const struct file_operations uverbs_event_fops;
  194. extern const struct file_operations uverbs_async_event_fops;
  195. void ib_uverbs_init_event_queue(struct ib_uverbs_event_queue *ev_queue);
  196. void ib_uverbs_init_async_event_file(struct ib_uverbs_async_event_file *ev_file);
  197. void ib_uverbs_free_event_queue(struct ib_uverbs_event_queue *event_queue);
  198. void ib_uverbs_flow_resources_free(struct ib_uflow_resources *uflow_res);
  199. int uverbs_async_event_release(struct inode *inode, struct file *filp);
  200. int ib_alloc_ucontext(struct uverbs_attr_bundle *attrs);
  201. int ib_init_ucontext(struct uverbs_attr_bundle *attrs);
  202. void ib_uverbs_release_ucq(struct ib_uverbs_completion_event_file *ev_file,
  203. struct ib_ucq_object *uobj);
  204. void ib_uverbs_release_uevent(struct ib_uevent_object *uobj);
  205. void ib_uverbs_release_file(struct kref *ref);
  206. void ib_uverbs_async_handler(struct ib_uverbs_async_event_file *async_file,
  207. __u64 element, __u64 event,
  208. struct list_head *obj_list, u32 *counter);
  209. void ib_uverbs_comp_handler(struct ib_cq *cq, void *cq_context);
  210. void ib_uverbs_cq_event_handler(struct ib_event *event, void *context_ptr);
  211. void ib_uverbs_qp_event_handler(struct ib_event *event, void *context_ptr);
  212. void ib_uverbs_wq_event_handler(struct ib_event *event, void *context_ptr);
  213. void ib_uverbs_srq_event_handler(struct ib_event *event, void *context_ptr);
  214. int ib_uverbs_dealloc_xrcd(struct ib_uobject *uobject, struct ib_xrcd *xrcd,
  215. enum rdma_remove_reason why,
  216. struct uverbs_attr_bundle *attrs);
  217. int uverbs_dealloc_mw(struct ib_mw *mw);
  218. void ib_uverbs_detach_umcast(struct ib_qp *qp,
  219. struct ib_uqp_object *uobj);
  220. long ib_uverbs_ioctl(struct file *filp, unsigned int cmd, unsigned long arg);
  221. struct ib_uverbs_flow_spec {
  222. union {
  223. union {
  224. struct ib_uverbs_flow_spec_hdr hdr;
  225. struct {
  226. __u32 type;
  227. __u16 size;
  228. __u16 reserved;
  229. };
  230. };
  231. struct ib_uverbs_flow_spec_eth eth;
  232. struct ib_uverbs_flow_spec_ipv4 ipv4;
  233. struct ib_uverbs_flow_spec_esp esp;
  234. struct ib_uverbs_flow_spec_tcp_udp tcp_udp;
  235. struct ib_uverbs_flow_spec_ipv6 ipv6;
  236. struct ib_uverbs_flow_spec_action_tag flow_tag;
  237. struct ib_uverbs_flow_spec_action_drop drop;
  238. struct ib_uverbs_flow_spec_action_handle action;
  239. struct ib_uverbs_flow_spec_action_count flow_count;
  240. };
  241. };
  242. int ib_uverbs_kern_spec_to_ib_spec_filter(enum ib_flow_spec_type type,
  243. const void *kern_spec_mask,
  244. const void *kern_spec_val,
  245. size_t kern_filter_sz,
  246. union ib_flow_spec *ib_spec);
  247. /*
  248. * ib_uverbs_query_port_resp.port_cap_flags started out as just a copy of the
  249. * PortInfo CapabilityMask, but was extended with unique bits.
  250. */
  251. static inline u32 make_port_cap_flags(const struct ib_port_attr *attr)
  252. {
  253. u32 res;
  254. /* All IBA CapabilityMask bits are passed through here, except bit 26,
  255. * which is overridden with IP_BASED_GIDS. This is due to a historical
  256. * mistake in the implementation of IP_BASED_GIDS. Otherwise all other
  257. * bits match the IBA definition across all kernel versions.
  258. */
  259. res = attr->port_cap_flags & ~(u32)IB_UVERBS_PCF_IP_BASED_GIDS;
  260. if (attr->ip_gids)
  261. res |= IB_UVERBS_PCF_IP_BASED_GIDS;
  262. return res;
  263. }
  264. static inline struct ib_uverbs_async_event_file *
  265. ib_uverbs_get_async_event(struct uverbs_attr_bundle *attrs,
  266. u16 id)
  267. {
  268. struct ib_uobject *async_ev_file_uobj;
  269. struct ib_uverbs_async_event_file *async_ev_file;
  270. async_ev_file_uobj = uverbs_attr_get_uobject(attrs, id);
  271. if (IS_ERR(async_ev_file_uobj))
  272. async_ev_file = READ_ONCE(attrs->ufile->default_async_file);
  273. else
  274. async_ev_file = container_of(async_ev_file_uobj,
  275. struct ib_uverbs_async_event_file,
  276. uobj);
  277. if (async_ev_file)
  278. uverbs_uobject_get(&async_ev_file->uobj);
  279. return async_ev_file;
  280. }
  281. void copy_port_attr_to_resp(struct ib_port_attr *attr,
  282. struct ib_uverbs_query_port_resp *resp,
  283. struct ib_device *ib_dev, u8 port_num);
  284. #endif /* UVERBS_H */