bearer.c 12.1 KB
Newer Older
Per Liden's avatar
Per Liden committed
1
2
/*
 * net/tipc/bearer.c: TIPC bearer code
3
 *
4
 * Copyright (c) 1996-2006, Ericsson AB
5
 * Copyright (c) 2004-2006, 2010-2011, Wind River Systems
Per Liden's avatar
Per Liden committed
6
7
 * All rights reserved.
 *
Per Liden's avatar
Per Liden committed
8
 * Redistribution and use in source and binary forms, with or without
Per Liden's avatar
Per Liden committed
9
10
 * modification, are permitted provided that the following conditions are met:
 *
Per Liden's avatar
Per Liden committed
11
12
13
14
15
16
17
18
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. Neither the names of the copyright holders nor the names of its
 *    contributors may be used to endorse or promote products derived from
 *    this software without specific prior written permission.
Per Liden's avatar
Per Liden committed
19
 *
Per Liden's avatar
Per Liden committed
20
21
22
23
24
25
26
27
28
29
30
31
32
33
 * Alternatively, this software may be distributed under the terms of the
 * GNU General Public License ("GPL") version 2 as published by the Free
 * Software Foundation.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
Per Liden's avatar
Per Liden committed
34
35
36
37
38
39
40
41
 * POSSIBILITY OF SUCH DAMAGE.
 */

#include "core.h"
#include "config.h"
#include "bearer.h"
#include "discover.h"

42
#define MAX_ADDR_STR 60
Per Liden's avatar
Per Liden committed
43

44
static struct tipc_media *media_list[MAX_MEDIA];
45
static u32 media_count;
Per Liden's avatar
Per Liden committed
46

47
struct tipc_bearer tipc_bearers[MAX_BEARERS];
Per Liden's avatar
Per Liden committed
48

49
50
static void bearer_disable(struct tipc_bearer *b_ptr);

Per Liden's avatar
Per Liden committed
51
/**
52
 * tipc_media_find - locates specified media object by name
Per Liden's avatar
Per Liden committed
53
 */
54
struct tipc_media *tipc_media_find(const char *name)
Per Liden's avatar
Per Liden committed
55
56
57
{
	u32 i;

58
59
60
	for (i = 0; i < media_count; i++) {
		if (!strcmp(media_list[i]->name, name))
			return media_list[i];
Per Liden's avatar
Per Liden committed
61
	}
62
	return NULL;
Per Liden's avatar
Per Liden committed
63
64
}

65
66
67
/**
 * media_find_id - locates specified media object by type identifier
 */
68
static struct tipc_media *media_find_id(u8 type)
69
70
71
72
{
	u32 i;

	for (i = 0; i < media_count; i++) {
73
74
		if (media_list[i]->type_id == type)
			return media_list[i];
75
76
77
78
	}
	return NULL;
}

Per Liden's avatar
Per Liden committed
79
80
/**
 * tipc_register_media - register a media type
81
 *
Per Liden's avatar
Per Liden committed
82
83
 * Bearers for this media type must be activated separately at a later stage.
 */
84
int tipc_register_media(struct tipc_media *m_ptr)
Per Liden's avatar
Per Liden committed
85
86
87
{
	int res = -EINVAL;

88
	write_lock_bh(&tipc_net_lock);
Per Liden's avatar
Per Liden committed
89

90
	if ((strlen(m_ptr->name) + 1) > TIPC_MAX_MEDIA_NAME)
91
		goto exit;
92
	if (m_ptr->priority > TIPC_MAX_LINK_PRI)
Per Liden's avatar
Per Liden committed
93
		goto exit;
94
	if ((m_ptr->tolerance < TIPC_MIN_LINK_TOL) ||
95
	    (m_ptr->tolerance > TIPC_MAX_LINK_TOL))
Per Liden's avatar
Per Liden committed
96
		goto exit;
97
	if (media_count >= MAX_MEDIA)
Per Liden's avatar
Per Liden committed
98
		goto exit;
99
	if (tipc_media_find(m_ptr->name) || media_find_id(m_ptr->type_id))
100
		goto exit;
Per Liden's avatar
Per Liden committed
101

102
	media_list[media_count] = m_ptr;
103
	media_count++;
Per Liden's avatar
Per Liden committed
104
105
	res = 0;
exit:
106
	write_unlock_bh(&tipc_net_lock);
107
	if (res)
108
		pr_warn("Media <%s> registration error\n", m_ptr->name);
Per Liden's avatar
Per Liden committed
109
110
111
112
	return res;
}

