blob: 34ccb7c11e7139bc6ec11d24829e42bee56fbb31 [file] [log] [blame]
Per Lidenb97bf3f2006-01-02 19:04:38 +01001/*
2 * net/tipc/port.h: Include file for TIPC port code
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +09003 *
Allan Stephens05646c92007-06-10 17:25:24 -07004 * Copyright (c) 1994-2007, Ericsson AB
Allan Stephens23dd4cc2011-01-07 11:43:40 -05005 * Copyright (c) 2004-2007, 2010-2011, Wind River Systems
Per Lidenb97bf3f2006-01-02 19:04:38 +01006 * All rights reserved.
7 *
Per Liden9ea1fd32006-01-11 13:30:43 +01008 * Redistribution and use in source and binary forms, with or without
Per Lidenb97bf3f2006-01-02 19:04:38 +01009 * modification, are permitted provided that the following conditions are met:
10 *
Per Liden9ea1fd32006-01-11 13:30:43 +010011 * 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.
Per Lidenb97bf3f2006-01-02 19:04:38 +010019 *
Per Liden9ea1fd32006-01-11 13:30:43 +010020 * 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
Per Lidenb97bf3f2006-01-02 19:04:38 +010034 * POSSIBILITY OF SUCH DAMAGE.
35 */
36
37#ifndef _TIPC_PORT_H
38#define _TIPC_PORT_H
39
Per Lidenb97bf3f2006-01-02 19:04:38 +010040#include "ref.h"
41#include "net.h"
42#include "msg.h"
Per Lidenb97bf3f2006-01-02 19:04:38 +010043#include "node_subscr.h"
44
Allan Stephensd265fef2010-11-30 12:00:53 +000045#define TIPC_FLOW_CONTROL_WIN 512
46
47typedef 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
52typedef 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
57typedef 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
61typedef 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
66typedef 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
72typedef void (*tipc_conn_msg_event) (void *usr_handle, u32 portref,
73 struct sk_buff **buf, unsigned char const *data,
74 unsigned int size);
75
76typedef void (*tipc_continue_event) (void *usr_handle, u32 portref);
77
Per Lidenb97bf3f2006-01-02 19:04:38 +010078/**
79 * struct user_port - TIPC user port (used with native API)
Per Lidenb97bf3f2006-01-02 19:04:38 +010080 * @usr_handle: user-specified field
81 * @ref: object reference to associated TIPC port
82 * <various callback routines>
Per Lidenb97bf3f2006-01-02 19:04:38 +010083 */
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +090084
Per Lidenb97bf3f2006-01-02 19:04:38 +010085struct user_port {
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +090086 void *usr_handle;
Per Lidenb97bf3f2006-01-02 19:04:38 +010087 u32 ref;
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +090088 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;
Per Lidenb97bf3f2006-01-02 19:04:38 +010094 tipc_continue_event continue_event_cb;
Per Lidenb97bf3f2006-01-02 19:04:38 +010095};
96
97/**
Allan Stephens23dd4cc2011-01-07 11:43:40 -050098 * struct tipc_port - TIPC port structure
Allan Stephensd265fef2010-11-30 12:00:53 +000099 * @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
Per Lidenb97bf3f2006-01-02 19:04:38 +0100110 * @port_list: adjacent ports in TIPC's global list of ports
111 * @dispatcher: ptr to routine which handles received messages
112 * @wakeup: ptr to routine to call when port is no longer congested
113 * @user_port: ptr to user port associated with port (if any)
114 * @wait_list: adjacent ports in list of ports waiting on link congestion
Per Lidenb97bf3f2006-01-02 19:04:38 +0100115 * @waiting_pkts:
Allan Stephenscb7ce912011-01-24 15:02:14 -0500116 * @sent: # of non-empty messages sent by port
117 * @acked: # of non-empty message acknowledgements from connected port's peer
Per Lidenb97bf3f2006-01-02 19:04:38 +0100118 * @publications: list of publications for port
119 * @pub_count: total # of publications port has made during its lifetime
Per Lidenb97bf3f2006-01-02 19:04:38 +0100120 * @probing_state:
121 * @probing_interval:
122 * @last_in_seqno:
123 * @timer_ref:
124 * @subscription: "node down" subscription used to terminate failed connections
125 */
Allan Stephens23dd4cc2011-01-07 11:43:40 -0500126struct tipc_port {
127 void *usr_handle;
128 spinlock_t *lock;
129 int connected;
130 u32 conn_type;
131 u32 conn_instance;
132 u32 conn_unacked;
133 int published;
134 u32 congested;
135 u32 max_pkt;
136 u32 ref;
137 struct tipc_msg phdr;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100138 struct list_head port_list;
139 u32 (*dispatcher)(struct tipc_port *, struct sk_buff *);
140 void (*wakeup)(struct tipc_port *);
141 struct user_port *user_port;
142 struct list_head wait_list;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100143 u32 waiting_pkts;
144 u32 sent;
145 u32 acked;
146 struct list_head publications;
147 u32 pub_count;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100148 u32 probing_state;
149 u32 probing_interval;
150 u32 last_in_seqno;
151 struct timer_list timer;
David S. Miller6c000552008-09-02 23:38:32 -0700152 struct tipc_node_subscr subscription;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100153};
154
Per Liden4323add2006-01-18 00:38:21 +0100155extern spinlock_t tipc_port_list_lock;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100156struct port_list;
157
Allan Stephensd265fef2010-11-30 12:00:53 +0000158/*
159 * TIPC port manipulation routines
160 */
161struct 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);
164
165int tipc_reject_msg(struct sk_buff *buf, u32 err);
166
167int tipc_send_buf_fast(struct sk_buff *buf, u32 destnode);
168
169void tipc_acknowledge(u32 port_ref, u32 ack);
170
Allan Stephensb0c1e922010-12-31 18:59:22 +0000171int tipc_createport(void *usr_handle,
Allan Stephensd265fef2010-11-30 12:00:53 +0000172 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);
178
179int tipc_deleteport(u32 portref);
180
Allan Stephensd265fef2010-11-30 12:00:53 +0000181int tipc_portimportance(u32 portref, unsigned int *importance);
182int tipc_set_portimportance(u32 portref, unsigned int importance);
183
184int tipc_portunreliable(u32 portref, unsigned int *isunreliable);
185int tipc_set_portunreliable(u32 portref, unsigned int isunreliable);
186
187int tipc_portunreturnable(u32 portref, unsigned int *isunreturnable);
188int tipc_set_portunreturnable(u32 portref, unsigned int isunreturnable);
189
190int tipc_publish(u32 portref, unsigned int scope,
191 struct tipc_name_seq const *name_seq);
192int tipc_withdraw(u32 portref, unsigned int scope,
193 struct tipc_name_seq const *name_seq);
194
195int tipc_connect2port(u32 portref, struct tipc_portid const *port);
196
197int tipc_disconnect(u32 portref);
198
199int tipc_shutdown(u32 ref);
200
201
202/*
203 * The following routines require that the port be locked on entry
204 */
205int tipc_disconnect_port(struct tipc_port *tp_ptr);
206
207/*
208 * TIPC messaging routines
209 */
Allan Stephensd265fef2010-11-30 12:00:53 +0000210int tipc_send(u32 portref, unsigned int num_sect, struct iovec const *msg_sect);
211
212int tipc_send2name(u32 portref, struct tipc_name const *name, u32 domain,
213 unsigned int num_sect, struct iovec const *msg_sect);
214
215int tipc_send2port(u32 portref, struct tipc_portid const *dest,
216 unsigned int num_sect, struct iovec const *msg_sect);
217
218int tipc_send_buf2port(u32 portref, struct tipc_portid const *dest,
219 struct sk_buff *buf, unsigned int dsz);
220
Allan Stephens38f232e2010-11-30 12:00:59 +0000221int tipc_multicast(u32 portref, struct tipc_name_seq const *seq,
Allan Stephensd265fef2010-11-30 12:00:53 +0000222 unsigned int section_count, struct iovec const *msg);
223
Allan Stephens23dd4cc2011-01-07 11:43:40 -0500224int tipc_port_reject_sections(struct tipc_port *p_ptr, struct tipc_msg *hdr,
Per Liden4323add2006-01-18 00:38:21 +0100225 struct iovec const *msg_sect, u32 num_sect,
226 int err);
227struct sk_buff *tipc_port_get_ports(void);
Per Liden4323add2006-01-18 00:38:21 +0100228void tipc_port_recv_proto_msg(struct sk_buff *buf);
229void tipc_port_recv_mcast(struct sk_buff *buf, struct port_list *dp);
230void tipc_port_reinit(void);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100231
232/**
Per Liden4323add2006-01-18 00:38:21 +0100233 * tipc_port_lock - lock port instance referred to and return its pointer
Per Lidenb97bf3f2006-01-02 19:04:38 +0100234 */
235
Allan Stephens23dd4cc2011-01-07 11:43:40 -0500236static inline struct tipc_port *tipc_port_lock(u32 ref)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100237{
Allan Stephens23dd4cc2011-01-07 11:43:40 -0500238 return (struct tipc_port *)tipc_ref_lock(ref);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100239}
240
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900241/**
Per Liden4323add2006-01-18 00:38:21 +0100242 * tipc_port_unlock - unlock a port instance
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900243 *
Per Liden4323add2006-01-18 00:38:21 +0100244 * Can use pointer instead of tipc_ref_unlock() since port is already locked.
Per Lidenb97bf3f2006-01-02 19:04:38 +0100245 */
246
Allan Stephens23dd4cc2011-01-07 11:43:40 -0500247static inline void tipc_port_unlock(struct tipc_port *p_ptr)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100248{
Allan Stephens23dd4cc2011-01-07 11:43:40 -0500249 spin_unlock_bh(p_ptr->lock);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100250}
251
Allan Stephens23dd4cc2011-01-07 11:43:40 -0500252static inline struct tipc_port *tipc_port_deref(u32 ref)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100253{
Allan Stephens23dd4cc2011-01-07 11:43:40 -0500254 return (struct tipc_port *)tipc_ref_deref(ref);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100255}
256
Allan Stephens23dd4cc2011-01-07 11:43:40 -0500257static inline u32 tipc_peer_port(struct tipc_port *p_ptr)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100258{
Allan Stephens23dd4cc2011-01-07 11:43:40 -0500259 return msg_destport(&p_ptr->phdr);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100260}
261
Allan Stephens23dd4cc2011-01-07 11:43:40 -0500262static inline u32 tipc_peer_node(struct tipc_port *p_ptr)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100263{
Allan Stephens23dd4cc2011-01-07 11:43:40 -0500264 return msg_destnode(&p_ptr->phdr);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100265}
266
Allan Stephens23dd4cc2011-01-07 11:43:40 -0500267static inline int tipc_port_congested(struct tipc_port *p_ptr)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100268{
Eric Dumazeta02cec22010-09-22 20:43:57 +0000269 return (p_ptr->sent - p_ptr->acked) >= (TIPC_FLOW_CONTROL_WIN * 2);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100270}
271
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900272/**
Per Liden4323add2006-01-18 00:38:21 +0100273 * tipc_port_recv_msg - receive message from lower layer and deliver to port user
Per Lidenb97bf3f2006-01-02 19:04:38 +0100274 */
275
Per Liden4323add2006-01-18 00:38:21 +0100276static inline int tipc_port_recv_msg(struct sk_buff *buf)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100277{
Allan Stephens23dd4cc2011-01-07 11:43:40 -0500278 struct tipc_port *p_ptr;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100279 struct tipc_msg *msg = buf_msg(buf);
280 u32 destport = msg_destport(msg);
281 u32 dsz = msg_data_sz(msg);
282 u32 err;
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900283
Per Lidenb97bf3f2006-01-02 19:04:38 +0100284 /* forward unresolved named message */
285 if (unlikely(!destport)) {
Per Liden4323add2006-01-18 00:38:21 +0100286 tipc_net_route_msg(buf);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100287 return dsz;
288 }
289
290 /* validate destination & pass to port, otherwise reject message */
Per Liden4323add2006-01-18 00:38:21 +0100291 p_ptr = tipc_port_lock(destport);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100292 if (likely(p_ptr)) {
Allan Stephens23dd4cc2011-01-07 11:43:40 -0500293 if (likely(p_ptr->connected)) {
Per Liden4323add2006-01-18 00:38:21 +0100294 if ((unlikely(msg_origport(msg) != tipc_peer_port(p_ptr))) ||
295 (unlikely(msg_orignode(msg) != tipc_peer_node(p_ptr))) ||
Per Lidenb97bf3f2006-01-02 19:04:38 +0100296 (unlikely(!msg_connected(msg)))) {
297 err = TIPC_ERR_NO_PORT;
Per Liden4323add2006-01-18 00:38:21 +0100298 tipc_port_unlock(p_ptr);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100299 goto reject;
300 }
301 }
Allan Stephens23dd4cc2011-01-07 11:43:40 -0500302 err = p_ptr->dispatcher(p_ptr, buf);
Per Liden4323add2006-01-18 00:38:21 +0100303 tipc_port_unlock(p_ptr);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100304 if (likely(!err))
305 return dsz;
306 } else {
307 err = TIPC_ERR_NO_PORT;
308 }
309reject:
Per Lidenb97bf3f2006-01-02 19:04:38 +0100310 return tipc_reject_msg(buf, err);
311}
312
313#endif