]>
Commit | Line | Data |
---|---|---|
b97bf3fd PL |
1 | /* |
2 | * net/tipc/port.h: Include file for TIPC port code | |
c4307285 | 3 | * |
05646c91 AS |
4 | * Copyright (c) 1994-2007, Ericsson AB |
5 | * Copyright (c) 2004-2007, 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 AS |
45 | #define TIPC_FLOW_CONTROL_WIN 512 |
46 | ||
47 | typedef void (*tipc_msg_err_event) (void *usr_handle, u32 portref, | |
48 | struct sk_buff **buf, unsigned char const *data, | |
49 | unsigned int size, int reason, | |
50 | struct tipc_portid const *attmpt_destid); | |
51 | ||
52 | typedef void (*tipc_named_msg_err_event) (void *usr_handle, u32 portref, | |
53 | struct sk_buff **buf, unsigned char const *data, | |
54 | unsigned int size, int reason, | |
55 | struct tipc_name_seq const *attmpt_dest); | |
56 | ||
57 | typedef void (*tipc_conn_shutdown_event) (void *usr_handle, u32 portref, | |
58 | struct sk_buff **buf, unsigned char const *data, | |
59 | unsigned int size, int reason); | |
60 | ||
61 | typedef void (*tipc_msg_event) (void *usr_handle, u32 portref, | |
62 | struct sk_buff **buf, unsigned char const *data, | |
63 | unsigned int size, unsigned int importance, | |
64 | struct tipc_portid const *origin); | |
65 | ||
66 | typedef void (*tipc_named_msg_event) (void *usr_handle, u32 portref, | |
67 | struct sk_buff **buf, unsigned char const *data, | |
68 | unsigned int size, unsigned int importance, | |
69 | struct tipc_portid const *orig, | |
70 | struct tipc_name_seq const *dest); | |
71 | ||
72 | typedef void (*tipc_conn_msg_event) (void *usr_handle, u32 portref, | |
73 | struct sk_buff **buf, unsigned char const *data, | |
74 | unsigned int size); | |
75 | ||
76 | typedef void (*tipc_continue_event) (void *usr_handle, u32 portref); | |
77 | ||
b97bf3fd PL |
78 | /** |
79 | * struct user_port - TIPC user port (used with native API) | |
b97bf3fd PL |
80 | * @usr_handle: user-specified field |
81 | * @ref: object reference to associated TIPC port | |
82 | * <various callback routines> | |
b97bf3fd | 83 | */ |
c4307285 | 84 | |
b97bf3fd | 85 | struct user_port { |
c4307285 | 86 | void *usr_handle; |
b97bf3fd | 87 | u32 ref; |
c4307285 YH |
88 | tipc_msg_err_event err_cb; |
89 | tipc_named_msg_err_event named_err_cb; | |
90 | tipc_conn_shutdown_event conn_err_cb; | |
91 | tipc_msg_event msg_cb; | |
92 | tipc_named_msg_event named_msg_cb; | |
93 | tipc_conn_msg_event conn_msg_cb; | |
b97bf3fd | 94 | tipc_continue_event continue_event_cb; |
b97bf3fd PL |
95 | }; |
96 | ||
d265fef6 AS |
97 | /** |
98 | * struct tipc_port - TIPC port info available to socket API | |
99 | * @usr_handle: pointer to additional user-defined information about port | |
100 | * @lock: pointer to spinlock for controlling access to port | |
101 | * @connected: non-zero if port is currently connected to a peer port | |
102 | * @conn_type: TIPC type used when connection was established | |
103 | * @conn_instance: TIPC instance used when connection was established | |
104 | * @conn_unacked: number of unacknowledged messages received from peer port | |
105 | * @published: non-zero if port has one or more associated names | |
106 | * @congested: non-zero if cannot send because of link or port congestion | |
107 | * @max_pkt: maximum packet size "hint" used when building messages sent by port | |
108 | * @ref: unique reference to port in TIPC object registry | |
109 | * @phdr: preformatted message header used when sending messages | |
110 | */ | |
111 | struct tipc_port { | |
112 | void *usr_handle; | |
113 | spinlock_t *lock; | |
114 | int connected; | |
115 | u32 conn_type; | |
116 | u32 conn_instance; | |
117 | u32 conn_unacked; | |
118 | int published; | |
119 | u32 congested; | |
120 | u32 max_pkt; | |
121 | u32 ref; | |
122 | struct tipc_msg phdr; | |
123 | }; | |
124 | ||
b97bf3fd PL |
125 | /** |
126 | * struct port - TIPC port structure | |
127 | * @publ: TIPC port info available to privileged users | |
128 | * @port_list: adjacent ports in TIPC's global list of ports | |
129 | * @dispatcher: ptr to routine which handles received messages | |
130 | * @wakeup: ptr to routine to call when port is no longer congested | |
131 | * @user_port: ptr to user port associated with port (if any) | |
132 | * @wait_list: adjacent ports in list of ports waiting on link congestion | |
b97bf3fd PL |
133 | * @waiting_pkts: |
134 | * @sent: | |
135 | * @acked: | |
136 | * @publications: list of publications for port | |
137 | * @pub_count: total # of publications port has made during its lifetime | |
b97bf3fd PL |
138 | * @probing_state: |
139 | * @probing_interval: | |
140 | * @last_in_seqno: | |
141 | * @timer_ref: | |
142 | * @subscription: "node down" subscription used to terminate failed connections | |
143 | */ | |
144 | ||
145 | struct port { | |
146 | struct tipc_port publ; | |
147 | struct list_head port_list; | |
148 | u32 (*dispatcher)(struct tipc_port *, struct sk_buff *); | |
149 | void (*wakeup)(struct tipc_port *); | |
150 | struct user_port *user_port; | |
151 | struct list_head wait_list; | |
b97bf3fd PL |
152 | u32 waiting_pkts; |
153 | u32 sent; | |
154 | u32 acked; | |
155 | struct list_head publications; | |
156 | u32 pub_count; | |
b97bf3fd PL |
157 | u32 probing_state; |
158 | u32 probing_interval; | |
159 | u32 last_in_seqno; | |
160 | struct timer_list timer; | |
6c00055a | 161 | struct tipc_node_subscr subscription; |
b97bf3fd PL |
162 | }; |
163 | ||
4323add6 | 164 | extern spinlock_t tipc_port_list_lock; |
b97bf3fd PL |
165 | struct port_list; |
166 | ||
d265fef6 AS |
167 | /* |
168 | * TIPC port manipulation routines | |
169 | */ | |
170 | struct tipc_port *tipc_createport_raw(void *usr_handle, | |
171 | u32 (*dispatcher)(struct tipc_port *, struct sk_buff *), | |
172 | void (*wakeup)(struct tipc_port *), const u32 importance); | |
173 | ||
174 | int tipc_reject_msg(struct sk_buff *buf, u32 err); | |
175 | ||
176 | int tipc_send_buf_fast(struct sk_buff *buf, u32 destnode); | |
177 | ||
178 | void tipc_acknowledge(u32 port_ref, u32 ack); | |
179 | ||
b0c1e928 | 180 | int tipc_createport(void *usr_handle, |
d265fef6 AS |
181 | unsigned int importance, tipc_msg_err_event error_cb, |
182 | tipc_named_msg_err_event named_error_cb, | |
183 | tipc_conn_shutdown_event conn_error_cb, tipc_msg_event msg_cb, | |
184 | tipc_named_msg_event named_msg_cb, | |
185 | tipc_conn_msg_event conn_msg_cb, | |
186 | tipc_continue_event continue_event_cb, u32 *portref); | |
187 | ||
188 | int tipc_deleteport(u32 portref); | |
189 | ||
d265fef6 AS |
190 | int tipc_portimportance(u32 portref, unsigned int *importance); |
191 | int tipc_set_portimportance(u32 portref, unsigned int importance); | |
192 | ||
193 | int tipc_portunreliable(u32 portref, unsigned int *isunreliable); | |
194 | int tipc_set_portunreliable(u32 portref, unsigned int isunreliable); | |
195 | ||
196 | int tipc_portunreturnable(u32 portref, unsigned int *isunreturnable); | |
197 | int tipc_set_portunreturnable(u32 portref, unsigned int isunreturnable); | |
198 | ||
199 | int tipc_publish(u32 portref, unsigned int scope, | |
200 | struct tipc_name_seq const *name_seq); | |
201 | int tipc_withdraw(u32 portref, unsigned int scope, | |
202 | struct tipc_name_seq const *name_seq); | |
203 | ||
204 | int tipc_connect2port(u32 portref, struct tipc_portid const *port); | |
205 | ||
206 | int tipc_disconnect(u32 portref); | |
207 | ||
208 | int tipc_shutdown(u32 ref); | |
209 | ||
210 | ||
211 | /* | |
212 | * The following routines require that the port be locked on entry | |
213 | */ | |
214 | int tipc_disconnect_port(struct tipc_port *tp_ptr); | |
215 | ||
216 | /* | |
217 | * TIPC messaging routines | |
218 | */ | |
d265fef6 AS |
219 | int tipc_send(u32 portref, unsigned int num_sect, struct iovec const *msg_sect); |
220 | ||
221 | int tipc_send2name(u32 portref, struct tipc_name const *name, u32 domain, | |
222 | unsigned int num_sect, struct iovec const *msg_sect); | |
223 | ||
224 | int tipc_send2port(u32 portref, struct tipc_portid const *dest, | |
225 | unsigned int num_sect, struct iovec const *msg_sect); | |
226 | ||
227 | int tipc_send_buf2port(u32 portref, struct tipc_portid const *dest, | |
228 | struct sk_buff *buf, unsigned int dsz); | |
229 | ||
38f232ea | 230 | int tipc_multicast(u32 portref, struct tipc_name_seq const *seq, |
d265fef6 AS |
231 | unsigned int section_count, struct iovec const *msg); |
232 | ||
4323add6 PL |
233 | int tipc_port_reject_sections(struct port *p_ptr, struct tipc_msg *hdr, |
234 | struct iovec const *msg_sect, u32 num_sect, | |
235 | int err); | |
236 | struct sk_buff *tipc_port_get_ports(void); | |
4323add6 PL |
237 | void tipc_port_recv_proto_msg(struct sk_buff *buf); |
238 | void tipc_port_recv_mcast(struct sk_buff *buf, struct port_list *dp); | |
239 | void tipc_port_reinit(void); | |
b97bf3fd PL |
240 | |
241 | /** | |
4323add6 | 242 | * tipc_port_lock - lock port instance referred to and return its pointer |
b97bf3fd PL |
243 | */ |
244 | ||
4323add6 | 245 | static inline struct port *tipc_port_lock(u32 ref) |
b97bf3fd | 246 | { |
4323add6 | 247 | return (struct port *)tipc_ref_lock(ref); |
b97bf3fd PL |
248 | } |
249 | ||
c4307285 | 250 | /** |
4323add6 | 251 | * tipc_port_unlock - unlock a port instance |
c4307285 | 252 | * |
4323add6 | 253 | * Can use pointer instead of tipc_ref_unlock() since port is already locked. |
b97bf3fd PL |
254 | */ |
255 | ||
4323add6 | 256 | static inline void tipc_port_unlock(struct port *p_ptr) |
b97bf3fd PL |
257 | { |
258 | spin_unlock_bh(p_ptr->publ.lock); | |
259 | } | |
260 | ||
0e65967e | 261 | static inline struct port *tipc_port_deref(u32 ref) |
b97bf3fd | 262 | { |
4323add6 | 263 | return (struct port *)tipc_ref_deref(ref); |
b97bf3fd PL |
264 | } |
265 | ||
4323add6 | 266 | static inline u32 tipc_peer_port(struct port *p_ptr) |
b97bf3fd PL |
267 | { |
268 | return msg_destport(&p_ptr->publ.phdr); | |
269 | } | |
270 | ||
4323add6 | 271 | static inline u32 tipc_peer_node(struct port *p_ptr) |
b97bf3fd PL |
272 | { |
273 | return msg_destnode(&p_ptr->publ.phdr); | |
274 | } | |
275 | ||
4323add6 | 276 | static inline int tipc_port_congested(struct port *p_ptr) |
b97bf3fd | 277 | { |
a02cec21 | 278 | return (p_ptr->sent - p_ptr->acked) >= (TIPC_FLOW_CONTROL_WIN * 2); |
b97bf3fd PL |
279 | } |
280 | ||
c4307285 | 281 | /** |
4323add6 | 282 | * tipc_port_recv_msg - receive message from lower layer and deliver to port user |
b97bf3fd PL |
283 | */ |
284 | ||
4323add6 | 285 | static inline int tipc_port_recv_msg(struct sk_buff *buf) |
b97bf3fd PL |
286 | { |
287 | struct port *p_ptr; | |
288 | struct tipc_msg *msg = buf_msg(buf); | |
289 | u32 destport = msg_destport(msg); | |
290 | u32 dsz = msg_data_sz(msg); | |
291 | u32 err; | |
c4307285 | 292 | |
b97bf3fd PL |
293 | /* forward unresolved named message */ |
294 | if (unlikely(!destport)) { | |
4323add6 | 295 | tipc_net_route_msg(buf); |
b97bf3fd PL |
296 | return dsz; |
297 | } | |
298 | ||
299 | /* validate destination & pass to port, otherwise reject message */ | |
4323add6 | 300 | p_ptr = tipc_port_lock(destport); |
b97bf3fd PL |
301 | if (likely(p_ptr)) { |
302 | if (likely(p_ptr->publ.connected)) { | |
4323add6 PL |
303 | if ((unlikely(msg_origport(msg) != tipc_peer_port(p_ptr))) || |
304 | (unlikely(msg_orignode(msg) != tipc_peer_node(p_ptr))) || | |
b97bf3fd PL |
305 | (unlikely(!msg_connected(msg)))) { |
306 | err = TIPC_ERR_NO_PORT; | |
4323add6 | 307 | tipc_port_unlock(p_ptr); |
b97bf3fd PL |
308 | goto reject; |
309 | } | |
310 | } | |
311 | err = p_ptr->dispatcher(&p_ptr->publ, buf); | |
4323add6 | 312 | tipc_port_unlock(p_ptr); |
b97bf3fd PL |
313 | if (likely(!err)) |
314 | return dsz; | |
315 | } else { | |
316 | err = TIPC_ERR_NO_PORT; | |
317 | } | |
318 | reject: | |
b97bf3fd PL |
319 | return tipc_reject_msg(buf, err); |
320 | } | |
321 | ||
322 | #endif |