Commit | Line | Data |
---|---|---|
b97bf3fd | 1 | /* |
5b06c85c | 2 | * net/tipc/subscr.c: TIPC network topology service |
c4307285 | 3 | * |
593a5f22 | 4 | * Copyright (c) 2000-2006, Ericsson AB |
13a2e898 | 5 | * Copyright (c) 2005-2007, 2010-2013, Wind River Systems |
b97bf3fd PL |
6 | * All rights reserved. |
7 | * | |
9ea1fd3c | 8 | * Redistribution and use in source and binary forms, with or without |
b97bf3fd PL |
9 | * modification, are permitted provided that the following conditions are met: |
10 | * | |
9ea1fd3c PL |
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. | |
b97bf3fd | 19 | * |
9ea1fd3c PL |
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 | |
b97bf3fd PL |
34 | * POSSIBILITY OF SUCH DAMAGE. |
35 | */ | |
36 | ||
37 | #include "core.h" | |
b97bf3fd | 38 | #include "name_table.h" |
5b06c85c | 39 | #include "subscr.h" |
b97bf3fd PL |
40 | |
41 | /** | |
11f99906 | 42 | * struct tipc_subscriber - TIPC network topology subscriber |
13a2e898 | 43 | * @conid: connection identifier to server connecting to subscriber |
963a1855 | 44 | * @lock: control access to subscriber |
b97bf3fd | 45 | * @subscription_list: list of subscription objects for this subscriber |
b97bf3fd | 46 | */ |
11f99906 | 47 | struct tipc_subscriber { |
13a2e898 YX |
48 | int conid; |
49 | spinlock_t lock; | |
b97bf3fd | 50 | struct list_head subscription_list; |
b97bf3fd PL |
51 | }; |
52 | ||
13a2e898 YX |
53 | static void subscr_conn_msg_event(int conid, struct sockaddr_tipc *addr, |
54 | void *usr_data, void *buf, size_t len); | |
55 | static void *subscr_named_msg_event(int conid); | |
56 | static void subscr_conn_shutdown_event(int conid, void *usr_data); | |
57 | ||
58 | static atomic_t subscription_count = ATOMIC_INIT(0); | |
59 | ||
60 | static struct sockaddr_tipc topsrv_addr __read_mostly = { | |
61 | .family = AF_TIPC, | |
62 | .addrtype = TIPC_ADDR_NAMESEQ, | |
63 | .addr.nameseq.type = TIPC_TOP_SRV, | |
64 | .addr.nameseq.lower = TIPC_TOP_SRV, | |
65 | .addr.nameseq.upper = TIPC_TOP_SRV, | |
66 | .scope = TIPC_NODE_SCOPE | |
b97bf3fd PL |
67 | }; |
68 | ||
13a2e898 YX |
69 | static struct tipc_server topsrv __read_mostly = { |
70 | .saddr = &topsrv_addr, | |
71 | .imp = TIPC_CRITICAL_IMPORTANCE, | |
72 | .type = SOCK_SEQPACKET, | |
73 | .max_rcvbuf_size = sizeof(struct tipc_subscr), | |
74 | .name = "topology_server", | |
75 | .tipc_conn_recvmsg = subscr_conn_msg_event, | |
76 | .tipc_conn_new = subscr_named_msg_event, | |
77 | .tipc_conn_shutdown = subscr_conn_shutdown_event, | |
78 | }; | |
b97bf3fd | 79 | |
db5a753b NH |
80 | /** |
81 | * htohl - convert value to endianness used by destination | |
82 | * @in: value to convert | |
83 | * @swap: non-zero if endianness must be reversed | |
84 | * | |
85 | * Returns converted value | |
86 | */ | |
db5a753b NH |
87 | static u32 htohl(u32 in, int swap) |
88 | { | |
89 | return swap ? swab32(in) : in; | |
90 | } | |
91 | ||
13a2e898 YX |
92 | static void subscr_send_event(struct tipc_subscription *sub, u32 found_lower, |
93 | u32 found_upper, u32 event, u32 port_ref, | |
b97bf3fd PL |
94 | u32 node) |
95 | { | |
13a2e898 YX |
96 | struct tipc_subscriber *subscriber = sub->subscriber; |
97 | struct kvec msg_sect; | |
b97bf3fd PL |
98 | |
99 | msg_sect.iov_base = (void *)&sub->evt; | |
100 | msg_sect.iov_len = sizeof(struct tipc_event); | |
db5a753b NH |
101 | sub->evt.event = htohl(event, sub->swap); |
102 | sub->evt.found_lower = htohl(found_lower, sub->swap); | |
103 | sub->evt.found_upper = htohl(found_upper, sub->swap); | |
104 | sub->evt.port.ref = htohl(port_ref, sub->swap); | |
105 | sub->evt.port.node = htohl(node, sub->swap); | |
6d4ebeb4 YX |
106 | tipc_conn_sendmsg(&topsrv, subscriber->conid, NULL, msg_sect.iov_base, |
107 | msg_sect.iov_len); | |
b97bf3fd PL |
108 | } |
109 | ||
110 | /** | |
4323add6 | 111 | * tipc_subscr_overlap - test for subscription overlap with the given values |
b97bf3fd PL |
112 | * |
113 | * Returns 1 if there is overlap, otherwise 0. | |
114 | */ | |
ae8509c4 | 115 | int tipc_subscr_overlap(struct tipc_subscription *sub, u32 found_lower, |
4323add6 | 116 | u32 found_upper) |
b97bf3fd PL |
117 | { |
118 | if (found_lower < sub->seq.lower) | |
119 | found_lower = sub->seq.lower; | |
120 | if (found_upper > sub->seq.upper) | |
121 | found_upper = sub->seq.upper; | |
122 | if (found_lower > found_upper) | |
123 | return 0; | |
124 | return 1; | |
125 | } | |
126 | ||
127 | /** | |
4323add6 | 128 | * tipc_subscr_report_overlap - issue event if there is subscription overlap |
c4307285 | 129 | * |
b97bf3fd PL |
130 | * Protected by nameseq.lock in name_table.c |
131 | */ | |
ae8509c4 PG |
132 | void tipc_subscr_report_overlap(struct tipc_subscription *sub, u32 found_lower, |
133 | u32 found_upper, u32 event, u32 port_ref, | |
134 | u32 node, int must) | |
b97bf3fd | 135 | { |
4323add6 | 136 | if (!tipc_subscr_overlap(sub, found_lower, found_upper)) |
b97bf3fd | 137 | return; |
eb409460 | 138 | if (!must && !(sub->filter & TIPC_SUB_PORTS)) |
b97bf3fd | 139 | return; |
e15f8804 | 140 | |
7e244776 | 141 | subscr_send_event(sub, found_lower, found_upper, event, port_ref, node); |
b97bf3fd PL |
142 | } |
143 | ||
fead3909 | 144 | static void subscr_timeout(struct tipc_subscription *sub) |
b97bf3fd | 145 | { |
13a2e898 | 146 | struct tipc_subscriber *subscriber = sub->subscriber; |
b97bf3fd | 147 | |
13a2e898 YX |
148 | /* The spin lock per subscriber is used to protect its members */ |
149 | spin_lock_bh(&subscriber->lock); | |
150 | ||
eb409460 | 151 | /* Validate timeout (in case subscription is being cancelled) */ |
eb409460 | 152 | if (sub->timeout == TIPC_WAIT_FOREVER) { |
13a2e898 | 153 | spin_unlock_bh(&subscriber->lock); |
eb409460 LC |
154 | return; |
155 | } | |
156 | ||
b97bf3fd | 157 | /* Unlink subscription from name table */ |
4323add6 | 158 | tipc_nametbl_unsubscribe(sub); |
b97bf3fd | 159 | |
28353e7f | 160 | /* Unlink subscription from subscriber */ |
b97bf3fd PL |
161 | list_del(&sub->subscription_list); |
162 | ||
13a2e898 | 163 | spin_unlock_bh(&subscriber->lock); |
28353e7f AS |
164 | |
165 | /* Notify subscriber of timeout */ | |
28353e7f AS |
166 | subscr_send_event(sub, sub->evt.s.seq.lower, sub->evt.s.seq.upper, |
167 | TIPC_SUBSCR_TIMEOUT, 0, 0); | |
168 | ||
b97bf3fd | 169 | /* Now destroy subscription */ |
b97bf3fd PL |
170 | k_term_timer(&sub->timer); |
171 | kfree(sub); | |
13a2e898 | 172 | atomic_dec(&subscription_count); |
b97bf3fd PL |
173 | } |
174 | ||
eb409460 LC |
175 | /** |
176 | * subscr_del - delete a subscription within a subscription list | |
177 | * | |
13a2e898 | 178 | * Called with subscriber lock held. |
eb409460 | 179 | */ |
fead3909 | 180 | static void subscr_del(struct tipc_subscription *sub) |
eb409460 LC |
181 | { |
182 | tipc_nametbl_unsubscribe(sub); | |
183 | list_del(&sub->subscription_list); | |
184 | kfree(sub); | |
13a2e898 | 185 | atomic_dec(&subscription_count); |
eb409460 LC |
186 | } |
187 | ||
b97bf3fd PL |
188 | /** |
189 | * subscr_terminate - terminate communication with a subscriber | |
c4307285 | 190 | * |
13a2e898 | 191 | * Note: Must call it in process context since it might sleep. |
b97bf3fd | 192 | */ |
11f99906 | 193 | static void subscr_terminate(struct tipc_subscriber *subscriber) |
b97bf3fd | 194 | { |
13a2e898 YX |
195 | tipc_conn_terminate(&topsrv, subscriber->conid); |
196 | } | |
197 | ||
198 | static void subscr_release(struct tipc_subscriber *subscriber) | |
199 | { | |
fead3909 PG |
200 | struct tipc_subscription *sub; |
201 | struct tipc_subscription *sub_temp; | |
b97bf3fd | 202 | |
13a2e898 | 203 | spin_lock_bh(&subscriber->lock); |
b97bf3fd PL |
204 | |
205 | /* Destroy any existing subscriptions for subscriber */ | |
b97bf3fd PL |
206 | list_for_each_entry_safe(sub, sub_temp, &subscriber->subscription_list, |
207 | subscription_list) { | |
208 | if (sub->timeout != TIPC_WAIT_FOREVER) { | |
13a2e898 | 209 | spin_unlock_bh(&subscriber->lock); |
b97bf3fd PL |
210 | k_cancel_timer(&sub->timer); |
211 | k_term_timer(&sub->timer); | |
13a2e898 | 212 | spin_lock_bh(&subscriber->lock); |
b97bf3fd | 213 | } |
eb409460 | 214 | subscr_del(sub); |
b97bf3fd | 215 | } |
13a2e898 | 216 | spin_unlock_bh(&subscriber->lock); |
28353e7f AS |
217 | |
218 | /* Now destroy subscriber */ | |
b97bf3fd PL |
219 | kfree(subscriber); |
220 | } | |
221 | ||
eb409460 LC |
222 | /** |
223 | * subscr_cancel - handle subscription cancellation request | |
224 | * | |
13a2e898 | 225 | * Called with subscriber lock held. Routine must temporarily release lock |
eb409460 LC |
226 | * to enable the subscription timeout routine to finish without deadlocking; |
227 | * the lock is then reclaimed to allow caller to release it upon return. | |
228 | * | |
229 | * Note that fields of 's' use subscriber's endianness! | |
230 | */ | |
eb409460 | 231 | static void subscr_cancel(struct tipc_subscr *s, |
11f99906 | 232 | struct tipc_subscriber *subscriber) |
eb409460 | 233 | { |
fead3909 PG |
234 | struct tipc_subscription *sub; |
235 | struct tipc_subscription *sub_temp; | |
eb409460 LC |
236 | int found = 0; |
237 | ||
238 | /* Find first matching subscription, exit if not found */ | |
eb409460 LC |
239 | list_for_each_entry_safe(sub, sub_temp, &subscriber->subscription_list, |
240 | subscription_list) { | |
db5a753b NH |
241 | if (!memcmp(s, &sub->evt.s, sizeof(struct tipc_subscr))) { |
242 | found = 1; | |
243 | break; | |
244 | } | |
eb409460 LC |
245 | } |
246 | if (!found) | |
247 | return; | |
248 | ||
249 | /* Cancel subscription timer (if used), then delete subscription */ | |
eb409460 LC |
250 | if (sub->timeout != TIPC_WAIT_FOREVER) { |
251 | sub->timeout = TIPC_WAIT_FOREVER; | |
13a2e898 | 252 | spin_unlock_bh(&subscriber->lock); |
eb409460 LC |
253 | k_cancel_timer(&sub->timer); |
254 | k_term_timer(&sub->timer); | |
13a2e898 | 255 | spin_lock_bh(&subscriber->lock); |
eb409460 | 256 | } |
eb409460 LC |
257 | subscr_del(sub); |
258 | } | |
259 | ||
b97bf3fd PL |
260 | /** |
261 | * subscr_subscribe - create subscription for subscriber | |
c4307285 | 262 | * |
13a2e898 | 263 | * Called with subscriber lock held. |
b97bf3fd | 264 | */ |
a5d0e7c0 EH |
265 | static int subscr_subscribe(struct tipc_subscr *s, |
266 | struct tipc_subscriber *subscriber, | |
267 | struct tipc_subscription **sub_p) { | |
fead3909 | 268 | struct tipc_subscription *sub; |
db5a753b NH |
269 | int swap; |
270 | ||
271 | /* Determine subscriber's endianness */ | |
db5a753b | 272 | swap = !(s->filter & (TIPC_SUB_PORTS | TIPC_SUB_SERVICE)); |
eb409460 LC |
273 | |
274 | /* Detect & process a subscription cancellation request */ | |
db5a753b NH |
275 | if (s->filter & htohl(TIPC_SUB_CANCEL, swap)) { |
276 | s->filter &= ~htohl(TIPC_SUB_CANCEL, swap); | |
eb409460 | 277 | subscr_cancel(s, subscriber); |
a5d0e7c0 | 278 | return 0; |
eb409460 LC |
279 | } |
280 | ||
b97bf3fd | 281 | /* Refuse subscription if global limit exceeded */ |
13a2e898 | 282 | if (atomic_read(&subscription_count) >= TIPC_MAX_SUBSCRIPTIONS) { |
2cf8aa19 | 283 | pr_warn("Subscription rejected, limit reached (%u)\n", |
34f256cc | 284 | TIPC_MAX_SUBSCRIPTIONS); |
a5d0e7c0 | 285 | return -EINVAL; |
b97bf3fd PL |
286 | } |
287 | ||
288 | /* Allocate subscription object */ | |
28353e7f | 289 | sub = kmalloc(sizeof(*sub), GFP_ATOMIC); |
a10bd924 | 290 | if (!sub) { |
2cf8aa19 | 291 | pr_warn("Subscription rejected, no memory\n"); |
a5d0e7c0 | 292 | return -ENOMEM; |
b97bf3fd PL |
293 | } |
294 | ||
b97bf3fd | 295 | /* Initialize subscription object */ |
db5a753b NH |
296 | sub->seq.type = htohl(s->seq.type, swap); |
297 | sub->seq.lower = htohl(s->seq.lower, swap); | |
298 | sub->seq.upper = htohl(s->seq.upper, swap); | |
299 | sub->timeout = htohl(s->timeout, swap); | |
300 | sub->filter = htohl(s->filter, swap); | |
8c974438 NH |
301 | if ((!(sub->filter & TIPC_SUB_PORTS) == |
302 | !(sub->filter & TIPC_SUB_SERVICE)) || | |
f64f9e71 | 303 | (sub->seq.lower > sub->seq.upper)) { |
2cf8aa19 | 304 | pr_warn("Subscription rejected, illegal request\n"); |
b97bf3fd | 305 | kfree(sub); |
a5d0e7c0 | 306 | return -EINVAL; |
b97bf3fd | 307 | } |
b97bf3fd PL |
308 | INIT_LIST_HEAD(&sub->nameseq_list); |
309 | list_add(&sub->subscription_list, &subscriber->subscription_list); | |
13a2e898 | 310 | sub->subscriber = subscriber; |
db5a753b | 311 | sub->swap = swap; |
28353e7f | 312 | memcpy(&sub->evt.s, s, sizeof(struct tipc_subscr)); |
13a2e898 | 313 | atomic_inc(&subscription_count); |
b97bf3fd PL |
314 | if (sub->timeout != TIPC_WAIT_FOREVER) { |
315 | k_init_timer(&sub->timer, | |
316 | (Handler)subscr_timeout, (unsigned long)sub); | |
317 | k_start_timer(&sub->timer, sub->timeout); | |
318 | } | |
a5d0e7c0 EH |
319 | *sub_p = sub; |
320 | return 0; | |
b97bf3fd PL |
321 | } |
322 | ||
13a2e898 YX |
323 | /* Handle one termination request for the subscriber */ |
324 | static void subscr_conn_shutdown_event(int conid, void *usr_data) | |
b97bf3fd | 325 | { |
13a2e898 | 326 | subscr_release((struct tipc_subscriber *)usr_data); |
b97bf3fd PL |
327 | } |
328 | ||
13a2e898 YX |
329 | /* Handle one request to create a new subscription for the subscriber */ |
330 | static void subscr_conn_msg_event(int conid, struct sockaddr_tipc *addr, | |
331 | void *usr_data, void *buf, size_t len) | |
b97bf3fd | 332 | { |
13a2e898 | 333 | struct tipc_subscriber *subscriber = usr_data; |
a5d0e7c0 | 334 | struct tipc_subscription *sub = NULL; |
28353e7f | 335 | |
13a2e898 | 336 | spin_lock_bh(&subscriber->lock); |
a5d0e7c0 EH |
337 | if (subscr_subscribe((struct tipc_subscr *)buf, subscriber, &sub) < 0) { |
338 | spin_unlock_bh(&subscriber->lock); | |
339 | subscr_terminate(subscriber); | |
340 | return; | |
341 | } | |
13a2e898 YX |
342 | if (sub) |
343 | tipc_nametbl_subscribe(sub); | |
344 | spin_unlock_bh(&subscriber->lock); | |
b97bf3fd PL |
345 | } |
346 | ||
13a2e898 YX |
347 | |
348 | /* Handle one request to establish a new subscriber */ | |
349 | static void *subscr_named_msg_event(int conid) | |
b97bf3fd | 350 | { |
11f99906 | 351 | struct tipc_subscriber *subscriber; |
b97bf3fd PL |
352 | |
353 | /* Create subscriber object */ | |
11f99906 | 354 | subscriber = kzalloc(sizeof(struct tipc_subscriber), GFP_ATOMIC); |
b97bf3fd | 355 | if (subscriber == NULL) { |
2cf8aa19 | 356 | pr_warn("Subscriber rejected, no memory\n"); |
13a2e898 | 357 | return NULL; |
b97bf3fd | 358 | } |
b97bf3fd | 359 | INIT_LIST_HEAD(&subscriber->subscription_list); |
13a2e898 YX |
360 | subscriber->conid = conid; |
361 | spin_lock_init(&subscriber->lock); | |
28353e7f | 362 | |
13a2e898 | 363 | return (void *)subscriber; |
b97bf3fd PL |
364 | } |
365 | ||
4323add6 | 366 | int tipc_subscr_start(void) |
b97bf3fd | 367 | { |
13a2e898 | 368 | return tipc_server_start(&topsrv); |
b97bf3fd PL |
369 | } |
370 | ||
4323add6 | 371 | void tipc_subscr_stop(void) |
b97bf3fd | 372 | { |
13a2e898 | 373 | tipc_server_stop(&topsrv); |
b97bf3fd | 374 | } |