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