diff options
author | John Levon <john.levon@nutanix.com> | 2020-11-24 09:43:59 +0000 |
---|---|---|
committer | GitHub <noreply@github.com> | 2020-11-24 09:43:59 +0000 |
commit | 5d58b0a7c30fb5b5a1167dc49b1322447b139f71 (patch) | |
tree | a1ae7b5dae7ff352566103ec6c61a14b9de80ee5 /lib/tran_sock.h | |
parent | 3b8d4018aa01cb4896b27cff1777beec20d27096 (diff) | |
download | libvfio-user-5d58b0a7c30fb5b5a1167dc49b1322447b139f71.zip libvfio-user-5d58b0a7c30fb5b5a1167dc49b1322447b139f71.tar.gz libvfio-user-5d58b0a7c30fb5b5a1167dc49b1322447b139f71.tar.bz2 |
refactor sock send/recv functions (#114)
Use shorter, more readable, function names, add re-jig the wrappers such that
the most common operations are shortest.
Diffstat (limited to 'lib/tran_sock.h')
-rw-r--r-- | lib/tran_sock.h | 90 |
1 files changed, 63 insertions, 27 deletions
diff --git a/lib/tran_sock.h b/lib/tran_sock.h index cbd6603..9add12c 100644 --- a/lib/tran_sock.h +++ b/lib/tran_sock.h @@ -48,44 +48,80 @@ extern struct transport_ops sock_transport_ops; -int -parse_version_json(const char *json_str, int *client_max_fdsp, size_t *pgsizep); +/* + * Parse JSON supplied from the other side into the known parameters. Note: they + * will not be set if not found in the JSON. + */ +int vfio_user_parse_version_json(const char *json_str, int *client_max_fdsp, + size_t *pgsizep); -int -_send_vfio_user_msg(int sock, uint16_t msg_id, bool is_reply, - enum vfio_user_command cmd, - struct iovec *iovecs, size_t nr_iovecs, - int *fds, int count, int err); +/* + * Send a message to the other end. The iovecs array should leave the first + * entry empty, as it will be used for the header. + */ +int vfio_user_send_iovec(int sock, uint16_t msg_id, bool is_reply, + enum vfio_user_command cmd, + struct iovec *iovecs, size_t nr_iovecs, + int *fds, int count, + int err); -int -send_vfio_user_msg(int sock, uint16_t msg_id, bool is_reply, +/* + * Send a message to the other end with the given data. + */ +int vfio_user_send(int sock, uint16_t msg_id, bool is_reply, enum vfio_user_command cmd, - void *data, size_t data_len, - int *fds, size_t count); - + void *data, size_t data_len); -int -recv_vfio_user_msg(int sock, struct vfio_user_header *hdr, bool is_reply, - uint16_t *msg_id, void *data, size_t *len); +/* + * Send an empty reply back to the other end with the given errno. + */ +int vfio_user_send_error(int sock, uint16_t msg_id, + enum vfio_user_command cmd, + int error); -int -recv_vfio_user_msg_alloc(int sock, struct vfio_user_header *hdr, bool is_reply, - uint16_t *msg_id, void **datap, size_t *lenp); +/* + * Receive a message from the other end, and place the data into the given + * buffer. If data is supplied by the other end, it must be exactly *len in + * size. + */ +int vfio_user_recv(int sock, struct vfio_user_header *hdr, + bool is_reply, uint16_t *msg_id, + void *data, size_t *len); -int -_send_recv_vfio_user_msg(int sock, uint16_t msg_id, enum vfio_user_command cmd, - struct iovec *iovecs, size_t nr_iovecs, - int *send_fds, size_t fd_count, - struct vfio_user_header *hdr, - void *recv_data, size_t recv_len); +/* + * Receive a message from the other end, but automatically allocate a buffer for + * it, which must be freed by the caller. If there is no data, *datap is set to + * NULL. + */ +int vfio_user_recv_alloc(int sock, struct vfio_user_header *hdr, + bool is_reply, uint16_t *msg_id, + void **datap, size_t *lenp); -int -send_recv_vfio_user_msg(int sock, uint16_t msg_id, enum vfio_user_command cmd, - void *send_data, size_t send_len, +/* + * Send and receive a message to the other end, using iovecs for the send. The + * iovecs array should leave the first entry empty, as it will be used for the + * header. + * + * If specified, the given fds are sent to the other side. @hdr is filled with + * the reply header if non-NULL. + */ +int vfio_user_msg_iovec(int sock, uint16_t msg_id, + enum vfio_user_command cmd, + struct iovec *iovecs, size_t nr_iovecs, int *send_fds, size_t fd_count, struct vfio_user_header *hdr, void *recv_data, size_t recv_len); +/* + * Send and receive a message to the other end. @hdr is filled with the reply + * header if non-NULL. + */ +int vfio_user_msg(int sock, uint16_t msg_id, + enum vfio_user_command cmd, + void *send_data, size_t send_len, + struct vfio_user_header *hdr, + void *recv_data, size_t recv_len); + #endif /* TRAN_SOCK_H */ /* ex: set tabstop=4 shiftwidth=4 softtabstop=4 expandtab: */ |