/**
113
 * tipc_media_addr_printf - record media address in print buffer
Per Liden's avatar
Per Liden committed
114
 */
115
void tipc_media_addr_printf(char *buf, int len, struct tipc_media_addr *a)
Per Liden's avatar
Per Liden committed
116
{
117
	char addr_str[MAX_ADDR_STR];
118
	struct tipc_media *m_ptr;
119
	int ret;
Per Liden's avatar
Per Liden committed
120

121
	m_ptr = media_find_id(a->media_id);
Per Liden's avatar
Per Liden committed
122

123
	if (m_ptr && !m_ptr->addr2str(a, addr_str, sizeof(addr_str)))
124
		ret = tipc_snprintf(buf, len, "%s(%s)", m_ptr->name, addr_str);
125
126
	else {
		u32 i;
Per Liden's avatar
Per Liden committed
127

128
		ret = tipc_snprintf(buf, len, "UNKNOWN(%u)", a->media_id);
129
		for (i = 0; i < sizeof(a->value); i++)
130
131
			ret += tipc_snprintf(buf - ret, len + ret,
					    "-%02x", a->value[i]);
Per Liden's avatar
Per Liden committed
132
133
134
135
	}
}

/**
136
 * tipc_media_get_names - record names of registered media in buffer
Per Liden's avatar
Per Liden committed
137
 */
138
struct sk_buff *tipc_media_get_names(void)
Per Liden's avatar
Per Liden committed
139
140
141
142
{
	struct sk_buff *buf;
	int i;

143
	buf = tipc_cfg_reply_alloc(MAX_MEDIA * TLV_SPACE(TIPC_MAX_MEDIA_NAME));
Per Liden's avatar
Per Liden committed
144
145
146
	if (!buf)
		return NULL;

147
	read_lock_bh(&tipc_net_lock);
148
149
150
151
	for (i = 0; i < media_count; i++) {
		tipc_cfg_append_tlv(buf, TIPC_TLV_MEDIA_NAME,
				    media_list[i]->name,
				    strlen(media_list[i]->name) + 1);
Per Liden's avatar
Per Liden committed
152
	}
153
	read_unlock_bh(&tipc_net_lock);
Per Liden's avatar
Per Liden committed
154
155
156
157
158
	return buf;
}

/**
 * bearer_name_validate - validate & (optionally) deconstruct bearer name
159
160
 * @name: ptr to bearer name string
 * @name_parts: ptr to area for bearer name components (or NULL if not needed)
161
 *
Per Liden's avatar
Per Liden committed
162
163
 * Returns 1 if bearer name is valid, otherwise 0.
 */
164
static int bearer_name_validate(const char *name,
165
				struct tipc_bearer_names *name_parts)
Per Liden's avatar
Per Liden committed
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
{
	char name_copy[TIPC_MAX_BEARER_NAME];
	char *media_name;
	char *if_name;
	u32 media_len;
	u32 if_len;

	/* copy bearer name & ensure length is OK */
	name_copy[TIPC_MAX_BEARER_NAME - 1] = 0;
	/* need above in case non-Posix strncpy() doesn't pad with nulls */
	strncpy(name_copy, name, TIPC_MAX_BEARER_NAME);
	if (name_copy[TIPC_MAX_BEARER_NAME - 1] != 0)
		return 0;

	/* ensure all component parts of bearer name are present */
	media_name = name_copy;
182
183
	if_name = strchr(media_name, ':');
	if (if_name == NULL)
Per Liden's avatar
Per Liden committed
184
185
186
187
188
189
		return 0;
	*(if_name++) = 0;
	media_len = if_name - media_name;
	if_len = strlen(if_name) + 1;

	/* validate component parts of bearer name */
190
	if ((media_len <= 1) || (media_len > TIPC_MAX_MEDIA_NAME) ||
191
	    (if_len <= 1) || (if_len > TIPC_MAX_IF_NAME))
Per Liden's avatar
Per Liden committed
192
193
194
195
196
197
198
199
200
201
202
		return 0;

	/* return bearer name components, if necessary */
	if (name_parts) {
		strcpy(name_parts->media_name, media_name);
		strcpy(name_parts->if_name, if_name);
	}
	return 1;
}

/**
203
 * tipc_bearer_find - locates bearer object with matching bearer name
Per Liden's avatar
Per Liden committed
204
 */
