blob: 7fd37c202ce6e8576d1ec3877bb5f551691a80a2 [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
Ying Xue198d73b2013-06-17 10:54:42 -04005 * Copyright (c) 2004-2007, 2010-2013, 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
Ying Xuecc79dd12013-06-17 10:54:37 -040046#define CONN_OVERLOAD_LIMIT ((TIPC_FLOW_CONTROL_WIN * 2 + 1) * \
47 SKB_TRUESIZE(TIPC_MAX_USER_MSG_SIZE))
Allan Stephensd265fef2010-11-30 12:00:53 +000048
Per Lidenb97bf3f2006-01-02 19:04:38 +010049/**
50 * struct user_port - TIPC user port (used with native API)
Per Lidenb97bf3f2006-01-02 19:04:38 +010051 * @usr_handle: user-specified field
52 * @ref: object reference to associated TIPC port
Ben Hutchings2c530402012-07-10 10:55:09 +000053 *
Per Lidenb97bf3f2006-01-02 19:04:38 +010054 * <various callback routines>
Per Lidenb97bf3f2006-01-02 19:04:38 +010055 */
Per Lidenb97bf3f2006-01-02 19:04:38 +010056struct user_port {
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +090057 void *usr_handle;
Per Lidenb97bf3f2006-01-02 19:04:38 +010058 u32 ref;
Per Lidenb97bf3f2006-01-02 19:04:38 +010059};
60
61/**
Allan Stephens23dd4cc2011-01-07 11:43:40 -050062 * struct tipc_port - TIPC port structure
Allan Stephensd265fef2010-11-30 12:00:53 +000063 * @usr_handle: pointer to additional user-defined information about port
64 * @lock: pointer to spinlock for controlling access to port
65 * @connected: non-zero if port is currently connected to a peer port
66 * @conn_type: TIPC type used when connection was established
67 * @conn_instance: TIPC instance used when connection was established
68 * @conn_unacked: number of unacknowledged messages received from peer port
69 * @published: non-zero if port has one or more associated names
70 * @congested: non-zero if cannot send because of link or port congestion
71 * @max_pkt: maximum packet size "hint" used when building messages sent by port
72 * @ref: unique reference to port in TIPC object registry
73 * @phdr: preformatted message header used when sending messages
Per Lidenb97bf3f2006-01-02 19:04:38 +010074 * @port_list: adjacent ports in TIPC's global list of ports
75 * @dispatcher: ptr to routine which handles received messages
76 * @wakeup: ptr to routine to call when port is no longer congested
77 * @user_port: ptr to user port associated with port (if any)
78 * @wait_list: adjacent ports in list of ports waiting on link congestion
Per Lidenb97bf3f2006-01-02 19:04:38 +010079 * @waiting_pkts:
Allan Stephenscb7ce912011-01-24 15:02:14 -050080 * @sent: # of non-empty messages sent by port
81 * @acked: # of non-empty message acknowledgements from connected port's peer
Per Lidenb97bf3f2006-01-02 19:04:38 +010082 * @publications: list of publications for port
83 * @pub_count: total # of publications port has made during its lifetime
Per Lidenb97bf3f2006-01-02 19:04:38 +010084 * @probing_state:
85 * @probing_interval:
Per Lidenb97bf3f2006-01-02 19:04:38 +010086 * @timer_ref:
87 * @subscription: "node down" subscription used to terminate failed connections
88 */
Allan Stephens23dd4cc2011-01-07 11:43:40 -050089struct tipc_port {
90 void *usr_handle;
91 spinlock_t *lock;
92 int connected;
93 u32 conn_type;
94 u32 conn_instance;
95 u32 conn_unacked;
96 int published;
97 u32 congested;
98 u32 max_pkt;
99 u32 ref;
100 struct tipc_msg phdr;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100101 struct list_head port_list;
102 u32 (*dispatcher)(struct tipc_port *, struct sk_buff *);
103 void (*wakeup)(struct tipc_port *);
104 struct user_port *user_port;
105 struct list_head wait_list;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100106 u32 waiting_pkts;
107 u32 sent;
108 u32 acked;
109 struct list_head publications;
110 u32 pub_count;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100111 u32 probing_state;
112 u32 probing_interval;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100113 struct timer_list timer;
David S. Miller6c000552008-09-02 23:38:32 -0700114 struct tipc_node_subscr subscription;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100115};
116
Per Liden4323add2006-01-18 00:38:21 +0100117extern spinlock_t tipc_port_list_lock;
Paul Gortmaker45843102011-12-29 20:33:30 -0500118struct tipc_port_list;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100119
Allan Stephensd265fef2010-11-30 12:00:53 +0000120/*
121 * TIPC port manipulation routines
122 */
123struct tipc_port *tipc_createport_raw(void *usr_handle,
124 u32 (*dispatcher)(struct tipc_port *, struct sk_buff *),
125 void (*wakeup)(struct tipc_port *), const u32 importance);
126
127int tipc_reject_msg(struct sk_buff *buf, u32 err);
128
Allan Stephensd265fef2010-11-30 12:00:53 +0000129void tipc_acknowledge(u32 port_ref, u32 ack);
130
Allan Stephensd265fef2010-11-30 12:00:53 +0000131int tipc_deleteport(u32 portref);
132
Allan Stephensd265fef2010-11-30 12:00:53 +0000133int tipc_portimportance(u32 portref, unsigned int *importance);
134int tipc_set_portimportance(u32 portref, unsigned int importance);
135
136int tipc_portunreliable(u32 portref, unsigned int *isunreliable);
137int tipc_set_portunreliable(u32 portref, unsigned int isunreliable);
138
139int tipc_portunreturnable(u32 portref, unsigned int *isunreturnable);
140int tipc_set_portunreturnable(u32 portref, unsigned int isunreturnable);
141
142int tipc_publish(u32 portref, unsigned int scope,
143 struct tipc_name_seq const *name_seq);
144int tipc_withdraw(u32 portref, unsigned int scope,
145 struct tipc_name_seq const *name_seq);
146
Paul Gortmakerbc879112012-11-29 13:48:40 -0500147int tipc_connect(u32 portref, struct tipc_portid const *port);
Allan Stephensd265fef2010-11-30 12:00:53 +0000148
149int tipc_disconnect(u32 portref);
150
151int tipc_shutdown(u32 ref);
152
153
154/*
155 * The following routines require that the port be locked on entry
156 */
Paul Gortmakerbc879112012-11-29 13:48:40 -0500157int __tipc_disconnect(struct tipc_port *tp_ptr);
158int __tipc_connect(u32 ref, struct tipc_port *p_ptr,
159 struct tipc_portid const *peer);
Allan Stephensf0712e862012-04-17 18:42:28 -0400160int tipc_port_peer_msg(struct tipc_port *p_ptr, struct tipc_msg *msg);
Allan Stephensd265fef2010-11-30 12:00:53 +0000161
162/*
163 * TIPC messaging routines
164 */
Allan Stephens9b641252011-11-09 13:29:18 -0500165int tipc_port_recv_msg(struct sk_buff *buf);
Allan Stephens26896902011-04-21 10:42:07 -0500166int tipc_send(u32 portref, unsigned int num_sect, struct iovec const *msg_sect,
167 unsigned int total_len);
Allan Stephensd265fef2010-11-30 12:00:53 +0000168
169int tipc_send2name(u32 portref, struct tipc_name const *name, u32 domain,
Allan Stephens26896902011-04-21 10:42:07 -0500170 unsigned int num_sect, struct iovec const *msg_sect,
171 unsigned int total_len);
Allan Stephensd265fef2010-11-30 12:00:53 +0000172
173int tipc_send2port(u32 portref, struct tipc_portid const *dest,
Allan Stephens26896902011-04-21 10:42:07 -0500174 unsigned int num_sect, struct iovec const *msg_sect,
175 unsigned int total_len);
Allan Stephensd265fef2010-11-30 12:00:53 +0000176
Allan Stephens38f232e2010-11-30 12:00:59 +0000177int tipc_multicast(u32 portref, struct tipc_name_seq const *seq,
Allan Stephens26896902011-04-21 10:42:07 -0500178 unsigned int section_count, struct iovec const *msg,
179 unsigned int total_len);
Allan Stephensd265fef2010-11-30 12:00:53 +0000180
Allan Stephens23dd4cc2011-01-07 11:43:40 -0500181int tipc_port_reject_sections(struct tipc_port *p_ptr, struct tipc_msg *hdr,
Per Liden4323add2006-01-18 00:38:21 +0100182 struct iovec const *msg_sect, u32 num_sect,
Allan Stephens26896902011-04-21 10:42:07 -0500183 unsigned int total_len, int err);
Per Liden4323add2006-01-18 00:38:21 +0100184struct sk_buff *tipc_port_get_ports(void);
Per Liden4323add2006-01-18 00:38:21 +0100185void tipc_port_recv_proto_msg(struct sk_buff *buf);
Paul Gortmaker45843102011-12-29 20:33:30 -0500186void tipc_port_recv_mcast(struct sk_buff *buf, struct tipc_port_list *dp);
Per Liden4323add2006-01-18 00:38:21 +0100187void tipc_port_reinit(void);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100188
189/**
Per Liden4323add2006-01-18 00:38:21 +0100190 * tipc_port_lock - lock port instance referred to and return its pointer
Per Lidenb97bf3f2006-01-02 19:04:38 +0100191 */
Allan Stephens23dd4cc2011-01-07 11:43:40 -0500192static inline struct tipc_port *tipc_port_lock(u32 ref)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100193{
Allan Stephens23dd4cc2011-01-07 11:43:40 -0500194 return (struct tipc_port *)tipc_ref_lock(ref);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100195}
196
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900197/**
Per Liden4323add2006-01-18 00:38:21 +0100198 * tipc_port_unlock - unlock a port instance
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900199 *
Per Liden4323add2006-01-18 00:38:21 +0100200 * Can use pointer instead of tipc_ref_unlock() since port is already locked.
Per Lidenb97bf3f2006-01-02 19:04:38 +0100201 */
Allan Stephens23dd4cc2011-01-07 11:43:40 -0500202static inline void tipc_port_unlock(struct tipc_port *p_ptr)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100203{
Allan Stephens23dd4cc2011-01-07 11:43:40 -0500204 spin_unlock_bh(p_ptr->lock);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100205}
206
Allan Stephens23dd4cc2011-01-07 11:43:40 -0500207static inline struct tipc_port *tipc_port_deref(u32 ref)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100208{
Allan Stephens23dd4cc2011-01-07 11:43:40 -0500209 return (struct tipc_port *)tipc_ref_deref(ref);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100210}
211
Allan Stephens23dd4cc2011-01-07 11:43:40 -0500212static inline int tipc_port_congested(struct tipc_port *p_ptr)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100213{
Eric Dumazeta02cec22010-09-22 20:43:57 +0000214 return (p_ptr->sent - p_ptr->acked) >= (TIPC_FLOW_CONTROL_WIN * 2);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100215}
216
Per Lidenb97bf3f2006-01-02 19:04:38 +0100217#endif