net/tipc/bearer.h

   1 /*
   2  * net/tipc/bearer.h: Include file for TIPC bearer code
   3  *
   4  * Copyright (c) 1996-2006, 2013-2014, 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_BEARER_H
  38 #define _TIPC_BEARER_H
  39
  40 #include "netlink.h"
  41 #include "core.h"
  42 #include "msg.h"
  43 #include <net/genetlink.h>
  44
  45 #define MAX_MEDIA       3
  46 #define MAX_NODES       4096
  47 #define WSIZE           32
  48
  49 /* Identifiers associated with TIPC message header media address info
  50  * - address info field is 32 bytes long
  51  * - the field's actual content and length is defined per media
  52  * - remaining unused bytes in the field are set to zero
  53  */
  54 #define TIPC_MEDIA_INFO_SIZE    32
  55 #define TIPC_MEDIA_TYPE_OFFSET  3
  56 #define TIPC_MEDIA_ADDR_OFFSET  4
  57
  58 /*
  59  * Identifiers of supported TIPC media types
  60  */
  61 #define TIPC_MEDIA_TYPE_ETH     1
  62 #define TIPC_MEDIA_TYPE_IB      2
  63 #define TIPC_MEDIA_TYPE_UDP     3
  64
  65 /* minimum bearer MTU */
  66 #define TIPC_MIN_BEARER_MTU     (MAX_H_SIZE + INT_H_SIZE)
  67
  68 /**
  69  * struct tipc_node_map - set of node identifiers
  70  * @count: # of nodes in set
  71  * @map: bitmap of node identifiers that are in the set
  72  */
  73 struct tipc_node_map {
  74         u32 count;
  75         u32 map[MAX_NODES / WSIZE];
  76 };
  77
  78 /**
  79  * struct tipc_media_addr - destination address used by TIPC bearers
  80  * @value: address info (format defined by media)
  81  * @media_id: TIPC media type identifier
  82  * @broadcast: non-zero if address is a broadcast address
  83  */
  84 struct tipc_media_addr {
  85         u8 value[TIPC_MEDIA_INFO_SIZE];
  86         u8 media_id;
  87         u8 broadcast;
  88 };
  89
  90 struct tipc_bearer;
  91
  92 /**
  93  * struct tipc_media - Media specific info exposed to generic bearer layer
  94  * @send_msg: routine which handles buffer transmission
  95  * @enable_media: routine which enables a media
  96  * @disable_media: routine which disables a media
  97  * @addr2str: convert media address format to string
  98  * @addr2msg: convert from media addr format to discovery msg addr format
  99  * @msg2addr: convert from discovery msg addr format to media addr format
 100  * @raw2addr: convert from raw addr format to media addr format
 101  * @priority: default link (and bearer) priority
 102  * @tolerance: default time (in ms) before declaring link failure
 103  * @window: default window (in packets) before declaring link congestion
 104  * @type_id: TIPC media identifier
 105  * @hwaddr_len: TIPC media address len
 106  * @name: media name
 107  */
 108 struct tipc_media {
 109         int (*send_msg)(struct net *net, struct sk_buff *buf,
 110                         struct tipc_bearer *b_ptr,
 111                         struct tipc_media_addr *dest);
 112         int (*enable_media)(struct net *net, struct tipc_bearer *b_ptr,
 113                             struct nlattr *attr[]);
 114         void (*disable_media)(struct tipc_bearer *b_ptr);
 115         int (*addr2str)(struct tipc_media_addr *addr,
 116                         char *strbuf,
 117                         int bufsz);
 118         int (*addr2msg)(char *msg, struct tipc_media_addr *addr);
 119         int (*msg2addr)(struct tipc_bearer *b,
 120                         struct tipc_media_addr *addr,
 121                         char *msg);
 122         int (*raw2addr)(struct tipc_bearer *b,
 123                         struct tipc_media_addr *addr,
 124                         char *raw);
 125         u32 priority;
 126         u32 tolerance;
 127         u32 window;
 128         u32 type_id;
 129         u32 hwaddr_len;
 130         char name[TIPC_MAX_MEDIA_NAME];
 131 };
 132
 133 /**
 134  * struct tipc_bearer - Generic TIPC bearer structure
 135  * @media_ptr: pointer to additional media-specific information about bearer
 136  * @mtu: max packet size bearer can support
 137  * @addr: media-specific address associated with bearer
 138  * @name: bearer name (format = media:interface)
 139  * @media: ptr to media structure associated with bearer
 140  * @bcast_addr: media address used in broadcasting
 141  * @rcu: rcu struct for tipc_bearer
 142  * @priority: default link priority for bearer
 143  * @window: default window size for bearer
 144  * @tolerance: default link tolerance for bearer
 145  * @domain: network domain to which links can be established
 146  * @identity: array index of this bearer within TIPC bearer array
 147  * @link_req: ptr to (optional) structure making periodic link setup requests
 148  * @net_plane: network plane ('A' through 'H') currently associated with bearer
 149  * @nodes: indicates which nodes in cluster can be reached through bearer
 150  *
 151  * Note: media-specific code is responsible for initialization of the fields
 152  * indicated below when a bearer is enabled; TIPC's generic bearer code takes
 153  * care of initializing all other fields.
 154  */
 155 struct tipc_bearer {
 156         void __rcu *media_ptr;                  /* initalized by media */
 157         u32 mtu;                                /* initalized by media */
 158         struct tipc_media_addr addr;            /* initalized by media */
 159         char name[TIPC_MAX_BEARER_NAME];
 160         struct tipc_media *media;
 161         struct tipc_media_addr bcast_addr;
 162         struct rcu_head rcu;
 163         u32 priority;
 164         u32 window;
 165         u32 tolerance;
 166         u32 domain;
 167         u32 identity;
 168         struct tipc_link_req *link_req;
 169         char net_plane;
 170         int node_cnt;
 171         struct tipc_node_map nodes;
 172 };
 173
 174 struct tipc_bearer_names {
 175         char media_name[TIPC_MAX_MEDIA_NAME];
 176         char if_name[TIPC_MAX_IF_NAME];
 177 };
 178
 179 /*
 180  * TIPC routines available to supported media types
 181  */
 182
 183 void tipc_rcv(struct net *net, struct sk_buff *skb, struct tipc_bearer *b_ptr);
 184
 185 /*
 186  * Routines made available to TIPC by supported media types
 187  */
 188 extern struct tipc_media eth_media_info;
 189
 190 #ifdef CONFIG_TIPC_MEDIA_IB
 191 extern struct tipc_media ib_media_info;
 192 #endif
 193 #ifdef CONFIG_TIPC_MEDIA_UDP
 194 extern struct tipc_media udp_media_info;
 195 #endif
 196
 197 int tipc_nl_bearer_disable(struct sk_buff *skb, struct genl_info *info);
 198 int tipc_nl_bearer_enable(struct sk_buff *skb, struct genl_info *info);
 199 int tipc_nl_bearer_dump(struct sk_buff *skb, struct netlink_callback *cb);
 200 int tipc_nl_bearer_get(struct sk_buff *skb, struct genl_info *info);
 201 int tipc_nl_bearer_set(struct sk_buff *skb, struct genl_info *info);
 202
 203 int tipc_nl_media_dump(struct sk_buff *skb, struct netlink_callback *cb);
 204 int tipc_nl_media_get(struct sk_buff *skb, struct genl_info *info);
 205 int tipc_nl_media_set(struct sk_buff *skb, struct genl_info *info);
 206
 207 int tipc_media_set_priority(const char *name, u32 new_value);
 208 int tipc_media_set_window(const char *name, u32 new_value);
 209 void tipc_media_addr_printf(char *buf, int len, struct tipc_media_addr *a);
 210 int tipc_enable_l2_media(struct net *net, struct tipc_bearer *b,
 211                          struct nlattr *attrs[]);
 212 void tipc_disable_l2_media(struct tipc_bearer *b);
 213 int tipc_l2_send_msg(struct net *net, struct sk_buff *buf,
 214                      struct tipc_bearer *b, struct tipc_media_addr *dest);
 215
 216 void tipc_bearer_add_dest(struct net *net, u32 bearer_id, u32 dest);
 217 void tipc_bearer_remove_dest(struct net *net, u32 bearer_id, u32 dest);
 218 struct tipc_bearer *tipc_bearer_find(struct net *net, const char *name);
 219 struct tipc_media *tipc_media_find(const char *name);
 220 int tipc_bearer_setup(void);
 221 void tipc_bearer_cleanup(void);
 222 void tipc_bearer_stop(struct net *net);
 223 int tipc_bearer_mtu(struct net *net, u32 bearer_id);
 224 void tipc_bearer_xmit_skb(struct net *net, u32 bearer_id,
 225                           struct sk_buff *skb,
 226                           struct tipc_media_addr *dest);
 227 void tipc_bearer_xmit(struct net *net, u32 bearer_id,
 228                       struct sk_buff_head *xmitq,
 229                       struct tipc_media_addr *dst);
 230 void tipc_bearer_bc_xmit(struct net *net, u32 bearer_id,
 231                          struct sk_buff_head *xmitq);
 232
 233 /* check if device MTU is too low for tipc headers */
 234 static inline bool tipc_mtu_bad(struct net_device *dev, unsigned int reserve)
 235 {
 236         if (dev->mtu >= TIPC_MIN_BEARER_MTU + reserve)
 237                 return false;
 238         netdev_warn(dev, "MTU too low for tipc bearer\n");
 239         return true;
 240 }
 241
 242 #endif  /* _TIPC_BEARER_H */