db947ff1265674810fa81a68802249406e0b6b5c
[linux-3.10.git] / include / net / tipc / tipc_port.h
1 /*
2  * include/net/tipc/tipc_port.h: Include file for privileged access to TIPC ports
3  * 
4  * Copyright (c) 2003-2005, Ericsson Research Canada
5  * Copyright (c) 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 _NET_TIPC_PORT_H_
39 #define _NET_TIPC_PORT_H_
40
41 #ifdef __KERNEL__
42
43 #include <linux/tipc.h>
44 #include <linux/skbuff.h>
45 #include <net/tipc/tipc_msg.h>
46
47 #define TIPC_FLOW_CONTROL_WIN 512
48
49 /**
50  * struct tipc_port - native TIPC port info available to privileged users
51  * @usr_handle: pointer to additional user-defined information about port
52  * @lock: pointer to spinlock for controlling access to port
53  * @connected: non-zero if port is currently connected to a peer port
54  * @conn_type: TIPC type used when connection was established
55  * @conn_instance: TIPC instance used when connection was established
56  * @conn_unacked: number of unacknowledged messages received from peer port
57  * @published: non-zero if port has one or more associated names
58  * @congested: non-zero if cannot send because of link or port congestion
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 ref;
73         struct tipc_msg phdr;
74 };
75
76
77 /**
78  * tipc_createport_raw - create a native TIPC port and return it's reference
79  *
80  * Note: 'dispatcher' and 'wakeup' deliver a locked port.
81  */
82
83 u32 tipc_createport_raw(void *usr_handle,
84                         u32 (*dispatcher)(struct tipc_port *, struct sk_buff *),
85                         void (*wakeup)(struct tipc_port *),
86                         const u32 importance);
87
88 /*
89  * tipc_set_msg_option(): port must be locked.
90  */
91 int tipc_set_msg_option(struct tipc_port *tp_ptr,
92                         const char *opt,
93                         const u32 len);
94
95 int tipc_reject_msg(struct sk_buff *buf, u32 err);
96
97 int tipc_send_buf_fast(struct sk_buff *buf, u32 destnode);
98
99 void tipc_acknowledge(u32 port_ref,u32 ack);
100
101 struct tipc_port *tipc_get_port(const u32 ref);
102
103 void *tipc_get_handle(const u32 ref);
104
105
106 #endif
107
108 #endif
109