]> git.proxmox.com Git - mirror_ubuntu-jammy-kernel.git/blame - net/tipc/subscr.h
Merge tag 'overflow-v5.13-rc1' of git://git.kernel.org/pub/scm/linux/kernel/git/kees...
[mirror_ubuntu-jammy-kernel.git] / net / tipc / subscr.h
CommitLineData
b97bf3fd 1/*
5b06c85c 2 * net/tipc/subscr.h: Include file for TIPC network topology service
c4307285 3 *
242e82cc 4 * Copyright (c) 2003-2017, Ericsson AB
13a2e898 5 * Copyright (c) 2005-2007, 2012-2013, Wind River Systems
b6f88d9c 6 * Copyright (c) 2020, Red Hat Inc
b97bf3fd
PL
7 * All rights reserved.
8 *
9ea1fd3c 9 * Redistribution and use in source and binary forms, with or without
b97bf3fd
PL
10 * modification, are permitted provided that the following conditions are met:
11 *
9ea1fd3c
PL
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.
b97bf3fd 20 *
9ea1fd3c
PL
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
b97bf3fd
PL
35 * POSSIBILITY OF SUCH DAMAGE.
36 */
37
38#ifndef _TIPC_SUBSCR_H
39#define _TIPC_SUBSCR_H
40
026321c6 41#include "topsrv.h"
13a2e898 42
242e82cc 43#define TIPC_MAX_SUBSCR 65535
218527fe 44#define TIPC_MAX_PUBL 65535
859fc7c0 45
fead3909 46struct tipc_subscription;
df79d040 47struct tipc_conn;
e15f8804 48
b97bf3fd 49/**
fead3909 50 * struct tipc_subscription - TIPC network topology subscription object
ff10527e
RD
51 * @kref: reference count for this subscription
52 * @net: network namespace associated with subscription
5b06c85c 53 * @timer: timer governing subscription duration (optional)
ff10527e 54 * @service_list: adjacent subscriptions in name sequence's subscription list
da0a75e8 55 * @sub_list: adjacent subscriptions in subscriber's subscription list
b97bf3fd 56 * @evt: template for events generated by subscription
ff10527e
RD
57 * @conid: connection identifier of topology server
58 * @inactive: true if this subscription is inactive
59 * @lock: serialize up/down and timer events
b97bf3fd 60 */
fead3909 61struct tipc_subscription {
d094c4d5 62 struct kref kref;
5c45ab24 63 struct net *net;
5b06c85c 64 struct timer_list timer;
218527fe 65 struct list_head service_list;
da0a75e8 66 struct list_head sub_list;
b97bf3fd 67 struct tipc_event evt;
df79d040 68 int conid;
df79d040 69 bool inactive;
ff10527e 70 spinlock_t lock;
b97bf3fd
PL
71};
72
5c45ab24 73struct tipc_subscription *tipc_sub_subscribe(struct net *net,
242e82cc
JM
74 struct tipc_subscr *s,
75 int conid);
76void tipc_sub_unsubscribe(struct tipc_subscription *sub);
8985ecc7 77
b6f88d9c
JM
78int tipc_sub_check_overlap(struct tipc_service_range *seq,
79 u32 found_lower, u32 found_upper);
da0a75e8
JM
80void 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);
526f5b85
JH
84
85int __net_init tipc_topsrv_init_net(struct net *net);
86void __net_exit tipc_topsrv_exit_net(struct net *net);
b97bf3fd 87
da0a75e8
JM
88void tipc_sub_put(struct tipc_subscription *subscription);
89void tipc_sub_get(struct tipc_subscription *subscription);
7efea60d 90
8985ecc7
JM
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
88690b10
TL
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
8985ecc7
JM
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
b97bf3fd 123#endif