aboutsummaryrefslogtreecommitdiffstats
path: root/src/osmo-bsc/neighbor_ident_vty.c
blob: 2b8cd7e2b10aaa8ac24c70aa832242998e640147 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
/* Quagga VTY implementation to manage identity of neighboring BSS cells for inter-BSC handover. */
/* (C) 2018 by sysmocom - s.f.m.c. GmbH <info@sysmocom.de>
 *
 * All Rights Reserved
 *
 * Author: Neels Hofmeyr <nhofmeyr@sysmocom.de>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation; either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

#include <stdlib.h>
#include <string.h>
#include <errno.h>

#include <osmocom/vty/command.h>
#include <osmocom/gsm/gsm0808.h>

#include <osmocom/bsc/vty.h>
#include <osmocom/bsc/neighbor_ident.h>
#include <osmocom/bsc/gsm_data.h>

static struct gsm_network *g_net = NULL;
static struct neighbor_ident_list *g_neighbor_cells = NULL;

/* Parse VTY parameters matching NEIGHBOR_IDENT_VTY_KEY_PARAMS. Pass a pointer so that argv[0] is the
 * ARFCN value followed by the BSIC keyword and value. vty *must* reference a BTS_NODE. */
bool neighbor_ident_vty_parse_key_params(struct vty *vty, const char **argv,
					 struct neighbor_ident_key *key)
{
	struct gsm_bts *bts = vty->index;

	OSMO_ASSERT(vty->node == BTS_NODE);
	OSMO_ASSERT(bts);

	return neighbor_ident_bts_parse_key_params(vty, bts, argv, key);
}

/* same as neighbor_ident_vty_parse_key_params() but pass an explicit bts, so it works on any node. */
bool neighbor_ident_bts_parse_key_params(struct vty *vty, struct gsm_bts *bts, const char **argv,
					 struct neighbor_ident_key *key)
{
	const char *arfcn_str = argv[0];
	const char *bsic_str = argv[1];

	OSMO_ASSERT(bts);

	*key = (struct neighbor_ident_key){
		.from_bts = bts->nr,
		.arfcn = atoi(arfcn_str),
	};

	if (!strcmp(bsic_str, "any"))
		key->bsic = BSIC_ANY;
	else
		key->bsic = atoi(bsic_str);
	return true;
}

#define NEIGHBOR_ADD_CMD "neighbor "
#define NEIGHBOR_DEL_CMD "no neighbor "
#define NEIGHBOR_DOC "Manage local and remote-BSS neighbor cells\n"
#define NEIGHBOR_ADD_DOC NEIGHBOR_DOC "Add "
#define NEIGHBOR_DEL_DOC NO_STR "Remove local or remote-BSS neighbor cell\n"

#define LAC_PARAMS "lac <0-65535>"
#define LAC_DOC "Neighbor cell by LAC\n" "LAC\n"

#define LAC_CI_PARAMS "lac-ci <0-65535> <0-65535>"
#define LAC_CI_DOC "Neighbor cell by LAC and CI\n" "LAC\n" "CI\n"

#define CGI_PARAMS "cgi <0-999> <0-999> <0-65535> <0-65535>"
#define CGI_DOC "Neighbor cell by cgi\n" "MCC\n" "MNC\n" "LAC\n" "CI\n"

#define LOCAL_BTS_PARAMS "bts <0-255>"
#define LOCAL_BTS_DOC "Neighbor cell by local BTS number\n" "BTS number\n"

static struct gsm_bts *neighbor_ident_vty_parse_bts_nr(struct vty *vty, const char **argv)
{
	const char *bts_nr_str = argv[0];
	struct gsm_bts *bts = gsm_bts_num(g_net, atoi(bts_nr_str));
	if (!bts)
		vty_out(vty, "%% No such BTS: nr = %s%s\n", bts_nr_str, VTY_NEWLINE);
	return bts;
}

static struct gsm_bts *bts_by_cell_id(struct vty *vty, struct gsm0808_cell_id *cell_id)
{
	struct gsm_bts *bts = gsm_bts_by_cell_id(g_net, cell_id, 0);
	if (!bts)
		vty_out(vty, "%% No such BTS: %s%s\n", gsm0808_cell_id_name(cell_id), VTY_NEWLINE);
	return bts;
}

