Linux Kernel  3.7.1
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
port.h
Go to the documentation of this file.
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, 2010-2011, 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 "ref.h"
41 #include "net.h"
42 #include "msg.h"
43 #include "node_subscr.h"
44 
45 #define TIPC_FLOW_CONTROL_WIN 512
46 
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);
51 
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);
56 
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);
60 
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);
65 
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);
71 
72 typedef void (*tipc_conn_msg_event) (void *usr_handle, u32 portref,
73  struct sk_buff **buf, unsigned char const *data,
74  unsigned int size);
75 
76 typedef void (*tipc_continue_event) (void *usr_handle, u32 portref);
77 
85 struct user_port {
86  void *usr_handle;
95 };
96 
125 struct tipc_port {
126  void *usr_handle;
136  struct tipc_msg phdr;
138  u32 (*dispatcher)(struct tipc_port *, struct sk_buff *);
139  void (*wakeup)(struct tipc_port *);
151 };
152 
154 struct tipc_port_list;
155 
156 /*
157  * TIPC port manipulation routines
158  */
160  u32 (*dispatcher)(struct tipc_port *, struct sk_buff *),
161  void (*wakeup)(struct tipc_port *), const u32 importance);
162 
163 int tipc_reject_msg(struct sk_buff *buf, u32 err);
164 
165 int tipc_send_buf_fast(struct sk_buff *buf, u32 destnode);
166 
167 void tipc_acknowledge(u32 port_ref, u32 ack);
168 
169 int tipc_createport(void *usr_handle,
170  unsigned int importance, tipc_msg_err_event error_cb,
171  tipc_named_msg_err_event named_error_cb,
172  tipc_conn_shutdown_event conn_error_cb, tipc_msg_event msg_cb,
173  tipc_named_msg_event named_msg_cb,
174  tipc_conn_msg_event conn_msg_cb,
175  tipc_continue_event continue_event_cb, u32 *portref);
176 
177 int tipc_deleteport(u32 portref);
178 
179 int tipc_portimportance(u32 portref, unsigned int *importance);
180 int tipc_set_portimportance(u32 portref, unsigned int importance);
181 
182 int tipc_portunreliable(u32 portref, unsigned int *isunreliable);
183 int tipc_set_portunreliable(u32 portref, unsigned int isunreliable);
184 
185 int tipc_portunreturnable(u32 portref, unsigned int *isunreturnable);
186 int tipc_set_portunreturnable(u32 portref, unsigned int isunreturnable);
187 
188 int tipc_publish(u32 portref, unsigned int scope,
189  struct tipc_name_seq const *name_seq);
190 int tipc_withdraw(u32 portref, unsigned int scope,
191  struct tipc_name_seq const *name_seq);
192 
193 int tipc_connect2port(u32 portref, struct tipc_portid const *port);
194 
195 int tipc_disconnect(u32 portref);
196 
197 int tipc_shutdown(u32 ref);
198 
199 
200 /*
201  * The following routines require that the port be locked on entry
202  */
203 int tipc_disconnect_port(struct tipc_port *tp_ptr);
204 int tipc_port_peer_msg(struct tipc_port *p_ptr, struct tipc_msg *msg);
205 
206 /*
207  * TIPC messaging routines
208  */
209 int tipc_port_recv_msg(struct sk_buff *buf);
210 int tipc_send(u32 portref, unsigned int num_sect, struct iovec const *msg_sect,
211  unsigned int total_len);
212 
213 int tipc_send2name(u32 portref, struct tipc_name const *name, u32 domain,
214  unsigned int num_sect, struct iovec const *msg_sect,
215  unsigned int total_len);
216 
217 int tipc_send2port(u32 portref, struct tipc_portid const *dest,
218  unsigned int num_sect, struct iovec const *msg_sect,
219  unsigned int total_len);
220 
221 int tipc_send_buf2port(u32 portref, struct tipc_portid const *dest,
222  struct sk_buff *buf, unsigned int dsz);
223 
224 int tipc_multicast(u32 portref, struct tipc_name_seq const *seq,
225  unsigned int section_count, struct iovec const *msg,
226  unsigned int total_len);
227 
228 int tipc_port_reject_sections(struct tipc_port *p_ptr, struct tipc_msg *hdr,
229  struct iovec const *msg_sect, u32 num_sect,
230  unsigned int total_len, int err);
231 struct sk_buff *tipc_port_get_ports(void);
232 void tipc_port_recv_proto_msg(struct sk_buff *buf);
233 void tipc_port_recv_mcast(struct sk_buff *buf, struct tipc_port_list *dp);
234 void tipc_port_reinit(void);
235 
239 static inline struct tipc_port *tipc_port_lock(u32 ref)
240 {
241  return (struct tipc_port *)tipc_ref_lock(ref);
242 }
243 
249 static inline void tipc_port_unlock(struct tipc_port *p_ptr)
250 {
251  spin_unlock_bh(p_ptr->lock);
252 }
253 
254 static inline struct tipc_port *tipc_port_deref(u32 ref)
255 {
256  return (struct tipc_port *)tipc_ref_deref(ref);
257 }
258 
259 static inline int tipc_port_congested(struct tipc_port *p_ptr)
260 {
261  return (p_ptr->sent - p_ptr->acked) >= (TIPC_FLOW_CONTROL_WIN * 2);
262 }
263 
264 #endif