2 * net/tipc/subscr.c: TIPC network topology service
4 * Copyright (c) 2000-2017, Ericsson AB
5 * Copyright (c) 2005-2007, 2010-2013, Wind River Systems
6 * Copyright (c) 2020, Red Hat Inc
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions are met:
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
17 * 3. Neither the names of the copyright holders nor the names of its
18 * contributors may be used to endorse or promote products derived from
19 * this software without specific prior written permission.
21 * Alternatively, this software may be distributed under the terms of the
22 * GNU General Public License ("GPL") version 2 as published by the Free
23 * Software Foundation.
25 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
26 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
28 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
29 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
30 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
31 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
32 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
33 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
34 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
35 * POSSIBILITY OF SUCH DAMAGE.
39 #include "name_table.h"
42 static void tipc_sub_send_event(struct tipc_subscription *sub,
43 u32 found_lower, u32 found_upper,
44 u32 event, u32 port, u32 node)
46 struct tipc_event *evt = &sub->evt;
50 tipc_evt_write(evt, event, event);
51 tipc_evt_write(evt, found_lower, found_lower);
52 tipc_evt_write(evt, found_upper, found_upper);
53 tipc_evt_write(evt, port.ref, port);
54 tipc_evt_write(evt, port.node, node);
55 tipc_topsrv_queue_evt(sub->net, sub->conid, event, evt);
59 * tipc_sub_check_overlap - test for subscription overlap with the
62 * Returns 1 if there is overlap, otherwise 0.
64 int tipc_sub_check_overlap(struct tipc_service_range *seq, u32 found_lower,
67 if (found_lower < seq->lower)
68 found_lower = seq->lower;
69 if (found_upper > seq->upper)
70 found_upper = seq->upper;
71 if (found_lower > found_upper)
76 void tipc_sub_report_overlap(struct tipc_subscription *sub,
77 u32 found_lower, u32 found_upper,
78 u32 event, u32 port, u32 node,
81 struct tipc_subscr *s = &sub->evt.s;
82 u32 filter = tipc_sub_read(s, filter);
83 struct tipc_service_range seq;
85 seq.type = tipc_sub_read(s, seq.type);
86 seq.lower = tipc_sub_read(s, seq.lower);
87 seq.upper = tipc_sub_read(s, seq.upper);
89 if (!tipc_sub_check_overlap(&seq, found_lower, found_upper))
92 if (!must && !(filter & TIPC_SUB_PORTS))
94 if (filter & TIPC_SUB_CLUSTER_SCOPE && scope == TIPC_NODE_SCOPE)
96 if (filter & TIPC_SUB_NODE_SCOPE && scope != TIPC_NODE_SCOPE)
98 spin_lock(&sub->lock);
99 tipc_sub_send_event(sub, found_lower, found_upper,
101 spin_unlock(&sub->lock);
104 static void tipc_sub_timeout(struct timer_list *t)
106 struct tipc_subscription *sub = from_timer(sub, t, timer);
107 struct tipc_subscr *s = &sub->evt.s;
109 spin_lock(&sub->lock);
110 tipc_sub_send_event(sub, s->seq.lower, s->seq.upper,
111 TIPC_SUBSCR_TIMEOUT, 0, 0);
112 sub->inactive = true;
113 spin_unlock(&sub->lock);
116 static void tipc_sub_kref_release(struct kref *kref)
118 kfree(container_of(kref, struct tipc_subscription, kref));
121 void tipc_sub_put(struct tipc_subscription *subscription)
123 kref_put(&subscription->kref, tipc_sub_kref_release);
126 void tipc_sub_get(struct tipc_subscription *subscription)
128 kref_get(&subscription->kref);
131 struct tipc_subscription *tipc_sub_subscribe(struct net *net,
132 struct tipc_subscr *s,
135 u32 filter = tipc_sub_read(s, filter);
136 struct tipc_subscription *sub;
139 if ((filter & TIPC_SUB_PORTS && filter & TIPC_SUB_SERVICE) ||
140 (tipc_sub_read(s, seq.lower) > tipc_sub_read(s, seq.upper))) {
141 pr_warn("Subscription rejected, illegal request\n");
144 sub = kmalloc(sizeof(*sub), GFP_ATOMIC);
146 pr_warn("Subscription rejected, no memory\n");
149 INIT_LIST_HEAD(&sub->service_list);
150 INIT_LIST_HEAD(&sub->sub_list);
153 sub->inactive = false;
154 memcpy(&sub->evt.s, s, sizeof(*s));
155 spin_lock_init(&sub->lock);
156 kref_init(&sub->kref);
157 if (!tipc_nametbl_subscribe(sub)) {
161 timer_setup(&sub->timer, tipc_sub_timeout, 0);
162 timeout = tipc_sub_read(&sub->evt.s, timeout);
163 if (timeout != TIPC_WAIT_FOREVER)
164 mod_timer(&sub->timer, jiffies + msecs_to_jiffies(timeout));
168 void tipc_sub_unsubscribe(struct tipc_subscription *sub)
170 tipc_nametbl_unsubscribe(sub);
171 if (sub->evt.s.timeout != TIPC_WAIT_FOREVER)
172 del_timer_sync(&sub->timer);
173 list_del(&sub->sub_list);