blob: 9087063793f26eb352f9b848a14b27545c8b02be [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 *
Per Liden593a5f22006-01-11 19:14:19 +01004 * Copyright (c) 2000-2006, 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
40#include "node_subscr.h"
Allan Stephens8f92df62010-12-31 18:59:19 +000041#include "addr.h"
42#include "net.h"
Per Lidenb97bf3f2006-01-02 19:04:38 +010043#include "bearer.h"
44
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 Xue10f465c2014-05-05 08:56:11 +080055 */
56enum {
Ying Xueaecb9bb2014-05-08 08:54:39 +080057 TIPC_WAIT_PEER_LINKS_DOWN = (1 << 1),
58 TIPC_WAIT_OWN_LINKS_DOWN = (1 << 2),
59 TIPC_NOTIFY_NODE_DOWN = (1 << 3),
60 TIPC_NOTIFY_NODE_UP = (1 << 4)
Ying Xue10f465c2014-05-05 08:56:11 +080061};
Allan Stephensb4b56102011-05-27 11:00:51 -040062
Per Lidenb97bf3f2006-01-02 19:04:38 +010063/**
Ying Xue486f9302014-05-05 08:56:10 +080064 * struct tipc_node_bclink - TIPC node bclink structure
65 * @acked: sequence # of last outbound b'cast message acknowledged by node
66 * @last_in: sequence # of last in-sequence b'cast message received from node
67 * @last_sent: sequence # of last b'cast message sent by node
68 * @oos_state: state tracker for handling OOS b'cast messages
69 * @deferred_size: number of OOS b'cast messages in deferred queue
70 * @deferred_head: oldest OOS b'cast message received from node
71 * @deferred_tail: newest OOS b'cast message received from node
Jon Paul Maloy37e22162014-05-14 05:39:12 -040072 * @reasm_buf: broadcast reassembly queue head from node
Ying Xue486f9302014-05-05 08:56:10 +080073 * @recv_permitted: true if node is allowed to receive b'cast messages
74 */
75struct tipc_node_bclink {
76 u32 acked;
77 u32 last_in;
78 u32 last_sent;
79 u32 oos_state;
80 u32 deferred_size;
81 struct sk_buff *deferred_head;
82 struct sk_buff *deferred_tail;
Jon Paul Maloy37e22162014-05-14 05:39:12 -040083 struct sk_buff *reasm_buf;
Ying Xue486f9302014-05-05 08:56:10 +080084 bool recv_permitted;
85};
86
87/**
David S. Miller6c000552008-09-02 23:38:32 -070088 * struct tipc_node - TIPC node structure
Per Lidenb97bf3f2006-01-02 19:04:38 +010089 * @addr: network address of node
90 * @lock: spinlock governing access to structure
Allan Stephens672d99e2011-02-25 18:42:52 -050091 * @hash: links to adjacent nodes in unsorted hash chain
Per Lidenb97bf3f2006-01-02 19:04:38 +010092 * @active_links: pointers to active links to node
93 * @links: pointers to all links to node
Ying Xueaecb9bb2014-05-08 08:54:39 +080094 * @action_flags: bit mask of different types of node actions
Ying Xue486f9302014-05-05 08:56:10 +080095 * @bclink: broadcast-related info
96 * @list: links to adjacent nodes in sorted list of cluster's nodes
97 * @working_links: number of working links to node (both active and standby)
Per Lidenb97bf3f2006-01-02 19:04:38 +010098 * @link_cnt: number of links to node
Allan Stephensfc0eea62011-10-28 16:26:41 -040099 * @signature: node instance identifier
Ying Xue486f9302014-05-05 08:56:10 +0800100 * @nsub: list of "node down" subscriptions monitoring node
Ying Xue6c7a7622014-03-27 12:54:37 +0800101 * @rcu: rcu struct for tipc_node
Per Lidenb97bf3f2006-01-02 19:04:38 +0100102 */
David S. Miller6c000552008-09-02 23:38:32 -0700103struct tipc_node {
Per Lidenb97bf3f2006-01-02 19:04:38 +0100104 u32 addr;
105 spinlock_t lock;
Allan Stephens672d99e2011-02-25 18:42:52 -0500106 struct hlist_node hash;
Paul Gortmakera18c4bc2011-12-29 20:58:42 -0500107 struct tipc_link *active_links[2];
108 struct tipc_link *links[MAX_BEARERS];
Ying Xueaecb9bb2014-05-08 08:54:39 +0800109 unsigned int action_flags;
Ying Xue486f9302014-05-05 08:56:10 +0800110 struct tipc_node_bclink bclink;
111 struct list_head list;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100112 int link_cnt;
Allan Stephens5392d642006-06-25 23:52:50 -0700113 int working_links;
Allan Stephensfc0eea62011-10-28 16:26:41 -0400114 u32 signature;
Ying Xue486f9302014-05-05 08:56:10 +0800115 struct list_head nsub;
Ying Xue6c7a7622014-03-27 12:54:37 +0800116 struct rcu_head rcu;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100117};
118
Allan Stephens672d99e2011-02-25 18:42:52 -0500119extern struct list_head tipc_node_list;
120
Allan Stephens672d99e2011-02-25 18:42:52 -0500121struct tipc_node *tipc_node_find(u32 addr);
David S. Miller6c000552008-09-02 23:38:32 -0700122struct tipc_node *tipc_node_create(u32 addr);
Ying Xue46651c52014-03-27 12:54:36 +0800123void tipc_node_stop(void);
Paul Gortmakera18c4bc2011-12-29 20:58:42 -0500124void tipc_node_attach_link(struct tipc_node *n_ptr, struct tipc_link *l_ptr);
125void tipc_node_detach_link(struct tipc_node *n_ptr, struct tipc_link *l_ptr);
126void tipc_node_link_down(struct tipc_node *n_ptr, struct tipc_link *l_ptr);
127void tipc_node_link_up(struct tipc_node *n_ptr, struct tipc_link *l_ptr);
Paul Gortmaker8f19afb2011-02-28 11:36:21 -0400128int tipc_node_active_links(struct tipc_node *n_ptr);
David S. Miller6c000552008-09-02 23:38:32 -0700129int tipc_node_is_up(struct tipc_node *n_ptr);
Per Liden4323add2006-01-18 00:38:21 +0100130struct sk_buff *tipc_node_get_links(const void *req_tlv_area, int req_tlv_space);
131struct sk_buff *tipc_node_get_nodes(const void *req_tlv_area, int req_tlv_space);
Erik Hugne78acb1f2014-04-24 16:26:47 +0200132int tipc_node_get_linkname(u32 bearer_id, u32 node, char *linkname, size_t len);
Ying Xue9db9fdd2014-05-05 08:56:12 +0800133void tipc_node_unlock(struct tipc_node *node);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100134
Ying Xue9db9fdd2014-05-05 08:56:12 +0800135static inline void tipc_node_lock(struct tipc_node *node)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100136{
Ying Xue9db9fdd2014-05-05 08:56:12 +0800137 spin_lock_bh(&node->lock);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100138}
139
Ying Xue10f465c2014-05-05 08:56:11 +0800140static inline bool tipc_node_blocked(struct tipc_node *node)
141{
Ying Xueaecb9bb2014-05-08 08:54:39 +0800142 return (node->action_flags & (TIPC_WAIT_PEER_LINKS_DOWN |
143 TIPC_NOTIFY_NODE_DOWN | TIPC_WAIT_OWN_LINKS_DOWN));
Ying Xue10f465c2014-05-05 08:56:11 +0800144}
145
Per Lidenb97bf3f2006-01-02 19:04:38 +0100146#endif