static struct gsm0808_cell_id *neighbor_ident_vty_parse_lac(struct vty *vty, const char **argv)
{
	static struct gsm0808_cell_id cell_id;
	cell_id = (struct gsm0808_cell_id){
		.id_discr = CELL_IDENT_LAC,
		.id.lac = atoi(argv[0]),
	};
	return &cell_id;
}

static struct gsm0808_cell_id *neighbor_ident_vty_parse_lac_ci(struct vty *vty, const char **argv)
{
	static struct gsm0808_cell_id cell_id;
	cell_id = (struct gsm0808_cell_id){
		.id_discr = CELL_IDENT_LAC_AND_CI,
		.id.lac_and_ci = {
			.lac = atoi(argv[0]),
			.ci = atoi(argv[1]),
		},
	};
	return &cell_id;
}

static struct gsm0808_cell_id *neighbor_ident_vty_parse_cgi(struct vty *vty, const char **argv)
{
	static struct gsm0808_cell_id cell_id;
	cell_id = (struct gsm0808_cell_id){
		.id_discr = CELL_IDENT_WHOLE_GLOBAL,
	};
	struct osmo_cell_global_id *cgi = &cell_id.id.global;
	const char *mcc = argv[0];
	const char *mnc = argv[1];
	const char *lac = argv[2];
	const char *ci = argv[3];

	if (osmo_mcc_from_str(mcc, &cgi->lai.plmn.mcc)) {
		vty_out(vty, "%% Error decoding MCC: %s%s", mcc, VTY_NEWLINE);
		return NULL;
	}

	if (osmo_mnc_from_str(mnc, &cgi->lai.plmn.mnc, &cgi->lai.plmn.mnc_3_digits)) {
		vty_out(vty, "%% Error decoding MNC: %s%s", mnc, VTY_NEWLINE);
		return NULL;
	}

	cgi->lai.lac = atoi(lac);
	cgi->cell_identity = atoi(ci);
	return &cell_id;
}

static int add_local_bts(struct vty *vty, struct gsm_bts *neigh)
{
	int rc;
	struct gsm_bts *bts = vty->index;
	if (vty->node != BTS_NODE) {
		vty_out(vty, "%% Error: cannot add local BTS neighbor, not on BTS node%s",
			VTY_NEWLINE);
		return CMD_WARNING;
	}
	if (!bts) {
		vty_out(vty, "%% Error: cannot add local BTS neighbor, no BTS on this node%s",
			VTY_NEWLINE);
		return CMD_WARNING;
	}
	if (!neigh) {
		vty_out(vty, "%% Error: cannot add local BTS neighbor to BTS %u, no such neighbor BTS%s"
			"%% (To add remote-BSS neighbors, pass full ARFCN and BSIC as well)%s",
			bts->nr, VTY_NEWLINE, VTY_NEWLINE);
		return CMD_WARNING;
	}
	rc = gsm_bts_local_neighbor_add(bts, neigh);
	if (rc < 0) {
		vty_out(vty, "%% Error: cannot add local BTS %u as neighbor to BTS %u: %s%s",
			neigh->nr, bts->nr, strerror(-rc), VTY_NEWLINE);
		return CMD_WARNING;
	} else
		vty_out(vty, "%% BTS %u %s local neighbor BTS %u with LAC %u CI %u and ARFCN %u BSIC %u%s",
			bts->nr, rc? "now has" : "already had",
			neigh->nr, neigh->location_area_code, neigh->cell_identity,
			neigh->c0->arfcn, neigh->bsic, VTY_NEWLINE);
	return CMD_SUCCESS;
}

