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 /*
  46  * Identifiers associated with TIPC message header media address info
  47  *
  48  * - address info field is 20 bytes long
  49  * - media type identifier located at offset 3
  50  * - remaining bytes vary according to media type
  51  */
  52 #define TIPC_MEDIA_ADDR_SIZE    20
  53 #define TIPC_MEDIA_TYPE_OFFSET  3
  54
  55 /*
  56  * Identifiers of supported TIPC media types
  57  */
  58 #define TIPC_MEDIA_TYPE_ETH     1
  59 #define TIPC_MEDIA_TYPE_IB      2
  60
  61 /**
  62  * struct tipc_media_addr - destination address used by TIPC bearers
  63  * @value: address info (format defined by media)
  64  * @media_id: TIPC media type identifier
  65  * @broadcast: non-zero if address is a broadcast address
  66  */
  67 struct tipc_media_addr {
  68         u8 value[TIPC_MEDIA_ADDR_SIZE];
  69         u8 media_id;
  70         u8 broadcast;
  71 };
  72
  73 struct tipc_bearer;
  74
  75 /**
  76  * struct tipc_media - Media specific info exposed to generic bearer layer
  77  * @send_msg: routine which handles buffer transmission
  78  * @enable_media: routine which enables a media
  79  * @disable_media: routine which disables a media
  80  * @addr2str: routine which converts media address to string
  81  * @addr2msg: routine which converts media address to protocol message area
  82  * @msg2addr: routine which converts media address from protocol message area
  83  * @priority: default link (and bearer) priority
  84  * @tolerance: default time (in ms) before declaring link failure
  85  * @window: default window (in packets) before declaring link congestion
  86  * @type_id: TIPC media identifier
  87  * @name: media name
  88  */
  89 struct tipc_media {
  90         int (*send_msg)(struct sk_buff *buf,
  91                         struct tipc_bearer *b_ptr,
  92                         struct tipc_media_addr *dest);
  93         int (*enable_media)(struct tipc_bearer *b_ptr);
  94         void (*disable_media)(struct tipc_bearer *b_ptr);
  95         int (*addr2str)(struct tipc_media_addr *a, char *str_buf, int str_size);
  96         int (*addr2msg)(struct tipc_media_addr *a, char *msg_area);
  97         int (*msg2addr)(const struct tipc_bearer *b_ptr,
  98                         struct tipc_media_addr *a, char *msg_area);
  99         u32 priority;
 100         u32 tolerance;
 101         u32 window;
 102         u32 type_id;
 103         char name[TIPC_MAX_MEDIA_NAME];
 104 };
 105
 106 /**
 107  * struct tipc_bearer - Generic TIPC bearer structure
 108  * @usr_handle: pointer to additional media-specific information about bearer
 109  * @mtu: max packet size bearer can support
 110  * @lock: spinlock for controlling access to bearer
 111  * @addr: media-specific address associated with bearer
 112  * @name: bearer name (format = media:interface)
 113  * @media: ptr to media structure associated with bearer
 114  * @bcast_addr: media address used in broadcasting
 115  * @priority: default link priority for bearer
 116  * @window: default window size for bearer
 117  * @tolerance: default link tolerance for bearer
 118  * @identity: array index of this bearer within TIPC bearer array
 119  * @link_req: ptr to (optional) structure making periodic link setup requests
 120  * @links: list of non-congested links associated with bearer
 121  * @active: non-zero if bearer structure is represents a bearer
 122  * @net_plane: network plane ('A' through 'H') currently associated with bearer
 123  * @nodes: indicates which nodes in cluster can be reached through bearer
 124  *
 125  * Note: media-specific code is responsible for initialization of the fields
 126  * indicated below when a bearer is enabled; TIPC's generic bearer code takes
 127  * care of initializing all other fields.
 128  */
 129 struct tipc_bearer {
 130         void *usr_handle;                       /* initalized by media */
 131         u32 mtu;                                /* initalized by media */
 132         struct tipc_media_addr addr;            /* initalized by media */
 133         char name[TIPC_MAX_BEARER_NAME];
 134         spinlock_t lock;
 135         struct tipc_media *media;
 136         struct tipc_media_addr bcast_addr;
 137         u32 priority;
 138         u32 window;
 139         u32 tolerance;
 140         u32 identity;
 141         struct tipc_link_req *link_req;
 142         struct list_head links;
 143         int active;
 144         char net_plane;
 145         struct tipc_node_map nodes;
 146 };
 147
 148 struct tipc_bearer_names {
 149         char media_name[TIPC_MAX_MEDIA_NAME];
 150         char if_name[TIPC_MAX_IF_NAME];
 151 };
 152
 153 struct tipc_link;
 154
 155 extern struct tipc_bearer tipc_bearers[];
 156
 157 /*
 158  * TIPC routines available to supported media types
 159  */
 160
 161 void tipc_recv_msg(struct sk_buff *buf, struct tipc_bearer *tb_ptr);
 162
 163 int  tipc_reset_bearer(struct tipc_bearer *b_ptr);
 164
 165 int tipc_enable_bearer(const char *bearer_name, u32 disc_domain, u32 priority);
 166 int tipc_disable_bearer(const char *name);
 167
 168 /*
 169  * Routines made available to TIPC by supported media types
 170  */
 171 int  tipc_eth_media_start(void);
 172 void tipc_eth_media_stop(void);
 173 extern struct tipc_media eth_media_info;
 174
 175 #ifdef CONFIG_TIPC_MEDIA_IB
 176 int  tipc_ib_media_start(void);
 177 void tipc_ib_media_stop(void);
 178 extern struct tipc_media ib_media_info;
 179 #else
 180 static inline int tipc_ib_media_start(void) { return 0; }
 181 static inline void tipc_ib_media_stop(void) { return; }
 182 #endif
 183
 184 int tipc_media_set_priority(const char *name, u32 new_value);
 185 int tipc_media_set_window(const char *name, u32 new_value);
 186 void tipc_media_addr_printf(char *buf, int len, struct tipc_media_addr *a);
 187 struct sk_buff *tipc_media_get_names(void);
 188
 189 struct sk_buff *tipc_bearer_get_names(void);
 190 void tipc_bearer_add_dest(struct tipc_bearer *b_ptr, u32 dest);
 191 void tipc_bearer_remove_dest(struct tipc_bearer *b_ptr, u32 dest);
 192 struct tipc_bearer *tipc_bearer_find(const char *name);
 193 struct tipc_bearer *tipc_bearer_find_interface(const char *if_name);
 194 struct tipc_media *tipc_media_find(const char *name);
 195 void tipc_bearer_stop(void);
 196
 197 /**
 198  * tipc_bearer_send- sends buffer to destination over bearer
 199  *
 200  * IMPORTANT:
 201  * The media send routine must not alter the buffer being passed in
 202  * as it may be needed for later retransmission!
 203  */
 204 static inline void tipc_bearer_send(struct tipc_bearer *b, struct sk_buff *buf,
 205                                    struct tipc_media_addr *dest)
 206 {
 207         b->media->send_msg(buf, b, dest);
 208 }
 209
 210 #endif  /* _TIPC_BEARER_H */