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 |
00bc00a9 | 43 | * @kref: reference counter to tipc_subscription object |
13a2e898 | 44 | * @conid: connection identifier to server connecting to subscriber |
963a1855 | 45 | * @lock: control access to subscriber |
57f1d186 | 46 | * @subscrp_list: list of subscription objects for this subscriber |
b97bf3fd | 47 | */ |
11f99906 | 48 | struct tipc_subscriber { |
00bc00a9 | 49 | struct kref kref; |
13a2e898 YX |
50 | int conid; |
51 | spinlock_t lock; | |
57f1d186 | 52 | struct list_head subscrp_list; |
b97bf3fd PL |
53 | }; |
54 | ||
00bc00a9 YX |
55 | static void tipc_subscrb_put(struct tipc_subscriber *subscriber); |
56 | ||
db5a753b NH |
57 | /** |
58 | * htohl - convert value to endianness used by destination | |
59 | * @in: value to convert | |
60 | * @swap: non-zero if endianness must be reversed | |
61 | * | |
62 | * Returns converted value | |
63 | */ | |
db5a753b NH |
64 | static u32 htohl(u32 in, int swap) |
65 | { | |
66 | return swap ? swab32(in) : in; | |
67 | } | |
68 | ||
57f1d186 YX |
69 | static void tipc_subscrp_send_event(struct tipc_subscription *sub, |
70 | u32 found_lower, u32 found_upper, | |
71 | u32 event, u32 port_ref, u32 node) | |
b97bf3fd | 72 | { |
a62fbcce | 73 | struct tipc_net *tn = net_generic(sub->net, tipc_net_id); |
13a2e898 YX |
74 | struct tipc_subscriber *subscriber = sub->subscriber; |
75 | struct kvec msg_sect; | |
b97bf3fd PL |
76 | |
77 | msg_sect.iov_base = (void *)&sub->evt; | |
78 | msg_sect.iov_len = sizeof(struct tipc_event); | |
db5a753b NH |
79 | sub->evt.event = htohl(event, sub->swap); |
80 | sub->evt.found_lower = htohl(found_lower, sub->swap); | |
81 | sub->evt.found_upper = htohl(found_upper, sub->swap); | |
82 | sub->evt.port.ref = htohl(port_ref, sub->swap); | |
83 | sub->evt.port.node = htohl(node, sub->swap); | |
27469b73 | 84 | tipc_conn_sendmsg(tn->topsrv, subscriber->conid, |
a62fbcce | 85 | msg_sect.iov_base, msg_sect.iov_len); |
b97bf3fd PL |
86 | } |
87 | ||
88 | /** | |
57f1d186 YX |
89 | * tipc_subscrp_check_overlap - test for subscription overlap with the |
90 | * given values | |
b97bf3fd PL |
91 | * |
92 | * Returns 1 if there is overlap, otherwise 0. | |
93 | */ | |
a4273c73 | 94 | int tipc_subscrp_check_overlap(struct tipc_name_seq *seq, u32 found_lower, |
57f1d186 | 95 | u32 found_upper) |
b97bf3fd | 96 | { |
a4273c73 PB |
97 | if (found_lower < seq->lower) |
98 | found_lower = seq->lower; | |
99 | if (found_upper > seq->upper) | |
100 | found_upper = seq->upper; | |
b97bf3fd PL |
101 | if (found_lower > found_upper) |
102 | return 0; | |
103 | return 1; | |
104 | } | |
105 | ||
a4273c73 PB |
106 | u32 tipc_subscrp_convert_seq_type(u32 type, int swap) |
107 | { | |
108 | return htohl(type, swap); | |
109 | } | |
110 | ||
111 | void tipc_subscrp_convert_seq(struct tipc_name_seq *in, int swap, | |
112 | struct tipc_name_seq *out) | |
113 | { | |
114 | out->type = htohl(in->type, swap); | |
115 | out->lower = htohl(in->lower, swap); | |
116 | out->upper = htohl(in->upper, swap); | |
117 | } | |
118 | ||
57f1d186 YX |
119 | void tipc_subscrp_report_overlap(struct tipc_subscription *sub, u32 found_lower, |
120 | u32 found_upper, u32 event, u32 port_ref, | |
232d07b7 | 121 | u32 node, u32 scope, int must) |
b97bf3fd | 122 | { |
232d07b7 | 123 | u32 filter = htohl(sub->evt.s.filter, sub->swap); |
a4273c73 PB |
124 | struct tipc_name_seq seq; |
125 | ||
126 | tipc_subscrp_convert_seq(&sub->evt.s.seq, sub->swap, &seq); | |
127 | if (!tipc_subscrp_check_overlap(&seq, found_lower, found_upper)) | |
b97bf3fd | 128 | return; |
232d07b7 JM |
129 | if (!must && !(filter & TIPC_SUB_PORTS)) |
130 | return; | |
131 | if (filter & TIPC_SUB_CLUSTER_SCOPE && scope == TIPC_NODE_SCOPE) | |
132 | return; | |
133 | if (filter & TIPC_SUB_NODE_SCOPE && scope != TIPC_NODE_SCOPE) | |
b97bf3fd | 134 | return; |
e15f8804 | 135 | |
57f1d186 YX |
136 | tipc_subscrp_send_event(sub, found_lower, found_upper, event, port_ref, |
137 | node); | |
b97bf3fd PL |
138 | } |
139 | ||
31b102bb | 140 | static void tipc_subscrp_timeout(struct timer_list *t) |
b97bf3fd | 141 | { |
31b102bb | 142 | struct tipc_subscription *sub = from_timer(sub, t, timer); |
557d054c YX |
143 | struct tipc_subscriber *subscriber = sub->subscriber; |
144 | ||
145 | spin_lock_bh(&subscriber->lock); | |
146 | tipc_nametbl_unsubscribe(sub); | |
139bb36f | 147 | list_del(&sub->subscrp_list); |
557d054c | 148 | spin_unlock_bh(&subscriber->lock); |
28353e7f AS |
149 | |
150 | /* Notify subscriber of timeout */ | |
57f1d186 YX |
151 | tipc_subscrp_send_event(sub, sub->evt.s.seq.lower, sub->evt.s.seq.upper, |
152 | TIPC_SUBSCR_TIMEOUT, 0, 0); | |
28353e7f | 153 | |
d094c4d5 | 154 | tipc_subscrp_put(sub); |
b97bf3fd PL |
155 | } |
156 | ||
00bc00a9 | 157 | static void tipc_subscrb_kref_release(struct kref *kref) |
eb409460 | 158 | { |
d094c4d5 | 159 | kfree(container_of(kref,struct tipc_subscriber, kref)); |
00bc00a9 YX |
160 | } |
161 | ||
162 | static void tipc_subscrb_put(struct tipc_subscriber *subscriber) | |
163 | { | |
164 | kref_put(&subscriber->kref, tipc_subscrb_kref_release); | |
165 | } | |
166 | ||
167 | static void tipc_subscrb_get(struct tipc_subscriber *subscriber) | |
168 | { | |
169 | kref_get(&subscriber->kref); | |
eb409460 LC |
170 | } |
171 | ||
d094c4d5 PB |
172 | static void tipc_subscrp_kref_release(struct kref *kref) |
173 | { | |
174 | struct tipc_subscription *sub = container_of(kref, | |
175 | struct tipc_subscription, | |
176 | kref); | |
177 | struct tipc_net *tn = net_generic(sub->net, tipc_net_id); | |
178 | struct tipc_subscriber *subscriber = sub->subscriber; | |
179 | ||
d094c4d5 | 180 | atomic_dec(&tn->subscription_count); |
d094c4d5 PB |
181 | kfree(sub); |
182 | tipc_subscrb_put(subscriber); | |
183 | } | |
184 | ||
7efea60d | 185 | void tipc_subscrp_put(struct tipc_subscription *subscription) |
d094c4d5 PB |
186 | { |
187 | kref_put(&subscription->kref, tipc_subscrp_kref_release); | |
188 | } | |
189 | ||
7efea60d | 190 | void tipc_subscrp_get(struct tipc_subscription *subscription) |
d094c4d5 PB |
191 | { |
192 | kref_get(&subscription->kref); | |
193 | } | |
194 | ||
195 | /* tipc_subscrb_subscrp_delete - delete a specific subscription or all | |
196 | * subscriptions for a given subscriber. | |
197 | */ | |
198 | static void tipc_subscrb_subscrp_delete(struct tipc_subscriber *subscriber, | |
199 | struct tipc_subscr *s) | |
200 | { | |
201 | struct list_head *subscription_list = &subscriber->subscrp_list; | |
202 | struct tipc_subscription *sub, *temp; | |
458be024 | 203 | u32 timeout; |
d094c4d5 PB |
204 | |
205 | spin_lock_bh(&subscriber->lock); | |
206 | list_for_each_entry_safe(sub, temp, subscription_list, subscrp_list) { | |
207 | if (s && memcmp(s, &sub->evt.s, sizeof(struct tipc_subscr))) | |
208 | continue; | |
209 | ||
458be024 PB |
210 | timeout = htohl(sub->evt.s.timeout, sub->swap); |
211 | if (timeout == TIPC_WAIT_FOREVER || del_timer(&sub->timer)) { | |
212 | tipc_nametbl_unsubscribe(sub); | |
213 | list_del(&sub->subscrp_list); | |
214 | tipc_subscrp_put(sub); | |
215 | } | |
d094c4d5 PB |
216 | |
217 | if (s) | |
218 | break; | |
219 | } | |
220 | spin_unlock_bh(&subscriber->lock); | |
221 | } | |
222 | ||
1b764828 YX |
223 | static struct tipc_subscriber *tipc_subscrb_create(int conid) |
224 | { | |
225 | struct tipc_subscriber *subscriber; | |
226 | ||
227 | subscriber = kzalloc(sizeof(*subscriber), GFP_ATOMIC); | |
228 | if (!subscriber) { | |
229 | pr_warn("Subscriber rejected, no memory\n"); | |
230 | return NULL; | |
231 | } | |
232 | INIT_LIST_HEAD(&subscriber->subscrp_list); | |
d094c4d5 | 233 | kref_init(&subscriber->kref); |
1b764828 YX |
234 | subscriber->conid = conid; |
235 | spin_lock_init(&subscriber->lock); | |
236 | ||
237 | return subscriber; | |
238 | } | |
239 | ||
57f1d186 | 240 | static void tipc_subscrb_delete(struct tipc_subscriber *subscriber) |
13a2e898 | 241 | { |
d094c4d5 | 242 | tipc_subscrb_subscrp_delete(subscriber, NULL); |
00bc00a9 YX |
243 | tipc_subscrb_put(subscriber); |
244 | } | |
245 | ||
57f1d186 YX |
246 | static void tipc_subscrp_cancel(struct tipc_subscr *s, |
247 | struct tipc_subscriber *subscriber) | |
eb409460 | 248 | { |
fd849b7c | 249 | tipc_subscrb_get(subscriber); |
d094c4d5 | 250 | tipc_subscrb_subscrp_delete(subscriber, s); |
fd849b7c | 251 | tipc_subscrb_put(subscriber); |
eb409460 LC |
252 | } |
253 | ||
7c13c622 PB |
254 | static struct tipc_subscription *tipc_subscrp_create(struct net *net, |
255 | struct tipc_subscr *s, | |
c8beccc6 | 256 | int swap) |
a62fbcce YX |
257 | { |
258 | struct tipc_net *tn = net_generic(net, tipc_net_id); | |
fead3909 | 259 | struct tipc_subscription *sub; |
c8beccc6 | 260 | u32 filter = htohl(s->filter, swap); |
eb409460 | 261 | |
b97bf3fd | 262 | /* Refuse subscription if global limit exceeded */ |
a62fbcce | 263 | if (atomic_read(&tn->subscription_count) >= TIPC_MAX_SUBSCRIPTIONS) { |
2cf8aa19 | 264 | pr_warn("Subscription rejected, limit reached (%u)\n", |
34f256cc | 265 | TIPC_MAX_SUBSCRIPTIONS); |
7c13c622 | 266 | return NULL; |
b97bf3fd PL |
267 | } |
268 | ||
269 | /* Allocate subscription object */ | |
28353e7f | 270 | sub = kmalloc(sizeof(*sub), GFP_ATOMIC); |
a10bd924 | 271 | if (!sub) { |
2cf8aa19 | 272 | pr_warn("Subscription rejected, no memory\n"); |
7c13c622 | 273 | return NULL; |
b97bf3fd PL |
274 | } |
275 | ||
b97bf3fd | 276 | /* Initialize subscription object */ |
4ac1c8d0 | 277 | sub->net = net; |
30865231 | 278 | if (((filter & TIPC_SUB_PORTS) && (filter & TIPC_SUB_SERVICE)) || |
a4273c73 | 279 | (htohl(s->seq.lower, swap) > htohl(s->seq.upper, swap))) { |
2cf8aa19 | 280 | pr_warn("Subscription rejected, illegal request\n"); |
b97bf3fd | 281 | kfree(sub); |
7c13c622 | 282 | return NULL; |
b97bf3fd | 283 | } |
30865231 | 284 | |
db5a753b | 285 | sub->swap = swap; |
57f1d186 | 286 | memcpy(&sub->evt.s, s, sizeof(*s)); |
a62fbcce | 287 | atomic_inc(&tn->subscription_count); |
d094c4d5 | 288 | kref_init(&sub->kref); |
7c13c622 PB |
289 | return sub; |
290 | } | |
291 | ||
e88f2be8 JM |
292 | static int tipc_subscrp_subscribe(struct net *net, struct tipc_subscr *s, |
293 | struct tipc_subscriber *subscriber, int swap, | |
294 | bool status) | |
7c13c622 | 295 | { |
7c13c622 PB |
296 | struct tipc_subscription *sub = NULL; |
297 | u32 timeout; | |
298 | ||
c8beccc6 | 299 | sub = tipc_subscrp_create(net, s, swap); |
7c13c622 | 300 | if (!sub) |
e88f2be8 | 301 | return -1; |
7c13c622 PB |
302 | |
303 | spin_lock_bh(&subscriber->lock); | |
304 | list_add(&sub->subscrp_list, &subscriber->subscrp_list); | |
d4091899 | 305 | sub->subscriber = subscriber; |
8348500f | 306 | tipc_nametbl_subscribe(sub, status); |
d094c4d5 | 307 | tipc_subscrb_get(subscriber); |
7c13c622 PB |
308 | spin_unlock_bh(&subscriber->lock); |
309 | ||
31b102bb | 310 | timer_setup(&sub->timer, tipc_subscrp_timeout, 0); |
c8beccc6 | 311 | timeout = htohl(sub->evt.s.timeout, swap); |
ae245557 | 312 | |
d094c4d5 PB |
313 | if (timeout != TIPC_WAIT_FOREVER) |
314 | mod_timer(&sub->timer, jiffies + msecs_to_jiffies(timeout)); | |
e88f2be8 | 315 | return 0; |
b97bf3fd PL |
316 | } |
317 | ||
13a2e898 | 318 | /* Handle one termination request for the subscriber */ |
333f7962 | 319 | static void tipc_subscrb_release_cb(int conid, void *usr_data) |
b97bf3fd | 320 | { |
57f1d186 | 321 | tipc_subscrb_delete((struct tipc_subscriber *)usr_data); |
b97bf3fd PL |
322 | } |
323 | ||
13a2e898 | 324 | /* Handle one request to create a new subscription for the subscriber */ |
e88f2be8 JM |
325 | static int tipc_subscrb_rcv_cb(struct net *net, int conid, |
326 | struct sockaddr_tipc *addr, void *usr_data, | |
327 | void *buf, size_t len) | |
b97bf3fd | 328 | { |
c8beccc6 PB |
329 | struct tipc_subscriber *subscriber = usr_data; |
330 | struct tipc_subscr *s = (struct tipc_subscr *)buf; | |
8348500f | 331 | bool status; |
c8beccc6 PB |
332 | int swap; |
333 | ||
334 | /* Determine subscriber's endianness */ | |
cb01c7c8 PB |
335 | swap = !(s->filter & (TIPC_SUB_PORTS | TIPC_SUB_SERVICE | |
336 | TIPC_SUB_CANCEL)); | |
c8beccc6 PB |
337 | |
338 | /* Detect & process a subscription cancellation request */ | |
339 | if (s->filter & htohl(TIPC_SUB_CANCEL, swap)) { | |
340 | s->filter &= ~htohl(TIPC_SUB_CANCEL, swap); | |
e88f2be8 JM |
341 | tipc_subscrp_cancel(s, subscriber); |
342 | return 0; | |
c8beccc6 | 343 | } |
8348500f | 344 | status = !(s->filter & htohl(TIPC_SUB_NO_STATUS, swap)); |
e88f2be8 | 345 | return tipc_subscrp_subscribe(net, s, subscriber, swap, status); |
b97bf3fd PL |
346 | } |
347 | ||
13a2e898 | 348 | /* Handle one request to establish a new subscriber */ |
57f1d186 | 349 | static void *tipc_subscrb_connect_cb(int conid) |
b97bf3fd | 350 | { |
1b764828 | 351 | return (void *)tipc_subscrb_create(conid); |
b97bf3fd PL |
352 | } |
353 | ||
57f1d186 | 354 | int tipc_topsrv_start(struct net *net) |
b97bf3fd | 355 | { |
a62fbcce YX |
356 | struct tipc_net *tn = net_generic(net, tipc_net_id); |
357 | const char name[] = "topology_server"; | |
358 | struct tipc_server *topsrv; | |
359 | struct sockaddr_tipc *saddr; | |
360 | ||
361 | saddr = kzalloc(sizeof(*saddr), GFP_ATOMIC); | |
362 | if (!saddr) | |
363 | return -ENOMEM; | |
364 | saddr->family = AF_TIPC; | |
365 | saddr->addrtype = TIPC_ADDR_NAMESEQ; | |
366 | saddr->addr.nameseq.type = TIPC_TOP_SRV; | |
367 | saddr->addr.nameseq.lower = TIPC_TOP_SRV; | |
368 | saddr->addr.nameseq.upper = TIPC_TOP_SRV; | |
369 | saddr->scope = TIPC_NODE_SCOPE; | |
370 | ||
371 | topsrv = kzalloc(sizeof(*topsrv), GFP_ATOMIC); | |
372 | if (!topsrv) { | |
373 | kfree(saddr); | |
374 | return -ENOMEM; | |
375 | } | |
376 | topsrv->net = net; | |
377 | topsrv->saddr = saddr; | |
a62fbcce | 378 | topsrv->max_rcvbuf_size = sizeof(struct tipc_subscr); |
57f1d186 YX |
379 | topsrv->tipc_conn_recvmsg = tipc_subscrb_rcv_cb; |
380 | topsrv->tipc_conn_new = tipc_subscrb_connect_cb; | |
333f7962 | 381 | topsrv->tipc_conn_release = tipc_subscrb_release_cb; |
a62fbcce YX |
382 | |
383 | strncpy(topsrv->name, name, strlen(name) + 1); | |
384 | tn->topsrv = topsrv; | |
385 | atomic_set(&tn->subscription_count, 0); | |
386 | ||
387 | return tipc_server_start(topsrv); | |
b97bf3fd PL |
388 | } |
389 | ||
57f1d186 | 390 | void tipc_topsrv_stop(struct net *net) |
b97bf3fd | 391 | { |
a62fbcce YX |
392 | struct tipc_net *tn = net_generic(net, tipc_net_id); |
393 | struct tipc_server *topsrv = tn->topsrv; | |
394 | ||
395 | tipc_server_stop(topsrv); | |
396 | kfree(topsrv->saddr); | |
397 | kfree(topsrv); | |
b97bf3fd | 398 | } |