blob: cbe0e950f1ccb81a63a3e0a19719cdef6fb2c6c5 [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 *
Richard Alpe3e4b6ab2014-11-20 10:29:17 +01004 * Copyright (c) 2000-2006, 2014, 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
Allan Stephensfc0eea62011-10-28 16:26:41 -040045/*
46 * Out-of-range value for node signature
47 */
48#define INVALID_NODE_SIG 0x10000
49
Ying Xueaecb9bb2014-05-08 08:54:39 +080050/* Flags used to take different actions according to flag type
51 * TIPC_WAIT_PEER_LINKS_DOWN: wait to see that peer's links are down
52 * TIPC_WAIT_OWN_LINKS_DOWN: wait until peer node is declared down
53 * TIPC_NOTIFY_NODE_DOWN: notify node is down
54 * TIPC_NOTIFY_NODE_UP: notify node is up
Ying Xue7b8613e2014-10-20 14:44:25 +080055 * TIPC_DISTRIBUTE_NAME: publish or withdraw link state name type
Ying Xue10f465c2014-05-05 08:56:11 +080056 */
57enum {
Ying Xueaecb9bb2014-05-08 08:54:39 +080058 TIPC_WAIT_PEER_LINKS_DOWN = (1 << 1),
59 TIPC_WAIT_OWN_LINKS_DOWN = (1 << 2),
60 TIPC_NOTIFY_NODE_DOWN = (1 << 3),
Jon Paul Maloy50100a52014-08-22 18:09:07 -040061 TIPC_NOTIFY_NODE_UP = (1 << 4),
Jon Maloy908344c2014-10-07 14:12:34 -040062 TIPC_WAKEUP_USERS = (1 << 5),
Ying Xue7b8613e2014-10-20 14:44:25 +080063 TIPC_WAKEUP_BCAST_USERS = (1 << 6),
64 TIPC_NOTIFY_LINK_UP = (1 << 7),
65 TIPC_NOTIFY_LINK_DOWN = (1 << 8)
Ying Xue10f465c2014-05-05 08:56:11 +080066};
Allan Stephensb4b56102011-05-27 11:00:51 -040067
Per Lidenb97bf3f2006-01-02 19:04:38 +010068/**
Ying Xue486f9302014-05-05 08:56:10 +080069 * struct tipc_node_bclink - TIPC node bclink structure
70 * @acked: sequence # of last outbound b'cast message acknowledged by node
71 * @last_in: sequence # of last in-sequence b'cast message received from node
72 * @last_sent: sequence # of last b'cast message sent by node
73 * @oos_state: state tracker for handling OOS b'cast messages
Ying Xuebc6fecd2014-11-26 11:41:53 +080074 * @deferred_queue: deferred queue saved OOS b'cast message received from node
Jon Paul Maloy37e22162014-05-14 05:39:12 -040075 * @reasm_buf: broadcast reassembly queue head from node
Ying Xue486f9302014-05-05 08:56:10 +080076 * @recv_permitted: true if node is allowed to receive b'cast messages
77 */
78struct tipc_node_bclink {
79 u32 acked;
80 u32 last_in;
81 u32 last_sent;
82 u32 oos_state;
83 u32 deferred_size;
Ying Xuebc6fecd2014-11-26 11:41:53 +080084 struct sk_buff_head deferred_queue;
Jon Paul Maloy37e22162014-05-14 05:39:12 -040085 struct sk_buff *reasm_buf;
Ying Xue486f9302014-05-05 08:56:10 +080086 bool recv_permitted;
87};
88
89/**
David S. Miller6c000552008-09-02 23:38:32 -070090 * struct tipc_node - TIPC node structure
Per Lidenb97bf3f2006-01-02 19:04:38 +010091 * @addr: network address of node
92 * @lock: spinlock governing access to structure
Allan Stephens672d99e2011-02-25 18:42:52 -050093 * @hash: links to adjacent nodes in unsorted hash chain
Per Lidenb97bf3f2006-01-02 19:04:38 +010094 * @active_links: pointers to active links to node
95 * @links: pointers to all links to node
Ying Xueaecb9bb2014-05-08 08:54:39 +080096 * @action_flags: bit mask of different types of node actions
Ying Xue486f9302014-05-05 08:56:10 +080097 * @bclink: broadcast-related info
98 * @list: links to adjacent nodes in sorted list of cluster's nodes
99 * @working_links: number of working links to node (both active and standby)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100100 * @link_cnt: number of links to node
Allan Stephensfc0eea62011-10-28 16:26:41 -0400101 * @signature: node instance identifier
Ying Xue7b8613e2014-10-20 14:44:25 +0800102 * @link_id: local and remote bearer ids of changing link, if any
Ying Xuea8f48af2014-11-26 11:41:45 +0800103 * @publ_list: list of publications
Ying Xue6c7a7622014-03-27 12:54:37 +0800104 * @rcu: rcu struct for tipc_node
Per Lidenb97bf3f2006-01-02 19:04:38 +0100105 */
David S. Miller6c000552008-09-02 23:38:32 -0700106struct tipc_node {
Per Lidenb97bf3f2006-01-02 19:04:38 +0100107 u32 addr;
108 spinlock_t lock;
Allan Stephens672d99e2011-02-25 18:42:52 -0500109 struct hlist_node hash;
Paul Gortmakera18c4bc2011-12-29 20:58:42 -0500110 struct tipc_link *active_links[2];
Jon Paul Maloy16e166b2014-06-25 20:41:33 -0500111 u32 act_mtus[2];
Paul Gortmakera18c4bc2011-12-29 20:58:42 -0500112 struct tipc_link *links[MAX_BEARERS];
Ying Xueaecb9bb2014-05-08 08:54:39 +0800113 unsigned int action_flags;
Ying Xue486f9302014-05-05 08:56:10 +0800114 struct tipc_node_bclink bclink;
115 struct list_head list;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100116 int link_cnt;
Allan Stephens5392d642006-06-25 23:52:50 -0700117 int working_links;
Allan Stephensfc0eea62011-10-28 16:26:41 -0400118 u32 signature;
Ying Xue7b8613e2014-10-20 14:44:25 +0800119 u32 link_id;
Ying Xuea8f48af2014-11-26 11:41:45 +0800120 struct list_head publ_list;
Jon Paul Maloy50100a52014-08-22 18:09:07 -0400121 struct sk_buff_head waiting_sks;
Jon Paul Maloy02be61a2014-08-22 18:09:08 -0400122 struct list_head conn_sks;
Ying Xue6c7a7622014-03-27 12:54:37 +0800123 struct rcu_head rcu;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100124};
125
Allan Stephens672d99e2011-02-25 18:42:52 -0500126extern struct list_head tipc_node_list;
127
Allan Stephens672d99e2011-02-25 18:42:52 -0500128struct tipc_node *tipc_node_find(u32 addr);
David S. Miller6c000552008-09-02 23:38:32 -0700129struct tipc_node *tipc_node_create(u32 addr);
Ying Xue46651c52014-03-27 12:54:36 +0800130void tipc_node_stop(void);
Paul Gortmakera18c4bc2011-12-29 20:58:42 -0500131void tipc_node_attach_link(struct tipc_node *n_ptr, struct tipc_link *l_ptr);
132void tipc_node_detach_link(struct tipc_node *n_ptr, struct tipc_link *l_ptr);
133void tipc_node_link_down(struct tipc_node *n_ptr, struct tipc_link *l_ptr);
134void tipc_node_link_up(struct tipc_node *n_ptr, struct tipc_link *l_ptr);
Paul Gortmaker8f19afb2011-02-28 11:36:21 -0400135int tipc_node_active_links(struct tipc_node *n_ptr);
David S. Miller6c000552008-09-02 23:38:32 -0700136int tipc_node_is_up(struct tipc_node *n_ptr);
Per Liden4323add2006-01-18 00:38:21 +0100137struct sk_buff *tipc_node_get_links(const void *req_tlv_area, int req_tlv_space);
138struct sk_buff *tipc_node_get_nodes(const void *req_tlv_area, int req_tlv_space);
Erik Hugne78acb1f2014-04-24 16:26:47 +0200139int tipc_node_get_linkname(u32 bearer_id, u32 node, char *linkname, size_t len);
Ying Xue9db9fdd2014-05-05 08:56:12 +0800140void tipc_node_unlock(struct tipc_node *node);
Jon Paul Maloy02be61a2014-08-22 18:09:08 -0400141int tipc_node_add_conn(u32 dnode, u32 port, u32 peer_port);
142void tipc_node_remove_conn(u32 dnode, u32 port);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100143
Richard Alpe3e4b6ab2014-11-20 10:29:17 +0100144int tipc_nl_node_dump(struct sk_buff *skb, struct netlink_callback *cb);
145
Ying Xue9db9fdd2014-05-05 08:56:12 +0800146static inline void tipc_node_lock(struct tipc_node *node)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100147{
Ying Xue9db9fdd2014-05-05 08:56:12 +0800148 spin_lock_bh(&node->lock);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100149}
150
Ying Xue10f465c2014-05-05 08:56:11 +0800151static inline bool tipc_node_blocked(struct tipc_node *node)
152{
Ying Xueaecb9bb2014-05-08 08:54:39 +0800153 return (node->action_flags & (TIPC_WAIT_PEER_LINKS_DOWN |
154 TIPC_NOTIFY_NODE_DOWN | TIPC_WAIT_OWN_LINKS_DOWN));
Ying Xue10f465c2014-05-05 08:56:11 +0800155}
156
Jon Paul Maloy16e166b2014-06-25 20:41:33 -0500157static inline uint tipc_node_get_mtu(u32 addr, u32 selector)
158{
159 struct tipc_node *node;
160 u32 mtu;
161
162 node = tipc_node_find(addr);
163
164 if (likely(node))
165 mtu = node->act_mtus[selector & 1];
166 else
167 mtu = MAX_MSG_SIZE;
168
169 return mtu;
170}
171
Per Lidenb97bf3f2006-01-02 19:04:38 +0100172#endif