blob: 9b24c9c7e05ac7cd9534aa53bbb17ec95a4a85dc [file] [log] [blame]
Per Lidenb97bf3f2006-01-02 19:04:38 +01001/*
Allan Stephens5b06c85c2008-05-19 13:30:13 -07002 * net/tipc/subscr.c: TIPC network topology service
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +09003 *
Per Liden593a5f22006-01-11 19:14:19 +01004 * Copyright (c) 2000-2006, Ericsson AB
Ying Xue13a2e892013-06-17 10:54:40 -04005 * Copyright (c) 2005-2007, 2010-2013, Wind River Systems
Per Lidenb97bf3f2006-01-02 19:04:38 +01006 * All rights reserved.
7 *
Per Liden9ea1fd32006-01-11 13:30:43 +01008 * Redistribution and use in source and binary forms, with or without
Per Lidenb97bf3f2006-01-02 19:04:38 +01009 * modification, are permitted provided that the following conditions are met:
10 *
Per Liden9ea1fd32006-01-11 13:30:43 +010011 * 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.
Per Lidenb97bf3f2006-01-02 19:04:38 +010019 *
Per Liden9ea1fd32006-01-11 13:30:43 +010020 * 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
Per Lidenb97bf3f2006-01-02 19:04:38 +010034 * POSSIBILITY OF SUCH DAMAGE.
35 */
36
37#include "core.h"
Per Lidenb97bf3f2006-01-02 19:04:38 +010038#include "name_table.h"
Allan Stephens5b06c85c2008-05-19 13:30:13 -070039#include "subscr.h"
Per Lidenb97bf3f2006-01-02 19:04:38 +010040
41/**
Paul Gortmaker11f99902011-12-29 20:49:39 -050042 * struct tipc_subscriber - TIPC network topology subscriber
Ying Xue00bc00a2015-05-04 10:36:46 +080043 * @kref: reference counter to tipc_subscription object
Ying Xue13a2e892013-06-17 10:54:40 -040044 * @conid: connection identifier to server connecting to subscriber
stephen hemminger963a18552014-01-12 12:48:00 -080045 * @lock: control access to subscriber
Ying Xue57f1d182015-05-04 10:36:44 +080046 * @subscrp_list: list of subscription objects for this subscriber
Per Lidenb97bf3f2006-01-02 19:04:38 +010047 */
Paul Gortmaker11f99902011-12-29 20:49:39 -050048struct tipc_subscriber {
Ying Xue00bc00a2015-05-04 10:36:46 +080049 struct kref kref;
Ying Xue13a2e892013-06-17 10:54:40 -040050 int conid;
51 spinlock_t lock;
Ying Xue57f1d182015-05-04 10:36:44 +080052 struct list_head subscrp_list;
Per Lidenb97bf3f2006-01-02 19:04:38 +010053};
54
Ying Xue00bc00a2015-05-04 10:36:46 +080055static void tipc_subscrp_delete(struct tipc_subscription *sub);
56static void tipc_subscrb_put(struct tipc_subscriber *subscriber);
57
Per Lidenb97bf3f2006-01-02 19:04:38 +010058/**
Neil Hormandb5a7532010-10-21 01:06:16 +000059 * 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 */
Neil Hormandb5a7532010-10-21 01:06:16 +000065static u32 htohl(u32 in, int swap)
66{
67 return swap ? swab32(in) : in;
68}
69
Ying Xue57f1d182015-05-04 10:36:44 +080070static void tipc_subscrp_send_event(struct tipc_subscription *sub,
71 u32 found_lower, u32 found_upper,
72 u32 event, u32 port_ref, u32 node)
Per Lidenb97bf3f2006-01-02 19:04:38 +010073{
Ying Xuea62fbcc2015-01-09 15:27:11 +080074 struct tipc_net *tn = net_generic(sub->net, tipc_net_id);
Ying Xue13a2e892013-06-17 10:54:40 -040075 struct tipc_subscriber *subscriber = sub->subscriber;
76 struct kvec msg_sect;
Per Lidenb97bf3f2006-01-02 19:04:38 +010077
78 msg_sect.iov_base = (void *)&sub->evt;
79 msg_sect.iov_len = sizeof(struct tipc_event);
Neil Hormandb5a7532010-10-21 01:06:16 +000080 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);
Ying Xuea62fbcc2015-01-09 15:27:11 +080085 tipc_conn_sendmsg(tn->topsrv, subscriber->conid, NULL,
86 msg_sect.iov_base, msg_sect.iov_len);
Per Lidenb97bf3f2006-01-02 19:04:38 +010087}
88
89/**
Ying Xue57f1d182015-05-04 10:36:44 +080090 * tipc_subscrp_check_overlap - test for subscription overlap with the
91 * given values
Per Lidenb97bf3f2006-01-02 19:04:38 +010092 *
93 * Returns 1 if there is overlap, otherwise 0.
94 */
Ying Xue57f1d182015-05-04 10:36:44 +080095int tipc_subscrp_check_overlap(struct tipc_subscription *sub, u32 found_lower,
96 u32 found_upper)
Per Lidenb97bf3f2006-01-02 19:04:38 +010097{
98 if (found_lower < sub->seq.lower)
99 found_lower = sub->seq.lower;
100 if (found_upper > sub->seq.upper)
101 found_upper = sub->seq.upper;
102 if (found_lower > found_upper)
103 return 0;
104 return 1;
105}
106
Ying Xue57f1d182015-05-04 10:36:44 +0800107void tipc_subscrp_report_overlap(struct tipc_subscription *sub, u32 found_lower,
108 u32 found_upper, u32 event, u32 port_ref,
109 u32 node, int must)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100110{
Ying Xue57f1d182015-05-04 10:36:44 +0800111 if (!tipc_subscrp_check_overlap(sub, found_lower, found_upper))
Per Lidenb97bf3f2006-01-02 19:04:38 +0100112 return;
Lijun Cheneb409462006-10-16 21:59:42 -0700113 if (!must && !(sub->filter & TIPC_SUB_PORTS))
Per Lidenb97bf3f2006-01-02 19:04:38 +0100114 return;
Allan Stephense15f8802008-05-19 13:27:31 -0700115
Ying Xue57f1d182015-05-04 10:36:44 +0800116 tipc_subscrp_send_event(sub, found_lower, found_upper, event, port_ref,
117 node);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100118}
119
Ying Xue57f1d182015-05-04 10:36:44 +0800120static void tipc_subscrp_timeout(unsigned long data)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100121{
Ying Xue2f55c432015-01-09 15:27:00 +0800122 struct tipc_subscription *sub = (struct tipc_subscription *)data;
Ying Xue13a2e892013-06-17 10:54:40 -0400123 struct tipc_subscriber *subscriber = sub->subscriber;
Allan Stephens28353e72008-05-19 13:29:47 -0700124
125 /* Notify subscriber of timeout */
Ying Xue57f1d182015-05-04 10:36:44 +0800126 tipc_subscrp_send_event(sub, sub->evt.s.seq.lower, sub->evt.s.seq.upper,
127 TIPC_SUBSCR_TIMEOUT, 0, 0);
Allan Stephens28353e72008-05-19 13:29:47 -0700128
Ying Xue00bc00a2015-05-04 10:36:46 +0800129 spin_lock_bh(&subscriber->lock);
130 tipc_subscrp_delete(sub);
131 spin_unlock_bh(&subscriber->lock);
132
133 tipc_subscrb_put(subscriber);
134}
135
136static void tipc_subscrb_kref_release(struct kref *kref)
137{
138 struct tipc_subscriber *subcriber = container_of(kref,
139 struct tipc_subscriber, kref);
140
141 kfree(subcriber);
142}
143
144static void tipc_subscrb_put(struct tipc_subscriber *subscriber)
145{
146 kref_put(&subscriber->kref, tipc_subscrb_kref_release);
147}
148
149static void tipc_subscrb_get(struct tipc_subscriber *subscriber)
150{
151 kref_get(&subscriber->kref);
152}
153
154static struct tipc_subscriber *tipc_subscrb_create(int conid)
155{
156 struct tipc_subscriber *subscriber;
157
158 subscriber = kzalloc(sizeof(*subscriber), GFP_ATOMIC);
159 if (!subscriber) {
160 pr_warn("Subscriber rejected, no memory\n");
161 return NULL;
162 }
163 kref_init(&subscriber->kref);
164 INIT_LIST_HEAD(&subscriber->subscrp_list);
165 subscriber->conid = conid;
166 spin_lock_init(&subscriber->lock);
167
168 return subscriber;
169}
170
171static void tipc_subscrb_delete(struct tipc_subscriber *subscriber)
172{
173 struct tipc_subscription *sub, *temp;
174
175 spin_lock_bh(&subscriber->lock);
176 /* Destroy any existing subscriptions for subscriber */
177 list_for_each_entry_safe(sub, temp, &subscriber->subscrp_list,
178 subscrp_list) {
179 if (del_timer(&sub->timer)) {
180 tipc_subscrp_delete(sub);
181 tipc_subscrb_put(subscriber);
182 }
183 }
184 spin_unlock_bh(&subscriber->lock);
185
186 tipc_subscrb_put(subscriber);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100187}
188
Ying Xue57f1d182015-05-04 10:36:44 +0800189static void tipc_subscrp_delete(struct tipc_subscription *sub)
Lijun Cheneb409462006-10-16 21:59:42 -0700190{
Ying Xuea62fbcc2015-01-09 15:27:11 +0800191 struct tipc_net *tn = net_generic(sub->net, tipc_net_id);
192
Lijun Cheneb409462006-10-16 21:59:42 -0700193 tipc_nametbl_unsubscribe(sub);
Ying Xue57f1d182015-05-04 10:36:44 +0800194 list_del(&sub->subscrp_list);
Lijun Cheneb409462006-10-16 21:59:42 -0700195 kfree(sub);
Ying Xuea62fbcc2015-01-09 15:27:11 +0800196 atomic_dec(&tn->subscription_count);
Lijun Cheneb409462006-10-16 21:59:42 -0700197}
198
Ying Xue57f1d182015-05-04 10:36:44 +0800199static void tipc_subscrp_cancel(struct tipc_subscr *s,
200 struct tipc_subscriber *subscriber)
Lijun Cheneb409462006-10-16 21:59:42 -0700201{
Ying Xue00bc00a2015-05-04 10:36:46 +0800202 struct tipc_subscription *sub, *temp;
Lijun Cheneb409462006-10-16 21:59:42 -0700203
204 /* Find first matching subscription, exit if not found */
Ying Xue00bc00a2015-05-04 10:36:46 +0800205 list_for_each_entry_safe(sub, temp, &subscriber->subscrp_list,
Ying Xue57f1d182015-05-04 10:36:44 +0800206 subscrp_list) {
Neil Hormandb5a7532010-10-21 01:06:16 +0000207 if (!memcmp(s, &sub->evt.s, sizeof(struct tipc_subscr))) {
Ying Xue00bc00a2015-05-04 10:36:46 +0800208 if (del_timer(&sub->timer)) {
209 tipc_subscrp_delete(sub);
210 tipc_subscrb_put(subscriber);
211 }
Neil Hormandb5a7532010-10-21 01:06:16 +0000212 break;
213 }
Lijun Cheneb409462006-10-16 21:59:42 -0700214 }
Lijun Cheneb409462006-10-16 21:59:42 -0700215}
216
Ying Xue57f1d182015-05-04 10:36:44 +0800217static int tipc_subscrp_create(struct net *net, struct tipc_subscr *s,
218 struct tipc_subscriber *subscriber,
219 struct tipc_subscription **sub_p)
Ying Xuea62fbcc2015-01-09 15:27:11 +0800220{
221 struct tipc_net *tn = net_generic(net, tipc_net_id);
Paul Gortmakerfead3902011-12-29 20:43:44 -0500222 struct tipc_subscription *sub;
Neil Hormandb5a7532010-10-21 01:06:16 +0000223 int swap;
224
225 /* Determine subscriber's endianness */
Neil Hormandb5a7532010-10-21 01:06:16 +0000226 swap = !(s->filter & (TIPC_SUB_PORTS | TIPC_SUB_SERVICE));
Lijun Cheneb409462006-10-16 21:59:42 -0700227
228 /* Detect & process a subscription cancellation request */
Neil Hormandb5a7532010-10-21 01:06:16 +0000229 if (s->filter & htohl(TIPC_SUB_CANCEL, swap)) {
230 s->filter &= ~htohl(TIPC_SUB_CANCEL, swap);
Ying Xue57f1d182015-05-04 10:36:44 +0800231 tipc_subscrp_cancel(s, subscriber);
Erik Hugnea5d0e7c2014-03-24 16:56:38 +0100232 return 0;
Lijun Cheneb409462006-10-16 21:59:42 -0700233 }
234
Per Lidenb97bf3f2006-01-02 19:04:38 +0100235 /* Refuse subscription if global limit exceeded */
Ying Xuea62fbcc2015-01-09 15:27:11 +0800236 if (atomic_read(&tn->subscription_count) >= TIPC_MAX_SUBSCRIPTIONS) {
Erik Hugne2cf8aa12012-06-29 00:16:37 -0400237 pr_warn("Subscription rejected, limit reached (%u)\n",
Ying Xue34f256c2012-08-16 12:09:13 +0000238 TIPC_MAX_SUBSCRIPTIONS);
Erik Hugnea5d0e7c2014-03-24 16:56:38 +0100239 return -EINVAL;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100240 }
241
242 /* Allocate subscription object */
Allan Stephens28353e72008-05-19 13:29:47 -0700243 sub = kmalloc(sizeof(*sub), GFP_ATOMIC);
Allan Stephensa10bd922006-06-25 23:52:17 -0700244 if (!sub) {
Erik Hugne2cf8aa12012-06-29 00:16:37 -0400245 pr_warn("Subscription rejected, no memory\n");
Erik Hugnea5d0e7c2014-03-24 16:56:38 +0100246 return -ENOMEM;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100247 }
248
Per Lidenb97bf3f2006-01-02 19:04:38 +0100249 /* Initialize subscription object */
Ying Xue4ac1c8d2015-01-09 15:27:09 +0800250 sub->net = net;
Neil Hormandb5a7532010-10-21 01:06:16 +0000251 sub->seq.type = htohl(s->seq.type, swap);
252 sub->seq.lower = htohl(s->seq.lower, swap);
253 sub->seq.upper = htohl(s->seq.upper, swap);
Ying Xue2f55c432015-01-09 15:27:00 +0800254 sub->timeout = msecs_to_jiffies(htohl(s->timeout, swap));
Neil Hormandb5a7532010-10-21 01:06:16 +0000255 sub->filter = htohl(s->filter, swap);
Neil Horman8c974432010-10-21 01:06:15 +0000256 if ((!(sub->filter & TIPC_SUB_PORTS) ==
257 !(sub->filter & TIPC_SUB_SERVICE)) ||
Joe Perchesf64f9e72009-11-29 16:55:45 -0800258 (sub->seq.lower > sub->seq.upper)) {
Erik Hugne2cf8aa12012-06-29 00:16:37 -0400259 pr_warn("Subscription rejected, illegal request\n");
Per Lidenb97bf3f2006-01-02 19:04:38 +0100260 kfree(sub);
Erik Hugnea5d0e7c2014-03-24 16:56:38 +0100261 return -EINVAL;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100262 }
Ying Xue57f1d182015-05-04 10:36:44 +0800263 list_add(&sub->subscrp_list, &subscriber->subscrp_list);
Ying Xue13a2e892013-06-17 10:54:40 -0400264 sub->subscriber = subscriber;
Neil Hormandb5a7532010-10-21 01:06:16 +0000265 sub->swap = swap;
Ying Xue57f1d182015-05-04 10:36:44 +0800266 memcpy(&sub->evt.s, s, sizeof(*s));
Ying Xuea62fbcc2015-01-09 15:27:11 +0800267 atomic_inc(&tn->subscription_count);
Ying Xue00bc00a2015-05-04 10:36:46 +0800268 setup_timer(&sub->timer, tipc_subscrp_timeout, (unsigned long)sub);
269 if (sub->timeout != TIPC_WAIT_FOREVER)
270 sub->timeout += jiffies;
271 if (!mod_timer(&sub->timer, sub->timeout))
272 tipc_subscrb_get(subscriber);
Erik Hugnea5d0e7c2014-03-24 16:56:38 +0100273 *sub_p = sub;
274 return 0;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100275}
276
Ying Xue13a2e892013-06-17 10:54:40 -0400277/* Handle one termination request for the subscriber */
Ying Xue57f1d182015-05-04 10:36:44 +0800278static void tipc_subscrb_shutdown_cb(int conid, void *usr_data)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100279{
Ying Xue57f1d182015-05-04 10:36:44 +0800280 tipc_subscrb_delete((struct tipc_subscriber *)usr_data);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100281}
282
Ying Xue13a2e892013-06-17 10:54:40 -0400283/* Handle one request to create a new subscription for the subscriber */
Ying Xue57f1d182015-05-04 10:36:44 +0800284static void tipc_subscrb_rcv_cb(struct net *net, int conid,
285 struct sockaddr_tipc *addr, void *usr_data,
286 void *buf, size_t len)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100287{
Ying Xue13a2e892013-06-17 10:54:40 -0400288 struct tipc_subscriber *subscriber = usr_data;
Erik Hugnea5d0e7c2014-03-24 16:56:38 +0100289 struct tipc_subscription *sub = NULL;
Erik Hugne7fe80972015-02-27 08:56:55 +0100290 struct tipc_net *tn = net_generic(net, tipc_net_id);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100291
Ying Xue13a2e892013-06-17 10:54:40 -0400292 spin_lock_bh(&subscriber->lock);
Ying Xue57f1d182015-05-04 10:36:44 +0800293 tipc_subscrp_create(net, (struct tipc_subscr *)buf, subscriber, &sub);
Ying Xue13a2e892013-06-17 10:54:40 -0400294 if (sub)
295 tipc_nametbl_subscribe(sub);
Erik Hugne7fe80972015-02-27 08:56:55 +0100296 else
297 tipc_conn_terminate(tn->topsrv, subscriber->conid);
Ying Xue13a2e892013-06-17 10:54:40 -0400298 spin_unlock_bh(&subscriber->lock);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100299}
300
Ying Xue13a2e892013-06-17 10:54:40 -0400301/* Handle one request to establish a new subscriber */
Ying Xue57f1d182015-05-04 10:36:44 +0800302static void *tipc_subscrb_connect_cb(int conid)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100303{
Ying Xue1b764822015-05-04 10:36:45 +0800304 return (void *)tipc_subscrb_create(conid);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100305}
306
Ying Xue57f1d182015-05-04 10:36:44 +0800307int tipc_topsrv_start(struct net *net)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100308{
Ying Xuea62fbcc2015-01-09 15:27:11 +0800309 struct tipc_net *tn = net_generic(net, tipc_net_id);
310 const char name[] = "topology_server";
311 struct tipc_server *topsrv;
312 struct sockaddr_tipc *saddr;
313
314 saddr = kzalloc(sizeof(*saddr), GFP_ATOMIC);
315 if (!saddr)
316 return -ENOMEM;
317 saddr->family = AF_TIPC;
318 saddr->addrtype = TIPC_ADDR_NAMESEQ;
319 saddr->addr.nameseq.type = TIPC_TOP_SRV;
320 saddr->addr.nameseq.lower = TIPC_TOP_SRV;
321 saddr->addr.nameseq.upper = TIPC_TOP_SRV;
322 saddr->scope = TIPC_NODE_SCOPE;
323
324 topsrv = kzalloc(sizeof(*topsrv), GFP_ATOMIC);
325 if (!topsrv) {
326 kfree(saddr);
327 return -ENOMEM;
328 }
329 topsrv->net = net;
330 topsrv->saddr = saddr;
331 topsrv->imp = TIPC_CRITICAL_IMPORTANCE;
332 topsrv->type = SOCK_SEQPACKET;
333 topsrv->max_rcvbuf_size = sizeof(struct tipc_subscr);
Ying Xue57f1d182015-05-04 10:36:44 +0800334 topsrv->tipc_conn_recvmsg = tipc_subscrb_rcv_cb;
335 topsrv->tipc_conn_new = tipc_subscrb_connect_cb;
336 topsrv->tipc_conn_shutdown = tipc_subscrb_shutdown_cb;
Ying Xuea62fbcc2015-01-09 15:27:11 +0800337
338 strncpy(topsrv->name, name, strlen(name) + 1);
339 tn->topsrv = topsrv;
340 atomic_set(&tn->subscription_count, 0);
341
342 return tipc_server_start(topsrv);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100343}
344
Ying Xue57f1d182015-05-04 10:36:44 +0800345void tipc_topsrv_stop(struct net *net)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100346{
Ying Xuea62fbcc2015-01-09 15:27:11 +0800347 struct tipc_net *tn = net_generic(net, tipc_net_id);
348 struct tipc_server *topsrv = tn->topsrv;
349
350 tipc_server_stop(topsrv);
351 kfree(topsrv->saddr);
352 kfree(topsrv);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100353}