static int del_local_bts(struct vty *vty, struct gsm_bts *neigh)
{
	int rc;
	struct gsm_bts *bts = vty->index;
	if (vty->node != BTS_NODE) {
		vty_out(vty, "%% Error: cannot remove local BTS neighbor, not on BTS node%s",
			VTY_NEWLINE);
		return CMD_WARNING;
	}
	if (!bts) {
		vty_out(vty, "%% Error: cannot remove local BTS neighbor, no BTS on this node%s",
			VTY_NEWLINE);
		return CMD_WARNING;
	}
	if (!neigh) {
		vty_out(vty, "%% Error: cannot remove local BTS neighbor from BTS %u, no such neighbor BTS%s",
			bts->nr, VTY_NEWLINE);
		return CMD_WARNING;
	}
	rc = gsm_bts_local_neighbor_del(bts, neigh);
	if (rc < 0) {
		vty_out(vty, "%% Error: cannot remove local BTS %u neighbor from BTS %u: %s%s",
			neigh->nr, bts->nr, strerror(-rc), VTY_NEWLINE);
		return CMD_WARNING;
	}
	if (rc == 0)
		vty_out(vty, "%% BTS %u is no neighbor of BTS %u%s",
			neigh->nr, bts->nr, VTY_NEWLINE);
	return CMD_SUCCESS;
}

DEFUN(cfg_neighbor_add_bts_nr, cfg_neighbor_add_bts_nr_cmd,
	NEIGHBOR_ADD_CMD LOCAL_BTS_PARAMS,
	NEIGHBOR_ADD_DOC LOCAL_BTS_DOC)
{
	return add_local_bts(vty, neighbor_ident_vty_parse_bts_nr(vty, argv));
}

DEFUN(cfg_neighbor_add_lac, cfg_neighbor_add_lac_cmd,
	NEIGHBOR_ADD_CMD LAC_PARAMS,
	NEIGHBOR_ADD_DOC LAC_DOC)
{
	return add_local_bts(vty, bts_by_cell_id(vty, neighbor_ident_vty_parse_lac(vty, argv)));
}

DEFUN(cfg_neighbor_add_lac_ci, cfg_neighbor_add_lac_ci_cmd,
	NEIGHBOR_ADD_CMD LAC_CI_PARAMS,
	NEIGHBOR_ADD_DOC LAC_CI_DOC)
{
	return add_local_bts(vty, bts_by_cell_id(vty, neighbor_ident_vty_parse_lac_ci(vty, argv)));
}

DEFUN(cfg_neighbor_add_cgi, cfg_neighbor_add_cgi_cmd,
	NEIGHBOR_ADD_CMD CGI_PARAMS,
	NEIGHBOR_ADD_DOC CGI_DOC)
{
	return add_local_bts(vty, bts_by_cell_id(vty, neighbor_ident_vty_parse_cgi(vty, argv)));
}

bool neighbor_ident_key_matches_bts(const struct neighbor_ident_key *key, struct gsm_bts *bts)
{
	if (!bts || !key)
		return false;
	return key->arfcn == bts->c0->arfcn
		&& (key->bsic == BSIC_ANY || key->bsic == bts->bsic);
}

