1/*
  2 * net/tipc/port.h: Include file for TIPC port code
  3 *
  4 * Copyright (c) 1994-2007, 2014, Ericsson AB
  5 * Copyright (c) 2004-2007, 2010-2013, 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#define CONN_OVERLOAD_LIMIT	((TIPC_FLOW_CONTROL_WIN * 2 + 1) * \
 47				SKB_TRUESIZE(TIPC_MAX_USER_MSG_SIZE))
 48
 49/**
 50 * struct tipc_port - TIPC port structure
 51 * @lock: pointer to spinlock for controlling access to port
 52 * @connected: non-zero if port is currently connected to a peer port
 53 * @conn_type: TIPC type used when connection was established
 54 * @conn_instance: TIPC instance used when connection was established
 55 * @conn_unacked: number of unacknowledged messages received from peer port
 56 * @published: non-zero if port has one or more associated names
 57 * @congested: non-zero if cannot send because of link or port congestion
 58 * @max_pkt: maximum packet size "hint" used when building messages sent by port
 59 * @ref: unique reference to port in TIPC object registry
 60 * @phdr: preformatted message header used when sending messages
 61 * @port_list: adjacent ports in TIPC's global list of ports
 62 * @wait_list: adjacent ports in list of ports waiting on link congestion
 63 * @waiting_pkts:
 64 * @sent: # of non-empty messages sent by port
 65 * @acked: # of non-empty message acknowledgements from connected port's peer
 66 * @publications: list of publications for port
 67 * @pub_count: total # of publications port has made during its lifetime
 68 * @probing_state:
 69 * @probing_interval:
 70 * @timer_ref:
 71 * @subscription: "node down" subscription used to terminate failed connections
 72 */
 73struct tipc_port {
 74	spinlock_t *lock;
 75	int connected;
 76	u32 conn_type;
 77	u32 conn_instance;
 78	u32 conn_unacked;
 79	int published;
 80	u32 congested;
 81	u32 max_pkt;
 82	u32 ref;
 83	struct tipc_msg phdr;
 84	struct list_head port_list;
 85	struct list_head wait_list;
 86	u32 waiting_pkts;
 87	u32 sent;
 88	u32 acked;
 89	struct list_head publications;
 90	u32 pub_count;
 91	u32 probing_state;
 92	u32 probing_interval;
 93	struct timer_list timer;
 94	struct tipc_node_subscr subscription;
 95};
 96
 97extern spinlock_t tipc_port_list_lock;
 98struct tipc_port_list;
 99
100/*
101 * TIPC port manipulation routines
102 */
103u32 tipc_port_init(struct tipc_port *p_ptr,
104		   const unsigned int importance);
105
106int tipc_reject_msg(struct sk_buff *buf, u32 err);
107
108void tipc_acknowledge(u32 port_ref, u32 ack);
109
110void tipc_port_destroy(struct tipc_port *p_ptr);
111
112int tipc_publish(struct tipc_port *p_ptr, unsigned int scope,
113		 struct tipc_name_seq const *name_seq);
114
115int tipc_withdraw(struct tipc_port *p_ptr, unsigned int scope,
116		  struct tipc_name_seq const *name_seq);
117
118int tipc_port_connect(u32 portref, struct tipc_portid const *port);
119
120int tipc_port_disconnect(u32 portref);
121
122int tipc_port_shutdown(u32 ref);
123
124void tipc_port_wakeup(struct tipc_port *port);
125
126/*
127 * The following routines require that the port be locked on entry
128 */
129int __tipc_port_disconnect(struct tipc_port *tp_ptr);
130int __tipc_port_connect(u32 ref, struct tipc_port *p_ptr,
131		   struct tipc_portid const *peer);
132int tipc_port_peer_msg(struct tipc_port *p_ptr, struct tipc_msg *msg);
133
134/*
135 * TIPC messaging routines
136 */
137int tipc_port_rcv(struct sk_buff *buf);
138
139int tipc_send(struct tipc_port *port,
140	      struct iovec const *msg_sect,
141	      unsigned int len);
142
143int tipc_send2name(struct tipc_port *port,
144		   struct tipc_name const *name,
145		   u32 domain,
146		   struct iovec const *msg_sect,
147		   unsigned int len);
148
149int tipc_send2port(struct tipc_port *port,
150		   struct tipc_portid const *dest,
151		   struct iovec const *msg_sect,
152		   unsigned int len);
153
154int tipc_port_mcast_xmit(struct tipc_port *port,
155			 struct tipc_name_seq const *seq,
156			 struct iovec const *msg,
157			 unsigned int len);
158
159int tipc_port_iovec_reject(struct tipc_port *p_ptr,
160			   struct tipc_msg *hdr,
161			   struct iovec const *msg_sect,
162			   unsigned int len,
163			   int err);
164
165struct sk_buff *tipc_port_get_ports(void);
166void tipc_port_proto_rcv(struct sk_buff *buf);
167void tipc_port_mcast_rcv(struct sk_buff *buf, struct tipc_port_list *dp);
168void tipc_port_reinit(void);
169
170/**
171 * tipc_port_lock - lock port instance referred to and return its pointer
172 */
173static inline struct tipc_port *tipc_port_lock(u32 ref)
174{
175	return (struct tipc_port *)tipc_ref_lock(ref);
176}
177
178/**
179 * tipc_port_unlock - unlock a port instance
180 *
181 * Can use pointer instead of tipc_ref_unlock() since port is already locked.
182 */
183static inline void tipc_port_unlock(struct tipc_port *p_ptr)
184{
185	spin_unlock_bh(p_ptr->lock);
186}
187
188static inline int tipc_port_congested(struct tipc_port *p_ptr)
189{
190	return (p_ptr->sent - p_ptr->acked) >= (TIPC_FLOW_CONTROL_WIN * 2);
191}
192
193
194static inline u32 tipc_port_peernode(struct tipc_port *p_ptr)
195{
196	return msg_destnode(&p_ptr->phdr);
197}
198
199static inline u32 tipc_port_peerport(struct tipc_port *p_ptr)
200{
201	return msg_destport(&p_ptr->phdr);
202}
203
204static inline  bool tipc_port_unreliable(struct tipc_port *port)
205{
206	return msg_src_droppable(&port->phdr) != 0;
207}
208
209static inline void tipc_port_set_unreliable(struct tipc_port *port,
210					    bool unreliable)
211{
212	msg_set_src_droppable(&port->phdr, unreliable ? 1 : 0);
213}
214
215static inline bool tipc_port_unreturnable(struct tipc_port *port)
216{
217	return msg_dest_droppable(&port->phdr) != 0;
218}
219
220static inline void tipc_port_set_unreturnable(struct tipc_port *port,
221					     bool unreturnable)
222{
223	msg_set_dest_droppable(&port->phdr, unreturnable ? 1 : 0);
224}
225
226
227static inline int tipc_port_importance(struct tipc_port *port)
228{
229	return msg_importance(&port->phdr);
230}
231
232static inline void tipc_port_set_importance(struct tipc_port *port, int imp)
233{
234	msg_set_importance(&port->phdr, (u32)imp);
235}
236
237#endif