net/tipc/bearer.h

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