2 * net/tipc/port.h: Include file for TIPC port code
4 * Copyright (c) 1994-2007, Ericsson AB
5 * Copyright (c) 2004-2007, 2010-2011, Wind River Systems
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions are met:
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.
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.
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
34 * POSSIBILITY OF SUCH DAMAGE.
43 #include "node_subscr.h"
45 #define TIPC_FLOW_CONTROL_WIN 512
46 #define CONN_OVERLOAD_LIMIT ((TIPC_FLOW_CONTROL_WIN * 2 + 1) * \
47 SKB_TRUESIZE(TIPC_MAX_USER_MSG_SIZE))
49 typedef void (*tipc_msg_err_event
) (void *usr_handle
, u32 portref
,
50 struct sk_buff
**buf
, unsigned char const *data
,
51 unsigned int size
, int reason
,
52 struct tipc_portid
const *attmpt_destid
);
54 typedef void (*tipc_named_msg_err_event
) (void *usr_handle
, u32 portref
,
55 struct sk_buff
**buf
, unsigned char const *data
,
56 unsigned int size
, int reason
,
57 struct tipc_name_seq
const *attmpt_dest
);
59 typedef void (*tipc_conn_shutdown_event
) (void *usr_handle
, u32 portref
,
60 struct sk_buff
**buf
, unsigned char const *data
,
61 unsigned int size
, int reason
);
63 typedef void (*tipc_msg_event
) (void *usr_handle
, u32 portref
,
64 struct sk_buff
**buf
, unsigned char const *data
,
65 unsigned int size
, unsigned int importance
,
66 struct tipc_portid
const *origin
);
68 typedef void (*tipc_named_msg_event
) (void *usr_handle
, u32 portref
,
69 struct sk_buff
**buf
, unsigned char const *data
,
70 unsigned int size
, unsigned int importance
,
71 struct tipc_portid
const *orig
,
72 struct tipc_name_seq
const *dest
);
74 typedef void (*tipc_conn_msg_event
) (void *usr_handle
, u32 portref
,
75 struct sk_buff
**buf
, unsigned char const *data
,
78 typedef void (*tipc_continue_event
) (void *usr_handle
, u32 portref
);
81 * struct user_port - TIPC user port (used with native API)
82 * @usr_handle: user-specified field
83 * @ref: object reference to associated TIPC port
85 * <various callback routines>
90 tipc_msg_err_event err_cb
;
91 tipc_named_msg_err_event named_err_cb
;
92 tipc_conn_shutdown_event conn_err_cb
;
93 tipc_msg_event msg_cb
;
94 tipc_named_msg_event named_msg_cb
;
95 tipc_conn_msg_event conn_msg_cb
;
96 tipc_continue_event continue_event_cb
;
100 * struct tipc_port - TIPC port structure
101 * @usr_handle: pointer to additional user-defined information about port
102 * @lock: pointer to spinlock for controlling access to port
103 * @connected: non-zero if port is currently connected to a peer port
104 * @conn_type: TIPC type used when connection was established
105 * @conn_instance: TIPC instance used when connection was established
106 * @conn_unacked: number of unacknowledged messages received from peer port
107 * @published: non-zero if port has one or more associated names
108 * @congested: non-zero if cannot send because of link or port congestion
109 * @max_pkt: maximum packet size "hint" used when building messages sent by port
110 * @ref: unique reference to port in TIPC object registry
111 * @phdr: preformatted message header used when sending messages
112 * @port_list: adjacent ports in TIPC's global list of ports
113 * @dispatcher: ptr to routine which handles received messages
114 * @wakeup: ptr to routine to call when port is no longer congested
115 * @user_port: ptr to user port associated with port (if any)
116 * @wait_list: adjacent ports in list of ports waiting on link congestion
118 * @sent: # of non-empty messages sent by port
119 * @acked: # of non-empty message acknowledgements from connected port's peer
120 * @publications: list of publications for port
121 * @pub_count: total # of publications port has made during its lifetime
125 * @subscription: "node down" subscription used to terminate failed connections
138 struct tipc_msg phdr
;
139 struct list_head port_list
;
140 u32 (*dispatcher
)(struct tipc_port
*, struct sk_buff
*);
141 void (*wakeup
)(struct tipc_port
*);
142 struct user_port
*user_port
;
143 struct list_head wait_list
;
147 struct list_head publications
;
150 u32 probing_interval
;
151 struct timer_list timer
;
152 struct tipc_node_subscr subscription
;
155 extern spinlock_t tipc_port_list_lock
;
156 struct tipc_port_list
;
159 * TIPC port manipulation routines
161 struct tipc_port
*tipc_createport_raw(void *usr_handle
,
162 u32 (*dispatcher
)(struct tipc_port
*, struct sk_buff
*),
163 void (*wakeup
)(struct tipc_port
*), const u32 importance
);
165 int tipc_reject_msg(struct sk_buff
*buf
, u32 err
);
167 int tipc_send_buf_fast(struct sk_buff
*buf
, u32 destnode
);
169 void tipc_acknowledge(u32 port_ref
, u32 ack
);
171 int tipc_createport(void *usr_handle
,
172 unsigned int importance
, tipc_msg_err_event error_cb
,
173 tipc_named_msg_err_event named_error_cb
,
174 tipc_conn_shutdown_event conn_error_cb
, tipc_msg_event msg_cb
,
175 tipc_named_msg_event named_msg_cb
,
176 tipc_conn_msg_event conn_msg_cb
,
177 tipc_continue_event continue_event_cb
, u32
*portref
);
179 int tipc_deleteport(u32 portref
);
181 int tipc_portimportance(u32 portref
, unsigned int *importance
);
182 int tipc_set_portimportance(u32 portref
, unsigned int importance
);
184 int tipc_portunreliable(u32 portref
, unsigned int *isunreliable
);
185 int tipc_set_portunreliable(u32 portref
, unsigned int isunreliable
);
187 int tipc_portunreturnable(u32 portref
, unsigned int *isunreturnable
);
188 int tipc_set_portunreturnable(u32 portref
, unsigned int isunreturnable
);
190 int tipc_publish(u32 portref
, unsigned int scope
,
191 struct tipc_name_seq
const *name_seq
);
192 int tipc_withdraw(u32 portref
, unsigned int scope
,
193 struct tipc_name_seq
const *name_seq
);
195 int tipc_connect(u32 portref
, struct tipc_portid
const *port
);
197 int tipc_disconnect(u32 portref
);
199 int tipc_shutdown(u32 ref
);
203 * The following routines require that the port be locked on entry
205 int __tipc_disconnect(struct tipc_port
*tp_ptr
);
206 int __tipc_connect(u32 ref
, struct tipc_port
*p_ptr
,
207 struct tipc_portid
const *peer
);
208 int tipc_port_peer_msg(struct tipc_port
*p_ptr
, struct tipc_msg
*msg
);
211 * TIPC messaging routines
213 int tipc_port_recv_msg(struct sk_buff
*buf
);
214 int tipc_send(u32 portref
, unsigned int num_sect
, struct iovec
const *msg_sect
,
215 unsigned int total_len
);
217 int tipc_send2name(u32 portref
, struct tipc_name
const *name
, u32 domain
,
218 unsigned int num_sect
, struct iovec
const *msg_sect
,
219 unsigned int total_len
);
221 int tipc_send2port(u32 portref
, struct tipc_portid
const *dest
,
222 unsigned int num_sect
, struct iovec
const *msg_sect
,
223 unsigned int total_len
);
225 int tipc_send_buf2port(u32 portref
, struct tipc_portid
const *dest
,
226 struct sk_buff
*buf
, unsigned int dsz
);
228 int tipc_multicast(u32 portref
, struct tipc_name_seq
const *seq
,
229 unsigned int section_count
, struct iovec
const *msg
,
230 unsigned int total_len
);
232 int tipc_port_reject_sections(struct tipc_port
*p_ptr
, struct tipc_msg
*hdr
,
233 struct iovec
const *msg_sect
, u32 num_sect
,
234 unsigned int total_len
, int err
);
235 struct sk_buff
*tipc_port_get_ports(void);
236 void tipc_port_recv_proto_msg(struct sk_buff
*buf
);
237 void tipc_port_recv_mcast(struct sk_buff
*buf
, struct tipc_port_list
*dp
);
238 void tipc_port_reinit(void);
241 * tipc_port_lock - lock port instance referred to and return its pointer
243 static inline struct tipc_port
*tipc_port_lock(u32 ref
)
245 return (struct tipc_port
*)tipc_ref_lock(ref
);
249 * tipc_port_unlock - unlock a port instance
251 * Can use pointer instead of tipc_ref_unlock() since port is already locked.
253 static inline void tipc_port_unlock(struct tipc_port
*p_ptr
)
255 spin_unlock_bh(p_ptr
->lock
);
258 static inline struct tipc_port
*tipc_port_deref(u32 ref
)
260 return (struct tipc_port
*)tipc_ref_deref(ref
);
263 static inline int tipc_port_congested(struct tipc_port
*p_ptr
)
265 return (p_ptr
->sent
- p_ptr
->acked
) >= (TIPC_FLOW_CONTROL_WIN
* 2);