port.h revision 617d3c7a50b3dc15f558d60013047aede79dc055
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-2011, 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 47typedef 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 52typedef 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 57typedef 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 61typedef 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 66typedef 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 72typedef void (*tipc_conn_msg_event) (void *usr_handle, u32 portref, 73 struct sk_buff **buf, unsigned char const *data, 74 unsigned int size); 75 76typedef void (*tipc_continue_event) (void *usr_handle, u32 portref); 77 78/** 79 * struct user_port - TIPC user port (used with native API) 80 * @usr_handle: user-specified field 81 * @ref: object reference to associated TIPC port 82 * <various callback routines> 83 */ 84struct user_port { 85 void *usr_handle; 86 u32 ref; 87 tipc_msg_err_event err_cb; 88 tipc_named_msg_err_event named_err_cb; 89 tipc_conn_shutdown_event conn_err_cb; 90 tipc_msg_event msg_cb; 91 tipc_named_msg_event named_msg_cb; 92 tipc_conn_msg_event conn_msg_cb; 93 tipc_continue_event continue_event_cb; 94}; 95 96/** 97 * struct tipc_port - TIPC port structure 98 * @usr_handle: pointer to additional user-defined information about port 99 * @lock: pointer to spinlock for controlling access to port 100 * @connected: non-zero if port is currently connected to a peer port 101 * @conn_type: TIPC type used when connection was established 102 * @conn_instance: TIPC instance used when connection was established 103 * @conn_unacked: number of unacknowledged messages received from peer port 104 * @published: non-zero if port has one or more associated names 105 * @congested: non-zero if cannot send because of link or port congestion 106 * @max_pkt: maximum packet size "hint" used when building messages sent by port 107 * @ref: unique reference to port in TIPC object registry 108 * @phdr: preformatted message header used when sending messages 109 * @port_list: adjacent ports in TIPC's global list of ports 110 * @dispatcher: ptr to routine which handles received messages 111 * @wakeup: ptr to routine to call when port is no longer congested 112 * @user_port: ptr to user port associated with port (if any) 113 * @wait_list: adjacent ports in list of ports waiting on link congestion 114 * @waiting_pkts: 115 * @sent: # of non-empty messages sent by port 116 * @acked: # of non-empty message acknowledgements from connected port's peer 117 * @publications: list of publications for port 118 * @pub_count: total # of publications port has made during its lifetime 119 * @probing_state: 120 * @probing_interval: 121 * @timer_ref: 122 * @subscription: "node down" subscription used to terminate failed connections 123 */ 124struct tipc_port { 125 void *usr_handle; 126 spinlock_t *lock; 127 int connected; 128 u32 conn_type; 129 u32 conn_instance; 130 u32 conn_unacked; 131 int published; 132 u32 congested; 133 u32 max_pkt; 134 u32 ref; 135 struct tipc_msg phdr; 136 struct list_head port_list; 137 u32 (*dispatcher)(struct tipc_port *, struct sk_buff *); 138 void (*wakeup)(struct tipc_port *); 139 struct user_port *user_port; 140 struct list_head wait_list; 141 u32 waiting_pkts; 142 u32 sent; 143 u32 acked; 144 struct list_head publications; 145 u32 pub_count; 146 u32 probing_state; 147 u32 probing_interval; 148 struct timer_list timer; 149 struct tipc_node_subscr subscription; 150}; 151 152extern spinlock_t tipc_port_list_lock; 153struct tipc_port_list; 154 155/* 156 * TIPC port manipulation routines 157 */ 158struct tipc_port *tipc_createport_raw(void *usr_handle, 159 u32 (*dispatcher)(struct tipc_port *, struct sk_buff *), 160 void (*wakeup)(struct tipc_port *), const u32 importance); 161 162int tipc_reject_msg(struct sk_buff *buf, u32 err); 163 164int tipc_send_buf_fast(struct sk_buff *buf, u32 destnode); 165 166void tipc_acknowledge(u32 port_ref, u32 ack); 167 168int tipc_createport(void *usr_handle, 169 unsigned int importance, tipc_msg_err_event error_cb, 170 tipc_named_msg_err_event named_error_cb, 171 tipc_conn_shutdown_event conn_error_cb, tipc_msg_event msg_cb, 172 tipc_named_msg_event named_msg_cb, 173 tipc_conn_msg_event conn_msg_cb, 174 tipc_continue_event continue_event_cb, u32 *portref); 175 176int tipc_deleteport(u32 portref); 177 178int tipc_portimportance(u32 portref, unsigned int *importance); 179int tipc_set_portimportance(u32 portref, unsigned int importance); 180 181int tipc_portunreliable(u32 portref, unsigned int *isunreliable); 182int tipc_set_portunreliable(u32 portref, unsigned int isunreliable); 183 184int tipc_portunreturnable(u32 portref, unsigned int *isunreturnable); 185int tipc_set_portunreturnable(u32 portref, unsigned int isunreturnable); 186 187int tipc_publish(u32 portref, unsigned int scope, 188 struct tipc_name_seq const *name_seq); 189int tipc_withdraw(u32 portref, unsigned int scope, 190 struct tipc_name_seq const *name_seq); 191 192int tipc_connect2port(u32 portref, struct tipc_portid const *port); 193 194int tipc_disconnect(u32 portref); 195 196int tipc_shutdown(u32 ref); 197 198 199/* 200 * The following routines require that the port be locked on entry 201 */ 202int tipc_disconnect_port(struct tipc_port *tp_ptr); 203int tipc_port_peer_msg(struct tipc_port *p_ptr, struct tipc_msg *msg); 204 205/* 206 * TIPC messaging routines 207 */ 208int tipc_port_recv_msg(struct sk_buff *buf); 209int tipc_send(u32 portref, unsigned int num_sect, struct iovec const *msg_sect, 210 unsigned int total_len); 211 212int tipc_send2name(u32 portref, struct tipc_name const *name, u32 domain, 213 unsigned int num_sect, struct iovec const *msg_sect, 214 unsigned int total_len); 215 216int tipc_send2port(u32 portref, struct tipc_portid const *dest, 217 unsigned int num_sect, struct iovec const *msg_sect, 218 unsigned int total_len); 219 220int tipc_send_buf2port(u32 portref, struct tipc_portid const *dest, 221 struct sk_buff *buf, unsigned int dsz); 222 223int tipc_multicast(u32 portref, struct tipc_name_seq const *seq, 224 unsigned int section_count, struct iovec const *msg, 225 unsigned int total_len); 226 227int tipc_port_reject_sections(struct tipc_port *p_ptr, struct tipc_msg *hdr, 228 struct iovec const *msg_sect, u32 num_sect, 229 unsigned int total_len, int err); 230struct sk_buff *tipc_port_get_ports(void); 231void tipc_port_recv_proto_msg(struct sk_buff *buf); 232void tipc_port_recv_mcast(struct sk_buff *buf, struct tipc_port_list *dp); 233void tipc_port_reinit(void); 234 235/** 236 * tipc_port_lock - lock port instance referred to and return its pointer 237 */ 238static inline struct tipc_port *tipc_port_lock(u32 ref) 239{ 240 return (struct tipc_port *)tipc_ref_lock(ref); 241} 242 243/** 244 * tipc_port_unlock - unlock a port instance 245 * 246 * Can use pointer instead of tipc_ref_unlock() since port is already locked. 247 */ 248static inline void tipc_port_unlock(struct tipc_port *p_ptr) 249{ 250 spin_unlock_bh(p_ptr->lock); 251} 252 253static inline struct tipc_port *tipc_port_deref(u32 ref) 254{ 255 return (struct tipc_port *)tipc_ref_deref(ref); 256} 257 258static inline int tipc_port_congested(struct tipc_port *p_ptr) 259{ 260 return (p_ptr->sent - p_ptr->acked) >= (TIPC_FLOW_CONTROL_WIN * 2); 261} 262 263#endif 264