static int add_remote_or_local_bts(struct vty *vty, const struct gsm0808_cell_id *cell_id,
				   const struct neighbor_ident_key *key)
{
	int rc;
	struct gsm_bts *local_neigh;
	const struct gsm0808_cell_id_list2 *exists;
	struct gsm0808_cell_id_list2 cil;
	struct gsm_bts *bts = vty->index;

	if (vty->node != BTS_NODE) {
		vty_out(vty, "%% Error: cannot add BTS neighbor, not on BTS node%s",
			VTY_NEWLINE);
		return CMD_WARNING;
	}
	if (!bts) {
		vty_out(vty, "%% Error: cannot add BTS neighbor, no BTS on this node%s",
			VTY_NEWLINE);
		return CMD_WARNING;
	}

	/* Is there a local BTS that matches the cell_id? */
	local_neigh = gsm_bts_by_cell_id(g_net, cell_id, 0);
	if (local_neigh) {
		/* But do the advertised ARFCN and BSIC match as intended?
		 * The user may omit ARFCN and BSIC for local cells, but if they are provided,
		 * they need to match. */
		if (!neighbor_ident_key_matches_bts(key, local_neigh)) {
			vty_out(vty, "%% Error: bts %u: neighbor cell id %s indicates local BTS %u,"
				" but it does not match ARFCN+BSIC %s%s",
				bts->nr, gsm0808_cell_id_name(cell_id), local_neigh->nr,
				neighbor_ident_key_name(key), VTY_NEWLINE);
			/* TODO: error out fatally for non-interactive VTY? */
			return CMD_WARNING;
		}
		return add_local_bts(vty, local_neigh);
	}

	/* Allow only one cell ID per remote-BSS neighbor, see OS#3656 */
	exists = neighbor_ident_get(g_neighbor_cells, key);
	if (exists) {
		vty_out(vty, "%% Error: only one Cell Identifier entry is allowed per remote neighbor."
			" Already have: %s -> %s%s", neighbor_ident_key_name(key),
			gsm0808_cell_id_list_name(exists), VTY_NEWLINE);
		return CMD_WARNING;
	}

	/* The cell_id is not known in this BSS, so it must be a remote cell. */
	gsm0808_cell_id_to_list(&cil, cell_id);
	rc = neighbor_ident_add(g_neighbor_cells, key, &cil);

	if (rc < 0) {
		const char *reason;
		switch (rc) {
		case -EINVAL:
			reason = ": mismatching type between current and newly added cell identifier";
			break;
		case -ENOSPC:
			reason = ": list is full";
			break;
		default:
			reason = "";
			break;
		}

		vty_out(vty, "%% Error adding neighbor-BSS Cell Identifier %s%s%s",
			gsm0808_cell_id_name(cell_id), reason, VTY_NEWLINE);
		return CMD_WARNING;
	}

	vty_out(vty, "%% %s now has %d remote BSS Cell Identifier List %s%s",
		neighbor_ident_key_name(key), rc, rc == 1? "entry" : "entries", VTY_NEWLINE);
	return CMD_SUCCESS;
}

static int del_by_key(struct vty *vty, const struct neighbor_ident_key *key)
{
	int removed = 0;
	int rc;
	struct gsm_bts *bts = vty->index;
	struct gsm_bts_ref *neigh, *safe;

	if (vty->node != BTS_NODE) {
		vty_out(vty, "%% Error: cannot remove BTS neighbor, not on BTS node%s",
			VTY_NEWLINE);
		return CMD_WARNING;
	}
	if (!bts) {
		vty_out(vty, "%% Error: cannot remove BTS neighbor, no BTS on this node%s",
			VTY_NEWLINE);
		return CMD_WARNING;
	}

	/* Is there a local BTS that matches the key? */
	llist_for_each_entry_safe(neigh, safe, &bts->local_neighbors, entry) {
		struct gsm_bts *neigh_bts = neigh->bts;
		if (!neighbor_ident_key_matches_bts(key, neigh->bts))
			continue;
		rc = gsm_bts_local_neighbor_del(bts, neigh->bts);
		if (rc > 0) {
			vty_out(vty, "%% Removed local neighbor bts %u to bts %u%s",
				bts->nr, neigh_bts->nr, VTY_NEWLINE);
			removed += rc;
		}
	}

	if (neighbor_ident_del(g_neighbor_cells, key)) {
		vty_out(vty, "%% Removed remote BSS neighbor %s%s",
			neighbor_ident_key_name(key), VTY_NEWLINE);
		removed ++;
	}

	if (!removed) {
		vty_out(vty, "%% Cannot remove, no such neighbor: %s%s",
			neighbor_ident_key_name(key), VTY_NEWLINE);
		return CMD_WARNING;
	}
	return CMD_SUCCESS;
}

struct nil_match_bts_data {
	int bts_nr;
	const struct neighbor_ident_key *found;
};

static bool nil_match_bts(const struct neighbor_ident_key *key,
			  const struct gsm0808_cell_id_list2 *val,
			  void *cb_data)
{
	struct nil_match_bts_data *d = cb_data;
	if (key->from_bts == d->bts_nr) {
		d->found = key;
		return false;
	}
	return true;
}

