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 37 #ifndef RDMA_CORE_H 38 #define RDMA_CORE_H 39 40 #include <linux/idr.h> 41 #include <rdma/uverbs_types.h> 42 #include <rdma/ib_verbs.h> 43 #include <linux/mutex.h> 44 45 /* 46 * These functions initialize the context and cleanups its uobjects. 47 * The context has a list of objects which is protected by a mutex 48 * on the context. initialize_ucontext should be called when we create 49 * a context. 50 * cleanup_ucontext removes all uobjects from the context and puts them. 51 */ 52 void uverbs_cleanup_ucontext(struct ib_ucontext *ucontext, bool device_removed); 53 void uverbs_initialize_ucontext(struct ib_ucontext *ucontext); 54 55 /* 56 * uverbs_uobject_get is called in order to increase the reference count on 57 * an uobject. This is useful when a handler wants to keep the uobject's memory 58 * alive, regardless if this uobject is still alive in the context's objects 59 * repository. Objects are put via uverbs_uobject_put. 60 */ 61 void uverbs_uobject_get(struct ib_uobject *uobject); 62 63 /* 64 * In order to indicate we no longer needs this uobject, uverbs_uobject_put 65 * is called. When the reference count is decreased, the uobject is freed. 66 * For example, this is used when attaching a completion channel to a CQ. 67 */ 68 void uverbs_uobject_put(struct ib_uobject *uobject); 69 70 /* Indicate this fd is no longer used by this consumer, but its memory isn't 71 * necessarily released yet. When the last reference is put, we release the 72 * memory. After this call is executed, calling uverbs_uobject_get isn't 73 * allowed. 74 * This must be called from the release file_operations of the file! 75 */ 76 void uverbs_close_fd(struct file *f); 77 78 #endif /* RDMA_CORE_H */ 79