SAFE public projects git trees. - safe/jmp/linux-2.6/blob - net/tipc/port.h

   1 /*
   2  * net/tipc/port.h: Include file for TIPC port code
   3  *
   4  * Copyright (c) 2003-2005, Ericsson Research Canada
   5  * Copyright (c) 2004-2005, Wind River Systems
   6  * Copyright (c) 2005-2006, Ericsson AB
   7  * All rights reserved.
   8  *
   9  * Redistribution and use in source and binary forms, with or without
  10  * modification, are permitted provided that the following conditions are met:
  11  *
  12  * 1. Redistributions of source code must retain the above copyright
  13  *    notice, this list of conditions and the following disclaimer.
  14  * 2. Redistributions in binary form must reproduce the above copyright
  15  *    notice, this list of conditions and the following disclaimer in the
  16  *    documentation and/or other materials provided with the distribution.
  17  * 3. Neither the names of the copyright holders nor the names of its
  18  *    contributors may be used to endorse or promote products derived from
  19  *    this software without specific prior written permission.
  20  *
  21  * Alternatively, this software may be distributed under the terms of the
  22  * GNU General Public License ("GPL") version 2 as published by the Free
  23  * Software Foundation.
  24  *
  25  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  26  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  27  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  28  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  29  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  30  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  31  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  32  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  33  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  34  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  35  * POSSIBILITY OF SUCH DAMAGE.
  36  */
  37
  38 #ifndef _TIPC_PORT_H
  39 #define _TIPC_PORT_H
  40
  41 #include <net/tipc/tipc_port.h>
  42 #include "ref.h"
  43 #include "net.h"
  44 #include "msg.h"
  45 #include "dbg.h"
  46 #include "node_subscr.h"
  47
  48 /**
  49  * struct user_port - TIPC user port (used with native API)
  50  * @user_ref: id of user who created user port
  51  * @usr_handle: user-specified field
  52  * @ref: object reference to associated TIPC port
  53  * <various callback routines>
  54  * @uport_list: adjacent user ports in list of ports held by user
  55  */
  56
  57 struct user_port {
  58         u32 user_ref;
  59         void *usr_handle;
  60         u32 ref;
  61         tipc_msg_err_event err_cb;
  62         tipc_named_msg_err_event named_err_cb;
  63         tipc_conn_shutdown_event conn_err_cb;
  64         tipc_msg_event msg_cb;
  65         tipc_named_msg_event named_msg_cb;
  66         tipc_conn_msg_event conn_msg_cb;
  67         tipc_continue_event continue_event_cb;
  68         struct list_head uport_list;
  69 };
  70
  71 /**
  72  * struct port - TIPC port structure
  73  * @publ: TIPC port info available to privileged users
  74  * @port_list: adjacent ports in TIPC's global list of ports
  75  * @dispatcher: ptr to routine which handles received messages
  76  * @wakeup: ptr to routine to call when port is no longer congested
  77  * @user_port: ptr to user port associated with port (if any)
  78  * @wait_list: adjacent ports in list of ports waiting on link congestion
  79  * @congested_link: ptr to congested link port is waiting on
  80  * @waiting_pkts:
  81  * @sent:
  82  * @acked:
  83  * @publications: list of publications for port
  84  * @pub_count: total # of publications port has made during its lifetime
  85  * @max_pkt: maximum packet size "hint" used when building messages sent by port
  86  * @probing_state:
  87  * @probing_interval:
  88  * @last_in_seqno:
  89  * @timer_ref:
  90  * @subscription: "node down" subscription used to terminate failed connections
  91  */
  92
  93 struct port {
  94         struct tipc_port publ;
  95         struct list_head port_list;
  96         u32 (*dispatcher)(struct tipc_port *, struct sk_buff *);
  97         void (*wakeup)(struct tipc_port *);
  98         struct user_port *user_port;
  99         struct list_head wait_list;
 100         struct link *congested_link;
 101         u32 waiting_pkts;
 102         u32 sent;
 103         u32 acked;
 104         struct list_head publications;
 105         u32 pub_count;
 106         u32 max_pkt;
 107         u32 probing_state;
 108         u32 probing_interval;
 109         u32 last_in_seqno;
 110         struct timer_list timer;
 111         struct node_subscr subscription;
 112 };
 113
 114 extern spinlock_t port_list_lock;
 115 struct port_list;
 116
 117 int port_recv_sections(struct port *p_ptr, u32 num_sect,
 118                        struct iovec const *msg_sect);
 119 int port_reject_sections(struct port *p_ptr, struct tipc_msg *hdr,
 120                          struct iovec const *msg_sect, u32 num_sect,
 121                          int err);
 122 struct sk_buff *port_get_ports(void);
 123 struct sk_buff *port_show_stats(const void *req_tlv_area, int req_tlv_space);
 124 void port_recv_proto_msg(struct sk_buff *buf);
 125 void port_recv_mcast(struct sk_buff *buf, struct port_list *dp);
 126 void port_reinit(void);
 127
 128 /**
 129  * port_lock - lock port instance referred to and return its pointer
 130  */
 131
 132 static inline struct port *port_lock(u32 ref)
 133 {
 134         return (struct port *)ref_lock(ref);
 135 }
 136
 137 /**
 138  * port_unlock - unlock a port instance
 139  *
 140  * Can use pointer instead of ref_unlock() since port is already locked.
 141  */
 142
 143 static inline void port_unlock(struct port *p_ptr)
 144 {
 145         spin_unlock_bh(p_ptr->publ.lock);
 146 }
 147
 148 static inline struct port* port_deref(u32 ref)
 149 {
 150         return (struct port *)ref_deref(ref);
 151 }
 152
 153 static inline u32 peer_port(struct port *p_ptr)
 154 {
 155         return msg_destport(&p_ptr->publ.phdr);
 156 }
 157
 158 static inline u32 peer_node(struct port *p_ptr)
 159 {
 160         return msg_destnode(&p_ptr->publ.phdr);
 161 }
 162
 163 static inline int port_congested(struct port *p_ptr)
 164 {
 165         return((p_ptr->sent - p_ptr->acked) >= (TIPC_FLOW_CONTROL_WIN * 2));
 166 }
 167
 168 /**
 169  * port_recv_msg - receive message from lower layer and deliver to port user
 170  */
 171
 172 static inline int port_recv_msg(struct sk_buff *buf)
 173 {
 174         struct port *p_ptr;
 175         struct tipc_msg *msg = buf_msg(buf);
 176         u32 destport = msg_destport(msg);
 177         u32 dsz = msg_data_sz(msg);
 178         u32 err;
 179
 180         /* forward unresolved named message */
 181         if (unlikely(!destport)) {
 182                 net_route_msg(buf);
 183                 return dsz;
 184         }
 185
 186         /* validate destination & pass to port, otherwise reject message */
 187         p_ptr = port_lock(destport);
 188         if (likely(p_ptr)) {
 189                 if (likely(p_ptr->publ.connected)) {
 190                         if ((unlikely(msg_origport(msg) != peer_port(p_ptr))) ||
 191                             (unlikely(msg_orignode(msg) != peer_node(p_ptr))) ||
 192                             (unlikely(!msg_connected(msg)))) {
 193                                 err = TIPC_ERR_NO_PORT;
 194                                 port_unlock(p_ptr);
 195                                 goto reject;
 196                         }
 197                 }
 198                 err = p_ptr->dispatcher(&p_ptr->publ, buf);
 199                 port_unlock(p_ptr);
 200                 if (likely(!err))
 201                         return dsz;
 202         } else {
 203                 err = TIPC_ERR_NO_PORT;
 204         }
 205 reject:
 206         dbg("port->rejecting, err = %x..\n",err);
 207         return tipc_reject_msg(buf, err);
 208 }
 209
 210 #endif