LXR linux/net/tipc/port.h

   1/*
   2 * net/tipc/port.h: Include file for TIPC port code
   3 *
   4 * Copyright (c) 1994-2007, 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 * @sk: pointer to socket handle
  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 * @dispatcher: ptr to routine which handles received messages
  64 * @wakeup: ptr to routine to call when port is no longer congested
  65 * @wait_list: adjacent ports in list of ports waiting on link congestion
  66 * @waiting_pkts:
  67 * @sent: # of non-empty messages sent by port
  68 * @acked: # of non-empty message acknowledgements from connected port's peer
  69 * @publications: list of publications for port
  70 * @pub_count: total # of publications port has made during its lifetime
  71 * @probing_state:
  72 * @probing_interval:
  73 * @timer_ref:
  74 * @subscription: "node down" subscription used to terminate failed connections
  75 */
  76struct tipc_port {
  77        struct sock *sk;
  78        spinlock_t *lock;
  79        int connected;
  80        u32 conn_type;
  81        u32 conn_instance;
  82        u32 conn_unacked;
  83        int published;
  84        u32 congested;
  85        u32 max_pkt;
  86        u32 ref;
  87        struct tipc_msg phdr;
  88        struct list_head port_list;
  89        u32 (*dispatcher)(struct tipc_port *, struct sk_buff *);
  90        void (*wakeup)(struct tipc_port *);
  91        struct list_head wait_list;
  92        u32 waiting_pkts;
  93        u32 sent;
  94        u32 acked;
  95        struct list_head publications;
  96        u32 pub_count;
  97        u32 probing_state;
  98        u32 probing_interval;
  99        struct timer_list timer;
 100        struct tipc_node_subscr subscription;
 101};
 102
 103extern spinlock_t tipc_port_list_lock;
 104struct tipc_port_list;
 105
 106/*
 107 * TIPC port manipulation routines
 108 */
 109struct tipc_port *tipc_createport(struct sock *sk,
 110                                  u32 (*dispatcher)(struct tipc_port *,
 111                                  struct sk_buff *),
 112                                  void (*wakeup)(struct tipc_port *),
 113                                  const u32 importance);
 114
 115int tipc_reject_msg(struct sk_buff *buf, u32 err);
 116
 117void tipc_acknowledge(u32 port_ref, u32 ack);
 118
 119int tipc_deleteport(struct tipc_port *p_ptr);
 120
 121int tipc_portimportance(u32 portref, unsigned int *importance);
 122int tipc_set_portimportance(u32 portref, unsigned int importance);
 123
 124int tipc_portunreliable(u32 portref, unsigned int *isunreliable);
 125int tipc_set_portunreliable(u32 portref, unsigned int isunreliable);
 126
 127int tipc_portunreturnable(u32 portref, unsigned int *isunreturnable);
 128int tipc_set_portunreturnable(u32 portref, unsigned int isunreturnable);
 129
 130int tipc_publish(struct tipc_port *p_ptr, unsigned int scope,
 131                 struct tipc_name_seq const *name_seq);
 132int tipc_withdraw(struct tipc_port *p_ptr, unsigned int scope,
 133                  struct tipc_name_seq const *name_seq);
 134
 135int tipc_connect(u32 portref, struct tipc_portid const *port);
 136
 137int tipc_disconnect(u32 portref);
 138
 139int tipc_shutdown(u32 ref);
 140
 141
 142/*
 143 * The following routines require that the port be locked on entry
 144 */
 145int __tipc_disconnect(struct tipc_port *tp_ptr);
 146int __tipc_connect(u32 ref, struct tipc_port *p_ptr,
 147                   struct tipc_portid const *peer);
 148int tipc_port_peer_msg(struct tipc_port *p_ptr, struct tipc_msg *msg);
 149
 150/*
 151 * TIPC messaging routines
 152 */
 153int tipc_port_recv_msg(struct sk_buff *buf);
 154int tipc_send(u32 portref, struct iovec const *msg_sect, unsigned int len);
 155
 156int tipc_send2name(u32 portref, struct tipc_name const *name, u32 domain,
 157                   struct iovec const *msg_sect, unsigned int len);
 158
 159int tipc_send2port(u32 portref, struct tipc_portid const *dest,
 160                   struct iovec const *msg_sect, unsigned int len);
 161
 162int tipc_multicast(u32 portref, struct tipc_name_seq const *seq,
 163                   struct iovec const *msg, unsigned int len);
 164
 165int tipc_port_reject_sections(struct tipc_port *p_ptr, struct tipc_msg *hdr,
 166                              struct iovec const *msg_sect, unsigned int len,
 167                              int err);
 168struct sk_buff *tipc_port_get_ports(void);
 169void tipc_port_recv_proto_msg(struct sk_buff *buf);
 170void tipc_port_recv_mcast(struct sk_buff *buf, struct tipc_port_list *dp);
 171void tipc_port_reinit(void);
 172
 173/**
 174 * tipc_port_lock - lock port instance referred to and return its pointer
 175 */
 176static inline struct tipc_port *tipc_port_lock(u32 ref)
 177{
 178        return (struct tipc_port *)tipc_ref_lock(ref);
 179}
 180
 181/**
 182 * tipc_port_unlock - unlock a port instance
 183 *
 184 * Can use pointer instead of tipc_ref_unlock() since port is already locked.
 185 */
 186static inline void tipc_port_unlock(struct tipc_port *p_ptr)
 187{
 188        spin_unlock_bh(p_ptr->lock);
 189}
 190
 191static inline struct tipc_port *tipc_port_deref(u32 ref)
 192{
 193        return (struct tipc_port *)tipc_ref_deref(ref);
 194}
 195
 196static inline int tipc_port_congested(struct tipc_port *p_ptr)
 197{
 198        return (p_ptr->sent - p_ptr->acked) >= (TIPC_FLOW_CONTROL_WIN * 2);
 199}
 200
 201#endif
 202