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