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