1 /* 2 * net/tipc/subscr.h: Include file for TIPC network topology service 3 * 4 * Copyright (c) 2003-2017, Ericsson AB 5 * Copyright (c) 2005-2007, 2012-2013, Wind River Systems 6 * Copyright (c) 2020, Red Hat Inc 7 * All rights reserved. 8 * 9 * Redistribution and use in source and binary forms, with or without 10 * modification, are permitted provided that the following conditions are met: 11 * 12 * 1. Redistributions of source code must retain the above copyright 13 * notice, this list of conditions and the following disclaimer. 14 * 2. Redistributions in binary form must reproduce the above copyright 15 * notice, this list of conditions and the following disclaimer in the 16 * documentation and/or other materials provided with the distribution. 17 * 3. Neither the names of the copyright holders nor the names of its 18 * contributors may be used to endorse or promote products derived from 19 * this software without specific prior written permission. 20 * 21 * Alternatively, this software may be distributed under the terms of the 22 * GNU General Public License ("GPL") version 2 as published by the Free 23 * Software Foundation. 24 * 25 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 26 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 27 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 28 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE 29 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 30 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 31 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 32 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 33 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 34 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 35 * POSSIBILITY OF SUCH DAMAGE. 36 */ 37 38 #ifndef _TIPC_SUBSCR_H 39 #define _TIPC_SUBSCR_H 40 41 #include "topsrv.h" 42 43 #define TIPC_MAX_SUBSCR 65535 44 #define TIPC_MAX_PUBL 65535 45 46 struct tipc_subscription; 47 struct tipc_conn; 48 49 /** 50 * struct tipc_subscription - TIPC network topology subscription object 51 * @kref: reference count for this subscription 52 * @net: network namespace associated with subscription 53 * @timer: timer governing subscription duration (optional) 54 * @service_list: adjacent subscriptions in name sequence's subscription list 55 * @sub_list: adjacent subscriptions in subscriber's subscription list 56 * @evt: template for events generated by subscription 57 * @conid: connection identifier of topology server 58 * @inactive: true if this subscription is inactive 59 * @lock: serialize up/down and timer events 60 */ 61 struct tipc_subscription { 62 struct kref kref; 63 struct net *net; 64 struct timer_list timer; 65 struct list_head service_list; 66 struct list_head sub_list; 67 struct tipc_event evt; 68 int conid; 69 bool inactive; 70 spinlock_t lock; 71 }; 72 73 struct tipc_subscription *tipc_sub_subscribe(struct net *net, 74 struct tipc_subscr *s, 75 int conid); 76 void tipc_sub_unsubscribe(struct tipc_subscription *sub); 77 78 int tipc_sub_check_overlap(struct tipc_service_range *seq, 79 u32 found_lower, u32 found_upper); 80 void tipc_sub_report_overlap(struct tipc_subscription *sub, 81 u32 found_lower, u32 found_upper, 82 u32 event, u32 port, u32 node, 83 u32 scope, int must); 84 85 int __net_init tipc_topsrv_init_net(struct net *net); 86 void __net_exit tipc_topsrv_exit_net(struct net *net); 87 88 void tipc_sub_put(struct tipc_subscription *subscription); 89 void tipc_sub_get(struct tipc_subscription *subscription); 90 91 #define TIPC_FILTER_MASK (TIPC_SUB_PORTS | TIPC_SUB_SERVICE | TIPC_SUB_CANCEL) 92 93 /* tipc_sub_read - return field_ of struct sub_ in host endian format 94 */ 95 #define tipc_sub_read(sub_, field_) \ 96 ({ \ 97 struct tipc_subscr *sub__ = sub_; \ 98 u32 val__ = (sub__)->field_; \ 99 int swap_ = !((sub__)->filter & TIPC_FILTER_MASK); \ 100 (swap_ ? swab32(val__) : val__); \ 101 }) 102 103 /* tipc_sub_write - write val_ to field_ of struct sub_ in user endian format 104 */ 105 #define tipc_sub_write(sub_, field_, val_) \ 106 ({ \ 107 struct tipc_subscr *sub__ = sub_; \ 108 u32 val__ = val_; \ 109 int swap_ = !((sub__)->filter & TIPC_FILTER_MASK); \ 110 (sub__)->field_ = swap_ ? swab32(val__) : val__; \ 111 }) 112 113 /* tipc_evt_write - write val_ to field_ of struct evt_ in user endian format 114 */ 115 #define tipc_evt_write(evt_, field_, val_) \ 116 ({ \ 117 struct tipc_event *evt__ = evt_; \ 118 u32 val__ = val_; \ 119 int swap_ = !((evt__)->s.filter & (TIPC_FILTER_MASK)); \ 120 (evt__)->field_ = swap_ ? swab32(val__) : val__; \ 121 }) 122 123 #endif 124