blob: e3b2be37fb311b7b6554fcac350a09712ab8b93f [file] [log] [blame]
Per Lidenb97bf3f2006-01-02 19:04:38 +01001/*
2 * net/tipc/bearer.h: Include file for TIPC bearer code
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +09003 *
Per Liden593a5f22006-01-11 19:14:19 +01004 * Copyright (c) 1996-2006, Ericsson AB
Allan Stephens2d627b92011-01-07 13:00:11 -05005 * Copyright (c) 2005, 2010-2011, Wind River Systems
Per Lidenb97bf3f2006-01-02 19:04:38 +01006 * All rights reserved.
7 *
Per Liden9ea1fd32006-01-11 13:30:43 +01008 * Redistribution and use in source and binary forms, with or without
Per Lidenb97bf3f2006-01-02 19:04:38 +01009 * modification, are permitted provided that the following conditions are met:
10 *
Per Liden9ea1fd32006-01-11 13:30:43 +010011 * 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.
Per Lidenb97bf3f2006-01-02 19:04:38 +010019 *
Per Liden9ea1fd32006-01-11 13:30:43 +010020 * 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
Per Lidenb97bf3f2006-01-02 19:04:38 +010034 * POSSIBILITY OF SUCH DAMAGE.
35 */
36
37#ifndef _TIPC_BEARER_H
38#define _TIPC_BEARER_H
39
Per Lidenb97bf3f2006-01-02 19:04:38 +010040#include "bcast.h"
41
Allan Stephens909234c2011-05-27 15:09:40 -040042#define MAX_BEARERS 2
43#define MAX_MEDIA 2
Per Lidenb97bf3f2006-01-02 19:04:38 +010044
Allan Stephensd265fef2010-11-30 12:00:53 +000045/*
Allan Stephens4d163a32011-10-07 13:37:34 -040046 * 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 */
Allan Stephens4d163a32011-10-07 13:37:34 -040052#define TIPC_MEDIA_ADDR_SIZE 20
53#define TIPC_MEDIA_TYPE_OFFSET 3
54
55/*
Allan Stephensd265fef2010-11-30 12:00:53 +000056 * Identifiers of supported TIPC media types
57 */
58#define TIPC_MEDIA_TYPE_ETH 1
59
60/*
Allan Stephens3d749a62011-10-07 15:19:11 -040061 * struct tipc_media_addr - destination address used by TIPC bearers
62 * @value: address info (format defined by media)
63 * @media_id: TIPC media type identifier
64 * @broadcast: non-zero if address is a broadcast address
Allan Stephensd265fef2010-11-30 12:00:53 +000065 */
66struct tipc_media_addr {
Allan Stephens3d749a62011-10-07 15:19:11 -040067 u8 value[TIPC_MEDIA_ADDR_SIZE];
68 u8 media_id;
69 u8 broadcast;
Allan Stephensd265fef2010-11-30 12:00:53 +000070};
71
Allan Stephens2d627b92011-01-07 13:00:11 -050072struct tipc_bearer;
Per Lidenb97bf3f2006-01-02 19:04:38 +010073
74/**
Paul Gortmaker358a0d12011-12-29 20:19:42 -050075 * struct tipc_media - TIPC media information available to internal users
Per Lidenb97bf3f2006-01-02 19:04:38 +010076 * @send_msg: routine which handles buffer transmission
77 * @enable_bearer: routine which enables a bearer
78 * @disable_bearer: routine which disables a bearer
Allan Stephens4d163a32011-10-07 13:37:34 -040079 * @addr2str: routine which converts media address to string
80 * @str2addr: routine which converts media address from string
81 * @addr2msg: routine which converts media address to protocol message area
82 * @msg2addr: routine which converts media address from protocol message area
Per Lidenb97bf3f2006-01-02 19:04:38 +010083 * @bcast_addr: media address used in broadcasting
Per Lidenb97bf3f2006-01-02 19:04:38 +010084 * @priority: default link (and bearer) priority
85 * @tolerance: default time (in ms) before declaring link failure
86 * @window: default window (in packets) before declaring link congestion
Allan Stephensd265fef2010-11-30 12:00:53 +000087 * @type_id: TIPC media identifier
Per Lidenb97bf3f2006-01-02 19:04:38 +010088 * @name: media name
89 */
Paul Gortmaker358a0d12011-12-29 20:19:42 -050090struct tipc_media {
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +090091 int (*send_msg)(struct sk_buff *buf,
Per Lidenb97bf3f2006-01-02 19:04:38 +010092 struct tipc_bearer *b_ptr,
93 struct tipc_media_addr *dest);
94 int (*enable_bearer)(struct tipc_bearer *b_ptr);
95 void (*disable_bearer)(struct tipc_bearer *b_ptr);
Allan Stephensc61b6662011-10-07 11:31:49 -040096 int (*addr2str)(struct tipc_media_addr *a, char *str_buf, int str_size);
Allan Stephens4d163a32011-10-07 13:37:34 -040097 int (*str2addr)(struct tipc_media_addr *a, char *str_buf);
98 int (*addr2msg)(struct tipc_media_addr *a, char *msg_area);
99 int (*msg2addr)(struct tipc_media_addr *a, char *msg_area);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100100 struct tipc_media_addr bcast_addr;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100101 u32 priority;
102 u32 tolerance;
103 u32 window;
104 u32 type_id;
105 char name[TIPC_MAX_MEDIA_NAME];
106};
107
108/**
Allan Stephens2d627b92011-01-07 13:00:11 -0500109 * struct tipc_bearer - TIPC bearer structure
110 * @usr_handle: pointer to additional media-specific information about bearer
111 * @mtu: max packet size bearer can support
112 * @blocked: non-zero if bearer is blocked
113 * @lock: spinlock for controlling access to bearer
114 * @addr: media-specific address associated with bearer
115 * @name: bearer name (format = media:interface)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100116 * @media: ptr to media structure associated with bearer
117 * @priority: default link priority for bearer
Allan Stephens5c216e12011-10-18 11:34:29 -0400118 * @window: default window size for bearer
119 * @tolerance: default link tolerance for bearer
Per Lidenb97bf3f2006-01-02 19:04:38 +0100120 * @identity: array index of this bearer within TIPC bearer array
121 * @link_req: ptr to (optional) structure making periodic link setup requests
122 * @links: list of non-congested links associated with bearer
123 * @cong_links: list of congested links associated with bearer
Per Lidenb97bf3f2006-01-02 19:04:38 +0100124 * @active: non-zero if bearer structure is represents a bearer
125 * @net_plane: network plane ('A' through 'H') currently associated with bearer
126 * @nodes: indicates which nodes in cluster can be reached through bearer
Allan Stephens2d627b92011-01-07 13:00:11 -0500127 *
128 * Note: media-specific code is responsible for initialization of the fields
129 * indicated below when a bearer is enabled; TIPC's generic bearer code takes
130 * care of initializing all other fields.
Per Lidenb97bf3f2006-01-02 19:04:38 +0100131 */
Allan Stephens2d627b92011-01-07 13:00:11 -0500132struct tipc_bearer {
133 void *usr_handle; /* initalized by media */
134 u32 mtu; /* initalized by media */
135 int blocked; /* initalized by media */
136 struct tipc_media_addr addr; /* initalized by media */
137 char name[TIPC_MAX_BEARER_NAME];
138 spinlock_t lock;
Paul Gortmaker358a0d12011-12-29 20:19:42 -0500139 struct tipc_media *media;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100140 u32 priority;
Allan Stephens5c216e12011-10-18 11:34:29 -0400141 u32 window;
142 u32 tolerance;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100143 u32 identity;
Paul Gortmakera18c4bc2011-12-29 20:58:42 -0500144 struct tipc_link_req *link_req;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100145 struct list_head links;
146 struct list_head cong_links;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100147 int active;
148 char net_plane;
David S. Miller6c000552008-09-02 23:38:32 -0700149 struct tipc_node_map nodes;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100150};
151
Paul Gortmakerf19765f2011-12-29 21:39:49 -0500152struct tipc_bearer_names {
Per Lidenb97bf3f2006-01-02 19:04:38 +0100153 char media_name[TIPC_MAX_MEDIA_NAME];
154 char if_name[TIPC_MAX_IF_NAME];
155};
156
Paul Gortmakera18c4bc2011-12-29 20:58:42 -0500157struct tipc_link;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100158
Allan Stephens2d627b92011-01-07 13:00:11 -0500159extern struct tipc_bearer tipc_bearers[];
Per Lidenb97bf3f2006-01-02 19:04:38 +0100160
Allan Stephensd265fef2010-11-30 12:00:53 +0000161/*
162 * TIPC routines available to supported media types
163 */
Paul Gortmaker358a0d12011-12-29 20:19:42 -0500164int tipc_register_media(struct tipc_media *m_ptr);
Allan Stephensd265fef2010-11-30 12:00:53 +0000165
166void tipc_recv_msg(struct sk_buff *buf, struct tipc_bearer *tb_ptr);
167
168int tipc_block_bearer(const char *name);
169void tipc_continue(struct tipc_bearer *tb_ptr);
170
Allan Stephens50d3e632011-02-28 14:56:15 -0500171int tipc_enable_bearer(const char *bearer_name, u32 disc_domain, u32 priority);
Allan Stephensd265fef2010-11-30 12:00:53 +0000172int tipc_disable_bearer(const char *name);
173
174/*
175 * Routines made available to TIPC by supported media types
176 */
177int tipc_eth_media_start(void);
178void tipc_eth_media_stop(void);
179
Allan Stephens5c216e12011-10-18 11:34:29 -0400180int tipc_media_set_priority(const char *name, u32 new_value);
181int tipc_media_set_window(const char *name, u32 new_value);
Per Liden4323add2006-01-18 00:38:21 +0100182void tipc_media_addr_printf(struct print_buf *pb, struct tipc_media_addr *a);
183struct sk_buff *tipc_media_get_names(void);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100184
Per Liden4323add2006-01-18 00:38:21 +0100185struct sk_buff *tipc_bearer_get_names(void);
Allan Stephens2d627b92011-01-07 13:00:11 -0500186void tipc_bearer_add_dest(struct tipc_bearer *b_ptr, u32 dest);
187void tipc_bearer_remove_dest(struct tipc_bearer *b_ptr, u32 dest);
Paul Gortmakera18c4bc2011-12-29 20:58:42 -0500188void tipc_bearer_schedule(struct tipc_bearer *b_ptr, struct tipc_link *l_ptr);
Allan Stephens5c216e12011-10-18 11:34:29 -0400189struct tipc_bearer *tipc_bearer_find(const char *name);
Allan Stephens2d627b92011-01-07 13:00:11 -0500190struct tipc_bearer *tipc_bearer_find_interface(const char *if_name);
Paul Gortmaker358a0d12011-12-29 20:19:42 -0500191struct tipc_media *tipc_media_find(const char *name);
Paul Gortmakera18c4bc2011-12-29 20:58:42 -0500192int tipc_bearer_resolve_congestion(struct tipc_bearer *b_ptr,
193 struct tipc_link *l_ptr);
194int tipc_bearer_congested(struct tipc_bearer *b_ptr, struct tipc_link *l_ptr);
Per Liden4323add2006-01-18 00:38:21 +0100195void tipc_bearer_stop(void);
Allan Stephens2d627b92011-01-07 13:00:11 -0500196void tipc_bearer_lock_push(struct tipc_bearer *b_ptr);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100197
198
199/**
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900200 * tipc_bearer_send- sends buffer to destination over bearer
201 *
Per Lidenb97bf3f2006-01-02 19:04:38 +0100202 * Returns true (1) if successful, or false (0) if unable to send
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900203 *
Per Lidenb97bf3f2006-01-02 19:04:38 +0100204 * IMPORTANT:
205 * The media send routine must not alter the buffer being passed in
206 * as it may be needed for later retransmission!
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900207 *
208 * If the media send routine returns a non-zero value (indicating that
Per Lidenb97bf3f2006-01-02 19:04:38 +0100209 * it was unable to send the buffer), it must:
210 * 1) mark the bearer as blocked,
211 * 2) call tipc_continue() once the bearer is able to send again.
212 * Media types that are unable to meet these two critera must ensure their
213 * send routine always returns success -- even if the buffer was not sent --
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900214 * and let TIPC's link code deal with the undelivered message.
Per Lidenb97bf3f2006-01-02 19:04:38 +0100215 */
Allan Stephens2d627b92011-01-07 13:00:11 -0500216static inline int tipc_bearer_send(struct tipc_bearer *b_ptr,
217 struct sk_buff *buf,
Per Liden4323add2006-01-18 00:38:21 +0100218 struct tipc_media_addr *dest)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100219{
Allan Stephens2d627b92011-01-07 13:00:11 -0500220 return !b_ptr->media->send_msg(buf, b_ptr, dest);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100221}
222
Allan Stephensb274f4a2010-05-11 14:30:16 +0000223#endif /* _TIPC_BEARER_H */