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  * @published: non-zero if port has one or more associated names
  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
  60  * @port_list: adjacent ports in TIPC's global list of ports
  61  * @publications: list of publications for port
  62  * @pub_count: total # of publications port has made during its lifetime
  63  * @probing_state:
  64  * @probing_interval:
  65  * @timer_ref:
  66  * @subscription: "node down" subscription used to terminate failed connections
  67  */
  68 struct tipc_port {
  69         spinlock_t *lock;
  70         int connected;
  71         u32 conn_type;
  72         u32 conn_instance;
  73         int published;
  74         u32 max_pkt;
  75         u32 ref;
  76         struct tipc_msg phdr;
  77         struct list_head port_list;
  78         struct list_head publications;
  79         u32 pub_count;
  80         u32 probing_state;
  81         u32 probing_interval;
  82         struct timer_list timer;
  83         struct tipc_node_subscr subscription;
  84 };
  85
  86 extern spinlock_t tipc_port_list_lock;
  87 struct tipc_port_list;
  88
  89 /*
  90  * TIPC port manipulation routines
  91  */
  92 u32 tipc_port_init(struct tipc_port *p_ptr,
  93                    const unsigned int importance);
  94
  95 void tipc_acknowledge(u32 port_ref, u32 ack);
  96
  97 void tipc_port_destroy(struct tipc_port *p_ptr);
  98
  99 int tipc_publish(struct tipc_port *p_ptr, unsigned int scope,
 100                  struct tipc_name_seq const *name_seq);
 101
 102 int tipc_withdraw(struct tipc_port *p_ptr, unsigned int scope,
 103                   struct tipc_name_seq const *name_seq);
 104
 105 int tipc_port_connect(u32 portref, struct tipc_portid const *port);
 106
 107 int tipc_port_disconnect(u32 portref);
 108
 109 /*
 110  * The following routines require that the port be locked on entry
 111  */
 112 int __tipc_port_disconnect(struct tipc_port *tp_ptr);
 113 int __tipc_port_connect(u32 ref, struct tipc_port *p_ptr,
 114                    struct tipc_portid const *peer);
 115 int tipc_port_peer_msg(struct tipc_port *p_ptr, struct tipc_msg *msg);
 116
 117 struct sk_buff *tipc_port_get_ports(void);
 118 void tipc_port_reinit(void);
 119
 120 /**
 121  * tipc_port_lock - lock port instance referred to and return its pointer
 122  */
 123 static inline struct tipc_port *tipc_port_lock(u32 ref)
 124 {
 125         return (struct tipc_port *)tipc_ref_lock(ref);
 126 }
 127
 128 /**
 129  * tipc_port_unlock - unlock a port instance
 130  *
 131  * Can use pointer instead of tipc_ref_unlock() since port is already locked.
 132  */
 133 static inline void tipc_port_unlock(struct tipc_port *p_ptr)
 134 {
 135         spin_unlock_bh(p_ptr->lock);
 136 }
 137
 138 static inline u32 tipc_port_peernode(struct tipc_port *p_ptr)
 139 {
 140         return msg_destnode(&p_ptr->phdr);
 141 }
 142
 143 static inline u32 tipc_port_peerport(struct tipc_port *p_ptr)
 144 {
 145         return msg_destport(&p_ptr->phdr);
 146 }
 147
 148 static inline  bool tipc_port_unreliable(struct tipc_port *port)
 149 {
 150         return msg_src_droppable(&port->phdr) != 0;
 151 }
 152
 153 static inline void tipc_port_set_unreliable(struct tipc_port *port,
 154                                             bool unreliable)
 155 {
 156         msg_set_src_droppable(&port->phdr, unreliable ? 1 : 0);
 157 }
 158
 159 static inline bool tipc_port_unreturnable(struct tipc_port *port)
 160 {
 161         return msg_dest_droppable(&port->phdr) != 0;
 162 }
 163
 164 static inline void tipc_port_set_unreturnable(struct tipc_port *port,
 165                                              bool unreturnable)
 166 {
 167         msg_set_dest_droppable(&port->phdr, unreturnable ? 1 : 0);
 168 }
 169
 170
 171 static inline int tipc_port_importance(struct tipc_port *port)
 172 {
 173         return msg_importance(&port->phdr);
 174 }
 175
 176 static inline int tipc_port_set_importance(struct tipc_port *port, int imp)
 177 {
 178         if (imp > TIPC_CRITICAL_IMPORTANCE)
 179                 return -EINVAL;
 180         msg_set_importance(&port->phdr, (u32)imp);
 181         return 0;
 182 }
 183
 184 #endif