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
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
);
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
);
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
);
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
);
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
);
72 typedef void (*tipc_conn_msg_event
) (void *usr_handle
, u32 portref
,
73 struct sk_buff
**buf
, unsigned char const *data
,
76 typedef void (*tipc_continue_event
) (void *usr_handle
, u32 portref
);
79 * struct user_port - TIPC user port (used with native API)
80 * @usr_handle: user-specified field
81 * @ref: object reference to associated TIPC port
82 * <various callback routines>
87 tipc_msg_err_event err_cb
;
88 tipc_named_msg_err_event named_err_cb
;
89 tipc_conn_shutdown_event conn_err_cb
;
90 tipc_msg_event msg_cb
;
91 tipc_named_msg_event named_msg_cb
;
92 tipc_conn_msg_event conn_msg_cb
;
93 tipc_continue_event continue_event_cb
;
97 * struct tipc_port - TIPC port structure
98 * @usr_handle: pointer to additional user-defined information about port
99 * @lock: pointer to spinlock for controlling access to port
100 * @connected: non-zero if port is currently connected to a peer port
101 * @conn_type: TIPC type used when connection was established
102 * @conn_instance: TIPC instance used when connection was established
103 * @conn_unacked: number of unacknowledged messages received from peer port
104 * @published: non-zero if port has one or more associated names
105 * @congested: non-zero if cannot send because of link or port congestion
106 * @max_pkt: maximum packet size "hint" used when building messages sent by port
107 * @ref: unique reference to port in TIPC object registry
108 * @phdr: preformatted message header used when sending messages
109 * @port_list: adjacent ports in TIPC's global list of ports
110 * @dispatcher: ptr to routine which handles received messages
111 * @wakeup: ptr to routine to call when port is no longer congested
112 * @user_port: ptr to user port associated with port (if any)
113 * @wait_list: adjacent ports in list of ports waiting on link congestion
115 * @sent: # of non-empty messages sent by port
116 * @acked: # of non-empty message acknowledgements from connected port's peer
117 * @publications: list of publications for port
118 * @pub_count: total # of publications port has made during its lifetime
122 * @subscription: "node down" subscription used to terminate failed connections
135 struct tipc_msg phdr
;
136 struct list_head port_list
;
137 u32 (*dispatcher
)(struct tipc_port
*, struct sk_buff
*);
138 void (*wakeup
)(struct tipc_port
*);
139 struct user_port
*user_port
;
140 struct list_head wait_list
;
144 struct list_head publications
;
147 u32 probing_interval
;
148 struct timer_list timer
;
149 struct tipc_node_subscr subscription
;
152 extern spinlock_t tipc_port_list_lock
;
153 struct tipc_port_list
;
156 * TIPC port manipulation routines
158 struct tipc_port
*tipc_createport_raw(void *usr_handle
,
159 u32 (*dispatcher
)(struct tipc_port
*, struct sk_buff
*),
160 void (*wakeup
)(struct tipc_port
*), const u32 importance
);
162 int tipc_reject_msg(struct sk_buff
*buf
, u32 err
);
164 int tipc_send_buf_fast(struct sk_buff
*buf
, u32 destnode
);
166 void tipc_acknowledge(u32 port_ref
, u32 ack
);
168 int tipc_createport(void *usr_handle
,
169 unsigned int importance
, tipc_msg_err_event error_cb
,
170 tipc_named_msg_err_event named_error_cb
,
171 tipc_conn_shutdown_event conn_error_cb
, tipc_msg_event msg_cb
,
172 tipc_named_msg_event named_msg_cb
,
173 tipc_conn_msg_event conn_msg_cb
,
174 tipc_continue_event continue_event_cb
, u32
*portref
);
176 int tipc_deleteport(u32 portref
);
178 int tipc_portimportance(u32 portref
, unsigned int *importance
);
179 int tipc_set_portimportance(u32 portref
, unsigned int importance
);
181 int tipc_portunreliable(u32 portref
, unsigned int *isunreliable
);
182 int tipc_set_portunreliable(u32 portref
, unsigned int isunreliable
);
184 int tipc_portunreturnable(u32 portref
, unsigned int *isunreturnable
);
185 int tipc_set_portunreturnable(u32 portref
, unsigned int isunreturnable
);
187 int tipc_publish(u32 portref
, unsigned int scope
,
188 struct tipc_name_seq
const *name_seq
);
189 int tipc_withdraw(u32 portref
, unsigned int scope
,
190 struct tipc_name_seq
const *name_seq
);
192 int tipc_connect2port(u32 portref
, struct tipc_portid
const *port
);
194 int tipc_disconnect(u32 portref
);
196 int tipc_shutdown(u32 ref
);
200 * The following routines require that the port be locked on entry
202 int tipc_disconnect_port(struct tipc_port
*tp_ptr
);
203 int tipc_port_peer_msg(struct tipc_port
*p_ptr
, struct tipc_msg
*msg
);
206 * TIPC messaging routines
208 int tipc_port_recv_msg(struct sk_buff
*buf
);
209 int tipc_send(u32 portref
, unsigned int num_sect
, struct iovec
const *msg_sect
,
210 unsigned int total_len
);
212 int tipc_send2name(u32 portref
, struct tipc_name
const *name
, u32 domain
,
213 unsigned int num_sect
, struct iovec
const *msg_sect
,
214 unsigned int total_len
);
216 int tipc_send2port(u32 portref
, struct tipc_portid
const *dest
,
217 unsigned int num_sect
, struct iovec
const *msg_sect
,
218 unsigned int total_len
);
220 int tipc_send_buf2port(u32 portref
, struct tipc_portid
const *dest
,
221 struct sk_buff
*buf
, unsigned int dsz
);
223 int tipc_multicast(u32 portref
, struct tipc_name_seq
const *seq
,
224 unsigned int section_count
, struct iovec
const *msg
,
225 unsigned int total_len
);
227 int tipc_port_reject_sections(struct tipc_port
*p_ptr
, struct tipc_msg
*hdr
,
228 struct iovec
const *msg_sect
, u32 num_sect
,
229 unsigned int total_len
, int err
);
230 struct sk_buff
*tipc_port_get_ports(void);
231 void tipc_port_recv_proto_msg(struct sk_buff
*buf
);
232 void tipc_port_recv_mcast(struct sk_buff
*buf
, struct tipc_port_list
*dp
);
233 void tipc_port_reinit(void);
236 * tipc_port_lock - lock port instance referred to and return its pointer
238 static inline struct tipc_port
*tipc_port_lock(u32 ref
)
240 return (struct tipc_port
*)tipc_ref_lock(ref
);
244 * tipc_port_unlock - unlock a port instance
246 * Can use pointer instead of tipc_ref_unlock() since port is already locked.
248 static inline void tipc_port_unlock(struct tipc_port
*p_ptr
)
250 spin_unlock_bh(p_ptr
->lock
);
253 static inline struct tipc_port
*tipc_port_deref(u32 ref
)
255 return (struct tipc_port
*)tipc_ref_deref(ref
);
258 static inline int tipc_port_congested(struct tipc_port
*p_ptr
)
260 return (p_ptr
->sent
- p_ptr
->acked
) >= (TIPC_FLOW_CONTROL_WIN
* 2);