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, 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
  47 typedef void (*tipc_msg_err_event) (void *usr_handle, u32 portref,
  48                 struct sk_buff **buf, unsigned char const *data,
  49                 unsigned int size, int reason,
  50                 struct tipc_portid const *attmpt_destid);
  51
  52 typedef void (*tipc_named_msg_err_event) (void *usr_handle, u32 portref,
  53                 struct sk_buff **buf, unsigned char const *data,
  54                 unsigned int size, int reason,
  55                 struct tipc_name_seq const *attmpt_dest);
  56
  57 typedef void (*tipc_conn_shutdown_event) (void *usr_handle, u32 portref,
  58                 struct sk_buff **buf, unsigned char const *data,
  59                 unsigned int size, int reason);
  60
  61 typedef void (*tipc_msg_event) (void *usr_handle, u32 portref,
  62                 struct sk_buff **buf, unsigned char const *data,
  63                 unsigned int size, unsigned int importance,
  64                 struct tipc_portid const *origin);
  65
  66 typedef void (*tipc_named_msg_event) (void *usr_handle, u32 portref,
  67                 struct sk_buff **buf, unsigned char const *data,
  68                 unsigned int size, unsigned int importance,
  69                 struct tipc_portid const *orig,
  70                 struct tipc_name_seq const *dest);
  71
  72 typedef void (*tipc_conn_msg_event) (void *usr_handle, u32 portref,
  73                 struct sk_buff **buf, unsigned char const *data,
  74                 unsigned int size);
  75
  76 typedef void (*tipc_continue_event) (void *usr_handle, u32 portref);
  77
  78 /**
  79  * struct user_port - TIPC user port (used with native API)
  80  * @user_ref: id of user who created user port
  81  * @usr_handle: user-specified field
  82  * @ref: object reference to associated TIPC port
  83  * <various callback routines>
  84  * @uport_list: adjacent user ports in list of ports held by user
  85  */
  86
  87 struct user_port {
  88         u32 user_ref;
  89         void *usr_handle;
  90         u32 ref;
  91         tipc_msg_err_event err_cb;
  92         tipc_named_msg_err_event named_err_cb;
  93         tipc_conn_shutdown_event conn_err_cb;
  94         tipc_msg_event msg_cb;
  95         tipc_named_msg_event named_msg_cb;
  96         tipc_conn_msg_event conn_msg_cb;
  97         tipc_continue_event continue_event_cb;
  98         struct list_head uport_list;
  99 };
 100
 101 /**
 102  * struct tipc_port - TIPC port info available to socket API
 103  * @usr_handle: pointer to additional user-defined information about port
 104  * @lock: pointer to spinlock for controlling access to port
 105  * @connected: non-zero if port is currently connected to a peer port
 106  * @conn_type: TIPC type used when connection was established
 107  * @conn_instance: TIPC instance used when connection was established
 108  * @conn_unacked: number of unacknowledged messages received from peer port
 109  * @published: non-zero if port has one or more associated names
 110  * @congested: non-zero if cannot send because of link or port congestion
 111  * @max_pkt: maximum packet size "hint" used when building messages sent by port
 112  * @ref: unique reference to port in TIPC object registry
 113  * @phdr: preformatted message header used when sending messages
 114  */
 115 struct tipc_port {
 116         void *usr_handle;
 117         spinlock_t *lock;
 118         int connected;
 119         u32 conn_type;
 120         u32 conn_instance;
 121         u32 conn_unacked;
 122         int published;
 123         u32 congested;
 124         u32 max_pkt;
 125         u32 ref;
 126         struct tipc_msg phdr;
 127 };
 128
 129 /**
 130  * struct port - TIPC port structure
 131  * @publ: TIPC port info available to privileged users
 132  * @port_list: adjacent ports in TIPC's global list of ports
 133  * @dispatcher: ptr to routine which handles received messages
 134  * @wakeup: ptr to routine to call when port is no longer congested
 135  * @user_port: ptr to user port associated with port (if any)
 136  * @wait_list: adjacent ports in list of ports waiting on link congestion
 137  * @waiting_pkts:
 138  * @sent:
 139  * @acked:
 140  * @publications: list of publications for port
 141  * @pub_count: total # of publications port has made during its lifetime
 142  * @probing_state:
 143  * @probing_interval:
 144  * @last_in_seqno:
 145  * @timer_ref:
 146  * @subscription: "node down" subscription used to terminate failed connections
 147  */
 148
 149 struct port {
 150         struct tipc_port publ;
 151         struct list_head port_list;
 152         u32 (*dispatcher)(struct tipc_port *, struct sk_buff *);
 153         void (*wakeup)(struct tipc_port *);
 154         struct user_port *user_port;
 155         struct list_head wait_list;
 156         u32 waiting_pkts;
 157         u32 sent;
 158         u32 acked;
 159         struct list_head publications;
 160         u32 pub_count;
 161         u32 probing_state;
 162         u32 probing_interval;
 163         u32 last_in_seqno;
 164         struct timer_list timer;
 165         struct tipc_node_subscr subscription;
 166 };
 167
 168 extern spinlock_t tipc_port_list_lock;
 169 struct port_list;
 170
 171 /*
 172  * TIPC port manipulation routines
 173  */
 174 struct tipc_port *tipc_createport_raw(void *usr_handle,
 175                 u32 (*dispatcher)(struct tipc_port *, struct sk_buff *),
 176                 void (*wakeup)(struct tipc_port *), const u32 importance);
 177
 178 int tipc_reject_msg(struct sk_buff *buf, u32 err);
 179
 180 int tipc_send_buf_fast(struct sk_buff *buf, u32 destnode);
 181
 182 void tipc_acknowledge(u32 port_ref, u32 ack);
 183
 184 int tipc_createport(unsigned int tipc_user, void *usr_handle,
 185                 unsigned int importance, tipc_msg_err_event error_cb,
 186                 tipc_named_msg_err_event named_error_cb,
 187                 tipc_conn_shutdown_event conn_error_cb, tipc_msg_event msg_cb,
 188                 tipc_named_msg_event named_msg_cb,
 189                 tipc_conn_msg_event conn_msg_cb,
 190                 tipc_continue_event continue_event_cb, u32 *portref);
 191
 192 int tipc_deleteport(u32 portref);
 193
 194 int tipc_ownidentity(u32 portref, struct tipc_portid *port);
 195
 196 int tipc_portimportance(u32 portref, unsigned int *importance);
 197 int tipc_set_portimportance(u32 portref, unsigned int importance);
 198
 199 int tipc_portunreliable(u32 portref, unsigned int *isunreliable);
 200 int tipc_set_portunreliable(u32 portref, unsigned int isunreliable);
 201
 202 int tipc_portunreturnable(u32 portref, unsigned int *isunreturnable);
 203 int tipc_set_portunreturnable(u32 portref, unsigned int isunreturnable);
 204
 205 int tipc_publish(u32 portref, unsigned int scope,
 206                 struct tipc_name_seq const *name_seq);
 207 int tipc_withdraw(u32 portref, unsigned int scope,
 208                 struct tipc_name_seq const *name_seq);
 209
 210 int tipc_connect2port(u32 portref, struct tipc_portid const *port);
 211
 212 int tipc_disconnect(u32 portref);
 213
 214 int tipc_shutdown(u32 ref);
 215
 216
 217 /*
 218  * The following routines require that the port be locked on entry
 219  */
 220 int tipc_disconnect_port(struct tipc_port *tp_ptr);
 221
 222 /*
 223  * TIPC messaging routines
 224  */
 225 #define TIPC_PORT_IMPORTANCE 100        /* send using current port setting */
 226
 227 int tipc_send(u32 portref, unsigned int num_sect, struct iovec const *msg_sect);
 228
 229 int tipc_send2name(u32 portref, struct tipc_name const *name, u32 domain,
 230                 unsigned int num_sect, struct iovec const *msg_sect);
 231
 232 int tipc_send2port(u32 portref, struct tipc_portid const *dest,
 233                 unsigned int num_sect, struct iovec const *msg_sect);
 234
 235 int tipc_send_buf2port(u32 portref, struct tipc_portid const *dest,
 236                 struct sk_buff *buf, unsigned int dsz);
 237
 238 int tipc_multicast(u32 portref, struct tipc_name_seq const *seq, u32 domain,
 239                 unsigned int section_count, struct iovec const *msg);
 240
 241 int tipc_port_reject_sections(struct port *p_ptr, struct tipc_msg *hdr,
 242                               struct iovec const *msg_sect, u32 num_sect,
 243                               int err);
 244 struct sk_buff *tipc_port_get_ports(void);
 245 void tipc_port_recv_proto_msg(struct sk_buff *buf);
 246 void tipc_port_recv_mcast(struct sk_buff *buf, struct port_list *dp);
 247 void tipc_port_reinit(void);
 248
 249 /**
 250  * tipc_port_lock - lock port instance referred to and return its pointer
 251  */
 252
 253 static inline struct port *tipc_port_lock(u32 ref)
 254 {
 255         return (struct port *)tipc_ref_lock(ref);
 256 }
 257
 258 /**
 259  * tipc_port_unlock - unlock a port instance
 260  *
 261  * Can use pointer instead of tipc_ref_unlock() since port is already locked.
 262  */
 263
 264 static inline void tipc_port_unlock(struct port *p_ptr)
 265 {
 266         spin_unlock_bh(p_ptr->publ.lock);
 267 }
 268
 269 static inline struct port* tipc_port_deref(u32 ref)
 270 {
 271         return (struct port *)tipc_ref_deref(ref);
 272 }
 273
 274 static inline u32 tipc_peer_port(struct port *p_ptr)
 275 {
 276         return msg_destport(&p_ptr->publ.phdr);
 277 }
 278
 279 static inline u32 tipc_peer_node(struct port *p_ptr)
 280 {
 281         return msg_destnode(&p_ptr->publ.phdr);
 282 }
 283
 284 static inline int tipc_port_congested(struct port *p_ptr)
 285 {
 286         return (p_ptr->sent - p_ptr->acked) >= (TIPC_FLOW_CONTROL_WIN * 2);
 287 }
 288
 289 /**
 290  * tipc_port_recv_msg - receive message from lower layer and deliver to port user
 291  */
 292
 293 static inline int tipc_port_recv_msg(struct sk_buff *buf)
 294 {
 295         struct port *p_ptr;
 296         struct tipc_msg *msg = buf_msg(buf);
 297         u32 destport = msg_destport(msg);
 298         u32 dsz = msg_data_sz(msg);
 299         u32 err;
 300
 301         /* forward unresolved named message */
 302         if (unlikely(!destport)) {
 303                 tipc_net_route_msg(buf);
 304                 return dsz;
 305         }
 306
 307         /* validate destination & pass to port, otherwise reject message */
 308         p_ptr = tipc_port_lock(destport);
 309         if (likely(p_ptr)) {
 310                 if (likely(p_ptr->publ.connected)) {
 311                         if ((unlikely(msg_origport(msg) != tipc_peer_port(p_ptr))) ||
 312                             (unlikely(msg_orignode(msg) != tipc_peer_node(p_ptr))) ||
 313                             (unlikely(!msg_connected(msg)))) {
 314                                 err = TIPC_ERR_NO_PORT;
 315                                 tipc_port_unlock(p_ptr);
 316                                 goto reject;
 317                         }
 318                 }
 319                 err = p_ptr->dispatcher(&p_ptr->publ, buf);
 320                 tipc_port_unlock(p_ptr);
 321                 if (likely(!err))
 322                         return dsz;
 323         } else {
 324                 err = TIPC_ERR_NO_PORT;
 325         }
 326 reject:
 327         dbg("port->rejecting, err = %x..\n",err);
 328         return tipc_reject_msg(buf, err);
 329 }
 330
 331 #endif