static int neighbor_del_all(struct vty *vty)
{
	int rc;
	int removed = 0;
	struct gsm_bts *bts = vty->index;

	OSMO_ASSERT((vty->node == BTS_NODE) && bts);

	/* Remove all local neighbors and print to VTY for the user to know what changed */
	while (1) {
		struct gsm_bts_ref *neigh = llist_first_entry_or_null(&bts->local_neighbors, struct gsm_bts_ref, entry);
		struct gsm_bts *neigh_bts;
		if (!neigh)
			break;

		neigh_bts = neigh->bts;
		OSMO_ASSERT(neigh_bts);

		/* It would be more efficient to just llist_del() the gsm_bts_ref directly, but for the sake of
		 * safe/sane API use and against code dup, rather invoke the central gsm_bts_local_neighbor_del()
		 * function intended for this task. */
		rc = gsm_bts_local_neighbor_del(bts, neigh_bts);
		if (rc > 0) {
			vty_out(vty, "%% Removed local neighbor bts %u to bts %u%s",
				bts->nr, neigh_bts->nr, VTY_NEWLINE);
			removed += rc;
		} else {
			vty_out(vty, "%% Error while removing local neigbor bts %u to bts %u, aborted%s",
				bts->nr, neigh_bts->nr, VTY_NEWLINE);
			return CMD_WARNING;
		}
	}

	/* Remove all remote-BSS neighbors */
	while (1) {
		struct neighbor_ident_key k;
		struct nil_match_bts_data d = {
			.bts_nr = bts->nr,
		};
		neighbor_ident_iter(g_neighbor_cells, nil_match_bts, &d);
		if (!d.found)
			break;
		k = *d.found;
		if (neighbor_ident_del(g_neighbor_cells, &k)) {
			vty_out(vty, "%% Removed remote BSS neighbor %s%s",
				neighbor_ident_key_name(&k), VTY_NEWLINE);
			removed++;
		} else {
			vty_out(vty, "%% Error while removing remote BSS neighbor %s, aborted%s",
				neighbor_ident_key_name(&k), VTY_NEWLINE);
			return CMD_WARNING;
		}
	}

	if (!removed)
		vty_out(vty, "%% No neighbors configured%s", VTY_NEWLINE);
	return CMD_SUCCESS;
}

DEFUN(cfg_neighbor_add_lac_arfcn_bsic, cfg_neighbor_add_lac_arfcn_bsic_cmd,
	NEIGHBOR_ADD_CMD LAC_PARAMS " " NEIGHBOR_IDENT_VTY_KEY_PARAMS,
	NEIGHBOR_ADD_DOC LAC_DOC NEIGHBOR_IDENT_VTY_KEY_DOC)
{
	struct neighbor_ident_key nik;
	struct gsm0808_cell_id *cell_id = neighbor_ident_vty_parse_lac(vty, argv);
	if (!cell_id)
		return CMD_WARNING;
	if (!neighbor_ident_vty_parse_key_params(vty, argv + 1, &nik))
		return CMD_WARNING;
	return add_remote_or_local_bts(vty, cell_id, &nik);
}

DEFUN(cfg_neighbor_add_lac_ci_arfcn_bsic, cfg_neighbor_add_lac_ci_arfcn_bsic_cmd,
	NEIGHBOR_ADD_CMD LAC_CI_PARAMS " " NEIGHBOR_IDENT_VTY_KEY_PARAMS,
	NEIGHBOR_ADD_DOC LAC_CI_DOC NEIGHBOR_IDENT_VTY_KEY_DOC)
{
	struct neighbor_ident_key nik;
	struct gsm0808_cell_id *cell_id = neighbor_ident_vty_parse_lac_ci(vty, argv);
	if (!cell_id)
		return CMD_WARNING;
	if (!neighbor_ident_vty_parse_key_params(vty, argv + 2, &nik))
		return CMD_WARNING;
	return add_remote_or_local_bts(vty, cell_id, &nik);
}

