blob: 36a1cd0bc1f1abf26431b1100a48eea74ecaf7ca [file] [log] [blame]
Per Lidenb97bf3f2006-01-02 19:04:38 +01001/*
2 * net/tipc/node.h: Include file for TIPC node management routines
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +09003 *
Jon Paul Maloycb1b7282015-02-05 08:36:44 -05004 * Copyright (c) 2000-2006, 2014-2015, Ericsson AB
Ying Xue46651c52014-03-27 12:54:36 +08005 * Copyright (c) 2005, 2010-2014, 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_NODE_H
38#define _TIPC_NODE_H
39
Allan Stephens8f92df62010-12-31 18:59:19 +000040#include "addr.h"
41#include "net.h"
Per Lidenb97bf3f2006-01-02 19:04:38 +010042#include "bearer.h"
Jon Paul Maloy16e166b2014-06-25 20:41:33 -050043#include "msg.h"
Per Lidenb97bf3f2006-01-02 19:04:38 +010044
Ying Xuef2f98002015-01-09 15:27:05 +080045/* Out-of-range value for node signature */
46#define INVALID_NODE_SIG 0x10000
47
Jon Paul Maloy36e78a42015-07-16 16:54:22 -040048#define INVALID_BEARER_ID -1
49
Ying Xueaecb9bb2014-05-08 08:54:39 +080050/* Flags used to take different actions according to flag type
Ying Xueaecb9bb2014-05-08 08:54:39 +080051 * TIPC_NOTIFY_NODE_DOWN: notify node is down
52 * TIPC_NOTIFY_NODE_UP: notify node is up
Ying Xue7b8613e2014-10-20 14:44:25 +080053 * TIPC_DISTRIBUTE_NAME: publish or withdraw link state name type
Ying Xue10f465c2014-05-05 08:56:11 +080054 */
55enum {
Ying Xueaecb9bb2014-05-08 08:54:39 +080056 TIPC_NOTIFY_NODE_DOWN = (1 << 3),
Jon Paul Maloy50100a52014-08-22 18:09:07 -040057 TIPC_NOTIFY_NODE_UP = (1 << 4),
Jon Paul Maloyc637c102015-02-05 08:36:41 -050058 TIPC_WAKEUP_BCAST_USERS = (1 << 5),
59 TIPC_NOTIFY_LINK_UP = (1 << 6),
60 TIPC_NOTIFY_LINK_DOWN = (1 << 7),
Ying Xueb952b2b2015-03-26 18:10:23 +080061 TIPC_BCAST_MSG_EVT = (1 << 9),
62 TIPC_BCAST_RESET = (1 << 10)
Ying Xue10f465c2014-05-05 08:56:11 +080063};
Allan Stephensb4b56102011-05-27 11:00:51 -040064
Jon Paul Maloyfd556f22015-10-22 08:51:40 -040065/* Optional capabilities supported by this code version
66 */
67enum {
68 TIPC_BCAST_SYNCH = (1 << 1)
69};
70
71#define TIPC_NODE_CAPABILITIES TIPC_BCAST_SYNCH
72
Per Lidenb97bf3f2006-01-02 19:04:38 +010073/**
Ying Xue486f9302014-05-05 08:56:10 +080074 * struct tipc_node_bclink - TIPC node bclink structure
75 * @acked: sequence # of last outbound b'cast message acknowledged by node
76 * @last_in: sequence # of last in-sequence b'cast message received from node
77 * @last_sent: sequence # of last b'cast message sent by node
78 * @oos_state: state tracker for handling OOS b'cast messages
Ying Xuebc6fecd2014-11-26 11:41:53 +080079 * @deferred_queue: deferred queue saved OOS b'cast message received from node
Jon Paul Maloy37e22162014-05-14 05:39:12 -040080 * @reasm_buf: broadcast reassembly queue head from node
Jon Paul Maloycb1b7282015-02-05 08:36:44 -050081 * @inputq_map: bitmap indicating which inqueues should be kicked
Ying Xue486f9302014-05-05 08:56:10 +080082 * @recv_permitted: true if node is allowed to receive b'cast messages
83 */
84struct tipc_node_bclink {
85 u32 acked;
86 u32 last_in;
87 u32 last_sent;
88 u32 oos_state;
89 u32 deferred_size;
Jon Paul Maloy05dcc5a2015-03-13 16:08:10 -040090 struct sk_buff_head deferdq;
Jon Paul Maloy37e22162014-05-14 05:39:12 -040091 struct sk_buff *reasm_buf;
Jon Paul Maloyd39bbd42015-07-16 16:54:21 -040092 struct sk_buff_head namedq;
Ying Xue486f9302014-05-05 08:56:10 +080093 bool recv_permitted;
94};
95
Jon Paul Maloy9d13ec62015-07-16 16:54:19 -040096struct tipc_link_entry {
97 struct tipc_link *link;
98 u32 mtu;
Jon Paul Maloyd39bbd42015-07-16 16:54:21 -040099 struct sk_buff_head inputq;
Jon Paul Maloyd3a43b92015-07-16 16:54:20 -0400100 struct tipc_media_addr maddr;
Jon Paul Maloy9d13ec62015-07-16 16:54:19 -0400101};
102
Jon Paul Maloy52666982015-10-22 08:51:41 -0400103struct tipc_bclink_entry {
104 struct tipc_link *link;
105 struct sk_buff_head inputq1;
106 struct sk_buff_head arrvq;
107 struct sk_buff_head inputq2;
108 struct sk_buff_head namedq;
109};
110
Ying Xue486f9302014-05-05 08:56:10 +0800111/**
David S. Miller6c000552008-09-02 23:38:32 -0700112 * struct tipc_node - TIPC node structure
Per Lidenb97bf3f2006-01-02 19:04:38 +0100113 * @addr: network address of node
Ying Xue8a0f6eb2015-03-26 18:10:24 +0800114 * @ref: reference counter to node object
Per Lidenb97bf3f2006-01-02 19:04:38 +0100115 * @lock: spinlock governing access to structure
Ying Xuef2f98002015-01-09 15:27:05 +0800116 * @net: the applicable net namespace
Allan Stephens672d99e2011-02-25 18:42:52 -0500117 * @hash: links to adjacent nodes in unsorted hash chain
Jon Paul Maloyc637c102015-02-05 08:36:41 -0500118 * @inputq: pointer to input queue containing messages for msg event
119 * @namedq: pointer to name table input queue with name table messages
Jon Paul Maloy36e78a42015-07-16 16:54:22 -0400120 * @active_links: bearer ids of active links, used as index into links[] array
Jon Paul Maloy9d13ec62015-07-16 16:54:19 -0400121 * @links: array containing references to all links to node
Ying Xueaecb9bb2014-05-08 08:54:39 +0800122 * @action_flags: bit mask of different types of node actions
Ying Xue486f9302014-05-05 08:56:10 +0800123 * @bclink: broadcast-related info
Jon Paul Maloy6e498152015-07-30 18:24:19 -0400124 * @state: connectivity state vs peer node
125 * @sync_point: sequence number where synch/failover is finished
Ying Xue486f9302014-05-05 08:56:10 +0800126 * @list: links to adjacent nodes in sorted list of cluster's nodes
127 * @working_links: number of working links to node (both active and standby)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100128 * @link_cnt: number of links to node
Jon Paul Maloy7764d6e2015-03-13 16:08:05 -0400129 * @capabilities: bitmap, indicating peer node's functional capabilities
Allan Stephensfc0eea62011-10-28 16:26:41 -0400130 * @signature: node instance identifier
Ying Xue7b8613e2014-10-20 14:44:25 +0800131 * @link_id: local and remote bearer ids of changing link, if any
Ying Xuea8f48af2014-11-26 11:41:45 +0800132 * @publ_list: list of publications
Ying Xue6c7a7622014-03-27 12:54:37 +0800133 * @rcu: rcu struct for tipc_node
Per Lidenb97bf3f2006-01-02 19:04:38 +0100134 */
David S. Miller6c000552008-09-02 23:38:32 -0700135struct tipc_node {
Per Lidenb97bf3f2006-01-02 19:04:38 +0100136 u32 addr;
Ying Xue8a0f6eb2015-03-26 18:10:24 +0800137 struct kref kref;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100138 spinlock_t lock;
Ying Xuef2f98002015-01-09 15:27:05 +0800139 struct net *net;
Allan Stephens672d99e2011-02-25 18:42:52 -0500140 struct hlist_node hash;
Jon Paul Maloy36e78a42015-07-16 16:54:22 -0400141 int active_links[2];
Jon Paul Maloy9d13ec62015-07-16 16:54:19 -0400142 struct tipc_link_entry links[MAX_BEARERS];
Jon Paul Maloy52666982015-10-22 08:51:41 -0400143 struct tipc_bclink_entry bc_entry;
Jon Paul Maloyc637c102015-02-05 08:36:41 -0500144 int action_flags;
Ying Xue486f9302014-05-05 08:56:10 +0800145 struct tipc_node_bclink bclink;
146 struct list_head list;
Jon Paul Maloy1a20cc22015-07-16 16:54:30 -0400147 int state;
Jon Paul Maloy6e498152015-07-30 18:24:19 -0400148 u16 sync_point;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100149 int link_cnt;
Jon Paul Maloy7764d6e2015-03-13 16:08:05 -0400150 u16 working_links;
151 u16 capabilities;
Allan Stephensfc0eea62011-10-28 16:26:41 -0400152 u32 signature;
Ying Xue7b8613e2014-10-20 14:44:25 +0800153 u32 link_id;
Ying Xuea8f48af2014-11-26 11:41:45 +0800154 struct list_head publ_list;
Jon Paul Maloy02be61a2014-08-22 18:09:08 -0400155 struct list_head conn_sks;
Jon Paul Maloy8a1577c2015-07-16 16:54:29 -0400156 unsigned long keepalive_intv;
157 struct timer_list timer;
Ying Xue6c7a7622014-03-27 12:54:37 +0800158 struct rcu_head rcu;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100159};
160
Ying Xuef2f98002015-01-09 15:27:05 +0800161struct tipc_node *tipc_node_find(struct net *net, u32 addr);
Ying Xue8a0f6eb2015-03-26 18:10:24 +0800162void tipc_node_put(struct tipc_node *node);
Ying Xuef2f98002015-01-09 15:27:05 +0800163void tipc_node_stop(struct net *net);
Jon Paul Maloycf148812015-07-30 18:24:22 -0400164void tipc_node_check_dest(struct net *net, u32 onode,
165 struct tipc_bearer *bearer,
166 u16 capabilities, u32 signature,
167 struct tipc_media_addr *maddr,
168 bool *respond, bool *dupl_addr);
Jon Paul Maloy6144a992015-07-30 18:24:16 -0400169void tipc_node_delete_links(struct net *net, int bearer_id);
Paul Gortmakera18c4bc2011-12-29 20:58:42 -0500170void tipc_node_attach_link(struct tipc_node *n_ptr, struct tipc_link *l_ptr);
171void tipc_node_detach_link(struct tipc_node *n_ptr, struct tipc_link *l_ptr);
Jon Paul Maloy9d13ec62015-07-16 16:54:19 -0400172bool tipc_node_is_up(struct tipc_node *n);
Ying Xuef2f98002015-01-09 15:27:05 +0800173int tipc_node_get_linkname(struct net *net, u32 bearer_id, u32 node,
174 char *linkname, size_t len);
Ying Xue9db9fdd2014-05-05 08:56:12 +0800175void tipc_node_unlock(struct tipc_node *node);
Jon Paul Maloyaf9b0282015-07-16 16:54:24 -0400176int tipc_node_xmit(struct net *net, struct sk_buff_head *list, u32 dnode,
177 int selector);
178int tipc_node_xmit_skb(struct net *net, struct sk_buff *skb, u32 dest,
179 u32 selector);
Ying Xuef2f98002015-01-09 15:27:05 +0800180int tipc_node_add_conn(struct net *net, u32 dnode, u32 port, u32 peer_port);
181void tipc_node_remove_conn(struct net *net, u32 dnode, u32 port);
Richard Alpe3e4b6ab2014-11-20 10:29:17 +0100182int tipc_nl_node_dump(struct sk_buff *skb, struct netlink_callback *cb);
183
Ying Xue9db9fdd2014-05-05 08:56:12 +0800184static inline void tipc_node_lock(struct tipc_node *node)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100185{
Ying Xue9db9fdd2014-05-05 08:56:12 +0800186 spin_lock_bh(&node->lock);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100187}
188
Jon Paul Maloy9d13ec62015-07-16 16:54:19 -0400189static inline struct tipc_link *node_active_link(struct tipc_node *n, int sel)
190{
Jon Paul Maloy36e78a42015-07-16 16:54:22 -0400191 int bearer_id = n->active_links[sel & 1];
Jon Paul Maloy9d13ec62015-07-16 16:54:19 -0400192
Jon Paul Maloy36e78a42015-07-16 16:54:22 -0400193 if (unlikely(bearer_id == INVALID_BEARER_ID))
194 return NULL;
195
196 return n->links[bearer_id].link;
Jon Paul Maloy9d13ec62015-07-16 16:54:19 -0400197}
198
Jon Paul Maloy36e78a42015-07-16 16:54:22 -0400199static inline unsigned int tipc_node_get_mtu(struct net *net, u32 addr, u32 sel)
Jon Paul Maloy16e166b2014-06-25 20:41:33 -0500200{
Jon Paul Maloy9d13ec62015-07-16 16:54:19 -0400201 struct tipc_node *n;
Jon Paul Maloy36e78a42015-07-16 16:54:22 -0400202 int bearer_id;
Jon Paul Maloy9d13ec62015-07-16 16:54:19 -0400203 unsigned int mtu = MAX_MSG_SIZE;
Jon Paul Maloy16e166b2014-06-25 20:41:33 -0500204
Jon Paul Maloy9d13ec62015-07-16 16:54:19 -0400205 n = tipc_node_find(net, addr);
206 if (unlikely(!n))
207 return mtu;
Jon Paul Maloy36e78a42015-07-16 16:54:22 -0400208
209 bearer_id = n->active_links[sel & 1];
210 if (likely(bearer_id != INVALID_BEARER_ID))
211 mtu = n->links[bearer_id].mtu;
Jon Paul Maloy9d13ec62015-07-16 16:54:19 -0400212 tipc_node_put(n);
Jon Paul Maloy16e166b2014-06-25 20:41:33 -0500213 return mtu;
214}
215
Per Lidenb97bf3f2006-01-02 19:04:38 +0100216#endif