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 #define CREATE_TRACE_POINTS
16 #include <trace/events/qrtr.h>
18 static RADIX_TREE(nodes, GFP_KERNEL);
22 struct sockaddr_qrtr bcast_sq;
23 struct list_head lookups;
24 struct workqueue_struct *workqueue;
25 struct work_struct work;
29 static const char * const qrtr_ctrl_pkt_strings[] = {
30 [QRTR_TYPE_HELLO] = "hello",
31 [QRTR_TYPE_BYE] = "bye",
32 [QRTR_TYPE_NEW_SERVER] = "new-server",
33 [QRTR_TYPE_DEL_SERVER] = "del-server",
34 [QRTR_TYPE_DEL_CLIENT] = "del-client",
35 [QRTR_TYPE_RESUME_TX] = "resume-tx",
36 [QRTR_TYPE_EXIT] = "exit",
37 [QRTR_TYPE_PING] = "ping",
38 [QRTR_TYPE_NEW_LOOKUP] = "new-lookup",
39 [QRTR_TYPE_DEL_LOOKUP] = "del-lookup",
42 struct qrtr_server_filter {
44 unsigned int instance;
50 unsigned int instance;
52 struct sockaddr_qrtr sq;
58 unsigned int instance;
68 struct radix_tree_root servers;
71 static struct qrtr_node *node_get(unsigned int node_id)
73 struct qrtr_node *node;
75 node = radix_tree_lookup(&nodes, node_id);
79 /* If node didn't exist, allocate and insert it to the tree */
80 node = kzalloc(sizeof(*node), GFP_KERNEL);
86 if (radix_tree_insert(&nodes, node_id, node)) {
94 static int server_match(const struct qrtr_server *srv,
95 const struct qrtr_server_filter *f)
97 unsigned int ifilter = f->ifilter;
99 if (f->service != 0 && srv->service != f->service)
101 if (!ifilter && f->instance)
104 return (srv->instance & ifilter) == f->instance;
107 static int service_announce_new(struct sockaddr_qrtr *dest,
108 struct qrtr_server *srv)
110 struct qrtr_ctrl_pkt pkt;
111 struct msghdr msg = { };
114 trace_qrtr_ns_service_announce_new(srv->service, srv->instance,
115 srv->node, srv->port);
118 iv.iov_len = sizeof(pkt);
120 memset(&pkt, 0, sizeof(pkt));
121 pkt.cmd = cpu_to_le32(QRTR_TYPE_NEW_SERVER);
122 pkt.server.service = cpu_to_le32(srv->service);
123 pkt.server.instance = cpu_to_le32(srv->instance);
124 pkt.server.node = cpu_to_le32(srv->node);
125 pkt.server.port = cpu_to_le32(srv->port);
127 msg.msg_name = (struct sockaddr *)dest;
128 msg.msg_namelen = sizeof(*dest);
130 return kernel_sendmsg(qrtr_ns.sock, &msg, &iv, 1, sizeof(pkt));
133 static int service_announce_del(struct sockaddr_qrtr *dest,
134 struct qrtr_server *srv)
136 struct qrtr_ctrl_pkt pkt;
137 struct msghdr msg = { };
141 trace_qrtr_ns_service_announce_del(srv->service, srv->instance,
142 srv->node, srv->port);
145 iv.iov_len = sizeof(pkt);
147 memset(&pkt, 0, sizeof(pkt));
148 pkt.cmd = cpu_to_le32(QRTR_TYPE_DEL_SERVER);
149 pkt.server.service = cpu_to_le32(srv->service);
150 pkt.server.instance = cpu_to_le32(srv->instance);
151 pkt.server.node = cpu_to_le32(srv->node);
152 pkt.server.port = cpu_to_le32(srv->port);
154 msg.msg_name = (struct sockaddr *)dest;
155 msg.msg_namelen = sizeof(*dest);
157 ret = kernel_sendmsg(qrtr_ns.sock, &msg, &iv, 1, sizeof(pkt));
159 pr_err("failed to announce del service\n");
164 static void lookup_notify(struct sockaddr_qrtr *to, struct qrtr_server *srv,
167 struct qrtr_ctrl_pkt pkt;
168 struct msghdr msg = { };
173 iv.iov_len = sizeof(pkt);
175 memset(&pkt, 0, sizeof(pkt));
176 pkt.cmd = new ? cpu_to_le32(QRTR_TYPE_NEW_SERVER) :
177 cpu_to_le32(QRTR_TYPE_DEL_SERVER);
179 pkt.server.service = cpu_to_le32(srv->service);
180 pkt.server.instance = cpu_to_le32(srv->instance);
181 pkt.server.node = cpu_to_le32(srv->node);
182 pkt.server.port = cpu_to_le32(srv->port);
185 msg.msg_name = (struct sockaddr *)to;
186 msg.msg_namelen = sizeof(*to);
188 ret = kernel_sendmsg(qrtr_ns.sock, &msg, &iv, 1, sizeof(pkt));
190 pr_err("failed to send lookup notification\n");
193 static int announce_servers(struct sockaddr_qrtr *sq)
195 struct radix_tree_iter iter;
196 struct qrtr_server *srv;
197 struct qrtr_node *node;
201 node = node_get(qrtr_ns.local_node);
206 /* Announce the list of servers registered in this node */
207 radix_tree_for_each_slot(slot, &node->servers, &iter, 0) {
208 srv = radix_tree_deref_slot(slot);
211 if (radix_tree_deref_retry(srv)) {
212 slot = radix_tree_iter_retry(&iter);
215 slot = radix_tree_iter_resume(slot, &iter);
218 ret = service_announce_new(sq, srv);
220 pr_err("failed to announce new service\n");
232 static struct qrtr_server *server_add(unsigned int service,
233 unsigned int instance,
234 unsigned int node_id,
237 struct qrtr_server *srv;
238 struct qrtr_server *old;
239 struct qrtr_node *node;
241 if (!service || !port)
244 srv = kzalloc(sizeof(*srv), GFP_KERNEL);
248 srv->service = service;
249 srv->instance = instance;
253 node = node_get(node_id);
257 /* Delete the old server on the same port */
258 old = radix_tree_lookup(&node->servers, port);
260 radix_tree_delete(&node->servers, port);
264 radix_tree_insert(&node->servers, port, srv);
266 trace_qrtr_ns_server_add(srv->service, srv->instance,
267 srv->node, srv->port);
276 static int server_del(struct qrtr_node *node, unsigned int port)
278 struct qrtr_lookup *lookup;
279 struct qrtr_server *srv;
280 struct list_head *li;
282 srv = radix_tree_lookup(&node->servers, port);
286 radix_tree_delete(&node->servers, port);
288 /* Broadcast the removal of local servers */
289 if (srv->node == qrtr_ns.local_node)
290 service_announce_del(&qrtr_ns.bcast_sq, srv);
292 /* Announce the service's disappearance to observers */
293 list_for_each(li, &qrtr_ns.lookups) {
294 lookup = container_of(li, struct qrtr_lookup, li);
295 if (lookup->service && lookup->service != srv->service)
297 if (lookup->instance && lookup->instance != srv->instance)
300 lookup_notify(&lookup->sq, srv, false);
308 static int say_hello(struct sockaddr_qrtr *dest)
310 struct qrtr_ctrl_pkt pkt;
311 struct msghdr msg = { };
316 iv.iov_len = sizeof(pkt);
318 memset(&pkt, 0, sizeof(pkt));
319 pkt.cmd = cpu_to_le32(QRTR_TYPE_HELLO);
321 msg.msg_name = (struct sockaddr *)dest;
322 msg.msg_namelen = sizeof(*dest);
324 ret = kernel_sendmsg(qrtr_ns.sock, &msg, &iv, 1, sizeof(pkt));
326 pr_err("failed to send hello msg\n");
331 /* Announce the list of servers registered on the local node */
332 static int ctrl_cmd_hello(struct sockaddr_qrtr *sq)
340 return announce_servers(sq);
343 static int ctrl_cmd_bye(struct sockaddr_qrtr *from)
345 struct qrtr_node *local_node;
346 struct radix_tree_iter iter;
347 struct qrtr_ctrl_pkt pkt;
348 struct qrtr_server *srv;
349 struct sockaddr_qrtr sq;
350 struct msghdr msg = { };
351 struct qrtr_node *node;
357 iv.iov_len = sizeof(pkt);
359 node = node_get(from->sq_node);
364 /* Advertise removal of this client to all servers of remote node */
365 radix_tree_for_each_slot(slot, &node->servers, &iter, 0) {
366 srv = radix_tree_deref_slot(slot);
369 if (radix_tree_deref_retry(srv)) {
370 slot = radix_tree_iter_retry(&iter);
373 slot = radix_tree_iter_resume(slot, &iter);
375 server_del(node, srv->port);
380 /* Advertise the removal of this client to all local servers */
381 local_node = node_get(qrtr_ns.local_node);
385 memset(&pkt, 0, sizeof(pkt));
386 pkt.cmd = cpu_to_le32(QRTR_TYPE_BYE);
387 pkt.client.node = cpu_to_le32(from->sq_node);
390 radix_tree_for_each_slot(slot, &local_node->servers, &iter, 0) {
391 srv = radix_tree_deref_slot(slot);
394 if (radix_tree_deref_retry(srv)) {
395 slot = radix_tree_iter_retry(&iter);
398 slot = radix_tree_iter_resume(slot, &iter);
401 sq.sq_family = AF_QIPCRTR;
402 sq.sq_node = srv->node;
403 sq.sq_port = srv->port;
405 msg.msg_name = (struct sockaddr *)&sq;
406 msg.msg_namelen = sizeof(sq);
408 ret = kernel_sendmsg(qrtr_ns.sock, &msg, &iv, 1, sizeof(pkt));
410 pr_err("failed to send bye cmd\n");
421 static int ctrl_cmd_del_client(struct sockaddr_qrtr *from,
422 unsigned int node_id, unsigned int port)
424 struct qrtr_node *local_node;
425 struct radix_tree_iter iter;
426 struct qrtr_lookup *lookup;
427 struct qrtr_ctrl_pkt pkt;
428 struct msghdr msg = { };
429 struct qrtr_server *srv;
430 struct sockaddr_qrtr sq;
431 struct qrtr_node *node;
432 struct list_head *tmp;
433 struct list_head *li;
439 iv.iov_len = sizeof(pkt);
441 /* Don't accept spoofed messages */
442 if (from->sq_node != node_id)
445 /* Local DEL_CLIENT messages comes from the port being closed */
446 if (from->sq_node == qrtr_ns.local_node && from->sq_port != port)
449 /* Remove any lookups by this client */
450 list_for_each_safe(li, tmp, &qrtr_ns.lookups) {
451 lookup = container_of(li, struct qrtr_lookup, li);
452 if (lookup->sq.sq_node != node_id)
454 if (lookup->sq.sq_port != port)
457 list_del(&lookup->li);
461 /* Remove the server belonging to this port */
462 node = node_get(node_id);
464 server_del(node, port);
466 /* Advertise the removal of this client to all local servers */
467 local_node = node_get(qrtr_ns.local_node);
471 memset(&pkt, 0, sizeof(pkt));
472 pkt.cmd = cpu_to_le32(QRTR_TYPE_DEL_CLIENT);
473 pkt.client.node = cpu_to_le32(node_id);
474 pkt.client.port = cpu_to_le32(port);
477 radix_tree_for_each_slot(slot, &local_node->servers, &iter, 0) {
478 srv = radix_tree_deref_slot(slot);
481 if (radix_tree_deref_retry(srv)) {
482 slot = radix_tree_iter_retry(&iter);
485 slot = radix_tree_iter_resume(slot, &iter);
488 sq.sq_family = AF_QIPCRTR;
489 sq.sq_node = srv->node;
490 sq.sq_port = srv->port;
492 msg.msg_name = (struct sockaddr *)&sq;
493 msg.msg_namelen = sizeof(sq);
495 ret = kernel_sendmsg(qrtr_ns.sock, &msg, &iv, 1, sizeof(pkt));
497 pr_err("failed to send del client cmd\n");
508 static int ctrl_cmd_new_server(struct sockaddr_qrtr *from,
509 unsigned int service, unsigned int instance,
510 unsigned int node_id, unsigned int port)
512 struct qrtr_lookup *lookup;
513 struct qrtr_server *srv;
514 struct list_head *li;
517 /* Ignore specified node and port for local servers */
518 if (from->sq_node == qrtr_ns.local_node) {
519 node_id = from->sq_node;
520 port = from->sq_port;
523 srv = server_add(service, instance, node_id, port);
527 if (srv->node == qrtr_ns.local_node) {
528 ret = service_announce_new(&qrtr_ns.bcast_sq, srv);
530 pr_err("failed to announce new service\n");
535 /* Notify any potential lookups about the new server */
536 list_for_each(li, &qrtr_ns.lookups) {
537 lookup = container_of(li, struct qrtr_lookup, li);
538 if (lookup->service && lookup->service != service)
540 if (lookup->instance && lookup->instance != instance)
543 lookup_notify(&lookup->sq, srv, true);
549 static int ctrl_cmd_del_server(struct sockaddr_qrtr *from,
550 unsigned int service, unsigned int instance,
551 unsigned int node_id, unsigned int port)
553 struct qrtr_node *node;
555 /* Ignore specified node and port for local servers*/
556 if (from->sq_node == qrtr_ns.local_node) {
557 node_id = from->sq_node;
558 port = from->sq_port;
561 /* Local servers may only unregister themselves */
562 if (from->sq_node == qrtr_ns.local_node && from->sq_port != port)
565 node = node_get(node_id);
569 return server_del(node, port);
572 static int ctrl_cmd_new_lookup(struct sockaddr_qrtr *from,
573 unsigned int service, unsigned int instance)
575 struct radix_tree_iter node_iter;
576 struct qrtr_server_filter filter;
577 struct radix_tree_iter srv_iter;
578 struct qrtr_lookup *lookup;
579 struct qrtr_node *node;
580 void __rcu **node_slot;
581 void __rcu **srv_slot;
583 /* Accept only local observers */
584 if (from->sq_node != qrtr_ns.local_node)
587 lookup = kzalloc(sizeof(*lookup), GFP_KERNEL);
592 lookup->service = service;
593 lookup->instance = instance;
594 list_add_tail(&lookup->li, &qrtr_ns.lookups);
596 memset(&filter, 0, sizeof(filter));
597 filter.service = service;
598 filter.instance = instance;
601 radix_tree_for_each_slot(node_slot, &nodes, &node_iter, 0) {
602 node = radix_tree_deref_slot(node_slot);
605 if (radix_tree_deref_retry(node)) {
606 node_slot = radix_tree_iter_retry(&node_iter);
609 node_slot = radix_tree_iter_resume(node_slot, &node_iter);
611 radix_tree_for_each_slot(srv_slot, &node->servers,
613 struct qrtr_server *srv;
615 srv = radix_tree_deref_slot(srv_slot);
618 if (radix_tree_deref_retry(srv)) {
619 srv_slot = radix_tree_iter_retry(&srv_iter);
623 if (!server_match(srv, &filter))
626 srv_slot = radix_tree_iter_resume(srv_slot, &srv_iter);
629 lookup_notify(from, srv, true);
635 /* Empty notification, to indicate end of listing */
636 lookup_notify(from, NULL, true);
641 static void ctrl_cmd_del_lookup(struct sockaddr_qrtr *from,
642 unsigned int service, unsigned int instance)
644 struct qrtr_lookup *lookup;
645 struct list_head *tmp;
646 struct list_head *li;
648 list_for_each_safe(li, tmp, &qrtr_ns.lookups) {
649 lookup = container_of(li, struct qrtr_lookup, li);
650 if (lookup->sq.sq_node != from->sq_node)
652 if (lookup->sq.sq_port != from->sq_port)
654 if (lookup->service != service)
656 if (lookup->instance && lookup->instance != instance)
659 list_del(&lookup->li);
664 static void qrtr_ns_worker(struct work_struct *work)
666 const struct qrtr_ctrl_pkt *pkt;
667 size_t recv_buf_size = 4096;
668 struct sockaddr_qrtr sq;
669 struct msghdr msg = { };
676 msg.msg_name = (struct sockaddr *)&sq;
677 msg.msg_namelen = sizeof(sq);
679 recv_buf = kzalloc(recv_buf_size, GFP_KERNEL);
684 iv.iov_base = recv_buf;
685 iv.iov_len = recv_buf_size;
687 msglen = kernel_recvmsg(qrtr_ns.sock, &msg, &iv, 1,
688 iv.iov_len, MSG_DONTWAIT);
690 if (msglen == -EAGAIN)
694 pr_err("error receiving packet: %zd\n", msglen);
699 cmd = le32_to_cpu(pkt->cmd);
700 if (cmd < ARRAY_SIZE(qrtr_ctrl_pkt_strings) &&
701 qrtr_ctrl_pkt_strings[cmd])
702 trace_qrtr_ns_message(qrtr_ctrl_pkt_strings[cmd],
703 sq.sq_node, sq.sq_port);
707 case QRTR_TYPE_HELLO:
708 ret = ctrl_cmd_hello(&sq);
711 ret = ctrl_cmd_bye(&sq);
713 case QRTR_TYPE_DEL_CLIENT:
714 ret = ctrl_cmd_del_client(&sq,
715 le32_to_cpu(pkt->client.node),
716 le32_to_cpu(pkt->client.port));
718 case QRTR_TYPE_NEW_SERVER:
719 ret = ctrl_cmd_new_server(&sq,
720 le32_to_cpu(pkt->server.service),
721 le32_to_cpu(pkt->server.instance),
722 le32_to_cpu(pkt->server.node),
723 le32_to_cpu(pkt->server.port));
725 case QRTR_TYPE_DEL_SERVER:
726 ret = ctrl_cmd_del_server(&sq,
727 le32_to_cpu(pkt->server.service),
728 le32_to_cpu(pkt->server.instance),
729 le32_to_cpu(pkt->server.node),
730 le32_to_cpu(pkt->server.port));
734 case QRTR_TYPE_RESUME_TX:
736 case QRTR_TYPE_NEW_LOOKUP:
737 ret = ctrl_cmd_new_lookup(&sq,
738 le32_to_cpu(pkt->server.service),
739 le32_to_cpu(pkt->server.instance));
741 case QRTR_TYPE_DEL_LOOKUP:
742 ctrl_cmd_del_lookup(&sq,
743 le32_to_cpu(pkt->server.service),
744 le32_to_cpu(pkt->server.instance));
749 pr_err("failed while handling packet from %d:%d",
750 sq.sq_node, sq.sq_port);
756 static void qrtr_ns_data_ready(struct sock *sk)
758 queue_work(qrtr_ns.workqueue, &qrtr_ns.work);
761 int qrtr_ns_init(void)
763 struct sockaddr_qrtr sq;
766 INIT_LIST_HEAD(&qrtr_ns.lookups);
767 INIT_WORK(&qrtr_ns.work, qrtr_ns_worker);
769 ret = sock_create_kern(&init_net, AF_QIPCRTR, SOCK_DGRAM,
770 PF_QIPCRTR, &qrtr_ns.sock);
774 ret = kernel_getsockname(qrtr_ns.sock, (struct sockaddr *)&sq);
776 pr_err("failed to get socket name\n");
780 qrtr_ns.workqueue = alloc_workqueue("qrtr_ns_handler", WQ_UNBOUND, 1);
781 if (!qrtr_ns.workqueue) {
786 qrtr_ns.sock->sk->sk_data_ready = qrtr_ns_data_ready;
788 sq.sq_port = QRTR_PORT_CTRL;
789 qrtr_ns.local_node = sq.sq_node;
791 ret = kernel_bind(qrtr_ns.sock, (struct sockaddr *)&sq, sizeof(sq));
793 pr_err("failed to bind to socket\n");
797 qrtr_ns.bcast_sq.sq_family = AF_QIPCRTR;
798 qrtr_ns.bcast_sq.sq_node = QRTR_NODE_BCAST;
799 qrtr_ns.bcast_sq.sq_port = QRTR_PORT_CTRL;
801 ret = say_hello(&qrtr_ns.bcast_sq);
808 destroy_workqueue(qrtr_ns.workqueue);
810 sock_release(qrtr_ns.sock);
813 EXPORT_SYMBOL_GPL(qrtr_ns_init);
815 void qrtr_ns_remove(void)
817 cancel_work_sync(&qrtr_ns.work);
818 destroy_workqueue(qrtr_ns.workqueue);
819 sock_release(qrtr_ns.sock);
821 EXPORT_SYMBOL_GPL(qrtr_ns_remove);
823 MODULE_AUTHOR("Manivannan Sadhasivam <manivannan.sadhasivam@linaro.org>");
824 MODULE_DESCRIPTION("Qualcomm IPC Router Nameservice");
825 MODULE_LICENSE("Dual BSD/GPL");