]>
Commit | Line | Data |
---|---|---|
b97bf3fd PL |
1 | /* |
2 | * net/tipc/port.h: Include file for TIPC port code | |
c4307285 | 3 | * |
8826cde6 | 4 | * Copyright (c) 1994-2007, 2014, 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 | ||
6163a194 JPM |
45 | #define TIPC_CONNACK_INTV 256 |
46 | #define TIPC_FLOWCTRL_WIN (TIPC_CONNACK_INTV * 2) | |
47 | #define TIPC_CONN_OVERLOAD_LIMIT ((TIPC_FLOWCTRL_WIN * 2 + 1) * \ | |
48 | SKB_TRUESIZE(TIPC_MAX_USER_MSG_SIZE)) | |
d265fef6 | 49 | |
d265fef6 | 50 | /** |
23dd4cce | 51 | * struct tipc_port - TIPC port structure |
d265fef6 AS |
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 | |
d265fef6 | 56 | * @published: non-zero if port has one or more associated names |
d265fef6 AS |
57 | * @max_pkt: maximum packet size "hint" used when building messages sent by port |
58 | * @ref: unique reference to port in TIPC object registry | |
59 | * @phdr: preformatted message header used when sending messages | |
b97bf3fd | 60 | * @port_list: adjacent ports in TIPC's global list of ports |
b97bf3fd | 61 | * @wait_list: adjacent ports in list of ports waiting on link congestion |
b97bf3fd | 62 | * @waiting_pkts: |
b97bf3fd PL |
63 | * @publications: list of publications for port |
64 | * @pub_count: total # of publications port has made during its lifetime | |
b97bf3fd PL |
65 | * @probing_state: |
66 | * @probing_interval: | |
b97bf3fd PL |
67 | * @timer_ref: |
68 | * @subscription: "node down" subscription used to terminate failed connections | |
69 | */ | |
23dd4cce | 70 | struct tipc_port { |
23dd4cce AS |
71 | spinlock_t *lock; |
72 | int connected; | |
73 | u32 conn_type; | |
74 | u32 conn_instance; | |
23dd4cce | 75 | int published; |
23dd4cce AS |
76 | u32 max_pkt; |
77 | u32 ref; | |
78 | struct tipc_msg phdr; | |
b97bf3fd | 79 | struct list_head port_list; |
b97bf3fd | 80 | struct list_head wait_list; |
b97bf3fd | 81 | u32 waiting_pkts; |
b97bf3fd PL |
82 | struct list_head publications; |
83 | u32 pub_count; | |
b97bf3fd PL |
84 | u32 probing_state; |
85 | u32 probing_interval; | |
b97bf3fd | 86 | struct timer_list timer; |
6c00055a | 87 | struct tipc_node_subscr subscription; |
b97bf3fd PL |
88 | }; |
89 | ||
4323add6 | 90 | extern spinlock_t tipc_port_list_lock; |
4584310b | 91 | struct tipc_port_list; |
b97bf3fd | 92 | |
d265fef6 AS |
93 | /* |
94 | * TIPC port manipulation routines | |
95 | */ | |
24be34b5 JPM |
96 | u32 tipc_port_init(struct tipc_port *p_ptr, |
97 | const unsigned int importance); | |
d265fef6 | 98 | |
d265fef6 AS |
99 | void tipc_acknowledge(u32 port_ref, u32 ack); |
100 | ||
24be34b5 | 101 | void tipc_port_destroy(struct tipc_port *p_ptr); |
d265fef6 | 102 | |
84602761 | 103 | int tipc_publish(struct tipc_port *p_ptr, unsigned int scope, |
ae8509c4 | 104 | struct tipc_name_seq const *name_seq); |
5c311421 | 105 | |
84602761 | 106 | int tipc_withdraw(struct tipc_port *p_ptr, unsigned int scope, |
ae8509c4 | 107 | struct tipc_name_seq const *name_seq); |
d265fef6 | 108 | |
247f0f3c | 109 | int tipc_port_connect(u32 portref, struct tipc_portid const *port); |
d265fef6 | 110 | |
247f0f3c | 111 | int tipc_port_disconnect(u32 portref); |
d265fef6 | 112 | |
247f0f3c | 113 | int tipc_port_shutdown(u32 ref); |
d265fef6 | 114 | |
d265fef6 AS |
115 | /* |
116 | * The following routines require that the port be locked on entry | |
117 | */ | |
247f0f3c YX |
118 | int __tipc_port_disconnect(struct tipc_port *tp_ptr); |
119 | int __tipc_port_connect(u32 ref, struct tipc_port *p_ptr, | |
bc879117 | 120 | struct tipc_portid const *peer); |
f0712e86 | 121 | int tipc_port_peer_msg(struct tipc_port *p_ptr, struct tipc_msg *msg); |
d265fef6 | 122 | |
4323add6 | 123 | struct sk_buff *tipc_port_get_ports(void); |
4323add6 | 124 | void tipc_port_reinit(void); |
b97bf3fd PL |
125 | |
126 | /** | |
4323add6 | 127 | * tipc_port_lock - lock port instance referred to and return its pointer |
b97bf3fd | 128 | */ |
23dd4cce | 129 | static inline struct tipc_port *tipc_port_lock(u32 ref) |
b97bf3fd | 130 | { |
23dd4cce | 131 | return (struct tipc_port *)tipc_ref_lock(ref); |
b97bf3fd PL |
132 | } |
133 | ||
c4307285 | 134 | /** |
4323add6 | 135 | * tipc_port_unlock - unlock a port instance |
c4307285 | 136 | * |
4323add6 | 137 | * Can use pointer instead of tipc_ref_unlock() since port is already locked. |
b97bf3fd | 138 | */ |
23dd4cce | 139 | static inline void tipc_port_unlock(struct tipc_port *p_ptr) |
b97bf3fd | 140 | { |
23dd4cce | 141 | spin_unlock_bh(p_ptr->lock); |
b97bf3fd PL |
142 | } |
143 | ||
f9fef18c JPM |
144 | static inline u32 tipc_port_peernode(struct tipc_port *p_ptr) |
145 | { | |
146 | return msg_destnode(&p_ptr->phdr); | |
147 | } | |
148 | ||
149 | static inline u32 tipc_port_peerport(struct tipc_port *p_ptr) | |
150 | { | |
151 | return msg_destport(&p_ptr->phdr); | |
152 | } | |
153 | ||
3b4f302d JPM |
154 | static inline bool tipc_port_unreliable(struct tipc_port *port) |
155 | { | |
156 | return msg_src_droppable(&port->phdr) != 0; | |
157 | } | |
158 | ||
159 | static inline void tipc_port_set_unreliable(struct tipc_port *port, | |
160 | bool unreliable) | |
161 | { | |
162 | msg_set_src_droppable(&port->phdr, unreliable ? 1 : 0); | |
163 | } | |
164 | ||
165 | static inline bool tipc_port_unreturnable(struct tipc_port *port) | |
166 | { | |
167 | return msg_dest_droppable(&port->phdr) != 0; | |
168 | } | |
169 | ||
170 | static inline void tipc_port_set_unreturnable(struct tipc_port *port, | |
171 | bool unreturnable) | |
172 | { | |
173 | msg_set_dest_droppable(&port->phdr, unreturnable ? 1 : 0); | |
174 | } | |
175 | ||
176 | ||
177 | static inline int tipc_port_importance(struct tipc_port *port) | |
178 | { | |
179 | return msg_importance(&port->phdr); | |
180 | } | |
181 | ||
ac32c7f7 | 182 | static inline int tipc_port_set_importance(struct tipc_port *port, int imp) |
3b4f302d | 183 | { |
ac32c7f7 EH |
184 | if (imp > TIPC_CRITICAL_IMPORTANCE) |
185 | return -EINVAL | |
3b4f302d JPM |
186 | msg_set_importance(&port->phdr, (u32)imp); |
187 | } | |
188 | ||
b97bf3fd | 189 | #endif |