2 * net/tipc/port.h: Include file for TIPC port code
4 * Copyright (c) 2003-2005, Ericsson Research Canada
5 * Copyright (c) 2004-2005, Wind River Systems
6 * Copyright (c) 2005-2006, Ericsson AB
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions are met:
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
17 * 3. Neither the names of the copyright holders nor the names of its
18 * contributors may be used to endorse or promote products derived from
19 * this software without specific prior written permission.
21 * Alternatively, this software may be distributed under the terms of the
22 * GNU General Public License ("GPL") version 2 as published by the Free
23 * Software Foundation.
25 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
26 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
28 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
29 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
30 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
31 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
32 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
33 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
34 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
35 * POSSIBILITY OF SUCH DAMAGE.
41 #include <net/tipc/tipc_port.h>
46 #include "node_subscr.h"
49 * struct user_port - TIPC user port (used with native API)
50 * @user_ref: id of user who created user port
51 * @usr_handle: user-specified field
52 * @ref: object reference to associated TIPC port
53 * <various callback routines>
54 * @uport_list: adjacent user ports in list of ports held by user
61 tipc_msg_err_event err_cb;
62 tipc_named_msg_err_event named_err_cb;
63 tipc_conn_shutdown_event conn_err_cb;
64 tipc_msg_event msg_cb;
65 tipc_named_msg_event named_msg_cb;
66 tipc_conn_msg_event conn_msg_cb;
67 tipc_continue_event continue_event_cb;
68 struct list_head uport_list;
72 * struct port - TIPC port structure
73 * @publ: TIPC port info available to privileged users
74 * @port_list: adjacent ports in TIPC's global list of ports
75 * @dispatcher: ptr to routine which handles received messages
76 * @wakeup: ptr to routine to call when port is no longer congested
77 * @user_port: ptr to user port associated with port (if any)
78 * @wait_list: adjacent ports in list of ports waiting on link congestion
79 * @congested_link: ptr to congested link port is waiting on
83 * @publications: list of publications for port
84 * @pub_count: total # of publications port has made during its lifetime
85 * @max_pkt: maximum packet size "hint" used when building messages sent by port
90 * @subscription: "node down" subscription used to terminate failed connections
94 struct tipc_port publ;
95 struct list_head port_list;
96 u32 (*dispatcher)(struct tipc_port *, struct sk_buff *);
97 void (*wakeup)(struct tipc_port *);
98 struct user_port *user_port;
99 struct list_head wait_list;
100 struct link *congested_link;
104 struct list_head publications;
108 u32 probing_interval;
110 struct timer_list timer;
111 struct node_subscr subscription;
114 extern spinlock_t port_list_lock;
117 int port_recv_sections(struct port *p_ptr, u32 num_sect,
118 struct iovec const *msg_sect);
119 int port_reject_sections(struct port *p_ptr, struct tipc_msg *hdr,
120 struct iovec const *msg_sect, u32 num_sect,
122 struct sk_buff *port_get_ports(void);
123 struct sk_buff *port_show_stats(const void *req_tlv_area, int req_tlv_space);
124 void port_recv_proto_msg(struct sk_buff *buf);
125 void port_recv_mcast(struct sk_buff *buf, struct port_list *dp);
126 void port_reinit(void);
129 * port_lock - lock port instance referred to and return its pointer
132 static inline struct port *port_lock(u32 ref)
134 return (struct port *)ref_lock(ref);
138 * port_unlock - unlock a port instance
140 * Can use pointer instead of ref_unlock() since port is already locked.
143 static inline void port_unlock(struct port *p_ptr)
145 spin_unlock_bh(p_ptr->publ.lock);
148 static inline struct port* port_deref(u32 ref)
150 return (struct port *)ref_deref(ref);
153 static inline u32 peer_port(struct port *p_ptr)
155 return msg_destport(&p_ptr->publ.phdr);
158 static inline u32 peer_node(struct port *p_ptr)
160 return msg_destnode(&p_ptr->publ.phdr);
163 static inline int port_congested(struct port *p_ptr)
165 return((p_ptr->sent - p_ptr->acked) >= (TIPC_FLOW_CONTROL_WIN * 2));
169 * port_recv_msg - receive message from lower layer and deliver to port user
172 static inline int port_recv_msg(struct sk_buff *buf)
175 struct tipc_msg *msg = buf_msg(buf);
176 u32 destport = msg_destport(msg);
177 u32 dsz = msg_data_sz(msg);
180 /* forward unresolved named message */
181 if (unlikely(!destport)) {
186 /* validate destination & pass to port, otherwise reject message */
187 p_ptr = port_lock(destport);
189 if (likely(p_ptr->publ.connected)) {
190 if ((unlikely(msg_origport(msg) != peer_port(p_ptr))) ||
191 (unlikely(msg_orignode(msg) != peer_node(p_ptr))) ||
192 (unlikely(!msg_connected(msg)))) {
193 err = TIPC_ERR_NO_PORT;
198 err = p_ptr->dispatcher(&p_ptr->publ, buf);
203 err = TIPC_ERR_NO_PORT;
206 dbg("port->rejecting, err = %x..\n",err);
207 return tipc_reject_msg(buf, err);