net/tipc/port.h

   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_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))
  49
  50 /**
  51  * struct tipc_port - TIPC port structure
  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
  62  * @port_list: adjacent ports in TIPC's global list of ports
  63  * @wait_list: adjacent ports in list of ports waiting on link congestion
  64  * @waiting_pkts:
  65  * @sent: # of non-empty messages sent by port
  66  * @acked: # of non-empty message acknowledgements from connected port's peer
  67  * @publications: list of publications for port
  68  * @pub_count: total # of publications port has made during its lifetime
  69  * @probing_state:
  70  * @probing_interval:
  71  * @timer_ref:
  72  * @subscription: "node down" subscription used to terminate failed connections
  73  */
  74 struct tipc_port {
  75         spinlock_t *lock;
  76         int connected;
  77         u32 conn_type;
  78         u32 conn_instance;
  79         u32 conn_unacked;
  80         int published;
  81         u32 congested;
  82         u32 max_pkt;
  83         u32 ref;
  84         struct tipc_msg phdr;
  85         struct list_head port_list;
  86         struct list_head wait_list;
  87         u32 waiting_pkts;
  88         u32 sent;
  89         u32 acked;
  90         struct list_head publications;
  91         u32 pub_count;
  92         u32 probing_state;
  93         u32 probing_interval;
  94         struct timer_list timer;
  95         struct tipc_node_subscr subscription;
  96 };
  97
  98 extern spinlock_t tipc_port_list_lock;
  99 struct tipc_port_list;
 100
 101 /*
 102  * TIPC port manipulation routines
 103  */
 104 u32 tipc_port_init(struct tipc_port *p_ptr,
 105                    const unsigned int importance);
 106
 107 void tipc_acknowledge(u32 port_ref, u32 ack);
 108
 109 void tipc_port_destroy(struct tipc_port *p_ptr);
 110
 111 int tipc_publish(struct tipc_port *p_ptr, unsigned int scope,
 112                  struct tipc_name_seq const *name_seq);
 113
 114 int tipc_withdraw(struct tipc_port *p_ptr, unsigned int scope,
 115                   struct tipc_name_seq const *name_seq);
 116
 117 int tipc_port_connect(u32 portref, struct tipc_portid const *port);
 118
 119 int tipc_port_disconnect(u32 portref);
 120
 121 int tipc_port_shutdown(u32 ref);
 122
 123 void tipc_port_wakeup(struct tipc_port *port);
 124
 125 /*
 126  * The following routines require that the port be locked on entry
 127  */
 128 int __tipc_port_disconnect(struct tipc_port *tp_ptr);
 129 int __tipc_port_connect(u32 ref, struct tipc_port *p_ptr,
 130                    struct tipc_portid const *peer);
 131 int tipc_port_peer_msg(struct tipc_port *p_ptr, struct tipc_msg *msg);
 132
 133 /*
 134  * TIPC messaging routines
 135  */
 136
 137 int tipc_port_mcast_xmit(struct tipc_port *port,
 138                          struct tipc_name_seq const *seq,
 139                          struct iovec const *msg,
 140                          unsigned int len);
 141
 142 struct sk_buff *tipc_port_get_ports(void);
 143 void tipc_port_mcast_rcv(struct sk_buff *buf, struct tipc_port_list *dp);
 144 void tipc_port_reinit(void);
 145
 146 /**
 147  * tipc_port_lock - lock port instance referred to and return its pointer
 148  */
 149 static inline struct tipc_port *tipc_port_lock(u32 ref)
 150 {
 151         return (struct tipc_port *)tipc_ref_lock(ref);
 152 }
 153
 154 /**
 155  * tipc_port_unlock - unlock a port instance
 156  *
 157  * Can use pointer instead of tipc_ref_unlock() since port is already locked.
 158  */
 159 static inline void tipc_port_unlock(struct tipc_port *p_ptr)
 160 {
 161         spin_unlock_bh(p_ptr->lock);
 162 }
 163
 164 static inline int tipc_port_congested(struct tipc_port *p_ptr)
 165 {
 166         return ((p_ptr->sent - p_ptr->acked) >= TIPC_FLOWCTRL_WIN);
 167 }
 168
 169
 170 static inline u32 tipc_port_peernode(struct tipc_port *p_ptr)
 171 {
 172         return msg_destnode(&p_ptr->phdr);
 173 }
 174
 175 static inline u32 tipc_port_peerport(struct tipc_port *p_ptr)
 176 {
 177         return msg_destport(&p_ptr->phdr);
 178 }
 179
 180 static inline  bool tipc_port_unreliable(struct tipc_port *port)
 181 {
 182         return msg_src_droppable(&port->phdr) != 0;
 183 }
 184
 185 static inline void tipc_port_set_unreliable(struct tipc_port *port,
 186                                             bool unreliable)
 187 {
 188         msg_set_src_droppable(&port->phdr, unreliable ? 1 : 0);
 189 }
 190
 191 static inline bool tipc_port_unreturnable(struct tipc_port *port)
 192 {
 193         return msg_dest_droppable(&port->phdr) != 0;
 194 }
 195
 196 static inline void tipc_port_set_unreturnable(struct tipc_port *port,
 197                                              bool unreturnable)
 198 {
 199         msg_set_dest_droppable(&port->phdr, unreturnable ? 1 : 0);
 200 }
 201
 202
 203 static inline int tipc_port_importance(struct tipc_port *port)
 204 {
 205         return msg_importance(&port->phdr);
 206 }
 207
 208 static inline void tipc_port_set_importance(struct tipc_port *port, int imp)
 209 {
 210         msg_set_importance(&port->phdr, (u32)imp);
 211 }
 212
 213 #endif