net: return operator cleanup
[linux-2.6.git] / net / tipc / port.h
1 /*
2  * net/tipc/port.h: Include file for TIPC port code
3  *
4  * Copyright (c) 1994-2007, Ericsson AB
5  * Copyright (c) 2004-2007, Wind River Systems
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions are met:
10  *
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.
19  *
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
34  * POSSIBILITY OF SUCH DAMAGE.
35  */
36
37 #ifndef _TIPC_PORT_H
38 #define _TIPC_PORT_H
39
40 #include "core.h"
41 #include "ref.h"
42 #include "net.h"
43 #include "msg.h"
44 #include "dbg.h"
45 #include "node_subscr.h"
46
47 /**
48  * struct user_port - TIPC user port (used with native API)
49  * @user_ref: id of user who created user port
50  * @usr_handle: user-specified field
51  * @ref: object reference to associated TIPC port
52  * <various callback routines>
53  * @uport_list: adjacent user ports in list of ports held by user
54  */
55
56 struct user_port {
57         u32 user_ref;
58         void *usr_handle;
59         u32 ref;
60         tipc_msg_err_event err_cb;
61         tipc_named_msg_err_event named_err_cb;
62         tipc_conn_shutdown_event conn_err_cb;
63         tipc_msg_event msg_cb;
64         tipc_named_msg_event named_msg_cb;
65         tipc_conn_msg_event conn_msg_cb;
66         tipc_continue_event continue_event_cb;
67         struct list_head uport_list;
68 };
69
70 /**
71  * struct port - TIPC port structure
72  * @publ: TIPC port info available to privileged users
73  * @port_list: adjacent ports in TIPC's global list of ports
74  * @dispatcher: ptr to routine which handles received messages
75  * @wakeup: ptr to routine to call when port is no longer congested
76  * @user_port: ptr to user port associated with port (if any)
77  * @wait_list: adjacent ports in list of ports waiting on link congestion
78  * @waiting_pkts:
79  * @sent:
80  * @acked:
81  * @publications: list of publications for port
82  * @pub_count: total # of publications port has made during its lifetime
83  * @probing_state:
84  * @probing_interval:
85  * @last_in_seqno:
86  * @timer_ref:
87  * @subscription: "node down" subscription used to terminate failed connections
88  */
89
90 struct port {
91         struct tipc_port publ;
92         struct list_head port_list;
93         u32 (*dispatcher)(struct tipc_port *, struct sk_buff *);
94         void (*wakeup)(struct tipc_port *);
95         struct user_port *user_port;
96         struct list_head wait_list;
97         u32 waiting_pkts;
98         u32 sent;
99         u32 acked;
100         struct list_head publications;
101         u32 pub_count;
102         u32 probing_state;
103         u32 probing_interval;
104         u32 last_in_seqno;
105         struct timer_list timer;
106         struct tipc_node_subscr subscription;
107 };
108
109 extern spinlock_t tipc_port_list_lock;
110 struct port_list;
111
112 int tipc_port_recv_sections(struct port *p_ptr, u32 num_sect,
113                             struct iovec const *msg_sect);
114 int tipc_port_reject_sections(struct port *p_ptr, struct tipc_msg *hdr,
115                               struct iovec const *msg_sect, u32 num_sect,
116                               int err);
117 struct sk_buff *tipc_port_get_ports(void);
118 struct sk_buff *port_show_stats(const void *req_tlv_area, int req_tlv_space);
119 void tipc_port_recv_proto_msg(struct sk_buff *buf);
120 void tipc_port_recv_mcast(struct sk_buff *buf, struct port_list *dp);
121 void tipc_port_reinit(void);
122
123 /**
124  * tipc_port_lock - lock port instance referred to and return its pointer
125  */
126
127 static inline struct port *tipc_port_lock(u32 ref)
128 {
129         return (struct port *)tipc_ref_lock(ref);
130 }
131
132 /**
133  * tipc_port_unlock - unlock a port instance
134  *
135  * Can use pointer instead of tipc_ref_unlock() since port is already locked.
136  */
137
138 static inline void tipc_port_unlock(struct port *p_ptr)
139 {
140         spin_unlock_bh(p_ptr->publ.lock);
141 }
142
143 static inline struct port* tipc_port_deref(u32 ref)
144 {
145         return (struct port *)tipc_ref_deref(ref);
146 }
147
148 static inline u32 tipc_peer_port(struct port *p_ptr)
149 {
150         return msg_destport(&p_ptr->publ.phdr);
151 }
152
153 static inline u32 tipc_peer_node(struct port *p_ptr)
154 {
155         return msg_destnode(&p_ptr->publ.phdr);
156 }
157
158 static inline int tipc_port_congested(struct port *p_ptr)
159 {
160         return (p_ptr->sent - p_ptr->acked) >= (TIPC_FLOW_CONTROL_WIN * 2);
161 }
162
163 /**
164  * tipc_port_recv_msg - receive message from lower layer and deliver to port user
165  */
166
167 static inline int tipc_port_recv_msg(struct sk_buff *buf)
168 {
169         struct port *p_ptr;
170         struct tipc_msg *msg = buf_msg(buf);
171         u32 destport = msg_destport(msg);
172         u32 dsz = msg_data_sz(msg);
173         u32 err;
174
175         /* forward unresolved named message */
176         if (unlikely(!destport)) {
177                 tipc_net_route_msg(buf);
178                 return dsz;
179         }
180
181         /* validate destination & pass to port, otherwise reject message */
182         p_ptr = tipc_port_lock(destport);
183         if (likely(p_ptr)) {
184                 if (likely(p_ptr->publ.connected)) {
185                         if ((unlikely(msg_origport(msg) != tipc_peer_port(p_ptr))) ||
186                             (unlikely(msg_orignode(msg) != tipc_peer_node(p_ptr))) ||
187                             (unlikely(!msg_connected(msg)))) {
188                                 err = TIPC_ERR_NO_PORT;
189                                 tipc_port_unlock(p_ptr);
190                                 goto reject;
191                         }
192                 }
193                 err = p_ptr->dispatcher(&p_ptr->publ, buf);
194                 tipc_port_unlock(p_ptr);
195                 if (likely(!err))
196                         return dsz;
197         } else {
198                 err = TIPC_ERR_NO_PORT;
199         }
200 reject:
201         dbg("port->rejecting, err = %x..\n",err);
202         return tipc_reject_msg(buf, err);
203 }
204
205 #endif