blob: 4f15cb40aaa44491cfbbfca2a59d7f5f374599ee [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 Stephensb4b56102011-05-27 11:00:51 -040045/* Flags used to block (re)establishment of contact with a neighboring node */
46
47#define WAIT_PEER_DOWN 0x0001 /* wait to see that peer's links are down */
48#define WAIT_NAMES_GONE 0x0002 /* wait for peer's publications to be purged */
49#define WAIT_NODE_DOWN 0x0004 /* wait until peer node is declared down */
50
Per Lidenb97bf3f2006-01-02 19:04:38 +010051/**
David S. Miller6c000552008-09-02 23:38:32 -070052 * struct tipc_node - TIPC node structure
Per Lidenb97bf3f2006-01-02 19:04:38 +010053 * @addr: network address of node
54 * @lock: spinlock governing access to structure
Allan Stephens672d99e2011-02-25 18:42:52 -050055 * @hash: links to adjacent nodes in unsorted hash chain
56 * @list: links to adjacent nodes in sorted list of cluster's nodes
Per Lidenb97bf3f2006-01-02 19:04:38 +010057 * @nsub: list of "node down" subscriptions monitoring node
58 * @active_links: pointers to active links to node
59 * @links: pointers to all links to node
Allan Stephens5392d642006-06-25 23:52:50 -070060 * @working_links: number of working links to node (both active and standby)
Allan Stephensb4b56102011-05-27 11:00:51 -040061 * @block_setup: bit mask of conditions preventing link establishment to node
Per Lidenb97bf3f2006-01-02 19:04:38 +010062 * @link_cnt: number of links to node
63 * @permit_changeover: non-zero if node has redundant links to this system
Per Lidenb97bf3f2006-01-02 19:04:38 +010064 * @bclink: broadcast-related info
65 * @supported: non-zero if node supports TIPC b'cast capability
66 * @acked: sequence # of last outbound b'cast message acknowledged by node
67 * @last_in: sequence # of last in-sequence b'cast message received from node
68 * @gap_after: sequence # of last message not requiring a NAK request
69 * @gap_to: sequence # of last message requiring a NAK request
70 * @nack_sync: counter that determines when NAK requests should be sent
71 * @deferred_head: oldest OOS b'cast message received from node
72 * @deferred_tail: newest OOS b'cast message received from node
73 * @defragm: list of partially reassembled b'cast message fragments from node
74 */
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +090075
David S. Miller6c000552008-09-02 23:38:32 -070076struct tipc_node {
Per Lidenb97bf3f2006-01-02 19:04:38 +010077 u32 addr;
78 spinlock_t lock;
Allan Stephens672d99e2011-02-25 18:42:52 -050079 struct hlist_node hash;
80 struct list_head list;
Per Lidenb97bf3f2006-01-02 19:04:38 +010081 struct list_head nsub;
82 struct link *active_links[2];
83 struct link *links[MAX_BEARERS];
84 int link_cnt;
Allan Stephens5392d642006-06-25 23:52:50 -070085 int working_links;
Allan Stephensb4b56102011-05-27 11:00:51 -040086 int block_setup;
Per Lidenb97bf3f2006-01-02 19:04:38 +010087 int permit_changeover;
Per Lidenb97bf3f2006-01-02 19:04:38 +010088 struct {
89 int supported;
90 u32 acked;
91 u32 last_in;
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +090092 u32 gap_after;
93 u32 gap_to;
Per Lidenb97bf3f2006-01-02 19:04:38 +010094 u32 nack_sync;
95 struct sk_buff *deferred_head;
96 struct sk_buff *deferred_tail;
97 struct sk_buff *defragm;
98 } bclink;
99};
100
Allan Stephens672d99e2011-02-25 18:42:52 -0500101#define NODE_HTABLE_SIZE 512
102extern struct list_head tipc_node_list;
103
104/*
105 * A trivial power-of-two bitmask technique is used for speed, since this
106 * operation is done for every incoming TIPC packet. The number of hash table
107 * entries has been chosen so that no hash chain exceeds 8 nodes and will
108 * usually be much smaller (typically only a single node).
109 */
110static inline unsigned int tipc_hashfn(u32 addr)
111{
112 return addr & (NODE_HTABLE_SIZE - 1);
113}
114
Per Lidenb97bf3f2006-01-02 19:04:38 +0100115extern u32 tipc_own_tag;
116
Allan Stephens672d99e2011-02-25 18:42:52 -0500117struct tipc_node *tipc_node_find(u32 addr);
David S. Miller6c000552008-09-02 23:38:32 -0700118struct tipc_node *tipc_node_create(u32 addr);
119void tipc_node_delete(struct tipc_node *n_ptr);
Allan Stephens37b9c082011-02-28 11:32:27 -0500120void tipc_node_attach_link(struct tipc_node *n_ptr, struct link *l_ptr);
David S. Miller6c000552008-09-02 23:38:32 -0700121void tipc_node_detach_link(struct tipc_node *n_ptr, struct link *l_ptr);
122void tipc_node_link_down(struct tipc_node *n_ptr, struct link *l_ptr);
123void tipc_node_link_up(struct tipc_node *n_ptr, struct link *l_ptr);
Paul Gortmaker8f19afb2011-02-28 11:36:21 -0400124int tipc_node_active_links(struct tipc_node *n_ptr);
125int tipc_node_redundant_links(struct tipc_node *n_ptr);
David S. Miller6c000552008-09-02 23:38:32 -0700126int tipc_node_is_up(struct tipc_node *n_ptr);
Per Liden4323add2006-01-18 00:38:21 +0100127struct sk_buff *tipc_node_get_links(const void *req_tlv_area, int req_tlv_space);
128struct sk_buff *tipc_node_get_nodes(const void *req_tlv_area, int req_tlv_space);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100129
David S. Miller6c000552008-09-02 23:38:32 -0700130static inline void tipc_node_lock(struct tipc_node *n_ptr)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100131{
132 spin_lock_bh(&n_ptr->lock);
133}
134
David S. Miller6c000552008-09-02 23:38:32 -0700135static inline void tipc_node_unlock(struct tipc_node *n_ptr)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100136{
137 spin_unlock_bh(&n_ptr->lock);
138}
139
140#endif