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