blob: e5e96c04e1676a91af811c8c270ce42296b27636 [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
Allan Stephens672d99e2011-02-25 18:42:52 -05005 * Copyright (c) 2005, 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_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
Allan Stephensb4b56102011-05-27 11:00:51 -040050/* Flags used to block (re)establishment of contact with a neighboring node */
Allan Stephensb4b56102011-05-27 11:00:51 -040051#define WAIT_PEER_DOWN 0x0001 /* wait to see that peer's links are down */
52#define WAIT_NAMES_GONE 0x0002 /* wait for peer's publications to be purged */
53#define WAIT_NODE_DOWN 0x0004 /* wait until peer node is declared down */
54
Per Lidenb97bf3f2006-01-02 19:04:38 +010055/**
David S. Miller6c000552008-09-02 23:38:32 -070056 * struct tipc_node - TIPC node structure
Per Lidenb97bf3f2006-01-02 19:04:38 +010057 * @addr: network address of node
58 * @lock: spinlock governing access to structure
Allan Stephens672d99e2011-02-25 18:42:52 -050059 * @hash: links to adjacent nodes in unsorted hash chain
60 * @list: links to adjacent nodes in sorted list of cluster's nodes
Per Lidenb97bf3f2006-01-02 19:04:38 +010061 * @nsub: list of "node down" subscriptions monitoring node
62 * @active_links: pointers to active links to node
63 * @links: pointers to all links to node
Allan Stephens5392d642006-06-25 23:52:50 -070064 * @working_links: number of working links to node (both active and standby)
Allan Stephensb4b56102011-05-27 11:00:51 -040065 * @block_setup: bit mask of conditions preventing link establishment to node
Per Lidenb97bf3f2006-01-02 19:04:38 +010066 * @link_cnt: number of links to node
67 * @permit_changeover: non-zero if node has redundant links to this system
Allan Stephensfc0eea62011-10-28 16:26:41 -040068 * @signature: node instance identifier
Per Lidenb97bf3f2006-01-02 19:04:38 +010069 * @bclink: broadcast-related info
Per Lidenb97bf3f2006-01-02 19:04:38 +010070 * @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
Allan Stephens7a54d4a2011-10-27 14:17:53 -040072 * @last_sent: sequence # of last b'cast message sent by node
73 * @oos_state: state tracker for handling OOS b'cast messages
74 * @deferred_size: number of OOS b'cast messages in deferred queue
Per Lidenb97bf3f2006-01-02 19:04:38 +010075 * @deferred_head: oldest OOS b'cast message received from node
76 * @deferred_tail: newest OOS b'cast message received from node
Erik Hugne40ba3cd2013-11-06 09:28:06 +010077 * @reasm_head: broadcast reassembly queue head from node
78 * @reasm_tail: last broadcast fragment received from node
Ying Xue389dd9b2012-11-16 13:51:30 +080079 * @recv_permitted: true if node is allowed to receive b'cast messages
Per Lidenb97bf3f2006-01-02 19:04:38 +010080 */
David S. Miller6c000552008-09-02 23:38:32 -070081struct tipc_node {
Per Lidenb97bf3f2006-01-02 19:04:38 +010082 u32 addr;
83 spinlock_t lock;
Allan Stephens672d99e2011-02-25 18:42:52 -050084 struct hlist_node hash;
85 struct list_head list;
Per Lidenb97bf3f2006-01-02 19:04:38 +010086 struct list_head nsub;
Paul Gortmakera18c4bc2011-12-29 20:58:42 -050087 struct tipc_link *active_links[2];
88 struct tipc_link *links[MAX_BEARERS];
Per Lidenb97bf3f2006-01-02 19:04:38 +010089 int link_cnt;
Allan Stephens5392d642006-06-25 23:52:50 -070090 int working_links;
Allan Stephensb4b56102011-05-27 11:00:51 -040091 int block_setup;
Per Lidenb97bf3f2006-01-02 19:04:38 +010092 int permit_changeover;
Allan Stephensfc0eea62011-10-28 16:26:41 -040093 u32 signature;
Per Lidenb97bf3f2006-01-02 19:04:38 +010094 struct {
Per Lidenb97bf3f2006-01-02 19:04:38 +010095 u32 acked;
96 u32 last_in;
Allan Stephens7a54d4a2011-10-27 14:17:53 -040097 u32 last_sent;
98 u32 oos_state;
99 u32 deferred_size;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100100 struct sk_buff *deferred_head;
101 struct sk_buff *deferred_tail;
Erik Hugne40ba3cd2013-11-06 09:28:06 +0100102 struct sk_buff *reasm_head;
103 struct sk_buff *reasm_tail;
Ying Xue389dd9b2012-11-16 13:51:30 +0800104 bool recv_permitted;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100105 } bclink;
106};
107
Allan Stephens672d99e2011-02-25 18:42:52 -0500108extern struct list_head tipc_node_list;
109
Allan Stephens672d99e2011-02-25 18:42:52 -0500110struct tipc_node *tipc_node_find(u32 addr);
David S. Miller6c000552008-09-02 23:38:32 -0700111struct tipc_node *tipc_node_create(u32 addr);
112void tipc_node_delete(struct tipc_node *n_ptr);
Paul Gortmakera18c4bc2011-12-29 20:58:42 -0500113void tipc_node_attach_link(struct tipc_node *n_ptr, struct tipc_link *l_ptr);
114void tipc_node_detach_link(struct tipc_node *n_ptr, struct tipc_link *l_ptr);
115void tipc_node_link_down(struct tipc_node *n_ptr, struct tipc_link *l_ptr);
116void tipc_node_link_up(struct tipc_node *n_ptr, struct tipc_link *l_ptr);
Paul Gortmaker8f19afb2011-02-28 11:36:21 -0400117int tipc_node_active_links(struct tipc_node *n_ptr);
118int tipc_node_redundant_links(struct tipc_node *n_ptr);
David S. Miller6c000552008-09-02 23:38:32 -0700119int tipc_node_is_up(struct tipc_node *n_ptr);
Per Liden4323add2006-01-18 00:38:21 +0100120struct sk_buff *tipc_node_get_links(const void *req_tlv_area, int req_tlv_space);
121struct sk_buff *tipc_node_get_nodes(const void *req_tlv_area, int req_tlv_space);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100122
David S. Miller6c000552008-09-02 23:38:32 -0700123static inline void tipc_node_lock(struct tipc_node *n_ptr)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100124{
125 spin_lock_bh(&n_ptr->lock);
126}
127
David S. Miller6c000552008-09-02 23:38:32 -0700128static inline void tipc_node_unlock(struct tipc_node *n_ptr)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100129{
130 spin_unlock_bh(&n_ptr->lock);
131}
132
133#endif