1 /* 2 * include/net/tipc/tipc_port.h: Include file for privileged access to TIPC ports 3 * 4 * Copyright (c) 1994-2007, Ericsson AB 5 * Copyright (c) 2005-2008, 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 _NET_TIPC_PORT_H_ 38 #define _NET_TIPC_PORT_H_ 39 40 #ifdef __KERNEL__ 41 42 #include <linux/tipc.h> 43 #include <linux/skbuff.h> 44 #include <net/tipc/tipc_msg.h> 45 46 #define TIPC_FLOW_CONTROL_WIN 512 47 48 /** 49 * struct tipc_port - native TIPC port info available to privileged users 50 * @usr_handle: pointer to additional user-defined information about port 51 * @lock: pointer to spinlock for controlling access to port 52 * @connected: non-zero if port is currently connected to a peer port 53 * @conn_type: TIPC type used when connection was established 54 * @conn_instance: TIPC instance used when connection was established 55 * @conn_unacked: number of unacknowledged messages received from peer port 56 * @published: non-zero if port has one or more associated names 57 * @congested: non-zero if cannot send because of link or port congestion 58 * @max_pkt: maximum packet size "hint" used when building messages sent by port 59 * @ref: unique reference to port in TIPC object registry 60 * @phdr: preformatted message header used when sending messages 61 */ 62 63 struct tipc_port { 64 void *usr_handle; 65 spinlock_t *lock; 66 int connected; 67 u32 conn_type; 68 u32 conn_instance; 69 u32 conn_unacked; 70 int published; 71 u32 congested; 72 u32 max_pkt; 73 u32 ref; 74 struct tipc_msg phdr; 75 }; 76 77 78 struct tipc_port *tipc_createport_raw(void *usr_handle, 79 u32 (*dispatcher)(struct tipc_port *, struct sk_buff *), 80 void (*wakeup)(struct tipc_port *), 81 const u32 importance); 82 83 int tipc_reject_msg(struct sk_buff *buf, u32 err); 84 85 int tipc_send_buf_fast(struct sk_buff *buf, u32 destnode); 86 87 void tipc_acknowledge(u32 port_ref,u32 ack); 88 89 struct tipc_port *tipc_get_port(const u32 ref); 90 91 void *tipc_get_handle(const u32 ref); 92 93 /* 94 * The following routines require that the port be locked on entry 95 */ 96 97 int tipc_disconnect_port(struct tipc_port *tp_ptr); 98 99 100 #endif 101 102 #endif 103 104