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