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