net/tipc/subscr.h

   1 /*
   2  * net/tipc/subscr.h: Include file for TIPC network topology service
   3  *
   4  * Copyright (c) 2003-2006, Ericsson AB
   5  * Copyright (c) 2005-2007, 2012-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 #ifndef _TIPC_SUBSCR_H
  38 #define _TIPC_SUBSCR_H
  39
  40 #include "server.h"
  41
  42 #define TIPC_MAX_SUBSCRIPTIONS  65535
  43 #define TIPC_MAX_PUBLICATIONS   65535
  44
  45 struct tipc_subscription;
  46 struct tipc_conn;
  47
  48 /**
  49  * struct tipc_subscription - TIPC network topology subscription object
  50  * @subscriber: pointer to its subscriber
  51  * @seq: name sequence associated with subscription
  52  * @net: point to network namespace
  53  * @timer: timer governing subscription duration (optional)
  54  * @nameseq_list: adjacent subscriptions in name sequence's subscription list
  55  * @subscrp_list: adjacent subscriptions in subscriber's subscription list
  56  * @swap: indicates if subscriber uses opposite endianness in its messages
  57  * @evt: template for events generated by subscription
  58  */
  59 struct tipc_subscription {
  60         struct kref kref;
  61         struct net *net;
  62         struct timer_list timer;
  63         struct list_head nameseq_list;
  64         struct list_head subscrp_list;
  65         struct tipc_event evt;
  66         int conid;
  67         bool swap;
  68         bool inactive;
  69         spinlock_t lock; /* serialize up/down and timer events */
  70 };
  71
  72 struct tipc_subscription *tipc_subscrp_subscribe(struct net *net,
  73                                                  struct tipc_subscr *s,
  74                                                  int conid, bool swap,
  75                                                  bool status);
  76 void tipc_sub_delete(struct tipc_subscription *sub);
  77 int tipc_subscrp_check_overlap(struct tipc_name_seq *seq, u32 found_lower,
  78                                u32 found_upper);
  79 void tipc_subscrp_report_overlap(struct tipc_subscription *sub,
  80                                  u32 found_lower, u32 found_upper, u32 event,
  81                                  u32 port_ref, u32 node, u32 scope, int must);
  82 void tipc_subscrp_convert_seq(struct tipc_name_seq *in, int swap,
  83                               struct tipc_name_seq *out);
  84 u32 tipc_subscrp_convert_seq_type(u32 type, int swap);
  85 int tipc_topsrv_start(struct net *net);
  86 void tipc_topsrv_stop(struct net *net);
  87
  88 void tipc_subscrp_put(struct tipc_subscription *subscription);
  89 void tipc_subscrp_get(struct tipc_subscription *subscription);
  90
  91 #endif