]>
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); | |
a62fbcce YX |
84 | tipc_conn_sendmsg(tn->topsrv, subscriber->conid, NULL, |
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, | |
121 | u32 node, int must) | |
b97bf3fd | 122 | { |
a4273c73 PB |
123 | struct tipc_name_seq seq; |
124 | ||
125 | tipc_subscrp_convert_seq(&sub->evt.s.seq, sub->swap, &seq); | |
126 | if (!tipc_subscrp_check_overlap(&seq, found_lower, found_upper)) | |
b97bf3fd | 127 | return; |
30865231 PB |
128 | if (!must && |
129 | !(htohl(sub->evt.s.filter, sub->swap) & TIPC_SUB_PORTS)) | |
b97bf3fd | 130 | return; |
e15f8804 | 131 | |
57f1d186 YX |
132 | tipc_subscrp_send_event(sub, found_lower, found_upper, event, port_ref, |
133 | node); | |
b97bf3fd PL |
134 | } |
135 | ||
31b102bb | 136 | static void tipc_subscrp_timeout(struct timer_list *t) |
b97bf3fd | 137 | { |
31b102bb | 138 | struct tipc_subscription *sub = from_timer(sub, t, timer); |
557d054c YX |
139 | struct tipc_subscriber *subscriber = sub->subscriber; |
140 | ||
141 | spin_lock_bh(&subscriber->lock); | |
142 | tipc_nametbl_unsubscribe(sub); | |
139bb36f | 143 | list_del(&sub->subscrp_list); |
557d054c | 144 | spin_unlock_bh(&subscriber->lock); |
28353e7f AS |
145 | |
146 | /* Notify subscriber of timeout */ | |
57f1d186 YX |
147 | tipc_subscrp_send_event(sub, sub->evt.s.seq.lower, sub->evt.s.seq.upper, |
148 | TIPC_SUBSCR_TIMEOUT, 0, 0); | |
28353e7f | 149 | |
d094c4d5 | 150 | tipc_subscrp_put(sub); |
b97bf3fd PL |
151 | } |
152 | ||
00bc00a9 | 153 | static void tipc_subscrb_kref_release(struct kref *kref) |
eb409460 | 154 | { |
d094c4d5 | 155 | kfree(container_of(kref,struct tipc_subscriber, kref)); |
00bc00a9 YX |
156 | } |
157 | ||
158 | static void tipc_subscrb_put(struct tipc_subscriber *subscriber) | |
159 | { | |
160 | kref_put(&subscriber->kref, tipc_subscrb_kref_release); | |
161 | } | |
162 | ||
163 | static void tipc_subscrb_get(struct tipc_subscriber *subscriber) | |
164 | { | |
165 | kref_get(&subscriber->kref); | |
eb409460 LC |
166 | } |
167 | ||
d094c4d5 PB |
168 | static void tipc_subscrp_kref_release(struct kref *kref) |
169 | { | |
170 | struct tipc_subscription *sub = container_of(kref, | |
171 | struct tipc_subscription, | |
172 | kref); | |
173 | struct tipc_net *tn = net_generic(sub->net, tipc_net_id); | |
174 | struct tipc_subscriber *subscriber = sub->subscriber; | |
175 | ||
d094c4d5 | 176 | atomic_dec(&tn->subscription_count); |
d094c4d5 PB |
177 | kfree(sub); |
178 | tipc_subscrb_put(subscriber); | |
179 | } | |
180 | ||
7efea60d | 181 | void tipc_subscrp_put(struct tipc_subscription *subscription) |
d094c4d5 PB |
182 | { |
183 | kref_put(&subscription->kref, tipc_subscrp_kref_release); | |
184 | } | |
185 | ||
7efea60d | 186 | void tipc_subscrp_get(struct tipc_subscription *subscription) |
d094c4d5 PB |
187 | { |
188 | kref_get(&subscription->kref); | |
189 | } | |
190 | ||
191 | /* tipc_subscrb_subscrp_delete - delete a specific subscription or all | |
192 | * subscriptions for a given subscriber. | |
193 | */ | |
194 | static void tipc_subscrb_subscrp_delete(struct tipc_subscriber *subscriber, | |
195 | struct tipc_subscr *s) | |
196 | { | |
197 | struct list_head *subscription_list = &subscriber->subscrp_list; | |
198 | struct tipc_subscription *sub, *temp; | |
458be024 | 199 | u32 timeout; |
d094c4d5 PB |
200 | |
201 | spin_lock_bh(&subscriber->lock); | |
202 | list_for_each_entry_safe(sub, temp, subscription_list, subscrp_list) { | |
203 | if (s && memcmp(s, &sub->evt.s, sizeof(struct tipc_subscr))) | |
204 | continue; | |
205 | ||
458be024 PB |
206 | timeout = htohl(sub->evt.s.timeout, sub->swap); |
207 | if (timeout == TIPC_WAIT_FOREVER || del_timer(&sub->timer)) { | |
208 | tipc_nametbl_unsubscribe(sub); | |
209 | list_del(&sub->subscrp_list); | |
210 | tipc_subscrp_put(sub); | |
211 | } | |
d094c4d5 PB |
212 | |
213 | if (s) | |
214 | break; | |
215 | } | |
216 | spin_unlock_bh(&subscriber->lock); | |
217 | } | |
218 | ||
1b764828 YX |
219 | static struct tipc_subscriber *tipc_subscrb_create(int conid) |
220 | { | |
221 | struct tipc_subscriber *subscriber; | |
222 | ||
223 | subscriber = kzalloc(sizeof(*subscriber), GFP_ATOMIC); | |
224 | if (!subscriber) { | |
225 | pr_warn("Subscriber rejected, no memory\n"); | |
226 | return NULL; | |
227 | } | |
228 | INIT_LIST_HEAD(&subscriber->subscrp_list); | |
d094c4d5 | 229 | kref_init(&subscriber->kref); |
1b764828 YX |
230 | subscriber->conid = conid; |
231 | spin_lock_init(&subscriber->lock); | |
232 | ||
233 | return subscriber; | |
234 | } | |
235 | ||
57f1d186 | 236 | static void tipc_subscrb_delete(struct tipc_subscriber *subscriber) |
13a2e898 | 237 | { |
d094c4d5 | 238 | tipc_subscrb_subscrp_delete(subscriber, NULL); |
00bc00a9 YX |
239 | tipc_subscrb_put(subscriber); |
240 | } | |
241 | ||
57f1d186 YX |
242 | static void tipc_subscrp_cancel(struct tipc_subscr *s, |
243 | struct tipc_subscriber *subscriber) | |
eb409460 | 244 | { |
fd849b7c | 245 | tipc_subscrb_get(subscriber); |
d094c4d5 | 246 | tipc_subscrb_subscrp_delete(subscriber, s); |
fd849b7c | 247 | tipc_subscrb_put(subscriber); |
eb409460 LC |
248 | } |
249 | ||
7c13c622 PB |
250 | static struct tipc_subscription *tipc_subscrp_create(struct net *net, |
251 | struct tipc_subscr *s, | |
c8beccc6 | 252 | int swap) |
a62fbcce YX |
253 | { |
254 | struct tipc_net *tn = net_generic(net, tipc_net_id); | |
fead3909 | 255 | struct tipc_subscription *sub; |
c8beccc6 | 256 | u32 filter = htohl(s->filter, swap); |
eb409460 | 257 | |
b97bf3fd | 258 | /* Refuse subscription if global limit exceeded */ |
a62fbcce | 259 | if (atomic_read(&tn->subscription_count) >= TIPC_MAX_SUBSCRIPTIONS) { |
2cf8aa19 | 260 | pr_warn("Subscription rejected, limit reached (%u)\n", |
34f256cc | 261 | TIPC_MAX_SUBSCRIPTIONS); |
7c13c622 | 262 | return NULL; |
b97bf3fd PL |
263 | } |
264 | ||
265 | /* Allocate subscription object */ | |
28353e7f | 266 | sub = kmalloc(sizeof(*sub), GFP_ATOMIC); |
a10bd924 | 267 | if (!sub) { |
2cf8aa19 | 268 | pr_warn("Subscription rejected, no memory\n"); |
7c13c622 | 269 | return NULL; |
b97bf3fd PL |
270 | } |
271 | ||
b97bf3fd | 272 | /* Initialize subscription object */ |
4ac1c8d0 | 273 | sub->net = net; |
30865231 | 274 | if (((filter & TIPC_SUB_PORTS) && (filter & TIPC_SUB_SERVICE)) || |
a4273c73 | 275 | (htohl(s->seq.lower, swap) > htohl(s->seq.upper, swap))) { |
2cf8aa19 | 276 | pr_warn("Subscription rejected, illegal request\n"); |
b97bf3fd | 277 | kfree(sub); |
7c13c622 | 278 | return NULL; |
b97bf3fd | 279 | } |
30865231 | 280 | |
db5a753b | 281 | sub->swap = swap; |
57f1d186 | 282 | memcpy(&sub->evt.s, s, sizeof(*s)); |
a62fbcce | 283 | atomic_inc(&tn->subscription_count); |
d094c4d5 | 284 | kref_init(&sub->kref); |
7c13c622 PB |
285 | return sub; |
286 | } | |
287 | ||
288 | static void tipc_subscrp_subscribe(struct net *net, struct tipc_subscr *s, | |
c8beccc6 | 289 | struct tipc_subscriber *subscriber, int swap) |
7c13c622 PB |
290 | { |
291 | struct tipc_net *tn = net_generic(net, tipc_net_id); | |
292 | struct tipc_subscription *sub = NULL; | |
293 | u32 timeout; | |
294 | ||
c8beccc6 | 295 | sub = tipc_subscrp_create(net, s, swap); |
7c13c622 PB |
296 | if (!sub) |
297 | return tipc_conn_terminate(tn->topsrv, subscriber->conid); | |
298 | ||
299 | spin_lock_bh(&subscriber->lock); | |
300 | list_add(&sub->subscrp_list, &subscriber->subscrp_list); | |
d4091899 PB |
301 | sub->subscriber = subscriber; |
302 | tipc_nametbl_subscribe(sub); | |
d094c4d5 | 303 | tipc_subscrb_get(subscriber); |
7c13c622 PB |
304 | spin_unlock_bh(&subscriber->lock); |
305 | ||
31b102bb | 306 | timer_setup(&sub->timer, tipc_subscrp_timeout, 0); |
c8beccc6 | 307 | timeout = htohl(sub->evt.s.timeout, swap); |
ae245557 | 308 | |
d094c4d5 PB |
309 | if (timeout != TIPC_WAIT_FOREVER) |
310 | mod_timer(&sub->timer, jiffies + msecs_to_jiffies(timeout)); | |
b97bf3fd PL |
311 | } |
312 | ||
13a2e898 | 313 | /* Handle one termination request for the subscriber */ |
333f7962 | 314 | static void tipc_subscrb_release_cb(int conid, void *usr_data) |
b97bf3fd | 315 | { |
57f1d186 | 316 | tipc_subscrb_delete((struct tipc_subscriber *)usr_data); |
b97bf3fd PL |
317 | } |
318 | ||
13a2e898 | 319 | /* Handle one request to create a new subscription for the subscriber */ |
57f1d186 YX |
320 | static void tipc_subscrb_rcv_cb(struct net *net, int conid, |
321 | struct sockaddr_tipc *addr, void *usr_data, | |
322 | void *buf, size_t len) | |
b97bf3fd | 323 | { |
c8beccc6 PB |
324 | struct tipc_subscriber *subscriber = usr_data; |
325 | struct tipc_subscr *s = (struct tipc_subscr *)buf; | |
326 | int swap; | |
327 | ||
328 | /* Determine subscriber's endianness */ | |
cb01c7c8 PB |
329 | swap = !(s->filter & (TIPC_SUB_PORTS | TIPC_SUB_SERVICE | |
330 | TIPC_SUB_CANCEL)); | |
c8beccc6 PB |
331 | |
332 | /* Detect & process a subscription cancellation request */ | |
333 | if (s->filter & htohl(TIPC_SUB_CANCEL, swap)) { | |
334 | s->filter &= ~htohl(TIPC_SUB_CANCEL, swap); | |
335 | return tipc_subscrp_cancel(s, subscriber); | |
336 | } | |
337 | ||
b4358657 | 338 | tipc_subscrp_subscribe(net, s, subscriber, swap); |
b97bf3fd PL |
339 | } |
340 | ||
13a2e898 | 341 | /* Handle one request to establish a new subscriber */ |
57f1d186 | 342 | static void *tipc_subscrb_connect_cb(int conid) |
b97bf3fd | 343 | { |
1b764828 | 344 | return (void *)tipc_subscrb_create(conid); |
b97bf3fd PL |
345 | } |
346 | ||
57f1d186 | 347 | int tipc_topsrv_start(struct net *net) |
b97bf3fd | 348 | { |
a62fbcce YX |
349 | struct tipc_net *tn = net_generic(net, tipc_net_id); |
350 | const char name[] = "topology_server"; | |
351 | struct tipc_server *topsrv; | |
352 | struct sockaddr_tipc *saddr; | |
353 | ||
354 | saddr = kzalloc(sizeof(*saddr), GFP_ATOMIC); | |
355 | if (!saddr) | |
356 | return -ENOMEM; | |
357 | saddr->family = AF_TIPC; | |
358 | saddr->addrtype = TIPC_ADDR_NAMESEQ; | |
359 | saddr->addr.nameseq.type = TIPC_TOP_SRV; | |
360 | saddr->addr.nameseq.lower = TIPC_TOP_SRV; | |
361 | saddr->addr.nameseq.upper = TIPC_TOP_SRV; | |
362 | saddr->scope = TIPC_NODE_SCOPE; | |
363 | ||
364 | topsrv = kzalloc(sizeof(*topsrv), GFP_ATOMIC); | |
365 | if (!topsrv) { | |
366 | kfree(saddr); | |
367 | return -ENOMEM; | |
368 | } | |
369 | topsrv->net = net; | |
370 | topsrv->saddr = saddr; | |
371 | topsrv->imp = TIPC_CRITICAL_IMPORTANCE; | |
372 | topsrv->type = SOCK_SEQPACKET; | |
373 | topsrv->max_rcvbuf_size = sizeof(struct tipc_subscr); | |
57f1d186 YX |
374 | topsrv->tipc_conn_recvmsg = tipc_subscrb_rcv_cb; |
375 | topsrv->tipc_conn_new = tipc_subscrb_connect_cb; | |
333f7962 | 376 | topsrv->tipc_conn_release = tipc_subscrb_release_cb; |
a62fbcce YX |
377 | |
378 | strncpy(topsrv->name, name, strlen(name) + 1); | |
379 | tn->topsrv = topsrv; | |
380 | atomic_set(&tn->subscription_count, 0); | |
381 | ||
382 | return tipc_server_start(topsrv); | |
b97bf3fd PL |
383 | } |
384 | ||
57f1d186 | 385 | void tipc_topsrv_stop(struct net *net) |
b97bf3fd | 386 | { |
a62fbcce YX |
387 | struct tipc_net *tn = net_generic(net, tipc_net_id); |
388 | struct tipc_server *topsrv = tn->topsrv; | |
389 | ||
390 | tipc_server_stop(topsrv); | |
391 | kfree(topsrv->saddr); | |
392 | kfree(topsrv); | |
b97bf3fd | 393 | } |