]>
Commit | Line | Data |
---|---|---|
b97bf3fd PL |
1 | /* |
2 | * net/tipc/port.h: Include file for TIPC port code | |
c4307285 | 3 | * |
8826cde6 | 4 | * Copyright (c) 1994-2007, 2014, Ericsson AB |
198d73b8 | 5 | * Copyright (c) 2004-2007, 2010-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_PORT_H | |
38 | #define _TIPC_PORT_H | |
39 | ||
b97bf3fd PL |
40 | #include "ref.h" |
41 | #include "net.h" | |
42 | #include "msg.h" | |
b97bf3fd PL |
43 | #include "node_subscr.h" |
44 | ||
d265fef6 | 45 | #define TIPC_FLOW_CONTROL_WIN 512 |
cc79dd1b YX |
46 | #define CONN_OVERLOAD_LIMIT ((TIPC_FLOW_CONTROL_WIN * 2 + 1) * \ |
47 | SKB_TRUESIZE(TIPC_MAX_USER_MSG_SIZE)) | |
d265fef6 | 48 | |
d265fef6 | 49 | /** |
23dd4cce | 50 | * struct tipc_port - TIPC port structure |
d265fef6 AS |
51 | * @lock: pointer to spinlock for controlling access to port |
52 | * @connected: non-zero if port is currently connected to a peer port | |
53 | * @conn_type: TIPC type used when connection was established | |
54 | * @conn_instance: TIPC instance used when connection was established | |
55 | * @conn_unacked: number of unacknowledged messages received from peer port | |
56 | * @published: non-zero if port has one or more associated names | |
57 | * @congested: non-zero if cannot send because of link or port congestion | |
58 | * @max_pkt: maximum packet size "hint" used when building messages sent by port | |
59 | * @ref: unique reference to port in TIPC object registry | |
60 | * @phdr: preformatted message header used when sending messages | |
b97bf3fd | 61 | * @port_list: adjacent ports in TIPC's global list of ports |
b97bf3fd | 62 | * @wait_list: adjacent ports in list of ports waiting on link congestion |
b97bf3fd | 63 | * @waiting_pkts: |
cb7ce914 AS |
64 | * @sent: # of non-empty messages sent by port |
65 | * @acked: # of non-empty message acknowledgements from connected port's peer | |
b97bf3fd PL |
66 | * @publications: list of publications for port |
67 | * @pub_count: total # of publications port has made during its lifetime | |
b97bf3fd PL |
68 | * @probing_state: |
69 | * @probing_interval: | |
b97bf3fd PL |
70 | * @timer_ref: |
71 | * @subscription: "node down" subscription used to terminate failed connections | |
72 | */ | |
23dd4cce | 73 | struct tipc_port { |
23dd4cce AS |
74 | spinlock_t *lock; |
75 | int connected; | |
76 | u32 conn_type; | |
77 | u32 conn_instance; | |
78 | u32 conn_unacked; | |
79 | int published; | |
80 | u32 congested; | |
81 | u32 max_pkt; | |
82 | u32 ref; | |
83 | struct tipc_msg phdr; | |
b97bf3fd | 84 | struct list_head port_list; |
b97bf3fd | 85 | struct list_head wait_list; |
b97bf3fd PL |
86 | u32 waiting_pkts; |
87 | u32 sent; | |
88 | u32 acked; | |
89 | struct list_head publications; | |
90 | u32 pub_count; | |
b97bf3fd PL |
91 | u32 probing_state; |
92 | u32 probing_interval; | |
b97bf3fd | 93 | struct timer_list timer; |
6c00055a | 94 | struct tipc_node_subscr subscription; |
b97bf3fd PL |
95 | }; |
96 | ||
4323add6 | 97 | extern spinlock_t tipc_port_list_lock; |
4584310b | 98 | struct tipc_port_list; |
b97bf3fd | 99 | |
d265fef6 AS |
100 | /* |
101 | * TIPC port manipulation routines | |
102 | */ | |
24be34b5 JPM |
103 | u32 tipc_port_init(struct tipc_port *p_ptr, |
104 | const unsigned int importance); | |
d265fef6 AS |
105 | |
106 | int tipc_reject_msg(struct sk_buff *buf, u32 err); | |
107 | ||
d265fef6 AS |
108 | void tipc_acknowledge(u32 port_ref, u32 ack); |
109 | ||
24be34b5 | 110 | void tipc_port_destroy(struct tipc_port *p_ptr); |
d265fef6 | 111 | |
84602761 | 112 | int tipc_publish(struct tipc_port *p_ptr, unsigned int scope, |
ae8509c4 | 113 | struct tipc_name_seq const *name_seq); |
5c311421 | 114 | |
84602761 | 115 | int tipc_withdraw(struct tipc_port *p_ptr, unsigned int scope, |
ae8509c4 | 116 | struct tipc_name_seq const *name_seq); |
d265fef6 | 117 | |
247f0f3c | 118 | int tipc_port_connect(u32 portref, struct tipc_portid const *port); |
d265fef6 | 119 | |
247f0f3c | 120 | int tipc_port_disconnect(u32 portref); |
d265fef6 | 121 | |
247f0f3c | 122 | int tipc_port_shutdown(u32 ref); |
d265fef6 | 123 | |
24be34b5 | 124 | void tipc_port_wakeup(struct tipc_port *port); |
d265fef6 AS |
125 | |
126 | /* | |
127 | * The following routines require that the port be locked on entry | |
128 | */ | |
247f0f3c YX |
129 | int __tipc_port_disconnect(struct tipc_port *tp_ptr); |
130 | int __tipc_port_connect(u32 ref, struct tipc_port *p_ptr, | |
bc879117 | 131 | struct tipc_portid const *peer); |
f0712e86 | 132 | int tipc_port_peer_msg(struct tipc_port *p_ptr, struct tipc_msg *msg); |
d265fef6 AS |
133 | |
134 | /* | |
135 | * TIPC messaging routines | |
136 | */ | |
247f0f3c | 137 | int tipc_port_rcv(struct sk_buff *buf); |
d265fef6 | 138 | |
5c311421 JPM |
139 | int tipc_send(struct tipc_port *port, |
140 | struct iovec const *msg_sect, | |
141 | unsigned int len); | |
142 | ||
143 | int tipc_send2name(struct tipc_port *port, | |
144 | struct tipc_name const *name, | |
145 | u32 domain, | |
146 | struct iovec const *msg_sect, | |
147 | unsigned int len); | |
148 | ||
149 | int tipc_send2port(struct tipc_port *port, | |
150 | struct tipc_portid const *dest, | |
151 | struct iovec const *msg_sect, | |
152 | unsigned int len); | |
153 | ||
154 | int tipc_port_mcast_xmit(struct tipc_port *port, | |
155 | struct tipc_name_seq const *seq, | |
156 | struct iovec const *msg, | |
157 | unsigned int len); | |
158 | ||
159 | int tipc_port_iovec_reject(struct tipc_port *p_ptr, | |
160 | struct tipc_msg *hdr, | |
161 | struct iovec const *msg_sect, | |
162 | unsigned int len, | |
247f0f3c | 163 | int err); |
5c311421 | 164 | |
4323add6 | 165 | struct sk_buff *tipc_port_get_ports(void); |
247f0f3c YX |
166 | void tipc_port_proto_rcv(struct sk_buff *buf); |
167 | void tipc_port_mcast_rcv(struct sk_buff *buf, struct tipc_port_list *dp); | |
4323add6 | 168 | void tipc_port_reinit(void); |
b97bf3fd PL |
169 | |
170 | /** | |
4323add6 | 171 | * tipc_port_lock - lock port instance referred to and return its pointer |
b97bf3fd | 172 | */ |
23dd4cce | 173 | static inline struct tipc_port *tipc_port_lock(u32 ref) |
b97bf3fd | 174 | { |
23dd4cce | 175 | return (struct tipc_port *)tipc_ref_lock(ref); |
b97bf3fd PL |
176 | } |
177 | ||
c4307285 | 178 | /** |
4323add6 | 179 | * tipc_port_unlock - unlock a port instance |
c4307285 | 180 | * |
4323add6 | 181 | * Can use pointer instead of tipc_ref_unlock() since port is already locked. |
b97bf3fd | 182 | */ |
23dd4cce | 183 | static inline void tipc_port_unlock(struct tipc_port *p_ptr) |
b97bf3fd | 184 | { |
23dd4cce | 185 | spin_unlock_bh(p_ptr->lock); |
b97bf3fd PL |
186 | } |
187 | ||
23dd4cce | 188 | static inline int tipc_port_congested(struct tipc_port *p_ptr) |
b97bf3fd | 189 | { |
a02cec21 | 190 | return (p_ptr->sent - p_ptr->acked) >= (TIPC_FLOW_CONTROL_WIN * 2); |
b97bf3fd PL |
191 | } |
192 | ||
f9fef18c JPM |
193 | |
194 | static inline u32 tipc_port_peernode(struct tipc_port *p_ptr) | |
195 | { | |
196 | return msg_destnode(&p_ptr->phdr); | |
197 | } | |
198 | ||
199 | static inline u32 tipc_port_peerport(struct tipc_port *p_ptr) | |
200 | { | |
201 | return msg_destport(&p_ptr->phdr); | |
202 | } | |
203 | ||
3b4f302d JPM |
204 | static inline bool tipc_port_unreliable(struct tipc_port *port) |
205 | { | |
206 | return msg_src_droppable(&port->phdr) != 0; | |
207 | } | |
208 | ||
209 | static inline void tipc_port_set_unreliable(struct tipc_port *port, | |
210 | bool unreliable) | |
211 | { | |
212 | msg_set_src_droppable(&port->phdr, unreliable ? 1 : 0); | |
213 | } | |
214 | ||
215 | static inline bool tipc_port_unreturnable(struct tipc_port *port) | |
216 | { | |
217 | return msg_dest_droppable(&port->phdr) != 0; | |
218 | } | |
219 | ||
220 | static inline void tipc_port_set_unreturnable(struct tipc_port *port, | |
221 | bool unreturnable) | |
222 | { | |
223 | msg_set_dest_droppable(&port->phdr, unreturnable ? 1 : 0); | |
224 | } | |
225 | ||
226 | ||
227 | static inline int tipc_port_importance(struct tipc_port *port) | |
228 | { | |
229 | return msg_importance(&port->phdr); | |
230 | } | |
231 | ||
232 | static inline void tipc_port_set_importance(struct tipc_port *port, int imp) | |
233 | { | |
234 | msg_set_importance(&port->phdr, (u32)imp); | |
235 | } | |
236 | ||
b97bf3fd | 237 | #endif |