Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 1 | /* |
| 2 | * net/tipc/port.h: Include file for TIPC port code |
YOSHIFUJI Hideaki | c430728 | 2007-02-09 23:25:21 +0900 | [diff] [blame] | 3 | * |
Jon Paul Maloy | 8826cde | 2014-03-12 11:31:09 -0400 | [diff] [blame] | 4 | * Copyright (c) 1994-2007, 2014, Ericsson AB |
Ying Xue | 198d73b | 2013-06-17 10:54:42 -0400 | [diff] [blame] | 5 | * Copyright (c) 2004-2007, 2010-2013, Wind River Systems |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 6 | * All rights reserved. |
| 7 | * |
Per Liden | 9ea1fd3 | 2006-01-11 13:30:43 +0100 | [diff] [blame] | 8 | * Redistribution and use in source and binary forms, with or without |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 9 | * modification, are permitted provided that the following conditions are met: |
| 10 | * |
Per Liden | 9ea1fd3 | 2006-01-11 13:30:43 +0100 | [diff] [blame] | 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. |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 19 | * |
Per Liden | 9ea1fd3 | 2006-01-11 13:30:43 +0100 | [diff] [blame] | 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 |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 34 | * POSSIBILITY OF SUCH DAMAGE. |
| 35 | */ |
| 36 | |
| 37 | #ifndef _TIPC_PORT_H |
| 38 | #define _TIPC_PORT_H |
| 39 | |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 40 | #include "ref.h" |
| 41 | #include "net.h" |
| 42 | #include "msg.h" |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 43 | #include "node_subscr.h" |
| 44 | |
Jon Paul Maloy | 6163a19 | 2014-05-14 05:39:08 -0400 | [diff] [blame] | 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)) |
Allan Stephens | d265fef | 2010-11-30 12:00:53 +0000 | [diff] [blame] | 49 | |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 50 | /** |
Allan Stephens | 23dd4cc | 2011-01-07 11:43:40 -0500 | [diff] [blame] | 51 | * struct tipc_port - TIPC port structure |
Allan Stephens | d265fef | 2010-11-30 12:00:53 +0000 | [diff] [blame] | 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 |
Allan Stephens | d265fef | 2010-11-30 12:00:53 +0000 | [diff] [blame] | 56 | * @published: non-zero if port has one or more associated names |
Allan Stephens | d265fef | 2010-11-30 12:00:53 +0000 | [diff] [blame] | 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 |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 60 | * @port_list: adjacent ports in TIPC's global list of ports |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 61 | * @wait_list: adjacent ports in list of ports waiting on link congestion |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 62 | * @waiting_pkts: |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 63 | * @publications: list of publications for port |
| 64 | * @pub_count: total # of publications port has made during its lifetime |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 65 | * @probing_state: |
| 66 | * @probing_interval: |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 67 | * @timer_ref: |
| 68 | * @subscription: "node down" subscription used to terminate failed connections |
| 69 | */ |
Allan Stephens | 23dd4cc | 2011-01-07 11:43:40 -0500 | [diff] [blame] | 70 | struct tipc_port { |
Allan Stephens | 23dd4cc | 2011-01-07 11:43:40 -0500 | [diff] [blame] | 71 | spinlock_t *lock; |
| 72 | int connected; |
| 73 | u32 conn_type; |
| 74 | u32 conn_instance; |
Allan Stephens | 23dd4cc | 2011-01-07 11:43:40 -0500 | [diff] [blame] | 75 | int published; |
Allan Stephens | 23dd4cc | 2011-01-07 11:43:40 -0500 | [diff] [blame] | 76 | u32 max_pkt; |
| 77 | u32 ref; |
| 78 | struct tipc_msg phdr; |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 79 | struct list_head port_list; |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 80 | struct list_head wait_list; |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 81 | u32 waiting_pkts; |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 82 | struct list_head publications; |
| 83 | u32 pub_count; |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 84 | u32 probing_state; |
| 85 | u32 probing_interval; |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 86 | struct timer_list timer; |
David S. Miller | 6c00055 | 2008-09-02 23:38:32 -0700 | [diff] [blame] | 87 | struct tipc_node_subscr subscription; |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 88 | }; |
| 89 | |
Per Liden | 4323add | 2006-01-18 00:38:21 +0100 | [diff] [blame] | 90 | extern spinlock_t tipc_port_list_lock; |
Paul Gortmaker | 4584310 | 2011-12-29 20:33:30 -0500 | [diff] [blame] | 91 | struct tipc_port_list; |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 92 | |
Allan Stephens | d265fef | 2010-11-30 12:00:53 +0000 | [diff] [blame] | 93 | /* |
| 94 | * TIPC port manipulation routines |
| 95 | */ |
Jon Paul Maloy | 24be34b | 2014-03-12 11:31:10 -0400 | [diff] [blame] | 96 | u32 tipc_port_init(struct tipc_port *p_ptr, |
| 97 | const unsigned int importance); |
Allan Stephens | d265fef | 2010-11-30 12:00:53 +0000 | [diff] [blame] | 98 | |
Allan Stephens | d265fef | 2010-11-30 12:00:53 +0000 | [diff] [blame] | 99 | void tipc_acknowledge(u32 port_ref, u32 ack); |
| 100 | |
Jon Paul Maloy | 24be34b | 2014-03-12 11:31:10 -0400 | [diff] [blame] | 101 | void tipc_port_destroy(struct tipc_port *p_ptr); |
Allan Stephens | d265fef | 2010-11-30 12:00:53 +0000 | [diff] [blame] | 102 | |
Ying Xue | 8460276 | 2013-12-27 10:18:28 +0800 | [diff] [blame] | 103 | int tipc_publish(struct tipc_port *p_ptr, unsigned int scope, |
Paul Gortmaker | ae8509c | 2013-06-17 10:54:47 -0400 | [diff] [blame] | 104 | struct tipc_name_seq const *name_seq); |
Jon Paul Maloy | 5c31142 | 2014-03-12 11:31:13 -0400 | [diff] [blame] | 105 | |
Ying Xue | 8460276 | 2013-12-27 10:18:28 +0800 | [diff] [blame] | 106 | int tipc_withdraw(struct tipc_port *p_ptr, unsigned int scope, |
Paul Gortmaker | ae8509c | 2013-06-17 10:54:47 -0400 | [diff] [blame] | 107 | struct tipc_name_seq const *name_seq); |
Allan Stephens | d265fef | 2010-11-30 12:00:53 +0000 | [diff] [blame] | 108 | |
Ying Xue | 247f0f3 | 2014-02-18 16:06:46 +0800 | [diff] [blame] | 109 | int tipc_port_connect(u32 portref, struct tipc_portid const *port); |
Allan Stephens | d265fef | 2010-11-30 12:00:53 +0000 | [diff] [blame] | 110 | |
Ying Xue | 247f0f3 | 2014-02-18 16:06:46 +0800 | [diff] [blame] | 111 | int tipc_port_disconnect(u32 portref); |
Allan Stephens | d265fef | 2010-11-30 12:00:53 +0000 | [diff] [blame] | 112 | |
Ying Xue | 247f0f3 | 2014-02-18 16:06:46 +0800 | [diff] [blame] | 113 | int tipc_port_shutdown(u32 ref); |
Allan Stephens | d265fef | 2010-11-30 12:00:53 +0000 | [diff] [blame] | 114 | |
Allan Stephens | d265fef | 2010-11-30 12:00:53 +0000 | [diff] [blame] | 115 | /* |
| 116 | * The following routines require that the port be locked on entry |
| 117 | */ |
Ying Xue | 247f0f3 | 2014-02-18 16:06:46 +0800 | [diff] [blame] | 118 | int __tipc_port_disconnect(struct tipc_port *tp_ptr); |
| 119 | int __tipc_port_connect(u32 ref, struct tipc_port *p_ptr, |
Paul Gortmaker | bc87911 | 2012-11-29 13:48:40 -0500 | [diff] [blame] | 120 | struct tipc_portid const *peer); |
Allan Stephens | f0712e86 | 2012-04-17 18:42:28 -0400 | [diff] [blame] | 121 | int tipc_port_peer_msg(struct tipc_port *p_ptr, struct tipc_msg *msg); |
Allan Stephens | d265fef | 2010-11-30 12:00:53 +0000 | [diff] [blame] | 122 | |
Per Liden | 4323add | 2006-01-18 00:38:21 +0100 | [diff] [blame] | 123 | struct sk_buff *tipc_port_get_ports(void); |
Per Liden | 4323add | 2006-01-18 00:38:21 +0100 | [diff] [blame] | 124 | void tipc_port_reinit(void); |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 125 | |
| 126 | /** |
Per Liden | 4323add | 2006-01-18 00:38:21 +0100 | [diff] [blame] | 127 | * tipc_port_lock - lock port instance referred to and return its pointer |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 128 | */ |
Allan Stephens | 23dd4cc | 2011-01-07 11:43:40 -0500 | [diff] [blame] | 129 | static inline struct tipc_port *tipc_port_lock(u32 ref) |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 130 | { |
Allan Stephens | 23dd4cc | 2011-01-07 11:43:40 -0500 | [diff] [blame] | 131 | return (struct tipc_port *)tipc_ref_lock(ref); |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 132 | } |
| 133 | |
YOSHIFUJI Hideaki | c430728 | 2007-02-09 23:25:21 +0900 | [diff] [blame] | 134 | /** |
Per Liden | 4323add | 2006-01-18 00:38:21 +0100 | [diff] [blame] | 135 | * tipc_port_unlock - unlock a port instance |
YOSHIFUJI Hideaki | c430728 | 2007-02-09 23:25:21 +0900 | [diff] [blame] | 136 | * |
Per Liden | 4323add | 2006-01-18 00:38:21 +0100 | [diff] [blame] | 137 | * Can use pointer instead of tipc_ref_unlock() since port is already locked. |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 138 | */ |
Allan Stephens | 23dd4cc | 2011-01-07 11:43:40 -0500 | [diff] [blame] | 139 | static inline void tipc_port_unlock(struct tipc_port *p_ptr) |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 140 | { |
Allan Stephens | 23dd4cc | 2011-01-07 11:43:40 -0500 | [diff] [blame] | 141 | spin_unlock_bh(p_ptr->lock); |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 142 | } |
| 143 | |
Jon Paul Maloy | f9fef18 | 2014-03-12 11:31:08 -0400 | [diff] [blame] | 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 | |
Jon Paul Maloy | 3b4f302 | 2014-03-12 11:31:11 -0400 | [diff] [blame] | 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 | |
| 182 | static inline void tipc_port_set_importance(struct tipc_port *port, int imp) |
| 183 | { |
| 184 | msg_set_importance(&port->phdr, (u32)imp); |
| 185 | } |
| 186 | |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 187 | #endif |