205
struct tipc_bearer *tipc_bearer_find(const char *name)
Per Liden's avatar
Per Liden committed
206
{
207
	struct tipc_bearer *b_ptr;
Per Liden's avatar
Per Liden committed
208
209
	u32 i;

210
	for (i = 0, b_ptr = tipc_bearers; i < MAX_BEARERS; i++, b_ptr++) {
211
		if (b_ptr->active && (!strcmp(b_ptr->name, name)))
Per Liden's avatar
Per Liden committed
212
213
			return b_ptr;
	}
214
	return NULL;
Per Liden's avatar
Per Liden committed
215
216
217
}

/**
218
 * tipc_bearer_find_interface - locates bearer object with matching interface name
Per Liden's avatar
Per Liden committed
219
 */
220
struct tipc_bearer *tipc_bearer_find_interface(const char *if_name)
Per Liden's avatar
Per Liden committed
221
{
222
	struct tipc_bearer *b_ptr;
Per Liden's avatar
Per Liden committed
223
224
225
	char *b_if_name;
	u32 i;

226
	for (i = 0, b_ptr = tipc_bearers; i < MAX_BEARERS; i++, b_ptr++) {
Per Liden's avatar
Per Liden committed
227
228
		if (!b_ptr->active)
			continue;
229
		b_if_name = strchr(b_ptr->name, ':') + 1;
Per Liden's avatar
Per Liden committed
230
231
232
		if (!strcmp(b_if_name, if_name))
			return b_ptr;
	}
233
	return NULL;
Per Liden's avatar
Per Liden committed
234
235
236
}

/**
237
 * tipc_bearer_get_names - record names of bearers in buffer
Per Liden's avatar
Per Liden committed
238
 */
239
struct sk_buff *tipc_bearer_get_names(void)
Per Liden's avatar
Per Liden committed
240
241
{
	struct sk_buff *buf;
242
	struct tipc_bearer *b_ptr;
Per Liden's avatar
Per Liden committed
243
244
	int i, j;

245
	buf = tipc_cfg_reply_alloc(MAX_BEARERS * TLV_SPACE(TIPC_MAX_BEARER_NAME));
Per Liden's avatar
Per Liden committed
246
247
248
	if (!buf)
		return NULL;

249
	read_lock_bh(&tipc_net_lock);
250
	for (i = 0; i < media_count; i++) {
Per Liden's avatar
Per Liden committed
251
		for (j = 0; j < MAX_BEARERS; j++) {
252
			b_ptr = &tipc_bearers[j];
253
			if (b_ptr->active && (b_ptr->media == media_list[i])) {
254
				tipc_cfg_append_tlv(buf, TIPC_TLV_BEARER_NAME,
255
256
						    b_ptr->name,
						    strlen(b_ptr->name) + 1);
Per Liden's avatar
Per Liden committed
257
258
259
			}
		}
	}
260
	read_unlock_bh(&tipc_net_lock);
Per Liden's avatar
Per Liden committed
261
262
263
	return buf;
}

264
void tipc_bearer_add_dest(struct tipc_bearer *b_ptr, u32 dest)
Per Liden's avatar
Per Liden committed
265
{
266
267
	tipc_nmap_add(&b_ptr->nodes, dest);
	tipc_bcbearer_sort();
268
	tipc_disc_add_dest(b_ptr->link_req);
Per Liden's avatar
Per Liden committed
269
270
}

271
void tipc_bearer_remove_dest(struct tipc_bearer *b_ptr, u32 dest)
Per Liden's avatar
Per Liden committed
272
{
273
274
	tipc_nmap_remove(&b_ptr->nodes, dest);
	tipc_bcbearer_sort();
275
	tipc_disc_remove_dest(b_ptr->link_req);
Per Liden's avatar
Per Liden committed
276
277
278
279
}

/**
 * tipc_enable_bearer - enable bearer with the given name
280
 */