DEFUN(cfg_neighbor_add_cgi_arfcn_bsic, cfg_neighbor_add_cgi_arfcn_bsic_cmd,
	NEIGHBOR_ADD_CMD CGI_PARAMS " " NEIGHBOR_IDENT_VTY_KEY_PARAMS,
	NEIGHBOR_ADD_DOC CGI_DOC NEIGHBOR_IDENT_VTY_KEY_DOC)
{
	struct neighbor_ident_key nik;
	struct gsm0808_cell_id *cell_id = neighbor_ident_vty_parse_cgi(vty, argv);
	if (!cell_id)
		return CMD_WARNING;
	if (!neighbor_ident_vty_parse_key_params(vty, argv + 4, &nik))
		return CMD_WARNING;
	return add_remote_or_local_bts(vty, cell_id, &nik);
}

DEFUN(cfg_neighbor_del_bts_nr, cfg_neighbor_del_bts_nr_cmd,
	NEIGHBOR_DEL_CMD LOCAL_BTS_PARAMS,
	NEIGHBOR_DEL_DOC LOCAL_BTS_DOC)
{
	return del_local_bts(vty, neighbor_ident_vty_parse_bts_nr(vty, argv));
}

DEFUN(cfg_neighbor_del_arfcn_bsic, cfg_neighbor_del_arfcn_bsic_cmd,
	NEIGHBOR_DEL_CMD NEIGHBOR_IDENT_VTY_KEY_PARAMS,
	NEIGHBOR_DEL_DOC NEIGHBOR_IDENT_VTY_KEY_DOC)
{
	struct neighbor_ident_key key;

	if (!neighbor_ident_vty_parse_key_params(vty, argv, &key))
		return CMD_WARNING;

	return del_by_key(vty, &key);
}

DEFUN(cfg_neighbor_del_all, cfg_neighbor_del_all_cmd,
	"no neighbors",
	NO_STR
	"Remove all local and remote-BSS neighbor config for this cell."
	" Note that this falls back to the legacy behavior of regarding all local cells as neighbors.\n")
{
	return neighbor_del_all(vty);
}

struct write_neighbor_ident_entry_data {
	struct vty *vty;
	const char *indent;
	struct gsm_bts *bts;
};

static bool write_neighbor_ident_list(const struct neighbor_ident_key *key,
				      const struct gsm0808_cell_id_list2 *val,
				      void *cb_data)
{
	struct write_neighbor_ident_entry_data *d = cb_data;
	struct vty *vty = d->vty;
	int i;

	if (d->bts) {
		if (d->bts->nr != key->from_bts)
			return true;
	} else if (key->from_bts != NEIGHBOR_IDENT_KEY_ANY_BTS)
			return true;

#define NEIGH_BSS_WRITE(fmt, args...) do { \
		vty_out(vty, "%sneighbor " fmt " arfcn %u ", d->indent, ## args, key->arfcn); \
		if (key->bsic == BSIC_ANY) \
			vty_out(vty, "bsic any"); \
		else \
			vty_out(vty, "bsic %u", key->bsic & 0x3f); \
		vty_out(vty, "%s", VTY_NEWLINE); \
	} while(0)

	switch (val->id_discr) {
	case CELL_IDENT_LAC:
		for (i = 0; i < val->id_list_len; i++) {
			NEIGH_BSS_WRITE("lac %u", val->id_list[i].lac);
		}
		break;
	case CELL_IDENT_LAC_AND_CI:
		for (i = 0; i < val->id_list_len; i++) {
			NEIGH_BSS_WRITE("lac-ci %u %u",
					val->id_list[i].lac_and_ci.lac,
					val->id_list[i].lac_and_ci.ci);
		}
		break;
	case CELL_IDENT_WHOLE_GLOBAL:
		for (i = 0; i < val->id_list_len; i++) {
			const struct osmo_cell_global_id *cgi = &val->id_list[i].global;
			NEIGH_BSS_WRITE("cgi %s %s %u %u",
					osmo_mcc_name(cgi->lai.plmn.mcc),
					osmo_mnc_name(cgi->lai.plmn.mnc, cgi->lai.plmn.mnc_3_digits),
					cgi->lai.lac, cgi->cell_identity);
		}
		break;
	default:
		vty_out(vty, "%% Unsupported Cell Identity%s", VTY_NEWLINE);
	}
#undef NEIGH_BSS_WRITE

	return true;
}

