Commit | Line | Data |
---|---|---|
b97bf3fd PL |
1 | /* |
2 | * net/tipc/port.h: Include file for TIPC port code | |
c4307285 | 3 | * |
05646c91 | 4 | * Copyright (c) 1994-2007, Ericsson AB |
198d73b8 | 5 | * Copyright (c) 2004-2007, 2010-2013, Wind River Systems |
b97bf3fd PL |
6 | * All rights reserved. |
7 | * | |
9ea1fd3c | 8 | * Redistribution and use in source and binary forms, with or without |
b97bf3fd PL |
9 | * modification, are permitted provided that the following conditions are met: |
10 | * | |
9ea1fd3c PL |
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. | |
b97bf3fd | 19 | * |
9ea1fd3c PL |
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 | |
b97bf3fd PL |
34 | * POSSIBILITY OF SUCH DAMAGE. |
35 | */ | |
36 | ||
37 | #ifndef _TIPC_PORT_H | |
38 | #define _TIPC_PORT_H | |
39 | ||
b97bf3fd PL |
40 | #include "ref.h" |
41 | #include "net.h" | |
42 | #include "msg.h" | |
b97bf3fd PL |
43 | #include "node_subscr.h" |
44 | ||
d265fef6 | 45 | #define TIPC_FLOW_CONTROL_WIN 512 |
cc79dd1b YX |
46 | #define CONN_OVERLOAD_LIMIT ((TIPC_FLOW_CONTROL_WIN * 2 + 1) * \ |
47 | SKB_TRUESIZE(TIPC_MAX_USER_MSG_SIZE)) | |
d265fef6 | 48 | |
d265fef6 | 49 | /** |
23dd4cce | 50 | * struct tipc_port - TIPC port structure |
d265fef6 AS |
51 | * @usr_handle: pointer to additional user-defined information about port |
52 | * @lock: pointer to spinlock for controlling access to port | |
53 | * @connected: non-zero if port is currently connected to a peer port | |
54 | * @conn_type: TIPC type used when connection was established | |
55 | * @conn_instance: TIPC instance used when connection was established | |
56 | * @conn_unacked: number of unacknowledged messages received from peer port | |
57 | * @published: non-zero if port has one or more associated names | |
58 | * @congested: non-zero if cannot send because of link or port congestion | |
59 | * @max_pkt: maximum packet size "hint" used when building messages sent by port | |
60 | * @ref: unique reference to port in TIPC object registry | |
61 | * @phdr: preformatted message header used when sending messages | |
b97bf3fd PL |
62 | * @port_list: adjacent ports in TIPC's global list of ports |
63 | * @dispatcher: ptr to routine which handles received messages | |
64 | * @wakeup: ptr to routine to call when port is no longer congested | |
b97bf3fd | 65 | * @wait_list: adjacent ports in list of ports waiting on link congestion |
b97bf3fd | 66 | * @waiting_pkts: |
cb7ce914 AS |
67 | * @sent: # of non-empty messages sent by port |
68 | * @acked: # of non-empty message acknowledgements from connected port's peer | |
b97bf3fd PL |
69 | * @publications: list of publications for port |
70 | * @pub_count: total # of publications port has made during its lifetime | |
b97bf3fd PL |
71 | * @probing_state: |
72 | * @probing_interval: | |
b97bf3fd PL |
73 | * @timer_ref: |
74 | * @subscription: "node down" subscription used to terminate failed connections | |
75 | */ | |
23dd4cce AS |
76 | struct tipc_port { |
77 | void *usr_handle; | |
78 | spinlock_t *lock; | |
79 | int connected; | |
80 | u32 conn_type; | |
81 | u32 conn_instance; | |
82 | u32 conn_unacked; | |
83 | int published; | |
84 | u32 congested; | |
85 | u32 max_pkt; | |
86 | u32 ref; | |
87 | struct tipc_msg phdr; | |
b97bf3fd PL |
88 | struct list_head port_list; |
89 | u32 (*dispatcher)(struct tipc_port *, struct sk_buff *); | |
90 | void (*wakeup)(struct tipc_port *); | |
b97bf3fd | 91 | struct list_head wait_list; |
b97bf3fd PL |
92 | u32 waiting_pkts; |
93 | u32 sent; | |
94 | u32 acked; | |
95 | struct list_head publications; | |
96 | u32 pub_count; | |
b97bf3fd PL |
97 | u32 probing_state; |
98 | u32 probing_interval; | |
b97bf3fd | 99 | struct timer_list timer; |
6c00055a | 100 | struct tipc_node_subscr subscription; |
b97bf3fd PL |
101 | }; |
102 | ||
4323add6 | 103 | extern spinlock_t tipc_port_list_lock; |
4584310b | 104 | struct tipc_port_list; |
b97bf3fd | 105 | |
d265fef6 AS |
106 | /* |
107 | * TIPC port manipulation routines | |
108 | */ | |
3c5db8e4 | 109 | struct tipc_port *tipc_createport(void *usr_handle, |
d265fef6 AS |
110 | u32 (*dispatcher)(struct tipc_port *, struct sk_buff *), |
111 | void (*wakeup)(struct tipc_port *), const u32 importance); | |
112 | ||
113 | int tipc_reject_msg(struct sk_buff *buf, u32 err); | |
114 | ||
d265fef6 AS |
115 | void tipc_acknowledge(u32 port_ref, u32 ack); |
116 | ||
d265fef6 AS |
117 | int tipc_deleteport(u32 portref); |
118 | ||
d265fef6 AS |
119 | int tipc_portimportance(u32 portref, unsigned int *importance); |
120 | int tipc_set_portimportance(u32 portref, unsigned int importance); | |
121 | ||
122 | int tipc_portunreliable(u32 portref, unsigned int *isunreliable); | |
123 | int tipc_set_portunreliable(u32 portref, unsigned int isunreliable); | |
124 | ||
125 | int tipc_portunreturnable(u32 portref, unsigned int *isunreturnable); | |
126 | int tipc_set_portunreturnable(u32 portref, unsigned int isunreturnable); | |
127 | ||
128 | int tipc_publish(u32 portref, unsigned int scope, | |
129 | struct tipc_name_seq const *name_seq); | |
130 | int tipc_withdraw(u32 portref, unsigned int scope, | |
131 | struct tipc_name_seq const *name_seq); | |
132 | ||
bc879117 | 133 | int tipc_connect(u32 portref, struct tipc_portid const *port); |
d265fef6 AS |
134 | |
135 | int tipc_disconnect(u32 portref); | |
136 | ||
137 | int tipc_shutdown(u32 ref); | |
138 | ||
139 | ||
140 | /* | |
141 | * The following routines require that the port be locked on entry | |
142 | */ | |
bc879117 PG |
143 | int __tipc_disconnect(struct tipc_port *tp_ptr); |
144 | int __tipc_connect(u32 ref, struct tipc_port *p_ptr, | |
145 | struct tipc_portid const *peer); | |
f0712e86 | 146 | int tipc_port_peer_msg(struct tipc_port *p_ptr, struct tipc_msg *msg); |
d265fef6 AS |
147 | |
148 | /* | |
149 | * TIPC messaging routines | |
150 | */ | |
9b641251 | 151 | int tipc_port_recv_msg(struct sk_buff *buf); |
26896904 AS |
152 | int tipc_send(u32 portref, unsigned int num_sect, struct iovec const *msg_sect, |
153 | unsigned int total_len); | |
d265fef6 AS |
154 | |
155 | int tipc_send2name(u32 portref, struct tipc_name const *name, u32 domain, | |
26896904 AS |
156 | unsigned int num_sect, struct iovec const *msg_sect, |
157 | unsigned int total_len); | |
d265fef6 AS |
158 | |
159 | int tipc_send2port(u32 portref, struct tipc_portid const *dest, | |
26896904 AS |
160 | unsigned int num_sect, struct iovec const *msg_sect, |
161 | unsigned int total_len); | |
d265fef6 | 162 | |
38f232ea | 163 | int tipc_multicast(u32 portref, struct tipc_name_seq const *seq, |
26896904 AS |
164 | unsigned int section_count, struct iovec const *msg, |
165 | unsigned int total_len); | |
d265fef6 | 166 | |
23dd4cce | 167 | int tipc_port_reject_sections(struct tipc_port *p_ptr, struct tipc_msg *hdr, |
4323add6 | 168 | struct iovec const *msg_sect, u32 num_sect, |
26896904 | 169 | unsigned int total_len, int err); |
4323add6 | 170 | struct sk_buff *tipc_port_get_ports(void); |
4323add6 | 171 | void tipc_port_recv_proto_msg(struct sk_buff *buf); |
4584310b | 172 | void tipc_port_recv_mcast(struct sk_buff *buf, struct tipc_port_list *dp); |
4323add6 | 173 | void tipc_port_reinit(void); |
b97bf3fd PL |
174 | |
175 | /** | |
4323add6 | 176 | * tipc_port_lock - lock port instance referred to and return its pointer |
b97bf3fd | 177 | */ |
23dd4cce | 178 | static inline struct tipc_port *tipc_port_lock(u32 ref) |
b97bf3fd | 179 | { |
23dd4cce | 180 | return (struct tipc_port *)tipc_ref_lock(ref); |
b97bf3fd PL |
181 | } |
182 | ||
c4307285 | 183 | /** |
4323add6 | 184 | * tipc_port_unlock - unlock a port instance |
c4307285 | 185 | * |
4323add6 | 186 | * Can use pointer instead of tipc_ref_unlock() since port is already locked. |
b97bf3fd | 187 | */ |
23dd4cce | 188 | static inline void tipc_port_unlock(struct tipc_port *p_ptr) |
b97bf3fd | 189 | { |
23dd4cce | 190 | spin_unlock_bh(p_ptr->lock); |
b97bf3fd PL |
191 | } |
192 | ||
23dd4cce | 193 | static inline struct tipc_port *tipc_port_deref(u32 ref) |
b97bf3fd | 194 | { |
23dd4cce | 195 | return (struct tipc_port *)tipc_ref_deref(ref); |
b97bf3fd PL |
196 | } |
197 | ||
23dd4cce | 198 | static inline int tipc_port_congested(struct tipc_port *p_ptr) |
b97bf3fd | 199 | { |
a02cec21 | 200 | return (p_ptr->sent - p_ptr->acked) >= (TIPC_FLOW_CONTROL_WIN * 2); |
b97bf3fd PL |
201 | } |
202 | ||
b97bf3fd | 203 | #endif |