1/*
2 * net/tipc/node.h: Include file for TIPC node management routines
3 *
4 * Copyright (c) 2000-2006, Ericsson AB
5 * Copyright (c) 2005, 2010-2011, Wind River Systems
6 * All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions are met:
10 *
11 * 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.
19 *
20 * 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
34 * POSSIBILITY OF SUCH DAMAGE.
35 */
36
37#ifndef _TIPC_NODE_H
38#define _TIPC_NODE_H
39
40#include "node_subscr.h"
41#include "addr.h"
42#include "net.h"
43#include "bearer.h"
44
45/*
46 * Out-of-range value for node signature
47 */
48#define INVALID_NODE_SIG 0x10000
49
50/* Flags used to block (re)establishment of contact with a neighboring node */
51#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
55/**
56 * struct tipc_node - TIPC node structure
57 * @addr: network address of node
58 * @lock: spinlock governing access to structure
59 * @hash: links to adjacent nodes in unsorted hash chain
60 * @list: links to adjacent nodes in sorted list of cluster's nodes
61 * @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
64 * @working_links: number of working links to node (both active and standby)
65 * @block_setup: bit mask of conditions preventing link establishment to node
66 * @link_cnt: number of links to node
67 * @permit_changeover: non-zero if node has redundant links to this system
68 * @signature: node instance identifier
69 * @bclink: broadcast-related info
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
74 *    @deferred_size: number of OOS b'cast messages in deferred queue
75 *    @deferred_head: oldest OOS b'cast message received from node
76 *    @deferred_tail: newest OOS b'cast message received from node
77 *    @defragm: list of partially reassembled b'cast message fragments from node
78 *    @recv_permitted: true if node is allowed to receive b'cast messages
79 */
80struct tipc_node {
81	u32 addr;
82	spinlock_t lock;
83	struct hlist_node hash;
84	struct list_head list;
85	struct list_head nsub;
86	struct tipc_link *active_links[2];
87	struct tipc_link *links[MAX_BEARERS];
88	int link_cnt;
89	int working_links;
90	int block_setup;
91	int permit_changeover;
92	u32 signature;
93	struct {
94		u32 acked;
95		u32 last_in;
96		u32 last_sent;
97		u32 oos_state;
98		u32 deferred_size;
99		struct sk_buff *deferred_head;
100		struct sk_buff *deferred_tail;
101		struct sk_buff *defragm;
102		bool recv_permitted;
103	} bclink;
104};
105
106extern struct list_head tipc_node_list;
107
108struct tipc_node *tipc_node_find(u32 addr);
109struct tipc_node *tipc_node_create(u32 addr);
110void tipc_node_delete(struct tipc_node *n_ptr);
111void tipc_node_attach_link(struct tipc_node *n_ptr, struct tipc_link *l_ptr);
112void tipc_node_detach_link(struct tipc_node *n_ptr, struct tipc_link *l_ptr);
113void tipc_node_link_down(struct tipc_node *n_ptr, struct tipc_link *l_ptr);
114void tipc_node_link_up(struct tipc_node *n_ptr, struct tipc_link *l_ptr);
115int tipc_node_active_links(struct tipc_node *n_ptr);
116int tipc_node_redundant_links(struct tipc_node *n_ptr);
117int tipc_node_is_up(struct tipc_node *n_ptr);
118struct sk_buff *tipc_node_get_links(const void *req_tlv_area, int req_tlv_space);
119struct sk_buff *tipc_node_get_nodes(const void *req_tlv_area, int req_tlv_space);
120
121static inline void tipc_node_lock(struct tipc_node *n_ptr)
122{
123	spin_lock_bh(&n_ptr->lock);
124}
125
126static inline void tipc_node_unlock(struct tipc_node *n_ptr)
127{
128	spin_unlock_bh(&n_ptr->lock);
129}
130
131#endif
132