Commit | Line | Data |
---|---|---|
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 |
09f78b85 | 6 | * Copyright (c) 2020-2021, 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 | |
09f78b85 | 46 | struct publication; |
fead3909 | 47 | struct tipc_subscription; |
df79d040 | 48 | struct tipc_conn; |
e15f8804 | 49 | |
b97bf3fd | 50 | /** |
fead3909 | 51 | * struct tipc_subscription - TIPC network topology subscription object |
02fdc14d JM |
52 | * @s: host-endian copy of the user subscription |
53 | * @evt: template for events generated by subscription | |
ff10527e RD |
54 | * @kref: reference count for this subscription |
55 | * @net: network namespace associated with subscription | |
5b06c85c | 56 | * @timer: timer governing subscription duration (optional) |
ff10527e | 57 | * @service_list: adjacent subscriptions in name sequence's subscription list |
da0a75e8 | 58 | * @sub_list: adjacent subscriptions in subscriber's subscription list |
ff10527e RD |
59 | * @conid: connection identifier of topology server |
60 | * @inactive: true if this subscription is inactive | |
61 | * @lock: serialize up/down and timer events | |
b97bf3fd | 62 | */ |
fead3909 | 63 | struct tipc_subscription { |
429189ac JM |
64 | struct tipc_subscr s; |
65 | struct tipc_event evt; | |
d094c4d5 | 66 | struct kref kref; |
5c45ab24 | 67 | struct net *net; |
5b06c85c | 68 | struct timer_list timer; |
218527fe | 69 | struct list_head service_list; |
da0a75e8 | 70 | struct list_head sub_list; |
df79d040 | 71 | int conid; |
df79d040 | 72 | bool inactive; |
ff10527e | 73 | spinlock_t lock; |
b97bf3fd PL |
74 | }; |
75 | ||
5c45ab24 | 76 | struct tipc_subscription *tipc_sub_subscribe(struct net *net, |
242e82cc JM |
77 | struct tipc_subscr *s, |
78 | int conid); | |
79 | void tipc_sub_unsubscribe(struct tipc_subscription *sub); | |
da0a75e8 | 80 | void tipc_sub_report_overlap(struct tipc_subscription *sub, |
09f78b85 JM |
81 | struct publication *p, |
82 | u32 event, bool must); | |
526f5b85 JH |
83 | |
84 | int __net_init tipc_topsrv_init_net(struct net *net); | |
85 | void __net_exit tipc_topsrv_exit_net(struct net *net); | |
b97bf3fd | 86 | |
da0a75e8 JM |
87 | void tipc_sub_put(struct tipc_subscription *subscription); |
88 | void tipc_sub_get(struct tipc_subscription *subscription); | |
7efea60d | 89 | |
8985ecc7 JM |
90 | #define TIPC_FILTER_MASK (TIPC_SUB_PORTS | TIPC_SUB_SERVICE | TIPC_SUB_CANCEL) |
91 | ||
92 | /* tipc_sub_read - return field_ of struct sub_ in host endian format | |
93 | */ | |
94 | #define tipc_sub_read(sub_, field_) \ | |
95 | ({ \ | |
96 | struct tipc_subscr *sub__ = sub_; \ | |
97 | u32 val__ = (sub__)->field_; \ | |
98 | int swap_ = !((sub__)->filter & TIPC_FILTER_MASK); \ | |
99 | (swap_ ? swab32(val__) : val__); \ | |
100 | }) | |
101 | ||
88690b10 TL |
102 | /* tipc_sub_write - write val_ to field_ of struct sub_ in user endian format |
103 | */ | |
104 | #define tipc_sub_write(sub_, field_, val_) \ | |
105 | ({ \ | |
106 | struct tipc_subscr *sub__ = sub_; \ | |
107 | u32 val__ = val_; \ | |
108 | int swap_ = !((sub__)->filter & TIPC_FILTER_MASK); \ | |
109 | (sub__)->field_ = swap_ ? swab32(val__) : val__; \ | |
110 | }) | |
111 | ||
8985ecc7 JM |
112 | /* tipc_evt_write - write val_ to field_ of struct evt_ in user endian format |
113 | */ | |
114 | #define tipc_evt_write(evt_, field_, val_) \ | |
115 | ({ \ | |
116 | struct tipc_event *evt__ = evt_; \ | |
117 | u32 val__ = val_; \ | |
118 | int swap_ = !((evt__)->s.filter & (TIPC_FILTER_MASK)); \ | |
119 | (evt__)->field_ = swap_ ? swab32(val__) : val__; \ | |
120 | }) | |
121 | ||
b97bf3fd | 122 | #endif |