1 // SPDX-License-Identifier: GPL-2.0-or-later
6 #include <linux/module.h>
8 #include <linux/socket.h>
12 #include <xen/events.h>
13 #include <xen/grant_table.h>
15 #include <xen/xenbus.h>
16 #include <xen/interface/io/pvcalls.h>
18 #include "pvcalls-front.h"
20 #define PVCALLS_INVALID_ID UINT_MAX
21 #define PVCALLS_RING_ORDER XENBUS_MAX_RING_GRANT_ORDER
22 #define PVCALLS_NR_RSP_PER_RING __CONST_RING_SIZE(xen_pvcalls, XEN_PAGE_SIZE)
23 #define PVCALLS_FRONT_MAX_SPIN 5000
25 static struct proto pvcalls_proto = {
28 .obj_size = sizeof(struct sock),
31 struct pvcalls_bedata {
32 struct xen_pvcalls_front_ring ring;
36 struct list_head socket_mappings;
37 spinlock_t socket_lock;
39 wait_queue_head_t inflight_req;
40 struct xen_pvcalls_response rsp[PVCALLS_NR_RSP_PER_RING];
42 /* Only one front/back connection supported. */
43 static struct xenbus_device *pvcalls_front_dev;
44 static atomic_t pvcalls_refcount;
46 /* first increment refcount, then proceed */
47 #define pvcalls_enter() { \
48 atomic_inc(&pvcalls_refcount); \
51 /* first complete other operations, then decrement refcount */
52 #define pvcalls_exit() { \
53 atomic_dec(&pvcalls_refcount); \
58 struct list_head list;
65 struct pvcalls_data_intf *ring;
66 struct pvcalls_data data;
67 struct mutex in_mutex;
68 struct mutex out_mutex;
70 wait_queue_head_t inflight_conn_req;
74 * Socket status, needs to be 64-bit aligned due to the
75 * test_and_* functions which have this requirement on arm64.
77 #define PVCALLS_STATUS_UNINITALIZED 0
78 #define PVCALLS_STATUS_BIND 1
79 #define PVCALLS_STATUS_LISTEN 2
80 uint8_t status __attribute__((aligned(8)));
82 * Internal state-machine flags.
83 * Only one accept operation can be inflight for a socket.
84 * Only one poll operation can be inflight for a given socket.
85 * flags needs to be 64-bit aligned due to the test_and_*
86 * functions which have this requirement on arm64.
88 #define PVCALLS_FLAG_ACCEPT_INFLIGHT 0
89 #define PVCALLS_FLAG_POLL_INFLIGHT 1
90 #define PVCALLS_FLAG_POLL_RET 2
91 uint8_t flags __attribute__((aligned(8)));
92 uint32_t inflight_req_id;
93 struct sock_mapping *accept_map;
94 wait_queue_head_t inflight_accept_req;
99 static inline struct sock_mapping *pvcalls_enter_sock(struct socket *sock)
101 struct sock_mapping *map;
103 if (!pvcalls_front_dev ||
104 dev_get_drvdata(&pvcalls_front_dev->dev) == NULL)
105 return ERR_PTR(-ENOTCONN);
107 map = (struct sock_mapping *)sock->sk->sk_send_head;
109 return ERR_PTR(-ENOTSOCK);
112 atomic_inc(&map->refcount);
116 static inline void pvcalls_exit_sock(struct socket *sock)
118 struct sock_mapping *map;
120 map = (struct sock_mapping *)sock->sk->sk_send_head;
121 atomic_dec(&map->refcount);
125 static inline int get_request(struct pvcalls_bedata *bedata, int *req_id)
127 *req_id = bedata->ring.req_prod_pvt & (RING_SIZE(&bedata->ring) - 1);
128 if (RING_FULL(&bedata->ring) ||
129 bedata->rsp[*req_id].req_id != PVCALLS_INVALID_ID)
134 static bool pvcalls_front_write_todo(struct sock_mapping *map)
136 struct pvcalls_data_intf *intf = map->active.ring;
137 RING_IDX cons, prod, size = XEN_FLEX_RING_SIZE(PVCALLS_RING_ORDER);
140 error = intf->out_error;
141 if (error == -ENOTCONN)
146 cons = intf->out_cons;
147 prod = intf->out_prod;
148 return !!(size - pvcalls_queued(prod, cons, size));
151 static bool pvcalls_front_read_todo(struct sock_mapping *map)
153 struct pvcalls_data_intf *intf = map->active.ring;
157 cons = intf->in_cons;
158 prod = intf->in_prod;
159 error = intf->in_error;
160 return (error != 0 ||
161 pvcalls_queued(prod, cons,
162 XEN_FLEX_RING_SIZE(PVCALLS_RING_ORDER)) != 0);
165 static irqreturn_t pvcalls_front_event_handler(int irq, void *dev_id)
167 struct xenbus_device *dev = dev_id;
168 struct pvcalls_bedata *bedata;
169 struct xen_pvcalls_response *rsp;
171 int req_id = 0, more = 0, done = 0;
177 bedata = dev_get_drvdata(&dev->dev);
178 if (bedata == NULL) {
184 while (RING_HAS_UNCONSUMED_RESPONSES(&bedata->ring)) {
185 rsp = RING_GET_RESPONSE(&bedata->ring, bedata->ring.rsp_cons);
187 req_id = rsp->req_id;
188 if (rsp->cmd == PVCALLS_POLL) {
189 struct sock_mapping *map = (struct sock_mapping *)(uintptr_t)
192 clear_bit(PVCALLS_FLAG_POLL_INFLIGHT,
193 (void *)&map->passive.flags);
195 * clear INFLIGHT, then set RET. It pairs with
196 * the checks at the beginning of
197 * pvcalls_front_poll_passive.
200 set_bit(PVCALLS_FLAG_POLL_RET,
201 (void *)&map->passive.flags);
203 dst = (uint8_t *)&bedata->rsp[req_id] +
205 src = (uint8_t *)rsp + sizeof(rsp->req_id);
206 memcpy(dst, src, sizeof(*rsp) - sizeof(rsp->req_id));
208 * First copy the rest of the data, then req_id. It is
209 * paired with the barrier when accessing bedata->rsp.
212 bedata->rsp[req_id].req_id = req_id;
216 bedata->ring.rsp_cons++;
219 RING_FINAL_CHECK_FOR_RESPONSES(&bedata->ring, more);
223 wake_up(&bedata->inflight_req);
228 static void free_active_ring(struct sock_mapping *map);
230 static void pvcalls_front_destroy_active(struct pvcalls_bedata *bedata,
231 struct sock_mapping *map)
235 unbind_from_irqhandler(map->active.irq, map);
238 spin_lock(&bedata->socket_lock);
239 if (!list_empty(&map->list))
240 list_del_init(&map->list);
241 spin_unlock(&bedata->socket_lock);
244 for (i = 0; i < (1 << PVCALLS_RING_ORDER); i++)
245 gnttab_end_foreign_access(map->active.ring->ref[i], NULL);
246 gnttab_end_foreign_access(map->active.ref, NULL);
247 free_active_ring(map);
250 static void pvcalls_front_free_map(struct pvcalls_bedata *bedata,
251 struct sock_mapping *map)
253 pvcalls_front_destroy_active(bedata, map);
258 static irqreturn_t pvcalls_front_conn_handler(int irq, void *sock_map)
260 struct sock_mapping *map = sock_map;
265 wake_up_interruptible(&map->active.inflight_conn_req);
270 int pvcalls_front_socket(struct socket *sock)
272 struct pvcalls_bedata *bedata;
273 struct sock_mapping *map = NULL;
274 struct xen_pvcalls_request *req;
275 int notify, req_id, ret;
278 * PVCalls only supports domain AF_INET,
279 * type SOCK_STREAM and protocol 0 sockets for now.
281 * Check socket type here, AF_INET and protocol checks are done
284 if (sock->type != SOCK_STREAM)
288 if (!pvcalls_front_dev) {
292 bedata = dev_get_drvdata(&pvcalls_front_dev->dev);
294 map = kzalloc(sizeof(*map), GFP_KERNEL);
300 spin_lock(&bedata->socket_lock);
302 ret = get_request(bedata, &req_id);
305 spin_unlock(&bedata->socket_lock);
311 * sock->sk->sk_send_head is not used for ip sockets: reuse the
312 * field to store a pointer to the struct sock_mapping
313 * corresponding to the socket. This way, we can easily get the
314 * struct sock_mapping from the struct socket.
316 sock->sk->sk_send_head = (void *)map;
317 list_add_tail(&map->list, &bedata->socket_mappings);
319 req = RING_GET_REQUEST(&bedata->ring, req_id);
320 req->req_id = req_id;
321 req->cmd = PVCALLS_SOCKET;
322 req->u.socket.id = (uintptr_t) map;
323 req->u.socket.domain = AF_INET;
324 req->u.socket.type = SOCK_STREAM;
325 req->u.socket.protocol = IPPROTO_IP;
327 bedata->ring.req_prod_pvt++;
328 RING_PUSH_REQUESTS_AND_CHECK_NOTIFY(&bedata->ring, notify);
329 spin_unlock(&bedata->socket_lock);
331 notify_remote_via_irq(bedata->irq);
333 wait_event(bedata->inflight_req,
334 READ_ONCE(bedata->rsp[req_id].req_id) == req_id);
336 /* read req_id, then the content */
338 ret = bedata->rsp[req_id].ret;
339 bedata->rsp[req_id].req_id = PVCALLS_INVALID_ID;
344 EXPORT_SYMBOL_GPL(pvcalls_front_socket);
346 static void free_active_ring(struct sock_mapping *map)
348 if (!map->active.ring)
351 free_pages_exact(map->active.data.in,
352 PAGE_SIZE << map->active.ring->ring_order);
353 free_page((unsigned long)map->active.ring);
356 static int alloc_active_ring(struct sock_mapping *map)
360 map->active.ring = (struct pvcalls_data_intf *)
361 get_zeroed_page(GFP_KERNEL);
362 if (!map->active.ring)
365 map->active.ring->ring_order = PVCALLS_RING_ORDER;
366 bytes = alloc_pages_exact(PAGE_SIZE << PVCALLS_RING_ORDER,
367 GFP_KERNEL | __GFP_ZERO);
371 map->active.data.in = bytes;
372 map->active.data.out = bytes +
373 XEN_FLEX_RING_SIZE(PVCALLS_RING_ORDER);
378 free_active_ring(map);
382 static int create_active(struct sock_mapping *map, evtchn_port_t *evtchn)
385 int ret, irq = -1, i;
388 init_waitqueue_head(&map->active.inflight_conn_req);
390 bytes = map->active.data.in;
391 for (i = 0; i < (1 << PVCALLS_RING_ORDER); i++)
392 map->active.ring->ref[i] = gnttab_grant_foreign_access(
393 pvcalls_front_dev->otherend_id,
394 pfn_to_gfn(virt_to_pfn(bytes) + i), 0);
396 map->active.ref = gnttab_grant_foreign_access(
397 pvcalls_front_dev->otherend_id,
398 pfn_to_gfn(virt_to_pfn((void *)map->active.ring)), 0);
400 ret = xenbus_alloc_evtchn(pvcalls_front_dev, evtchn);
403 irq = bind_evtchn_to_irqhandler(*evtchn, pvcalls_front_conn_handler,
404 0, "pvcalls-frontend", map);
410 map->active.irq = irq;
411 map->active_socket = true;
412 mutex_init(&map->active.in_mutex);
413 mutex_init(&map->active.out_mutex);
419 xenbus_free_evtchn(pvcalls_front_dev, *evtchn);
423 int pvcalls_front_connect(struct socket *sock, struct sockaddr *addr,
424 int addr_len, int flags)
426 struct pvcalls_bedata *bedata;
427 struct sock_mapping *map = NULL;
428 struct xen_pvcalls_request *req;
429 int notify, req_id, ret;
430 evtchn_port_t evtchn;
432 if (addr->sa_family != AF_INET || sock->type != SOCK_STREAM)
435 map = pvcalls_enter_sock(sock);
439 bedata = dev_get_drvdata(&pvcalls_front_dev->dev);
440 ret = alloc_active_ring(map);
442 pvcalls_exit_sock(sock);
445 ret = create_active(map, &evtchn);
447 free_active_ring(map);
448 pvcalls_exit_sock(sock);
452 spin_lock(&bedata->socket_lock);
453 ret = get_request(bedata, &req_id);
455 spin_unlock(&bedata->socket_lock);
456 pvcalls_front_destroy_active(NULL, map);
457 pvcalls_exit_sock(sock);
461 req = RING_GET_REQUEST(&bedata->ring, req_id);
462 req->req_id = req_id;
463 req->cmd = PVCALLS_CONNECT;
464 req->u.connect.id = (uintptr_t)map;
465 req->u.connect.len = addr_len;
466 req->u.connect.flags = flags;
467 req->u.connect.ref = map->active.ref;
468 req->u.connect.evtchn = evtchn;
469 memcpy(req->u.connect.addr, addr, sizeof(*addr));
473 bedata->ring.req_prod_pvt++;
474 RING_PUSH_REQUESTS_AND_CHECK_NOTIFY(&bedata->ring, notify);
475 spin_unlock(&bedata->socket_lock);
478 notify_remote_via_irq(bedata->irq);
480 wait_event(bedata->inflight_req,
481 READ_ONCE(bedata->rsp[req_id].req_id) == req_id);
483 /* read req_id, then the content */
485 ret = bedata->rsp[req_id].ret;
486 bedata->rsp[req_id].req_id = PVCALLS_INVALID_ID;
487 pvcalls_exit_sock(sock);
490 EXPORT_SYMBOL_GPL(pvcalls_front_connect);
492 static int __write_ring(struct pvcalls_data_intf *intf,
493 struct pvcalls_data *data,
494 struct iov_iter *msg_iter,
497 RING_IDX cons, prod, size, masked_prod, masked_cons;
498 RING_IDX array_size = XEN_FLEX_RING_SIZE(PVCALLS_RING_ORDER);
501 error = intf->out_error;
504 cons = intf->out_cons;
505 prod = intf->out_prod;
506 /* read indexes before continuing */
509 size = pvcalls_queued(prod, cons, array_size);
510 if (size > array_size)
512 if (size == array_size)
514 if (len > array_size - size)
515 len = array_size - size;
517 masked_prod = pvcalls_mask(prod, array_size);
518 masked_cons = pvcalls_mask(cons, array_size);
520 if (masked_prod < masked_cons) {
521 len = copy_from_iter(data->out + masked_prod, len, msg_iter);
523 if (len > array_size - masked_prod) {
524 int ret = copy_from_iter(data->out + masked_prod,
525 array_size - masked_prod, msg_iter);
526 if (ret != array_size - masked_prod) {
530 len = ret + copy_from_iter(data->out, len - ret, msg_iter);
532 len = copy_from_iter(data->out + masked_prod, len, msg_iter);
536 /* write to ring before updating pointer */
538 intf->out_prod += len;
543 int pvcalls_front_sendmsg(struct socket *sock, struct msghdr *msg,
546 struct sock_mapping *map;
547 int sent, tot_sent = 0;
548 int count = 0, flags;
550 flags = msg->msg_flags;
551 if (flags & (MSG_CONFIRM|MSG_DONTROUTE|MSG_EOR|MSG_OOB))
554 map = pvcalls_enter_sock(sock);
558 mutex_lock(&map->active.out_mutex);
559 if ((flags & MSG_DONTWAIT) && !pvcalls_front_write_todo(map)) {
560 mutex_unlock(&map->active.out_mutex);
561 pvcalls_exit_sock(sock);
569 sent = __write_ring(map->active.ring,
570 &map->active.data, &msg->msg_iter,
575 notify_remote_via_irq(map->active.irq);
577 if (sent >= 0 && len > 0 && count < PVCALLS_FRONT_MAX_SPIN)
582 mutex_unlock(&map->active.out_mutex);
583 pvcalls_exit_sock(sock);
586 EXPORT_SYMBOL_GPL(pvcalls_front_sendmsg);
588 static int __read_ring(struct pvcalls_data_intf *intf,
589 struct pvcalls_data *data,
590 struct iov_iter *msg_iter,
591 size_t len, int flags)
593 RING_IDX cons, prod, size, masked_prod, masked_cons;
594 RING_IDX array_size = XEN_FLEX_RING_SIZE(PVCALLS_RING_ORDER);
597 cons = intf->in_cons;
598 prod = intf->in_prod;
599 error = intf->in_error;
600 /* get pointers before reading from the ring */
603 size = pvcalls_queued(prod, cons, array_size);
604 masked_prod = pvcalls_mask(prod, array_size);
605 masked_cons = pvcalls_mask(cons, array_size);
608 return error ?: size;
613 if (masked_prod > masked_cons) {
614 len = copy_to_iter(data->in + masked_cons, len, msg_iter);
616 if (len > (array_size - masked_cons)) {
617 int ret = copy_to_iter(data->in + masked_cons,
618 array_size - masked_cons, msg_iter);
619 if (ret != array_size - masked_cons) {
623 len = ret + copy_to_iter(data->in, len - ret, msg_iter);
625 len = copy_to_iter(data->in + masked_cons, len, msg_iter);
629 /* read data from the ring before increasing the index */
631 if (!(flags & MSG_PEEK))
632 intf->in_cons += len;
637 int pvcalls_front_recvmsg(struct socket *sock, struct msghdr *msg, size_t len,
641 struct sock_mapping *map;
643 if (flags & (MSG_CMSG_CLOEXEC|MSG_ERRQUEUE|MSG_OOB|MSG_TRUNC))
646 map = pvcalls_enter_sock(sock);
650 mutex_lock(&map->active.in_mutex);
651 if (len > XEN_FLEX_RING_SIZE(PVCALLS_RING_ORDER))
652 len = XEN_FLEX_RING_SIZE(PVCALLS_RING_ORDER);
654 while (!(flags & MSG_DONTWAIT) && !pvcalls_front_read_todo(map)) {
655 wait_event_interruptible(map->active.inflight_conn_req,
656 pvcalls_front_read_todo(map));
658 ret = __read_ring(map->active.ring, &map->active.data,
659 &msg->msg_iter, len, flags);
662 notify_remote_via_irq(map->active.irq);
664 ret = (flags & MSG_DONTWAIT) ? -EAGAIN : 0;
665 if (ret == -ENOTCONN)
668 mutex_unlock(&map->active.in_mutex);
669 pvcalls_exit_sock(sock);
672 EXPORT_SYMBOL_GPL(pvcalls_front_recvmsg);
674 int pvcalls_front_bind(struct socket *sock, struct sockaddr *addr, int addr_len)
676 struct pvcalls_bedata *bedata;
677 struct sock_mapping *map = NULL;
678 struct xen_pvcalls_request *req;
679 int notify, req_id, ret;
681 if (addr->sa_family != AF_INET || sock->type != SOCK_STREAM)
684 map = pvcalls_enter_sock(sock);
687 bedata = dev_get_drvdata(&pvcalls_front_dev->dev);
689 spin_lock(&bedata->socket_lock);
690 ret = get_request(bedata, &req_id);
692 spin_unlock(&bedata->socket_lock);
693 pvcalls_exit_sock(sock);
696 req = RING_GET_REQUEST(&bedata->ring, req_id);
697 req->req_id = req_id;
699 req->cmd = PVCALLS_BIND;
700 req->u.bind.id = (uintptr_t)map;
701 memcpy(req->u.bind.addr, addr, sizeof(*addr));
702 req->u.bind.len = addr_len;
704 init_waitqueue_head(&map->passive.inflight_accept_req);
706 map->active_socket = false;
708 bedata->ring.req_prod_pvt++;
709 RING_PUSH_REQUESTS_AND_CHECK_NOTIFY(&bedata->ring, notify);
710 spin_unlock(&bedata->socket_lock);
712 notify_remote_via_irq(bedata->irq);
714 wait_event(bedata->inflight_req,
715 READ_ONCE(bedata->rsp[req_id].req_id) == req_id);
717 /* read req_id, then the content */
719 ret = bedata->rsp[req_id].ret;
720 bedata->rsp[req_id].req_id = PVCALLS_INVALID_ID;
722 map->passive.status = PVCALLS_STATUS_BIND;
723 pvcalls_exit_sock(sock);
726 EXPORT_SYMBOL_GPL(pvcalls_front_bind);
728 int pvcalls_front_listen(struct socket *sock, int backlog)
730 struct pvcalls_bedata *bedata;
731 struct sock_mapping *map;
732 struct xen_pvcalls_request *req;
733 int notify, req_id, ret;
735 map = pvcalls_enter_sock(sock);
738 bedata = dev_get_drvdata(&pvcalls_front_dev->dev);
740 if (map->passive.status != PVCALLS_STATUS_BIND) {
741 pvcalls_exit_sock(sock);
745 spin_lock(&bedata->socket_lock);
746 ret = get_request(bedata, &req_id);
748 spin_unlock(&bedata->socket_lock);
749 pvcalls_exit_sock(sock);
752 req = RING_GET_REQUEST(&bedata->ring, req_id);
753 req->req_id = req_id;
754 req->cmd = PVCALLS_LISTEN;
755 req->u.listen.id = (uintptr_t) map;
756 req->u.listen.backlog = backlog;
758 bedata->ring.req_prod_pvt++;
759 RING_PUSH_REQUESTS_AND_CHECK_NOTIFY(&bedata->ring, notify);
760 spin_unlock(&bedata->socket_lock);
762 notify_remote_via_irq(bedata->irq);
764 wait_event(bedata->inflight_req,
765 READ_ONCE(bedata->rsp[req_id].req_id) == req_id);
767 /* read req_id, then the content */
769 ret = bedata->rsp[req_id].ret;
770 bedata->rsp[req_id].req_id = PVCALLS_INVALID_ID;
772 map->passive.status = PVCALLS_STATUS_LISTEN;
773 pvcalls_exit_sock(sock);
776 EXPORT_SYMBOL_GPL(pvcalls_front_listen);
778 int pvcalls_front_accept(struct socket *sock, struct socket *newsock,
779 struct proto_accept_arg *arg)
781 struct pvcalls_bedata *bedata;
782 struct sock_mapping *map;
783 struct sock_mapping *map2 = NULL;
784 struct xen_pvcalls_request *req;
785 int notify, req_id, ret, nonblock;
786 evtchn_port_t evtchn;
788 map = pvcalls_enter_sock(sock);
791 bedata = dev_get_drvdata(&pvcalls_front_dev->dev);
793 if (map->passive.status != PVCALLS_STATUS_LISTEN) {
794 pvcalls_exit_sock(sock);
798 nonblock = arg->flags & SOCK_NONBLOCK;
800 * Backend only supports 1 inflight accept request, will return
801 * errors for the others
803 if (test_and_set_bit(PVCALLS_FLAG_ACCEPT_INFLIGHT,
804 (void *)&map->passive.flags)) {
805 req_id = READ_ONCE(map->passive.inflight_req_id);
806 if (req_id != PVCALLS_INVALID_ID &&
807 READ_ONCE(bedata->rsp[req_id].req_id) == req_id) {
808 map2 = map->passive.accept_map;
812 pvcalls_exit_sock(sock);
815 if (wait_event_interruptible(map->passive.inflight_accept_req,
816 !test_and_set_bit(PVCALLS_FLAG_ACCEPT_INFLIGHT,
817 (void *)&map->passive.flags))) {
818 pvcalls_exit_sock(sock);
823 map2 = kzalloc(sizeof(*map2), GFP_KERNEL);
825 clear_bit(PVCALLS_FLAG_ACCEPT_INFLIGHT,
826 (void *)&map->passive.flags);
827 pvcalls_exit_sock(sock);
830 ret = alloc_active_ring(map2);
832 clear_bit(PVCALLS_FLAG_ACCEPT_INFLIGHT,
833 (void *)&map->passive.flags);
835 pvcalls_exit_sock(sock);
838 ret = create_active(map2, &evtchn);
840 free_active_ring(map2);
842 clear_bit(PVCALLS_FLAG_ACCEPT_INFLIGHT,
843 (void *)&map->passive.flags);
844 pvcalls_exit_sock(sock);
848 spin_lock(&bedata->socket_lock);
849 ret = get_request(bedata, &req_id);
851 clear_bit(PVCALLS_FLAG_ACCEPT_INFLIGHT,
852 (void *)&map->passive.flags);
853 spin_unlock(&bedata->socket_lock);
854 pvcalls_front_free_map(bedata, map2);
855 pvcalls_exit_sock(sock);
859 list_add_tail(&map2->list, &bedata->socket_mappings);
861 req = RING_GET_REQUEST(&bedata->ring, req_id);
862 req->req_id = req_id;
863 req->cmd = PVCALLS_ACCEPT;
864 req->u.accept.id = (uintptr_t) map;
865 req->u.accept.ref = map2->active.ref;
866 req->u.accept.id_new = (uintptr_t) map2;
867 req->u.accept.evtchn = evtchn;
868 map->passive.accept_map = map2;
870 bedata->ring.req_prod_pvt++;
871 RING_PUSH_REQUESTS_AND_CHECK_NOTIFY(&bedata->ring, notify);
872 spin_unlock(&bedata->socket_lock);
874 notify_remote_via_irq(bedata->irq);
875 /* We could check if we have received a response before returning. */
877 WRITE_ONCE(map->passive.inflight_req_id, req_id);
878 pvcalls_exit_sock(sock);
882 if (wait_event_interruptible(bedata->inflight_req,
883 READ_ONCE(bedata->rsp[req_id].req_id) == req_id)) {
884 pvcalls_exit_sock(sock);
887 /* read req_id, then the content */
891 map2->sock = newsock;
892 newsock->sk = sk_alloc(sock_net(sock->sk), PF_INET, GFP_KERNEL, &pvcalls_proto, false);
894 bedata->rsp[req_id].req_id = PVCALLS_INVALID_ID;
895 map->passive.inflight_req_id = PVCALLS_INVALID_ID;
896 clear_bit(PVCALLS_FLAG_ACCEPT_INFLIGHT,
897 (void *)&map->passive.flags);
898 pvcalls_front_free_map(bedata, map2);
899 pvcalls_exit_sock(sock);
902 newsock->sk->sk_send_head = (void *)map2;
904 ret = bedata->rsp[req_id].ret;
905 bedata->rsp[req_id].req_id = PVCALLS_INVALID_ID;
906 map->passive.inflight_req_id = PVCALLS_INVALID_ID;
908 clear_bit(PVCALLS_FLAG_ACCEPT_INFLIGHT, (void *)&map->passive.flags);
909 wake_up(&map->passive.inflight_accept_req);
911 pvcalls_exit_sock(sock);
914 EXPORT_SYMBOL_GPL(pvcalls_front_accept);
916 static __poll_t pvcalls_front_poll_passive(struct file *file,
917 struct pvcalls_bedata *bedata,
918 struct sock_mapping *map,
921 int notify, req_id, ret;
922 struct xen_pvcalls_request *req;
924 if (test_bit(PVCALLS_FLAG_ACCEPT_INFLIGHT,
925 (void *)&map->passive.flags)) {
926 uint32_t req_id = READ_ONCE(map->passive.inflight_req_id);
928 if (req_id != PVCALLS_INVALID_ID &&
929 READ_ONCE(bedata->rsp[req_id].req_id) == req_id)
930 return EPOLLIN | EPOLLRDNORM;
932 poll_wait(file, &map->passive.inflight_accept_req, wait);
936 if (test_and_clear_bit(PVCALLS_FLAG_POLL_RET,
937 (void *)&map->passive.flags))
938 return EPOLLIN | EPOLLRDNORM;
941 * First check RET, then INFLIGHT. No barriers necessary to
942 * ensure execution ordering because of the conditional
943 * instructions creating control dependencies.
946 if (test_and_set_bit(PVCALLS_FLAG_POLL_INFLIGHT,
947 (void *)&map->passive.flags)) {
948 poll_wait(file, &bedata->inflight_req, wait);
952 spin_lock(&bedata->socket_lock);
953 ret = get_request(bedata, &req_id);
955 spin_unlock(&bedata->socket_lock);
958 req = RING_GET_REQUEST(&bedata->ring, req_id);
959 req->req_id = req_id;
960 req->cmd = PVCALLS_POLL;
961 req->u.poll.id = (uintptr_t) map;
963 bedata->ring.req_prod_pvt++;
964 RING_PUSH_REQUESTS_AND_CHECK_NOTIFY(&bedata->ring, notify);
965 spin_unlock(&bedata->socket_lock);
967 notify_remote_via_irq(bedata->irq);
969 poll_wait(file, &bedata->inflight_req, wait);
973 static __poll_t pvcalls_front_poll_active(struct file *file,
974 struct pvcalls_bedata *bedata,
975 struct sock_mapping *map,
979 int32_t in_error, out_error;
980 struct pvcalls_data_intf *intf = map->active.ring;
982 out_error = intf->out_error;
983 in_error = intf->in_error;
985 poll_wait(file, &map->active.inflight_conn_req, wait);
986 if (pvcalls_front_write_todo(map))
987 mask |= EPOLLOUT | EPOLLWRNORM;
988 if (pvcalls_front_read_todo(map))
989 mask |= EPOLLIN | EPOLLRDNORM;
990 if (in_error != 0 || out_error != 0)
996 __poll_t pvcalls_front_poll(struct file *file, struct socket *sock,
999 struct pvcalls_bedata *bedata;
1000 struct sock_mapping *map;
1003 map = pvcalls_enter_sock(sock);
1006 bedata = dev_get_drvdata(&pvcalls_front_dev->dev);
1008 if (map->active_socket)
1009 ret = pvcalls_front_poll_active(file, bedata, map, wait);
1011 ret = pvcalls_front_poll_passive(file, bedata, map, wait);
1012 pvcalls_exit_sock(sock);
1015 EXPORT_SYMBOL_GPL(pvcalls_front_poll);
1017 int pvcalls_front_release(struct socket *sock)
1019 struct pvcalls_bedata *bedata;
1020 struct sock_mapping *map;
1021 int req_id, notify, ret;
1022 struct xen_pvcalls_request *req;
1024 if (sock->sk == NULL)
1027 map = pvcalls_enter_sock(sock);
1029 if (PTR_ERR(map) == -ENOTCONN)
1034 bedata = dev_get_drvdata(&pvcalls_front_dev->dev);
1036 spin_lock(&bedata->socket_lock);
1037 ret = get_request(bedata, &req_id);
1039 spin_unlock(&bedata->socket_lock);
1040 pvcalls_exit_sock(sock);
1043 sock->sk->sk_send_head = NULL;
1045 req = RING_GET_REQUEST(&bedata->ring, req_id);
1046 req->req_id = req_id;
1047 req->cmd = PVCALLS_RELEASE;
1048 req->u.release.id = (uintptr_t)map;
1050 bedata->ring.req_prod_pvt++;
1051 RING_PUSH_REQUESTS_AND_CHECK_NOTIFY(&bedata->ring, notify);
1052 spin_unlock(&bedata->socket_lock);
1054 notify_remote_via_irq(bedata->irq);
1056 wait_event(bedata->inflight_req,
1057 READ_ONCE(bedata->rsp[req_id].req_id) == req_id);
1059 if (map->active_socket) {
1061 * Set in_error and wake up inflight_conn_req to force
1062 * recvmsg waiters to exit.
1064 map->active.ring->in_error = -EBADF;
1065 wake_up_interruptible(&map->active.inflight_conn_req);
1068 * We need to make sure that sendmsg/recvmsg on this socket have
1069 * not started before we've cleared sk_send_head here. The
1070 * easiest way to guarantee this is to see that no pvcalls
1071 * (other than us) is in progress on this socket.
1073 while (atomic_read(&map->refcount) > 1)
1076 pvcalls_front_free_map(bedata, map);
1078 wake_up(&bedata->inflight_req);
1079 wake_up(&map->passive.inflight_accept_req);
1081 while (atomic_read(&map->refcount) > 1)
1084 spin_lock(&bedata->socket_lock);
1085 list_del(&map->list);
1086 spin_unlock(&bedata->socket_lock);
1087 if (READ_ONCE(map->passive.inflight_req_id) != PVCALLS_INVALID_ID &&
1088 READ_ONCE(map->passive.inflight_req_id) != 0) {
1089 pvcalls_front_free_map(bedata,
1090 map->passive.accept_map);
1094 WRITE_ONCE(bedata->rsp[req_id].req_id, PVCALLS_INVALID_ID);
1099 EXPORT_SYMBOL_GPL(pvcalls_front_release);
1101 static const struct xenbus_device_id pvcalls_front_ids[] = {
1106 static void pvcalls_front_remove(struct xenbus_device *dev)
1108 struct pvcalls_bedata *bedata;
1109 struct sock_mapping *map = NULL, *n;
1111 bedata = dev_get_drvdata(&pvcalls_front_dev->dev);
1112 dev_set_drvdata(&dev->dev, NULL);
1113 pvcalls_front_dev = NULL;
1114 if (bedata->irq >= 0)
1115 unbind_from_irqhandler(bedata->irq, dev);
1117 list_for_each_entry_safe(map, n, &bedata->socket_mappings, list) {
1118 map->sock->sk->sk_send_head = NULL;
1119 if (map->active_socket) {
1120 map->active.ring->in_error = -EBADF;
1121 wake_up_interruptible(&map->active.inflight_conn_req);
1126 while (atomic_read(&pvcalls_refcount) > 0)
1128 list_for_each_entry_safe(map, n, &bedata->socket_mappings, list) {
1129 if (map->active_socket) {
1130 /* No need to lock, refcount is 0 */
1131 pvcalls_front_free_map(bedata, map);
1133 list_del(&map->list);
1137 if (bedata->ref != -1)
1138 gnttab_end_foreign_access(bedata->ref, NULL);
1139 kfree(bedata->ring.sring);
1141 xenbus_switch_state(dev, XenbusStateClosed);
1144 static int pvcalls_front_probe(struct xenbus_device *dev,
1145 const struct xenbus_device_id *id)
1147 int ret = -ENOMEM, i;
1148 evtchn_port_t evtchn;
1149 unsigned int max_page_order, function_calls, len;
1151 grant_ref_t gref_head = 0;
1152 struct xenbus_transaction xbt;
1153 struct pvcalls_bedata *bedata = NULL;
1154 struct xen_pvcalls_sring *sring;
1156 if (pvcalls_front_dev != NULL) {
1157 dev_err(&dev->dev, "only one PV Calls connection supported\n");
1161 versions = xenbus_read(XBT_NIL, dev->otherend, "versions", &len);
1162 if (IS_ERR(versions))
1163 return PTR_ERR(versions);
1166 if (strcmp(versions, "1")) {
1171 max_page_order = xenbus_read_unsigned(dev->otherend,
1172 "max-page-order", 0);
1173 if (max_page_order < PVCALLS_RING_ORDER)
1175 function_calls = xenbus_read_unsigned(dev->otherend,
1176 "function-calls", 0);
1177 /* See XENBUS_FUNCTIONS_CALLS in pvcalls.h */
1178 if (function_calls != 1)
1180 pr_info("%s max-page-order is %u\n", __func__, max_page_order);
1182 bedata = kzalloc(sizeof(struct pvcalls_bedata), GFP_KERNEL);
1186 dev_set_drvdata(&dev->dev, bedata);
1187 pvcalls_front_dev = dev;
1188 init_waitqueue_head(&bedata->inflight_req);
1189 INIT_LIST_HEAD(&bedata->socket_mappings);
1190 spin_lock_init(&bedata->socket_lock);
1194 for (i = 0; i < PVCALLS_NR_RSP_PER_RING; i++)
1195 bedata->rsp[i].req_id = PVCALLS_INVALID_ID;
1197 sring = (struct xen_pvcalls_sring *) __get_free_page(GFP_KERNEL |
1201 SHARED_RING_INIT(sring);
1202 FRONT_RING_INIT(&bedata->ring, sring, XEN_PAGE_SIZE);
1204 ret = xenbus_alloc_evtchn(dev, &evtchn);
1208 bedata->irq = bind_evtchn_to_irqhandler(evtchn,
1209 pvcalls_front_event_handler,
1210 0, "pvcalls-frontend", dev);
1211 if (bedata->irq < 0) {
1216 ret = gnttab_alloc_grant_references(1, &gref_head);
1219 ret = gnttab_claim_grant_reference(&gref_head);
1223 gnttab_grant_foreign_access_ref(bedata->ref, dev->otherend_id,
1224 virt_to_gfn((void *)sring), 0);
1227 ret = xenbus_transaction_start(&xbt);
1229 xenbus_dev_fatal(dev, ret, "starting transaction");
1232 ret = xenbus_printf(xbt, dev->nodename, "version", "%u", 1);
1235 ret = xenbus_printf(xbt, dev->nodename, "ring-ref", "%d", bedata->ref);
1238 ret = xenbus_printf(xbt, dev->nodename, "port", "%u",
1242 ret = xenbus_transaction_end(xbt, 0);
1246 xenbus_dev_fatal(dev, ret, "completing transaction");
1249 xenbus_switch_state(dev, XenbusStateInitialised);
1254 xenbus_transaction_end(xbt, 1);
1255 xenbus_dev_fatal(dev, ret, "writing xenstore");
1257 pvcalls_front_remove(dev);
1261 static void pvcalls_front_changed(struct xenbus_device *dev,
1262 enum xenbus_state backend_state)
1264 switch (backend_state) {
1265 case XenbusStateReconfiguring:
1266 case XenbusStateReconfigured:
1267 case XenbusStateInitialising:
1268 case XenbusStateInitialised:
1269 case XenbusStateUnknown:
1272 case XenbusStateInitWait:
1275 case XenbusStateConnected:
1276 xenbus_switch_state(dev, XenbusStateConnected);
1279 case XenbusStateClosed:
1280 if (dev->state == XenbusStateClosed)
1282 /* Missed the backend's CLOSING state */
1284 case XenbusStateClosing:
1285 xenbus_frontend_closed(dev);
1290 static struct xenbus_driver pvcalls_front_driver = {
1291 .ids = pvcalls_front_ids,
1292 .probe = pvcalls_front_probe,
1293 .remove = pvcalls_front_remove,
1294 .otherend_changed = pvcalls_front_changed,
1295 .not_essential = true,
1298 static int __init pvcalls_frontend_init(void)
1303 pr_info("Initialising Xen pvcalls frontend driver\n");
1305 return xenbus_register_frontend(&pvcalls_front_driver);
1308 module_init(pvcalls_frontend_init);
1310 MODULE_DESCRIPTION("Xen PV Calls frontend driver");
1312 MODULE_LICENSE("GPL");