LXR linux/net/tipc/bcast.h

   1/*
   2 * net/tipc/bcast.h: Include file for TIPC broadcast code
   3 *
   4 * Copyright (c) 2003-2006, 2014-2015, 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_BCAST_H
  38#define _TIPC_BCAST_H
  39
  40#include "core.h"
  41
  42struct tipc_node;
  43struct tipc_msg;
  44struct tipc_nl_msg;
  45struct tipc_nlist;
  46struct tipc_nitem;
  47extern const char tipc_bclink_name[];
  48extern unsigned long sysctl_tipc_bc_retruni;
  49
  50#define TIPC_METHOD_EXPIRE msecs_to_jiffies(5000)
  51
  52#define BCLINK_MODE_BCAST  0x1
  53#define BCLINK_MODE_RCAST  0x2
  54#define BCLINK_MODE_SEL    0x4
  55
  56struct tipc_nlist {
  57        struct list_head list;
  58        u32 self;
  59        u16 remote;
  60        bool local;
  61};
  62
  63void tipc_nlist_init(struct tipc_nlist *nl, u32 self);
  64void tipc_nlist_purge(struct tipc_nlist *nl);
  65void tipc_nlist_add(struct tipc_nlist *nl, u32 node);
  66void tipc_nlist_del(struct tipc_nlist *nl, u32 node);
  67
  68/* Cookie to be used between socket and broadcast layer
  69 * @rcast: replicast (instead of broadcast) was used at previous xmit
  70 * @mandatory: broadcast/replicast indication was set by user
  71 * @deferredq: defer queue to make message in order
  72 * @expires: re-evaluate non-mandatory transmit method if we are past this
  73 */
  74struct tipc_mc_method {
  75        bool rcast;
  76        bool mandatory;
  77        struct sk_buff_head deferredq;
  78        unsigned long expires;
  79};
  80
  81int tipc_bcast_init(struct net *net);
  82void tipc_bcast_stop(struct net *net);
  83void tipc_bcast_add_peer(struct net *net, struct tipc_link *l,
  84                         struct sk_buff_head *xmitq);
  85void tipc_bcast_remove_peer(struct net *net, struct tipc_link *rcv_bcl);
  86void tipc_bcast_inc_bearer_dst_cnt(struct net *net, int bearer_id);
  87void tipc_bcast_dec_bearer_dst_cnt(struct net *net, int bearer_id);
  88int  tipc_bcast_get_mtu(struct net *net);
  89void tipc_bcast_toggle_rcast(struct net *net, bool supp);
  90int tipc_mcast_xmit(struct net *net, struct sk_buff_head *pkts,
  91                    struct tipc_mc_method *method, struct tipc_nlist *dests,
  92                    u16 *cong_link_cnt);
  93int tipc_bcast_xmit(struct net *net, struct sk_buff_head *pkts,
  94                    u16 *cong_link_cnt);
  95int tipc_bcast_rcv(struct net *net, struct tipc_link *l, struct sk_buff *skb);
  96void tipc_bcast_ack_rcv(struct net *net, struct tipc_link *l,
  97                        struct tipc_msg *hdr);
  98int tipc_bcast_sync_rcv(struct net *net, struct tipc_link *l,
  99                        struct tipc_msg *hdr,
 100                        struct sk_buff_head *retrq);
 101int tipc_nl_add_bc_link(struct net *net, struct tipc_nl_msg *msg,
 102                        struct tipc_link *bcl);
 103int tipc_nl_bc_link_set(struct net *net, struct nlattr *attrs[]);
 104int tipc_bclink_reset_stats(struct net *net, struct tipc_link *l);
 105
 106u32 tipc_bcast_get_mode(struct net *net);
 107u32 tipc_bcast_get_broadcast_ratio(struct net *net);
 108
 109void tipc_mcast_filter_msg(struct net *net, struct sk_buff_head *defq,
 110                           struct sk_buff_head *inputq);
 111
 112static inline void tipc_bcast_lock(struct net *net)
 113{
 114        spin_lock_bh(&tipc_net(net)->bclock);
 115}
 116
 117static inline void tipc_bcast_unlock(struct net *net)
 118{
 119        spin_unlock_bh(&tipc_net(net)->bclock);
 120}
 121
 122static inline struct tipc_link *tipc_bc_sndlink(struct net *net)
 123{
 124        return tipc_net(net)->bcl;
 125}
 126
 127#endif
 128