net/tipc/bearer.h

   1 /*
   2  * net/tipc/bearer.h: Include file for TIPC bearer code
   3  *
   4  * Copyright (c) 1996-2006, 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 /*
  46  * Identifiers of supported TIPC media types
  47  */
  48 #define TIPC_MEDIA_TYPE_ETH     1
  49
  50 /* Message header sizes from msg.h - duplicated to avoid mutual inclusion */
  51 #define INT_H_SIZE                40
  52 #define MAX_H_SIZE                60
  53
  54 /* minimum bearer MTU */
  55 #define TIPC_MIN_BEARER_MTU     (MAX_H_SIZE + INT_H_SIZE)
  56
  57 /*
  58  * Destination address structure used by TIPC bearers when sending messages
  59  *
  60  * IMPORTANT: The fields of this structure MUST be stored using the specified
  61  * byte order indicated below, as the structure is exchanged between nodes
  62  * as part of a link setup process.
  63  */
  64 struct tipc_media_addr {
  65         __be32  type;                   /* bearer type (network byte order) */
  66         union {
  67                 __u8   eth_addr[6];     /* 48 bit Ethernet addr (byte array) */
  68         } dev_addr;
  69 };
  70
  71 struct tipc_bearer;
  72
  73 /**
  74  * struct media - TIPC media information available to internal users
  75  * @send_msg: routine which handles buffer transmission
  76  * @enable_bearer: routine which enables a bearer
  77  * @disable_bearer: routine which disables a bearer
  78  * @addr2str: routine which converts bearer's address to string form
  79  * @bcast_addr: media address used in broadcasting
  80  * @priority: default link (and bearer) priority
  81  * @tolerance: default time (in ms) before declaring link failure
  82  * @window: default window (in packets) before declaring link congestion
  83  * @type_id: TIPC media identifier
  84  * @name: media name
  85  */
  86
  87 struct media {
  88         int (*send_msg)(struct sk_buff *buf,
  89                         struct tipc_bearer *b_ptr,
  90                         struct tipc_media_addr *dest);
  91         int (*enable_bearer)(struct tipc_bearer *b_ptr);
  92         void (*disable_bearer)(struct tipc_bearer *b_ptr);
  93         char *(*addr2str)(struct tipc_media_addr *a,
  94                           char *str_buf, int str_size);
  95         struct tipc_media_addr bcast_addr;
  96         u32 priority;
  97         u32 tolerance;
  98         u32 window;
  99         u32 type_id;
 100         char name[TIPC_MAX_MEDIA_NAME];
 101 };
 102
 103 /**
 104  * struct tipc_bearer - TIPC bearer structure
 105  * @usr_handle: pointer to additional media-specific information about bearer
 106  * @mtu: max packet size bearer can support
 107  * @blocked: non-zero if bearer is blocked
 108  * @lock: spinlock for controlling access to bearer
 109  * @addr: media-specific address associated with bearer
 110  * @name: bearer name (format = media:interface)
 111  * @media: ptr to media structure associated with bearer
 112  * @priority: default link priority for bearer
 113  * @identity: array index of this bearer within TIPC bearer array
 114  * @link_req: ptr to (optional) structure making periodic link setup requests
 115  * @links: list of non-congested links associated with bearer
 116  * @cong_links: list of congested links associated with bearer
 117  * @active: non-zero if bearer structure is represents a bearer
 118  * @net_plane: network plane ('A' through 'H') currently associated with bearer
 119  * @nodes: indicates which nodes in cluster can be reached through bearer
 120  *
 121  * Note: media-specific code is responsible for initialization of the fields
 122  * indicated below when a bearer is enabled; TIPC's generic bearer code takes
 123  * care of initializing all other fields.
 124  */
 125 struct tipc_bearer {
 126         void *usr_handle;                       /* initalized by media */
 127         u32 mtu;                                /* initalized by media */
 128         int blocked;                            /* initalized by media */
 129         struct tipc_media_addr addr;            /* initalized by media */
 130         char name[TIPC_MAX_BEARER_NAME];
 131         spinlock_t lock;
 132         struct media *media;
 133         u32 priority;
 134         u32 identity;
 135         struct link_req *link_req;
 136         struct list_head links;
 137         struct list_head cong_links;
 138         int active;
 139         char net_plane;
 140         struct tipc_node_map nodes;
 141 };
 142
 143 struct bearer_name {
 144         char media_name[TIPC_MAX_MEDIA_NAME];
 145         char if_name[TIPC_MAX_IF_NAME];
 146 };
 147
 148 struct link;
 149
 150 extern struct tipc_bearer tipc_bearers[];
 151
 152 /*
 153  * TIPC routines available to supported media types
 154  */
 155 int tipc_register_media(u32 media_type,
 156                  char *media_name, int (*enable)(struct tipc_bearer *),
 157                  void (*disable)(struct tipc_bearer *),
 158                  int (*send_msg)(struct sk_buff *,
 159                         struct tipc_bearer *, struct tipc_media_addr *),
 160                  char *(*addr2str)(struct tipc_media_addr *a,
 161                         char *str_buf, int str_size),
 162                  struct tipc_media_addr *bcast_addr, const u32 bearer_priority,
 163                  const u32 link_tolerance,  /* [ms] */
 164                  const u32 send_window_limit);
 165
 166 void tipc_recv_msg(struct sk_buff *buf, struct tipc_bearer *tb_ptr);
 167
 168 int  tipc_block_bearer(const char *name);
 169 void tipc_continue(struct tipc_bearer *tb_ptr);
 170
 171 int tipc_enable_bearer(const char *bearer_name, u32 disc_domain, u32 priority);
 172 int tipc_disable_bearer(const char *name);
 173
 174 /*
 175  * Routines made available to TIPC by supported media types
 176  */
 177 int  tipc_eth_media_start(void);
 178 void tipc_eth_media_stop(void);
 179
 180 void tipc_media_addr_printf(struct print_buf *pb, struct tipc_media_addr *a);
 181 struct sk_buff *tipc_media_get_names(void);
 182
 183 struct sk_buff *tipc_bearer_get_names(void);
 184 void tipc_bearer_add_dest(struct tipc_bearer *b_ptr, u32 dest);
 185 void tipc_bearer_remove_dest(struct tipc_bearer *b_ptr, u32 dest);
 186 void tipc_bearer_schedule(struct tipc_bearer *b_ptr, struct link *l_ptr);
 187 struct tipc_bearer *tipc_bearer_find_interface(const char *if_name);
 188 int tipc_bearer_resolve_congestion(struct tipc_bearer *b_ptr, struct link *l_ptr);
 189 int tipc_bearer_congested(struct tipc_bearer *b_ptr, struct link *l_ptr);
 190 void tipc_bearer_stop(void);
 191 void tipc_bearer_lock_push(struct tipc_bearer *b_ptr);
 192
 193
 194 /**
 195  * tipc_bearer_send- sends buffer to destination over bearer
 196  *
 197  * Returns true (1) if successful, or false (0) if unable to send
 198  *
 199  * IMPORTANT:
 200  * The media send routine must not alter the buffer being passed in
 201  * as it may be needed for later retransmission!
 202  *
 203  * If the media send routine returns a non-zero value (indicating that
 204  * it was unable to send the buffer), it must:
 205  *   1) mark the bearer as blocked,
 206  *   2) call tipc_continue() once the bearer is able to send again.
 207  * Media types that are unable to meet these two critera must ensure their
 208  * send routine always returns success -- even if the buffer was not sent --
 209  * and let TIPC's link code deal with the undelivered message.
 210  */
 211
 212 static inline int tipc_bearer_send(struct tipc_bearer *b_ptr,
 213                                    struct sk_buff *buf,
 214                                    struct tipc_media_addr *dest)
 215 {
 216         return !b_ptr->media->send_msg(buf, b_ptr, dest);
 217 }
 218
 219 /* check if device MTU is too low for tipc headers */
 220 static inline bool tipc_mtu_bad(struct net_device *dev, unsigned int reserve)
 221 {
 222         if (dev->mtu >= TIPC_MIN_BEARER_MTU + reserve)
 223                 return false;
 224         netdev_warn(dev, "MTU too low for tipc bearer\n");
 225         return true;
 226 }
 227
 228 #endif  /* _TIPC_BEARER_H */