Merge remote-tracking branch 'torvalds/master' into perf/core
[linux-2.6-microblaze.git] / net / qrtr / qrtr.c
1 // SPDX-License-Identifier: GPL-2.0-only
2 /*
3  * Copyright (c) 2015, Sony Mobile Communications Inc.
4  * Copyright (c) 2013, The Linux Foundation. All rights reserved.
5  */
6 #include <linux/module.h>
7 #include <linux/netlink.h>
8 #include <linux/qrtr.h>
9 #include <linux/termios.h>      /* For TIOCINQ/OUTQ */
10 #include <linux/spinlock.h>
11 #include <linux/wait.h>
12
13 #include <net/sock.h>
14
15 #include "qrtr.h"
16
17 #define QRTR_PROTO_VER_1 1
18 #define QRTR_PROTO_VER_2 3
19
20 /* auto-bind range */
21 #define QRTR_MIN_EPH_SOCKET 0x4000
22 #define QRTR_MAX_EPH_SOCKET 0x7fff
23 #define QRTR_EPH_PORT_RANGE \
24                 XA_LIMIT(QRTR_MIN_EPH_SOCKET, QRTR_MAX_EPH_SOCKET)
25
26 /**
27  * struct qrtr_hdr_v1 - (I|R)PCrouter packet header version 1
28  * @version: protocol version
29  * @type: packet type; one of QRTR_TYPE_*
30  * @src_node_id: source node
31  * @src_port_id: source port
32  * @confirm_rx: boolean; whether a resume-tx packet should be send in reply
33  * @size: length of packet, excluding this header
34  * @dst_node_id: destination node
35  * @dst_port_id: destination port
36  */
37 struct qrtr_hdr_v1 {
38         __le32 version;
39         __le32 type;
40         __le32 src_node_id;
41         __le32 src_port_id;
42         __le32 confirm_rx;
43         __le32 size;
44         __le32 dst_node_id;
45         __le32 dst_port_id;
46 } __packed;
47
48 /**
49  * struct qrtr_hdr_v2 - (I|R)PCrouter packet header later versions
50  * @version: protocol version
51  * @type: packet type; one of QRTR_TYPE_*
52  * @flags: bitmask of QRTR_FLAGS_*
53  * @optlen: length of optional header data
54  * @size: length of packet, excluding this header and optlen
55  * @src_node_id: source node
56  * @src_port_id: source port
57  * @dst_node_id: destination node
58  * @dst_port_id: destination port
59  */
60 struct qrtr_hdr_v2 {
61         u8 version;
62         u8 type;
63         u8 flags;
64         u8 optlen;
65         __le32 size;
66         __le16 src_node_id;
67         __le16 src_port_id;
68         __le16 dst_node_id;
69         __le16 dst_port_id;
70 };
71
72 #define QRTR_FLAGS_CONFIRM_RX   BIT(0)
73
74 struct qrtr_cb {
75         u32 src_node;
76         u32 src_port;
77         u32 dst_node;
78         u32 dst_port;
79
80         u8 type;
81         u8 confirm_rx;
82 };
83
84 #define QRTR_HDR_MAX_SIZE max_t(size_t, sizeof(struct qrtr_hdr_v1), \
85                                         sizeof(struct qrtr_hdr_v2))
86
87 struct qrtr_sock {
88         /* WARNING: sk must be the first member */
89         struct sock sk;
90         struct sockaddr_qrtr us;
91         struct sockaddr_qrtr peer;
92 };
93
94 static inline struct qrtr_sock *qrtr_sk(struct sock *sk)
95 {
96         BUILD_BUG_ON(offsetof(struct qrtr_sock, sk) != 0);
97         return container_of(sk, struct qrtr_sock, sk);
98 }
99
100 static unsigned int qrtr_local_nid = 1;
101
102 /* for node ids */
103 static RADIX_TREE(qrtr_nodes, GFP_ATOMIC);
104 static DEFINE_SPINLOCK(qrtr_nodes_lock);
105 /* broadcast list */
106 static LIST_HEAD(qrtr_all_nodes);
107 /* lock for qrtr_all_nodes and node reference */
108 static DEFINE_MUTEX(qrtr_node_lock);
109
110 /* local port allocation management */
111 static DEFINE_XARRAY_ALLOC(qrtr_ports);
112
113 /**
114  * struct qrtr_node - endpoint node
115  * @ep_lock: lock for endpoint management and callbacks
116  * @ep: endpoint
117  * @ref: reference count for node
118  * @nid: node id
119  * @qrtr_tx_flow: tree of qrtr_tx_flow, keyed by node << 32 | port
120  * @qrtr_tx_lock: lock for qrtr_tx_flow inserts
121  * @rx_queue: receive queue
122  * @item: list item for broadcast list
123  */
124 struct qrtr_node {
125         struct mutex ep_lock;
126         struct qrtr_endpoint *ep;
127         struct kref ref;
128         unsigned int nid;
129
130         struct radix_tree_root qrtr_tx_flow;
131         struct mutex qrtr_tx_lock; /* for qrtr_tx_flow */
132
133         struct sk_buff_head rx_queue;
134         struct list_head item;
135 };
136
137 /**
138  * struct qrtr_tx_flow - tx flow control
139  * @resume_tx: waiters for a resume tx from the remote
140  * @pending: number of waiting senders
141  * @tx_failed: indicates that a message with confirm_rx flag was lost
142  */
143 struct qrtr_tx_flow {
144         struct wait_queue_head resume_tx;
145         int pending;
146         int tx_failed;
147 };
148
149 #define QRTR_TX_FLOW_HIGH       10
150 #define QRTR_TX_FLOW_LOW        5
151
152 static int qrtr_local_enqueue(struct qrtr_node *node, struct sk_buff *skb,
153                               int type, struct sockaddr_qrtr *from,
154                               struct sockaddr_qrtr *to);
155 static int qrtr_bcast_enqueue(struct qrtr_node *node, struct sk_buff *skb,
156                               int type, struct sockaddr_qrtr *from,
157                               struct sockaddr_qrtr *to);
158 static struct qrtr_sock *qrtr_port_lookup(int port);
159 static void qrtr_port_put(struct qrtr_sock *ipc);
160
161 /* Release node resources and free the node.
162  *
163  * Do not call directly, use qrtr_node_release.  To be used with
164  * kref_put_mutex.  As such, the node mutex is expected to be locked on call.
165  */
166 static void __qrtr_node_release(struct kref *kref)
167 {
168         struct qrtr_node *node = container_of(kref, struct qrtr_node, ref);
169         struct radix_tree_iter iter;
170         struct qrtr_tx_flow *flow;
171         unsigned long flags;
172         void __rcu **slot;
173
174         spin_lock_irqsave(&qrtr_nodes_lock, flags);
175         /* If the node is a bridge for other nodes, there are possibly
176          * multiple entries pointing to our released node, delete them all.
177          */
178         radix_tree_for_each_slot(slot, &qrtr_nodes, &iter, 0) {
179                 if (*slot == node)
180                         radix_tree_iter_delete(&qrtr_nodes, &iter, slot);
181         }
182         spin_unlock_irqrestore(&qrtr_nodes_lock, flags);
183
184         list_del(&node->item);
185         mutex_unlock(&qrtr_node_lock);
186
187         skb_queue_purge(&node->rx_queue);
188
189         /* Free tx flow counters */
190         radix_tree_for_each_slot(slot, &node->qrtr_tx_flow, &iter, 0) {
191                 flow = *slot;
192                 radix_tree_iter_delete(&node->qrtr_tx_flow, &iter, slot);
193                 kfree(flow);
194         }
195         kfree(node);
196 }
197
198 /* Increment reference to node. */
199 static struct qrtr_node *qrtr_node_acquire(struct qrtr_node *node)
200 {
201         if (node)
202                 kref_get(&node->ref);
203         return node;
204 }
205
206 /* Decrement reference to node and release as necessary. */
207 static void qrtr_node_release(struct qrtr_node *node)
208 {
209         if (!node)
210                 return;
211         kref_put_mutex(&node->ref, __qrtr_node_release, &qrtr_node_lock);
212 }
213
214 /**
215  * qrtr_tx_resume() - reset flow control counter
216  * @node:       qrtr_node that the QRTR_TYPE_RESUME_TX packet arrived on
217  * @skb:        resume_tx packet
218  */
219 static void qrtr_tx_resume(struct qrtr_node *node, struct sk_buff *skb)
220 {
221         struct qrtr_ctrl_pkt *pkt = (struct qrtr_ctrl_pkt *)skb->data;
222         u64 remote_node = le32_to_cpu(pkt->client.node);
223         u32 remote_port = le32_to_cpu(pkt->client.port);
224         struct qrtr_tx_flow *flow;
225         unsigned long key;
226
227         key = remote_node << 32 | remote_port;
228
229         rcu_read_lock();
230         flow = radix_tree_lookup(&node->qrtr_tx_flow, key);
231         rcu_read_unlock();
232         if (flow) {
233                 spin_lock(&flow->resume_tx.lock);
234                 flow->pending = 0;
235                 spin_unlock(&flow->resume_tx.lock);
236                 wake_up_interruptible_all(&flow->resume_tx);
237         }
238
239         consume_skb(skb);
240 }
241
242 /**
243  * qrtr_tx_wait() - flow control for outgoing packets
244  * @node:       qrtr_node that the packet is to be send to
245  * @dest_node:  node id of the destination
246  * @dest_port:  port number of the destination
247  * @type:       type of message
248  *
249  * The flow control scheme is based around the low and high "watermarks". When
250  * the low watermark is passed the confirm_rx flag is set on the outgoing
251  * message, which will trigger the remote to send a control message of the type
252  * QRTR_TYPE_RESUME_TX to reset the counter. If the high watermark is hit
253  * further transmision should be paused.
254  *
255  * Return: 1 if confirm_rx should be set, 0 otherwise or errno failure
256  */
257 static int qrtr_tx_wait(struct qrtr_node *node, int dest_node, int dest_port,
258                         int type)
259 {
260         unsigned long key = (u64)dest_node << 32 | dest_port;
261         struct qrtr_tx_flow *flow;
262         int confirm_rx = 0;
263         int ret;
264
265         /* Never set confirm_rx on non-data packets */
266         if (type != QRTR_TYPE_DATA)
267                 return 0;
268
269         mutex_lock(&node->qrtr_tx_lock);
270         flow = radix_tree_lookup(&node->qrtr_tx_flow, key);
271         if (!flow) {
272                 flow = kzalloc(sizeof(*flow), GFP_KERNEL);
273                 if (flow) {
274                         init_waitqueue_head(&flow->resume_tx);
275                         if (radix_tree_insert(&node->qrtr_tx_flow, key, flow)) {
276                                 kfree(flow);
277                                 flow = NULL;
278                         }
279                 }
280         }
281         mutex_unlock(&node->qrtr_tx_lock);
282
283         /* Set confirm_rx if we where unable to find and allocate a flow */
284         if (!flow)
285                 return 1;
286
287         spin_lock_irq(&flow->resume_tx.lock);
288         ret = wait_event_interruptible_locked_irq(flow->resume_tx,
289                                                   flow->pending < QRTR_TX_FLOW_HIGH ||
290                                                   flow->tx_failed ||
291                                                   !node->ep);
292         if (ret < 0) {
293                 confirm_rx = ret;
294         } else if (!node->ep) {
295                 confirm_rx = -EPIPE;
296         } else if (flow->tx_failed) {
297                 flow->tx_failed = 0;
298                 confirm_rx = 1;
299         } else {
300                 flow->pending++;
301                 confirm_rx = flow->pending == QRTR_TX_FLOW_LOW;
302         }
303         spin_unlock_irq(&flow->resume_tx.lock);
304
305         return confirm_rx;
306 }
307
308 /**
309  * qrtr_tx_flow_failed() - flag that tx of confirm_rx flagged messages failed
310  * @node:       qrtr_node that the packet is to be send to
311  * @dest_node:  node id of the destination
312  * @dest_port:  port number of the destination
313  *
314  * Signal that the transmission of a message with confirm_rx flag failed. The
315  * flow's "pending" counter will keep incrementing towards QRTR_TX_FLOW_HIGH,
316  * at which point transmission would stall forever waiting for the resume TX
317  * message associated with the dropped confirm_rx message.
318  * Work around this by marking the flow as having a failed transmission and
319  * cause the next transmission attempt to be sent with the confirm_rx.
320  */
321 static void qrtr_tx_flow_failed(struct qrtr_node *node, int dest_node,
322                                 int dest_port)
323 {
324         unsigned long key = (u64)dest_node << 32 | dest_port;
325         struct qrtr_tx_flow *flow;
326
327         rcu_read_lock();
328         flow = radix_tree_lookup(&node->qrtr_tx_flow, key);
329         rcu_read_unlock();
330         if (flow) {
331                 spin_lock_irq(&flow->resume_tx.lock);
332                 flow->tx_failed = 1;
333                 spin_unlock_irq(&flow->resume_tx.lock);
334         }
335 }
336
337 /* Pass an outgoing packet socket buffer to the endpoint driver. */
338 static int qrtr_node_enqueue(struct qrtr_node *node, struct sk_buff *skb,
339                              int type, struct sockaddr_qrtr *from,
340                              struct sockaddr_qrtr *to)
341 {
342         struct qrtr_hdr_v1 *hdr;
343         size_t len = skb->len;
344         int rc, confirm_rx;
345
346         confirm_rx = qrtr_tx_wait(node, to->sq_node, to->sq_port, type);
347         if (confirm_rx < 0) {
348                 kfree_skb(skb);
349                 return confirm_rx;
350         }
351
352         hdr = skb_push(skb, sizeof(*hdr));
353         hdr->version = cpu_to_le32(QRTR_PROTO_VER_1);
354         hdr->type = cpu_to_le32(type);
355         hdr->src_node_id = cpu_to_le32(from->sq_node);
356         hdr->src_port_id = cpu_to_le32(from->sq_port);
357         if (to->sq_port == QRTR_PORT_CTRL) {
358                 hdr->dst_node_id = cpu_to_le32(node->nid);
359                 hdr->dst_port_id = cpu_to_le32(QRTR_PORT_CTRL);
360         } else {
361                 hdr->dst_node_id = cpu_to_le32(to->sq_node);
362                 hdr->dst_port_id = cpu_to_le32(to->sq_port);
363         }
364
365         hdr->size = cpu_to_le32(len);
366         hdr->confirm_rx = !!confirm_rx;
367
368         rc = skb_put_padto(skb, ALIGN(len, 4) + sizeof(*hdr));
369
370         if (!rc) {
371                 mutex_lock(&node->ep_lock);
372                 rc = -ENODEV;
373                 if (node->ep)
374                         rc = node->ep->xmit(node->ep, skb);
375                 else
376                         kfree_skb(skb);
377                 mutex_unlock(&node->ep_lock);
378         }
379         /* Need to ensure that a subsequent message carries the otherwise lost
380          * confirm_rx flag if we dropped this one */
381         if (rc && confirm_rx)
382                 qrtr_tx_flow_failed(node, to->sq_node, to->sq_port);
383
384         return rc;
385 }
386
387 /* Lookup node by id.
388  *
389  * callers must release with qrtr_node_release()
390  */
391 static struct qrtr_node *qrtr_node_lookup(unsigned int nid)
392 {
393         struct qrtr_node *node;
394         unsigned long flags;
395
396         spin_lock_irqsave(&qrtr_nodes_lock, flags);
397         node = radix_tree_lookup(&qrtr_nodes, nid);
398         node = qrtr_node_acquire(node);
399         spin_unlock_irqrestore(&qrtr_nodes_lock, flags);
400
401         return node;
402 }
403
404 /* Assign node id to node.
405  *
406  * This is mostly useful for automatic node id assignment, based on
407  * the source id in the incoming packet.
408  */
409 static void qrtr_node_assign(struct qrtr_node *node, unsigned int nid)
410 {
411         unsigned long flags;
412
413         if (nid == QRTR_EP_NID_AUTO)
414                 return;
415
416         spin_lock_irqsave(&qrtr_nodes_lock, flags);
417         radix_tree_insert(&qrtr_nodes, nid, node);
418         if (node->nid == QRTR_EP_NID_AUTO)
419                 node->nid = nid;
420         spin_unlock_irqrestore(&qrtr_nodes_lock, flags);
421 }
422
423 /**
424  * qrtr_endpoint_post() - post incoming data
425  * @ep: endpoint handle
426  * @data: data pointer
427  * @len: size of data in bytes
428  *
429  * Return: 0 on success; negative error code on failure
430  */
431 int qrtr_endpoint_post(struct qrtr_endpoint *ep, const void *data, size_t len)
432 {
433         struct qrtr_node *node = ep->node;
434         const struct qrtr_hdr_v1 *v1;
435         const struct qrtr_hdr_v2 *v2;
436         struct qrtr_sock *ipc;
437         struct sk_buff *skb;
438         struct qrtr_cb *cb;
439         size_t size;
440         unsigned int ver;
441         size_t hdrlen;
442
443         if (len == 0 || len & 3)
444                 return -EINVAL;
445
446         skb = __netdev_alloc_skb(NULL, len, GFP_ATOMIC | __GFP_NOWARN);
447         if (!skb)
448                 return -ENOMEM;
449
450         cb = (struct qrtr_cb *)skb->cb;
451
452         /* Version field in v1 is little endian, so this works for both cases */
453         ver = *(u8*)data;
454
455         switch (ver) {
456         case QRTR_PROTO_VER_1:
457                 if (len < sizeof(*v1))
458                         goto err;
459                 v1 = data;
460                 hdrlen = sizeof(*v1);
461
462                 cb->type = le32_to_cpu(v1->type);
463                 cb->src_node = le32_to_cpu(v1->src_node_id);
464                 cb->src_port = le32_to_cpu(v1->src_port_id);
465                 cb->confirm_rx = !!v1->confirm_rx;
466                 cb->dst_node = le32_to_cpu(v1->dst_node_id);
467                 cb->dst_port = le32_to_cpu(v1->dst_port_id);
468
469                 size = le32_to_cpu(v1->size);
470                 break;
471         case QRTR_PROTO_VER_2:
472                 if (len < sizeof(*v2))
473                         goto err;
474                 v2 = data;
475                 hdrlen = sizeof(*v2) + v2->optlen;
476
477                 cb->type = v2->type;
478                 cb->confirm_rx = !!(v2->flags & QRTR_FLAGS_CONFIRM_RX);
479                 cb->src_node = le16_to_cpu(v2->src_node_id);
480                 cb->src_port = le16_to_cpu(v2->src_port_id);
481                 cb->dst_node = le16_to_cpu(v2->dst_node_id);
482                 cb->dst_port = le16_to_cpu(v2->dst_port_id);
483
484                 if (cb->src_port == (u16)QRTR_PORT_CTRL)
485                         cb->src_port = QRTR_PORT_CTRL;
486                 if (cb->dst_port == (u16)QRTR_PORT_CTRL)
487                         cb->dst_port = QRTR_PORT_CTRL;
488
489                 size = le32_to_cpu(v2->size);
490                 break;
491         default:
492                 pr_err("qrtr: Invalid version %d\n", ver);
493                 goto err;
494         }
495
496         if (len != ALIGN(size, 4) + hdrlen)
497                 goto err;
498
499         if (cb->dst_port != QRTR_PORT_CTRL && cb->type != QRTR_TYPE_DATA &&
500             cb->type != QRTR_TYPE_RESUME_TX)
501                 goto err;
502
503         skb_put_data(skb, data + hdrlen, size);
504
505         qrtr_node_assign(node, cb->src_node);
506
507         if (cb->type == QRTR_TYPE_NEW_SERVER) {
508                 /* Remote node endpoint can bridge other distant nodes */
509                 const struct qrtr_ctrl_pkt *pkt = data + hdrlen;
510
511                 qrtr_node_assign(node, le32_to_cpu(pkt->server.node));
512         }
513
514         if (cb->type == QRTR_TYPE_RESUME_TX) {
515                 qrtr_tx_resume(node, skb);
516         } else {
517                 ipc = qrtr_port_lookup(cb->dst_port);
518                 if (!ipc)
519                         goto err;
520
521                 if (sock_queue_rcv_skb(&ipc->sk, skb))
522                         goto err;
523
524                 qrtr_port_put(ipc);
525         }
526
527         return 0;
528
529 err:
530         kfree_skb(skb);
531         return -EINVAL;
532
533 }
534 EXPORT_SYMBOL_GPL(qrtr_endpoint_post);
535
536 /**
537  * qrtr_alloc_ctrl_packet() - allocate control packet skb
538  * @pkt: reference to qrtr_ctrl_pkt pointer
539  * @flags: the type of memory to allocate
540  *
541  * Returns newly allocated sk_buff, or NULL on failure
542  *
543  * This function allocates a sk_buff large enough to carry a qrtr_ctrl_pkt and
544  * on success returns a reference to the control packet in @pkt.
545  */
546 static struct sk_buff *qrtr_alloc_ctrl_packet(struct qrtr_ctrl_pkt **pkt,
547                                               gfp_t flags)
548 {
549         const int pkt_len = sizeof(struct qrtr_ctrl_pkt);
550         struct sk_buff *skb;
551
552         skb = alloc_skb(QRTR_HDR_MAX_SIZE + pkt_len, flags);
553         if (!skb)
554                 return NULL;
555
556         skb_reserve(skb, QRTR_HDR_MAX_SIZE);
557         *pkt = skb_put_zero(skb, pkt_len);
558
559         return skb;
560 }
561
562 /**
563  * qrtr_endpoint_register() - register a new endpoint
564  * @ep: endpoint to register
565  * @nid: desired node id; may be QRTR_EP_NID_AUTO for auto-assignment
566  * Return: 0 on success; negative error code on failure
567  *
568  * The specified endpoint must have the xmit function pointer set on call.
569  */
570 int qrtr_endpoint_register(struct qrtr_endpoint *ep, unsigned int nid)
571 {
572         struct qrtr_node *node;
573
574         if (!ep || !ep->xmit)
575                 return -EINVAL;
576
577         node = kzalloc(sizeof(*node), GFP_KERNEL);
578         if (!node)
579                 return -ENOMEM;
580
581         kref_init(&node->ref);
582         mutex_init(&node->ep_lock);
583         skb_queue_head_init(&node->rx_queue);
584         node->nid = QRTR_EP_NID_AUTO;
585         node->ep = ep;
586
587         INIT_RADIX_TREE(&node->qrtr_tx_flow, GFP_KERNEL);
588         mutex_init(&node->qrtr_tx_lock);
589
590         qrtr_node_assign(node, nid);
591
592         mutex_lock(&qrtr_node_lock);
593         list_add(&node->item, &qrtr_all_nodes);
594         mutex_unlock(&qrtr_node_lock);
595         ep->node = node;
596
597         return 0;
598 }
599 EXPORT_SYMBOL_GPL(qrtr_endpoint_register);
600
601 /**
602  * qrtr_endpoint_unregister - unregister endpoint
603  * @ep: endpoint to unregister
604  */
605 void qrtr_endpoint_unregister(struct qrtr_endpoint *ep)
606 {
607         struct qrtr_node *node = ep->node;
608         struct sockaddr_qrtr src = {AF_QIPCRTR, node->nid, QRTR_PORT_CTRL};
609         struct sockaddr_qrtr dst = {AF_QIPCRTR, qrtr_local_nid, QRTR_PORT_CTRL};
610         struct radix_tree_iter iter;
611         struct qrtr_ctrl_pkt *pkt;
612         struct qrtr_tx_flow *flow;
613         struct sk_buff *skb;
614         unsigned long flags;
615         void __rcu **slot;
616
617         mutex_lock(&node->ep_lock);
618         node->ep = NULL;
619         mutex_unlock(&node->ep_lock);
620
621         /* Notify the local controller about the event */
622         spin_lock_irqsave(&qrtr_nodes_lock, flags);
623         radix_tree_for_each_slot(slot, &qrtr_nodes, &iter, 0) {
624                 if (*slot != node)
625                         continue;
626                 src.sq_node = iter.index;
627                 skb = qrtr_alloc_ctrl_packet(&pkt, GFP_ATOMIC);
628                 if (skb) {
629                         pkt->cmd = cpu_to_le32(QRTR_TYPE_BYE);
630                         qrtr_local_enqueue(NULL, skb, QRTR_TYPE_BYE, &src, &dst);
631                 }
632         }
633         spin_unlock_irqrestore(&qrtr_nodes_lock, flags);
634
635         /* Wake up any transmitters waiting for resume-tx from the node */
636         mutex_lock(&node->qrtr_tx_lock);
637         radix_tree_for_each_slot(slot, &node->qrtr_tx_flow, &iter, 0) {
638                 flow = *slot;
639                 wake_up_interruptible_all(&flow->resume_tx);
640         }
641         mutex_unlock(&node->qrtr_tx_lock);
642
643         qrtr_node_release(node);
644         ep->node = NULL;
645 }
646 EXPORT_SYMBOL_GPL(qrtr_endpoint_unregister);
647
648 /* Lookup socket by port.
649  *
650  * Callers must release with qrtr_port_put()
651  */
652 static struct qrtr_sock *qrtr_port_lookup(int port)
653 {
654         struct qrtr_sock *ipc;
655
656         if (port == QRTR_PORT_CTRL)
657                 port = 0;
658
659         rcu_read_lock();
660         ipc = xa_load(&qrtr_ports, port);
661         if (ipc)
662                 sock_hold(&ipc->sk);
663         rcu_read_unlock();
664
665         return ipc;
666 }
667
668 /* Release acquired socket. */
669 static void qrtr_port_put(struct qrtr_sock *ipc)
670 {
671         sock_put(&ipc->sk);
672 }
673
674 /* Remove port assignment. */
675 static void qrtr_port_remove(struct qrtr_sock *ipc)
676 {
677         struct qrtr_ctrl_pkt *pkt;
678         struct sk_buff *skb;
679         int port = ipc->us.sq_port;
680         struct sockaddr_qrtr to;
681
682         to.sq_family = AF_QIPCRTR;
683         to.sq_node = QRTR_NODE_BCAST;
684         to.sq_port = QRTR_PORT_CTRL;
685
686         skb = qrtr_alloc_ctrl_packet(&pkt, GFP_KERNEL);
687         if (skb) {
688                 pkt->cmd = cpu_to_le32(QRTR_TYPE_DEL_CLIENT);
689                 pkt->client.node = cpu_to_le32(ipc->us.sq_node);
690                 pkt->client.port = cpu_to_le32(ipc->us.sq_port);
691
692                 skb_set_owner_w(skb, &ipc->sk);
693                 qrtr_bcast_enqueue(NULL, skb, QRTR_TYPE_DEL_CLIENT, &ipc->us,
694                                    &to);
695         }
696
697         if (port == QRTR_PORT_CTRL)
698                 port = 0;
699
700         __sock_put(&ipc->sk);
701
702         xa_erase(&qrtr_ports, port);
703
704         /* Ensure that if qrtr_port_lookup() did enter the RCU read section we
705          * wait for it to up increment the refcount */
706         synchronize_rcu();
707 }
708
709 /* Assign port number to socket.
710  *
711  * Specify port in the integer pointed to by port, and it will be adjusted
712  * on return as necesssary.
713  *
714  * Port may be:
715  *   0: Assign ephemeral port in [QRTR_MIN_EPH_SOCKET, QRTR_MAX_EPH_SOCKET]
716  *   <QRTR_MIN_EPH_SOCKET: Specified; requires CAP_NET_ADMIN
717  *   >QRTR_MIN_EPH_SOCKET: Specified; available to all
718  */
719 static int qrtr_port_assign(struct qrtr_sock *ipc, int *port)
720 {
721         int rc;
722
723         if (!*port) {
724                 rc = xa_alloc(&qrtr_ports, port, ipc, QRTR_EPH_PORT_RANGE,
725                                 GFP_KERNEL);
726         } else if (*port < QRTR_MIN_EPH_SOCKET && !capable(CAP_NET_ADMIN)) {
727                 rc = -EACCES;
728         } else if (*port == QRTR_PORT_CTRL) {
729                 rc = xa_insert(&qrtr_ports, 0, ipc, GFP_KERNEL);
730         } else {
731                 rc = xa_insert(&qrtr_ports, *port, ipc, GFP_KERNEL);
732         }
733
734         if (rc == -EBUSY)
735                 return -EADDRINUSE;
736         else if (rc < 0)
737                 return rc;
738
739         sock_hold(&ipc->sk);
740
741         return 0;
742 }
743
744 /* Reset all non-control ports */
745 static void qrtr_reset_ports(void)
746 {
747         struct qrtr_sock *ipc;
748         unsigned long index;
749
750         rcu_read_lock();
751         xa_for_each_start(&qrtr_ports, index, ipc, 1) {
752                 sock_hold(&ipc->sk);
753                 ipc->sk.sk_err = ENETRESET;
754                 ipc->sk.sk_error_report(&ipc->sk);
755                 sock_put(&ipc->sk);
756         }
757         rcu_read_unlock();
758 }
759
760 /* Bind socket to address.
761  *
762  * Socket should be locked upon call.
763  */
764 static int __qrtr_bind(struct socket *sock,
765                        const struct sockaddr_qrtr *addr, int zapped)
766 {
767         struct qrtr_sock *ipc = qrtr_sk(sock->sk);
768         struct sock *sk = sock->sk;
769         int port;
770         int rc;
771
772         /* rebinding ok */
773         if (!zapped && addr->sq_port == ipc->us.sq_port)
774                 return 0;
775
776         port = addr->sq_port;
777         rc = qrtr_port_assign(ipc, &port);
778         if (rc)
779                 return rc;
780
781         /* unbind previous, if any */
782         if (!zapped)
783                 qrtr_port_remove(ipc);
784         ipc->us.sq_port = port;
785
786         sock_reset_flag(sk, SOCK_ZAPPED);
787
788         /* Notify all open ports about the new controller */
789         if (port == QRTR_PORT_CTRL)
790                 qrtr_reset_ports();
791
792         return 0;
793 }
794
795 /* Auto bind to an ephemeral port. */
796 static int qrtr_autobind(struct socket *sock)
797 {
798         struct sock *sk = sock->sk;
799         struct sockaddr_qrtr addr;
800
801         if (!sock_flag(sk, SOCK_ZAPPED))
802                 return 0;
803
804         addr.sq_family = AF_QIPCRTR;
805         addr.sq_node = qrtr_local_nid;
806         addr.sq_port = 0;
807
808         return __qrtr_bind(sock, &addr, 1);
809 }
810
811 /* Bind socket to specified sockaddr. */
812 static int qrtr_bind(struct socket *sock, struct sockaddr *saddr, int len)
813 {
814         DECLARE_SOCKADDR(struct sockaddr_qrtr *, addr, saddr);
815         struct qrtr_sock *ipc = qrtr_sk(sock->sk);
816         struct sock *sk = sock->sk;
817         int rc;
818
819         if (len < sizeof(*addr) || addr->sq_family != AF_QIPCRTR)
820                 return -EINVAL;
821
822         if (addr->sq_node != ipc->us.sq_node)
823                 return -EINVAL;
824
825         lock_sock(sk);
826         rc = __qrtr_bind(sock, addr, sock_flag(sk, SOCK_ZAPPED));
827         release_sock(sk);
828
829         return rc;
830 }
831
832 /* Queue packet to local peer socket. */
833 static int qrtr_local_enqueue(struct qrtr_node *node, struct sk_buff *skb,
834                               int type, struct sockaddr_qrtr *from,
835                               struct sockaddr_qrtr *to)
836 {
837         struct qrtr_sock *ipc;
838         struct qrtr_cb *cb;
839
840         ipc = qrtr_port_lookup(to->sq_port);
841         if (!ipc || &ipc->sk == skb->sk) { /* do not send to self */
842                 kfree_skb(skb);
843                 return -ENODEV;
844         }
845
846         cb = (struct qrtr_cb *)skb->cb;
847         cb->src_node = from->sq_node;
848         cb->src_port = from->sq_port;
849
850         if (sock_queue_rcv_skb(&ipc->sk, skb)) {
851                 qrtr_port_put(ipc);
852                 kfree_skb(skb);
853                 return -ENOSPC;
854         }
855
856         qrtr_port_put(ipc);
857
858         return 0;
859 }
860
861 /* Queue packet for broadcast. */
862 static int qrtr_bcast_enqueue(struct qrtr_node *node, struct sk_buff *skb,
863                               int type, struct sockaddr_qrtr *from,
864                               struct sockaddr_qrtr *to)
865 {
866         struct sk_buff *skbn;
867
868         mutex_lock(&qrtr_node_lock);
869         list_for_each_entry(node, &qrtr_all_nodes, item) {
870                 skbn = skb_clone(skb, GFP_KERNEL);
871                 if (!skbn)
872                         break;
873                 skb_set_owner_w(skbn, skb->sk);
874                 qrtr_node_enqueue(node, skbn, type, from, to);
875         }
876         mutex_unlock(&qrtr_node_lock);
877
878         qrtr_local_enqueue(NULL, skb, type, from, to);
879
880         return 0;
881 }
882
883 static int qrtr_sendmsg(struct socket *sock, struct msghdr *msg, size_t len)
884 {
885         DECLARE_SOCKADDR(struct sockaddr_qrtr *, addr, msg->msg_name);
886         int (*enqueue_fn)(struct qrtr_node *, struct sk_buff *, int,
887                           struct sockaddr_qrtr *, struct sockaddr_qrtr *);
888         __le32 qrtr_type = cpu_to_le32(QRTR_TYPE_DATA);
889         struct qrtr_sock *ipc = qrtr_sk(sock->sk);
890         struct sock *sk = sock->sk;
891         struct qrtr_node *node;
892         struct sk_buff *skb;
893         size_t plen;
894         u32 type;
895         int rc;
896
897         if (msg->msg_flags & ~(MSG_DONTWAIT))
898                 return -EINVAL;
899
900         if (len > 65535)
901                 return -EMSGSIZE;
902
903         lock_sock(sk);
904
905         if (addr) {
906                 if (msg->msg_namelen < sizeof(*addr)) {
907                         release_sock(sk);
908                         return -EINVAL;
909                 }
910
911                 if (addr->sq_family != AF_QIPCRTR) {
912                         release_sock(sk);
913                         return -EINVAL;
914                 }
915
916                 rc = qrtr_autobind(sock);
917                 if (rc) {
918                         release_sock(sk);
919                         return rc;
920                 }
921         } else if (sk->sk_state == TCP_ESTABLISHED) {
922                 addr = &ipc->peer;
923         } else {
924                 release_sock(sk);
925                 return -ENOTCONN;
926         }
927
928         node = NULL;
929         if (addr->sq_node == QRTR_NODE_BCAST) {
930                 if (addr->sq_port != QRTR_PORT_CTRL &&
931                     qrtr_local_nid != QRTR_NODE_BCAST) {
932                         release_sock(sk);
933                         return -ENOTCONN;
934                 }
935                 enqueue_fn = qrtr_bcast_enqueue;
936         } else if (addr->sq_node == ipc->us.sq_node) {
937                 enqueue_fn = qrtr_local_enqueue;
938         } else {
939                 node = qrtr_node_lookup(addr->sq_node);
940                 if (!node) {
941                         release_sock(sk);
942                         return -ECONNRESET;
943                 }
944                 enqueue_fn = qrtr_node_enqueue;
945         }
946
947         plen = (len + 3) & ~3;
948         skb = sock_alloc_send_skb(sk, plen + QRTR_HDR_MAX_SIZE,
949                                   msg->msg_flags & MSG_DONTWAIT, &rc);
950         if (!skb) {
951                 rc = -ENOMEM;
952                 goto out_node;
953         }
954
955         skb_reserve(skb, QRTR_HDR_MAX_SIZE);
956
957         rc = memcpy_from_msg(skb_put(skb, len), msg, len);
958         if (rc) {
959                 kfree_skb(skb);
960                 goto out_node;
961         }
962
963         if (ipc->us.sq_port == QRTR_PORT_CTRL) {
964                 if (len < 4) {
965                         rc = -EINVAL;
966                         kfree_skb(skb);
967                         goto out_node;
968                 }
969
970                 /* control messages already require the type as 'command' */
971                 skb_copy_bits(skb, 0, &qrtr_type, 4);
972         }
973
974         type = le32_to_cpu(qrtr_type);
975         rc = enqueue_fn(node, skb, type, &ipc->us, addr);
976         if (rc >= 0)
977                 rc = len;
978
979 out_node:
980         qrtr_node_release(node);
981         release_sock(sk);
982
983         return rc;
984 }
985
986 static int qrtr_send_resume_tx(struct qrtr_cb *cb)
987 {
988         struct sockaddr_qrtr remote = { AF_QIPCRTR, cb->src_node, cb->src_port };
989         struct sockaddr_qrtr local = { AF_QIPCRTR, cb->dst_node, cb->dst_port };
990         struct qrtr_ctrl_pkt *pkt;
991         struct qrtr_node *node;
992         struct sk_buff *skb;
993         int ret;
994
995         node = qrtr_node_lookup(remote.sq_node);
996         if (!node)
997                 return -EINVAL;
998
999         skb = qrtr_alloc_ctrl_packet(&pkt, GFP_KERNEL);
1000         if (!skb)
1001                 return -ENOMEM;
1002
1003         pkt->cmd = cpu_to_le32(QRTR_TYPE_RESUME_TX);
1004         pkt->client.node = cpu_to_le32(cb->dst_node);
1005         pkt->client.port = cpu_to_le32(cb->dst_port);
1006
1007         ret = qrtr_node_enqueue(node, skb, QRTR_TYPE_RESUME_TX, &local, &remote);
1008
1009         qrtr_node_release(node);
1010
1011         return ret;
1012 }
1013
1014 static int qrtr_recvmsg(struct socket *sock, struct msghdr *msg,
1015                         size_t size, int flags)
1016 {
1017         DECLARE_SOCKADDR(struct sockaddr_qrtr *, addr, msg->msg_name);
1018         struct sock *sk = sock->sk;
1019         struct sk_buff *skb;
1020         struct qrtr_cb *cb;
1021         int copied, rc;
1022
1023         lock_sock(sk);
1024
1025         if (sock_flag(sk, SOCK_ZAPPED)) {
1026                 release_sock(sk);
1027                 return -EADDRNOTAVAIL;
1028         }
1029
1030         skb = skb_recv_datagram(sk, flags & ~MSG_DONTWAIT,
1031                                 flags & MSG_DONTWAIT, &rc);
1032         if (!skb) {
1033                 release_sock(sk);
1034                 return rc;
1035         }
1036         cb = (struct qrtr_cb *)skb->cb;
1037
1038         copied = skb->len;
1039         if (copied > size) {
1040                 copied = size;
1041                 msg->msg_flags |= MSG_TRUNC;
1042         }
1043
1044         rc = skb_copy_datagram_msg(skb, 0, msg, copied);
1045         if (rc < 0)
1046                 goto out;
1047         rc = copied;
1048
1049         if (addr) {
1050                 /* There is an anonymous 2-byte hole after sq_family,
1051                  * make sure to clear it.
1052                  */
1053                 memset(addr, 0, sizeof(*addr));
1054
1055                 addr->sq_family = AF_QIPCRTR;
1056                 addr->sq_node = cb->src_node;
1057                 addr->sq_port = cb->src_port;
1058                 msg->msg_namelen = sizeof(*addr);
1059         }
1060
1061 out:
1062         if (cb->confirm_rx)
1063                 qrtr_send_resume_tx(cb);
1064
1065         skb_free_datagram(sk, skb);
1066         release_sock(sk);
1067
1068         return rc;
1069 }
1070
1071 static int qrtr_connect(struct socket *sock, struct sockaddr *saddr,
1072                         int len, int flags)
1073 {
1074         DECLARE_SOCKADDR(struct sockaddr_qrtr *, addr, saddr);
1075         struct qrtr_sock *ipc = qrtr_sk(sock->sk);
1076         struct sock *sk = sock->sk;
1077         int rc;
1078
1079         if (len < sizeof(*addr) || addr->sq_family != AF_QIPCRTR)
1080                 return -EINVAL;
1081
1082         lock_sock(sk);
1083
1084         sk->sk_state = TCP_CLOSE;
1085         sock->state = SS_UNCONNECTED;
1086
1087         rc = qrtr_autobind(sock);
1088         if (rc) {
1089                 release_sock(sk);
1090                 return rc;
1091         }
1092
1093         ipc->peer = *addr;
1094         sock->state = SS_CONNECTED;
1095         sk->sk_state = TCP_ESTABLISHED;
1096
1097         release_sock(sk);
1098
1099         return 0;
1100 }
1101
1102 static int qrtr_getname(struct socket *sock, struct sockaddr *saddr,
1103                         int peer)
1104 {
1105         struct qrtr_sock *ipc = qrtr_sk(sock->sk);
1106         struct sockaddr_qrtr qaddr;
1107         struct sock *sk = sock->sk;
1108
1109         lock_sock(sk);
1110         if (peer) {
1111                 if (sk->sk_state != TCP_ESTABLISHED) {
1112                         release_sock(sk);
1113                         return -ENOTCONN;
1114                 }
1115
1116                 qaddr = ipc->peer;
1117         } else {
1118                 qaddr = ipc->us;
1119         }
1120         release_sock(sk);
1121
1122         qaddr.sq_family = AF_QIPCRTR;
1123
1124         memcpy(saddr, &qaddr, sizeof(qaddr));
1125
1126         return sizeof(qaddr);
1127 }
1128
1129 static int qrtr_ioctl(struct socket *sock, unsigned int cmd, unsigned long arg)
1130 {
1131         void __user *argp = (void __user *)arg;
1132         struct qrtr_sock *ipc = qrtr_sk(sock->sk);
1133         struct sock *sk = sock->sk;
1134         struct sockaddr_qrtr *sq;
1135         struct sk_buff *skb;
1136         struct ifreq ifr;
1137         long len = 0;
1138         int rc = 0;
1139
1140         lock_sock(sk);
1141
1142         switch (cmd) {
1143         case TIOCOUTQ:
1144                 len = sk->sk_sndbuf - sk_wmem_alloc_get(sk);
1145                 if (len < 0)
1146                         len = 0;
1147                 rc = put_user(len, (int __user *)argp);
1148                 break;
1149         case TIOCINQ:
1150                 skb = skb_peek(&sk->sk_receive_queue);
1151                 if (skb)
1152                         len = skb->len;
1153                 rc = put_user(len, (int __user *)argp);
1154                 break;
1155         case SIOCGIFADDR:
1156                 if (copy_from_user(&ifr, argp, sizeof(ifr))) {
1157                         rc = -EFAULT;
1158                         break;
1159                 }
1160
1161                 sq = (struct sockaddr_qrtr *)&ifr.ifr_addr;
1162                 *sq = ipc->us;
1163                 if (copy_to_user(argp, &ifr, sizeof(ifr))) {
1164                         rc = -EFAULT;
1165                         break;
1166                 }
1167                 break;
1168         case SIOCADDRT:
1169         case SIOCDELRT:
1170         case SIOCSIFADDR:
1171         case SIOCGIFDSTADDR:
1172         case SIOCSIFDSTADDR:
1173         case SIOCGIFBRDADDR:
1174         case SIOCSIFBRDADDR:
1175         case SIOCGIFNETMASK:
1176         case SIOCSIFNETMASK:
1177                 rc = -EINVAL;
1178                 break;
1179         default:
1180                 rc = -ENOIOCTLCMD;
1181                 break;
1182         }
1183
1184         release_sock(sk);
1185
1186         return rc;
1187 }
1188
1189 static int qrtr_release(struct socket *sock)
1190 {
1191         struct sock *sk = sock->sk;
1192         struct qrtr_sock *ipc;
1193
1194         if (!sk)
1195                 return 0;
1196
1197         lock_sock(sk);
1198
1199         ipc = qrtr_sk(sk);
1200         sk->sk_shutdown = SHUTDOWN_MASK;
1201         if (!sock_flag(sk, SOCK_DEAD))
1202                 sk->sk_state_change(sk);
1203
1204         sock_set_flag(sk, SOCK_DEAD);
1205         sock_orphan(sk);
1206         sock->sk = NULL;
1207
1208         if (!sock_flag(sk, SOCK_ZAPPED))
1209                 qrtr_port_remove(ipc);
1210
1211         skb_queue_purge(&sk->sk_receive_queue);
1212
1213         release_sock(sk);
1214         sock_put(sk);
1215
1216         return 0;
1217 }
1218
1219 static const struct proto_ops qrtr_proto_ops = {
1220         .owner          = THIS_MODULE,
1221         .family         = AF_QIPCRTR,
1222         .bind           = qrtr_bind,
1223         .connect        = qrtr_connect,
1224         .socketpair     = sock_no_socketpair,
1225         .accept         = sock_no_accept,
1226         .listen         = sock_no_listen,
1227         .sendmsg        = qrtr_sendmsg,
1228         .recvmsg        = qrtr_recvmsg,
1229         .getname        = qrtr_getname,
1230         .ioctl          = qrtr_ioctl,
1231         .gettstamp      = sock_gettstamp,
1232         .poll           = datagram_poll,
1233         .shutdown       = sock_no_shutdown,
1234         .release        = qrtr_release,
1235         .mmap           = sock_no_mmap,
1236         .sendpage       = sock_no_sendpage,
1237 };
1238
1239 static struct proto qrtr_proto = {
1240         .name           = "QIPCRTR",
1241         .owner          = THIS_MODULE,
1242         .obj_size       = sizeof(struct qrtr_sock),
1243 };
1244
1245 static int qrtr_create(struct net *net, struct socket *sock,
1246                        int protocol, int kern)
1247 {
1248         struct qrtr_sock *ipc;
1249         struct sock *sk;
1250
1251         if (sock->type != SOCK_DGRAM)
1252                 return -EPROTOTYPE;
1253
1254         sk = sk_alloc(net, AF_QIPCRTR, GFP_KERNEL, &qrtr_proto, kern);
1255         if (!sk)
1256                 return -ENOMEM;
1257
1258         sock_set_flag(sk, SOCK_ZAPPED);
1259
1260         sock_init_data(sock, sk);
1261         sock->ops = &qrtr_proto_ops;
1262
1263         ipc = qrtr_sk(sk);
1264         ipc->us.sq_family = AF_QIPCRTR;
1265         ipc->us.sq_node = qrtr_local_nid;
1266         ipc->us.sq_port = 0;
1267
1268         return 0;
1269 }
1270
1271 static const struct net_proto_family qrtr_family = {
1272         .owner  = THIS_MODULE,
1273         .family = AF_QIPCRTR,
1274         .create = qrtr_create,
1275 };
1276
1277 static int __init qrtr_proto_init(void)
1278 {
1279         int rc;
1280
1281         rc = proto_register(&qrtr_proto, 1);
1282         if (rc)
1283                 return rc;
1284
1285         rc = sock_register(&qrtr_family);
1286         if (rc)
1287                 goto err_proto;
1288
1289         rc = qrtr_ns_init();
1290         if (rc)
1291                 goto err_sock;
1292
1293         return 0;
1294
1295 err_sock:
1296         sock_unregister(qrtr_family.family);
1297 err_proto:
1298         proto_unregister(&qrtr_proto);
1299         return rc;
1300 }
1301 postcore_initcall(qrtr_proto_init);
1302
1303 static void __exit qrtr_proto_fini(void)
1304 {
1305         qrtr_ns_remove();
1306         sock_unregister(qrtr_family.family);
1307         proto_unregister(&qrtr_proto);
1308 }
1309 module_exit(qrtr_proto_fini);
1310
1311 MODULE_DESCRIPTION("Qualcomm IPC-router driver");
1312 MODULE_LICENSE("GPL v2");
1313 MODULE_ALIAS_NETPROTO(PF_QIPCRTR);