xref: /OK3568_Linux_fs/kernel/drivers/misc/vmw_vmci/vmci_handle_array.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0-only */
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun  * VMware VMCI Driver
4*4882a593Smuzhiyun  *
5*4882a593Smuzhiyun  * Copyright (C) 2012 VMware, Inc. All rights reserved.
6*4882a593Smuzhiyun  */
7*4882a593Smuzhiyun 
8*4882a593Smuzhiyun #ifndef _VMCI_HANDLE_ARRAY_H_
9*4882a593Smuzhiyun #define _VMCI_HANDLE_ARRAY_H_
10*4882a593Smuzhiyun 
11*4882a593Smuzhiyun #include <linux/vmw_vmci_defs.h>
12*4882a593Smuzhiyun #include <linux/limits.h>
13*4882a593Smuzhiyun #include <linux/types.h>
14*4882a593Smuzhiyun 
15*4882a593Smuzhiyun struct vmci_handle_arr {
16*4882a593Smuzhiyun 	u32 capacity;
17*4882a593Smuzhiyun 	u32 max_capacity;
18*4882a593Smuzhiyun 	u32 size;
19*4882a593Smuzhiyun 	u32 pad;
20*4882a593Smuzhiyun 	struct vmci_handle entries[];
21*4882a593Smuzhiyun };
22*4882a593Smuzhiyun 
23*4882a593Smuzhiyun #define VMCI_HANDLE_ARRAY_HEADER_SIZE				\
24*4882a593Smuzhiyun 	offsetof(struct vmci_handle_arr, entries)
25*4882a593Smuzhiyun /* Select a default capacity that results in a 64 byte sized array */
26*4882a593Smuzhiyun #define VMCI_HANDLE_ARRAY_DEFAULT_CAPACITY			6
27*4882a593Smuzhiyun /* Make sure that the max array size can be expressed by a u32 */
28*4882a593Smuzhiyun #define VMCI_HANDLE_ARRAY_MAX_CAPACITY				\
29*4882a593Smuzhiyun 	((U32_MAX - VMCI_HANDLE_ARRAY_HEADER_SIZE - 1) /	\
30*4882a593Smuzhiyun 	sizeof(struct vmci_handle))
31*4882a593Smuzhiyun 
32*4882a593Smuzhiyun struct vmci_handle_arr *vmci_handle_arr_create(u32 capacity, u32 max_capacity);
33*4882a593Smuzhiyun void vmci_handle_arr_destroy(struct vmci_handle_arr *array);
34*4882a593Smuzhiyun int vmci_handle_arr_append_entry(struct vmci_handle_arr **array_ptr,
35*4882a593Smuzhiyun 				 struct vmci_handle handle);
36*4882a593Smuzhiyun struct vmci_handle vmci_handle_arr_remove_entry(struct vmci_handle_arr *array,
37*4882a593Smuzhiyun 						struct vmci_handle
38*4882a593Smuzhiyun 						entry_handle);
39*4882a593Smuzhiyun struct vmci_handle vmci_handle_arr_remove_tail(struct vmci_handle_arr *array);
40*4882a593Smuzhiyun struct vmci_handle
41*4882a593Smuzhiyun vmci_handle_arr_get_entry(const struct vmci_handle_arr *array, u32 index);
42*4882a593Smuzhiyun bool vmci_handle_arr_has_entry(const struct vmci_handle_arr *array,
43*4882a593Smuzhiyun 			       struct vmci_handle entry_handle);
44*4882a593Smuzhiyun struct vmci_handle *vmci_handle_arr_get_handles(struct vmci_handle_arr *array);
45*4882a593Smuzhiyun 
vmci_handle_arr_get_size(const struct vmci_handle_arr * array)46*4882a593Smuzhiyun static inline u32 vmci_handle_arr_get_size(
47*4882a593Smuzhiyun 	const struct vmci_handle_arr *array)
48*4882a593Smuzhiyun {
49*4882a593Smuzhiyun 	return array->size;
50*4882a593Smuzhiyun }
51*4882a593Smuzhiyun 
52*4882a593Smuzhiyun 
53*4882a593Smuzhiyun #endif /* _VMCI_HANDLE_ARRAY_H_ */
54