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