include/linux/vmw_vmci_api.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 __VMW_VMCI_API_H__
0009 #define __VMW_VMCI_API_H__
0010
0011 #include <linux/uidgid.h>
0012 #include <linux/vmw_vmci_defs.h>
0013
0014 #undef  VMCI_KERNEL_API_VERSION
0015 #define VMCI_KERNEL_API_VERSION_1 1
0016 #define VMCI_KERNEL_API_VERSION_2 2
0017 #define VMCI_KERNEL_API_VERSION   VMCI_KERNEL_API_VERSION_2
0018
0019 struct msghdr;
0020 typedef void (vmci_device_shutdown_fn) (void *device_registration,
0021                     void *user_data);
0022 typedef void (*vmci_vsock_cb) (bool is_host);
0023
0024 int vmci_datagram_create_handle(u32 resource_id, u32 flags,
0025                 vmci_datagram_recv_cb recv_cb,
0026                 void *client_data,
0027                 struct vmci_handle *out_handle);
0028 int vmci_datagram_create_handle_priv(u32 resource_id, u32 flags, u32 priv_flags,
0029                      vmci_datagram_recv_cb recv_cb,
0030                      void *client_data,
0031                      struct vmci_handle *out_handle);
0032 int vmci_datagram_destroy_handle(struct vmci_handle handle);
0033 int vmci_datagram_send(struct vmci_datagram *msg);
0034 int vmci_doorbell_create(struct vmci_handle *handle, u32 flags,
0035              u32 priv_flags,
0036              vmci_callback notify_cb, void *client_data);
0037 int vmci_doorbell_destroy(struct vmci_handle handle);
0038 int vmci_doorbell_notify(struct vmci_handle handle, u32 priv_flags);
0039 u32 vmci_get_context_id(void);
0040 bool vmci_is_context_owner(u32 context_id, kuid_t uid);
0041 int vmci_register_vsock_callback(vmci_vsock_cb callback);
0042
0043 int vmci_event_subscribe(u32 event,
0044              vmci_event_cb callback, void *callback_data,
0045              u32 *subid);
0046 int vmci_event_unsubscribe(u32 subid);
0047 u32 vmci_context_get_priv_flags(u32 context_id);
0048 int vmci_qpair_alloc(struct vmci_qp **qpair,
0049              struct vmci_handle *handle,
0050              u64 produce_qsize,
0051              u64 consume_qsize,
0052              u32 peer, u32 flags, u32 priv_flags);
0053 int vmci_qpair_detach(struct vmci_qp **qpair);
0054 int vmci_qpair_get_produce_indexes(const struct vmci_qp *qpair,
0055                    u64 *producer_tail,
0056                    u64 *consumer_head);
0057 int vmci_qpair_get_consume_indexes(const struct vmci_qp *qpair,
0058                    u64 *consumer_tail,
0059                    u64 *producer_head);
0060 s64 vmci_qpair_produce_free_space(const struct vmci_qp *qpair);
0061 s64 vmci_qpair_produce_buf_ready(const struct vmci_qp *qpair);
0062 s64 vmci_qpair_consume_free_space(const struct vmci_qp *qpair);
0063 s64 vmci_qpair_consume_buf_ready(const struct vmci_qp *qpair);
0064 ssize_t vmci_qpair_enqueue(struct vmci_qp *qpair,
0065                const void *buf, size_t buf_size, int mode);
0066 ssize_t vmci_qpair_dequeue(struct vmci_qp *qpair,
0067                void *buf, size_t buf_size, int mode);
0068 ssize_t vmci_qpair_peek(struct vmci_qp *qpair, void *buf, size_t buf_size,
0069             int mode);
0070 ssize_t vmci_qpair_enquev(struct vmci_qp *qpair,
0071               struct msghdr *msg, size_t iov_size, int mode);
0072 ssize_t vmci_qpair_dequev(struct vmci_qp *qpair,
0073               struct msghdr *msg, size_t iov_size, int mode);
0074 ssize_t vmci_qpair_peekv(struct vmci_qp *qpair, struct msghdr *msg, size_t iov_size,
0075              int mode);
0076
0077 #endif /* !__VMW_VMCI_API_H__ */