misc/vmw_vmci/vmci_handle_array.h

0001 /* SPDX-License-Identifier: GPL-2.0-only */
0002 /*
0003  * VMware VMCI Driver
0004  *
0005  * Copyright (C) 2012 VMware, Inc. All rights reserved.
0006  */
0007
0008 #ifndef _VMCI_HANDLE_ARRAY_H_
0009 #define _VMCI_HANDLE_ARRAY_H_
0010
0011 #include <linux/vmw_vmci_defs.h>
0012 #include <linux/limits.h>
0013 #include <linux/types.h>
0014
0015 struct vmci_handle_arr {
0016     u32 capacity;
0017     u32 max_capacity;
0018     u32 size;
0019     u32 pad;
0020     struct vmci_handle entries[];
0021 };
0022
0023 #define VMCI_HANDLE_ARRAY_HEADER_SIZE               \
0024     offsetof(struct vmci_handle_arr, entries)
0025 /* Select a default capacity that results in a 64 byte sized array */
0026 #define VMCI_HANDLE_ARRAY_DEFAULT_CAPACITY          6
0027 /* Make sure that the max array size can be expressed by a u32 */
0028 #define VMCI_HANDLE_ARRAY_MAX_CAPACITY              \
0029     ((U32_MAX - VMCI_HANDLE_ARRAY_HEADER_SIZE - 1) /    \
0030     sizeof(struct vmci_handle))
0031
0032 struct vmci_handle_arr *vmci_handle_arr_create(u32 capacity, u32 max_capacity);
0033 void vmci_handle_arr_destroy(struct vmci_handle_arr *array);
0034 int vmci_handle_arr_append_entry(struct vmci_handle_arr **array_ptr,
0035                  struct vmci_handle handle);
0036 struct vmci_handle vmci_handle_arr_remove_entry(struct vmci_handle_arr *array,
0037                         struct vmci_handle
0038                         entry_handle);
0039 struct vmci_handle vmci_handle_arr_remove_tail(struct vmci_handle_arr *array);
0040 struct vmci_handle
0041 vmci_handle_arr_get_entry(const struct vmci_handle_arr *array, u32 index);
0042 bool vmci_handle_arr_has_entry(const struct vmci_handle_arr *array,
0043                    struct vmci_handle entry_handle);
0044 struct vmci_handle *vmci_handle_arr_get_handles(struct vmci_handle_arr *array);
0045
0046 static inline u32 vmci_handle_arr_get_size(
0047     const struct vmci_handle_arr *array)
0048 {
0049     return array->size;
0050 }
0051
0052
0053 #endif /* _VMCI_HANDLE_ARRAY_H_ */