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 |
b97bf3fd PL |
6 | * All rights reserved. |
7 | * | |
9ea1fd3c | 8 | * Redistribution and use in source and binary forms, with or without |
b97bf3fd PL |
9 | * modification, are permitted provided that the following conditions are met: |
10 | * | |
9ea1fd3c PL |
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. | |
b97bf3fd | 19 | * |
9ea1fd3c PL |
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 | |
b97bf3fd PL |
34 | * POSSIBILITY OF SUCH DAMAGE. |
35 | */ | |
36 | ||
37 | #ifndef _TIPC_SUBSCR_H | |
38 | #define _TIPC_SUBSCR_H | |
39 | ||
026321c6 | 40 | #include "topsrv.h" |
13a2e898 | 41 | |
242e82cc | 42 | #define TIPC_MAX_SUBSCR 65535 |
218527fe | 43 | #define TIPC_MAX_PUBL 65535 |
859fc7c0 | 44 | |
fead3909 | 45 | struct tipc_subscription; |
df79d040 | 46 | struct tipc_conn; |
e15f8804 | 47 | |
b97bf3fd | 48 | /** |
fead3909 | 49 | * struct tipc_subscription - TIPC network topology subscription object |
13a2e898 | 50 | * @subscriber: pointer to its subscriber |
b97bf3fd | 51 | * @seq: name sequence associated with subscription |
5b06c85c AS |
52 | * @timer: timer governing subscription duration (optional) |
53 | * @nameseq_list: adjacent subscriptions in name sequence's subscription list | |
da0a75e8 | 54 | * @sub_list: adjacent subscriptions in subscriber's subscription list |
b97bf3fd | 55 | * @evt: template for events generated by subscription |
b97bf3fd | 56 | */ |
fead3909 | 57 | struct tipc_subscription { |
d094c4d5 | 58 | struct kref kref; |
5c45ab24 | 59 | struct net *net; |
5b06c85c | 60 | struct timer_list timer; |
218527fe | 61 | struct list_head service_list; |
da0a75e8 | 62 | struct list_head sub_list; |
b97bf3fd | 63 | struct tipc_event evt; |
df79d040 | 64 | int conid; |
df79d040 JM |
65 | bool inactive; |
66 | spinlock_t lock; /* serialize up/down and timer events */ | |
b97bf3fd PL |
67 | }; |
68 | ||
5c45ab24 | 69 | struct tipc_subscription *tipc_sub_subscribe(struct net *net, |
242e82cc JM |
70 | struct tipc_subscr *s, |
71 | int conid); | |
72 | void tipc_sub_unsubscribe(struct tipc_subscription *sub); | |
8985ecc7 | 73 | |
da0a75e8 JM |
74 | int tipc_sub_check_overlap(struct tipc_name_seq *seq, u32 found_lower, |
75 | u32 found_upper); | |
76 | void tipc_sub_report_overlap(struct tipc_subscription *sub, | |
77 | u32 found_lower, u32 found_upper, | |
78 | u32 event, u32 port, u32 node, | |
79 | u32 scope, int must); | |
526f5b85 JH |
80 | |
81 | int __net_init tipc_topsrv_init_net(struct net *net); | |
82 | void __net_exit tipc_topsrv_exit_net(struct net *net); | |
b97bf3fd | 83 | |
da0a75e8 JM |
84 | void tipc_sub_put(struct tipc_subscription *subscription); |
85 | void tipc_sub_get(struct tipc_subscription *subscription); | |
7efea60d | 86 | |
8985ecc7 JM |
87 | #define TIPC_FILTER_MASK (TIPC_SUB_PORTS | TIPC_SUB_SERVICE | TIPC_SUB_CANCEL) |
88 | ||
89 | /* tipc_sub_read - return field_ of struct sub_ in host endian format | |
90 | */ | |
91 | #define tipc_sub_read(sub_, field_) \ | |
92 | ({ \ | |
93 | struct tipc_subscr *sub__ = sub_; \ | |
94 | u32 val__ = (sub__)->field_; \ | |
95 | int swap_ = !((sub__)->filter & TIPC_FILTER_MASK); \ | |
96 | (swap_ ? swab32(val__) : val__); \ | |
97 | }) | |
98 | ||
99 | /* tipc_evt_write - write val_ to field_ of struct evt_ in user endian format | |
100 | */ | |
101 | #define tipc_evt_write(evt_, field_, val_) \ | |
102 | ({ \ | |
103 | struct tipc_event *evt__ = evt_; \ | |
104 | u32 val__ = val_; \ | |
105 | int swap_ = !((evt__)->s.filter & (TIPC_FILTER_MASK)); \ | |
106 | (evt__)->field_ = swap_ ? swab32(val__) : val__; \ | |
107 | }) | |
108 | ||
b97bf3fd | 109 | #endif |