281
int tipc_enable_bearer(const char *name, u32 disc_domain, u32 priority)
Per Liden's avatar
Per Liden committed
282
{
283
	struct tipc_bearer *b_ptr;
284
	struct tipc_media *m_ptr;
285
	struct tipc_bearer_names b_names;
Per Liden's avatar
Per Liden committed
286
287
288
289
290
291
	char addr_string[16];
	u32 bearer_id;
	u32 with_this_prio;
	u32 i;
	int res = -EINVAL;

292
	if (!tipc_own_addr) {
293
294
		pr_warn("Bearer <%s> rejected, not supported in standalone mode\n",
			name);
Per Liden's avatar
Per Liden committed
295
		return -ENOPROTOOPT;
296
	}
297
	if (!bearer_name_validate(name, &b_names)) {
298
		pr_warn("Bearer <%s> rejected, illegal name\n", name);
299
		return -EINVAL;
300
	}
301
302
303
304
305
	if (tipc_addr_domain_valid(disc_domain) &&
	    (disc_domain != tipc_own_addr)) {
		if (tipc_in_scope(disc_domain, tipc_own_addr)) {
			disc_domain = tipc_own_addr & TIPC_CLUSTER_MASK;
			res = 0;   /* accept any node in own cluster */
306
		} else if (in_own_cluster_exact(disc_domain))
307
308
309
			res = 0;   /* accept specified node in own cluster */
	}
	if (res) {
310
311
		pr_warn("Bearer <%s> rejected, illegal discovery domain\n",
			name);
312
313
		return -EINVAL;
	}
314
	if ((priority > TIPC_MAX_LINK_PRI) &&
315
	    (priority != TIPC_MEDIA_LINK_PRI)) {
316
		pr_warn("Bearer <%s> rejected, illegal priority\n", name);
Per Liden's avatar
Per Liden committed
317
		return -EINVAL;
318
	}
Per Liden's avatar
Per Liden committed
319

320
	write_lock_bh(&tipc_net_lock);
Per Liden's avatar
Per Liden committed
321

322
	m_ptr = tipc_media_find(b_names.media_name);
Per Liden's avatar
Per Liden committed
323
	if (!m_ptr) {
324
325
		pr_warn("Bearer <%s> rejected, media <%s> not registered\n",
			name, b_names.media_name);
326
		goto exit;
Per Liden's avatar
Per Liden committed
327
	}
328
329

	if (priority == TIPC_MEDIA_LINK_PRI)
Per Liden's avatar
Per Liden committed
330
331
332
333
334
335
		priority = m_ptr->priority;

restart:
	bearer_id = MAX_BEARERS;
	with_this_prio = 1;
	for (i = MAX_BEARERS; i-- != 0; ) {
336
		if (!tipc_bearers[i].active) {
Per Liden's avatar
Per Liden committed
337
338
339
			bearer_id = i;
			continue;
		}
340
		if (!strcmp(name, tipc_bearers[i].name)) {
341
342
			pr_warn("Bearer <%s> rejected, already enabled\n",
				name);
343
			goto exit;
Per Liden's avatar
Per Liden committed
344
		}
345
		if ((tipc_bearers[i].priority == priority) &&
Per Liden's avatar
Per Liden committed
346
347
		    (++with_this_prio > 2)) {
			if (priority-- == 0) {
348
349
				pr_warn("Bearer <%s> rejected, duplicate priority\n",
					name);
350
				goto exit;
Per Liden's avatar
Per Liden committed
351
			}
352
353
			pr_warn("Bearer <%s> priority adjustment required %u->%u\n",
				name, priority + 1, priority);
Per Liden's avatar
Per Liden committed
354
355
356
357
			goto restart;
		}
	}
	if (bearer_id >= MAX_BEARERS) {
358
359
		pr_warn("Bearer <%s> rejected, bearer limit reached (%u)\n",
			name, MAX_BEARERS);
360
		goto exit;
Per Liden's avatar
Per Liden committed
361
362
	}

363
	b_ptr = &tipc_bearers[bearer_id];
364
	strcpy(b_ptr->name, name);
365
	res = m_ptr->enable_media(b_ptr);
Per Liden's avatar
Per Liden committed
366
	if (res) {
367
368
		pr_warn("Bearer <%s> rejected, enable failure (%d)\n",
			name, -res);
369
		goto exit;
Per Liden's avatar
Per Liden committed
370
371
372
373
	}

	b_ptr->identity = bearer_id;
	b_ptr->media = m_ptr;
374
375
	b_ptr->tolerance = m_ptr->tolerance;
	b_ptr->window = m_ptr->window;
Per Liden's avatar
Per Liden committed
376
377
378
379
	b_ptr->net_plane = bearer_id + 'A';
	b_ptr->active = 1;
	b_ptr->priority = priority;
	INIT_LIST_HEAD(&b_ptr->links);
380
	spin_lock_init(&b_ptr->lock);
381

382
	res = tipc_disc_create(b_ptr, &b_ptr->bcast_addr, disc_domain);
383
384
	if (res) {
		bearer_disable(b_ptr);
385
386
		pr_warn("Bearer <%s> rejected, discovery object creation failed\n",
			name);
387
388
		goto exit;
	}
389
390
391
	pr_info("Enabled bearer <%s>, discovery domain %s, priority %u\n",
		name,
		tipc_addr_string_fill(addr_string, disc_domain), priority);
392
exit:
393
	write_unlock_bh(&tipc_net_lock);
Per Liden's avatar
Per Liden committed
394
395
396
397
	return res;
}

