linux/net/tipc/node.h
<<
>>
Prefs
   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-2014, 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#include "msg.h"
  45
  46/*
  47 * Out-of-range value for node signature
  48 */
  49#define INVALID_NODE_SIG 0x10000
  50
  51/* Flags used to take different actions according to flag type
  52 * TIPC_WAIT_PEER_LINKS_DOWN: wait to see that peer's links are down
  53 * TIPC_WAIT_OWN_LINKS_DOWN: wait until peer node is declared down
  54 * TIPC_NOTIFY_NODE_DOWN: notify node is down
  55 * TIPC_NOTIFY_NODE_UP: notify node is up
  56 */
  57enum {
  58        TIPC_WAIT_PEER_LINKS_DOWN       = (1 << 1),
  59        TIPC_WAIT_OWN_LINKS_DOWN        = (1 << 2),
  60        TIPC_NOTIFY_NODE_DOWN           = (1 << 3),
  61        TIPC_NOTIFY_NODE_UP             = (1 << 4)
  62};
  63
  64/**
  65 * struct tipc_node_bclink - TIPC node bclink structure
  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 * @last_sent: sequence # of last b'cast message sent by node
  69 * @oos_state: state tracker for handling OOS b'cast messages
  70 * @deferred_size: number of OOS b'cast messages in deferred queue
  71 * @deferred_head: oldest OOS b'cast message received from node
  72 * @deferred_tail: newest OOS b'cast message received from node
  73 * @reasm_buf: broadcast reassembly queue head from node
  74 * @recv_permitted: true if node is allowed to receive b'cast messages
  75 */
  76struct tipc_node_bclink {
  77        u32 acked;
  78        u32 last_in;
  79        u32 last_sent;
  80        u32 oos_state;
  81        u32 deferred_size;
  82        struct sk_buff *deferred_head;
  83        struct sk_buff *deferred_tail;
  84        struct sk_buff *reasm_buf;
  85        bool recv_permitted;
  86};
  87
  88/**
  89 * struct tipc_node - TIPC node structure
  90 * @addr: network address of node
  91 * @lock: spinlock governing access to structure
  92 * @hash: links to adjacent nodes in unsorted hash chain
  93 * @active_links: pointers to active links to node
  94 * @links: pointers to all links to node
  95 * @action_flags: bit mask of different types of node actions
  96 * @bclink: broadcast-related info
  97 * @list: links to adjacent nodes in sorted list of cluster's nodes
  98 * @working_links: number of working links to node (both active and standby)
  99 * @link_cnt: number of links to node
 100 * @signature: node instance identifier
 101 * @nsub: list of "node down" subscriptions monitoring node
 102 * @rcu: rcu struct for tipc_node
 103 */
 104struct tipc_node {
 105        u32 addr;
 106        spinlock_t lock;
 107        struct hlist_node hash;
 108        struct tipc_link *active_links[2];
 109        u32 act_mtus[2];
 110        struct tipc_link *links[MAX_BEARERS];
 111        unsigned int action_flags;
 112        struct tipc_node_bclink bclink;
 113        struct list_head list;
 114        int link_cnt;
 115        int working_links;
 116        u32 signature;
 117        struct list_head nsub;
 118        struct rcu_head rcu;
 119};
 120
 121extern struct list_head tipc_node_list;
 122
 123struct tipc_node *tipc_node_find(u32 addr);
 124struct tipc_node *tipc_node_create(u32 addr);
 125void tipc_node_stop(void);
 126void tipc_node_attach_link(struct tipc_node *n_ptr, struct tipc_link *l_ptr);
 127void tipc_node_detach_link(struct tipc_node *n_ptr, struct tipc_link *l_ptr);
 128void tipc_node_link_down(struct tipc_node *n_ptr, struct tipc_link *l_ptr);
 129void tipc_node_link_up(struct tipc_node *n_ptr, struct tipc_link *l_ptr);
 130int tipc_node_active_links(struct tipc_node *n_ptr);
 131int tipc_node_is_up(struct tipc_node *n_ptr);
 132struct sk_buff *tipc_node_get_links(const void *req_tlv_area, int req_tlv_space);
 133struct sk_buff *tipc_node_get_nodes(const void *req_tlv_area, int req_tlv_space);
 134int tipc_node_get_linkname(u32 bearer_id, u32 node, char *linkname, size_t len);
 135void tipc_node_unlock(struct tipc_node *node);
 136
 137static inline void tipc_node_lock(struct tipc_node *node)
 138{
 139        spin_lock_bh(&node->lock);
 140}
 141
 142static inline bool tipc_node_blocked(struct tipc_node *node)
 143{
 144        return (node->action_flags & (TIPC_WAIT_PEER_LINKS_DOWN |
 145                TIPC_NOTIFY_NODE_DOWN | TIPC_WAIT_OWN_LINKS_DOWN));
 146}
 147
 148static inline uint tipc_node_get_mtu(u32 addr, u32 selector)
 149{
 150        struct tipc_node *node;
 151        u32 mtu;
 152
 153        node = tipc_node_find(addr);
 154
 155        if (likely(node))
 156                mtu = node->act_mtus[selector & 1];
 157        else
 158                mtu = MAX_MSG_SIZE;
 159
 160        return mtu;
 161}
 162
 163#endif
 164