void neighbor_ident_vty_write_remote_bss(struct vty *vty, const char *indent, struct gsm_bts *bts)
{
	struct write_neighbor_ident_entry_data d = {
		.vty = vty,
		.indent = indent,
		.bts = bts,
	};

	neighbor_ident_iter(g_neighbor_cells, write_neighbor_ident_list, &d);
}

void neighbor_ident_vty_write_local_neighbors(struct vty *vty, const char *indent, struct gsm_bts *bts)
{
	struct gsm_bts_ref *neigh;

	llist_for_each_entry(neigh, &bts->local_neighbors, entry) {
		vty_out(vty, "%sneighbor bts %u%s", indent, neigh->bts->nr, VTY_NEWLINE);
	}
}

void neighbor_ident_vty_write(struct vty *vty, const char *indent, struct gsm_bts *bts)
{
	neighbor_ident_vty_write_local_neighbors(vty, indent, bts);
	neighbor_ident_vty_write_remote_bss(vty, indent, bts);
}

DEFUN(show_bts_neighbor, show_bts_neighbor_cmd,
      "show bts <0-255> neighbor " NEIGHBOR_IDENT_VTY_KEY_PARAMS,
      SHOW_STR "Display information about a BTS\n" "BTS number\n"
      "Query which cell would be the target for this neighbor ARFCN+BSIC\n"
      NEIGHBOR_IDENT_VTY_KEY_DOC)
{
	int found = 0;
	struct neighbor_ident_key key;
	struct gsm_bts_ref *neigh;
	const struct gsm0808_cell_id_list2 *res;
	struct gsm_bts *bts = gsm_bts_num(g_net, atoi(argv[0]));
	struct write_neighbor_ident_entry_data d = {
		.vty = vty,
		.indent = "% ",
		.bts = bts,
	};

	if (!bts) {
		vty_out(vty, "%% Error: cannot find BTS '%s'%s", argv[0],
			VTY_NEWLINE);
		return CMD_WARNING;
	}

	if (!neighbor_ident_bts_parse_key_params(vty, bts, &argv[1], &key))
		return CMD_WARNING;

	/* Is there a local BTS that matches the key? */
	llist_for_each_entry(neigh, &bts->local_neighbors, entry) {
		if (!neighbor_ident_key_matches_bts(&key, neigh->bts))
			continue;
		vty_out(vty, "%% %s resolves to local BTS %u lac-ci %u %u%s",
			neighbor_ident_key_name(&key), neigh->bts->nr, neigh->bts->location_area_code,
			neigh->bts->cell_identity, VTY_NEWLINE);
		found++;
	}

	res = neighbor_ident_get(g_neighbor_cells, &key);
	if (res) {
		write_neighbor_ident_list(&key, res, &d);
		found++;
	}

	if (!found)
		vty_out(vty, "%% No entry for %s%s", neighbor_ident_key_name(&key), VTY_NEWLINE);

	return CMD_SUCCESS;
}

void neighbor_ident_vty_init(struct gsm_network *net, struct neighbor_ident_list *nil)
{
	g_net = net;
	g_neighbor_cells = nil;
	install_element(BTS_NODE, &cfg_neighbor_add_bts_nr_cmd);
	install_element(BTS_NODE, &cfg_neighbor_add_lac_cmd);
	install_element(BTS_NODE, &cfg_neighbor_add_lac_ci_cmd);
	install_element(BTS_NODE, &cfg_neighbor_add_cgi_cmd);
	install_element(BTS_NODE, &cfg_neighbor_add_lac_arfcn_bsic_cmd);
	install_element(BTS_NODE, &cfg_neighbor_add_lac_ci_arfcn_bsic_cmd);
	install_element(BTS_NODE, &cfg_neighbor_add_cgi_arfcn_bsic_cmd);
	install_element(BTS_NODE, &cfg_neighbor_del_bts_nr_cmd);
	install_element(BTS_NODE, &cfg_neighbor_del_arfcn_bsic_cmd);
	install_element(BTS_NODE, &cfg_neighbor_del_all_cmd);
	install_element_ve(&show_bts_neighbor_cmd);
}