net/tipc/subscr.c

   1 /*
   2  * net/tipc/subscr.c: TIPC network topology service
   3  *
   4  * Copyright (c) 2000-2006, Ericsson AB
   5  * Copyright (c) 2005-2007, 2010-2013, Wind River Systems
   6  * All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions are met:
  10  *
  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.
  19  *
  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
  34  * POSSIBILITY OF SUCH DAMAGE.
  35  */
  36
  37 #include "core.h"
  38 #include "name_table.h"
  39 #include "subscr.h"
  40
  41 /**
  42  * struct tipc_subscriber - TIPC network topology subscriber
  43  * @kref: reference counter to tipc_subscription object
  44  * @conid: connection identifier to server connecting to subscriber
  45  * @lock: control access to subscriber
  46  * @subscrp_list: list of subscription objects for this subscriber
  47  */
  48 struct tipc_subscriber {
  49         struct kref kref;
  50         int conid;
  51         spinlock_t lock;
  52         struct list_head subscrp_list;
  53 };
  54
  55 static void tipc_subscrp_delete(struct tipc_subscription *sub);
  56 static void tipc_subscrb_put(struct tipc_subscriber *subscriber);
  57
  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  */
  65 static u32 htohl(u32 in, int swap)
  66 {
  67         return swap ? swab32(in) : in;
  68 }
  69
  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)
  73 {
  74         struct tipc_net *tn = net_generic(sub->net, tipc_net_id);
  75         struct tipc_subscriber *subscriber = sub->subscriber;
  76         struct kvec msg_sect;
  77
  78         msg_sect.iov_base = (void *)&sub->evt;
  79         msg_sect.iov_len = sizeof(struct tipc_event);
  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);
  85         tipc_conn_sendmsg(tn->topsrv, subscriber->conid, NULL,
  86                           msg_sect.iov_base, msg_sect.iov_len);
  87 }
  88
  89 /**
  90  * tipc_subscrp_check_overlap - test for subscription overlap with the
  91  * given values
  92  *
  93  * Returns 1 if there is overlap, otherwise 0.
  94  */
  95 int tipc_subscrp_check_overlap(struct tipc_name_seq *seq, u32 found_lower,
  96                                u32 found_upper)
  97 {
  98         if (found_lower < seq->lower)
  99                 found_lower = seq->lower;
 100         if (found_upper > seq->upper)
 101                 found_upper = seq->upper;
 102         if (found_lower > found_upper)
 103                 return 0;
 104         return 1;
 105 }
 106
 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
 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)
 123 {
 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))
 128                 return;
 129         if (!must &&
 130             !(htohl(sub->evt.s.filter, sub->swap) & TIPC_SUB_PORTS))
 131                 return;
 132
 133         tipc_subscrp_send_event(sub, found_lower, found_upper, event, port_ref,
 134                                 node);
 135 }
 136
 137 static void tipc_subscrp_timeout(unsigned long data)
 138 {
 139         struct tipc_subscription *sub = (struct tipc_subscription *)data;
 140         struct tipc_subscriber *subscriber = sub->subscriber;
 141
 142         spin_lock_bh(&subscriber->lock);
 143         tipc_nametbl_unsubscribe(sub);
 144         list_del(&sub->subscrp_list);
 145         spin_unlock_bh(&subscriber->lock);
 146
 147         /* Notify subscriber of timeout */
 148         tipc_subscrp_send_event(sub, sub->evt.s.seq.lower, sub->evt.s.seq.upper,
 149                                 TIPC_SUBSCR_TIMEOUT, 0, 0);
 150
 151         tipc_subscrp_put(sub);
 152 }
 153
 154 static void tipc_subscrb_kref_release(struct kref *kref)
 155 {
 156         kfree(container_of(kref,struct tipc_subscriber, kref));
 157 }
 158
 159 static void tipc_subscrb_put(struct tipc_subscriber *subscriber)
 160 {
 161         kref_put(&subscriber->kref, tipc_subscrb_kref_release);
 162 }
 163
 164 static void tipc_subscrb_get(struct tipc_subscriber *subscriber)
 165 {
 166         kref_get(&subscriber->kref);
 167 }
 168
 169 static void tipc_subscrp_kref_release(struct kref *kref)
 170 {
 171         struct tipc_subscription *sub = container_of(kref,
 172                                                      struct tipc_subscription,
 173                                                      kref);
 174         struct tipc_net *tn = net_generic(sub->net, tipc_net_id);
 175         struct tipc_subscriber *subscriber = sub->subscriber;
 176
 177         atomic_dec(&tn->subscription_count);
 178         kfree(sub);
 179         tipc_subscrb_put(subscriber);
 180 }
 181
 182 void tipc_subscrp_put(struct tipc_subscription *subscription)
 183 {
 184         kref_put(&subscription->kref, tipc_subscrp_kref_release);
 185 }
 186
 187 void tipc_subscrp_get(struct tipc_subscription *subscription)
 188 {
 189         kref_get(&subscription->kref);
 190 }
 191
 192 /* tipc_subscrb_subscrp_delete - delete a specific subscription or all
 193  * subscriptions for a given subscriber.
 194  */
 195 static void tipc_subscrb_subscrp_delete(struct tipc_subscriber *subscriber,
 196                                         struct tipc_subscr *s)
 197 {
 198         struct list_head *subscription_list = &subscriber->subscrp_list;
 199         struct tipc_subscription *sub, *temp;
 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
 206                 tipc_nametbl_unsubscribe(sub);
 207                 list_del(&sub->subscrp_list);
 208                 tipc_subscrp_delete(sub);
 209
 210                 if (s)
 211                         break;
 212         }
 213         spin_unlock_bh(&subscriber->lock);
 214 }
 215
 216 static struct tipc_subscriber *tipc_subscrb_create(int conid)
 217 {
 218         struct tipc_subscriber *subscriber;
 219
 220         subscriber = kzalloc(sizeof(*subscriber), GFP_ATOMIC);
 221         if (!subscriber) {
 222                 pr_warn("Subscriber rejected, no memory\n");
 223                 return NULL;
 224         }
 225         INIT_LIST_HEAD(&subscriber->subscrp_list);
 226         kref_init(&subscriber->kref);
 227         subscriber->conid = conid;
 228         spin_lock_init(&subscriber->lock);
 229
 230         return subscriber;
 231 }
 232
 233 static void tipc_subscrb_delete(struct tipc_subscriber *subscriber)
 234 {
 235         tipc_subscrb_subscrp_delete(subscriber, NULL);
 236         tipc_subscrb_put(subscriber);
 237 }
 238
 239 static void tipc_subscrp_delete(struct tipc_subscription *sub)
 240 {
 241         u32 timeout = htohl(sub->evt.s.timeout, sub->swap);
 242
 243         if (timeout == TIPC_WAIT_FOREVER || del_timer(&sub->timer))
 244                 tipc_subscrp_put(sub);
 245 }
 246
 247 static void tipc_subscrp_cancel(struct tipc_subscr *s,
 248                                 struct tipc_subscriber *subscriber)
 249 {
 250         tipc_subscrb_subscrp_delete(subscriber, s);
 251 }
 252
 253 static struct tipc_subscription *tipc_subscrp_create(struct net *net,
 254                                                      struct tipc_subscr *s,
 255                                                      int swap)
 256 {
 257         struct tipc_net *tn = net_generic(net, tipc_net_id);
 258         struct tipc_subscription *sub;
 259         u32 filter = htohl(s->filter, swap);
 260
 261         /* Refuse subscription if global limit exceeded */
 262         if (atomic_read(&tn->subscription_count) >= TIPC_MAX_SUBSCRIPTIONS) {
 263                 pr_warn("Subscription rejected, limit reached (%u)\n",
 264                         TIPC_MAX_SUBSCRIPTIONS);
 265                 return NULL;
 266         }
 267
 268         /* Allocate subscription object */
 269         sub = kmalloc(sizeof(*sub), GFP_ATOMIC);
 270         if (!sub) {
 271                 pr_warn("Subscription rejected, no memory\n");
 272                 return NULL;
 273         }
 274
 275         /* Initialize subscription object */
 276         sub->net = net;
 277         if (((filter & TIPC_SUB_PORTS) && (filter & TIPC_SUB_SERVICE)) ||
 278             (htohl(s->seq.lower, swap) > htohl(s->seq.upper, swap))) {
 279                 pr_warn("Subscription rejected, illegal request\n");
 280                 kfree(sub);
 281                 return NULL;
 282         }
 283
 284         sub->swap = swap;
 285         memcpy(&sub->evt.s, s, sizeof(*s));
 286         atomic_inc(&tn->subscription_count);
 287         kref_init(&sub->kref);
 288         return sub;
 289 }
 290
 291 static void tipc_subscrp_subscribe(struct net *net, struct tipc_subscr *s,
 292                                    struct tipc_subscriber *subscriber, int swap)
 293 {
 294         struct tipc_net *tn = net_generic(net, tipc_net_id);
 295         struct tipc_subscription *sub = NULL;
 296         u32 timeout;
 297
 298         sub = tipc_subscrp_create(net, s, swap);
 299         if (!sub)
 300                 return tipc_conn_terminate(tn->topsrv, subscriber->conid);
 301
 302         spin_lock_bh(&subscriber->lock);
 303         list_add(&sub->subscrp_list, &subscriber->subscrp_list);
 304         sub->subscriber = subscriber;
 305         tipc_nametbl_subscribe(sub);
 306         tipc_subscrb_get(subscriber);
 307         spin_unlock_bh(&subscriber->lock);
 308
 309         setup_timer(&sub->timer, tipc_subscrp_timeout, (unsigned long)sub);
 310         timeout = htohl(sub->evt.s.timeout, swap);
 311
 312         if (timeout != TIPC_WAIT_FOREVER)
 313                 mod_timer(&sub->timer, jiffies + msecs_to_jiffies(timeout));
 314 }
 315
 316 /* Handle one termination request for the subscriber */
 317 static void tipc_subscrb_release_cb(int conid, void *usr_data)
 318 {
 319         tipc_subscrb_delete((struct tipc_subscriber *)usr_data);
 320 }
 321
 322 /* Handle one request to create a new subscription for the subscriber */
 323 static void tipc_subscrb_rcv_cb(struct net *net, int conid,
 324                                 struct sockaddr_tipc *addr, void *usr_data,
 325                                 void *buf, size_t len)
 326 {
 327         struct tipc_subscriber *subscriber = usr_data;
 328         struct tipc_subscr *s = (struct tipc_subscr *)buf;
 329         int swap;
 330
 331         /* Determine subscriber's endianness */
 332         swap = !(s->filter & (TIPC_SUB_PORTS | TIPC_SUB_SERVICE |
 333                               TIPC_SUB_CANCEL));
 334
 335         /* Detect & process a subscription cancellation request */
 336         if (s->filter & htohl(TIPC_SUB_CANCEL, swap)) {
 337                 s->filter &= ~htohl(TIPC_SUB_CANCEL, swap);
 338                 return tipc_subscrp_cancel(s, subscriber);
 339         }
 340
 341         tipc_subscrp_subscribe(net, s, subscriber, swap);
 342 }
 343
 344 /* Handle one request to establish a new subscriber */
 345 static void *tipc_subscrb_connect_cb(int conid)
 346 {
 347         return (void *)tipc_subscrb_create(conid);
 348 }
 349
 350 int tipc_topsrv_start(struct net *net)
 351 {
 352         struct tipc_net *tn = net_generic(net, tipc_net_id);
 353         const char name[] = "topology_server";
 354         struct tipc_server *topsrv;
 355         struct sockaddr_tipc *saddr;
 356
 357         saddr = kzalloc(sizeof(*saddr), GFP_ATOMIC);
 358         if (!saddr)
 359                 return -ENOMEM;
 360         saddr->family                   = AF_TIPC;
 361         saddr->addrtype                 = TIPC_ADDR_NAMESEQ;
 362         saddr->addr.nameseq.type        = TIPC_TOP_SRV;
 363         saddr->addr.nameseq.lower       = TIPC_TOP_SRV;
 364         saddr->addr.nameseq.upper       = TIPC_TOP_SRV;
 365         saddr->scope                    = TIPC_NODE_SCOPE;
 366
 367         topsrv = kzalloc(sizeof(*topsrv), GFP_ATOMIC);
 368         if (!topsrv) {
 369                 kfree(saddr);
 370                 return -ENOMEM;
 371         }
 372         topsrv->net                     = net;
 373         topsrv->saddr                   = saddr;
 374         topsrv->imp                     = TIPC_CRITICAL_IMPORTANCE;
 375         topsrv->type                    = SOCK_SEQPACKET;
 376         topsrv->max_rcvbuf_size         = sizeof(struct tipc_subscr);
 377         topsrv->tipc_conn_recvmsg       = tipc_subscrb_rcv_cb;
 378         topsrv->tipc_conn_new           = tipc_subscrb_connect_cb;
 379         topsrv->tipc_conn_release       = tipc_subscrb_release_cb;
 380
 381         strncpy(topsrv->name, name, strlen(name) + 1);
 382         tn->topsrv = topsrv;
 383         atomic_set(&tn->subscription_count, 0);
 384
 385         return tipc_server_start(topsrv);
 386 }
 387
 388 void tipc_topsrv_stop(struct net *net)
 389 {
 390         struct tipc_net *tn = net_generic(net, tipc_net_id);
 391         struct tipc_server *topsrv = tn->topsrv;
 392
 393         tipc_server_stop(topsrv);
 394         kfree(topsrv->saddr);
 395         kfree(topsrv);
 396 }