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