xref: /openbmc/linux/net/tipc/name_table.c (revision 429189ac)
1 /*
2  * net/tipc/name_table.c: TIPC name table code
3  *
4  * Copyright (c) 2000-2006, 2014-2018, Ericsson AB
5  * Copyright (c) 2004-2008, 2010-2014, Wind River Systems
6  * Copyright (c) 2020-2021, Red Hat Inc
7  * All rights reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions are met:
11  *
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the distribution.
17  * 3. Neither the names of the copyright holders nor the names of its
18  *    contributors may be used to endorse or promote products derived from
19  *    this software without specific prior written permission.
20  *
21  * Alternatively, this software may be distributed under the terms of the
22  * GNU General Public License ("GPL") version 2 as published by the Free
23  * Software Foundation.
24  *
25  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
26  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
28  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
29  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
30  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
31  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
32  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
33  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
34  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
35  * POSSIBILITY OF SUCH DAMAGE.
36  */
37 
38 #include <net/sock.h>
39 #include <linux/list_sort.h>
40 #include <linux/rbtree_augmented.h>
41 #include "core.h"
42 #include "netlink.h"
43 #include "name_table.h"
44 #include "name_distr.h"
45 #include "subscr.h"
46 #include "bcast.h"
47 #include "addr.h"
48 #include "node.h"
49 #include "group.h"
50 
51 /**
52  * struct service_range - container for all bindings of a service range
53  * @lower: service range lower bound
54  * @upper: service range upper bound
55  * @tree_node: member of service range RB tree
56  * @max: largest 'upper' in this node subtree
57  * @local_publ: list of identical publications made from this node
58  *   Used by closest_first lookup and multicast lookup algorithm
59  * @all_publ: all publications identical to this one, whatever node and scope
60  *   Used by round-robin lookup algorithm
61  */
62 struct service_range {
63 	u32 lower;
64 	u32 upper;
65 	struct rb_node tree_node;
66 	u32 max;
67 	struct list_head local_publ;
68 	struct list_head all_publ;
69 };
70 
71 /**
72  * struct tipc_service - container for all published instances of a service type
73  * @type: 32 bit 'type' value for service
74  * @publ_cnt: increasing counter for publications in this service
75  * @ranges: rb tree containing all service ranges for this service
76  * @service_list: links to adjacent name ranges in hash chain
77  * @subscriptions: list of subscriptions for this service type
78  * @lock: spinlock controlling access to pertaining service ranges/publications
79  * @rcu: RCU callback head used for deferred freeing
80  */
81 struct tipc_service {
82 	u32 type;
83 	u32 publ_cnt;
84 	struct rb_root ranges;
85 	struct hlist_node service_list;
86 	struct list_head subscriptions;
87 	spinlock_t lock; /* Covers service range list */
88 	struct rcu_head rcu;
89 };
90 
91 #define service_range_upper(sr) ((sr)->upper)
92 RB_DECLARE_CALLBACKS_MAX(static, sr_callbacks,
93 			 struct service_range, tree_node, u32, max,
94 			 service_range_upper)
95 
96 #define service_range_entry(rbtree_node)				\
97 	(container_of(rbtree_node, struct service_range, tree_node))
98 
99 #define service_range_overlap(sr, start, end)				\
100 	((sr)->lower <= (end) && (sr)->upper >= (start))
101 
102 /**
103  * service_range_foreach_match - iterate over tipc service rbtree for each
104  *                               range match
105  * @sr: the service range pointer as a loop cursor
106  * @sc: the pointer to tipc service which holds the service range rbtree
107  * @start: beginning of the search range (end >= start) for matching
108  * @end: end of the search range (end >= start) for matching
109  */
110 #define service_range_foreach_match(sr, sc, start, end)			\
111 	for (sr = service_range_match_first((sc)->ranges.rb_node,	\
112 					    start,			\
113 					    end);			\
114 	     sr;							\
115 	     sr = service_range_match_next(&(sr)->tree_node,		\
116 					   start,			\
117 					   end))
118 
119 /**
120  * service_range_match_first - find first service range matching a range
121  * @n: the root node of service range rbtree for searching
122  * @start: beginning of the search range (end >= start) for matching
123  * @end: end of the search range (end >= start) for matching
124  *
125  * Return: the leftmost service range node in the rbtree that overlaps the
126  * specific range if any. Otherwise, returns NULL.
127  */
128 static struct service_range *service_range_match_first(struct rb_node *n,
129 						       u32 start, u32 end)
130 {
131 	struct service_range *sr;
132 	struct rb_node *l, *r;
133 
134 	/* Non overlaps in tree at all? */
135 	if (!n || service_range_entry(n)->max < start)
136 		return NULL;
137 
138 	while (n) {
139 		l = n->rb_left;
140 		if (l && service_range_entry(l)->max >= start) {
141 			/* A leftmost overlap range node must be one in the left
142 			 * subtree. If not, it has lower > end, then nodes on
143 			 * the right side cannot satisfy the condition either.
144 			 */
145 			n = l;
146 			continue;
147 		}
148 
149 		/* No one in the left subtree can match, return if this node is
150 		 * an overlap i.e. leftmost.
151 		 */
152 		sr = service_range_entry(n);
153 		if (service_range_overlap(sr, start, end))
154 			return sr;
155 
156 		/* Ok, try to lookup on the right side */
157 		r = n->rb_right;
158 		if (sr->lower <= end &&
159 		    r && service_range_entry(r)->max >= start) {
160 			n = r;
161 			continue;
162 		}
163 		break;
164 	}
165 
166 	return NULL;
167 }
168 
169 /**
170  * service_range_match_next - find next service range matching a range
171  * @n: a node in service range rbtree from which the searching starts
172  * @start: beginning of the search range (end >= start) for matching
173  * @end: end of the search range (end >= start) for matching
174  *
175  * Return: the next service range node to the given node in the rbtree that
176  * overlaps the specific range if any. Otherwise, returns NULL.
177  */
178 static struct service_range *service_range_match_next(struct rb_node *n,
179 						      u32 start, u32 end)
180 {
181 	struct service_range *sr;
182 	struct rb_node *p, *r;
183 
184 	while (n) {
185 		r = n->rb_right;
186 		if (r && service_range_entry(r)->max >= start)
187 			/* A next overlap range node must be one in the right
188 			 * subtree. If not, it has lower > end, then any next
189 			 * successor (- an ancestor) of this node cannot
190 			 * satisfy the condition either.
191 			 */
192 			return service_range_match_first(r, start, end);
193 
194 		/* No one in the right subtree can match, go up to find an
195 		 * ancestor of this node which is parent of a left-hand child.
196 		 */
197 		while ((p = rb_parent(n)) && n == p->rb_right)
198 			n = p;
199 		if (!p)
200 			break;
201 
202 		/* Return if this ancestor is an overlap */
203 		sr = service_range_entry(p);
204 		if (service_range_overlap(sr, start, end))
205 			return sr;
206 
207 		/* Ok, try to lookup more from this ancestor */
208 		if (sr->lower <= end) {
209 			n = p;
210 			continue;
211 		}
212 		break;
213 	}
214 
215 	return NULL;
216 }
217 
218 static int hash(int x)
219 {
220 	return x & (TIPC_NAMETBL_SIZE - 1);
221 }
222 
223 /**
224  * tipc_publ_create - create a publication structure
225  * @ua: the service range the user is binding to
226  * @sk: the address of the socket that is bound
227  * @key: publication key
228  */
229 static struct publication *tipc_publ_create(struct tipc_uaddr *ua,
230 					    struct tipc_socket_addr *sk,
231 					    u32 key)
232 {
233 	struct publication *p = kzalloc(sizeof(*p), GFP_ATOMIC);
234 
235 	if (!p)
236 		return NULL;
237 
238 	p->sr = ua->sr;
239 	p->sk = *sk;
240 	p->scope = ua->scope;
241 	p->key = key;
242 	INIT_LIST_HEAD(&p->binding_sock);
243 	INIT_LIST_HEAD(&p->binding_node);
244 	INIT_LIST_HEAD(&p->local_publ);
245 	INIT_LIST_HEAD(&p->all_publ);
246 	INIT_LIST_HEAD(&p->list);
247 	return p;
248 }
249 
250 /**
251  * tipc_service_create - create a service structure for the specified 'type'
252  * @net: network namespace
253  * @ua: address representing the service to be bound
254  *
255  * Allocates a single range structure and sets it to all 0's.
256  */
257 static struct tipc_service *tipc_service_create(struct net *net,
258 						struct tipc_uaddr *ua)
259 {
260 	struct name_table *nt = tipc_name_table(net);
261 	struct tipc_service *service;
262 	struct hlist_head *hd;
263 
264 	service = kzalloc(sizeof(*service), GFP_ATOMIC);
265 	if (!service) {
266 		pr_warn("Service creation failed, no memory\n");
267 		return NULL;
268 	}
269 
270 	spin_lock_init(&service->lock);
271 	service->type = ua->sr.type;
272 	service->ranges = RB_ROOT;
273 	INIT_HLIST_NODE(&service->service_list);
274 	INIT_LIST_HEAD(&service->subscriptions);
275 	hd = &nt->services[hash(ua->sr.type)];
276 	hlist_add_head_rcu(&service->service_list, hd);
277 	return service;
278 }
279 
280 /*  tipc_service_find_range - find service range matching publication parameters
281  */
282 static struct service_range *tipc_service_find_range(struct tipc_service *sc,
283 						     struct tipc_uaddr *ua)
284 {
285 	struct service_range *sr;
286 
287 	service_range_foreach_match(sr, sc, ua->sr.lower, ua->sr.upper) {
288 		/* Look for exact match */
289 		if (sr->lower == ua->sr.lower && sr->upper == ua->sr.upper)
290 			return sr;
291 	}
292 
293 	return NULL;
294 }
295 
296 static struct service_range *tipc_service_create_range(struct tipc_service *sc,
297 						       struct publication *p)
298 {
299 	struct rb_node **n, *parent = NULL;
300 	struct service_range *sr;
301 	u32 lower = p->sr.lower;
302 	u32 upper = p->sr.upper;
303 
304 	n = &sc->ranges.rb_node;
305 	while (*n) {
306 		parent = *n;
307 		sr = service_range_entry(parent);
308 		if (lower == sr->lower && upper == sr->upper)
309 			return sr;
310 		if (sr->max < upper)
311 			sr->max = upper;
312 		if (lower <= sr->lower)
313 			n = &parent->rb_left;
314 		else
315 			n = &parent->rb_right;
316 	}
317 	sr = kzalloc(sizeof(*sr), GFP_ATOMIC);
318 	if (!sr)
319 		return NULL;
320 	sr->lower = lower;
321 	sr->upper = upper;
322 	sr->max = upper;
323 	INIT_LIST_HEAD(&sr->local_publ);
324 	INIT_LIST_HEAD(&sr->all_publ);
325 	rb_link_node(&sr->tree_node, parent, n);
326 	rb_insert_augmented(&sr->tree_node, &sc->ranges, &sr_callbacks);
327 	return sr;
328 }
329 
330 static bool tipc_service_insert_publ(struct net *net,
331 				     struct tipc_service *sc,
332 				     struct publication *p)
333 {
334 	struct tipc_subscription *sub, *tmp;
335 	struct service_range *sr;
336 	struct publication *_p;
337 	u32 node = p->sk.node;
338 	bool first = false;
339 	bool res = false;
340 
341 	spin_lock_bh(&sc->lock);
342 	sr = tipc_service_create_range(sc, p);
343 	if (!sr)
344 		goto  exit;
345 
346 	first = list_empty(&sr->all_publ);
347 
348 	/* Return if the publication already exists */
349 	list_for_each_entry(_p, &sr->all_publ, all_publ) {
350 		if (_p->key == p->key && (!_p->sk.node || _p->sk.node == node))
351 			goto exit;
352 	}
353 
354 	if (in_own_node(net, p->sk.node))
355 		list_add(&p->local_publ, &sr->local_publ);
356 	list_add(&p->all_publ, &sr->all_publ);
357 	p->id = sc->publ_cnt++;
358 
359 	/* Any subscriptions waiting for notification?  */
360 	list_for_each_entry_safe(sub, tmp, &sc->subscriptions, service_list) {
361 		tipc_sub_report_overlap(sub, p, TIPC_PUBLISHED, first);
362 	}
363 	res = true;
364 exit:
365 	if (!res)
366 		pr_warn("Failed to bind to %u,%u,%u\n",
367 			p->sr.type, p->sr.lower, p->sr.upper);
368 	spin_unlock_bh(&sc->lock);
369 	return res;
370 }
371 
372 /**
373  * tipc_service_remove_publ - remove a publication from a service
374  * @r: service_range to remove publication from
375  * @sk: address publishing socket
376  * @key: target publication key
377  */
378 static struct publication *tipc_service_remove_publ(struct service_range *r,
379 						    struct tipc_socket_addr *sk,
380 						    u32 key)
381 {
382 	struct publication *p;
383 	u32 node = sk->node;
384 
385 	list_for_each_entry(p, &r->all_publ, all_publ) {
386 		if (p->key != key || (node && node != p->sk.node))
387 			continue;
388 		list_del(&p->all_publ);
389 		list_del(&p->local_publ);
390 		return p;
391 	}
392 	return NULL;
393 }
394 
395 /*
396  * Code reused: time_after32() for the same purpose
397  */
398 #define publication_after(pa, pb) time_after32((pa)->id, (pb)->id)
399 static int tipc_publ_sort(void *priv, struct list_head *a,
400 			  struct list_head *b)
401 {
402 	struct publication *pa, *pb;
403 
404 	pa = container_of(a, struct publication, list);
405 	pb = container_of(b, struct publication, list);
406 	return publication_after(pa, pb);
407 }
408 
409 /**
410  * tipc_service_subscribe - attach a subscription, and optionally
411  * issue the prescribed number of events if there is any service
412  * range overlapping with the requested range
413  * @service: the tipc_service to attach the @sub to
414  * @sub: the subscription to attach
415  */
416 static void tipc_service_subscribe(struct tipc_service *service,
417 				   struct tipc_subscription *sub)
418 {
419 	struct publication *p, *first, *tmp;
420 	struct list_head publ_list;
421 	struct service_range *sr;
422 	u32 filter, lower, upper;
423 
424 	filter = sub->s.filter;
425 	lower = sub->s.seq.lower;
426 	upper = sub->s.seq.upper;
427 
428 	tipc_sub_get(sub);
429 	list_add(&sub->service_list, &service->subscriptions);
430 
431 	if (filter & TIPC_SUB_NO_STATUS)
432 		return;
433 
434 	INIT_LIST_HEAD(&publ_list);
435 	service_range_foreach_match(sr, service, lower, upper) {
436 		first = NULL;
437 		list_for_each_entry(p, &sr->all_publ, all_publ) {
438 			if (filter & TIPC_SUB_PORTS)
439 				list_add_tail(&p->list, &publ_list);
440 			else if (!first || publication_after(first, p))
441 				/* Pick this range's *first* publication */
442 				first = p;
443 		}
444 		if (first)
445 			list_add_tail(&first->list, &publ_list);
446 	}
447 
448 	/* Sort the publications before reporting */
449 	list_sort(NULL, &publ_list, tipc_publ_sort);
450 	list_for_each_entry_safe(p, tmp, &publ_list, list) {
451 		tipc_sub_report_overlap(sub, p, TIPC_PUBLISHED, true);
452 		list_del_init(&p->list);
453 	}
454 }
455 
456 static struct tipc_service *tipc_service_find(struct net *net,
457 					      struct tipc_uaddr *ua)
458 {
459 	struct name_table *nt = tipc_name_table(net);
460 	struct hlist_head *service_head;
461 	struct tipc_service *service;
462 
463 	service_head = &nt->services[hash(ua->sr.type)];
464 	hlist_for_each_entry_rcu(service, service_head, service_list) {
465 		if (service->type == ua->sr.type)
466 			return service;
467 	}
468 	return NULL;
469 };
470 
471 struct publication *tipc_nametbl_insert_publ(struct net *net,
472 					     struct tipc_uaddr *ua,
473 					     struct tipc_socket_addr *sk,
474 					     u32 key)
475 {
476 	struct tipc_service *sc;
477 	struct publication *p;
478 	u32 type = ua->sr.type;
479 
480 	p = tipc_publ_create(ua, sk, key);
481 	if (!p)
482 		return NULL;
483 
484 	if (ua->sr.lower > ua->sr.upper) {
485 		pr_debug("Failed to bind illegal {%u,%u,%u} from node %u\n",
486 			 type, ua->sr.lower, ua->sr.upper, sk->node);
487 		return NULL;
488 	}
489 	sc = tipc_service_find(net, ua);
490 	if (!sc)
491 		sc = tipc_service_create(net, ua);
492 	if (sc && tipc_service_insert_publ(net, sc, p))
493 		return p;
494 	kfree(p);
495 	return NULL;
496 }
497 
498 struct publication *tipc_nametbl_remove_publ(struct net *net,
499 					     struct tipc_uaddr *ua,
500 					     struct tipc_socket_addr *sk,
501 					     u32 key)
502 {
503 	struct tipc_subscription *sub, *tmp;
504 	struct publication *p = NULL;
505 	struct service_range *sr;
506 	struct tipc_service *sc;
507 	bool last;
508 
509 	sc = tipc_service_find(net, ua);
510 	if (!sc)
511 		return NULL;
512 
513 	spin_lock_bh(&sc->lock);
514 	sr = tipc_service_find_range(sc, ua);
515 	if (!sr)
516 		goto exit;
517 	p = tipc_service_remove_publ(sr, sk, key);
518 	if (!p)
519 		goto exit;
520 
521 	/* Notify any waiting subscriptions */
522 	last = list_empty(&sr->all_publ);
523 	list_for_each_entry_safe(sub, tmp, &sc->subscriptions, service_list) {
524 		tipc_sub_report_overlap(sub, p, TIPC_WITHDRAWN, last);
525 	}
526 
527 	/* Remove service range item if this was its last publication */
528 	if (list_empty(&sr->all_publ)) {
529 		rb_erase_augmented(&sr->tree_node, &sc->ranges, &sr_callbacks);
530 		kfree(sr);
531 	}
532 
533 	/* Delete service item if no more publications and subscriptions */
534 	if (RB_EMPTY_ROOT(&sc->ranges) && list_empty(&sc->subscriptions)) {
535 		hlist_del_init_rcu(&sc->service_list);
536 		kfree_rcu(sc, rcu);
537 	}
538 exit:
539 	spin_unlock_bh(&sc->lock);
540 	return p;
541 }
542 
543 /**
544  * tipc_nametbl_lookup_anycast - perform service instance to socket translation
545  * @net: network namespace
546  * @ua: service address to look up
547  * @sk: address to socket we want to find
548  *
549  * On entry, a non-zero 'sk->node' indicates the node where we want lookup to be
550  * performed, which may not be this one.
551  * On exit:
552  * - If lookup is deferred to another node, leave 'sk->node' unchanged and
553  *   return 'true'.
554  * - If lookup is successful, set the 'sk->node' and 'sk->ref' (== portid) which
555  *   represent the bound socket and return 'true'.
556  * - If lookup fails, return 'false'
557  *
558  * Note that for legacy users (node configured with Z.C.N address format) the
559  * 'closest-first' lookup algorithm must be maintained, i.e., if sk.node is 0
560  * we must look in the local binding list first
561  */
562 bool tipc_nametbl_lookup_anycast(struct net *net,
563 				 struct tipc_uaddr *ua,
564 				 struct tipc_socket_addr *sk)
565 {
566 	struct tipc_net *tn = tipc_net(net);
567 	bool legacy = tn->legacy_addr_format;
568 	u32 self = tipc_own_addr(net);
569 	u32 inst = ua->sa.instance;
570 	struct service_range *r;
571 	struct tipc_service *sc;
572 	struct publication *p;
573 	struct list_head *l;
574 	bool res = false;
575 
576 	if (!tipc_in_scope(legacy, sk->node, self))
577 		return true;
578 
579 	rcu_read_lock();
580 	sc = tipc_service_find(net, ua);
581 	if (unlikely(!sc))
582 		goto exit;
583 
584 	spin_lock_bh(&sc->lock);
585 	service_range_foreach_match(r, sc, inst, inst) {
586 		/* Select lookup algo: local, closest-first or round-robin */
587 		if (sk->node == self) {
588 			l = &r->local_publ;
589 			if (list_empty(l))
590 				continue;
591 			p = list_first_entry(l, struct publication, local_publ);
592 			list_move_tail(&p->local_publ, &r->local_publ);
593 		} else if (legacy && !sk->node && !list_empty(&r->local_publ)) {
594 			l = &r->local_publ;
595 			p = list_first_entry(l, struct publication, local_publ);
596 			list_move_tail(&p->local_publ, &r->local_publ);
597 		} else {
598 			l = &r->all_publ;
599 			p = list_first_entry(l, struct publication, all_publ);
600 			list_move_tail(&p->all_publ, &r->all_publ);
601 		}
602 		*sk = p->sk;
603 		res = true;
604 		/* Todo: as for legacy, pick the first matching range only, a
605 		 * "true" round-robin will be performed as needed.
606 		 */
607 		break;
608 	}
609 	spin_unlock_bh(&sc->lock);
610 
611 exit:
612 	rcu_read_unlock();
613 	return res;
614 }
615 
616 /* tipc_nametbl_lookup_group(): lookup destinaton(s) in a communication group
617  * Returns a list of one (== group anycast) or more (== group multicast)
618  * destination socket/node pairs matching the given address.
619  * The requester may or may not want to exclude himself from the list.
620  */
621 bool tipc_nametbl_lookup_group(struct net *net, struct tipc_uaddr *ua,
622 			       struct list_head *dsts, int *dstcnt,
623 			       u32 exclude, bool mcast)
624 {
625 	u32 self = tipc_own_addr(net);
626 	u32 inst = ua->sa.instance;
627 	struct service_range *sr;
628 	struct tipc_service *sc;
629 	struct publication *p;
630 
631 	*dstcnt = 0;
632 	rcu_read_lock();
633 	sc = tipc_service_find(net, ua);
634 	if (unlikely(!sc))
635 		goto exit;
636 
637 	spin_lock_bh(&sc->lock);
638 
639 	/* Todo: a full search i.e. service_range_foreach_match() instead? */
640 	sr = service_range_match_first(sc->ranges.rb_node, inst, inst);
641 	if (!sr)
642 		goto no_match;
643 
644 	list_for_each_entry(p, &sr->all_publ, all_publ) {
645 		if (p->scope != ua->scope)
646 			continue;
647 		if (p->sk.ref == exclude && p->sk.node == self)
648 			continue;
649 		tipc_dest_push(dsts, p->sk.node, p->sk.ref);
650 		(*dstcnt)++;
651 		if (mcast)
652 			continue;
653 		list_move_tail(&p->all_publ, &sr->all_publ);
654 		break;
655 	}
656 no_match:
657 	spin_unlock_bh(&sc->lock);
658 exit:
659 	rcu_read_unlock();
660 	return !list_empty(dsts);
661 }
662 
663 /* tipc_nametbl_lookup_mcast_sockets(): look up node local destinaton sockets
664  *                                      matching the given address
665  * Used on nodes which have received a multicast/broadcast message
666  * Returns a list of local sockets
667  */
668 void tipc_nametbl_lookup_mcast_sockets(struct net *net, struct tipc_uaddr *ua,
669 				       bool exact, struct list_head *dports)
670 {
671 	struct service_range *sr;
672 	struct tipc_service *sc;
673 	struct publication *p;
674 	u32 scope = ua->scope;
675 
676 	rcu_read_lock();
677 	sc = tipc_service_find(net, ua);
678 	if (!sc)
679 		goto exit;
680 
681 	spin_lock_bh(&sc->lock);
682 	service_range_foreach_match(sr, sc, ua->sr.lower, ua->sr.upper) {
683 		list_for_each_entry(p, &sr->local_publ, local_publ) {
684 			if (p->scope == scope || (!exact && p->scope < scope))
685 				tipc_dest_push(dports, 0, p->sk.ref);
686 		}
687 	}
688 	spin_unlock_bh(&sc->lock);
689 exit:
690 	rcu_read_unlock();
691 }
692 
693 /* tipc_nametbl_lookup_mcast_nodes(): look up all destination nodes matching
694  *                                    the given address. Used in sending node.
695  * Used on nodes which are sending out a multicast/broadcast message
696  * Returns a list of nodes, including own node if applicable
697  */
698 void tipc_nametbl_lookup_mcast_nodes(struct net *net, struct tipc_uaddr *ua,
699 				     struct tipc_nlist *nodes)
700 {
701 	struct service_range *sr;
702 	struct tipc_service *sc;
703 	struct publication *p;
704 
705 	rcu_read_lock();
706 	sc = tipc_service_find(net, ua);
707 	if (!sc)
708 		goto exit;
709 
710 	spin_lock_bh(&sc->lock);
711 	service_range_foreach_match(sr, sc, ua->sr.lower, ua->sr.upper) {
712 		list_for_each_entry(p, &sr->all_publ, all_publ) {
713 			tipc_nlist_add(nodes, p->sk.node);
714 		}
715 	}
716 	spin_unlock_bh(&sc->lock);
717 exit:
718 	rcu_read_unlock();
719 }
720 
721 /* tipc_nametbl_build_group - build list of communication group members
722  */
723 void tipc_nametbl_build_group(struct net *net, struct tipc_group *grp,
724 			      struct tipc_uaddr *ua)
725 {
726 	struct service_range *sr;
727 	struct tipc_service *sc;
728 	struct publication *p;
729 	struct rb_node *n;
730 
731 	rcu_read_lock();
732 	sc = tipc_service_find(net, ua);
733 	if (!sc)
734 		goto exit;
735 
736 	spin_lock_bh(&sc->lock);
737 	for (n = rb_first(&sc->ranges); n; n = rb_next(n)) {
738 		sr = container_of(n, struct service_range, tree_node);
739 		list_for_each_entry(p, &sr->all_publ, all_publ) {
740 			if (p->scope != ua->scope)
741 				continue;
742 			tipc_group_add_member(grp, p->sk.node, p->sk.ref,
743 					      p->sr.lower);
744 		}
745 	}
746 	spin_unlock_bh(&sc->lock);
747 exit:
748 	rcu_read_unlock();
749 }
750 
751 /* tipc_nametbl_publish - add service binding to name table
752  */
753 struct publication *tipc_nametbl_publish(struct net *net, struct tipc_uaddr *ua,
754 					 struct tipc_socket_addr *sk, u32 key)
755 {
756 	struct name_table *nt = tipc_name_table(net);
757 	struct tipc_net *tn = tipc_net(net);
758 	struct publication *p = NULL;
759 	struct sk_buff *skb = NULL;
760 	u32 rc_dests;
761 
762 	spin_lock_bh(&tn->nametbl_lock);
763 
764 	if (nt->local_publ_count >= TIPC_MAX_PUBL) {
765 		pr_warn("Bind failed, max limit %u reached\n", TIPC_MAX_PUBL);
766 		goto exit;
767 	}
768 
769 	p = tipc_nametbl_insert_publ(net, ua, sk, key);
770 	if (p) {
771 		nt->local_publ_count++;
772 		skb = tipc_named_publish(net, p);
773 	}
774 	rc_dests = nt->rc_dests;
775 exit:
776 	spin_unlock_bh(&tn->nametbl_lock);
777 
778 	if (skb)
779 		tipc_node_broadcast(net, skb, rc_dests);
780 	return p;
781 
782 }
783 
784 /**
785  * tipc_nametbl_withdraw - withdraw a service binding
786  * @net: network namespace
787  * @ua: service address/range being unbound
788  * @sk: address of the socket being unbound from
789  * @key: target publication key
790  */
791 void tipc_nametbl_withdraw(struct net *net, struct tipc_uaddr *ua,
792 			   struct tipc_socket_addr *sk, u32 key)
793 {
794 	struct name_table *nt = tipc_name_table(net);
795 	struct tipc_net *tn = tipc_net(net);
796 	struct sk_buff *skb = NULL;
797 	struct publication *p;
798 	u32 rc_dests;
799 
800 	spin_lock_bh(&tn->nametbl_lock);
801 
802 	p = tipc_nametbl_remove_publ(net, ua, sk, key);
803 	if (p) {
804 		nt->local_publ_count--;
805 		skb = tipc_named_withdraw(net, p);
806 		list_del_init(&p->binding_sock);
807 		kfree_rcu(p, rcu);
808 	} else {
809 		pr_err("Failed to remove local publication {%u,%u,%u}/%u\n",
810 		       ua->sr.type, ua->sr.lower, ua->sr.upper, key);
811 	}
812 	rc_dests = nt->rc_dests;
813 	spin_unlock_bh(&tn->nametbl_lock);
814 
815 	if (skb)
816 		tipc_node_broadcast(net, skb, rc_dests);
817 }
818 
819 /**
820  * tipc_nametbl_subscribe - add a subscription object to the name table
821  * @sub: subscription to add
822  */
823 bool tipc_nametbl_subscribe(struct tipc_subscription *sub)
824 {
825 	struct tipc_net *tn = tipc_net(sub->net);
826 	u32 type = sub->s.seq.type;
827 	struct tipc_service *sc;
828 	struct tipc_uaddr ua;
829 	bool res = true;
830 
831 	tipc_uaddr(&ua, TIPC_SERVICE_RANGE, TIPC_NODE_SCOPE, type,
832 		   sub->s.seq.lower, sub->s.seq.upper);
833 	spin_lock_bh(&tn->nametbl_lock);
834 	sc = tipc_service_find(sub->net, &ua);
835 	if (!sc)
836 		sc = tipc_service_create(sub->net, &ua);
837 	if (sc) {
838 		spin_lock_bh(&sc->lock);
839 		tipc_service_subscribe(sc, sub);
840 		spin_unlock_bh(&sc->lock);
841 	} else {
842 		pr_warn("Failed to subscribe for {%u,%u,%u}\n",
843 			type, sub->s.seq.lower, sub->s.seq.upper);
844 		res = false;
845 	}
846 	spin_unlock_bh(&tn->nametbl_lock);
847 	return res;
848 }
849 
850 /**
851  * tipc_nametbl_unsubscribe - remove a subscription object from name table
852  * @sub: subscription to remove
853  */
854 void tipc_nametbl_unsubscribe(struct tipc_subscription *sub)
855 {
856 	struct tipc_net *tn = tipc_net(sub->net);
857 	struct tipc_service *sc;
858 	struct tipc_uaddr ua;
859 
860 	tipc_uaddr(&ua, TIPC_SERVICE_RANGE, TIPC_NODE_SCOPE,
861 		   sub->s.seq.type, sub->s.seq.lower, sub->s.seq.upper);
862 	spin_lock_bh(&tn->nametbl_lock);
863 	sc = tipc_service_find(sub->net, &ua);
864 	if (!sc)
865 		goto exit;
866 
867 	spin_lock_bh(&sc->lock);
868 	list_del_init(&sub->service_list);
869 	tipc_sub_put(sub);
870 
871 	/* Delete service item if no more publications and subscriptions */
872 	if (RB_EMPTY_ROOT(&sc->ranges) && list_empty(&sc->subscriptions)) {
873 		hlist_del_init_rcu(&sc->service_list);
874 		kfree_rcu(sc, rcu);
875 	}
876 	spin_unlock_bh(&sc->lock);
877 exit:
878 	spin_unlock_bh(&tn->nametbl_lock);
879 }
880 
881 int tipc_nametbl_init(struct net *net)
882 {
883 	struct tipc_net *tn = tipc_net(net);
884 	struct name_table *nt;
885 	int i;
886 
887 	nt = kzalloc(sizeof(*nt), GFP_KERNEL);
888 	if (!nt)
889 		return -ENOMEM;
890 
891 	for (i = 0; i < TIPC_NAMETBL_SIZE; i++)
892 		INIT_HLIST_HEAD(&nt->services[i]);
893 
894 	INIT_LIST_HEAD(&nt->node_scope);
895 	INIT_LIST_HEAD(&nt->cluster_scope);
896 	rwlock_init(&nt->cluster_scope_lock);
897 	tn->nametbl = nt;
898 	spin_lock_init(&tn->nametbl_lock);
899 	return 0;
900 }
901 
902 /**
903  * tipc_service_delete - purge all publications for a service and delete it
904  * @net: the associated network namespace
905  * @sc: tipc_service to delete
906  */
907 static void tipc_service_delete(struct net *net, struct tipc_service *sc)
908 {
909 	struct service_range *sr, *tmpr;
910 	struct publication *p, *tmp;
911 
912 	spin_lock_bh(&sc->lock);
913 	rbtree_postorder_for_each_entry_safe(sr, tmpr, &sc->ranges, tree_node) {
914 		list_for_each_entry_safe(p, tmp, &sr->all_publ, all_publ) {
915 			tipc_service_remove_publ(sr, &p->sk, p->key);
916 			kfree_rcu(p, rcu);
917 		}
918 		rb_erase_augmented(&sr->tree_node, &sc->ranges, &sr_callbacks);
919 		kfree(sr);
920 	}
921 	hlist_del_init_rcu(&sc->service_list);
922 	spin_unlock_bh(&sc->lock);
923 	kfree_rcu(sc, rcu);
924 }
925 
926 void tipc_nametbl_stop(struct net *net)
927 {
928 	struct name_table *nt = tipc_name_table(net);
929 	struct tipc_net *tn = tipc_net(net);
930 	struct hlist_head *service_head;
931 	struct tipc_service *service;
932 	u32 i;
933 
934 	/* Verify name table is empty and purge any lingering
935 	 * publications, then release the name table
936 	 */
937 	spin_lock_bh(&tn->nametbl_lock);
938 	for (i = 0; i < TIPC_NAMETBL_SIZE; i++) {
939 		if (hlist_empty(&nt->services[i]))
940 			continue;
941 		service_head = &nt->services[i];
942 		hlist_for_each_entry_rcu(service, service_head, service_list) {
943 			tipc_service_delete(net, service);
944 		}
945 	}
946 	spin_unlock_bh(&tn->nametbl_lock);
947 
948 	synchronize_net();
949 	kfree(nt);
950 }
951 
952 static int __tipc_nl_add_nametable_publ(struct tipc_nl_msg *msg,
953 					struct tipc_service *service,
954 					struct service_range *sr,
955 					u32 *last_key)
956 {
957 	struct publication *p;
958 	struct nlattr *attrs;
959 	struct nlattr *b;
960 	void *hdr;
961 
962 	if (*last_key) {
963 		list_for_each_entry(p, &sr->all_publ, all_publ)
964 			if (p->key == *last_key)
965 				break;
966 		if (p->key != *last_key)
967 			return -EPIPE;
968 	} else {
969 		p = list_first_entry(&sr->all_publ,
970 				     struct publication,
971 				     all_publ);
972 	}
973 
974 	list_for_each_entry_from(p, &sr->all_publ, all_publ) {
975 		*last_key = p->key;
976 
977 		hdr = genlmsg_put(msg->skb, msg->portid, msg->seq,
978 				  &tipc_genl_family, NLM_F_MULTI,
979 				  TIPC_NL_NAME_TABLE_GET);
980 		if (!hdr)
981 			return -EMSGSIZE;
982 
983 		attrs = nla_nest_start_noflag(msg->skb, TIPC_NLA_NAME_TABLE);
984 		if (!attrs)
985 			goto msg_full;
986 
987 		b = nla_nest_start_noflag(msg->skb, TIPC_NLA_NAME_TABLE_PUBL);
988 		if (!b)
989 			goto attr_msg_full;
990 
991 		if (nla_put_u32(msg->skb, TIPC_NLA_PUBL_TYPE, service->type))
992 			goto publ_msg_full;
993 		if (nla_put_u32(msg->skb, TIPC_NLA_PUBL_LOWER, sr->lower))
994 			goto publ_msg_full;
995 		if (nla_put_u32(msg->skb, TIPC_NLA_PUBL_UPPER, sr->upper))
996 			goto publ_msg_full;
997 		if (nla_put_u32(msg->skb, TIPC_NLA_PUBL_SCOPE, p->scope))
998 			goto publ_msg_full;
999 		if (nla_put_u32(msg->skb, TIPC_NLA_PUBL_NODE, p->sk.node))
1000 			goto publ_msg_full;
1001 		if (nla_put_u32(msg->skb, TIPC_NLA_PUBL_REF, p->sk.ref))
1002 			goto publ_msg_full;
1003 		if (nla_put_u32(msg->skb, TIPC_NLA_PUBL_KEY, p->key))
1004 			goto publ_msg_full;
1005 
1006 		nla_nest_end(msg->skb, b);
1007 		nla_nest_end(msg->skb, attrs);
1008 		genlmsg_end(msg->skb, hdr);
1009 	}
1010 	*last_key = 0;
1011 
1012 	return 0;
1013 
1014 publ_msg_full:
1015 	nla_nest_cancel(msg->skb, b);
1016 attr_msg_full:
1017 	nla_nest_cancel(msg->skb, attrs);
1018 msg_full:
1019 	genlmsg_cancel(msg->skb, hdr);
1020 
1021 	return -EMSGSIZE;
1022 }
1023 
1024 static int __tipc_nl_service_range_list(struct tipc_nl_msg *msg,
1025 					struct tipc_service *sc,
1026 					u32 *last_lower, u32 *last_key)
1027 {
1028 	struct service_range *sr;
1029 	struct rb_node *n;
1030 	int err;
1031 
1032 	for (n = rb_first(&sc->ranges); n; n = rb_next(n)) {
1033 		sr = container_of(n, struct service_range, tree_node);
1034 		if (sr->lower < *last_lower)
1035 			continue;
1036 		err = __tipc_nl_add_nametable_publ(msg, sc, sr, last_key);
1037 		if (err) {
1038 			*last_lower = sr->lower;
1039 			return err;
1040 		}
1041 	}
1042 	*last_lower = 0;
1043 	return 0;
1044 }
1045 
1046 static int tipc_nl_service_list(struct net *net, struct tipc_nl_msg *msg,
1047 				u32 *last_type, u32 *last_lower, u32 *last_key)
1048 {
1049 	struct tipc_net *tn = tipc_net(net);
1050 	struct tipc_service *service = NULL;
1051 	struct hlist_head *head;
1052 	struct tipc_uaddr ua;
1053 	int err;
1054 	int i;
1055 
1056 	if (*last_type)
1057 		i = hash(*last_type);
1058 	else
1059 		i = 0;
1060 
1061 	for (; i < TIPC_NAMETBL_SIZE; i++) {
1062 		head = &tn->nametbl->services[i];
1063 
1064 		if (*last_type ||
1065 		    (!i && *last_key && (*last_lower == *last_key))) {
1066 			tipc_uaddr(&ua, TIPC_SERVICE_RANGE, TIPC_NODE_SCOPE,
1067 				   *last_type, *last_lower, *last_lower);
1068 			service = tipc_service_find(net, &ua);
1069 			if (!service)
1070 				return -EPIPE;
1071 		} else {
1072 			hlist_for_each_entry_rcu(service, head, service_list)
1073 				break;
1074 			if (!service)
1075 				continue;
1076 		}
1077 
1078 		hlist_for_each_entry_from_rcu(service, service_list) {
1079 			spin_lock_bh(&service->lock);
1080 			err = __tipc_nl_service_range_list(msg, service,
1081 							   last_lower,
1082 							   last_key);
1083 
1084 			if (err) {
1085 				*last_type = service->type;
1086 				spin_unlock_bh(&service->lock);
1087 				return err;
1088 			}
1089 			spin_unlock_bh(&service->lock);
1090 		}
1091 		*last_type = 0;
1092 	}
1093 	return 0;
1094 }
1095 
1096 int tipc_nl_name_table_dump(struct sk_buff *skb, struct netlink_callback *cb)
1097 {
1098 	struct net *net = sock_net(skb->sk);
1099 	u32 last_type = cb->args[0];
1100 	u32 last_lower = cb->args[1];
1101 	u32 last_key = cb->args[2];
1102 	int done = cb->args[3];
1103 	struct tipc_nl_msg msg;
1104 	int err;
1105 
1106 	if (done)
1107 		return 0;
1108 
1109 	msg.skb = skb;
1110 	msg.portid = NETLINK_CB(cb->skb).portid;
1111 	msg.seq = cb->nlh->nlmsg_seq;
1112 
1113 	rcu_read_lock();
1114 	err = tipc_nl_service_list(net, &msg, &last_type,
1115 				   &last_lower, &last_key);
1116 	if (!err) {
1117 		done = 1;
1118 	} else if (err != -EMSGSIZE) {
1119 		/* We never set seq or call nl_dump_check_consistent() this
1120 		 * means that setting prev_seq here will cause the consistence
1121 		 * check to fail in the netlink callback handler. Resulting in
1122 		 * the NLMSG_DONE message having the NLM_F_DUMP_INTR flag set if
1123 		 * we got an error.
1124 		 */
1125 		cb->prev_seq = 1;
1126 	}
1127 	rcu_read_unlock();
1128 
1129 	cb->args[0] = last_type;
1130 	cb->args[1] = last_lower;
1131 	cb->args[2] = last_key;
1132 	cb->args[3] = done;
1133 
1134 	return skb->len;
1135 }
1136 
1137 struct tipc_dest *tipc_dest_find(struct list_head *l, u32 node, u32 port)
1138 {
1139 	struct tipc_dest *dst;
1140 
1141 	list_for_each_entry(dst, l, list) {
1142 		if (dst->node == node && dst->port == port)
1143 			return dst;
1144 	}
1145 	return NULL;
1146 }
1147 
1148 bool tipc_dest_push(struct list_head *l, u32 node, u32 port)
1149 {
1150 	struct tipc_dest *dst;
1151 
1152 	if (tipc_dest_find(l, node, port))
1153 		return false;
1154 
1155 	dst = kmalloc(sizeof(*dst), GFP_ATOMIC);
1156 	if (unlikely(!dst))
1157 		return false;
1158 	dst->node = node;
1159 	dst->port = port;
1160 	list_add(&dst->list, l);
1161 	return true;
1162 }
1163 
1164 bool tipc_dest_pop(struct list_head *l, u32 *node, u32 *port)
1165 {
1166 	struct tipc_dest *dst;
1167 
1168 	if (list_empty(l))
1169 		return false;
1170 	dst = list_first_entry(l, typeof(*dst), list);
1171 	if (port)
1172 		*port = dst->port;
1173 	if (node)
1174 		*node = dst->node;
1175 	list_del(&dst->list);
1176 	kfree(dst);
1177 	return true;
1178 }
1179 
1180 bool tipc_dest_del(struct list_head *l, u32 node, u32 port)
1181 {
1182 	struct tipc_dest *dst;
1183 
1184 	dst = tipc_dest_find(l, node, port);
1185 	if (!dst)
1186 		return false;
1187 	list_del(&dst->list);
1188 	kfree(dst);
1189 	return true;
1190 }
1191 
1192 void tipc_dest_list_purge(struct list_head *l)
1193 {
1194 	struct tipc_dest *dst, *tmp;
1195 
1196 	list_for_each_entry_safe(dst, tmp, l, list) {
1197 		list_del(&dst->list);
1198 		kfree(dst);
1199 	}
1200 }
1201 
1202 int tipc_dest_list_len(struct list_head *l)
1203 {
1204 	struct tipc_dest *dst;
1205 	int i = 0;
1206 
1207 	list_for_each_entry(dst, l, list) {
1208 		i++;
1209 	}
1210 	return i;
1211 }
1212