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 PL |
61 | * @publications: list of publications for port |
62 | * @pub_count: total # of publications port has made during its lifetime | |
b97bf3fd PL |
63 | * @probing_state: |
64 | * @probing_interval: | |
b97bf3fd PL |
65 | * @timer_ref: |
66 | * @subscription: "node down" subscription used to terminate failed connections | |
67 | */ | |
23dd4cce | 68 | struct tipc_port { |
23dd4cce AS |
69 | spinlock_t *lock; |
70 | int connected; | |
71 | u32 conn_type; | |
72 | u32 conn_instance; | |
23dd4cce | 73 | int published; |
23dd4cce AS |
74 | u32 max_pkt; |
75 | u32 ref; | |
76 | struct tipc_msg phdr; | |
b97bf3fd | 77 | struct list_head port_list; |
b97bf3fd PL |
78 | struct list_head publications; |
79 | u32 pub_count; | |
b97bf3fd PL |
80 | u32 probing_state; |
81 | u32 probing_interval; | |
b97bf3fd | 82 | struct timer_list timer; |
6c00055a | 83 | struct tipc_node_subscr subscription; |
b97bf3fd PL |
84 | }; |
85 | ||
4323add6 | 86 | extern spinlock_t tipc_port_list_lock; |
4584310b | 87 | struct tipc_port_list; |
b97bf3fd | 88 | |
d265fef6 AS |
89 | /* |
90 | * TIPC port manipulation routines | |
91 | */ | |
24be34b5 JPM |
92 | u32 tipc_port_init(struct tipc_port *p_ptr, |
93 | const unsigned int importance); | |
d265fef6 | 94 | |
d265fef6 AS |
95 | void tipc_acknowledge(u32 port_ref, u32 ack); |
96 | ||
24be34b5 | 97 | void tipc_port_destroy(struct tipc_port *p_ptr); |
d265fef6 | 98 | |
84602761 | 99 | int tipc_publish(struct tipc_port *p_ptr, unsigned int scope, |
ae8509c4 | 100 | struct tipc_name_seq const *name_seq); |
5c311421 | 101 | |
84602761 | 102 | int tipc_withdraw(struct tipc_port *p_ptr, unsigned int scope, |
ae8509c4 | 103 | struct tipc_name_seq const *name_seq); |
d265fef6 | 104 | |
f0712e86 | 105 | int tipc_port_peer_msg(struct tipc_port *p_ptr, struct tipc_msg *msg); |
d265fef6 | 106 | |
4323add6 | 107 | struct sk_buff *tipc_port_get_ports(void); |
4323add6 | 108 | void tipc_port_reinit(void); |
b97bf3fd PL |
109 | |
110 | /** | |
4323add6 | 111 | * tipc_port_lock - lock port instance referred to and return its pointer |
b97bf3fd | 112 | */ |
23dd4cce | 113 | static inline struct tipc_port *tipc_port_lock(u32 ref) |
b97bf3fd | 114 | { |
23dd4cce | 115 | return (struct tipc_port *)tipc_ref_lock(ref); |
b97bf3fd PL |
116 | } |
117 | ||
c4307285 | 118 | /** |
4323add6 | 119 | * tipc_port_unlock - unlock a port instance |
c4307285 | 120 | * |
4323add6 | 121 | * Can use pointer instead of tipc_ref_unlock() since port is already locked. |
b97bf3fd | 122 | */ |
23dd4cce | 123 | static inline void tipc_port_unlock(struct tipc_port *p_ptr) |
b97bf3fd | 124 | { |
23dd4cce | 125 | spin_unlock_bh(p_ptr->lock); |
b97bf3fd PL |
126 | } |
127 | ||
f9fef18c JPM |
128 | static inline u32 tipc_port_peernode(struct tipc_port *p_ptr) |
129 | { | |
130 | return msg_destnode(&p_ptr->phdr); | |
131 | } | |
132 | ||
133 | static inline u32 tipc_port_peerport(struct tipc_port *p_ptr) | |
134 | { | |
135 | return msg_destport(&p_ptr->phdr); | |
136 | } | |
137 | ||
3b4f302d JPM |
138 | static inline bool tipc_port_unreliable(struct tipc_port *port) |
139 | { | |
140 | return msg_src_droppable(&port->phdr) != 0; | |
141 | } | |
142 | ||
143 | static inline void tipc_port_set_unreliable(struct tipc_port *port, | |
144 | bool unreliable) | |
145 | { | |
146 | msg_set_src_droppable(&port->phdr, unreliable ? 1 : 0); | |
147 | } | |
148 | ||
149 | static inline bool tipc_port_unreturnable(struct tipc_port *port) | |
150 | { | |
151 | return msg_dest_droppable(&port->phdr) != 0; | |
152 | } | |
153 | ||
154 | static inline void tipc_port_set_unreturnable(struct tipc_port *port, | |
155 | bool unreturnable) | |
156 | { | |
157 | msg_set_dest_droppable(&port->phdr, unreturnable ? 1 : 0); | |
158 | } | |
159 | ||
160 | ||
161 | static inline int tipc_port_importance(struct tipc_port *port) | |
162 | { | |
163 | return msg_importance(&port->phdr); | |
164 | } | |
165 | ||
ac32c7f7 | 166 | static inline int tipc_port_set_importance(struct tipc_port *port, int imp) |
3b4f302d | 167 | { |
ac32c7f7 | 168 | if (imp > TIPC_CRITICAL_IMPORTANCE) |
02784f1b | 169 | return -EINVAL; |
3b4f302d | 170 | msg_set_importance(&port->phdr, (u32)imp); |
02784f1b | 171 | return 0; |
3b4f302d JPM |
172 | } |
173 | ||
b97bf3fd | 174 | #endif |