ipv6: Remove unnecessary test
[cascardo/linux.git] / net / tipc / name_table.c
1 /*
2  * net/tipc/name_table.c: TIPC name table code
3  *
4  * Copyright (c) 2000-2006, 2014, 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
43 #define TIPC_NAMETBL_SIZE 1024          /* must be a power of 2 */
44
45 static const struct nla_policy
46 tipc_nl_name_table_policy[TIPC_NLA_NAME_TABLE_MAX + 1] = {
47         [TIPC_NLA_NAME_TABLE_UNSPEC]    = { .type = NLA_UNSPEC },
48         [TIPC_NLA_NAME_TABLE_PUBL]      = { .type = NLA_NESTED }
49 };
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  */
96 struct 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 };
105
106 /**
107  * struct name_table - table containing all existing port name publications
108  * @types: pointer to fixed-sized array of name sequence lists,
109  *         accessed via hashing on 'type'; name sequence lists are *not* sorted
110  * @local_publ_count: number of publications issued by this node
111  */
112 struct name_table {
113         struct hlist_head *types;
114         u32 local_publ_count;
115 };
116
117 static struct name_table table;
118 DEFINE_RWLOCK(tipc_nametbl_lock);
119
120 static int hash(int x)
121 {
122         return x & (TIPC_NAMETBL_SIZE - 1);
123 }
124
125 /**
126  * publ_create - create a publication structure
127  */
128 static struct publication *publ_create(u32 type, u32 lower, u32 upper,
129                                        u32 scope, u32 node, u32 port_ref,
130                                        u32 key)
131 {
132         struct publication *publ = kzalloc(sizeof(*publ), GFP_ATOMIC);
133         if (publ == NULL) {
134                 pr_warn("Publication creation failure, no memory\n");
135                 return NULL;
136         }
137
138         publ->type = type;
139         publ->lower = lower;
140         publ->upper = upper;
141         publ->scope = scope;
142         publ->node = node;
143         publ->ref = port_ref;
144         publ->key = key;
145         INIT_LIST_HEAD(&publ->local_list);
146         INIT_LIST_HEAD(&publ->pport_list);
147         INIT_LIST_HEAD(&publ->subscr.nodesub_list);
148         return publ;
149 }
150
151 /**
152  * tipc_subseq_alloc - allocate a specified number of sub-sequence structures
153  */
154 static struct sub_seq *tipc_subseq_alloc(u32 cnt)
155 {
156         return kcalloc(cnt, sizeof(struct sub_seq), GFP_ATOMIC);
157 }
158
159 /**
160  * tipc_nameseq_create - create a name sequence structure for the specified 'type'
161  *
162  * Allocates a single sub-sequence structure and sets it to all 0's.
163  */
164 static struct name_seq *tipc_nameseq_create(u32 type, struct hlist_head *seq_head)
165 {
166         struct name_seq *nseq = kzalloc(sizeof(*nseq), GFP_ATOMIC);
167         struct sub_seq *sseq = tipc_subseq_alloc(1);
168
169         if (!nseq || !sseq) {
170                 pr_warn("Name sequence creation failed, no memory\n");
171                 kfree(nseq);
172                 kfree(sseq);
173                 return NULL;
174         }
175
176         spin_lock_init(&nseq->lock);
177         nseq->type = type;
178         nseq->sseqs = sseq;
179         nseq->alloc = 1;
180         INIT_HLIST_NODE(&nseq->ns_list);
181         INIT_LIST_HEAD(&nseq->subscriptions);
182         hlist_add_head(&nseq->ns_list, seq_head);
183         return nseq;
184 }
185
186 /*
187  * nameseq_delete_empty - deletes a name sequence structure if now unused
188  */
189 static void nameseq_delete_empty(struct name_seq *seq)
190 {
191         if (!seq->first_free && list_empty(&seq->subscriptions)) {
192                 hlist_del_init(&seq->ns_list);
193                 kfree(seq->sseqs);
194                 kfree(seq);
195         }
196 }
197
198 /**
199  * nameseq_find_subseq - find sub-sequence (if any) matching a name instance
200  *
201  * Very time-critical, so binary searches through sub-sequence array.
202  */
203 static struct sub_seq *nameseq_find_subseq(struct name_seq *nseq,
204                                            u32 instance)
205 {
206         struct sub_seq *sseqs = nseq->sseqs;
207         int low = 0;
208         int high = nseq->first_free - 1;
209         int mid;
210
211         while (low <= high) {
212                 mid = (low + high) / 2;
213                 if (instance < sseqs[mid].lower)
214                         high = mid - 1;
215                 else if (instance > sseqs[mid].upper)
216                         low = mid + 1;
217                 else
218                         return &sseqs[mid];
219         }
220         return NULL;
221 }
222
223 /**
224  * nameseq_locate_subseq - determine position of name instance in sub-sequence
225  *
226  * Returns index in sub-sequence array of the entry that contains the specified
227  * instance value; if no entry contains that value, returns the position
228  * where a new entry for it would be inserted in the array.
229  *
230  * Note: Similar to binary search code for locating a sub-sequence.
231  */
232 static u32 nameseq_locate_subseq(struct name_seq *nseq, u32 instance)
233 {
234         struct sub_seq *sseqs = nseq->sseqs;
235         int low = 0;
236         int high = nseq->first_free - 1;
237         int mid;
238
239         while (low <= high) {
240                 mid = (low + high) / 2;
241                 if (instance < sseqs[mid].lower)
242                         high = mid - 1;
243                 else if (instance > sseqs[mid].upper)
244                         low = mid + 1;
245                 else
246                         return mid;
247         }
248         return low;
249 }
250
251 /**
252  * tipc_nameseq_insert_publ
253  */
254 static struct publication *tipc_nameseq_insert_publ(struct name_seq *nseq,
255                                                     u32 type, u32 lower, u32 upper,
256                                                     u32 scope, u32 node, u32 port, u32 key)
257 {
258         struct tipc_subscription *s;
259         struct tipc_subscription *st;
260         struct publication *publ;
261         struct sub_seq *sseq;
262         struct name_info *info;
263         int created_subseq = 0;
264
265         sseq = nameseq_find_subseq(nseq, lower);
266         if (sseq) {
267
268                 /* Lower end overlaps existing entry => need an exact match */
269                 if ((sseq->lower != lower) || (sseq->upper != upper)) {
270                         return NULL;
271                 }
272
273                 info = sseq->info;
274
275                 /* Check if an identical publication already exists */
276                 list_for_each_entry(publ, &info->zone_list, zone_list) {
277                         if ((publ->ref == port) && (publ->key == key) &&
278                             (!publ->node || (publ->node == node)))
279                                 return NULL;
280                 }
281         } else {
282                 u32 inspos;
283                 struct sub_seq *freesseq;
284
285                 /* Find where lower end should be inserted */
286                 inspos = nameseq_locate_subseq(nseq, lower);
287
288                 /* Fail if upper end overlaps into an existing entry */
289                 if ((inspos < nseq->first_free) &&
290                     (upper >= nseq->sseqs[inspos].lower)) {
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                                 pr_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                         pr_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  */
375 static 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
398 found:
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  */
442 static 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
473 static struct name_seq *nametbl_find_seq(u32 type)
474 {
475         struct hlist_head *seq_head;
476         struct name_seq *ns;
477
478         seq_head = &table.types[hash(type)];
479         hlist_for_each_entry(ns, seq_head, ns_list) {
480                 if (ns->type == type)
481                         return ns;
482         }
483
484         return NULL;
485 };
486
487 struct publication *tipc_nametbl_insert_publ(u32 type, u32 lower, u32 upper,
488                                              u32 scope, u32 node, u32 port, u32 key)
489 {
490         struct name_seq *seq = nametbl_find_seq(type);
491
492         if ((scope < TIPC_ZONE_SCOPE) || (scope > TIPC_NODE_SCOPE) ||
493             (lower > upper)) {
494                 pr_debug("Failed to publish illegal {%u,%u,%u} with scope %u\n",
495                          type, lower, upper, scope);
496                 return NULL;
497         }
498
499         if (!seq)
500                 seq = tipc_nameseq_create(type, &table.types[hash(type)]);
501         if (!seq)
502                 return NULL;
503
504         return tipc_nameseq_insert_publ(seq, type, lower, upper,
505                                         scope, node, port, key);
506 }
507
508 struct publication *tipc_nametbl_remove_publ(u32 type, u32 lower,
509                                              u32 node, u32 ref, u32 key)
510 {
511         struct publication *publ;
512         struct name_seq *seq = nametbl_find_seq(type);
513
514         if (!seq)
515                 return NULL;
516
517         publ = tipc_nameseq_remove_publ(seq, lower, node, ref, key);
518         nameseq_delete_empty(seq);
519         return publ;
520 }
521
522 /**
523  * tipc_nametbl_translate - perform name translation
524  *
525  * On entry, 'destnode' is the search domain used during translation.
526  *
527  * On exit:
528  * - if name translation is deferred to another node/cluster/zone,
529  *   leaves 'destnode' unchanged (will be non-zero) and returns 0
530  * - if name translation is attempted and succeeds, sets 'destnode'
531  *   to publishing node and returns port reference (will be non-zero)
532  * - if name translation is attempted and fails, sets 'destnode' to 0
533  *   and returns 0
534  */
535 u32 tipc_nametbl_translate(u32 type, u32 instance, u32 *destnode)
536 {
537         struct sub_seq *sseq;
538         struct name_info *info;
539         struct publication *publ;
540         struct name_seq *seq;
541         u32 ref = 0;
542         u32 node = 0;
543
544         if (!tipc_in_scope(*destnode, tipc_own_addr))
545                 return 0;
546
547         read_lock_bh(&tipc_nametbl_lock);
548         seq = nametbl_find_seq(type);
549         if (unlikely(!seq))
550                 goto not_found;
551         sseq = nameseq_find_subseq(seq, instance);
552         if (unlikely(!sseq))
553                 goto not_found;
554         spin_lock_bh(&seq->lock);
555         info = sseq->info;
556
557         /* Closest-First Algorithm */
558         if (likely(!*destnode)) {
559                 if (!list_empty(&info->node_list)) {
560                         publ = list_first_entry(&info->node_list,
561                                                 struct publication,
562                                                 node_list);
563                         list_move_tail(&publ->node_list,
564                                        &info->node_list);
565                 } else if (!list_empty(&info->cluster_list)) {
566                         publ = list_first_entry(&info->cluster_list,
567                                                 struct publication,
568                                                 cluster_list);
569                         list_move_tail(&publ->cluster_list,
570                                        &info->cluster_list);
571                 } else {
572                         publ = list_first_entry(&info->zone_list,
573                                                 struct publication,
574                                                 zone_list);
575                         list_move_tail(&publ->zone_list,
576                                        &info->zone_list);
577                 }
578         }
579
580         /* Round-Robin Algorithm */
581         else if (*destnode == tipc_own_addr) {
582                 if (list_empty(&info->node_list))
583                         goto no_match;
584                 publ = list_first_entry(&info->node_list, struct publication,
585                                         node_list);
586                 list_move_tail(&publ->node_list, &info->node_list);
587         } else if (in_own_cluster_exact(*destnode)) {
588                 if (list_empty(&info->cluster_list))
589                         goto no_match;
590                 publ = list_first_entry(&info->cluster_list, struct publication,
591                                         cluster_list);
592                 list_move_tail(&publ->cluster_list, &info->cluster_list);
593         } else {
594                 publ = list_first_entry(&info->zone_list, struct publication,
595                                         zone_list);
596                 list_move_tail(&publ->zone_list, &info->zone_list);
597         }
598
599         ref = publ->ref;
600         node = publ->node;
601 no_match:
602         spin_unlock_bh(&seq->lock);
603 not_found:
604         read_unlock_bh(&tipc_nametbl_lock);
605         *destnode = node;
606         return ref;
607 }
608
609 /**
610  * tipc_nametbl_mc_translate - find multicast destinations
611  *
612  * Creates list of all local ports that overlap the given multicast address;
613  * also determines if any off-node ports overlap.
614  *
615  * Note: Publications with a scope narrower than 'limit' are ignored.
616  * (i.e. local node-scope publications mustn't receive messages arriving
617  * from another node, even if the multcast link brought it here)
618  *
619  * Returns non-zero if any off-node ports overlap
620  */
621 int tipc_nametbl_mc_translate(u32 type, u32 lower, u32 upper, u32 limit,
622                               struct tipc_port_list *dports)
623 {
624         struct name_seq *seq;
625         struct sub_seq *sseq;
626         struct sub_seq *sseq_stop;
627         struct name_info *info;
628         int res = 0;
629
630         read_lock_bh(&tipc_nametbl_lock);
631         seq = nametbl_find_seq(type);
632         if (!seq)
633                 goto exit;
634
635         spin_lock_bh(&seq->lock);
636
637         sseq = seq->sseqs + nameseq_locate_subseq(seq, lower);
638         sseq_stop = seq->sseqs + seq->first_free;
639         for (; sseq != sseq_stop; sseq++) {
640                 struct publication *publ;
641
642                 if (sseq->lower > upper)
643                         break;
644
645                 info = sseq->info;
646                 list_for_each_entry(publ, &info->node_list, node_list) {
647                         if (publ->scope <= limit)
648                                 tipc_port_list_add(dports, publ->ref);
649                 }
650
651                 if (info->cluster_list_size != info->node_list_size)
652                         res = 1;
653         }
654
655         spin_unlock_bh(&seq->lock);
656 exit:
657         read_unlock_bh(&tipc_nametbl_lock);
658         return res;
659 }
660
661 /*
662  * tipc_nametbl_publish - add name publication to network name tables
663  */
664 struct publication *tipc_nametbl_publish(u32 type, u32 lower, u32 upper,
665                                          u32 scope, u32 port_ref, u32 key)
666 {
667         struct publication *publ;
668         struct sk_buff *buf = NULL;
669
670         if (table.local_publ_count >= TIPC_MAX_PUBLICATIONS) {
671                 pr_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                 buf = tipc_named_publish(publ);
682                 /* Any pending external events? */
683                 tipc_named_process_backlog();
684         }
685         write_unlock_bh(&tipc_nametbl_lock);
686
687         if (buf)
688                 named_cluster_distribute(buf);
689         return publ;
690 }
691
692 /**
693  * tipc_nametbl_withdraw - withdraw name publication from network name tables
694  */
695 int tipc_nametbl_withdraw(u32 type, u32 lower, u32 ref, u32 key)
696 {
697         struct publication *publ;
698         struct sk_buff *buf;
699
700         write_lock_bh(&tipc_nametbl_lock);
701         publ = tipc_nametbl_remove_publ(type, lower, tipc_own_addr, ref, key);
702         if (likely(publ)) {
703                 table.local_publ_count--;
704                 buf = tipc_named_withdraw(publ);
705                 /* Any pending external events? */
706                 tipc_named_process_backlog();
707                 write_unlock_bh(&tipc_nametbl_lock);
708                 list_del_init(&publ->pport_list);
709                 kfree(publ);
710
711                 if (buf)
712                         named_cluster_distribute(buf);
713                 return 1;
714         }
715         write_unlock_bh(&tipc_nametbl_lock);
716         pr_err("Unable to remove local publication\n"
717                "(type=%u, lower=%u, ref=%u, key=%u)\n",
718                type, lower, ref, key);
719         return 0;
720 }
721
722 /**
723  * tipc_nametbl_subscribe - add a subscription object to the name table
724  */
725 void tipc_nametbl_subscribe(struct tipc_subscription *s)
726 {
727         u32 type = s->seq.type;
728         struct name_seq *seq;
729
730         write_lock_bh(&tipc_nametbl_lock);
731         seq = nametbl_find_seq(type);
732         if (!seq)
733                 seq = tipc_nameseq_create(type, &table.types[hash(type)]);
734         if (seq) {
735                 spin_lock_bh(&seq->lock);
736                 tipc_nameseq_subscribe(seq, s);
737                 spin_unlock_bh(&seq->lock);
738         } else {
739                 pr_warn("Failed to create subscription for {%u,%u,%u}\n",
740                         s->seq.type, s->seq.lower, s->seq.upper);
741         }
742         write_unlock_bh(&tipc_nametbl_lock);
743 }
744
745 /**
746  * tipc_nametbl_unsubscribe - remove a subscription object from name table
747  */
748 void tipc_nametbl_unsubscribe(struct tipc_subscription *s)
749 {
750         struct name_seq *seq;
751
752         write_lock_bh(&tipc_nametbl_lock);
753         seq = nametbl_find_seq(s->seq.type);
754         if (seq != NULL) {
755                 spin_lock_bh(&seq->lock);
756                 list_del_init(&s->nameseq_list);
757                 spin_unlock_bh(&seq->lock);
758                 nameseq_delete_empty(seq);
759         }
760         write_unlock_bh(&tipc_nametbl_lock);
761 }
762
763
764 /**
765  * subseq_list - print specified sub-sequence contents into the given buffer
766  */
767 static int subseq_list(struct sub_seq *sseq, char *buf, int len, u32 depth,
768                        u32 index)
769 {
770         char portIdStr[27];
771         const char *scope_str[] = {"", " zone", " cluster", " node"};
772         struct publication *publ;
773         struct name_info *info;
774         int ret;
775
776         ret = tipc_snprintf(buf, len, "%-10u %-10u ", sseq->lower, sseq->upper);
777
778         if (depth == 2) {
779                 ret += tipc_snprintf(buf - ret, len + ret, "\n");
780                 return ret;
781         }
782
783         info = sseq->info;
784
785         list_for_each_entry(publ, &info->zone_list, zone_list) {
786                 sprintf(portIdStr, "<%u.%u.%u:%u>",
787                          tipc_zone(publ->node), tipc_cluster(publ->node),
788                          tipc_node(publ->node), publ->ref);
789                 ret += tipc_snprintf(buf + ret, len - ret, "%-26s ", portIdStr);
790                 if (depth > 3) {
791                         ret += tipc_snprintf(buf + ret, len - ret, "%-10u %s",
792                                              publ->key, scope_str[publ->scope]);
793                 }
794                 if (!list_is_last(&publ->zone_list, &info->zone_list))
795                         ret += tipc_snprintf(buf + ret, len - ret,
796                                              "\n%33s", " ");
797         }
798
799         ret += tipc_snprintf(buf + ret, len - ret, "\n");
800         return ret;
801 }
802
803 /**
804  * nameseq_list - print specified name sequence contents into the given buffer
805  */
806 static int nameseq_list(struct name_seq *seq, char *buf, int len, u32 depth,
807                         u32 type, u32 lowbound, u32 upbound, u32 index)
808 {
809         struct sub_seq *sseq;
810         char typearea[11];
811         int ret = 0;
812
813         if (seq->first_free == 0)
814                 return 0;
815
816         sprintf(typearea, "%-10u", seq->type);
817
818         if (depth == 1) {
819                 ret += tipc_snprintf(buf, len, "%s\n", typearea);
820                 return ret;
821         }
822
823         for (sseq = seq->sseqs; sseq != &seq->sseqs[seq->first_free]; sseq++) {
824                 if ((lowbound <= sseq->upper) && (upbound >= sseq->lower)) {
825                         ret += tipc_snprintf(buf + ret, len - ret, "%s ",
826                                             typearea);
827                         spin_lock_bh(&seq->lock);
828                         ret += subseq_list(sseq, buf + ret, len - ret,
829                                           depth, index);
830                         spin_unlock_bh(&seq->lock);
831                         sprintf(typearea, "%10s", " ");
832                 }
833         }
834         return ret;
835 }
836
837 /**
838  * nametbl_header - print name table header into the given buffer
839  */
840 static int nametbl_header(char *buf, int len, u32 depth)
841 {
842         const char *header[] = {
843                 "Type       ",
844                 "Lower      Upper      ",
845                 "Port Identity              ",
846                 "Publication Scope"
847         };
848
849         int i;
850         int ret = 0;
851
852         if (depth > 4)
853                 depth = 4;
854         for (i = 0; i < depth; i++)
855                 ret += tipc_snprintf(buf + ret, len - ret, header[i]);
856         ret += tipc_snprintf(buf + ret, len - ret, "\n");
857         return ret;
858 }
859
860 /**
861  * nametbl_list - print specified name table contents into the given buffer
862  */
863 static int nametbl_list(char *buf, int len, u32 depth_info,
864                         u32 type, u32 lowbound, u32 upbound)
865 {
866         struct hlist_head *seq_head;
867         struct name_seq *seq;
868         int all_types;
869         int ret = 0;
870         u32 depth;
871         u32 i;
872
873         all_types = (depth_info & TIPC_NTQ_ALLTYPES);
874         depth = (depth_info & ~TIPC_NTQ_ALLTYPES);
875
876         if (depth == 0)
877                 return 0;
878
879         if (all_types) {
880                 /* display all entries in name table to specified depth */
881                 ret += nametbl_header(buf, len, depth);
882                 lowbound = 0;
883                 upbound = ~0;
884                 for (i = 0; i < TIPC_NAMETBL_SIZE; i++) {
885                         seq_head = &table.types[i];
886                         hlist_for_each_entry(seq, seq_head, ns_list) {
887                                 ret += nameseq_list(seq, buf + ret, len - ret,
888                                                    depth, seq->type,
889                                                    lowbound, upbound, i);
890                         }
891                 }
892         } else {
893                 /* display only the sequence that matches the specified type */
894                 if (upbound < lowbound) {
895                         ret += tipc_snprintf(buf + ret, len - ret,
896                                         "invalid name sequence specified\n");
897                         return ret;
898                 }
899                 ret += nametbl_header(buf + ret, len - ret, depth);
900                 i = hash(type);
901                 seq_head = &table.types[i];
902                 hlist_for_each_entry(seq, seq_head, ns_list) {
903                         if (seq->type == type) {
904                                 ret += nameseq_list(seq, buf + ret, len - ret,
905                                                    depth, type,
906                                                    lowbound, upbound, i);
907                                 break;
908                         }
909                 }
910         }
911         return ret;
912 }
913
914 struct sk_buff *tipc_nametbl_get(const void *req_tlv_area, int req_tlv_space)
915 {
916         struct sk_buff *buf;
917         struct tipc_name_table_query *argv;
918         struct tlv_desc *rep_tlv;
919         char *pb;
920         int pb_len;
921         int str_len;
922
923         if (!TLV_CHECK(req_tlv_area, req_tlv_space, TIPC_TLV_NAME_TBL_QUERY))
924                 return tipc_cfg_reply_error_string(TIPC_CFG_TLV_ERROR);
925
926         buf = tipc_cfg_reply_alloc(TLV_SPACE(ULTRA_STRING_MAX_LEN));
927         if (!buf)
928                 return NULL;
929
930         rep_tlv = (struct tlv_desc *)buf->data;
931         pb = TLV_DATA(rep_tlv);
932         pb_len = ULTRA_STRING_MAX_LEN;
933         argv = (struct tipc_name_table_query *)TLV_DATA(req_tlv_area);
934         read_lock_bh(&tipc_nametbl_lock);
935         str_len = nametbl_list(pb, pb_len, ntohl(argv->depth),
936                                ntohl(argv->type),
937                                ntohl(argv->lowbound), ntohl(argv->upbound));
938         read_unlock_bh(&tipc_nametbl_lock);
939         str_len += 1;   /* for "\0" */
940         skb_put(buf, TLV_SPACE(str_len));
941         TLV_SET(rep_tlv, TIPC_TLV_ULTRA_STRING, NULL, str_len);
942
943         return buf;
944 }
945
946 int tipc_nametbl_init(void)
947 {
948         table.types = kcalloc(TIPC_NAMETBL_SIZE, sizeof(struct hlist_head),
949                               GFP_ATOMIC);
950         if (!table.types)
951                 return -ENOMEM;
952
953         table.local_publ_count = 0;
954         return 0;
955 }
956
957 /**
958  * tipc_purge_publications - remove all publications for a given type
959  *
960  * tipc_nametbl_lock must be held when calling this function
961  */
962 static void tipc_purge_publications(struct name_seq *seq)
963 {
964         struct publication *publ, *safe;
965         struct sub_seq *sseq;
966         struct name_info *info;
967
968         if (!seq->sseqs) {
969                 nameseq_delete_empty(seq);
970                 return;
971         }
972         sseq = seq->sseqs;
973         info = sseq->info;
974         list_for_each_entry_safe(publ, safe, &info->zone_list, zone_list) {
975                 tipc_nametbl_remove_publ(publ->type, publ->lower, publ->node,
976                                          publ->ref, publ->key);
977                 kfree(publ);
978         }
979 }
980
981 void tipc_nametbl_stop(void)
982 {
983         u32 i;
984         struct name_seq *seq;
985         struct hlist_head *seq_head;
986         struct hlist_node *safe;
987
988         /* Verify name table is empty and purge any lingering
989          * publications, then release the name table
990          */
991         write_lock_bh(&tipc_nametbl_lock);
992         for (i = 0; i < TIPC_NAMETBL_SIZE; i++) {
993                 if (hlist_empty(&table.types[i]))
994                         continue;
995                 seq_head = &table.types[i];
996                 hlist_for_each_entry_safe(seq, safe, seq_head, ns_list) {
997                         tipc_purge_publications(seq);
998                 }
999         }
1000         kfree(table.types);
1001         table.types = NULL;
1002         write_unlock_bh(&tipc_nametbl_lock);
1003 }
1004
1005 static int __tipc_nl_add_nametable_publ(struct tipc_nl_msg *msg,
1006                                         struct name_seq *seq,
1007                                         struct sub_seq *sseq, u32 *last_publ)
1008 {
1009         void *hdr;
1010         struct nlattr *attrs;
1011         struct nlattr *publ;
1012         struct publication *p;
1013
1014         if (*last_publ) {
1015                 list_for_each_entry(p, &sseq->info->zone_list, zone_list)
1016                         if (p->key == *last_publ)
1017                                 break;
1018                 if (p->key != *last_publ)
1019                         return -EPIPE;
1020         } else {
1021                 p = list_first_entry(&sseq->info->zone_list, struct publication,
1022                                      zone_list);
1023         }
1024
1025         list_for_each_entry_from(p, &sseq->info->zone_list, zone_list) {
1026                 *last_publ = p->key;
1027
1028                 hdr = genlmsg_put(msg->skb, msg->portid, msg->seq,
1029                                   &tipc_genl_v2_family, NLM_F_MULTI,
1030                                   TIPC_NL_NAME_TABLE_GET);
1031                 if (!hdr)
1032                         return -EMSGSIZE;
1033
1034                 attrs = nla_nest_start(msg->skb, TIPC_NLA_NAME_TABLE);
1035                 if (!attrs)
1036                         goto msg_full;
1037
1038                 publ = nla_nest_start(msg->skb, TIPC_NLA_NAME_TABLE_PUBL);
1039                 if (!publ)
1040                         goto attr_msg_full;
1041
1042                 if (nla_put_u32(msg->skb, TIPC_NLA_PUBL_TYPE, seq->type))
1043                         goto publ_msg_full;
1044                 if (nla_put_u32(msg->skb, TIPC_NLA_PUBL_LOWER, sseq->lower))
1045                         goto publ_msg_full;
1046                 if (nla_put_u32(msg->skb, TIPC_NLA_PUBL_UPPER, sseq->upper))
1047                         goto publ_msg_full;
1048                 if (nla_put_u32(msg->skb, TIPC_NLA_PUBL_SCOPE, p->scope))
1049                         goto publ_msg_full;
1050                 if (nla_put_u32(msg->skb, TIPC_NLA_PUBL_NODE, p->node))
1051                         goto publ_msg_full;
1052                 if (nla_put_u32(msg->skb, TIPC_NLA_PUBL_REF, p->ref))
1053                         goto publ_msg_full;
1054                 if (nla_put_u32(msg->skb, TIPC_NLA_PUBL_KEY, p->key))
1055                         goto publ_msg_full;
1056
1057                 nla_nest_end(msg->skb, publ);
1058                 nla_nest_end(msg->skb, attrs);
1059                 genlmsg_end(msg->skb, hdr);
1060         }
1061         *last_publ = 0;
1062
1063         return 0;
1064
1065 publ_msg_full:
1066         nla_nest_cancel(msg->skb, publ);
1067 attr_msg_full:
1068         nla_nest_cancel(msg->skb, attrs);
1069 msg_full:
1070         genlmsg_cancel(msg->skb, hdr);
1071
1072         return -EMSGSIZE;
1073 }
1074
1075 static int __tipc_nl_subseq_list(struct tipc_nl_msg *msg, struct name_seq *seq,
1076                                  u32 *last_lower, u32 *last_publ)
1077 {
1078         struct sub_seq *sseq;
1079         struct sub_seq *sseq_start;
1080         int err;
1081
1082         if (*last_lower) {
1083                 sseq_start = nameseq_find_subseq(seq, *last_lower);
1084                 if (!sseq_start)
1085                         return -EPIPE;
1086         } else {
1087                 sseq_start = seq->sseqs;
1088         }
1089
1090         for (sseq = sseq_start; sseq != &seq->sseqs[seq->first_free]; sseq++) {
1091                 err = __tipc_nl_add_nametable_publ(msg, seq, sseq, last_publ);
1092                 if (err) {
1093                         *last_lower = sseq->lower;
1094                         return err;
1095                 }
1096         }
1097         *last_lower = 0;
1098
1099         return 0;
1100 }
1101
1102 static int __tipc_nl_seq_list(struct tipc_nl_msg *msg, u32 *last_type,
1103                               u32 *last_lower, u32 *last_publ)
1104 {
1105         struct hlist_head *seq_head;
1106         struct name_seq *seq;
1107         int err;
1108         int i;
1109
1110         if (*last_type)
1111                 i = hash(*last_type);
1112         else
1113                 i = 0;
1114
1115         for (; i < TIPC_NAMETBL_SIZE; i++) {
1116                 seq_head = &table.types[i];
1117
1118                 if (*last_type) {
1119                         seq = nametbl_find_seq(*last_type);
1120                         if (!seq)
1121                                 return -EPIPE;
1122                 } else {
1123                         seq = hlist_entry_safe((seq_head)->first,
1124                                                struct name_seq, ns_list);
1125                         if (!seq)
1126                                 continue;
1127                 }
1128
1129                 hlist_for_each_entry_from(seq, ns_list) {
1130                         spin_lock_bh(&seq->lock);
1131
1132                         err = __tipc_nl_subseq_list(msg, seq, last_lower,
1133                                                     last_publ);
1134
1135                         if (err) {
1136                                 *last_type = seq->type;
1137                                 spin_unlock_bh(&seq->lock);
1138                                 return err;
1139                         }
1140                         spin_unlock_bh(&seq->lock);
1141                 }
1142                 *last_type = 0;
1143         }
1144         return 0;
1145 }
1146
1147 int tipc_nl_name_table_dump(struct sk_buff *skb, struct netlink_callback *cb)
1148 {
1149         int err;
1150         int done = cb->args[3];
1151         u32 last_type = cb->args[0];
1152         u32 last_lower = cb->args[1];
1153         u32 last_publ = cb->args[2];
1154         struct tipc_nl_msg msg;
1155
1156         if (done)
1157                 return 0;
1158
1159         msg.skb = skb;
1160         msg.portid = NETLINK_CB(cb->skb).portid;
1161         msg.seq = cb->nlh->nlmsg_seq;
1162
1163         read_lock_bh(&tipc_nametbl_lock);
1164
1165         err = __tipc_nl_seq_list(&msg, &last_type, &last_lower, &last_publ);
1166         if (!err) {
1167                 done = 1;
1168         } else if (err != -EMSGSIZE) {
1169                 /* We never set seq or call nl_dump_check_consistent() this
1170                  * means that setting prev_seq here will cause the consistence
1171                  * check to fail in the netlink callback handler. Resulting in
1172                  * the NLMSG_DONE message having the NLM_F_DUMP_INTR flag set if
1173                  * we got an error.
1174                  */
1175                 cb->prev_seq = 1;
1176         }
1177
1178         read_unlock_bh(&tipc_nametbl_lock);
1179
1180         cb->args[0] = last_type;
1181         cb->args[1] = last_lower;
1182         cb->args[2] = last_publ;
1183         cb->args[3] = done;
1184
1185         return skb->len;
1186 }