1 // SPDX-License-Identifier: GPL-2.0 OR BSD-3-Clause
3 * Copyright (c) 2015, Sony Mobile Communications Inc.
4 * Copyright (c) 2013, The Linux Foundation. All rights reserved.
5 * Copyright (c) 2020, Linaro Ltd.
8 #include <linux/module.h>
9 #include <linux/qrtr.h>
10 #include <linux/workqueue.h>
15 #include <trace/events/sock.h>
16 #define CREATE_TRACE_POINTS
17 #include <trace/events/qrtr.h>
19 static RADIX_TREE(nodes, GFP_KERNEL);
23 struct sockaddr_qrtr bcast_sq;
24 struct list_head lookups;
25 struct workqueue_struct *workqueue;
26 struct work_struct work;
30 static const char * const qrtr_ctrl_pkt_strings[] = {
31 [QRTR_TYPE_HELLO] = "hello",
32 [QRTR_TYPE_BYE] = "bye",
33 [QRTR_TYPE_NEW_SERVER] = "new-server",
34 [QRTR_TYPE_DEL_SERVER] = "del-server",
35 [QRTR_TYPE_DEL_CLIENT] = "del-client",
36 [QRTR_TYPE_RESUME_TX] = "resume-tx",
37 [QRTR_TYPE_EXIT] = "exit",
38 [QRTR_TYPE_PING] = "ping",
39 [QRTR_TYPE_NEW_LOOKUP] = "new-lookup",
40 [QRTR_TYPE_DEL_LOOKUP] = "del-lookup",
43 struct qrtr_server_filter {
45 unsigned int instance;
51 unsigned int instance;
53 struct sockaddr_qrtr sq;
59 unsigned int instance;
69 struct radix_tree_root servers;
72 static struct qrtr_node *node_get(unsigned int node_id)
74 struct qrtr_node *node;
76 node = radix_tree_lookup(&nodes, node_id);
80 /* If node didn't exist, allocate and insert it to the tree */
81 node = kzalloc(sizeof(*node), GFP_KERNEL);
87 if (radix_tree_insert(&nodes, node_id, node)) {
95 static int server_match(const struct qrtr_server *srv,
96 const struct qrtr_server_filter *f)
98 unsigned int ifilter = f->ifilter;
100 if (f->service != 0 && srv->service != f->service)
102 if (!ifilter && f->instance)
105 return (srv->instance & ifilter) == f->instance;
108 static int service_announce_new(struct sockaddr_qrtr *dest,
109 struct qrtr_server *srv)
111 struct qrtr_ctrl_pkt pkt;
112 struct msghdr msg = { };
115 trace_qrtr_ns_service_announce_new(srv->service, srv->instance,
116 srv->node, srv->port);
119 iv.iov_len = sizeof(pkt);
121 memset(&pkt, 0, sizeof(pkt));
122 pkt.cmd = cpu_to_le32(QRTR_TYPE_NEW_SERVER);
123 pkt.server.service = cpu_to_le32(srv->service);
124 pkt.server.instance = cpu_to_le32(srv->instance);
125 pkt.server.node = cpu_to_le32(srv->node);
126 pkt.server.port = cpu_to_le32(srv->port);
128 msg.msg_name = (struct sockaddr *)dest;
129 msg.msg_namelen = sizeof(*dest);
131 return kernel_sendmsg(qrtr_ns.sock, &msg, &iv, 1, sizeof(pkt));
134 static int service_announce_del(struct sockaddr_qrtr *dest,
135 struct qrtr_server *srv)
137 struct qrtr_ctrl_pkt pkt;
138 struct msghdr msg = { };
142 trace_qrtr_ns_service_announce_del(srv->service, srv->instance,
143 srv->node, srv->port);
146 iv.iov_len = sizeof(pkt);
148 memset(&pkt, 0, sizeof(pkt));
149 pkt.cmd = cpu_to_le32(QRTR_TYPE_DEL_SERVER);
150 pkt.server.service = cpu_to_le32(srv->service);
151 pkt.server.instance = cpu_to_le32(srv->instance);
152 pkt.server.node = cpu_to_le32(srv->node);
153 pkt.server.port = cpu_to_le32(srv->port);
155 msg.msg_name = (struct sockaddr *)dest;
156 msg.msg_namelen = sizeof(*dest);
158 ret = kernel_sendmsg(qrtr_ns.sock, &msg, &iv, 1, sizeof(pkt));
160 pr_err("failed to announce del service\n");
165 static void lookup_notify(struct sockaddr_qrtr *to, struct qrtr_server *srv,
168 struct qrtr_ctrl_pkt pkt;
169 struct msghdr msg = { };
174 iv.iov_len = sizeof(pkt);
176 memset(&pkt, 0, sizeof(pkt));
177 pkt.cmd = new ? cpu_to_le32(QRTR_TYPE_NEW_SERVER) :
178 cpu_to_le32(QRTR_TYPE_DEL_SERVER);
180 pkt.server.service = cpu_to_le32(srv->service);
181 pkt.server.instance = cpu_to_le32(srv->instance);
182 pkt.server.node = cpu_to_le32(srv->node);
183 pkt.server.port = cpu_to_le32(srv->port);
186 msg.msg_name = (struct sockaddr *)to;
187 msg.msg_namelen = sizeof(*to);
189 ret = kernel_sendmsg(qrtr_ns.sock, &msg, &iv, 1, sizeof(pkt));
191 pr_err("failed to send lookup notification\n");
194 static int announce_servers(struct sockaddr_qrtr *sq)
196 struct radix_tree_iter iter;
197 struct qrtr_server *srv;
198 struct qrtr_node *node;
202 node = node_get(qrtr_ns.local_node);
207 /* Announce the list of servers registered in this node */
208 radix_tree_for_each_slot(slot, &node->servers, &iter, 0) {
209 srv = radix_tree_deref_slot(slot);
212 if (radix_tree_deref_retry(srv)) {
213 slot = radix_tree_iter_retry(&iter);
216 slot = radix_tree_iter_resume(slot, &iter);
219 ret = service_announce_new(sq, srv);
221 pr_err("failed to announce new service\n");
233 static struct qrtr_server *server_add(unsigned int service,
234 unsigned int instance,
235 unsigned int node_id,
238 struct qrtr_server *srv;
239 struct qrtr_server *old;
240 struct qrtr_node *node;
242 if (!service || !port)
245 srv = kzalloc(sizeof(*srv), GFP_KERNEL);
249 srv->service = service;
250 srv->instance = instance;
254 node = node_get(node_id);
258 /* Delete the old server on the same port */
259 old = radix_tree_lookup(&node->servers, port);
261 radix_tree_delete(&node->servers, port);
265 radix_tree_insert(&node->servers, port, srv);
267 trace_qrtr_ns_server_add(srv->service, srv->instance,
268 srv->node, srv->port);
277 static int server_del(struct qrtr_node *node, unsigned int port, bool bcast)
279 struct qrtr_lookup *lookup;
280 struct qrtr_server *srv;
281 struct list_head *li;
283 srv = radix_tree_lookup(&node->servers, port);
287 radix_tree_delete(&node->servers, port);
289 /* Broadcast the removal of local servers */
290 if (srv->node == qrtr_ns.local_node && bcast)
291 service_announce_del(&qrtr_ns.bcast_sq, srv);
293 /* Announce the service's disappearance to observers */
294 list_for_each(li, &qrtr_ns.lookups) {
295 lookup = container_of(li, struct qrtr_lookup, li);
296 if (lookup->service && lookup->service != srv->service)
298 if (lookup->instance && lookup->instance != srv->instance)
301 lookup_notify(&lookup->sq, srv, false);
309 static int say_hello(struct sockaddr_qrtr *dest)
311 struct qrtr_ctrl_pkt pkt;
312 struct msghdr msg = { };
317 iv.iov_len = sizeof(pkt);
319 memset(&pkt, 0, sizeof(pkt));
320 pkt.cmd = cpu_to_le32(QRTR_TYPE_HELLO);
322 msg.msg_name = (struct sockaddr *)dest;
323 msg.msg_namelen = sizeof(*dest);
325 ret = kernel_sendmsg(qrtr_ns.sock, &msg, &iv, 1, sizeof(pkt));
327 pr_err("failed to send hello msg\n");
332 /* Announce the list of servers registered on the local node */
333 static int ctrl_cmd_hello(struct sockaddr_qrtr *sq)
341 return announce_servers(sq);
344 static int ctrl_cmd_bye(struct sockaddr_qrtr *from)
346 struct qrtr_node *local_node;
347 struct radix_tree_iter iter;
348 struct qrtr_ctrl_pkt pkt;
349 struct qrtr_server *srv;
350 struct sockaddr_qrtr sq;
351 struct msghdr msg = { };
352 struct qrtr_node *node;
358 iv.iov_len = sizeof(pkt);
360 node = node_get(from->sq_node);
365 /* Advertise removal of this client to all servers of remote node */
366 radix_tree_for_each_slot(slot, &node->servers, &iter, 0) {
367 srv = radix_tree_deref_slot(slot);
370 if (radix_tree_deref_retry(srv)) {
371 slot = radix_tree_iter_retry(&iter);
374 slot = radix_tree_iter_resume(slot, &iter);
376 server_del(node, srv->port, true);
381 /* Advertise the removal of this client to all local servers */
382 local_node = node_get(qrtr_ns.local_node);
386 memset(&pkt, 0, sizeof(pkt));
387 pkt.cmd = cpu_to_le32(QRTR_TYPE_BYE);
388 pkt.client.node = cpu_to_le32(from->sq_node);
391 radix_tree_for_each_slot(slot, &local_node->servers, &iter, 0) {
392 srv = radix_tree_deref_slot(slot);
395 if (radix_tree_deref_retry(srv)) {
396 slot = radix_tree_iter_retry(&iter);
399 slot = radix_tree_iter_resume(slot, &iter);
402 sq.sq_family = AF_QIPCRTR;
403 sq.sq_node = srv->node;
404 sq.sq_port = srv->port;
406 msg.msg_name = (struct sockaddr *)&sq;
407 msg.msg_namelen = sizeof(sq);
409 ret = kernel_sendmsg(qrtr_ns.sock, &msg, &iv, 1, sizeof(pkt));
411 pr_err("failed to send bye cmd\n");
422 static int ctrl_cmd_del_client(struct sockaddr_qrtr *from,
423 unsigned int node_id, unsigned int port)
425 struct qrtr_node *local_node;
426 struct radix_tree_iter iter;
427 struct qrtr_lookup *lookup;
428 struct qrtr_ctrl_pkt pkt;
429 struct msghdr msg = { };
430 struct qrtr_server *srv;
431 struct sockaddr_qrtr sq;
432 struct qrtr_node *node;
433 struct list_head *tmp;
434 struct list_head *li;
440 iv.iov_len = sizeof(pkt);
442 /* Don't accept spoofed messages */
443 if (from->sq_node != node_id)
446 /* Local DEL_CLIENT messages comes from the port being closed */
447 if (from->sq_node == qrtr_ns.local_node && from->sq_port != port)
450 /* Remove any lookups by this client */
451 list_for_each_safe(li, tmp, &qrtr_ns.lookups) {
452 lookup = container_of(li, struct qrtr_lookup, li);
453 if (lookup->sq.sq_node != node_id)
455 if (lookup->sq.sq_port != port)
458 list_del(&lookup->li);
462 /* Remove the server belonging to this port but don't broadcast
463 * DEL_SERVER. Neighbours would've already removed the server belonging
464 * to this port due to the DEL_CLIENT broadcast from qrtr_port_remove().
466 node = node_get(node_id);
468 server_del(node, port, false);
470 /* Advertise the removal of this client to all local servers */
471 local_node = node_get(qrtr_ns.local_node);
475 memset(&pkt, 0, sizeof(pkt));
476 pkt.cmd = cpu_to_le32(QRTR_TYPE_DEL_CLIENT);
477 pkt.client.node = cpu_to_le32(node_id);
478 pkt.client.port = cpu_to_le32(port);
481 radix_tree_for_each_slot(slot, &local_node->servers, &iter, 0) {
482 srv = radix_tree_deref_slot(slot);
485 if (radix_tree_deref_retry(srv)) {
486 slot = radix_tree_iter_retry(&iter);
489 slot = radix_tree_iter_resume(slot, &iter);
492 sq.sq_family = AF_QIPCRTR;
493 sq.sq_node = srv->node;
494 sq.sq_port = srv->port;
496 msg.msg_name = (struct sockaddr *)&sq;
497 msg.msg_namelen = sizeof(sq);
499 ret = kernel_sendmsg(qrtr_ns.sock, &msg, &iv, 1, sizeof(pkt));
501 pr_err("failed to send del client cmd\n");
512 static int ctrl_cmd_new_server(struct sockaddr_qrtr *from,
513 unsigned int service, unsigned int instance,
514 unsigned int node_id, unsigned int port)
516 struct qrtr_lookup *lookup;
517 struct qrtr_server *srv;
518 struct list_head *li;
521 /* Ignore specified node and port for local servers */
522 if (from->sq_node == qrtr_ns.local_node) {
523 node_id = from->sq_node;
524 port = from->sq_port;
527 srv = server_add(service, instance, node_id, port);
531 if (srv->node == qrtr_ns.local_node) {
532 ret = service_announce_new(&qrtr_ns.bcast_sq, srv);
534 pr_err("failed to announce new service\n");
539 /* Notify any potential lookups about the new server */
540 list_for_each(li, &qrtr_ns.lookups) {
541 lookup = container_of(li, struct qrtr_lookup, li);
542 if (lookup->service && lookup->service != service)
544 if (lookup->instance && lookup->instance != instance)
547 lookup_notify(&lookup->sq, srv, true);
553 static int ctrl_cmd_del_server(struct sockaddr_qrtr *from,
554 unsigned int service, unsigned int instance,
555 unsigned int node_id, unsigned int port)
557 struct qrtr_node *node;
559 /* Ignore specified node and port for local servers*/
560 if (from->sq_node == qrtr_ns.local_node) {
561 node_id = from->sq_node;
562 port = from->sq_port;
565 /* Local servers may only unregister themselves */
566 if (from->sq_node == qrtr_ns.local_node && from->sq_port != port)
569 node = node_get(node_id);
573 return server_del(node, port, true);
576 static int ctrl_cmd_new_lookup(struct sockaddr_qrtr *from,
577 unsigned int service, unsigned int instance)
579 struct radix_tree_iter node_iter;
580 struct qrtr_server_filter filter;
581 struct radix_tree_iter srv_iter;
582 struct qrtr_lookup *lookup;
583 struct qrtr_node *node;
584 void __rcu **node_slot;
585 void __rcu **srv_slot;
587 /* Accept only local observers */
588 if (from->sq_node != qrtr_ns.local_node)
591 lookup = kzalloc(sizeof(*lookup), GFP_KERNEL);
596 lookup->service = service;
597 lookup->instance = instance;
598 list_add_tail(&lookup->li, &qrtr_ns.lookups);
600 memset(&filter, 0, sizeof(filter));
601 filter.service = service;
602 filter.instance = instance;
605 radix_tree_for_each_slot(node_slot, &nodes, &node_iter, 0) {
606 node = radix_tree_deref_slot(node_slot);
609 if (radix_tree_deref_retry(node)) {
610 node_slot = radix_tree_iter_retry(&node_iter);
613 node_slot = radix_tree_iter_resume(node_slot, &node_iter);
615 radix_tree_for_each_slot(srv_slot, &node->servers,
617 struct qrtr_server *srv;
619 srv = radix_tree_deref_slot(srv_slot);
622 if (radix_tree_deref_retry(srv)) {
623 srv_slot = radix_tree_iter_retry(&srv_iter);
627 if (!server_match(srv, &filter))
630 srv_slot = radix_tree_iter_resume(srv_slot, &srv_iter);
633 lookup_notify(from, srv, true);
639 /* Empty notification, to indicate end of listing */
640 lookup_notify(from, NULL, true);
645 static void ctrl_cmd_del_lookup(struct sockaddr_qrtr *from,
646 unsigned int service, unsigned int instance)
648 struct qrtr_lookup *lookup;
649 struct list_head *tmp;
650 struct list_head *li;
652 list_for_each_safe(li, tmp, &qrtr_ns.lookups) {
653 lookup = container_of(li, struct qrtr_lookup, li);
654 if (lookup->sq.sq_node != from->sq_node)
656 if (lookup->sq.sq_port != from->sq_port)
658 if (lookup->service != service)
660 if (lookup->instance && lookup->instance != instance)
663 list_del(&lookup->li);
668 static void qrtr_ns_worker(struct work_struct *work)
670 const struct qrtr_ctrl_pkt *pkt;
671 size_t recv_buf_size = 4096;
672 struct sockaddr_qrtr sq;
673 struct msghdr msg = { };
680 msg.msg_name = (struct sockaddr *)&sq;
681 msg.msg_namelen = sizeof(sq);
683 recv_buf = kzalloc(recv_buf_size, GFP_KERNEL);
688 iv.iov_base = recv_buf;
689 iv.iov_len = recv_buf_size;
691 msglen = kernel_recvmsg(qrtr_ns.sock, &msg, &iv, 1,
692 iv.iov_len, MSG_DONTWAIT);
694 if (msglen == -EAGAIN)
698 pr_err("error receiving packet: %zd\n", msglen);
703 cmd = le32_to_cpu(pkt->cmd);
704 if (cmd < ARRAY_SIZE(qrtr_ctrl_pkt_strings) &&
705 qrtr_ctrl_pkt_strings[cmd])
706 trace_qrtr_ns_message(qrtr_ctrl_pkt_strings[cmd],
707 sq.sq_node, sq.sq_port);
711 case QRTR_TYPE_HELLO:
712 ret = ctrl_cmd_hello(&sq);
715 ret = ctrl_cmd_bye(&sq);
717 case QRTR_TYPE_DEL_CLIENT:
718 ret = ctrl_cmd_del_client(&sq,
719 le32_to_cpu(pkt->client.node),
720 le32_to_cpu(pkt->client.port));
722 case QRTR_TYPE_NEW_SERVER:
723 ret = ctrl_cmd_new_server(&sq,
724 le32_to_cpu(pkt->server.service),
725 le32_to_cpu(pkt->server.instance),
726 le32_to_cpu(pkt->server.node),
727 le32_to_cpu(pkt->server.port));
729 case QRTR_TYPE_DEL_SERVER:
730 ret = ctrl_cmd_del_server(&sq,
731 le32_to_cpu(pkt->server.service),
732 le32_to_cpu(pkt->server.instance),
733 le32_to_cpu(pkt->server.node),
734 le32_to_cpu(pkt->server.port));
738 case QRTR_TYPE_RESUME_TX:
740 case QRTR_TYPE_NEW_LOOKUP:
741 ret = ctrl_cmd_new_lookup(&sq,
742 le32_to_cpu(pkt->server.service),
743 le32_to_cpu(pkt->server.instance));
745 case QRTR_TYPE_DEL_LOOKUP:
746 ctrl_cmd_del_lookup(&sq,
747 le32_to_cpu(pkt->server.service),
748 le32_to_cpu(pkt->server.instance));
753 pr_err("failed while handling packet from %d:%d",
754 sq.sq_node, sq.sq_port);
760 static void qrtr_ns_data_ready(struct sock *sk)
762 trace_sk_data_ready(sk);
764 queue_work(qrtr_ns.workqueue, &qrtr_ns.work);
767 int qrtr_ns_init(void)
769 struct sockaddr_qrtr sq;
772 INIT_LIST_HEAD(&qrtr_ns.lookups);
773 INIT_WORK(&qrtr_ns.work, qrtr_ns_worker);
775 ret = sock_create_kern(&init_net, AF_QIPCRTR, SOCK_DGRAM,
776 PF_QIPCRTR, &qrtr_ns.sock);
780 ret = kernel_getsockname(qrtr_ns.sock, (struct sockaddr *)&sq);
782 pr_err("failed to get socket name\n");
786 qrtr_ns.workqueue = alloc_workqueue("qrtr_ns_handler", WQ_UNBOUND, 1);
787 if (!qrtr_ns.workqueue) {
792 qrtr_ns.sock->sk->sk_data_ready = qrtr_ns_data_ready;
794 sq.sq_port = QRTR_PORT_CTRL;
795 qrtr_ns.local_node = sq.sq_node;
797 ret = kernel_bind(qrtr_ns.sock, (struct sockaddr *)&sq, sizeof(sq));
799 pr_err("failed to bind to socket\n");
803 qrtr_ns.bcast_sq.sq_family = AF_QIPCRTR;
804 qrtr_ns.bcast_sq.sq_node = QRTR_NODE_BCAST;
805 qrtr_ns.bcast_sq.sq_port = QRTR_PORT_CTRL;
807 ret = say_hello(&qrtr_ns.bcast_sq);
814 destroy_workqueue(qrtr_ns.workqueue);
816 sock_release(qrtr_ns.sock);
819 EXPORT_SYMBOL_GPL(qrtr_ns_init);
821 void qrtr_ns_remove(void)
823 cancel_work_sync(&qrtr_ns.work);
824 destroy_workqueue(qrtr_ns.workqueue);
825 sock_release(qrtr_ns.sock);
827 EXPORT_SYMBOL_GPL(qrtr_ns_remove);
830 MODULE_DESCRIPTION("Qualcomm IPC Router Nameservice");
831 MODULE_LICENSE("Dual BSD/GPL");