net/tipc/bearer.h

   1 /*
   2  * net/tipc/bearer.h: Include file for TIPC bearer code
   3  *
   4  * Copyright (c) 1996-2006, 2013, 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 "bcast.h"
  41
  42 #define MAX_BEARERS     2
  43 #define MAX_MEDIA       2
  44
  45 /* Identifiers associated with TIPC message header media address info
  46  * - address info field is 32 bytes long
  47  * - the field's actual content and length is defined per media
  48  * - remaining unused bytes in the field are set to zero
  49  */
  50 #define TIPC_MEDIA_ADDR_SIZE    32
  51 #define TIPC_MEDIA_TYPE_OFFSET  3
  52
  53 /* Message header sizes from msg.h - duplicated to avoid mutual inclusion */
  54 #define INT_H_SIZE                40
  55 #define MAX_H_SIZE                60
  56
  57 /* minimum bearer MTU */
  58 #define TIPC_MIN_BEARER_MTU     (MAX_H_SIZE + INT_H_SIZE)
  59
  60 /*
  61  * Identifiers of supported TIPC media types
  62  */
  63 #define TIPC_MEDIA_TYPE_ETH     1
  64 #define TIPC_MEDIA_TYPE_IB      2
  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_ADDR_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 sk_buff *buf,
  98                         struct tipc_bearer *b_ptr,
  99                         struct tipc_media_addr *dest);
 100         int (*enable_media)(struct tipc_bearer *b_ptr);
 101         void (*disable_media)(struct tipc_bearer *b_ptr);
 102         int (*addr2str)(struct tipc_media_addr *addr,
 103                         char *strbuf,
 104                         int bufsz);
 105         int (*addr2msg)(char *msg, struct tipc_media_addr *addr);
 106         int (*msg2addr)(struct tipc_bearer *b,
 107                         struct tipc_media_addr *addr,
 108                         char *msg);
 109         int (*raw2addr)(struct tipc_bearer *b,
 110                         struct tipc_media_addr *addr,
 111                         char *raw);
 112         u32 priority;
 113         u32 tolerance;
 114         u32 window;
 115         u32 type_id;
 116         u32 hwaddr_len;
 117         char name[TIPC_MAX_MEDIA_NAME];
 118 };
 119
 120 /**
 121  * struct tipc_bearer - Generic TIPC bearer structure
 122  * @media_ptr: pointer to additional media-specific information about bearer
 123  * @mtu: max packet size bearer can support
 124  * @addr: media-specific address associated with bearer
 125  * @name: bearer name (format = media:interface)
 126  * @media: ptr to media structure associated with bearer
 127  * @bcast_addr: media address used in broadcasting
 128  * @rcu: rcu struct for tipc_bearer
 129  * @priority: default link priority for bearer
 130  * @window: default window size for bearer
 131  * @tolerance: default link tolerance for bearer
 132  * @domain: network domain to which links can be established
 133  * @identity: array index of this bearer within TIPC bearer array
 134  * @link_req: ptr to (optional) structure making periodic link setup requests
 135  * @net_plane: network plane ('A' through 'H') currently associated with bearer
 136  * @nodes: indicates which nodes in cluster can be reached through 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         struct tipc_node_map nodes;
 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 struct tipc_link;
 166
 167 extern struct tipc_bearer __rcu *bearer_list[];
 168
 169 /*
 170  * TIPC routines available to supported media types
 171  */
 172
 173 void tipc_rcv(struct sk_buff *buf, struct tipc_bearer *tb_ptr);
 174 int tipc_enable_bearer(const char *bearer_name, u32 disc_domain, u32 priority);
 175 int tipc_disable_bearer(const char *name);
 176
 177 /*
 178  * Routines made available to TIPC by supported media types
 179  */
 180 extern struct tipc_media eth_media_info;
 181
 182 #ifdef CONFIG_TIPC_MEDIA_IB
 183 extern struct tipc_media ib_media_info;
 184 #endif
 185
 186 int tipc_media_set_priority(const char *name, u32 new_value);
 187 int tipc_media_set_window(const char *name, u32 new_value);
 188 void tipc_media_addr_printf(char *buf, int len, struct tipc_media_addr *a);
 189 struct sk_buff *tipc_media_get_names(void);
 190 int tipc_enable_l2_media(struct tipc_bearer *b);
 191 void tipc_disable_l2_media(struct tipc_bearer *b);
 192 int tipc_l2_send_msg(struct sk_buff *buf, struct tipc_bearer *b,
 193                      struct tipc_media_addr *dest);
 194
 195 struct sk_buff *tipc_bearer_get_names(void);
 196 void tipc_bearer_add_dest(u32 bearer_id, u32 dest);
 197 void tipc_bearer_remove_dest(u32 bearer_id, u32 dest);
 198 struct tipc_bearer *tipc_bearer_find(const char *name);
 199 struct tipc_media *tipc_media_find(const char *name);
 200 int tipc_bearer_setup(void);
 201 void tipc_bearer_cleanup(void);
 202 void tipc_bearer_stop(void);
 203 void tipc_bearer_send(u32 bearer_id, struct sk_buff *buf,
 204                       struct tipc_media_addr *dest);
 205
 206 /* check if device MTU is too low for tipc headers */
 207 static inline bool tipc_mtu_bad(struct net_device *dev, unsigned int reserve)
 208 {
 209         if (dev->mtu >= TIPC_MIN_BEARER_MTU + reserve)
 210                 return false;
 211         netdev_warn(dev, "MTU too low for tipc bearer\n");
 212         return true;
 213 }
 214
 215 #endif  /* _TIPC_BEARER_H */