blob: fb66e2e5f4d1a93348c24e212946d74c776c0331 [file] [log] [blame]
Per Lidenb97bf3f2006-01-02 19:04:38 +01001/*
2 * net/tipc/port.h: Include file for TIPC port code
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +09003 *
Allan Stephens05646c92007-06-10 17:25:24 -07004 * Copyright (c) 1994-2007, Ericsson AB
Allan Stephens23dd4cc2011-01-07 11:43:40 -05005 * Copyright (c) 2004-2007, 2010-2011, Wind River Systems
Per Lidenb97bf3f2006-01-02 19:04:38 +01006 * All rights reserved.
7 *
Per Liden9ea1fd32006-01-11 13:30:43 +01008 * Redistribution and use in source and binary forms, with or without
Per Lidenb97bf3f2006-01-02 19:04:38 +01009 * modification, are permitted provided that the following conditions are met:
10 *
Per Liden9ea1fd32006-01-11 13:30:43 +010011 * 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.
Per Lidenb97bf3f2006-01-02 19:04:38 +010019 *
Per Liden9ea1fd32006-01-11 13:30:43 +010020 * 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
Per Lidenb97bf3f2006-01-02 19:04:38 +010034 * POSSIBILITY OF SUCH DAMAGE.
35 */
36
37#ifndef _TIPC_PORT_H
38#define _TIPC_PORT_H
39
Per Lidenb97bf3f2006-01-02 19:04:38 +010040#include "ref.h"
41#include "net.h"
42#include "msg.h"
Per Lidenb97bf3f2006-01-02 19:04:38 +010043#include "node_subscr.h"
44
Allan Stephensd265fef2010-11-30 12:00:53 +000045#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
Per Lidenb97bf3f2006-01-02 19:04:38 +010078/**
79 * struct user_port - TIPC user port (used with native API)
Per Lidenb97bf3f2006-01-02 19:04:38 +010080 * @usr_handle: user-specified field
81 * @ref: object reference to associated TIPC port
Ben Hutchings2c530402012-07-10 10:55:09 +000082 *
Per Lidenb97bf3f2006-01-02 19:04:38 +010083 * <various callback routines>
Per Lidenb97bf3f2006-01-02 19:04:38 +010084 */
Per Lidenb97bf3f2006-01-02 19:04:38 +010085struct user_port {
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +090086 void *usr_handle;
Per Lidenb97bf3f2006-01-02 19:04:38 +010087 u32 ref;
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +090088 tipc_msg_err_event err_cb;
89 tipc_named_msg_err_event named_err_cb;
90 tipc_conn_shutdown_event conn_err_cb;
91 tipc_msg_event msg_cb;
92 tipc_named_msg_event named_msg_cb;
93 tipc_conn_msg_event conn_msg_cb;
Per Lidenb97bf3f2006-01-02 19:04:38 +010094 tipc_continue_event continue_event_cb;
Per Lidenb97bf3f2006-01-02 19:04:38 +010095};
96
97/**
Allan Stephens23dd4cc2011-01-07 11:43:40 -050098 * struct tipc_port - TIPC port structure
Allan Stephensd265fef2010-11-30 12:00:53 +000099 * @usr_handle: pointer to additional user-defined information about port
100 * @lock: pointer to spinlock for controlling access to port
101 * @connected: non-zero if port is currently connected to a peer port
102 * @conn_type: TIPC type used when connection was established
103 * @conn_instance: TIPC instance used when connection was established
104 * @conn_unacked: number of unacknowledged messages received from peer port
105 * @published: non-zero if port has one or more associated names
106 * @congested: non-zero if cannot send because of link or port congestion
107 * @max_pkt: maximum packet size "hint" used when building messages sent by port
108 * @ref: unique reference to port in TIPC object registry
109 * @phdr: preformatted message header used when sending messages
Per Lidenb97bf3f2006-01-02 19:04:38 +0100110 * @port_list: adjacent ports in TIPC's global list of ports
111 * @dispatcher: ptr to routine which handles received messages
112 * @wakeup: ptr to routine to call when port is no longer congested
113 * @user_port: ptr to user port associated with port (if any)
114 * @wait_list: adjacent ports in list of ports waiting on link congestion
Per Lidenb97bf3f2006-01-02 19:04:38 +0100115 * @waiting_pkts:
Allan Stephenscb7ce912011-01-24 15:02:14 -0500116 * @sent: # of non-empty messages sent by port
117 * @acked: # of non-empty message acknowledgements from connected port's peer
Per Lidenb97bf3f2006-01-02 19:04:38 +0100118 * @publications: list of publications for port
119 * @pub_count: total # of publications port has made during its lifetime
Per Lidenb97bf3f2006-01-02 19:04:38 +0100120 * @probing_state:
121 * @probing_interval:
Per Lidenb97bf3f2006-01-02 19:04:38 +0100122 * @timer_ref:
123 * @subscription: "node down" subscription used to terminate failed connections
124 */
Allan Stephens23dd4cc2011-01-07 11:43:40 -0500125struct tipc_port {
126 void *usr_handle;
127 spinlock_t *lock;
128 int connected;
129 u32 conn_type;
130 u32 conn_instance;
131 u32 conn_unacked;
132 int published;
133 u32 congested;
134 u32 max_pkt;
135 u32 ref;
136 struct tipc_msg phdr;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100137 struct list_head port_list;
138 u32 (*dispatcher)(struct tipc_port *, struct sk_buff *);
139 void (*wakeup)(struct tipc_port *);
140 struct user_port *user_port;
141 struct list_head wait_list;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100142 u32 waiting_pkts;
143 u32 sent;
144 u32 acked;
145 struct list_head publications;
146 u32 pub_count;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100147 u32 probing_state;
148 u32 probing_interval;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100149 struct timer_list timer;
David S. Miller6c000552008-09-02 23:38:32 -0700150 struct tipc_node_subscr subscription;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100151};
152
Per Liden4323add2006-01-18 00:38:21 +0100153extern spinlock_t tipc_port_list_lock;
Paul Gortmaker45843102011-12-29 20:33:30 -0500154struct tipc_port_list;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100155
Allan Stephensd265fef2010-11-30 12:00:53 +0000156/*
157 * TIPC port manipulation routines
158 */
159struct tipc_port *tipc_createport_raw(void *usr_handle,
160 u32 (*dispatcher)(struct tipc_port *, struct sk_buff *),
161 void (*wakeup)(struct tipc_port *), const u32 importance);
162
163int tipc_reject_msg(struct sk_buff *buf, u32 err);
164
165int tipc_send_buf_fast(struct sk_buff *buf, u32 destnode);
166
167void tipc_acknowledge(u32 port_ref, u32 ack);
168
Allan Stephensb0c1e922010-12-31 18:59:22 +0000169int tipc_createport(void *usr_handle,
Allan Stephensd265fef2010-11-30 12:00:53 +0000170 unsigned int importance, tipc_msg_err_event error_cb,
171 tipc_named_msg_err_event named_error_cb,
172 tipc_conn_shutdown_event conn_error_cb, tipc_msg_event msg_cb,
173 tipc_named_msg_event named_msg_cb,
174 tipc_conn_msg_event conn_msg_cb,
175 tipc_continue_event continue_event_cb, u32 *portref);
176
177int tipc_deleteport(u32 portref);
178
Allan Stephensd265fef2010-11-30 12:00:53 +0000179int tipc_portimportance(u32 portref, unsigned int *importance);
180int tipc_set_portimportance(u32 portref, unsigned int importance);
181
182int tipc_portunreliable(u32 portref, unsigned int *isunreliable);
183int tipc_set_portunreliable(u32 portref, unsigned int isunreliable);
184
185int tipc_portunreturnable(u32 portref, unsigned int *isunreturnable);
186int tipc_set_portunreturnable(u32 portref, unsigned int isunreturnable);
187
188int tipc_publish(u32 portref, unsigned int scope,
189 struct tipc_name_seq const *name_seq);
190int tipc_withdraw(u32 portref, unsigned int scope,
191 struct tipc_name_seq const *name_seq);
192
Paul Gortmakerbc879112012-11-29 13:48:40 -0500193int tipc_connect(u32 portref, struct tipc_portid const *port);
Allan Stephensd265fef2010-11-30 12:00:53 +0000194
195int tipc_disconnect(u32 portref);
196
197int tipc_shutdown(u32 ref);
198
199
200/*
201 * The following routines require that the port be locked on entry
202 */
Paul Gortmakerbc879112012-11-29 13:48:40 -0500203int __tipc_disconnect(struct tipc_port *tp_ptr);
204int __tipc_connect(u32 ref, struct tipc_port *p_ptr,
205 struct tipc_portid const *peer);
Allan Stephensf0712e862012-04-17 18:42:28 -0400206int tipc_port_peer_msg(struct tipc_port *p_ptr, struct tipc_msg *msg);
Allan Stephensd265fef2010-11-30 12:00:53 +0000207
208/*
209 * TIPC messaging routines
210 */
Allan Stephens9b641252011-11-09 13:29:18 -0500211int tipc_port_recv_msg(struct sk_buff *buf);
Allan Stephens26896902011-04-21 10:42:07 -0500212int tipc_send(u32 portref, unsigned int num_sect, struct iovec const *msg_sect,
213 unsigned int total_len);
Allan Stephensd265fef2010-11-30 12:00:53 +0000214
215int tipc_send2name(u32 portref, struct tipc_name const *name, u32 domain,
Allan Stephens26896902011-04-21 10:42:07 -0500216 unsigned int num_sect, struct iovec const *msg_sect,
217 unsigned int total_len);
Allan Stephensd265fef2010-11-30 12:00:53 +0000218
219int tipc_send2port(u32 portref, struct tipc_portid const *dest,
Allan Stephens26896902011-04-21 10:42:07 -0500220 unsigned int num_sect, struct iovec const *msg_sect,
221 unsigned int total_len);
Allan Stephensd265fef2010-11-30 12:00:53 +0000222
223int tipc_send_buf2port(u32 portref, struct tipc_portid const *dest,
224 struct sk_buff *buf, unsigned int dsz);
225
Allan Stephens38f232e2010-11-30 12:00:59 +0000226int tipc_multicast(u32 portref, struct tipc_name_seq const *seq,
Allan Stephens26896902011-04-21 10:42:07 -0500227 unsigned int section_count, struct iovec const *msg,
228 unsigned int total_len);
Allan Stephensd265fef2010-11-30 12:00:53 +0000229
Allan Stephens23dd4cc2011-01-07 11:43:40 -0500230int tipc_port_reject_sections(struct tipc_port *p_ptr, struct tipc_msg *hdr,
Per Liden4323add2006-01-18 00:38:21 +0100231 struct iovec const *msg_sect, u32 num_sect,
Allan Stephens26896902011-04-21 10:42:07 -0500232 unsigned int total_len, int err);
Per Liden4323add2006-01-18 00:38:21 +0100233struct sk_buff *tipc_port_get_ports(void);
Per Liden4323add2006-01-18 00:38:21 +0100234void tipc_port_recv_proto_msg(struct sk_buff *buf);
Paul Gortmaker45843102011-12-29 20:33:30 -0500235void tipc_port_recv_mcast(struct sk_buff *buf, struct tipc_port_list *dp);
Per Liden4323add2006-01-18 00:38:21 +0100236void tipc_port_reinit(void);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100237
238/**
Per Liden4323add2006-01-18 00:38:21 +0100239 * tipc_port_lock - lock port instance referred to and return its pointer
Per Lidenb97bf3f2006-01-02 19:04:38 +0100240 */
Allan Stephens23dd4cc2011-01-07 11:43:40 -0500241static inline struct tipc_port *tipc_port_lock(u32 ref)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100242{
Allan Stephens23dd4cc2011-01-07 11:43:40 -0500243 return (struct tipc_port *)tipc_ref_lock(ref);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100244}
245
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900246/**
Per Liden4323add2006-01-18 00:38:21 +0100247 * tipc_port_unlock - unlock a port instance
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900248 *
Per Liden4323add2006-01-18 00:38:21 +0100249 * Can use pointer instead of tipc_ref_unlock() since port is already locked.
Per Lidenb97bf3f2006-01-02 19:04:38 +0100250 */
Allan Stephens23dd4cc2011-01-07 11:43:40 -0500251static inline void tipc_port_unlock(struct tipc_port *p_ptr)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100252{
Allan Stephens23dd4cc2011-01-07 11:43:40 -0500253 spin_unlock_bh(p_ptr->lock);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100254}
255
Allan Stephens23dd4cc2011-01-07 11:43:40 -0500256static inline struct tipc_port *tipc_port_deref(u32 ref)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100257{
Allan Stephens23dd4cc2011-01-07 11:43:40 -0500258 return (struct tipc_port *)tipc_ref_deref(ref);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100259}
260
Allan Stephens23dd4cc2011-01-07 11:43:40 -0500261static inline int tipc_port_congested(struct tipc_port *p_ptr)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100262{
Eric Dumazeta02cec22010-09-22 20:43:57 +0000263 return (p_ptr->sent - p_ptr->acked) >= (TIPC_FLOW_CONTROL_WIN * 2);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100264}
265
Per Lidenb97bf3f2006-01-02 19:04:38 +0100266#endif