1685a6bf8SThomas Gleixner /* SPDX-License-Identifier: GPL-2.0-only */
2b484b26cSGeorge Zhang /*
3b484b26cSGeorge Zhang  * VMware VMCI Driver
4b484b26cSGeorge Zhang  *
5b484b26cSGeorge Zhang  * Copyright (C) 2012 VMware, Inc. All rights reserved.
6b484b26cSGeorge Zhang  */
7b484b26cSGeorge Zhang 
8b484b26cSGeorge Zhang #ifndef _VMCI_HANDLE_ARRAY_H_
9b484b26cSGeorge Zhang #define _VMCI_HANDLE_ARRAY_H_
10b484b26cSGeorge Zhang 
11b484b26cSGeorge Zhang #include <linux/vmw_vmci_defs.h>
121c2eb5b2SVishnu DASA #include <linux/limits.h>
13b484b26cSGeorge Zhang #include <linux/types.h>
14b484b26cSGeorge Zhang 
15b484b26cSGeorge Zhang struct vmci_handle_arr {
161c2eb5b2SVishnu DASA 	u32 capacity;
171c2eb5b2SVishnu DASA 	u32 max_capacity;
181c2eb5b2SVishnu DASA 	u32 size;
191c2eb5b2SVishnu DASA 	u32 pad;
20b484b26cSGeorge Zhang 	struct vmci_handle entries[];
21b484b26cSGeorge Zhang };
22b484b26cSGeorge Zhang 
231c2eb5b2SVishnu DASA #define VMCI_HANDLE_ARRAY_HEADER_SIZE				\
241c2eb5b2SVishnu DASA 	offsetof(struct vmci_handle_arr, entries)
251c2eb5b2SVishnu DASA /* Select a default capacity that results in a 64 byte sized array */
261c2eb5b2SVishnu DASA #define VMCI_HANDLE_ARRAY_DEFAULT_CAPACITY			6
271c2eb5b2SVishnu DASA /* Make sure that the max array size can be expressed by a u32 */
281c2eb5b2SVishnu DASA #define VMCI_HANDLE_ARRAY_MAX_CAPACITY				\
291c2eb5b2SVishnu DASA 	((U32_MAX - VMCI_HANDLE_ARRAY_HEADER_SIZE - 1) /	\
301c2eb5b2SVishnu DASA 	sizeof(struct vmci_handle))
311c2eb5b2SVishnu DASA 
321c2eb5b2SVishnu DASA struct vmci_handle_arr *vmci_handle_arr_create(u32 capacity, u32 max_capacity);
33b484b26cSGeorge Zhang void vmci_handle_arr_destroy(struct vmci_handle_arr *array);
341c2eb5b2SVishnu DASA int vmci_handle_arr_append_entry(struct vmci_handle_arr **array_ptr,
35b484b26cSGeorge Zhang 				 struct vmci_handle handle);
36b484b26cSGeorge Zhang struct vmci_handle vmci_handle_arr_remove_entry(struct vmci_handle_arr *array,
37b484b26cSGeorge Zhang 						struct vmci_handle
38b484b26cSGeorge Zhang 						entry_handle);
39b484b26cSGeorge Zhang struct vmci_handle vmci_handle_arr_remove_tail(struct vmci_handle_arr *array);
40b484b26cSGeorge Zhang struct vmci_handle
411c2eb5b2SVishnu DASA vmci_handle_arr_get_entry(const struct vmci_handle_arr *array, u32 index);
42b484b26cSGeorge Zhang bool vmci_handle_arr_has_entry(const struct vmci_handle_arr *array,
43b484b26cSGeorge Zhang 			       struct vmci_handle entry_handle);
44b484b26cSGeorge Zhang struct vmci_handle *vmci_handle_arr_get_handles(struct vmci_handle_arr *array);
45b484b26cSGeorge Zhang 
vmci_handle_arr_get_size(const struct vmci_handle_arr * array)461c2eb5b2SVishnu DASA static inline u32 vmci_handle_arr_get_size(
47b484b26cSGeorge Zhang 	const struct vmci_handle_arr *array)
48b484b26cSGeorge Zhang {
49b484b26cSGeorge Zhang 	return array->size;
50b484b26cSGeorge Zhang }
51b484b26cSGeorge Zhang 
52b484b26cSGeorge Zhang 
53b484b26cSGeorge Zhang #endif /* _VMCI_HANDLE_ARRAY_H_ */
54