/**
398
 * tipc_reset_bearer - Reset all links established over this bearer
Per Liden's avatar
Per Liden committed
399
 */
400
int tipc_reset_bearer(struct tipc_bearer *b_ptr)
Per Liden's avatar
Per Liden committed
401
{
402
403
	struct tipc_link *l_ptr;
	struct tipc_link *temp_l_ptr;
Per Liden's avatar
Per Liden committed
404

405
	read_lock_bh(&tipc_net_lock);
406
	pr_info("Resetting bearer <%s>\n", b_ptr->name);
407
	spin_lock_bh(&b_ptr->lock);
Per Liden's avatar
Per Liden committed
408
	list_for_each_entry_safe(l_ptr, temp_l_ptr, &b_ptr->links, link_list) {
409
		struct tipc_node *n_ptr = l_ptr->owner;
Per Liden's avatar
Per Liden committed
410
411

		spin_lock_bh(&n_ptr->lock);
412
		tipc_link_reset(l_ptr);
Per Liden's avatar
Per Liden committed
413
414
		spin_unlock_bh(&n_ptr->lock);
	}
415
	spin_unlock_bh(&b_ptr->lock);
416
	read_unlock_bh(&tipc_net_lock);
417
	return 0;
Per Liden's avatar
Per Liden committed
418
419
420
}

/**
421
 * bearer_disable
422
 *
423
 * Note: This routine assumes caller holds tipc_net_lock.
Per Liden's avatar
Per Liden committed
424
 */
425
static void bearer_disable(struct tipc_bearer *b_ptr)
Per Liden's avatar
Per Liden committed
426
{
427
428
	struct tipc_link *l_ptr;
	struct tipc_link *temp_l_ptr;
429
	struct tipc_link_req *temp_req;
Per Liden's avatar
Per Liden committed
430

431
	pr_info("Disabling bearer <%s>\n", b_ptr->name);
432
	spin_lock_bh(&b_ptr->lock);
433
	b_ptr->media->disable_media(b_ptr);
Per Liden's avatar
Per Liden committed
434
	list_for_each_entry_safe(l_ptr, temp_l_ptr, &b_ptr->links, link_list) {
435
		tipc_link_delete(l_ptr);
Per Liden's avatar
Per Liden committed
436
	}
437
438
	temp_req = b_ptr->link_req;
	b_ptr->link_req = NULL;
439
	spin_unlock_bh(&b_ptr->lock);
440
441
442
443

	if (temp_req)
		tipc_disc_delete(temp_req);

444
	memset(b_ptr, 0, sizeof(struct tipc_bearer));
Per Liden's avatar
Per Liden committed
445
446
447
448
}

int tipc_disable_bearer(const char *name)
{
449
	struct tipc_bearer *b_ptr;
Per Liden's avatar
Per Liden committed
450
451
	int res;

452
	write_lock_bh(&tipc_net_lock);
453
	b_ptr = tipc_bearer_find(name);
454
	if (b_ptr == NULL) {
455
		pr_warn("Attempt to disable unknown bearer <%s>\n", name);
456
		res = -EINVAL;
457
458
459
460
	} else {
		bearer_disable(b_ptr);
		res = 0;
	}
461
	write_unlock_bh(&tipc_net_lock);
Per Liden's avatar
Per Liden committed
462
463
464
465
466
	return res;
}



467
void tipc_bearer_stop(void)
Per Liden's avatar
Per Liden committed
468
469
470
471
{
	u32 i;

	for (i = 0; i < MAX_BEARERS; i++) {
472
		if (tipc_bearers[i].active)
473
			bearer_disable(&tipc_bearers[i]);
Per Liden's avatar
Per Liden committed
474
475
476
	}
	media_count = 0;
}