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  */
  67 struct tipc_port {
  68         spinlock_t *lock;
  69         int connected;
  70         u32 conn_type;
  71         u32 conn_instance;
  72         int published;
  73         u32 max_pkt;
  74         u32 ref;
  75         struct tipc_msg phdr;
  76         struct list_head publications;
  77         u32 pub_count;
  78         u32 probing_state;
  79         u32 probing_interval;
  80         struct timer_list timer;
  81 };
  82
  83 /*
  84  * TIPC port manipulation routines
  85  */
  86 u32 tipc_port_init(struct tipc_port *p_ptr,
  87                    const unsigned int importance);
  88
  89 void tipc_port_destroy(struct tipc_port *p_ptr);
  90
  91 int tipc_publish(struct tipc_port *p_ptr, unsigned int scope,
  92                  struct tipc_name_seq const *name_seq);
  93
  94 int tipc_withdraw(struct tipc_port *p_ptr, unsigned int scope,
  95                   struct tipc_name_seq const *name_seq);
  96
  97 int tipc_port_peer_msg(struct tipc_port *p_ptr, struct tipc_msg *msg);
  98
  99 void tipc_port_reinit(void);
 100
 101 /**
 102  * tipc_port_lock - lock port instance referred to and return its pointer
 103  */
 104 static inline struct tipc_sock *tipc_port_lock(u32 ref)
 105 {
 106         return (struct tipc_sock *)tipc_ref_lock(ref);
 107 }
 108
 109 /**
 110  * tipc_port_unlock - unlock a port instance
 111  *
 112  * Can use pointer instead of tipc_ref_unlock() since port is already locked.
 113  */
 114 static inline void tipc_port_unlock(struct tipc_port *p_ptr)
 115 {
 116         spin_unlock_bh(p_ptr->lock);
 117 }
 118
 119 static inline u32 tipc_port_peernode(struct tipc_port *p_ptr)
 120 {
 121         return msg_destnode(&p_ptr->phdr);
 122 }
 123
 124 static inline u32 tipc_port_peerport(struct tipc_port *p_ptr)
 125 {
 126         return msg_destport(&p_ptr->phdr);
 127 }
 128
 129 static inline  bool tipc_port_unreliable(struct tipc_port *port)
 130 {
 131         return msg_src_droppable(&port->phdr) != 0;
 132 }
 133
 134 static inline void tipc_port_set_unreliable(struct tipc_port *port,
 135                                             bool unreliable)
 136 {
 137         msg_set_src_droppable(&port->phdr, unreliable ? 1 : 0);
 138 }
 139
 140 static inline bool tipc_port_unreturnable(struct tipc_port *port)
 141 {
 142         return msg_dest_droppable(&port->phdr) != 0;
 143 }
 144
 145 static inline void tipc_port_set_unreturnable(struct tipc_port *port,
 146                                              bool unreturnable)
 147 {
 148         msg_set_dest_droppable(&port->phdr, unreturnable ? 1 : 0);
 149 }
 150
 151
 152 static inline int tipc_port_importance(struct tipc_port *port)
 153 {
 154         return msg_importance(&port->phdr);
 155 }
 156
 157 static inline int tipc_port_set_importance(struct tipc_port *port, int imp)
 158 {
 159         if (imp > TIPC_CRITICAL_IMPORTANCE)
 160                 return -EINVAL;
 161         msg_set_importance(&port->phdr, (u32)imp);
 162         return 0;
 163 }
 164
 165 #endif