xref: /openbmc/linux/net/tipc/name_table.c (revision b802fb99)
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 <net/genetlink.h>
47 
48 #define TIPC_NAMETBL_SIZE 1024		/* must be a power of 2 */
49 
50 static const struct nla_policy
51 tipc_nl_name_table_policy[TIPC_NLA_NAME_TABLE_MAX + 1] = {
52 	[TIPC_NLA_NAME_TABLE_UNSPEC]	= { .type = NLA_UNSPEC },
53 	[TIPC_NLA_NAME_TABLE_PUBL]	= { .type = NLA_NESTED }
54 };
55 
56 /**
57  * struct name_info - name sequence publication info
58  * @node_list: circular list of publications made by own node
59  * @cluster_list: circular list of publications made by own cluster
60  * @zone_list: circular list of publications made by own zone
61  * @node_list_size: number of entries in "node_list"
62  * @cluster_list_size: number of entries in "cluster_list"
63  * @zone_list_size: number of entries in "zone_list"
64  *
65  * Note: The zone list always contains at least one entry, since all
66  *       publications of the associated name sequence belong to it.
67  *       (The cluster and node lists may be empty.)
68  */
69 struct name_info {
70 	struct list_head node_list;
71 	struct list_head cluster_list;
72 	struct list_head zone_list;
73 	u32 node_list_size;
74 	u32 cluster_list_size;
75 	u32 zone_list_size;
76 };
77 
78 /**
79  * struct sub_seq - container for all published instances of a name sequence
80  * @lower: name sequence lower bound
81  * @upper: name sequence upper bound
82  * @info: pointer to name sequence publication info
83  */
84 struct sub_seq {
85 	u32 lower;
86 	u32 upper;
87 	struct name_info *info;
88 };
89 
90 /**
91  * struct name_seq - container for all published instances of a name type
92  * @type: 32 bit 'type' value for name sequence
93  * @sseq: pointer to dynamically-sized array of sub-sequences of this 'type';
94  *        sub-sequences are sorted in ascending order
95  * @alloc: number of sub-sequences currently in array
96  * @first_free: array index of first unused sub-sequence entry
97  * @ns_list: links to adjacent name sequences in hash chain
98  * @subscriptions: list of subscriptions for this 'type'
99  * @lock: spinlock controlling access to publication lists of all sub-sequences
100  * @rcu: RCU callback head used for deferred freeing
101  */
102 struct name_seq {
103 	u32 type;
104 	struct sub_seq *sseqs;
105 	u32 alloc;
106 	u32 first_free;
107 	struct hlist_node ns_list;
108 	struct list_head subscriptions;
109 	spinlock_t lock;
110 	struct rcu_head rcu;
111 };
112 
113 static int hash(int x)
114 {
115 	return x & (TIPC_NAMETBL_SIZE - 1);
116 }
117 
118 /**
119  * publ_create - create a publication structure
120  */
121 static struct publication *publ_create(u32 type, u32 lower, u32 upper,
122 				       u32 scope, u32 node, u32 port_ref,
123 				       u32 key)
124 {
125 	struct publication *publ = kzalloc(sizeof(*publ), GFP_ATOMIC);
126 	if (publ == NULL) {
127 		pr_warn("Publication creation failure, no memory\n");
128 		return NULL;
129 	}
130 
131 	publ->type = type;
132 	publ->lower = lower;
133 	publ->upper = upper;
134 	publ->scope = scope;
135 	publ->node = node;
136 	publ->ref = port_ref;
137 	publ->key = key;
138 	INIT_LIST_HEAD(&publ->pport_list);
139 	return publ;
140 }
141 
142 /**
143  * tipc_subseq_alloc - allocate a specified number of sub-sequence structures
144  */
145 static struct sub_seq *tipc_subseq_alloc(u32 cnt)
146 {
147 	return kcalloc(cnt, sizeof(struct sub_seq), GFP_ATOMIC);
148 }
149 
150 /**
151  * tipc_nameseq_create - create a name sequence structure for the specified 'type'
152  *
153  * Allocates a single sub-sequence structure and sets it to all 0's.
154  */
155 static struct name_seq *tipc_nameseq_create(u32 type, struct hlist_head *seq_head)
156 {
157 	struct name_seq *nseq = kzalloc(sizeof(*nseq), GFP_ATOMIC);
158 	struct sub_seq *sseq = tipc_subseq_alloc(1);
159 
160 	if (!nseq || !sseq) {
161 		pr_warn("Name sequence creation failed, no memory\n");
162 		kfree(nseq);
163 		kfree(sseq);
164 		return NULL;
165 	}
166 
167 	spin_lock_init(&nseq->lock);
168 	nseq->type = type;
169 	nseq->sseqs = sseq;
170 	nseq->alloc = 1;
171 	INIT_HLIST_NODE(&nseq->ns_list);
172 	INIT_LIST_HEAD(&nseq->subscriptions);
173 	hlist_add_head_rcu(&nseq->ns_list, seq_head);
174 	return nseq;
175 }
176 
177 /**
178  * nameseq_find_subseq - find sub-sequence (if any) matching a name instance
179  *
180  * Very time-critical, so binary searches through sub-sequence array.
181  */
182 static struct sub_seq *nameseq_find_subseq(struct name_seq *nseq,
183 					   u32 instance)
184 {
185 	struct sub_seq *sseqs = nseq->sseqs;
186 	int low = 0;
187 	int high = nseq->first_free - 1;
188 	int mid;
189 
190 	while (low <= high) {
191 		mid = (low + high) / 2;
192 		if (instance < sseqs[mid].lower)
193 			high = mid - 1;
194 		else if (instance > sseqs[mid].upper)
195 			low = mid + 1;
196 		else
197 			return &sseqs[mid];
198 	}
199 	return NULL;
200 }
201 
202 /**
203  * nameseq_locate_subseq - determine position of name instance in sub-sequence
204  *
205  * Returns index in sub-sequence array of the entry that contains the specified
206  * instance value; if no entry contains that value, returns the position
207  * where a new entry for it would be inserted in the array.
208  *
209  * Note: Similar to binary search code for locating a sub-sequence.
210  */
211 static u32 nameseq_locate_subseq(struct name_seq *nseq, u32 instance)
212 {
213 	struct sub_seq *sseqs = nseq->sseqs;
214 	int low = 0;
215 	int high = nseq->first_free - 1;
216 	int mid;
217 
218 	while (low <= high) {
219 		mid = (low + high) / 2;
220 		if (instance < sseqs[mid].lower)
221 			high = mid - 1;
222 		else if (instance > sseqs[mid].upper)
223 			low = mid + 1;
224 		else
225 			return mid;
226 	}
227 	return low;
228 }
229 
230 /**
231  * tipc_nameseq_insert_publ
232  */
233 static struct publication *tipc_nameseq_insert_publ(struct net *net,
234 						    struct name_seq *nseq,
235 						    u32 type, u32 lower,
236 						    u32 upper, u32 scope,
237 						    u32 node, u32 port, u32 key)
238 {
239 	struct tipc_subscription *s;
240 	struct tipc_subscription *st;
241 	struct publication *publ;
242 	struct sub_seq *sseq;
243 	struct name_info *info;
244 	int created_subseq = 0;
245 
246 	sseq = nameseq_find_subseq(nseq, lower);
247 	if (sseq) {
248 
249 		/* Lower end overlaps existing entry => need an exact match */
250 		if ((sseq->lower != lower) || (sseq->upper != upper)) {
251 			return NULL;
252 		}
253 
254 		info = sseq->info;
255 
256 		/* Check if an identical publication already exists */
257 		list_for_each_entry(publ, &info->zone_list, zone_list) {
258 			if ((publ->ref == port) && (publ->key == key) &&
259 			    (!publ->node || (publ->node == node)))
260 				return NULL;
261 		}
262 	} else {
263 		u32 inspos;
264 		struct sub_seq *freesseq;
265 
266 		/* Find where lower end should be inserted */
267 		inspos = nameseq_locate_subseq(nseq, lower);
268 
269 		/* Fail if upper end overlaps into an existing entry */
270 		if ((inspos < nseq->first_free) &&
271 		    (upper >= nseq->sseqs[inspos].lower)) {
272 			return NULL;
273 		}
274 
275 		/* Ensure there is space for new sub-sequence */
276 		if (nseq->first_free == nseq->alloc) {
277 			struct sub_seq *sseqs = tipc_subseq_alloc(nseq->alloc * 2);
278 
279 			if (!sseqs) {
280 				pr_warn("Cannot publish {%u,%u,%u}, no memory\n",
281 					type, lower, upper);
282 				return NULL;
283 			}
284 			memcpy(sseqs, nseq->sseqs,
285 			       nseq->alloc * sizeof(struct sub_seq));
286 			kfree(nseq->sseqs);
287 			nseq->sseqs = sseqs;
288 			nseq->alloc *= 2;
289 		}
290 
291 		info = kzalloc(sizeof(*info), GFP_ATOMIC);
292 		if (!info) {
293 			pr_warn("Cannot publish {%u,%u,%u}, no memory\n",
294 				type, lower, upper);
295 			return NULL;
296 		}
297 
298 		INIT_LIST_HEAD(&info->node_list);
299 		INIT_LIST_HEAD(&info->cluster_list);
300 		INIT_LIST_HEAD(&info->zone_list);
301 
302 		/* Insert new sub-sequence */
303 		sseq = &nseq->sseqs[inspos];
304 		freesseq = &nseq->sseqs[nseq->first_free];
305 		memmove(sseq + 1, sseq, (freesseq - sseq) * sizeof(*sseq));
306 		memset(sseq, 0, sizeof(*sseq));
307 		nseq->first_free++;
308 		sseq->lower = lower;
309 		sseq->upper = upper;
310 		sseq->info = info;
311 		created_subseq = 1;
312 	}
313 
314 	/* Insert a publication */
315 	publ = publ_create(type, lower, upper, scope, node, port, key);
316 	if (!publ)
317 		return NULL;
318 
319 	list_add(&publ->zone_list, &info->zone_list);
320 	info->zone_list_size++;
321 
322 	if (in_own_cluster(net, node)) {
323 		list_add(&publ->cluster_list, &info->cluster_list);
324 		info->cluster_list_size++;
325 	}
326 
327 	if (in_own_node(net, node)) {
328 		list_add(&publ->node_list, &info->node_list);
329 		info->node_list_size++;
330 	}
331 
332 	/* Any subscriptions waiting for notification?  */
333 	list_for_each_entry_safe(s, st, &nseq->subscriptions, nameseq_list) {
334 		tipc_subscrp_report_overlap(s, publ->lower, publ->upper,
335 					    TIPC_PUBLISHED, publ->ref,
336 					    publ->node, created_subseq);
337 	}
338 	return publ;
339 }
340 
341 /**
342  * tipc_nameseq_remove_publ
343  *
344  * NOTE: There may be cases where TIPC is asked to remove a publication
345  * that is not in the name table.  For example, if another node issues a
346  * publication for a name sequence that overlaps an existing name sequence
347  * the publication will not be recorded, which means the publication won't
348  * be found when the name sequence is later withdrawn by that node.
349  * A failed withdraw request simply returns a failure indication and lets the
350  * caller issue any error or warning messages associated with such a problem.
351  */
352 static struct publication *tipc_nameseq_remove_publ(struct net *net,
353 						    struct name_seq *nseq,
354 						    u32 inst, u32 node,
355 						    u32 ref, u32 key)
356 {
357 	struct publication *publ;
358 	struct sub_seq *sseq = nameseq_find_subseq(nseq, inst);
359 	struct name_info *info;
360 	struct sub_seq *free;
361 	struct tipc_subscription *s, *st;
362 	int removed_subseq = 0;
363 
364 	if (!sseq)
365 		return NULL;
366 
367 	info = sseq->info;
368 
369 	/* Locate publication, if it exists */
370 	list_for_each_entry(publ, &info->zone_list, zone_list) {
371 		if ((publ->key == key) && (publ->ref == ref) &&
372 		    (!publ->node || (publ->node == node)))
373 			goto found;
374 	}
375 	return NULL;
376 
377 found:
378 	/* Remove publication from zone scope list */
379 	list_del(&publ->zone_list);
380 	info->zone_list_size--;
381 
382 	/* Remove publication from cluster scope list, if present */
383 	if (in_own_cluster(net, node)) {
384 		list_del(&publ->cluster_list);
385 		info->cluster_list_size--;
386 	}
387 
388 	/* Remove publication from node scope list, if present */
389 	if (in_own_node(net, node)) {
390 		list_del(&publ->node_list);
391 		info->node_list_size--;
392 	}
393 
394 	/* Contract subseq list if no more publications for that subseq */
395 	if (list_empty(&info->zone_list)) {
396 		kfree(info);
397 		free = &nseq->sseqs[nseq->first_free--];
398 		memmove(sseq, sseq + 1, (free - (sseq + 1)) * sizeof(*sseq));
399 		removed_subseq = 1;
400 	}
401 
402 	/* Notify any waiting subscriptions */
403 	list_for_each_entry_safe(s, st, &nseq->subscriptions, nameseq_list) {
404 		tipc_subscrp_report_overlap(s, publ->lower, publ->upper,
405 					    TIPC_WITHDRAWN, publ->ref,
406 					    publ->node, removed_subseq);
407 	}
408 
409 	return publ;
410 }
411 
412 /**
413  * tipc_nameseq_subscribe - attach a subscription, and issue
414  * the prescribed number of events if there is any sub-
415  * sequence overlapping with the requested sequence
416  */
417 static void tipc_nameseq_subscribe(struct name_seq *nseq,
418 				   struct tipc_subscription *s)
419 {
420 	struct sub_seq *sseq = nseq->sseqs;
421 
422 	list_add(&s->nameseq_list, &nseq->subscriptions);
423 
424 	if (!sseq)
425 		return;
426 
427 	while (sseq != &nseq->sseqs[nseq->first_free]) {
428 		if (tipc_subscrp_check_overlap(s, sseq->lower, sseq->upper)) {
429 			struct publication *crs;
430 			struct name_info *info = sseq->info;
431 			int must_report = 1;
432 
433 			list_for_each_entry(crs, &info->zone_list, zone_list) {
434 				tipc_subscrp_report_overlap(s, sseq->lower,
435 							    sseq->upper,
436 							    TIPC_PUBLISHED,
437 							    crs->ref, crs->node,
438 							    must_report);
439 				must_report = 0;
440 			}
441 		}
442 		sseq++;
443 	}
444 }
445 
446 static struct name_seq *nametbl_find_seq(struct net *net, u32 type)
447 {
448 	struct tipc_net *tn = net_generic(net, tipc_net_id);
449 	struct hlist_head *seq_head;
450 	struct name_seq *ns;
451 
452 	seq_head = &tn->nametbl->seq_hlist[hash(type)];
453 	hlist_for_each_entry_rcu(ns, seq_head, ns_list) {
454 		if (ns->type == type)
455 			return ns;
456 	}
457 
458 	return NULL;
459 };
460 
461 struct publication *tipc_nametbl_insert_publ(struct net *net, u32 type,
462 					     u32 lower, u32 upper, u32 scope,
463 					     u32 node, u32 port, u32 key)
464 {
465 	struct tipc_net *tn = net_generic(net, tipc_net_id);
466 	struct publication *publ;
467 	struct name_seq *seq = nametbl_find_seq(net, type);
468 	int index = hash(type);
469 
470 	if ((scope < TIPC_ZONE_SCOPE) || (scope > TIPC_NODE_SCOPE) ||
471 	    (lower > upper)) {
472 		pr_debug("Failed to publish illegal {%u,%u,%u} with scope %u\n",
473 			 type, lower, upper, scope);
474 		return NULL;
475 	}
476 
477 	if (!seq)
478 		seq = tipc_nameseq_create(type, &tn->nametbl->seq_hlist[index]);
479 	if (!seq)
480 		return NULL;
481 
482 	spin_lock_bh(&seq->lock);
483 	publ = tipc_nameseq_insert_publ(net, seq, type, lower, upper,
484 					scope, node, port, key);
485 	spin_unlock_bh(&seq->lock);
486 	return publ;
487 }
488 
489 struct publication *tipc_nametbl_remove_publ(struct net *net, u32 type,
490 					     u32 lower, u32 node, u32 ref,
491 					     u32 key)
492 {
493 	struct publication *publ;
494 	struct name_seq *seq = nametbl_find_seq(net, type);
495 
496 	if (!seq)
497 		return NULL;
498 
499 	spin_lock_bh(&seq->lock);
500 	publ = tipc_nameseq_remove_publ(net, seq, lower, node, ref, key);
501 	if (!seq->first_free && list_empty(&seq->subscriptions)) {
502 		hlist_del_init_rcu(&seq->ns_list);
503 		kfree(seq->sseqs);
504 		spin_unlock_bh(&seq->lock);
505 		kfree_rcu(seq, rcu);
506 		return publ;
507 	}
508 	spin_unlock_bh(&seq->lock);
509 	return publ;
510 }
511 
512 /**
513  * tipc_nametbl_translate - perform name translation
514  *
515  * On entry, 'destnode' is the search domain used during translation.
516  *
517  * On exit:
518  * - if name translation is deferred to another node/cluster/zone,
519  *   leaves 'destnode' unchanged (will be non-zero) and returns 0
520  * - if name translation is attempted and succeeds, sets 'destnode'
521  *   to publishing node and returns port reference (will be non-zero)
522  * - if name translation is attempted and fails, sets 'destnode' to 0
523  *   and returns 0
524  */
525 u32 tipc_nametbl_translate(struct net *net, u32 type, u32 instance,
526 			   u32 *destnode)
527 {
528 	struct tipc_net *tn = net_generic(net, tipc_net_id);
529 	struct sub_seq *sseq;
530 	struct name_info *info;
531 	struct publication *publ;
532 	struct name_seq *seq;
533 	u32 ref = 0;
534 	u32 node = 0;
535 
536 	if (!tipc_in_scope(*destnode, tn->own_addr))
537 		return 0;
538 
539 	rcu_read_lock();
540 	seq = nametbl_find_seq(net, type);
541 	if (unlikely(!seq))
542 		goto not_found;
543 	spin_lock_bh(&seq->lock);
544 	sseq = nameseq_find_subseq(seq, instance);
545 	if (unlikely(!sseq))
546 		goto no_match;
547 	info = sseq->info;
548 
549 	/* Closest-First Algorithm */
550 	if (likely(!*destnode)) {
551 		if (!list_empty(&info->node_list)) {
552 			publ = list_first_entry(&info->node_list,
553 						struct publication,
554 						node_list);
555 			list_move_tail(&publ->node_list,
556 				       &info->node_list);
557 		} else if (!list_empty(&info->cluster_list)) {
558 			publ = list_first_entry(&info->cluster_list,
559 						struct publication,
560 						cluster_list);
561 			list_move_tail(&publ->cluster_list,
562 				       &info->cluster_list);
563 		} else {
564 			publ = list_first_entry(&info->zone_list,
565 						struct publication,
566 						zone_list);
567 			list_move_tail(&publ->zone_list,
568 				       &info->zone_list);
569 		}
570 	}
571 
572 	/* Round-Robin Algorithm */
573 	else if (*destnode == tn->own_addr) {
574 		if (list_empty(&info->node_list))
575 			goto no_match;
576 		publ = list_first_entry(&info->node_list, struct publication,
577 					node_list);
578 		list_move_tail(&publ->node_list, &info->node_list);
579 	} else if (in_own_cluster_exact(net, *destnode)) {
580 		if (list_empty(&info->cluster_list))
581 			goto no_match;
582 		publ = list_first_entry(&info->cluster_list, struct publication,
583 					cluster_list);
584 		list_move_tail(&publ->cluster_list, &info->cluster_list);
585 	} else {
586 		publ = list_first_entry(&info->zone_list, struct publication,
587 					zone_list);
588 		list_move_tail(&publ->zone_list, &info->zone_list);
589 	}
590 
591 	ref = publ->ref;
592 	node = publ->node;
593 no_match:
594 	spin_unlock_bh(&seq->lock);
595 not_found:
596 	rcu_read_unlock();
597 	*destnode = node;
598 	return ref;
599 }
600 
601 /**
602  * tipc_nametbl_mc_translate - find multicast destinations
603  *
604  * Creates list of all local ports that overlap the given multicast address;
605  * also determines if any off-node ports overlap.
606  *
607  * Note: Publications with a scope narrower than 'limit' are ignored.
608  * (i.e. local node-scope publications mustn't receive messages arriving
609  * from another node, even if the multcast link brought it here)
610  *
611  * Returns non-zero if any off-node ports overlap
612  */
613 int tipc_nametbl_mc_translate(struct net *net, u32 type, u32 lower, u32 upper,
614 			      u32 limit, struct tipc_plist *dports)
615 {
616 	struct name_seq *seq;
617 	struct sub_seq *sseq;
618 	struct sub_seq *sseq_stop;
619 	struct name_info *info;
620 	int res = 0;
621 
622 	rcu_read_lock();
623 	seq = nametbl_find_seq(net, type);
624 	if (!seq)
625 		goto exit;
626 
627 	spin_lock_bh(&seq->lock);
628 	sseq = seq->sseqs + nameseq_locate_subseq(seq, lower);
629 	sseq_stop = seq->sseqs + seq->first_free;
630 	for (; sseq != sseq_stop; sseq++) {
631 		struct publication *publ;
632 
633 		if (sseq->lower > upper)
634 			break;
635 
636 		info = sseq->info;
637 		list_for_each_entry(publ, &info->node_list, node_list) {
638 			if (publ->scope <= limit)
639 				tipc_plist_push(dports, publ->ref);
640 		}
641 
642 		if (info->cluster_list_size != info->node_list_size)
643 			res = 1;
644 	}
645 	spin_unlock_bh(&seq->lock);
646 exit:
647 	rcu_read_unlock();
648 	return res;
649 }
650 
651 /*
652  * tipc_nametbl_publish - add name publication to network name tables
653  */
654 struct publication *tipc_nametbl_publish(struct net *net, u32 type, u32 lower,
655 					 u32 upper, u32 scope, u32 port_ref,
656 					 u32 key)
657 {
658 	struct publication *publ;
659 	struct sk_buff *buf = NULL;
660 	struct tipc_net *tn = net_generic(net, tipc_net_id);
661 
662 	spin_lock_bh(&tn->nametbl_lock);
663 	if (tn->nametbl->local_publ_count >= TIPC_MAX_PUBLICATIONS) {
664 		pr_warn("Publication failed, local publication limit reached (%u)\n",
665 			TIPC_MAX_PUBLICATIONS);
666 		spin_unlock_bh(&tn->nametbl_lock);
667 		return NULL;
668 	}
669 
670 	publ = tipc_nametbl_insert_publ(net, type, lower, upper, scope,
671 					tn->own_addr, port_ref, key);
672 	if (likely(publ)) {
673 		tn->nametbl->local_publ_count++;
674 		buf = tipc_named_publish(net, publ);
675 		/* Any pending external events? */
676 		tipc_named_process_backlog(net);
677 	}
678 	spin_unlock_bh(&tn->nametbl_lock);
679 
680 	if (buf)
681 		tipc_node_broadcast(net, buf);
682 	return publ;
683 }
684 
685 /**
686  * tipc_nametbl_withdraw - withdraw name publication from network name tables
687  */
688 int tipc_nametbl_withdraw(struct net *net, u32 type, u32 lower, u32 ref,
689 			  u32 key)
690 {
691 	struct publication *publ;
692 	struct sk_buff *skb = NULL;
693 	struct tipc_net *tn = net_generic(net, tipc_net_id);
694 
695 	spin_lock_bh(&tn->nametbl_lock);
696 	publ = tipc_nametbl_remove_publ(net, type, lower, tn->own_addr,
697 					ref, key);
698 	if (likely(publ)) {
699 		tn->nametbl->local_publ_count--;
700 		skb = tipc_named_withdraw(net, publ);
701 		/* Any pending external events? */
702 		tipc_named_process_backlog(net);
703 		list_del_init(&publ->pport_list);
704 		kfree_rcu(publ, rcu);
705 	} else {
706 		pr_err("Unable to remove local publication\n"
707 		       "(type=%u, lower=%u, ref=%u, key=%u)\n",
708 		       type, lower, ref, key);
709 	}
710 	spin_unlock_bh(&tn->nametbl_lock);
711 
712 	if (skb) {
713 		tipc_node_broadcast(net, skb);
714 		return 1;
715 	}
716 	return 0;
717 }
718 
719 /**
720  * tipc_nametbl_subscribe - add a subscription object to the name table
721  */
722 void tipc_nametbl_subscribe(struct tipc_subscription *s)
723 {
724 	struct tipc_net *tn = net_generic(s->net, tipc_net_id);
725 	u32 type = s->seq.type;
726 	int index = hash(type);
727 	struct name_seq *seq;
728 
729 	spin_lock_bh(&tn->nametbl_lock);
730 	seq = nametbl_find_seq(s->net, type);
731 	if (!seq)
732 		seq = tipc_nameseq_create(type, &tn->nametbl->seq_hlist[index]);
733 	if (seq) {
734 		spin_lock_bh(&seq->lock);
735 		tipc_nameseq_subscribe(seq, s);
736 		spin_unlock_bh(&seq->lock);
737 	} else {
738 		pr_warn("Failed to create subscription for {%u,%u,%u}\n",
739 			s->seq.type, s->seq.lower, s->seq.upper);
740 	}
741 	spin_unlock_bh(&tn->nametbl_lock);
742 }
743 
744 /**
745  * tipc_nametbl_unsubscribe - remove a subscription object from name table
746  */
747 void tipc_nametbl_unsubscribe(struct tipc_subscription *s)
748 {
749 	struct tipc_net *tn = net_generic(s->net, tipc_net_id);
750 	struct name_seq *seq;
751 
752 	spin_lock_bh(&tn->nametbl_lock);
753 	seq = nametbl_find_seq(s->net, s->seq.type);
754 	if (seq != NULL) {
755 		spin_lock_bh(&seq->lock);
756 		list_del_init(&s->nameseq_list);
757 		if (!seq->first_free && list_empty(&seq->subscriptions)) {
758 			hlist_del_init_rcu(&seq->ns_list);
759 			kfree(seq->sseqs);
760 			spin_unlock_bh(&seq->lock);
761 			kfree_rcu(seq, rcu);
762 		} else {
763 			spin_unlock_bh(&seq->lock);
764 		}
765 	}
766 	spin_unlock_bh(&tn->nametbl_lock);
767 }
768 
769 int tipc_nametbl_init(struct net *net)
770 {
771 	struct tipc_net *tn = net_generic(net, tipc_net_id);
772 	struct name_table *tipc_nametbl;
773 	int i;
774 
775 	tipc_nametbl = kzalloc(sizeof(*tipc_nametbl), GFP_ATOMIC);
776 	if (!tipc_nametbl)
777 		return -ENOMEM;
778 
779 	for (i = 0; i < TIPC_NAMETBL_SIZE; i++)
780 		INIT_HLIST_HEAD(&tipc_nametbl->seq_hlist[i]);
781 
782 	INIT_LIST_HEAD(&tipc_nametbl->publ_list[TIPC_ZONE_SCOPE]);
783 	INIT_LIST_HEAD(&tipc_nametbl->publ_list[TIPC_CLUSTER_SCOPE]);
784 	INIT_LIST_HEAD(&tipc_nametbl->publ_list[TIPC_NODE_SCOPE]);
785 	tn->nametbl = tipc_nametbl;
786 	spin_lock_init(&tn->nametbl_lock);
787 	return 0;
788 }
789 
790 /**
791  * tipc_purge_publications - remove all publications for a given type
792  *
793  * tipc_nametbl_lock must be held when calling this function
794  */
795 static void tipc_purge_publications(struct net *net, struct name_seq *seq)
796 {
797 	struct publication *publ, *safe;
798 	struct sub_seq *sseq;
799 	struct name_info *info;
800 
801 	spin_lock_bh(&seq->lock);
802 	sseq = seq->sseqs;
803 	info = sseq->info;
804 	list_for_each_entry_safe(publ, safe, &info->zone_list, zone_list) {
805 		tipc_nameseq_remove_publ(net, seq, publ->lower, publ->node,
806 					 publ->ref, publ->key);
807 		kfree_rcu(publ, rcu);
808 	}
809 	hlist_del_init_rcu(&seq->ns_list);
810 	kfree(seq->sseqs);
811 	spin_unlock_bh(&seq->lock);
812 
813 	kfree_rcu(seq, rcu);
814 }
815 
816 void tipc_nametbl_stop(struct net *net)
817 {
818 	u32 i;
819 	struct name_seq *seq;
820 	struct hlist_head *seq_head;
821 	struct tipc_net *tn = net_generic(net, tipc_net_id);
822 	struct name_table *tipc_nametbl = tn->nametbl;
823 
824 	/* Verify name table is empty and purge any lingering
825 	 * publications, then release the name table
826 	 */
827 	spin_lock_bh(&tn->nametbl_lock);
828 	for (i = 0; i < TIPC_NAMETBL_SIZE; i++) {
829 		if (hlist_empty(&tipc_nametbl->seq_hlist[i]))
830 			continue;
831 		seq_head = &tipc_nametbl->seq_hlist[i];
832 		hlist_for_each_entry_rcu(seq, seq_head, ns_list) {
833 			tipc_purge_publications(net, seq);
834 		}
835 	}
836 	spin_unlock_bh(&tn->nametbl_lock);
837 
838 	synchronize_net();
839 	kfree(tipc_nametbl);
840 
841 }
842 
843 static int __tipc_nl_add_nametable_publ(struct tipc_nl_msg *msg,
844 					struct name_seq *seq,
845 					struct sub_seq *sseq, u32 *last_publ)
846 {
847 	void *hdr;
848 	struct nlattr *attrs;
849 	struct nlattr *publ;
850 	struct publication *p;
851 
852 	if (*last_publ) {
853 		list_for_each_entry(p, &sseq->info->zone_list, zone_list)
854 			if (p->key == *last_publ)
855 				break;
856 		if (p->key != *last_publ)
857 			return -EPIPE;
858 	} else {
859 		p = list_first_entry(&sseq->info->zone_list, struct publication,
860 				     zone_list);
861 	}
862 
863 	list_for_each_entry_from(p, &sseq->info->zone_list, zone_list) {
864 		*last_publ = p->key;
865 
866 		hdr = genlmsg_put(msg->skb, msg->portid, msg->seq,
867 				  &tipc_genl_family, NLM_F_MULTI,
868 				  TIPC_NL_NAME_TABLE_GET);
869 		if (!hdr)
870 			return -EMSGSIZE;
871 
872 		attrs = nla_nest_start(msg->skb, TIPC_NLA_NAME_TABLE);
873 		if (!attrs)
874 			goto msg_full;
875 
876 		publ = nla_nest_start(msg->skb, TIPC_NLA_NAME_TABLE_PUBL);
877 		if (!publ)
878 			goto attr_msg_full;
879 
880 		if (nla_put_u32(msg->skb, TIPC_NLA_PUBL_TYPE, seq->type))
881 			goto publ_msg_full;
882 		if (nla_put_u32(msg->skb, TIPC_NLA_PUBL_LOWER, sseq->lower))
883 			goto publ_msg_full;
884 		if (nla_put_u32(msg->skb, TIPC_NLA_PUBL_UPPER, sseq->upper))
885 			goto publ_msg_full;
886 		if (nla_put_u32(msg->skb, TIPC_NLA_PUBL_SCOPE, p->scope))
887 			goto publ_msg_full;
888 		if (nla_put_u32(msg->skb, TIPC_NLA_PUBL_NODE, p->node))
889 			goto publ_msg_full;
890 		if (nla_put_u32(msg->skb, TIPC_NLA_PUBL_REF, p->ref))
891 			goto publ_msg_full;
892 		if (nla_put_u32(msg->skb, TIPC_NLA_PUBL_KEY, p->key))
893 			goto publ_msg_full;
894 
895 		nla_nest_end(msg->skb, publ);
896 		nla_nest_end(msg->skb, attrs);
897 		genlmsg_end(msg->skb, hdr);
898 	}
899 	*last_publ = 0;
900 
901 	return 0;
902 
903 publ_msg_full:
904 	nla_nest_cancel(msg->skb, publ);
905 attr_msg_full:
906 	nla_nest_cancel(msg->skb, attrs);
907 msg_full:
908 	genlmsg_cancel(msg->skb, hdr);
909 
910 	return -EMSGSIZE;
911 }
912 
913 static int __tipc_nl_subseq_list(struct tipc_nl_msg *msg, struct name_seq *seq,
914 				 u32 *last_lower, u32 *last_publ)
915 {
916 	struct sub_seq *sseq;
917 	struct sub_seq *sseq_start;
918 	int err;
919 
920 	if (*last_lower) {
921 		sseq_start = nameseq_find_subseq(seq, *last_lower);
922 		if (!sseq_start)
923 			return -EPIPE;
924 	} else {
925 		sseq_start = seq->sseqs;
926 	}
927 
928 	for (sseq = sseq_start; sseq != &seq->sseqs[seq->first_free]; sseq++) {
929 		err = __tipc_nl_add_nametable_publ(msg, seq, sseq, last_publ);
930 		if (err) {
931 			*last_lower = sseq->lower;
932 			return err;
933 		}
934 	}
935 	*last_lower = 0;
936 
937 	return 0;
938 }
939 
940 static int tipc_nl_seq_list(struct net *net, struct tipc_nl_msg *msg,
941 			    u32 *last_type, u32 *last_lower, u32 *last_publ)
942 {
943 	struct tipc_net *tn = net_generic(net, tipc_net_id);
944 	struct hlist_head *seq_head;
945 	struct name_seq *seq = NULL;
946 	int err;
947 	int i;
948 
949 	if (*last_type)
950 		i = hash(*last_type);
951 	else
952 		i = 0;
953 
954 	for (; i < TIPC_NAMETBL_SIZE; i++) {
955 		seq_head = &tn->nametbl->seq_hlist[i];
956 
957 		if (*last_type) {
958 			seq = nametbl_find_seq(net, *last_type);
959 			if (!seq)
960 				return -EPIPE;
961 		} else {
962 			hlist_for_each_entry_rcu(seq, seq_head, ns_list)
963 				break;
964 			if (!seq)
965 				continue;
966 		}
967 
968 		hlist_for_each_entry_from_rcu(seq, ns_list) {
969 			spin_lock_bh(&seq->lock);
970 			err = __tipc_nl_subseq_list(msg, seq, last_lower,
971 						    last_publ);
972 
973 			if (err) {
974 				*last_type = seq->type;
975 				spin_unlock_bh(&seq->lock);
976 				return err;
977 			}
978 			spin_unlock_bh(&seq->lock);
979 		}
980 		*last_type = 0;
981 	}
982 	return 0;
983 }
984 
985 int tipc_nl_name_table_dump(struct sk_buff *skb, struct netlink_callback *cb)
986 {
987 	int err;
988 	int done = cb->args[3];
989 	u32 last_type = cb->args[0];
990 	u32 last_lower = cb->args[1];
991 	u32 last_publ = cb->args[2];
992 	struct net *net = sock_net(skb->sk);
993 	struct tipc_nl_msg msg;
994 
995 	if (done)
996 		return 0;
997 
998 	msg.skb = skb;
999 	msg.portid = NETLINK_CB(cb->skb).portid;
1000 	msg.seq = cb->nlh->nlmsg_seq;
1001 
1002 	rcu_read_lock();
1003 	err = tipc_nl_seq_list(net, &msg, &last_type, &last_lower, &last_publ);
1004 	if (!err) {
1005 		done = 1;
1006 	} else if (err != -EMSGSIZE) {
1007 		/* We never set seq or call nl_dump_check_consistent() this
1008 		 * means that setting prev_seq here will cause the consistence
1009 		 * check to fail in the netlink callback handler. Resulting in
1010 		 * the NLMSG_DONE message having the NLM_F_DUMP_INTR flag set if
1011 		 * we got an error.
1012 		 */
1013 		cb->prev_seq = 1;
1014 	}
1015 	rcu_read_unlock();
1016 
1017 	cb->args[0] = last_type;
1018 	cb->args[1] = last_lower;
1019 	cb->args[2] = last_publ;
1020 	cb->args[3] = done;
1021 
1022 	return skb->len;
1023 }
1024 
1025 void tipc_plist_push(struct tipc_plist *pl, u32 port)
1026 {
1027 	struct tipc_plist *nl;
1028 
1029 	if (likely(!pl->port)) {
1030 		pl->port = port;
1031 		return;
1032 	}
1033 	if (pl->port == port)
1034 		return;
1035 	list_for_each_entry(nl, &pl->list, list) {
1036 		if (nl->port == port)
1037 			return;
1038 	}
1039 	nl = kmalloc(sizeof(*nl), GFP_ATOMIC);
1040 	if (nl) {
1041 		nl->port = port;
1042 		list_add(&nl->list, &pl->list);
1043 	}
1044 }
1045 
1046 u32 tipc_plist_pop(struct tipc_plist *pl)
1047 {
1048 	struct tipc_plist *nl;
1049 	u32 port = 0;
1050 
1051 	if (likely(list_empty(&pl->list))) {
1052 		port = pl->port;
1053 		pl->port = 0;
1054 		return port;
1055 	}
1056 	nl = list_first_entry(&pl->list, typeof(*nl), list);
1057 	port = nl->port;
1058 	list_del(&nl->list);
1059 	kfree(nl);
1060 	return port;
1061 }
1062