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