rdma_core.h 6.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191
  1. /*
  2. * Copyright (c) 2005 Topspin Communications. All rights reserved.
  3. * Copyright (c) 2005, 2006 Cisco Systems. All rights reserved.
  4. * Copyright (c) 2005-2017 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 RDMA_CORE_H
  37. #define RDMA_CORE_H
  38. #include <linux/idr.h>
  39. #include <rdma/uverbs_types.h>
  40. #include <rdma/uverbs_ioctl.h>
  41. #include <rdma/ib_verbs.h>
  42. #include <linux/mutex.h>
  43. struct ib_uverbs_device;
  44. void uverbs_destroy_ufile_hw(struct ib_uverbs_file *ufile,
  45. enum rdma_remove_reason reason);
  46. int uobj_destroy(struct ib_uobject *uobj, struct uverbs_attr_bundle *attrs);
  47. /*
  48. * Get an ib_uobject that corresponds to the given id from ufile, assuming
  49. * the object is from the given type. Lock it to the required access when
  50. * applicable.
  51. * This function could create (access == NEW), destroy (access == DESTROY)
  52. * or unlock (access == READ || access == WRITE) objects if required.
  53. * The action will be finalized only when uverbs_finalize_object or
  54. * uverbs_finalize_objects are called.
  55. */
  56. struct ib_uobject *
  57. uverbs_get_uobject_from_file(u16 object_id, enum uverbs_obj_access access,
  58. s64 id, struct uverbs_attr_bundle *attrs);
  59. void uverbs_finalize_object(struct ib_uobject *uobj,
  60. enum uverbs_obj_access access, bool hw_obj_valid,
  61. bool commit, struct uverbs_attr_bundle *attrs);
  62. int uverbs_output_written(const struct uverbs_attr_bundle *bundle, size_t idx);
  63. void setup_ufile_idr_uobject(struct ib_uverbs_file *ufile);
  64. void release_ufile_idr_uobject(struct ib_uverbs_file *ufile);
  65. struct ib_udata *uverbs_get_cleared_udata(struct uverbs_attr_bundle *attrs);
  66. /*
  67. * This is the runtime description of the uverbs API, used by the syscall
  68. * machinery to validate and dispatch calls.
  69. */
  70. /*
  71. * Depending on ID the slot pointer in the radix tree points at one of these
  72. * structs.
  73. */
  74. struct uverbs_api_ioctl_method {
  75. int(__rcu *handler)(struct uverbs_attr_bundle *attrs);
  76. DECLARE_BITMAP(attr_mandatory, UVERBS_API_ATTR_BKEY_LEN);
  77. u16 bundle_size;
  78. u8 use_stack:1;
  79. u8 driver_method:1;
  80. u8 disabled:1;
  81. u8 has_udata:1;
  82. u8 key_bitmap_len;
  83. u8 destroy_bkey;
  84. };
  85. struct uverbs_api_write_method {
  86. int (*handler)(struct uverbs_attr_bundle *attrs);
  87. u8 disabled:1;
  88. u8 is_ex:1;
  89. u8 has_udata:1;
  90. u8 has_resp:1;
  91. u8 req_size;
  92. u8 resp_size;
  93. };
  94. struct uverbs_api_attr {
  95. struct uverbs_attr_spec spec;
  96. };
  97. struct uverbs_api {
  98. /* radix tree contains struct uverbs_api_* pointers */
  99. struct radix_tree_root radix;
  100. enum rdma_driver_id driver_id;
  101. unsigned int num_write;
  102. unsigned int num_write_ex;
  103. struct uverbs_api_write_method notsupp_method;
  104. const struct uverbs_api_write_method **write_methods;
  105. const struct uverbs_api_write_method **write_ex_methods;
  106. };
  107. /*
  108. * Get an uverbs_api_object that corresponds to the given object_id.
  109. * Note:
  110. * -ENOMSG means that any object is allowed to match during lookup.
  111. */
  112. static inline const struct uverbs_api_object *
  113. uapi_get_object(struct uverbs_api *uapi, u16 object_id)
  114. {
  115. const struct uverbs_api_object *res;
  116. if (object_id == UVERBS_IDR_ANY_OBJECT)
  117. return ERR_PTR(-ENOMSG);
  118. res = radix_tree_lookup(&uapi->radix, uapi_key_obj(object_id));
  119. if (!res)
  120. return ERR_PTR(-ENOENT);
  121. return res;
  122. }
  123. char *uapi_key_format(char *S, unsigned int key);
  124. struct uverbs_api *uverbs_alloc_api(struct ib_device *ibdev);
  125. void uverbs_disassociate_api_pre(struct ib_uverbs_device *uverbs_dev);
  126. void uverbs_disassociate_api(struct uverbs_api *uapi);
  127. void uverbs_destroy_api(struct uverbs_api *uapi);
  128. void uapi_compute_bundle_size(struct uverbs_api_ioctl_method *method_elm,
  129. unsigned int num_attrs);
  130. void uverbs_user_mmap_disassociate(struct ib_uverbs_file *ufile);
  131. extern const struct uapi_definition uverbs_def_obj_async_fd[];
  132. extern const struct uapi_definition uverbs_def_obj_counters[];
  133. extern const struct uapi_definition uverbs_def_obj_cq[];
  134. extern const struct uapi_definition uverbs_def_obj_device[];
  135. extern const struct uapi_definition uverbs_def_obj_dm[];
  136. extern const struct uapi_definition uverbs_def_obj_flow_action[];
  137. extern const struct uapi_definition uverbs_def_obj_intf[];
  138. extern const struct uapi_definition uverbs_def_obj_mr[];
  139. extern const struct uapi_definition uverbs_def_obj_qp[];
  140. extern const struct uapi_definition uverbs_def_obj_srq[];
  141. extern const struct uapi_definition uverbs_def_obj_wq[];
  142. extern const struct uapi_definition uverbs_def_write_intf[];
  143. static inline const struct uverbs_api_write_method *
  144. uapi_get_method(const struct uverbs_api *uapi, u32 command)
  145. {
  146. u32 cmd_idx = command & IB_USER_VERBS_CMD_COMMAND_MASK;
  147. if (command & ~(u32)(IB_USER_VERBS_CMD_FLAG_EXTENDED |
  148. IB_USER_VERBS_CMD_COMMAND_MASK))
  149. return ERR_PTR(-EINVAL);
  150. if (command & IB_USER_VERBS_CMD_FLAG_EXTENDED) {
  151. if (cmd_idx >= uapi->num_write_ex)
  152. return ERR_PTR(-EOPNOTSUPP);
  153. return uapi->write_ex_methods[cmd_idx];
  154. }
  155. if (cmd_idx >= uapi->num_write)
  156. return ERR_PTR(-EOPNOTSUPP);
  157. return uapi->write_methods[cmd_idx];
  158. }
  159. void uverbs_fill_udata(struct uverbs_attr_bundle *bundle,
  160. struct ib_udata *udata, unsigned int attr_in,
  161. unsigned int attr_out);
  162. #endif /* RDMA_CORE_H */