diff options
Diffstat (limited to 'net/tipc/port.h')
-rw-r--r-- | net/tipc/port.h | 209 |
1 files changed, 209 insertions, 0 deletions
diff --git a/net/tipc/port.h b/net/tipc/port.h new file mode 100644 index 000000000000..e829a99d3b7f --- /dev/null +++ b/net/tipc/port.h | |||
@@ -0,0 +1,209 @@ | |||
1 | /* | ||
2 | * net/tipc/port.h: Include file for TIPC port code | ||
3 | * | ||
4 | * Copyright (c) 1994-2006, Ericsson AB | ||
5 | * Copyright (c) 2004-2005, 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 <net/tipc/tipc_port.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 | * @congested_link: ptr to congested link port is waiting on | ||
79 | * @waiting_pkts: | ||
80 | * @sent: | ||
81 | * @acked: | ||
82 | * @publications: list of publications for port | ||
83 | * @pub_count: total # of publications port has made during its lifetime | ||
84 | * @max_pkt: maximum packet size "hint" used when building messages sent by port | ||
85 | * @probing_state: | ||
86 | * @probing_interval: | ||
87 | * @last_in_seqno: | ||
88 | * @timer_ref: | ||
89 | * @subscription: "node down" subscription used to terminate failed connections | ||
90 | */ | ||
91 | |||
92 | struct port { | ||
93 | struct tipc_port publ; | ||
94 | struct list_head port_list; | ||
95 | u32 (*dispatcher)(struct tipc_port *, struct sk_buff *); | ||
96 | void (*wakeup)(struct tipc_port *); | ||
97 | struct user_port *user_port; | ||
98 | struct list_head wait_list; | ||
99 | struct link *congested_link; | ||
100 | u32 waiting_pkts; | ||
101 | u32 sent; | ||
102 | u32 acked; | ||
103 | struct list_head publications; | ||
104 | u32 pub_count; | ||
105 | u32 max_pkt; | ||
106 | u32 probing_state; | ||
107 | u32 probing_interval; | ||
108 | u32 last_in_seqno; | ||
109 | struct timer_list timer; | ||
110 | struct node_subscr subscription; | ||
111 | }; | ||
112 | |||
113 | extern spinlock_t port_list_lock; | ||
114 | struct port_list; | ||
115 | |||
116 | int port_recv_sections(struct port *p_ptr, u32 num_sect, | ||
117 | struct iovec const *msg_sect); | ||
118 | int port_reject_sections(struct port *p_ptr, struct tipc_msg *hdr, | ||
119 | struct iovec const *msg_sect, u32 num_sect, | ||
120 | int err); | ||
121 | struct sk_buff *port_get_ports(void); | ||
122 | struct sk_buff *port_show_stats(const void *req_tlv_area, int req_tlv_space); | ||
123 | void port_recv_proto_msg(struct sk_buff *buf); | ||
124 | void port_recv_mcast(struct sk_buff *buf, struct port_list *dp); | ||
125 | void port_reinit(void); | ||
126 | |||
127 | /** | ||
128 | * port_lock - lock port instance referred to and return its pointer | ||
129 | */ | ||
130 | |||
131 | static inline struct port *port_lock(u32 ref) | ||
132 | { | ||
133 | return (struct port *)ref_lock(ref); | ||
134 | } | ||
135 | |||
136 | /** | ||
137 | * port_unlock - unlock a port instance | ||
138 | * | ||
139 | * Can use pointer instead of ref_unlock() since port is already locked. | ||
140 | */ | ||
141 | |||
142 | static inline void port_unlock(struct port *p_ptr) | ||
143 | { | ||
144 | spin_unlock_bh(p_ptr->publ.lock); | ||
145 | } | ||
146 | |||
147 | static inline struct port* port_deref(u32 ref) | ||
148 | { | ||
149 | return (struct port *)ref_deref(ref); | ||
150 | } | ||
151 | |||
152 | static inline u32 peer_port(struct port *p_ptr) | ||
153 | { | ||
154 | return msg_destport(&p_ptr->publ.phdr); | ||
155 | } | ||
156 | |||
157 | static inline u32 peer_node(struct port *p_ptr) | ||
158 | { | ||
159 | return msg_destnode(&p_ptr->publ.phdr); | ||
160 | } | ||
161 | |||
162 | static inline int port_congested(struct port *p_ptr) | ||
163 | { | ||
164 | return((p_ptr->sent - p_ptr->acked) >= (TIPC_FLOW_CONTROL_WIN * 2)); | ||
165 | } | ||
166 | |||
167 | /** | ||
168 | * port_recv_msg - receive message from lower layer and deliver to port user | ||
169 | */ | ||
170 | |||
171 | static inline int port_recv_msg(struct sk_buff *buf) | ||
172 | { | ||
173 | struct port *p_ptr; | ||
174 | struct tipc_msg *msg = buf_msg(buf); | ||
175 | u32 destport = msg_destport(msg); | ||
176 | u32 dsz = msg_data_sz(msg); | ||
177 | u32 err; | ||
178 | |||
179 | /* forward unresolved named message */ | ||
180 | if (unlikely(!destport)) { | ||
181 | net_route_msg(buf); | ||
182 | return dsz; | ||
183 | } | ||
184 | |||
185 | /* validate destination & pass to port, otherwise reject message */ | ||
186 | p_ptr = port_lock(destport); | ||
187 | if (likely(p_ptr)) { | ||
188 | if (likely(p_ptr->publ.connected)) { | ||
189 | if ((unlikely(msg_origport(msg) != peer_port(p_ptr))) || | ||
190 | (unlikely(msg_orignode(msg) != peer_node(p_ptr))) || | ||
191 | (unlikely(!msg_connected(msg)))) { | ||
192 | err = TIPC_ERR_NO_PORT; | ||
193 | port_unlock(p_ptr); | ||
194 | goto reject; | ||
195 | } | ||
196 | } | ||
197 | err = p_ptr->dispatcher(&p_ptr->publ, buf); | ||
198 | port_unlock(p_ptr); | ||
199 | if (likely(!err)) | ||
200 | return dsz; | ||
201 | } else { | ||
202 | err = TIPC_ERR_NO_PORT; | ||
203 | } | ||
204 | reject: | ||
205 | dbg("port->rejecting, err = %x..\n",err); | ||
206 | return tipc_reject_msg(buf, err); | ||
207 | } | ||
208 | |||
209 | #endif | ||